\FACTFinder\Core\ClientUrlBuilder

Generates URLs to be used in requests to the client.

Summary

Methods
Properties
Constants
__construct()
generateUrl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$log
$parametersConverter
$requestParser
$encodingConverter
N/A

Properties

$log

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

Type

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

$parametersConverter

$parametersConverter : \FACTFinder\Core\Client\FACTFinder\Core\ParametersConverter

Type

\FACTFinder\Core\Client\FACTFinder\Core\ParametersConverter

$requestParser

$requestParser : \FACTFinder\Core\Client\FACTFinder\Core\Client\RequestParser

Type

\FACTFinder\Core\Client\FACTFinder\Core\Client\RequestParser

$encodingConverter

$encodingConverter : \FACTFinder\Core\Client\FACTFinder\Core\AbstractEncodingConverter

Type

\FACTFinder\Core\Client\FACTFinder\Core\AbstractEncodingConverter

Methods

generateUrl()

generateUrl(\FACTFinder\Core\Client\FACTFinder\Util\Parameters  $parameters, string  $target = null) : string

Generates a link to be used on the page that leads to the client from a set of server parameters. Note that the link will still be UTF-8 encoded.

If the page uses a different encoding, conversion to that encoding has to be done when actually rendering the string to the page.

TODO: Should the signature be more similar to that of \Server\UrlBuilder?

Parameters

\FACTFinder\Core\Client\FACTFinder\Util\Parameters $parameters

The server parameters that should be retrieved when the link is followed.

string $target

An optional request target. If omitted, the target of the current request will be used. For instance, this parameter can be used if a product detail page needs a different target.

Returns

string