Blame view

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