API Documentation
\
FACTFinder
Adapter
Core
Client
Server
Data
Util

\FACTFinder\Core\ServerUrlBuilder

Assembles URLs to the FACT-Finder server for different kinds of authentication based on the given parameters and the configuration.

Summary

Methods
Properties
Constants
__construct()
getNonAuthenticationUrl()
getAuthenticationUrl()
No public properties found
No constants found
getAdvancedAuthenticationUrl()
getSimpleAuthenticationUrl()
getHttpAuthenticationUrl()
ensureChannelParameter()
buildAddress()
$configuration
N/A
No private methods found
$log
N/A

Properties

$configuration

$configuration : \FACTFinder\Core\Server\ConfigurationInterface

Type

\FACTFinder\Core\Server\ConfigurationInterface

$log

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

Type

\FACTFinder\Core\Server\FACTFinder\Util\LoggerInterface

Methods

__construct()

__construct(string  $loggerClass, \FACTFinder\Core\Server\ConfigurationInterface  $configuration)

Parameters

string $loggerClass

Class name of logger to use. The class should implement FACTFinder\Util\LoggerInterface.
\FACTFinder\Core\Server\ConfigurationInterface $configuration

getNonAuthenticationUrl()

getNonAuthenticationUrl(string  $action, \FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters) : string

Get URL without authentication data.

Note that this method may set a channel parameter if there is none already.

Parameters

string $action

The action to be targeted on the FACT-Finder server.
\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object from which to build the URL.

Returns

string —

The full URL.

getAuthenticationUrl()

getAuthenticationUrl(string  $action, \FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters) : string

Returns a full URL with authentication data. The type of authentication is determined from the configuration.

Note that this method may set a channel parameter if there is none already.

Parameters

string $action

The action to be targeted on the FACT-Finder server.
\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object from which to build the URL.

Throws

\FACTFinder\Core\Server\Exception

if no valid authentication type was configured.

Returns

string —

The full URL.

getAdvancedAuthenticationUrl()

getAdvancedAuthenticationUrl(string  $action, \FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters) : string

Get URL with advanced authentication encryption.

Parameters

string $action

The action to be targeted on the FACT-Finder server.
\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object from which to build the URL.

Returns

string —

The full URL.

getSimpleAuthenticationUrl()

getSimpleAuthenticationUrl(string  $action, \FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters) : string

Get URL with simple authentication encryption.

Parameters

string $action

The action to be targeted on the FACT-Finder server.
\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object from which to build the URL.

Returns

string —

The full URL.

getHttpAuthenticationUrl()

getHttpAuthenticationUrl(string  $action, \FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters) : string

Get URL with HTTP authentication.

Parameters

string $action

The action to be targeted on the FACT-Finder server.
\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object from which to build the URL.

Returns

string —

The full URL.

ensureChannelParameter()

ensureChannelParameter(\FACTFinder\Core\Server\FACTFinder\Util\Parameters  $parameters)

If no channel is set, try to fill it from configuration data.

Parameters

\FACTFinder\Core\Server\FACTFinder\Util\Parameters $parameters

The parameters object to check.

buildAddress()

buildAddress(  $action,   $includeHttpAuthentication = false)

Parameters

$action
$includeHttpAuthentication