public
|
#
__construct( scalar|resource|Psr\Http\Message\StreamInterface $body, array $headers = null, type $protocol = null, string $host = null, string $uri = null, string $method = null, array $params = array(), array $cookies = array(), array $query = array(), array $files = array(), array $parsed = array(), array $attributes = array() )
Instantiates an instance of a Psr-7 server request object.
Instantiates an instance of a Psr-7 server request object.
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"
- $host
- (optional) If provided, a host header will be explicitly set to this value. If not supplied, it will return the current host, or 127.0.0.1 if the host could not be determined or the request originated from CLI.
- $uri
- (optional) If provided, an endpoint uri will be explicitly set to this value. If not supplied, it will return the current host, or 127.0.0.1 if the host could not be determined or the request originated from CLI.
- $method
- (optional) If provided, a request method will be explicitly set to this value. If not supplied, it will return the same request method of the current page load, or GET if it could not be determined or the request originated from CLI.
- $params
- An array of parameters, following the convention of the $_SERVER superglobal
- $cookies
- An array of parameters, following the convention of the $_COOKIE superglobal
- $query
- An array of parameters, following the convention of the $_GET superglobal
- $files
- An array of parameters, following the convention of the $_FILES superglobal
- $parsed
- An array of parameters, following the convention of the $_POST superglobal
- $attributes
- (optional) An array of request-specific parameters
Throws
Implementation of
|
public static
oroboros\core\traits\libraries\request\ServerRequestTrait
|
#
create( array $params = array(), array $cookies = array(), array $query = array(), array $files = array(), array $parsed = array(), array $attributes = array() )
Provides a simpler way of instantiating a new object based
on only the superglobal state or equivalent, so that the
provided constructor does not interfere with the
Liskov Substitution Principle, but in general use,
the object is not cumbersome to generate either.
Provides a simpler way of instantiating a new object based
on only the superglobal state or equivalent, so that the
provided constructor does not interfere with the
Liskov Substitution Principle, but in general use,
the object is not cumbersome to generate either.
This is the suggested means of creating an instance
with your own parameters.
If you would like to automatically create an instance from existing superglobals,
it is suggested to instead use the fromGlobals method.
Parameters
- $params
- $cookies
- $query
- $files
- $parsed
- $attributes
Returns
Throws
See
\oroboros\core\traits\libraries\request\ServerRequestTrait::fromGlobals()
|
public static
oroboros\core\traits\libraries\request\ServerRequestTrait
|
#
fromGlobals( )
This is the suggested means of creating an instance of an object
using this trait automatically from existing globals.
This is the suggested means of creating an instance of an object
using this trait automatically from existing globals.
In the event that you have to pass your own parameters,
it is suggested to use the create method instead.
Returns
See
\oroboros\core\traits\libraries\request\ServerRequestTrait::create()
Constructs an instance of the current class using the current superglobals.
As a safety measure , superglobals will be spoofed as empty arrays if they
are not available (ie: if you have not called session_start , or the
request if from CLI and therefore does not have $_GET or $_POST).
This method will use $_SESSION for the $attributes
parameter of the constructor.
If the request originated from CLI , $argv will be used in place of $_GET
if it is available. The first parameter if $argv is to be omitted , as it
only designates the php script name of the original request , and is
also available in $_SERVER.
The $_REQUEST superglobal is to be ignored , as all of it's values are provided in $_GET and $_POST.
|
public
array
|
#
getServerParams( )
Retrieve server parameters.
Retrieve server parameters.
Retrieves data related to the incoming request environment,
typically derived from PHP's $_SERVER superglobal. The data IS NOT
REQUIRED to originate from $_SERVER.
Returns
array
|
public
array
|
#
getCookieParams( )
Retrieve cookies.
Retrieves cookies sent by the client to the server.
The data MUST be compatible with the structure of the $_COOKIE
superglobal.
Returns
array
|
public
static
|
#
withCookieParams( array $cookies )
Return an instance with the specified cookies.
Return an instance with the specified cookies.
The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
be compatible with the structure of $_COOKIE. Typically, this data will
be injected at instantiation.
This method MUST NOT update the related Cookie header of the request
instance, nor related values in the server params.
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 cookie values.
Parameters
- $cookies
- Array of key/value pairs representing cookies.
Returns
static
|
public
array
|
#
getQueryParams( )
Retrieve query string arguments.
Retrieve query string arguments.
Retrieves the deserialized query string arguments, if any.
Note: the query params might not be in sync with the URI or server
params. If you need to ensure you are only getting the original
values, you may need to parse the query string from getUri()->getQuery()
or from the QUERY_STRING server param.
Returns
array
|
public
static
|
#
withQueryParams( array $query )
Return an instance with the specified query string arguments.
Return an instance with the specified query string arguments.
These values SHOULD remain immutable over the course of the incoming
request. They MAY be injected during instantiation, such as from PHP's
$_GET superglobal, or MAY be derived from some other value such as the
URI. In cases where the arguments are parsed from the URI, the data
MUST be compatible with what PHP's parse_str() would return for
purposes of how duplicate query parameters are handled, and how nested
sets are handled.
Setting query string arguments MUST NOT change the URI stored by the
request, nor the values in the server params.
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 query string arguments.
Parameters
- $query
Array of query string arguments, typically from
$_GET. Returns
static
|
public
array
|
#
getUploadedFiles( )
Retrieve normalized file upload data.
Retrieve normalized file upload data.
This method returns upload metadata in a normalized tree, with each leaf
an instance of Psr\Http\Message\UploadedFileInterface.
These values MAY be prepared from $_FILES or the message body during
instantiation, or MAY be injected via withUploadedFiles().
Returns
array An array tree of UploadedFileInterface instances; an empty
array MUST be returned if no data is present.
|
public
static
|
#
withUploadedFiles( array $uploadedFiles )
Create a new instance with the specified uploaded files.
Create a new instance with the specified uploaded files.
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 body parameters.
Parameters
- $uploadedFiles
- An array tree of UploadedFileInterface instances.
Returns
static
Throws
|
public
null|array|object
|
#
getParsedBody( )
Retrieve any parameters provided in the request body.
Retrieve any parameters provided in the request body.
If the request Content-Type is either application/x-www-form-urlencoded
or multipart/form-data, and the request method is POST, this method MUST
return the contents of $_POST.
Otherwise, this method may return any results of deserializing
the request body content; as parsing returns structured content, the
potential types MUST be arrays or objects only. A null value indicates
the absence of body content.
Returns
null|array|object The deserialized body parameters, if any.
These will typically be an array or object.
|
public
static
|
#
withParsedBody( null|array|object $data )
Return an instance with the specified body parameters.
Return an instance with the specified body parameters.
These MAY be injected during instantiation.
If the request Content-Type is either application/x-www-form-urlencoded
or multipart/form-data, and the request method is POST, use this method
ONLY to inject the contents of $_POST.
The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
deserializing the request body content. Deserialization/parsing returns
structured data, and, as such, this method ONLY accepts arrays or objects,
or a null value if nothing was available to parse.
As an example, if content negotiation determines that the request data
is a JSON payload, this method could be used to create a request
instance with the deserialized parameters.
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 body parameters.
Parameters
- $data
The deserialized body data. This will
typically be in an array or object. Returns
static
Throws
|
public
mixed[]
|
#
getAttributes( )
Retrieve attributes derived from the request.
Retrieve attributes derived from the request.
The request "attributes" may be used to allow injection of any
parameters derived from the request: e.g., the results of path
match operations; the results of decrypting cookies; the results of
deserializing non-form-encoded message bodies; etc. Attributes
will be application and request specific, and CAN be mutable.
Returns
mixed[]
Attributes derived from the request.
|
public
mixed
|
#
getAttribute( string $name, mixed $default = null )
Retrieve a single derived request attribute.
Retrieve a single derived request attribute.
Retrieves a single derived request attribute as described in
getAttributes(). If the attribute has not been previously set, returns
the default value as provided.
This method obviates the need for a hasAttribute() method, as it allows
specifying a default value to return if the attribute is not found.
Parameters
- $name
- The attribute name.
- $default
- Default value to return if the attribute does not exist.
Returns
mixed
See
|
public
static
|
#
withAttribute( string $name, mixed $value )
Return an instance with the specified derived request attribute.
Return an instance with the specified derived request attribute.
This method allows setting a single derived request attribute as
described in getAttributes().
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 attribute.
Parameters
- $name
- The attribute name.
- $value
- The value of the attribute.
Returns
static
See
|
public
static
|
#
withoutAttribute( string $name )
Return an instance that removes the specified derived request attribute.
Return an instance that removes the specified derived request attribute.
This method allows removing a single derived request attribute as
described in getAttributes().
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 attribute.
Parameters
- $name
- The attribute name.
Returns
static
See
|