class Response in Zircon Profile 8

HTTP response encapsulation.

Responses are considered immutable; all methods that might change state are implemented such that they retain the internal state of the current message and return a new instance that contains the changed state.

Hierarchy

• class \Zend\Diactoros\Response implements ResponseInterface uses MessageTrait

6 files declare their use of Response

DiactorosFactory.php in vendor/symfony/psr-http-message-bridge/Factory/DiactorosFactory.php

EmptyResponse.php in vendor/zendframework/zend-diactoros/src/Response/EmptyResponse.php

HtmlResponse.php in vendor/zendframework/zend-diactoros/src/Response/HtmlResponse.php

JsonResponse.php in vendor/zendframework/zend-diactoros/src/Response/JsonResponse.php

RedirectResponse.php in vendor/zendframework/zend-diactoros/src/Response/RedirectResponse.php

... See full list

1 string reference to 'Response'

form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml

core/modules/system/tests/modules/form_test/form_test.routing.yml

File

vendor/zendframework/zend-diactoros/src/Response.php, line 23

Namespace

Zend\Diactoros

class Response implements ResponseInterface {
  use MessageTrait;

  /**
   * Map of standard HTTP status code/reason phrases
   *
   * @var array
   */
  private $phrases = [
    // INFORMATIONAL CODES
    100 => 'Continue',
    101 => 'Switching Protocols',
    102 => 'Processing',
    // SUCCESS CODES
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    207 => 'Multi-status',
    208 => 'Already Reported',
    // REDIRECTION CODES
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    306 => 'Switch Proxy',
    // Deprecated
    307 => 'Temporary Redirect',
    // CLIENT ERROR
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Time-out',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    418 => 'I\'m a teapot',
    422 => 'Unprocessable Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    // SERVER ERROR
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Time-out',
    505 => 'HTTP Version not supported',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    511 => 'Network Authentication Required',
  ];

  /**
   * @var string
   */
  private $reasonPhrase = '';

  /**
   * @var int
   */
  private $statusCode = 200;

  /**
   * @param string|resource|StreamInterface $stream Stream identifier and/or actual stream resource
   * @param int $status Status code for the response, if any.
   * @param array $headers Headers for the response, if any.
   * @throws InvalidArgumentException on any invalid element.
   */
  public function __construct($body = 'php://memory', $status = 200, array $headers = []) {
    if (!is_string($body) && !is_resource($body) && !$body instanceof StreamInterface) {
      throw new InvalidArgumentException('Stream must be a string stream resource identifier, ' . 'an actual stream resource, ' . 'or a Psr\\Http\\Message\\StreamInterface implementation');
    }
    if (null !== $status) {
      $this
        ->validateStatus($status);
    }
    $this->stream = $body instanceof StreamInterface ? $body : new Stream($body, 'wb+');
    $this->statusCode = $status ? (int) $status : 200;
    list($this->headerNames, $headers) = $this
      ->filterHeaders($headers);
    $this
      ->assertHeaders($headers);
    $this->headers = $headers;
  }

  /**
   * {@inheritdoc}
   */
  public function getStatusCode() {
    return $this->statusCode;
  }

  /**
   * {@inheritdoc}
   */
  public function getReasonPhrase() {
    if (!$this->reasonPhrase && isset($this->phrases[$this->statusCode])) {
      $this->reasonPhrase = $this->phrases[$this->statusCode];
    }
    return $this->reasonPhrase;
  }

  /**
   * {@inheritdoc}
   */
  public function withStatus($code, $reasonPhrase = '') {
    $this
      ->validateStatus($code);
    $new = clone $this;
    $new->statusCode = (int) $code;
    $new->reasonPhrase = $reasonPhrase;
    return $new;
  }

  /**
   * Validate a status code.
   *
   * @param int|string $code
   * @throws InvalidArgumentException on an invalid status code.
   */
  private function validateStatus($code) {
    if (!is_numeric($code) || is_float($code) || $code < 100 || $code >= 600) {
      throw new InvalidArgumentException(sprintf('Invalid status code "%s"; must be an integer between 100 and 599, inclusive', is_scalar($code) ? $code : gettype($code)));
    }
  }

  /**
   * Ensure header names and values are valid.
   *
   * @param array $headers
   * @throws InvalidArgumentException
   */
  private function assertHeaders(array $headers) {
    foreach ($headers as $name => $headerValues) {
      HeaderSecurity::assertValidName($name);
      array_walk($headerValues, __NAMESPACE__ . '\\HeaderSecurity::assertValid');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessageTrait::$headerNames	protected	property	Map of normalized header name to original name used to register header.
MessageTrait::$headers	protected	property	List of all registered headers, as key => array of values.
MessageTrait::$protocol	private	property
MessageTrait::$stream	private	property
MessageTrait::arrayContainsOnlyStrings	private	function	Test that an array contains only strings
MessageTrait::assertValidHeaderValue	private static	function	Assert that the provided header values are valid.
MessageTrait::filterHeaders	private	function	Filter a set of headers to ensure they are in the correct internal format.
MessageTrait::filterStringValue	private static	function	Test if a value is a string
MessageTrait::getBody	public	function	Gets the body of the message.
MessageTrait::getHeader	public	function	Retrieves a message header value by the given case-insensitive name.	1
MessageTrait::getHeaderLine	public	function	Retrieves a comma-separated string of the values for a single header.
MessageTrait::getHeaders	public	function	Retrieves all message headers.	1
MessageTrait::getProtocolVersion	public	function	Retrieves the HTTP protocol version as a string.
MessageTrait::hasHeader	public	function	Checks if a header exists by the given case-insensitive name.
MessageTrait::withAddedHeader	public	function	Return an instance with the specified header appended with the given value.
MessageTrait::withBody	public	function	Return an instance with the specified message body.
MessageTrait::withHeader	public	function	Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
MessageTrait::withoutHeader	public	function	Return an instance without the specified header.
MessageTrait::withProtocolVersion	public	function	Return an instance with the specified HTTP protocol version.
Response::$phrases	private	property	Map of standard HTTP status code/reason phrases
Response::$reasonPhrase	private	property
Response::$statusCode	private	property
Response::assertHeaders	private	function	Ensure header names and values are valid.
Response::getReasonPhrase	public	function	Gets the response reason phrase associated with the status code. Overrides ResponseInterface::getReasonPhrase
Response::getStatusCode	public	function	Gets the response status code. Overrides ResponseInterface::getStatusCode
Response::validateStatus	private	function	Validate a status code.
Response::withStatus	public	function	Return an instance with the specified status code and, optionally, reason phrase. Overrides ResponseInterface::withStatus
Response::__construct	public	function