Interface MessageContract

Designates a Psr-7 message object. In addition to the Psr-7 spec, Oroboros core messages also support CLI messages in addition to HTTP messages without violating the Psr-7 spec.

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.

Contract interfaces enforce expected behavior in a non-colliding way. They are tasked with enforcing methods, and extending interfaces provided by standards and other packages for compatibility.

All valid oroboros classes MUST extend at

least one Contract Interface to be considered valid.

oroboros\core\interfaces\contract\libraries\stream\MessageContract implements oroboros\core\interfaces\contract\libraries\stream\StreamContract, Psr\Http\Message\MessageInterface

Direct known implementers

oroboros\core\abstracts\libraries\stream\AbstractMessage, oroboros\core\interfaces\contract\libraries\request\RequestContract, oroboros\core\interfaces\contract\libraries\response\ResponseContract

Indirect known implementers

oroboros\core\abstracts\libraries\request\AbstractRequest, oroboros\core\abstracts\libraries\request\AbstractServerRequest, oroboros\core\abstracts\libraries\response\AbstractResponse, oroboros\core\interfaces\contract\libraries\request\ServerRequestContract, oroboros\core\interfaces\contract\libraries\response\ServerResponseContract, oroboros\core\libraries\request\Request, oroboros\core\libraries\request\ServerRequest, oroboros\core\libraries\response\Response, oroboros\core\libraries\stream\Message

Namespace: oroboros\core\interfaces\contract\libraries\stream
Package: oroboros\core\message
Category: contract-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4
Since: 0.2.4-alpha
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
Link: http://www.ietf.org/rfc/rfc7230.txt
Link: http://www.ietf.org/rfc/rfc7231.txt
Located at core/interfaces/contract/libraries/stream/MessageContract.php

Methods summary

`public`	# `__construct( scalar\|resource\|Psr\Http\Message\StreamInterface $body, array $headers = null, type $protocol = null )` Constructs a new instance of a Psr-7 message wrapper. Constructs a new instance of a Psr-7 message wrapper. Parameters `$body` This is the only required value for the constructor, and represents a message body as a scalar value, resource pointer, or instance of a stream interface. `$headers` (optional) If provided, represents an array of headers to construct with the message. `$protocol` (optional) If provided, the HTTP request protocol will be set to this value. Default value is "1.1" Throws `oroboros\core\utilities\exception\InvalidArgumentException` if any passed parameters do not validate Implementation of `oroboros\core\interfaces\contract\libraries\stream\StreamContract::__construct()`
`public string`	# `getProtocolVersion( )` Retrieves the HTTP protocol version as a string. Retrieves the HTTP protocol version as a string. The string MUST contain only the HTTP version number (e.g., "1.1", "1.0"). Returns string HTTP protocol version.
`public static`	# `withProtocolVersion( string $version )` Return an instance with the specified HTTP protocol version. 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. Parameters `$version` HTTP protocol version Returns static
`public string[][]`	# `getHeaders( )` Retrieves all message header values. 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. Returns string[][] Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.
`public boolean`	# `hasHeader( string $name )` Checks if a header exists by the given case-insensitive name. Checks if a header exists by the given case-insensitive name. Parameters `$name` Case-insensitive header field name. Returns boolean Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.
`public string[]`	# `getHeader( string $name )` Retrieves a message header value by the given case-insensitive name. 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. Parameters `$name` Case-insensitive header field name. Returns string[] An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.
`public string`	# `getHeaderLine( string $name )` Retrieves a comma-separated string of the values for a single header. 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. Parameters `$name` Case-insensitive header field name. Returns string A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.
`public static`	# `withHeader( string $name, string\|string[] $value )` Return an instance with the provided value replacing the specified header. 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. Parameters `$name` Case-insensitive header field name. `$value` Header value(s). Returns static Throws `InvalidArgumentException` for invalid header names or values.
`public static`	# `withAddedHeader( string $name, string\|string[] $value )` Return an instance with the specified header appended with the given value. 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. Parameters `$name` Case-insensitive header field name to add. `$value` Header value(s). Returns static Throws `InvalidArgumentException` for invalid header names. `InvalidArgumentException` for invalid header values.
`public static`	# `withoutHeader( string $name )` Return an instance without the specified header. 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. Parameters `$name` Case-insensitive header field name to remove. Returns static
`public StreamInterface`	# `getBody( )` Gets the body of the message. Gets the body of the message. Returns StreamInterface Returns the body as a stream.
`public static`	# `withBody( Psr\Http\Message\StreamInterface $body )` Return an instance with the specified message body. 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. Parameters `$body` Body. Returns static Throws `InvalidArgumentException` When the body is not valid.

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\StreamContract

__destruct(), __toString(), close(), detach(), eof(), getContents(), getMetadata(), getSize(), isReadable(), isSeekable(), isWritable(), read(), rewind(), seek(), tell(), write()

Namespaces

Interfaces

Interface MessageContract

least one Contract Interface to be considered valid.

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Throws

Implementation of

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Throws

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\StreamContract