Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/http-message/src/ -> MessageInterface.php (source)

[Source view]

(no description)

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

Defines 1 class

MessageInterface:: (11 methods):
  getProtocolVersion()
  withProtocolVersion()
  getHeaders()
  hasHeader()
  getHeader()
  getHeaderLine()
  withHeader()
  withAddedHeader()
  withoutHeader()
  getBody()
  withBody()


Interface: MessageInterface  - X-Ref

HTTP messages consist of requests from a client to a server and responses
from a server to a client. This interface defines the methods common to
each.

Messages 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.

getProtocolVersion()   X-Ref
Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

return: string HTTP protocol version.

withProtocolVersion($version)   X-Ref
Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g.,
"1.1", "1.0").

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
new protocol version.

return: static
param: string $version HTTP protocol version

getHeaders()   X-Ref
Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and
each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
echo $name . ": " . implode(", ", $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
foreach ($values as $value) {
header(sprintf('%s: %s', $name, $value), false);
}
}

While header names are not case-sensitive, getHeaders() will preserve the
exact case in which headers were originally specified.

return: string[][] Returns an associative array of the message's headers. Each

hasHeader($name)   X-Ref
Checks if a header exists by the given case-insensitive name.

return: bool Returns true if any header names match the given header
param: string $name Case-insensitive header field name.

getHeader($name)   X-Ref
Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given
case-insensitive header name.

If the header does not appear in the message, this method MUST return an
empty array.

return: string[] An array of string values as provided for the given
param: string $name Case-insensitive header field name.

getHeaderLine($name)   X-Ref
Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given
case-insensitive header name as a string concatenated together using
a comma.

NOTE: Not all header values may be appropriately represented using
comma concatenation. For such headers, use getHeader() instead
and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return
an empty string.

return: string A string of values as provided for the given header
param: string $name Case-insensitive header field name.

withHeader($name, $value)   X-Ref
Return an instance with the provided value replacing the specified header.

While header names are case-insensitive, the casing of the header will
be preserved by this function, and returned from getHeaders().

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
new and/or updated header and value.

return: static
param: string $name Case-insensitive header field name.
param: string|string[] $value Header value(s).

withAddedHeader($name, $value)   X-Ref
Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new
value(s) will be appended to the existing list. If the header did not
exist previously, it will be added.

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
new header and/or value.

return: static
param: string $name Case-insensitive header field name to add.
param: string|string[] $value Header value(s).

withoutHeader($name)   X-Ref
Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the
immutability of the message, and MUST return an instance that removes
the named header.

return: static
param: string $name Case-insensitive header field name to remove.

getBody()   X-Ref
Gets the body of the message.

return: StreamInterface Returns the body as a stream.

withBody(StreamInterface $body)   X-Ref
Return an instance with the specified message body.

The body MUST be a StreamInterface object.

This method MUST be implemented in such a way as to retain the
immutability of the message, and MUST return a new instance that has the
new body stream.

return: static
param: StreamInterface $body Body.