class HttpResponse in Zircon Profile 8

Hierarchy

• class \Zend\Feed\PubSubHubbub\HttpResponse

File

vendor/zendframework/zend-feed/src/PubSubHubbub/HttpResponse.php, line 12

Namespace

Zend\Feed\PubSubHubbub

class HttpResponse {

  /**
   * The body of any response to the current callback request
   *
   * @var string
   */
  protected $content = '';

  /**
   * Array of headers. Each header is an array with keys 'name' and 'value'
   *
   * @var array
   */
  protected $headers = [];

  /**
   * HTTP response code to use in headers
   *
   * @var int
   */
  protected $statusCode = 200;

  /**
   * Send the response, including all headers
   *
   * @return void
   */
  public function send() {
    $this
      ->sendHeaders();
    echo $this
      ->getContent();
  }

  /**
   * 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 void
   */
  public function sendHeaders() {
    if (count($this->headers) || 200 != $this->statusCode) {
      $this
        ->canSendHeaders(true);
    }
    elseif (200 == $this->statusCode) {
      return;
    }
    $httpCodeSent = false;
    foreach ($this->headers as $header) {
      if (!$httpCodeSent && $this->statusCode) {
        header($header['name'] . ': ' . $header['value'], $header['replace'], $this->statusCode);
        $httpCodeSent = true;
      }
      else {
        header($header['name'] . ': ' . $header['value'], $header['replace']);
      }
    }
    if (!$httpCodeSent) {
      header('HTTP/1.1 ' . $this->statusCode);
    }
  }

  /**
   * Set a header
   *
   * If $replace is true, replaces any headers already defined with that
   * $name.
   *
   * @param  string $name
   * @param  string $value
   * @param  bool $replace
   * @return \Zend\Feed\PubSubHubbub\HttpResponse
   */
  public function setHeader($name, $value, $replace = false) {
    $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[] = [
      'name' => $name,
      'value' => $value,
      'replace' => $replace,
    ];
    return $this;
  }

  /**
   * Check if a specific Header is set and return its value
   *
   * @param  string $name
   * @return string|null
   */
  public function getHeader($name) {
    $name = $this
      ->_normalizeHeader($name);
    foreach ($this->headers as $header) {
      if ($header['name'] == $name) {
        return $header['value'];
      }
    }
  }

  /**
   * Return array of headers; see {@link $headers} for format
   *
   * @return array
   */
  public function getHeaders() {
    return $this->headers;
  }

  /**
   * Can we send headers?
   *
   * @param  bool $throw Whether or not to throw an exception if headers have been sent; defaults to false
   * @return HttpResponse
   * @throws Exception\RuntimeException
   */
  public function canSendHeaders($throw = false) {
    $ok = headers_sent($file, $line);
    if ($ok && $throw) {
      throw new Exception\RuntimeException('Cannot send headers; headers already sent in ' . $file . ', line ' . $line);
    }
    return !$ok;
  }

  /**
   * Set HTTP response code to use with headers
   *
   * @param  int $code
   * @return HttpResponse
   * @throws Exception\InvalidArgumentException
   */
  public function setStatusCode($code) {
    if (!is_int($code) || 100 > $code || 599 < $code) {
      throw new Exception\InvalidArgumentException('Invalid HTTP response' . ' code:' . $code);
    }
    $this->statusCode = $code;
    return $this;
  }

  /**
   * Retrieve HTTP response code
   *
   * @return int
   */
  public function getStatusCode() {
    return $this->statusCode;
  }

  /**
   * Set body content
   *
   * @param  string $content
   * @return \Zend\Feed\PubSubHubbub\HttpResponse
   */
  public function setContent($content) {
    $this->content = (string) $content;
    $this
      ->setHeader('content-length', strlen($content));
    return $this;
  }

  /**
   * Return the body content
   *
   * @return string
   */
  public function getContent() {
    return $this->content;
  }

  /**
   * Normalizes a header name to X-Capitalized-Names
   *
   * @param  string $name
   * @return string
   */
  protected function _normalizeHeader($name) {
    $filtered = str_replace([
      '-',
      '_',
    ], ' ', (string) $name);
    $filtered = ucwords(strtolower($filtered));
    $filtered = str_replace(' ', '-', $filtered);
    return $filtered;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HttpResponse::$content	protected	property	The body of any response to the current callback request
HttpResponse::$headers	protected	property	Array of headers. Each header is an array with keys 'name' and 'value'
HttpResponse::$statusCode	protected	property	HTTP response code to use in headers
HttpResponse::canSendHeaders	public	function	Can we send headers?
HttpResponse::getContent	public	function	Return the body content
HttpResponse::getHeader	public	function	Check if a specific Header is set and return its value
HttpResponse::getHeaders	public	function	Return array of headers; see {@link $headers} for format
HttpResponse::getStatusCode	public	function	Retrieve HTTP response code
HttpResponse::send	public	function	Send the response, including all headers
HttpResponse::sendHeaders	public	function	Send all headers
HttpResponse::setContent	public	function	Set body content
HttpResponse::setHeader	public	function	Set a header
HttpResponse::setStatusCode	public	function	Set HTTP response code to use with headers
HttpResponse::_normalizeHeader	protected	function	Normalizes a header name to X-Capitalized-Names