Zend\Diactoros Namespace Reference

Zend Framework (http://framework.zend.com/) More...

Namespaces
namespace	Exception
	Zend Framework (http://framework.zend.com/)
namespace	Request
	Zend Framework (http://framework.zend.com/)
namespace	Response
	Zend Framework (http://framework.zend.com/)

Classes
class	AbstractSerializer
	Provides base functionality for request and response de/serialization strategies, including functionality for retrieving a line at a time from the message, splitting headers from the body, and serializing headers. More...
class	CallbackStream
	Implementation of PSR HTTP streams. More...
class	HeaderSecurity
	Provide security tools around HTTP headers to prevent common injection vectors. More...
class	PhpInputStream
	Caching version of php://input. More...
class	RelativeStream
class	Request
	HTTP Request encapsulation. More...
class	Response
	HTTP response encapsulation. More...
class	Server
	"Serve" incoming HTTP requests More...
class	ServerRequest
	Server-side HTTP request. More...
class	ServerRequestFactory
	Class for marshaling a request object from the current PHP environment. More...
class	Stream
	Implementation of PSR HTTP streams. More...
class	UploadedFile
class	Uri
	Implementation of Psr. More...

Functions
	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string.
	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version.
	getHeaders ()
	Retrieves all message headers.
	hasHeader ($header)
	Checks if a header exists by the given case-insensitive name.
	getHeader ($header)
	Retrieves a message header value by the given case-insensitive name.
	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header.
	withHeader ($header, $value)
	Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
	withAddedHeader ($header, $value)
	Return an instance with the specified header appended with the given value.
	withoutHeader ($header)
	Return an instance without the specified header.
	getBody ()
	Gets the body of the message.
	withBody (StreamInterface $body)
	Return an instance with the specified message body.
	getRequestTarget ()
	Retrieves the message's request target.
	withRequestTarget ($requestTarget)
	Create a new instance with a specific request-target.
	getMethod ()
	Retrieves the HTTP method of the request.
	withMethod ($method)
	Return an instance with the provided HTTP method.
	getUri ()
	Retrieves the URI instance.
	withUri (UriInterface $uri, $preserveHost=false)
	Returns an instance with the provided URI.

Variables
trait	MessageTrait
	Trait implementing the various methods defined in MessageInterface.
	$headerNames = []
	$protocol = '1.1'
	$stream
	bool hasHeader(string $header)
trait	RequestTrait
	$requestTarget
	$uri

Detailed Description

Zend Framework (http://framework.zend.com/)

See Also

http://github.com/zendframework/zend-diactoros for the canonical source repository

Copyright

Copyright (c) 2015-2016 Zend Technologies USA Inc. (http://www.zend.com) https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License

Function Documentation

Zend\Diactoros\getBody

(

)

Gets the body of the message.

Returns

StreamInterface Returns the body as a stream.

Zend\Diactoros\getHeader

(

$header

)

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

string

$header

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.

Zend\Diactoros\getHeaderLine

(

$name

)

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

string

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

Zend\Diactoros\getHeaders

(

)

Retrieves all message headers.

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); } }

Returns

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

Zend\Diactoros\getMethod

(

)

Retrieves the HTTP method of the request.

Returns

string Returns the request method.

Zend\Diactoros\getProtocolVersion

(

)

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.

Zend\Diactoros\getRequestTarget

(

)

Retrieves the message's request target.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method MUST return the string "/".

Returns

string

Zend\Diactoros\getUri

(

)

Retrieves the URI instance.

This method MUST return a UriInterface instance.

UriInterface Returns a UriInterface instance representing the URI of the request, if any.

Zend\Diactoros\hasHeader

(

$header

)

Checks if a header exists by the given case-insensitive name.

Parameters

string

$header

Case-insensitive header name.

Returns

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

Zend\Diactoros\withAddedHeader	(		$header,
			$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

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

Returns

static

Exceptions

\InvalidArgumentException

for invalid header names or values.

Zend\Diactoros\withBody

(

StreamInterface

$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

StreamInterface

$body

Body.

Returns

static

Exceptions

\InvalidArgumentException

When the body is not valid.

Zend\Diactoros\withHeader	(		$header,
			$value
	)

Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.

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

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

Returns

static

Exceptions

\InvalidArgumentException

for invalid header names or values.

Zend\Diactoros\withMethod

(

$method

)

Return an instance with the provided HTTP method.

While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string.

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 changed request method.

Parameters

string

$method

Case-insensitive method.

Returns

static

Exceptions

InvalidArgumentException

for invalid HTTP methods.

Zend\Diactoros\withoutHeader

(

$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

string

$header

Case-insensitive header field name to remove.

Returns

static

Zend\Diactoros\withProtocolVersion

(

$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

string

$version

HTTP protocol version

Returns

static

Zend\Diactoros\withRequestTarget

(

$requestTarget

)

Create a new instance with a specific request-target.

If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.

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 changed request target.

(for the various request-target forms allowed in request messages) mixed $requestTarget static InvalidArgumentException if the request target is invalid.

Zend\Diactoros\withUri	(	UriInterface	$uri,
			$preserveHost = false
	)

Returns an instance with the provided URI.

This method will update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header will be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting `$preserveHost` to `true`. When `$preserveHost` is set to `true`, the returned request will not update the Host header of the returned message – even if the message contains no Host header. This means that a call to `getHeader('Host')` on the original request MUST equal the return value of a call to `getHeader('Host')` on the returned request.

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 UriInterface instance.

UriInterface $uri New request URI to use. bool $preserveHost Preserve the original state of the Host header. static

Variable Documentation

array $headerNames = []

$protocol = '1.1'

$requestTarget

StreamInterface $stream

bool hasHeader(string $header)

$uri

trait MessageTrait

Initial value:

{
    
    protected $headers = []

Trait implementing the various methods defined in MessageInterface.

See Also

https://github.com/php-fig/http-message/tree/master/src/MessageInterface.php

trait RequestTrait

Initial value:

{
    
    private $method = ''