Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/http-message/src/ -> ResponseInterface.php (source)

[Source view]

(no description)

File Size: 68 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ResponseInterface:: (3 methods):
  getStatusCode()
  withStatus()
  getReasonPhrase()


Interface: ResponseInterface  - X-Ref

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.
getStatusCode()   X-Ref
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.

withStatus($code, $reasonPhrase = '')   X-Ref
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.

param: int $code The 3-digit integer result code to set.
param: string $reasonPhrase The reason phrase to use with the
return: static

getReasonPhrase()   X-Ref
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.

return: string Reason phrase; must return an empty string if none present.