Trait ServerRequestTrait

Provides a set of methods to represent a Psr-7 server request stream.

Representation of an incoming, server-side HTTP request.

Per the HTTP specification, this interface includes properties for each of the following:

Protocol version
HTTP method
URI
Headers
Message body

Additionally, it encapsulates all data as it has arrived at the application from the CGI and/or PHP environment, including:

The values represented in $_SERVER.
Any cookies provided (generally via $_COOKIE)
Query string arguments (generally via $_GET, or as parsed via parse_str())
Upload files, if any (as represented by $_FILES)
Deserialized body parameters (generally from $_POST)

$_SERVER values MUST be treated as immutable, as they represent application state at the time of request; as such, no methods are provided to allow modification of those values. The other values provide such methods, as they can be restored from $_SERVER or the request body, and may need treatment during the application (e.g., body parameters may be deserialized based on content type).

Additionally, this interface recognizes the utility of introspecting a request to derive and match additional parameters (e.g., via URI path matching, decrypting cookie values, deserializing non-form-encoded body content, matching authorization headers to users, etc). These parameters are stored in an "attributes" property.

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

oroboros\core\traits\libraries\request\ServerRequestTrait uses oroboros\core\traits\libraries\request\RequestTrait

Direct Known Users

oroboros\core\abstracts\libraries\request\AbstractServerRequest

Indirect Known Users

oroboros\core\libraries\request\ServerRequest

Namespace: oroboros\core\traits\libraries\request
Package: oroboros\core\psr7
Category: traits
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/traits.md
Satisfies: \oroboros\core\interfaces\contract\libraries\request\ServerRequestContract
Satisfies: \Psr\Http\Message\ServerRequestInterface
Located at core/traits/libraries/request/ServerRequestTrait.php

Methods summary

`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 `oroboros\core\utilities\exception\InvalidArgumentException` if any passed parameters do not validate
`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 `oroboros\core\traits\libraries\request\ServerRequestTrait` Throws `oroboros\core\utilities\exception\InvalidArgumentException` If instantiation cannot occur due to bad parameters 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 `oroboros\core\traits\libraries\request\ServerRequestTrait` 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. 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 `InvalidArgumentException` if an invalid structure is provided.
`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 `InvalidArgumentException` if an unsupported argument type is provided.
`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 `oroboros\core\traits\libraries\request\ServerRequestTrait::getAttributes()`
`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 `oroboros\core\traits\libraries\request\ServerRequestTrait::getAttributes()`
`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 `oroboros\core\traits\libraries\request\ServerRequestTrait::getAttributes()`
`protected`	# `_initializeServerRequest( array $body, array $headers = null, array $protocol = null, array $host = null, array $uri = null, array $method = null, array $params = array(), array $cookies = array(), array $query = array(), array $files = array(), array $parsed = array(), array $attributes = array() )` Creates a ready instance of a Psr-7 server request message stream. Creates a ready instance of a Psr-7 server request message stream. Parameters `$body` $params An array of parameters, following the convention of the $_SERVER superglobal `$headers` $cookies An array of parameters, following the convention of the $_COOKIES superglobal `$protocol` $query An array of parameters, following the convention of the $_GET superglobal `$host` $files An array of parameters, following the convention of the $_FILES superglobal `$uri` $parsed An array of parameters, following the convention of the $_POST superglobal `$method` $attributes (optional) An array of request-specific parameters `$params` `$cookies` `$query` `$files` `$parsed` `$attributes` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if any passed parameters do not validate
`private`	# `_validateServerRequestParams( string $params )` Validates the params. Params must be an array compatible with the structure of the $_SERVER superglobal. Validates the params. Params must be an array compatible with the structure of the $_SERVER superglobal. Parameters `$params` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_validateServerRequestCookies( string $cookies )` Validates the cookies. Cookies must be an array compatible with the structure of the $_COOKIES superglobal. Validates the cookies. Cookies must be an array compatible with the structure of the $_COOKIES superglobal. Parameters `$cookies` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_validateServerRequestQuery( string $query )` Validates the cookies. Cookies must be an array compatible with the structure of the $_GET superglobal. Validates the cookies. Cookies must be an array compatible with the structure of the $_GET superglobal. Parameters `$query` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_validateServerRequestFiles( string $files )` Validates the files. Files must be an array compatible with the structure of the $_FILES superglobal. Validates the files. Files must be an array compatible with the structure of the $_FILES superglobal. Parameters `$files` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_validateServerRequestParsed( string $parsed )` Validates the parsed values. Parsed values must be an array compatible with the structure of the $_POST superglobal. Validates the parsed values. Parsed values must be an array compatible with the structure of the $_POST superglobal. Parameters `$parsed` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_validateServerRequestAttributes( string $attributes )` Validates the attributes. Attributes must be an array compatible with the structure of the $_POST superglobal. Validates the attributes. Attributes must be an array compatible with the structure of the $_POST superglobal. Parameters `$attributes` Throws `oroboros\core\utilities\exception\InvalidArgumentException`
`private`	# `_setServerRequestParams( string $params )` Creates an object that represents the provided params, and stores it internally. Creates an object that represents the provided params, and stores it internally. Parameters `$params` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid params array is provided
`private`	# `_setServerRequestCookies( string $cookies )` Creates an object that represents the cookies, and stores it internally. Creates an object that represents the cookies, and stores it internally. Parameters `$cookies` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid cookies array is provided
`private`	# `_setServerRequestQuery( string $query )` Creates an object that represents the query, and stores it internally. Creates an object that represents the query, and stores it internally. Parameters `$query` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid query array is provided
`private`	# `_setServerRequestFiles( string $files )` Creates an object that represents the uploaded files, and stores it internally. Creates an object that represents the uploaded files, and stores it internally. Parameters `$files` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid files array is provided
`private`	# `_setServerRequestParsed( string $parsed )` Creates an object that represents the parsed values, and stores it internally. Creates an object that represents the parsed values, and stores it internally. Parameters `$parsed` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid parsed array is provided
`private`	# `_setServerRequestAttributes( string $attributes )` Creates an object that represents the attributes, and stores it internally. Creates an object that represents the attributes, and stores it internally. Parameters `$attributes` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid attribute array is provided
`private resource`	# `_getServerRequestBodyValue( )` Provides a value to satisfy the underlying stream body value, based on the server request values. Provides a value to satisfy the underlying stream body value, based on the server request values. Returns resource
`private array`	# `_getServerRequestHeadersValue( )` Provides a value to satisfy the underlying message headers value, based on the server request values. Provides a value to satisfy the underlying message headers value, based on the server request values. Returns array
`private string`	# `_getServerRequestProtocolValue( )` Provides a value to satisfy the underlying message protocol value, based on the server request values. Provides a value to satisfy the underlying message protocol value, based on the server request values. Returns string
`private string`	# `_getServerRequestHostValue( )` Provides a value to satisfy the underlying request host value, based on the server request values. Provides a value to satisfy the underlying request host value, based on the server request values. Returns string
`private string`	# `_getServerRequestUriValue( )` Provides a value to satisfy the underlying request uri value, based on the server request values. Provides a value to satisfy the underlying request uri value, based on the server request values. Returns string
`private string`	# `_getServerRequestMethodValue( )` Provides a value to satisfy the underlying request method value, based on the server request values. Provides a value to satisfy the underlying request method value, based on the server request values. Returns string
`private array`	# `_getMessageValues( )` Returns the current internal values, for instantiation of new object instances while rendering the current object immutable. Returns the current internal values, for instantiation of new object instances while rendering the current object immutable. Returns array
`private oroboros\core\traits\libraries\request\ServerRequestTrait`	# `_instantiateMessageNewInstance( array $params = null )` Creates a new instance based off of the default parameters, substituting any values passed in. Creates a new instance based off of the default parameters, substituting any values passed in. Parameters `$params` Returns `oroboros\core\traits\libraries\request\ServerRequestTrait`

Methods used from oroboros\core\traits\libraries\request\RequestTrait

_getRequestDefaultHostname(), _getRequestDefaultRequestMethod(), _getRequestDefaultUri(), _initializeRequest(), _setRequestHostHeader(), _setRequestMethod(), _setRequestUri(), _validateRequestHost(), _validateRequestMethod(), _validateRequestUri(), getMethod(), getRequestTarget(), getUri(), withMethod(), withRequestTarget(), withUri()

Properties summary

`private array`	`$_server_request_params` Represents the server request parameters Represents the server request parameters	# `array()`
`private array`	`$_server_request_cookies` Represents the server request cookies. Represents the server request cookies.	# `array()`
`private array`	`$_server_request_query` Represents the server request query Represents the server request query	# `array()`
`private array`	`$_server_request_files` Represents the server request uploaded files Represents the server request uploaded files	# `array()`
`private array`	`$_server_request_parsed` Represents the server request parsed body (POST) content Represents the server request parsed body (POST) content	# `array()`
`private array`	`$_server_request_attributes` Represents the server request attributes Represents the server request attributes	# `array()`
`private boolean`	`$_server_request_is_initialized` Represents whether the server request has been correctly initialized. Represents whether the server request has been correctly initialized.	# `false`

Properties used from oroboros\core\traits\libraries\request\RequestTrait

$_request_is_initialized, $_request_method, $_request_uri, $_request_uri_provided

Namespaces

Traits

Trait ServerRequestTrait

Direct Known Users

Indirect Known Users

Methods summary

Parameters

Throws

Parameters

Returns

Throws

See

Returns

See

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Methods used from oroboros\core\traits\libraries\request\RequestTrait

Properties summary

Properties used from oroboros\core\traits\libraries\request\RequestTrait