H:/Workspace/php-axiom/www/php-axiom/libraries/axiom/axResponse.class.php

Go to the documentation of this file.

<?php
class axResponse {
    
    protected $_view;
    
    protected $_viewSection;
    
    protected $_viewFormat;
    
    protected $_viewLayout;
    
    protected $_layoutEnabled;
    
    protected $_vars;
    
    protected $_headers;
    
    protected $_outputCallback;
    
    protected $_filter;
    
    protected $_filterFlag;
    
    protected $_messages;
    
    protected $_styleSheets;
    
    protected $_scripts;
    
    public function __construct () {
        $this->_layoutEnabled = true;
        $this->_vars          = array();
        $this->_headers       = array();
        $this->_messages      = array();
        $this->_styleSheets   = array();
        $this->_scripts       = array();
    }
    
    public function reset () {
        $this->_view           = null;
        $this->_viewSection    = null;
        $this->_viewFormat     = null;
        $this->_viewLayout     = null;
        $this->_outputCallback = null;
        $this->_filter         = null;
        $this->_layoutEnabled  = true;
        $this->_vars           = array();
        $this->_headers        = array();
        $this->_messages       = array();
        $this->_styleSheets    = array();
        $this->_scripts        = array();
    }
    
    public function getView () {
        return $this->_view;
    }
    
    public function setView ($view) {
        $this->_view = $view;
        return $this;
    }
    
    public function getViewSection () {
        return $this->_viewSection;
    }
    
    public function setViewSection ($section) {
        $this->_viewSection = $section;
        return $this;
    }
    
    public function getFormat () {
        return $this->_viewFormat;
    }
    
    public function setFormat ($format) {
        $this->_viewFormat = $format;
        return $this;
    }
    
    public function getLayout () {
        return $this->_viewLayout;
    }
    
    public function setLayout ($layout) {
        $this->_viewLayout = $layout;
        return $this;
    }
    
    public function enableLayout ($enabled = true) {
        $this->_layoutEnabled = (boolean)$enabled;
        return $this;
    }
    
    public function layoutState () {
        return $this->_layoutEnabled;
    }
    
    public function getVar ($name) {
        if ($this->_filterFlag)
            $this->_applyFilter();
        
        return isset($this->_vars[$name]) ? $this->_vars[$name] : null;
    }
    
    public function setVar ($name, $value) {
        $this->_vars[(string)$name] = $value;
        $this->_filterFlag = true;
        return $this;
    }
    
    public function __get ($key) {
        return $this->getVar($key);
    }
    
    public function __set ($key, $value) {
        $this->setVar($key,$value);
    }
    
    public function getVars () {
        if ($this->_filterFlag)
            $this->_applyFilter();
        
        return $this->_vars;
    }
    
    public function add ($collection, $method = self::MERGE_VARS) {
        if (!$collection)
            return $this;
        
        switch ($method) {
            case self::MERGE_VARS:
                $this->_vars = array_merge($this->_vars, $collection);
                break;
            case self::ADD_VARS:
                $this->_vars += $vars;
                break;
            default:
                return false;
        }
        $this->_filterFlag = true;
        return $this;
    }
    
    public function clearVars () {
        $this->_vars = array();
        return $this;
    }
    
    public function setHeader ($field, $value) {
        $this->_headers[$field] = "{$field}: {$value}";
        return $this;
    }
    
    public function setHaders (array $headers) {
        foreach ($headers as $field => $value) {
            $this->setHeader($field, $value);
        }
        return $this;
    }
    
    public function setStatus ($http_status) {
        $this->_headers['status'] = $http_status;
        return $this;
    }
    
    public function getHeaders () {
        return array_unique($this->_headers);
    }
    
    public function clearHeaders () {
        $this->_headers = array();
        return $this;
    }
    
    public function setOutputCallback ($callback) {
        if (!is_callable($this->_outputCallback = $callback)) {
            $this->_outputCallback = null;
            return false;
        }
        return $this;
    }
    
    public function getOutputCallback () {
        return $this->_outputCallback;
    }
    
    public function hasFilter () {
        return isset($this->_filter);
    }
    
    public function getFilter () {
        return $this->_filter;
    }
    
    public function setFilter (array $filter) {
        $this->_filter = $filter;
        $this->_filterFlag = true;
        return $this;
    }
        
    public function addMessage ($message, $level = self::MESSAGE_WARNING) {
        if (!isset($this->_messages[$level]))
            $this->_messages[$level] = array();
        
        $this->_messages[$level][(string)$message] = (string)$message;
        return $this;
    }
    
    public function removeMessage ($message) {
        foreach ($this->_messages as $level => $messages) {
            if (isset($messages[(string)$message]))
                unset($this->_messages[$level][(string)$message]);
        }
        return $this;
    }
    
    public function getMessages ($level = null) {
        if ($level)
            return isset($this->_messages[$level]) ? $this->_messages[$level] : array();
        else
            return $this->_messages;
    }
    
    public function clearMessages () {
        $this->_messages = array();
        return $this;
    }
    
    public function addStyleSheet ($stylesheet, $type= "text/css", $media = "screen") {
        $this->_styleSheets[$stylesheet] = array(
                'href'  => $stylesheet, 
                'type'  => $type,
            'media' => $media
        );
        return $this;
    }
    
    public function removeStyleSheet ($stylehseet) {
        unset($this->_styleSheets[$stylesheet]);
        return $this;
    }
    
    public function clearStyleSheets () {
        $this->_styleSheets = array();
        return $this;
    }
    
    public function addScript ($script, $type = "text/javascript") {
        $this->_scripts[$script] = array(
            'src'  => $script,
            'type' => $type
        );
        return $this;
    }
    
    public function removeScript ($script) {
        unset($this->_scripts[$script]);
        return $this;
    }
    
    public function clearScripts () {
        $this->_scripts = array();
        return $this;
    }
    
    public function setCookie ($name, 
                               $value = "", 
                               $expire = 0, 
                               $path = "",
                               $domain = "", 
                               $secure = false, 
                               $httponly = false) {
        return setcookie($name,$value,$expire,$path,$domain,$secure,$httponly) ? $this : false;
    }
    
    public function setRawCookie ($name, 
                                  $value = "", 
                                  $expire = 0, 
                                  $path = "",
                                  $domain = "", 
                                  $secure = false, 
                                  $httponly = false) {
        return setrawcookie($name,$value,$expire,$path,$domain,$secure,$httponly) ? $this : false;
    }
    
    protected function _applyFilter () {
        if (!isset($this->_filter))
            return false;
        
        $this->_vars = filter_var_array($this->_vars, $this->_filter);
        $this->_filterFlag = false;
        if (!$this->_vars) {
            $this->clearVars();
            $this->_filter = null;
            throw new RuntimeException("Incorrect filter definition");
        }
        return true;
    }
    
    const MERGE_VARS      = "merge";
    const ADD_VARS        = "add";
    
    const MESSAGE_NOTICE  = "notice";
    const MESSAGE_WARNING = "warning";
    const MESSAGE_ALERT   = "alert";
    
    const HEADER_ACCEPT_RANGE        = "Accept-Ranges";
    const HEADER_AGE                 = "Age";
    const HEADER_ALLOW               = "Allow";
    const HEADER_CACHE_CONTROL       = "Cache-Control";
    const HEADER_CONNECTION          = "Connection";
    const HEADER_CONTENT_ENCODING    = "Content-Encoding";
    const HEADER_CONTENT_LANGUAGE    = "Content-Language";
    const HEADER_CONTENT_LENGTH      = "Content-Length";
    const HEADER_CONTENT_LOCATION    = "Content-Location";
    const HEADER_CONTENT_MD5         = "Content-MD5";
    const HEADER_CONTENT_DISPOSITION = "Content-Disposition";
    const HEADER_CONTENT_RANGE       = "Content-Range";
    const HEADER_CONTENT_TYPE        = "Content-Type";
    const HEADER_DATE                = "Date";
    const HEADER_ETAG                = "ETag";
    const HEADER_EXPIRES             = "Expires";
    const HEADER_LAST_MODIFIED       = "Last-Modified";
    const HEADER_LINK                = "Link";
    const HEADER_LOCATION            = "Location";
    const HEADER_P3P                 = "P3P";
    const HEADER_PRAGMA              = "Pragma";
    const HEADER_PROXY_AUTHENTICATE  = "Proxy-Authenticate";
    const HEADER_REFRESH             = "Refresh";
    const HEADER_RETRY_AFTER         = "Retry-After";
    const HEADER_SERVER              = "Server";
    const HEADER_SET_COOKIE          = "Set-Cookie";
    const HEADER_STS                 = "Strict-Transport-Security";
    const HEADER_TRAILER             = "Trailer";
    const HEADER_TRANSFER_ENCODING   = "Transfer-Encoding";
    const HEADER_VARY                = "Vary";
    const HEADER_VIA                 = "Via";
    const HEADER_WARNING             = "Warning";
    const HEADER_WWW_AUTHENTICATE    = "WWW-Authenticate";
}