[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace WordPress\AiClientDependencies\Psr\Http\Message;
   4  
   5  /**
   6   * Representation of an outgoing, server-side response.
   7   *
   8   * Per the HTTP specification, this interface includes properties for
   9   * each of the following:
  10   *
  11   * - Protocol version
  12   * - Status code and reason phrase
  13   * - Headers
  14   * - Message body
  15   *
  16   * Responses are considered immutable; all methods that might change state MUST
  17   * be implemented such that they retain the internal state of the current
  18   * message and return an instance that contains the changed state.
  19   */
  20  interface ResponseInterface extends MessageInterface
  21  {
  22      /**
  23       * Gets the response status code.
  24       *
  25       * The status code is a 3-digit integer result code of the server's attempt
  26       * to understand and satisfy the request.
  27       *
  28       * @return int Status code.
  29       */
  30      public function getStatusCode(): int;
  31      /**
  32       * Return an instance with the specified status code and, optionally, reason phrase.
  33       *
  34       * If no reason phrase is specified, implementations MAY choose to default
  35       * to the RFC 7231 or IANA recommended reason phrase for the response's
  36       * status code.
  37       *
  38       * This method MUST be implemented in such a way as to retain the
  39       * immutability of the message, and MUST return an instance that has the
  40       * updated status and reason phrase.
  41       *
  42       * @link http://tools.ietf.org/html/rfc7231#section-6
  43       * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  44       * @param int $code The 3-digit integer result code to set.
  45       * @param string $reasonPhrase The reason phrase to use with the
  46       *     provided status code; if none is provided, implementations MAY
  47       *     use the defaults as suggested in the HTTP specification.
  48       * @return static
  49       * @throws \InvalidArgumentException For invalid status code arguments.
  50       */
  51      public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface;
  52      /**
  53       * Gets the response reason phrase associated with the status code.
  54       *
  55       * Because a reason phrase is not a required element in a response
  56       * status line, the reason phrase value MAY be null. Implementations MAY
  57       * choose to return the default RFC 7231 recommended reason phrase (or those
  58       * listed in the IANA HTTP Status Code Registry) for the response's
  59       * status code.
  60       *
  61       * @link http://tools.ietf.org/html/rfc7231#section-6
  62       * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
  63       * @return string Reason phrase; must return an empty string if none present.
  64       */
  65      public function getReasonPhrase(): string;
  66  }