\FACTFinder\Core\ClientRequestParser

Extracts several data from the request made to the client.

Summary

Methods
Properties
Constants
__construct()
getRequestParameters()
getClientRequestParameters()
getRequestTarget()
No public properties found
No constants found
No protected methods found
$clientRequestParameters
$serverRequestParameters
$requestTarget
$configuration
$encodingConverter
$parametersConverter
N/A
No private methods found
$log
N/A

Properties

$clientRequestParameters

$clientRequestParameters : 

Type

$serverRequestParameters

$serverRequestParameters : 

Type

$requestTarget

$requestTarget : 

Type

$configuration

$configuration : \FACTFinder\Core\Client\ConfigurationInterface

Type

\FACTFinder\Core\Client\ConfigurationInterface

$encodingConverter

$encodingConverter : \FACTFinder\Core\Client\AbstractEncodingConverter

Type

\FACTFinder\Core\Client\AbstractEncodingConverter

$parametersConverter

$parametersConverter : \FACTFinder\Core\Client\ParametersConverter

Type

\FACTFinder\Core\Client\ParametersConverter

$log

$log : \FACTFinder\Core\Client\FACTFinder\Util\LoggerInterface

Type

\FACTFinder\Core\Client\FACTFinder\Util\LoggerInterface

Methods

__construct()

__construct(string  $loggerClass, \FACTFinder\Core\Client\ConfigurationInterface  $configuration, \FACTFinder\Core\Client\AbstractEncodingConverter  $encodingConverter = null) 

Parameters

string $loggerClass

Class name of logger to use. The class should implement FACTFinder\Util\LoggerInterface.

\FACTFinder\Core\Client\ConfigurationInterface $configuration
\FACTFinder\Core\Client\AbstractEncodingConverter $encodingConverter

getRequestParameters()

getRequestParameters() : \FACTFinder\Core\Client\Parameters

Loads parameters from the request and returns a Parameter object.

Also takes care of encoding conversion if necessary. Finally it will make all necessary conversions according to the ignore/require/mapping directives given in the configuration for the server. Use this method for any other part of the library that needs the request parameters.

Returns

\FACTFinder\Core\Client\Parameters —

Array of UTF-8 encoded and converted parameters

getClientRequestParameters()

getClientRequestParameters() : \FACTFinder\Core\Client\Parameters

Loads parameters from the request and returns a Parameter object.

Also takes care of encoding conversion if necessary. However, the parameters themselves are not converted (that is ignore, require and mapping directives in the configuration are not taken into account).

You won't usually need this method unless you really want to get access to some parameters that would be ignored or mapped otherwise.

For use with any other part of the library, use getRequestParameters() instead, which converts the parameters for usage with the server.

Returns

\FACTFinder\Core\Client\Parameters —

Array of UTF-8 encoded parameters

getRequestTarget()

getRequestTarget() : string

Get target of the current request.

Returns

string —

request target