qii/src/Base/Response.php

<?php

namespace Qii\Base;

use Qii\Response\Cli;

class Response
{
    /**
     * Default body name
     */
    const DEFAULT_BODY = 'html';
    const FORMAT_JSON = 'json';
    const FORMAT_HTML = 'html';
    
    public static $render = null;
    
    /**
     * Body content
     * @var array
     */
    protected $body = array();
    
    /**
     * data
     * @param array $data
     */
    protected $data = array();
    /**
     * Array of headers. Each header is an array with keys 'name' and 'value'
     * @var array
     */
    protected $headers = array();
    
    /**
     * Determine to send the headers or not
     * @var bool $_sendHeader 是否发送头信息
     */
    protected $_sendHeader = true;
    /**
     * @var bool|string 返回数据格式
     */
    private $format;


    public function __construct($data = array())
    {
        $this->format = isset($data['format']) ? $data['format'] : self::FORMAT_HTML;
        $this->data = $data;
    }
    
    /**
     * 设置页面渲染类
     * @param \Qii\View\Intf $render 渲染类
     */
    public function setRender(\Qii\View\Intf $render)
    {
        Response::$render = $render;
    }

    /**
     * @param bool $isSend 是否发送头信息
     * @return void
     */
    public function setSendHeader($isSend = true) {
        $this->_sendHeader = $isSend;
    }
    
    /**
     * Append content to the body content
     *
     * @param string $content
     * @param string $key
     * @return $this
     */
    public function appendBody($body, $key = NULL)
    {
        if (!strlen($key)) {
            $key = self::DEFAULT_BODY;
        }
        if (!isset($this->body[$key])) {
            $this->body[$key] = '';
        }
        $this->body[$key] .= (string)$body;
        return $this;
    }
    
    /**
     * Clear the entire body
     *
     * @param string $key
     * @return boolean
     */
    public function clearBody($key = NULL)
    {
        if (strlen($key)) {
            if (array_key_exists($key, $this->body)) {
                unset($this->body[$key]);
            }
        } else {
            $this->body = array();
        }
        return true;
    }
    
    /**
     * Clear headers
     *
     * @return $this
     */
    public function clearHeaders()
    {
        $this->headers = array();
        return $this;
    }
    
    /**
     * Return the body content
     *
     * @param string $key
     * @return string
     */
    public function getBody($key = NULL)
    {
        if (!strlen($key)) {
            $key = self::DEFAULT_BODY;
        }
        return array_key_exists($key, $this->body) ? $this->body[$key] : null;
    }
    
    /**
     * Return array of headers; see {@link $headers} for format
     *
     * @return array
     */
    public function getHeader()
    {
        return $this->headers;
    }
    
    /**
     * Prepend content the body
     *
     * @param string $body
     * @param string $key
     * @return $this
     */
    public function prependBody($body, $key = null)
    {
        if (!strlen($key)) {
            $key = self::DEFAULT_BODY;
        }
        if (!isset($this->body[$key])) {
            $this->body[$key] = '';
        }
        $this->body[$key] = $body . $this->body[$key];
        return $this;
    }
    /**
     * 是否需要view来渲染页面
     * @return bool
     */
    public function needRender()
    {
        if(isset($this->data['body']) && is_array($this->data['body']) && isset($this->data['body']['tpl']))
        {
            return true;
        }
        return false;
    }
    
    /**
     * Send the response, including all headers
     *
     * @return void
     */
    public function response()
    {
        if ($this->data && isset($this->data['body'])) {
            switch ($this->data['format']) {
                case self::FORMAT_JSON:
                    $this->setHeader('Content-Type', 'text/json');
                    $this->sendHeaders();
                    echo json_encode($this->data['body'], JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE);
                    break;
                default:
                    $body = $this->data['body'];
                    if (is_array($this->data['body'])) {
                        $body = '';
                        if (isset($this->data['body']['render']) && $this->data['body']['render'] instanceof \Qii\View\Intf) {
                            Response::$render = $this->data['body']['render'];
                        }
                        
                        if (Response::$render != null && Response::$render instanceof \Qii\View\Intf) {
                            $tplData = isset($this->data['body']['tplData']) ? $this->data['body']['tplData'] : [];
                            Response::$render->assign($tplData);
                            $body = Response::$render->fetch($this->data['body']['tpl']);
                        }
                    }
                    $this->setBody($body);
                    echo(IS_CLI ? (new Cli())->stdout($body) : $body);
                    break;
            }
            return;
        }
        if ($this->_sendHeader) {
            $this->sendHeaders();
        }
        foreach ($this->body as $body) {
            echo IS_CLI ? new Cli($body) : $body;
        }
    }

    /**
     * @param $headers 头信息 [['name' => 'value'], ...]
     * @return $this
     */
    public function setAllHeaders($headers = array())
    {
        if (is_array($headers)) {
            foreach ($headers as $value) {
                if (!isset($value['name'])) {
                    continue;
                }
                $this->setHeader($value['name'], $value['value']);
            }
        }
        return $this;
    }
    
    /**
     * Set body content
     *
     * @param string $body
     * @param string $key
     * @return $this
     */
    public function setBody($body, $key = NULL)
    {
        if (!strlen($key)) {
            $key = self::DEFAULT_BODY;
        }
        $this->body[$key] = (string)$body;
        return $this;
    }
    
    /**
     * Set a header
     *
     * If $replace is true, replaces any headers already defined with that
     * $name.
     *
     * @param string $name 名称
     * @param string $value 值
     * @param boolean $replace 如果存在是否替换
     * @return $this
     */
    public function setHeader($name, $value, $replace = true)
    {
        $name = $this->_normalizeHeader($name);
        $value = (string)$value;
        
        if ($replace) {
            foreach ($this->headers as $key => $header) {
                if ($name == $header['name']) {
                    unset($this->headers[$key]);
                }
            }
        }
        
        $this->headers[] = array(
            'name' => $name,
            'value' => $value,
            'replace' => $replace
        );
        
        return $this;
    }
    
    /**
     * Set redirect URL
     *
     * Sets Location header. Forces replacement of any prior redirects.
     *
     * @param string $url
     * @return $this
     */
    public function setRedirect($url)
    {
        $this->setHeader('Location', $url, true);
        return $this;
    }
    
    /**
     * Magic __toString functionality
     *
     * Returns response value as string
     * using output buffering.
     *
     * @return string
     */
    public function __toString()
    {
        ob_start();
        $this->response();
        return ob_get_clean();
    }
    
    /**
     * Normalize a header name
     *
     * Normalizes a header name to X-Capitalized-Names
     *
     * @param  string $name
     * @return string
     */
    protected function _normalizeHeader($name)
    {
        $filtered = str_replace(array('-', '_'), ' ', (string)$name);
        $filtered = ucwords(strtolower($filtered));
        return  str_replace(' ', '-', $filtered);
    }
    
    /**
     * Send all headers
     *
     * Sends any headers specified.
     * If an {@link setHttpResponseCode() HTTP response code}
     * has been specified, it is sent with the first header.
     *
     * @return $this
     */
    protected function sendHeaders()
    {
        foreach ($this->headers as $key => $header) {
            header(
                $header['name'] . ': ' . $header['value'],
                $header['replace']
            );
        }
        $this->clearHeaders();
        return $this;
    }
}