Class ServerRequestFactory
Factory for making ServerRequest instances.
This subclass adds in CakePHP specific behavior to populate the basePath and webroot attributes. Furthermore the Uri's path is corrected to only contain the 'virtual' path for the request.
Method Summary
-
createUri() public static
Create a new Uri instance from the provided server data.
-
fromGlobals() public static
Create a request from the supplied superglobal values.
-
get() public static deprecated
Access a value in an array, returning a default value if not found
-
getBase() protected static
Calculate the base directory and webroot directory.
-
getHeader() public static deprecated
Search for a header value.
-
marshalHeaders() public static deprecated
Marshal headers from $_SERVER
-
marshalHostAndPortFromHeaders() public static deprecated
Marshal the host and port from HTTP headers and/or the PHP environment
-
marshalRequestUri() public static deprecated
Detect the base URI for the request
-
marshalUriFromServer() public static
Build a UriInterface object.
-
normalizeFiles() public static deprecated
Normalize uploaded files
-
normalizeServer() public static
Marshal the $_SERVER array
-
stripQueryString() public static deprecated
Strip the query string from a path
-
updatePath() protected static
Updates the request URI to remove the base directory.
Method Detail
createUri() ¶ public static
createUri(array $server = []): Psr\Http\Message\UriInterfaceCreate a new Uri instance from the provided server data.
Parameters
-
array$server optional Array of server data to build the Uri from. $_SERVER will be added into the $server parameter.
Returns
Psr\Http\Message\UriInterfacefromGlobals() ¶ public static
fromGlobals(array $server = null, array $query = null, array $body = null, array $cookies = null, array $files = null): ServerRequestCreate a request from the supplied superglobal values.
If any argument is not supplied, the corresponding superglobal value will be used.
The ServerRequest created is then passed to the fromServer() method in order to marshal the request URI and headers.
Parameters
-
array$server optional -
array$query optional -
array$body optional -
array$cookies optional -
array$files optional
Returns
ServerRequestget() ¶ public static
get(string $key, array $values, mixed $default = null): mixedAccess a value in an array, returning a default value if not found
Parameters
-
string$key -
array$values -
mixed$default optional
Returns
mixedgetBase() ¶ protected static
getBase(Psr\Http\Message\UriInterface $uri, array $server): arrayCalculate the base directory and webroot directory.
Parameters
-
Psr\Http\Message\UriInterface$uri The Uri instance.
-
array$server The SERVER data to use.
Returns
arraygetHeader() ¶ public static
getHeader(string $header, array $headers, mixed $default = null): stringSearch for a header value.
Does a case-insensitive search for a matching header.
If found, it is returned as a string, using comma concatenation.
If not, the $default is returned.
Parameters
-
string$header -
array$headers -
mixed$default optional
Returns
stringmarshalHeaders() ¶ public static
marshalHeaders(array $server): arrayMarshal headers from $_SERVER
Parameters
-
array$server
Returns
arraymarshalHostAndPortFromHeaders() ¶ public static
marshalHostAndPortFromHeaders(stdClass $accumulator, array $server, array $headers)Marshal the host and port from HTTP headers and/or the PHP environment
Parameters
-
stdClass$accumulator -
array$server -
array$headers
marshalRequestUri() ¶ public static
marshalRequestUri(array $server): stringDetect the base URI for the request
Looks at a variety of criteria in order to attempt to autodetect a base URI, including rewrite URIs, proxy URIs, etc.
Parameters
-
array$server
Returns
stringmarshalUriFromServer() ¶ public static
marshalUriFromServer(array $server, array $headers): Psr\Http\Message\UriInterfaceBuild a UriInterface object.
Add in some CakePHP specific logic/properties that help preserve backwards compatibility.
Parameters
-
array$server The server parameters.
-
array$headers The normalized headers
Returns
Psr\Http\Message\UriInterfacenormalizeFiles() ¶ public static
normalizeFiles(array $files): arrayNormalize uploaded files
Transforms each value into an UploadedFileInterface instance, and ensures that nested arrays are normalized.
Parameters
-
array$files
Returns
arrayThrows
InvalidArgumentExceptionfor unrecognized values
normalizeServer() ¶ public static
normalizeServer(array $server): arrayMarshal the $_SERVER array
Pre-processes and returns the $_SERVER superglobal.
Parameters
-
array$server
Returns
arraystripQueryString() ¶ public static
stripQueryString(mixed $path): stringStrip the query string from a path
Parameters
-
mixed$path
Returns
stringupdatePath() ¶ protected static
updatePath(string $base, Psr\Http\Message\UriInterface $uri): Psr\Http\Message\UriInterfaceUpdates the request URI to remove the base directory.
Parameters
-
string$base The base path to remove.
-
Psr\Http\Message\UriInterface$uri The uri to update.
Returns
Psr\Http\Message\UriInterface