Slim\Http\Request Class Reference

Request. More...

Inheritance diagram for Slim\Http\Request:

Collaboration diagram for Slim\Http\Request:

Public Member Functions
	__construct ( $method, UriInterface $uri, HeadersInterface $headers, array $cookies, array $serverParams, StreamInterface $body, array $uploadedFiles=[])
	Create new HTTP request. More...
	__clone ()
	This method is applied to the cloned object after PHP performs an initial shallow-copy. More...
	getMethod ()
	Retrieves the HTTP method of the request. More...
	getOriginalMethod ()
	Get the original HTTP method (ignore override). More...
	withMethod ($method)
	Return an instance with the provided HTTP method. More...
	isMethod ($method)
	Does this request use a given method? More...
	isGet ()
	Is this a GET request? More...
	isPost ()
	Is this a POST request? More...
	isPut ()
	Is this a PUT request? More...
	isPatch ()
	Is this a PATCH request? More...
	isDelete ()
	Is this a DELETE request? More...
	isHead ()
	Is this a HEAD request? More...
	isOptions ()
	Is this a OPTIONS request? More...
	isXhr ()
	Is this an XHR request? More...
	getRequestTarget ()
	Retrieves the message's request target. More...
	withRequestTarget ($requestTarget)
	Return an instance with the specific request-target. More...
	getUri ()
	Retrieves the URI instance. More...
	withUri (UriInterface $uri, $preserveHost=false)
	Returns an instance with the provided URI. More...
	getContentType ()
	Get request content type. More...
	getMediaType ()
	Get request media type, if known. More...
	getMediaTypeParams ()
	Get request media type params, if known. More...
	getContentCharset ()
	Get request content character set, if known. More...
	getContentLength ()
	Get request content length, if known. More...
	getCookieParams ()
	Retrieve cookies. More...
	getCookieParam ($key, $default=null)
	Fetch cookie value from cookies sent by the client to the server. More...
	withCookieParams (array $cookies)
	Return an instance with the specified cookies. More...
	getQueryParams ()
	Retrieve query string arguments. More...
	withQueryParams (array $query)
	Return an instance with the specified query string arguments. More...
	getUploadedFiles ()
	Retrieve normalized file upload data. More...
	withUploadedFiles (array $uploadedFiles)
	Create a new instance with the specified uploaded files. More...
	getServerParams ()
	Retrieve server parameters. More...
	getServerParam ($key, $default=null)
	Retrieve a server parameter. More...
	getAttributes ()
	Retrieve attributes derived from the request. More...
	getAttribute ($name, $default=null)
	Retrieve a single derived request attribute. More...
	withAttribute ($name, $value)
	Return an instance with the specified derived request attribute. More...
	withAttributes (array $attributes)
	Create a new instance with the specified derived request attributes. More...
	withoutAttribute ($name)
	Return an instance that removes the specified derived request attribute. More...
	getParsedBody ()
	Retrieve any parameters provided in the request body. More...
	withParsedBody ($data)
	Return an instance with the specified body parameters. More...
	reparseBody ()
	Force Body to be parsed again. More...
	registerMediaTypeParser ($mediaType, callable $callable)
	Register media type parser. More...
	getParam ($key, $default=null)
	Fetch request parameter value from body or query string (in that order). More...
	getParsedBodyParam ($key, $default=null)
	Fetch parameter value from request body. More...
	getQueryParam ($key, $default=null)
	Fetch parameter value from query string. More...
	getParams (array $only=null)
	Fetch associative array of body and query string parameters. More...
Public Member Functions inherited from Slim\Http\Message
	__set ($name, $value)
	Disable magic setter to ensure immutability. More...
	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string. More...
	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version. More...
	getHeaders ()
	Retrieves all message header values. More...
	hasHeader ($name)
	Checks if a header exists by the given case-insensitive name. More...
	getHeader ($name)
	Retrieves a message header value by the given case-insensitive name. More...
	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header. More...
	withHeader ($name, $value)
	Return an instance with the provided value replacing the specified header. More...
	withAddedHeader ($name, $value)
	Return an instance with the specified header appended with the given value. More...
	withoutHeader ($name)
	Return an instance without the specified header. More...
	getBody ()
	Gets the body of the message. More...
	withBody (StreamInterface $body)
	Return an instance with the specified message body. More...

Static Public Member Functions
static	createFromEnvironment (Environment $environment)
	Create new HTTP request with data extracted from the application Environment object. More...

Protected Member Functions
	filterMethod ($method)
	Validate the HTTP method. More...

Protected Attributes
	$method
	$originalMethod
	$uri
	$requestTarget
	$queryParams
	$cookies
	$serverParams
	$attributes
	$bodyParsed = false
	$bodyParsers = []
	$uploadedFiles
	$validMethods
Protected Attributes inherited from Slim\Http\Message
	$protocolVersion = '1.1'
	$headers
	$body

Additional Inherited Members
Static Protected Attributes inherited from Slim\Http\Message
static	$validProtocolVersions

Detailed Description

Request.

This class represents an HTTP request. It manages the request method, URI, headers, cookies, and body according to the PSR-7 standard.

https://github.com/php-fig/http-message/blob/master/src/RequestInterface.php https://github.com/php-fig/http-message/blob/master/src/ServerRequestInterface.php

Definition at line 33 of file Request.php.

Constructor & Destructor Documentation

__construct()

Slim\Http\Request::__construct	(		$method,
		UriInterface	$uri,
		HeadersInterface	$headers,
		array	$cookies,
		array	$serverParams,
		StreamInterface	$body,
		array	$uploadedFiles = []
	)

Create new HTTP request.

Adds a host header when none was provided and a host is defined in uri.

Parameters

string	$method	The request method
UriInterface	$uri	The request URI object
HeadersInterface	$headers	The request headers collection
array	$cookies	The request cookies collection
array	$serverParams	The server environment variables
StreamInterface	$body	The request body object
array	$uploadedFiles	The request uploadedFiles collection

Exceptions

InvalidMethodException

on invalid HTTP method

Definition at line 173 of file Request.php.

References Slim\Http\Message\$body, Slim\Http\Request\$cookies, $data, Slim\Http\Message\$headers, Slim\Http\Request\$method, $result, Slim\Http\Request\$serverParams, Slim\Http\Request\$uploadedFiles, Slim\Http\Request\$uri, Slim\Http\Request\filterMethod(), and Slim\Http\Request\registerMediaTypeParser().

      {
        try {
            $this->originalMethod = $this->filterMethod($method);
        } catch (InvalidMethodException $e) {
            $this->originalMethod = $method;
        }

        $this->uri = $uri;
        $this->headers = $headers;
        $this->cookies = $cookies;
        $this->serverParams = $serverParams;
        $this->attributes = new Collection();
        $this->body = $body;
        $this->uploadedFiles = $uploadedFiles;

        if (isset($serverParams['SERVER_PROTOCOL'])) {
            $this->protocolVersion = str_replace('HTTP/', '', $serverParams['SERVER_PROTOCOL']);
        }

        if (!$this->headers->has('Host') && $this->uri->getHost() !== '') {
            $port = $this->uri->getPort() ? ":{$this->uri->getPort()}" : '';

            $this->headers->set('Host', $this->uri->getHost() . $port);
        }

        $this->registerMediaTypeParser('application/json', function ($input) {
            $result = json_decode($input, true);
            if (!is_array($result)) {
                return null;
            }
            return $result;
        });

        $this->registerMediaTypeParser('application/xml', function ($input) {
            $backup = libxml_disable_entity_loader(true);
            $backup_errors = libxml_use_internal_errors(true);
            $result = simplexml_load_string($input);
            libxml_disable_entity_loader($backup);
            libxml_clear_errors();
            libxml_use_internal_errors($backup_errors);
            if ($result === false) {
                return null;
            }
            return $result;
        });

        $this->registerMediaTypeParser('text/xml', function ($input) {
            $backup = libxml_disable_entity_loader(true);
            $backup_errors = libxml_use_internal_errors(true);
            $result = simplexml_load_string($input);
            libxml_disable_entity_loader($backup);
            libxml_clear_errors();
            libxml_use_internal_errors($backup_errors);
            if ($result === false) {
                return null;
            }
            return $result;
        });

        $this->registerMediaTypeParser('application/x-www-form-urlencoded', function ($input) {
            parse_str($input, $data);
            return $data;
        });

        // if the request had an invalid method, we can throw it now
        if (isset($e) && $e instanceof InvalidMethodException) {
            throw $e;
        }
    }

Here is the call graph for this function:

Member Function Documentation

__clone()

Slim\Http\Request::__clone

(

)

This method is applied to the cloned object after PHP performs an initial shallow-copy.

This method completes a deep-copy by creating new objects for the cloned object's internal reference pointers.

Definition at line 257 of file Request.php.

References Slim\Http\Request\$attributes, Slim\Http\Message\$body, and Slim\Http\Message\$headers.

    {
        $this->headers = clone $this->headers;
        $this->attributes = clone $this->attributes;
        $this->body = clone $this->body;
    }

createFromEnvironment()

static Slim\Http\Request::createFromEnvironment ( Environment  $environment )

static

Create new HTTP request with data extracted from the application Environment object.

Parameters

Environment

$environment

The Slim application Environment

Returns

static

Definition at line 138 of file Request.php.

References $_POST, Slim\Http\Message\$body, Slim\Http\Request\$cookies, Slim\Http\Message\$headers, Slim\Http\Request\$method, Slim\Http\Request\$serverParams, Slim\Http\Request\$uploadedFiles, Slim\Http\Request\$uri, Slim\Collection\all(), Slim\Http\Headers\createFromEnvironment(), Slim\Http\UploadedFile\createFromEnvironment(), Slim\Http\Uri\createFromEnvironment(), and Slim\Http\Cookies\parseHeader().

    {
        $method = $environment['REQUEST_METHOD'];
        $uri = Uri::createFromEnvironment($environment);
        $headers = Headers::createFromEnvironment($environment);
        $cookies = Cookies::parseHeader($headers->get('Cookie', []));
        $serverParams = $environment->all();
        $body = new RequestBody();
        $uploadedFiles = UploadedFile::createFromEnvironment($environment);

        $request = new static($method, $uri, $headers, $cookies, $serverParams, $body, $uploadedFiles);

        if ($method === 'POST' &&
            in_array($request->getMediaType(), ['application/x-www-form-urlencoded', 'multipart/form-data'])
        ) {
            // parsed body must be $_POST
            $request = $request->withParsedBody($_POST);
        }
        return $request;
    }

Here is the call graph for this function:

filterMethod()

Slim\Http\Request::filterMethod (   $method )

protected

Validate the HTTP method.

Parameters

null | string

$method

Returns

null|string

Exceptions

Definition at line 340 of file Request.php.

References Slim\Http\Request\$method.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\getMethod(), and Slim\Http\Request\withMethod().

    {
        if ($method === null) {
            return $method;
        }

        if (!is_string($method)) {
            throw new InvalidArgumentException(sprintf(
                'Unsupported HTTP method; must be a string, received %s',
                (is_object($method) ? get_class($method) : gettype($method))
            ));
        }

        $method = strtoupper($method);
        if (preg_match("/^[!#$%&'*+.^_`|~0-9a-z-]+$/i", $method) !== 1) {
            throw new InvalidMethodException($this, $method);
        }

        return $method;
    }

Here is the caller graph for this function:

getAttribute()

Slim\Http\Request::getAttribute	(		$name,
			$default = null
	)

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.

See also

getAttributes()

Parameters

string	$name	The attribute name.
mixed	$default	Default value to return if the attribute does not exist.

Returns

mixed

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 928 of file Request.php.

References $name.

    {
        return $this->attributes->get($name, $default);
    }

getAttributes()

Slim\Http\Request::getAttributes

(

)

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

array Attributes derived from the request.

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 908 of file Request.php.

    {
        return $this->attributes->all();
    }

getContentCharset()

Slim\Http\Request::getContentCharset

(

)

Get request content character set, if known.

Note: This method is not part of the PSR-7 standard.

Returns

string|null

Definition at line 669 of file Request.php.

References Slim\Http\Request\getMediaTypeParams().

    {
        $mediaTypeParams = $this->getMediaTypeParams();
        if (isset($mediaTypeParams['charset'])) {
            return $mediaTypeParams['charset'];
        }

        return null;
    }

Here is the call graph for this function:

getContentLength()

Slim\Http\Request::getContentLength

(

)

Get request content length, if known.

Note: This method is not part of the PSR-7 standard.

Returns

int|null

Definition at line 686 of file Request.php.

References $result.

    {
        $result = $this->headers->get('Content-Length');

        return $result ? (int)$result[0] : null;
    }

getContentType()

Slim\Http\Request::getContentType

(

)

Get request content type.

Note: This method is not part of the PSR-7 standard.

Returns

string|null The request content type, if known

Definition at line 613 of file Request.php.

References $result, and Slim\Http\Message\getHeader().

Referenced by Slim\Http\Request\getMediaType(), and Slim\Http\Request\getMediaTypeParams().

    {
        $result = $this->getHeader('Content-Type');

        return $result ? $result[0] : null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCookieParam()

Slim\Http\Request::getCookieParam	(		$key,
			$default = null
	)

Fetch cookie value from cookies sent by the client to the server.

Note: This method is not part of the PSR-7 standard.

Parameters

string	$key	The attribute name.
mixed	$default	Default value to return if the attribute does not exist.

Returns

mixed

Definition at line 722 of file Request.php.

References Slim\Http\Request\$cookies, $key, $result, and Slim\Http\Request\getCookieParams().

    {
        $cookies = $this->getCookieParams();
        $result = $default;
        if (isset($cookies[$key])) {
            $result = $cookies[$key];
        }

        return $result;
    }

Here is the call graph for this function:

getCookieParams()

Slim\Http\Request::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

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 707 of file Request.php.

References Slim\Http\Request\$cookies.

Referenced by Slim\Http\Request\getCookieParam().

    {
        return $this->cookies;
    }

Here is the caller graph for this function:

getMediaType()

Slim\Http\Request::getMediaType

(

)

Get request media type, if known.

Note: This method is not part of the PSR-7 standard.

Returns

string|null The request media type, minus content-type params

Definition at line 627 of file Request.php.

References $contentType, and Slim\Http\Request\getContentType().

Referenced by Slim\Http\Request\getParsedBody().

    {
        $contentType = $this->getContentType();
        if ($contentType) {
            $contentTypeParts = preg_split('/\s*[;,]\s*/', $contentType);

            return strtolower($contentTypeParts[0]);
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMediaTypeParams()

Slim\Http\Request::getMediaTypeParams

(

)

Get request media type params, if known.

Note: This method is not part of the PSR-7 standard.

Returns

array

Definition at line 646 of file Request.php.

References $contentType, $i, and Slim\Http\Request\getContentType().

Referenced by Slim\Http\Request\getContentCharset().

    {
        $contentType = $this->getContentType();
        $contentTypeParams = [];
        if ($contentType) {
            $contentTypeParts = preg_split('/\s*[;,]\s*/', $contentType);
            $contentTypePartsLength = count($contentTypeParts);
            for ($i = 1; $i < $contentTypePartsLength; $i++) {
                $paramParts = explode('=', $contentTypeParts[$i]);
                $contentTypeParams[strtolower($paramParts[0])] = $paramParts[1];
            }
        }

        return $contentTypeParams;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMethod()

Slim\Http\Request::getMethod

(

)

Retrieves the HTTP method of the request.

Returns

string Returns the request method.

Implements Psr\Http\Message\RequestInterface.

Definition at line 273 of file Request.php.

References Slim\Http\Request\$method, Slim\Http\Request\$originalMethod, Slim\Http\Request\filterMethod(), Slim\Http\Message\getBody(), Slim\Http\Message\getHeaderLine(), and Slim\Http\Request\getParsedBodyParam().

Referenced by Slim\Http\Request\isMethod().

    {
        if ($this->method === null) {
            $this->method = $this->originalMethod;
            $customMethod = $this->getHeaderLine('X-Http-Method-Override');

            if ($customMethod) {
                $this->method = $this->filterMethod($customMethod);
            } elseif ($this->originalMethod === 'POST') {
                $overrideMethod = $this->filterMethod($this->getParsedBodyParam('_METHOD'));
                if ($overrideMethod !== null) {
                    $this->method = $overrideMethod;
                }

                if ($this->getBody()->eof()) {
                    $this->getBody()->rewind();
                }
            }
        }

        return $this->method;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOriginalMethod()

Slim\Http\Request::getOriginalMethod

(

)

Get the original HTTP method (ignore override).

Note: This method is not part of the PSR-7 standard.

Returns

string

Definition at line 303 of file Request.php.

References Slim\Http\Request\$originalMethod.

    {
        return $this->originalMethod;
    }

getParam()

Slim\Http\Request::getParam	(		$key,
			$default = null
	)

Fetch request parameter value from body or query string (in that order).

Note: This method is not part of the PSR-7 standard.

Parameters

string	$key	The parameter key.
mixed	$default	The default value.

Returns

mixed The parameter value.

Definition at line 1141 of file Request.php.

References $key, $result, Slim\Http\Request\getParsedBody(), and Slim\Http\Request\getQueryParams().

    {
        $postParams = $this->getParsedBody();
        $getParams = $this->getQueryParams();
        $result = $default;
        if (is_array($postParams) && isset($postParams[$key])) {
            $result = $postParams[$key];
        } elseif (is_object($postParams) && property_exists($postParams, $key)) {
            $result = $postParams->$key;
        } elseif (isset($getParams[$key])) {
            $result = $getParams[$key];
        }

        return $result;
    }

Here is the call graph for this function:

getParams()

Slim\Http\Request::getParams

(

array

$only = null

)

Fetch associative array of body and query string parameters.

Note: This method is not part of the PSR-7 standard.

Parameters

array | null

$only

list the keys to retrieve.

Returns

array|null

Definition at line 1209 of file Request.php.

References $key, $params, array, Slim\Http\Request\getParsedBody(), and Slim\Http\Request\getQueryParams().

    {
        $params = $this->getQueryParams();
        $postParams = $this->getParsedBody();
        if ($postParams) {
            $params = array_replace($params, (array)$postParams);
        }

        if ($only) {
            $onlyParams = [];
            foreach ($only as $key) {
                if (array_key_exists($key, $params)) {
                    $onlyParams[$key] = $params[$key];
                }
            }
            return $onlyParams;
        }

        return $params;
    }

Here is the call graph for this function:

getParsedBody()

Slim\Http\Request::getParsedBody

(

)

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.

Exceptions

RuntimeException

if the request body media type parser returns an invalid value

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 1021 of file Request.php.

References Slim\Http\Message\$body, Slim\Http\Request\$bodyParsed, Slim\Http\Message\getBody(), Slim\Http\Request\getMediaType(), and string.

Referenced by Slim\Http\Request\getParam(), Slim\Http\Request\getParams(), and Slim\Http\Request\getParsedBodyParam().

    {
        if ($this->bodyParsed !== false) {
            return $this->bodyParsed;
        }

        if (!$this->body) {
            return null;
        }

        $mediaType = $this->getMediaType();

        // look for a media type with a structured syntax suffix (RFC 6839)
        $parts = explode('+', $mediaType);
        if (count($parts) >= 2) {
            $mediaType = 'application/' . $parts[count($parts)-1];
        }

        if (isset($this->bodyParsers[$mediaType]) === true) {
            $body = (string)$this->getBody();
            $parsed = $this->bodyParsers[$mediaType]($body);

            if (!is_null($parsed) && !is_object($parsed) && !is_array($parsed)) {
                throw new RuntimeException(
                    'Request body media type parser return value must be an array, an object, or null'
                );
            }
            $this->bodyParsed = $parsed;
            return $this->bodyParsed;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParsedBodyParam()

Slim\Http\Request::getParsedBodyParam	(		$key,
			$default = null
	)

Fetch parameter value from request body.

Note: This method is not part of the PSR-7 standard.

Parameters

string	$key
mixed	$default

Returns

mixed

Definition at line 1167 of file Request.php.

References $key, $result, and Slim\Http\Request\getParsedBody().

Referenced by Slim\Http\Request\getMethod().

    {
        $postParams = $this->getParsedBody();
        $result = $default;
        if (is_array($postParams) && isset($postParams[$key])) {
            $result = $postParams[$key];
        } elseif (is_object($postParams) && property_exists($postParams, $key)) {
            $result = $postParams->$key;
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQueryParam()

Slim\Http\Request::getQueryParam	(		$key,
			$default = null
	)

Fetch parameter value from query string.

Note: This method is not part of the PSR-7 standard.

Parameters

string	$key
mixed	$default

Returns

mixed

Definition at line 1190 of file Request.php.

References $key, $result, and Slim\Http\Request\getQueryParams().

    {
        $getParams = $this->getQueryParams();
        $result = $default;
        if (isset($getParams[$key])) {
            $result = $getParams[$key];
        }

        return $result;
    }

Here is the call graph for this function:

getQueryParams()

Slim\Http\Request::getQueryParams

(

)

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

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 774 of file Request.php.

References Slim\Http\Request\$queryParams.

Referenced by Slim\Http\Request\getParam(), Slim\Http\Request\getParams(), and Slim\Http\Request\getQueryParam().

    {
        if (is_array($this->queryParams)) {
            return $this->queryParams;
        }

        if ($this->uri === null) {
            return [];
        }

        parse_str($this->uri->getQuery(), $this->queryParams); // <-- URL decodes data

        return $this->queryParams;
    }

Here is the caller graph for this function:

getRequestTarget()

Slim\Http\Request::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

Implements Psr\Http\Message\RequestInterface.

Definition at line 490 of file Request.php.

References $path, $query, and Slim\Http\Request\$requestTarget.

    {
        if ($this->requestTarget) {
            return $this->requestTarget;
        }

        if ($this->uri === null) {
            return '/';
        }

        $basePath = $this->uri->getBasePath();
        $path = $this->uri->getPath();
        $path = $basePath . '/' . ltrim($path, '/');

        $query = $this->uri->getQuery();
        if ($query) {
            $path .= '?' . $query;
        }
        $this->requestTarget = $path;

        return $this->requestTarget;
    }

getServerParam()

Slim\Http\Request::getServerParam	(		$key,
			$default = null
	)

Retrieve a server parameter.

Note: This method is not part of the PSR-7 standard.

Parameters

string	$key
mixed	$default

Returns

mixed

Definition at line 886 of file Request.php.

References $key, Slim\Http\Request\$serverParams, and Slim\Http\Request\getServerParams().

    {
        $serverParams = $this->getServerParams();

        return isset($serverParams[$key]) ? $serverParams[$key] : $default;
    }

Here is the call graph for this function:

getServerParams()

Slim\Http\Request::getServerParams

(

)

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

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 872 of file Request.php.

References Slim\Http\Request\$serverParams.

Referenced by Slim\Http\Request\getServerParam().

    {
        return $this->serverParams;
    }

Here is the caller graph for this function:

getUploadedFiles()

Slim\Http\Request::getUploadedFiles

(

)

Retrieve normalized file upload data.

This method returns upload metadata in a normalized tree, with each leaf an instance of Psr.

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.

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 835 of file Request.php.

References Slim\Http\Request\$uploadedFiles.

    {
        return $this->uploadedFiles;
    }

getUri()

Slim\Http\Request::getUri

(

)

Retrieves the URI instance.

This method MUST return a UriInterface instance.

UriInterface Returns a UriInterface instance representing the URI of the request.

Implements Psr\Http\Message\RequestInterface.

Definition at line 553 of file Request.php.

References Slim\Http\Request\$uri.

    {
        return $this->uri;
    }

isDelete()

Slim\Http\Request::isDelete

(

)

Is this a DELETE request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 429 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('DELETE');
    }

Here is the call graph for this function:

isGet()

Slim\Http\Request::isGet

(

)

Is this a GET request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 381 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('GET');
    }

Here is the call graph for this function:

isHead()

Slim\Http\Request::isHead

(

)

Is this a HEAD request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 441 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('HEAD');
    }

Here is the call graph for this function:

isMethod()

Slim\Http\Request::isMethod

(

$method

)

Does this request use a given method?

Note: This method is not part of the PSR-7 standard.

Parameters

string

$method

HTTP method

Returns

bool

Definition at line 369 of file Request.php.

References Slim\Http\Request\$method, and Slim\Http\Request\getMethod().

Referenced by Slim\Http\Request\isDelete(), Slim\Http\Request\isGet(), Slim\Http\Request\isHead(), Slim\Http\Request\isOptions(), Slim\Http\Request\isPatch(), Slim\Http\Request\isPost(), and Slim\Http\Request\isPut().

    {
        return $this->getMethod() === $method;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isOptions()

Slim\Http\Request::isOptions

(

)

Is this a OPTIONS request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 453 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('OPTIONS');
    }

Here is the call graph for this function:

isPatch()

Slim\Http\Request::isPatch

(

)

Is this a PATCH request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 417 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('PATCH');
    }

Here is the call graph for this function:

isPost()

Slim\Http\Request::isPost

(

)

Is this a POST request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 393 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('POST');
    }

Here is the call graph for this function:

isPut()

Slim\Http\Request::isPut

(

)

Is this a PUT request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 405 of file Request.php.

References Slim\Http\Request\isMethod().

    {
        return $this->isMethod('PUT');
    }

Here is the call graph for this function:

isXhr()

Slim\Http\Request::isXhr

(

)

Is this an XHR request?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 465 of file Request.php.

References Slim\Http\Message\getHeaderLine().

    {
        return $this->getHeaderLine('X-Requested-With') === 'XMLHttpRequest';
    }

Here is the call graph for this function:

registerMediaTypeParser()

Slim\Http\Request::registerMediaTypeParser	(		$mediaType,
		callable	$callable
	)

Register media type parser.

Note: This method is not part of the PSR-7 standard.

Parameters

string	$mediaType	A HTTP media type (excluding content-type params).
callable	$callable	A callable that returns parsed contents for media type.

Definition at line 1119 of file Request.php.

References string.

Referenced by Slim\Http\Request\__construct().

    {
        if ($callable instanceof Closure) {
            $callable = $callable->bindTo($this);
        }
        $this->bodyParsers[(string)$mediaType] = $callable;
    }

Here is the caller graph for this function:

reparseBody()

Slim\Http\Request::reparseBody

(

)

Force Body to be parsed again.

Note: This method is not part of the PSR-7 standard.

Returns

$this

Definition at line 1102 of file Request.php.

    {
        $this->bodyParsed = false;

        return $this;
    }

withAttribute()

Slim\Http\Request::withAttribute	(		$name,
			$value
	)

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.

See also

getAttributes()

Parameters

string	$name	The attribute name.
mixed	$value	The value of the attribute.

Returns

static

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 948 of file Request.php.

References $name.

    {
        $clone = clone $this;
        $clone->attributes->set($name, $value);

        return $clone;
    }

withAttributes()

Slim\Http\Request::withAttributes

(

array

$attributes

)

Create a new instance with the specified derived request attributes.

Note: This method is not part of the PSR-7 standard.

This method allows setting all new derived request attributes as described in getAttributes().

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 updated attributes.

Parameters

array

$attributes

New attributes

Returns

static

Definition at line 971 of file Request.php.

    {
        $clone = clone $this;
        $clone->attributes = new Collection($attributes);

        return $clone;
    }

withCookieParams()

Slim\Http\Request::withCookieParams

(

array

$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

array

$cookies

Array of key/value pairs representing cookies.

Returns

static

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 750 of file Request.php.

References Slim\Http\Request\$cookies.

    {
        $clone = clone $this;
        $clone->cookies = $cookies;

        return $clone;
    }

withMethod()

Slim\Http\Request::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-sensitive method.

Returns

static

Exceptions

Implements Psr\Http\Message\RequestInterface.

Definition at line 323 of file Request.php.

References Slim\Http\Request\$method, and Slim\Http\Request\filterMethod().

    {
        $method = $this->filterMethod($method);
        $clone = clone $this;
        $clone->originalMethod = $method;
        $clone->method = $method;

        return $clone;
    }

Here is the call graph for this function:

withoutAttribute()

Slim\Http\Request::withoutAttribute

(

$name

)

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.

See also

getAttributes()

Parameters

string

$name

The attribute name.

Returns

static

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 993 of file Request.php.

References $name.

    {
        $clone = clone $this;
        $clone->attributes->remove($name);

        return $clone;
    }

withParsedBody()

Slim\Http\Request::withParsedBody

(

$data

)

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

null | array | object

$data

The deserialized body data. This will typically be in an array or object.

Returns

static

Exceptions

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 1083 of file Request.php.

References $data.

    {
        if (!is_null($data) && !is_object($data) && !is_array($data)) {
            throw new InvalidArgumentException('Parsed body value must be an array, an object, or null');
        }

        $clone = clone $this;
        $clone->bodyParsed = $data;

        return $clone;
    }

withQueryParams()

Slim\Http\Request::withQueryParams

(

array

$query

)

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

array

$query

Array of query string arguments, typically from $_GET.

Returns

static

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 811 of file Request.php.

References $query.

    {
        $clone = clone $this;
        $clone->queryParams = $query;

        return $clone;
    }

withRequestTarget()

Slim\Http\Request::withRequestTarget

(

$requestTarget

)

Return an instance with the 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 an 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

Implements Psr\Http\Message\RequestInterface.

Definition at line 531 of file Request.php.

References Slim\Http\Request\$requestTarget.

    {
        if (preg_match('#\s#', $requestTarget)) {
            throw new InvalidArgumentException(
                'Invalid request target provided; must be a string and cannot contain whitespace'
            );
        }
        $clone = clone $this;
        $clone->requestTarget = $requestTarget;

        return $clone;
    }

withUploadedFiles()

Slim\Http\Request::withUploadedFiles

(

array

$uploadedFiles

)

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

array

$uploadedFiles

An array tree of UploadedFileInterface instances.

Returns

static

Exceptions

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 851 of file Request.php.

References Slim\Http\Request\$uploadedFiles.

    {
        $clone = clone $this;
        $clone->uploadedFiles = $uploadedFiles;

        return $clone;
    }

withUri()

Slim\Http\Request::withUri	(	UriInterface	$uri,
			$preserveHost = false
	)

Returns an instance with the provided URI.

This method MUST 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 MUST 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, this method interacts with the Host header in the following ways:

• If the the Host header is missing or empty, and the new URI contains a host component, this method MUST update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method MUST NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method MUST NOT update the Host header in 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

Implements Psr\Http\Message\RequestInterface.

Definition at line 588 of file Request.php.

References Slim\Http\Request\$uri, Slim\Http\Message\getHeaderLine(), Psr\Http\Message\UriInterface\getHost(), and Slim\Http\Message\hasHeader().

    {
        $clone = clone $this;
        $clone->uri = $uri;

        if (!$preserveHost) {
            if ($uri->getHost() !== '') {
                $clone->headers->set('Host', $uri->getHost());
            }
        } else {
            if ($uri->getHost() !== '' && (!$this->hasHeader('Host') || $this->getHeaderLine('Host') === '')) {
                $clone->headers->set('Host', $uri->getHost());
            }
        }

        return $clone;
    }

Here is the call graph for this function:

Field Documentation

$attributes

Slim\Http\Request::$attributes

protected

Definition at line 89 of file Request.php.

Referenced by Slim\Http\Request\__clone().

$bodyParsed

Slim\Http\Request::$bodyParsed = false

protected

Definition at line 96 of file Request.php.

Referenced by Slim\Http\Request\getParsedBody().

$bodyParsers

Slim\Http\Request::$bodyParsers = []

protected

Definition at line 103 of file Request.php.

$cookies

Slim\Http\Request::$cookies

protected

Definition at line 75 of file Request.php.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Request\getCookieParam(), Slim\Http\Request\getCookieParams(), and Slim\Http\Request\withCookieParams().

$method

Slim\Http\Request::$method

protected

Definition at line 40 of file Request.php.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Request\filterMethod(), Slim\Http\Request\getMethod(), Slim\Http\Request\isMethod(), and Slim\Http\Request\withMethod().

$originalMethod

Slim\Http\Request::$originalMethod

protected

Definition at line 47 of file Request.php.

Referenced by Slim\Http\Request\getMethod(), and Slim\Http\Request\getOriginalMethod().

$queryParams

Slim\Http\Request::$queryParams

protected

Definition at line 68 of file Request.php.

Referenced by Slim\Http\Request\getQueryParams().

$requestTarget

Slim\Http\Request::$requestTarget

protected

Definition at line 61 of file Request.php.

Referenced by Slim\Http\Request\getRequestTarget(), and Slim\Http\Request\withRequestTarget().

$serverParams

Slim\Http\Request::$serverParams

protected

Definition at line 82 of file Request.php.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Request\getServerParam(), and Slim\Http\Request\getServerParams().

$uploadedFiles

Slim\Http\Request::$uploadedFiles

protected

Definition at line 110 of file Request.php.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Request\getUploadedFiles(), and Slim\Http\Request\withUploadedFiles().

$uri

Slim\Http\Request::$uri

protected

Definition at line 54 of file Request.php.

Referenced by Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Request\getUri(), and Slim\Http\Request\withUri().

$validMethods

Slim\Http\Request::$validMethods

protected

Initial value:

= [
        'CONNECT' => 1

Definition at line 118 of file Request.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/slim/slim/Slim/Http/Request.php