\FACTFinder\CoreXmlConfiguration

Implements ConfigurationInterface by reading from an XML file. Also allows for some values to be changed later on.

Summary

Methods

Properties

Constants

getCustomValue()
isDebugEnabled()
getRequestProtocol()
getServerAddress()
getServerPort()
getContext()
getChannel()
getLanguage()
isHttpAuthenticationType()
isSimpleAuthenticationType()
isAdvancedAuthenticationType()
getUserName()
getPassword()
getAuthenticationPrefix()
getAuthenticationPostfix()
getClientMappings()
getServerMappings()
getIgnoredClientParameters()
getIgnoredServerParameters()
getWhitelistClientParameters()
getWhitelistServerParameters()
getRequiredClientParameters()
getRequiredServerParameters()
getDefaultConnectTimeout()
getDefaultTimeout()
getSuggestConnectTimeout()
getSuggestTimeout()
getTrackingConnectTimeout()
getTrackingTimeout()
getImportConnectTimeout()
getImportTimeout()
getPageContentEncoding()
getClientUrlEncoding()
__construct()
makeHttpAuthenticationType()
makeSimpleAuthenticationType()
makeAdvancedAuthenticationType()
setPageContentEncoding()
setClientUrlEncoding()

No public properties found

HTTP_AUTHENTICATION
SIMPLE_AUTHENTICATION
ADVANCED_AUTHENTICATION

No protected methods found

No protected properties found

N/A

retrieveAuthenticationType()
retrieveMappings()
retrieveIgnoredParameters()
retrieveWhitelistParameters()
retrieveRequiredParameters()

$configuration
$authenticationType
$clientMappings
$serverMappings
$ignoredClientParameters
$ignoredServerParameters
$whitelistClientParameters
$whitelistServerParameters
$requiredClientParameters
$requiredServerParameters
$pageContentEncoding
$clientUrlEncoding

N/A

File: Core\XmlConfiguration.php
Package: Default
Class hierarchy: \FACTFinder\Core\AbstractConfiguration

\FACTFinder\Core\XmlConfiguration

Constants

HTTP_AUTHENTICATION

HTTP_AUTHENTICATION

SIMPLE_AUTHENTICATION

SIMPLE_AUTHENTICATION

ADVANCED_AUTHENTICATION

ADVANCED_AUTHENTICATION

Properties

$configuration

$configuration : \FACTFinder\Core\SimpleXMLElement

Type

\FACTFinder\Core\SimpleXMLElement — XML representation of the configuration.

$authenticationType

$authenticationType :

Type

$clientMappings

$clientMappings :

Type

$serverMappings

$serverMappings :

Type

$ignoredClientParameters

$ignoredClientParameters :

Type

$ignoredServerParameters

$ignoredServerParameters :

Type

$whitelistClientParameters

$whitelistClientParameters :

Type

$whitelistServerParameters

$whitelistServerParameters :

Type

$requiredClientParameters

$requiredClientParameters :

Type

$requiredServerParameters

$requiredServerParameters :

Type

$pageContentEncoding

$pageContentEncoding :

Type

$clientUrlEncoding

$clientUrlEncoding :

Type

Methods

getCustomValue()

getCustomValue(  $name) : string

Parameters

$name

Returns

string —

value

isDebugEnabled()

isDebugEnabled() : boolean

Returns

boolean

getRequestProtocol()

getRequestProtocol() : string

Returns

string

getServerAddress()

getServerAddress() : string

Returns

string

getServerPort()

getServerPort() : integer

Returns

integer

getContext()

getContext() : string

Returns

string

getChannel()

getChannel() : string

Returns

string

getLanguage()

getLanguage() : string

Returns

string

isHttpAuthenticationType()

isHttpAuthenticationType() : boolean

Returns

boolean

isSimpleAuthenticationType()

isSimpleAuthenticationType() : boolean

Returns

boolean

isAdvancedAuthenticationType()

isAdvancedAuthenticationType() : boolean

Returns

boolean

getUserName()

getUserName() : string

Returns

string

getPassword()

getPassword() : string

Returns

string

getAuthenticationPrefix()

getAuthenticationPrefix() : string

Returns

string

getAuthenticationPostfix()

getAuthenticationPostfix() : string

Returns

string

getClientMappings()

getClientMappings() : array

Get mappings from server to client parameters.

Returns

array

getServerMappings()

getServerMappings() : array

Get mappings from client to server parameters.

Returns

array

getIgnoredClientParameters()

getIgnoredClientParameters() : array

Get parameters which should be ignored in client URLs.

Returns

array —

with string as key and boolean true as value for each item

getIgnoredServerParameters()

getIgnoredServerParameters() : array

Get parameters which should be ignored in server URLs.

Returns

array —

with string as key and boolean true as value for each item

getWhitelistClientParameters()

getWhitelistClientParameters() : array

Get parameters which are allowed in client URLs.

Returns

array —

with string as key and boolean true as value for each item

getWhitelistServerParameters()

getWhitelistServerParameters() : array

Get parameters which are allowed in server URLs.

Returns

array —

with string as key and boolean true as value for each item

getRequiredClientParameters()

getRequiredClientParameters() : array

Get parameters which are required in client URLs.

Returns

array —

with parameter name as key and default value as value.

getRequiredServerParameters()

getRequiredServerParameters() : array

Get parameters which are required in server URLs.

Returns

array —

with parameter name as key and default value as value.

getDefaultConnectTimeout()

getDefaultConnectTimeout() : integer

Get default connect timeout for all adapters.

Returns

integer

getDefaultTimeout()

getDefaultTimeout() : integer

Get default timeout for all adapters.

Returns

integer

getSuggestConnectTimeout()

getSuggestConnectTimeout() : integer

Get connect timeout for Suggest adapter.

Returns

integer

getSuggestTimeout()

getSuggestTimeout() : integer

Get timeout for Suggest adapter.

Returns

integer

getTrackingConnectTimeout()

getTrackingConnectTimeout() : integer

Get connect timeout for Tracking adapter.

Returns

integer

getTrackingTimeout()

getTrackingTimeout() : integer

Get timeout for Tracking adapter.

Returns

integer

getImportConnectTimeout()

getImportConnectTimeout() : integer

Get connect timeout for Import adapter.

Returns

integer

getImportTimeout()

getImportTimeout() : integer

Get timeout for Import adapter-

Returns

integer

getPageContentEncoding()

getPageContentEncoding() : string

Get encoding for content to be sent to the browser.

Returns

string

getClientUrlEncoding()

getClientUrlEncoding() : string

Get encoding for URLs of the client.

Returns

string

__construct()

__construct(string  $fileName, \FACTFinder\Core\type  $element,   $data_is_url = true) : \FACTFinder\Core\XmlConfiguration

Create a new configuration from an XML file. The outer element in the XML tree must be named <configuration>. The actual data is read from a child of this element whose name can be specified through the second argument.

Parameters

string	$fileName	Name of configuration file.
\FACTFinder\Core\type	$element	Name of the XML element from which to read configuration data.
	$data_is_url

Returns

\FACTFinder\Core\XmlConfiguration

makeHttpAuthenticationType()

makeHttpAuthenticationType()

makeSimpleAuthenticationType()

makeSimpleAuthenticationType()

makeAdvancedAuthenticationType()

makeAdvancedAuthenticationType()

setPageContentEncoding()

setPageContentEncoding(  $encoding)

Parameters

$encoding

setClientUrlEncoding()

setClientUrlEncoding(  $encoding)

Parameters

$encoding

retrieveAuthenticationType()

retrieveAuthenticationType()

retrieveMappings()

retrieveMappings(\SimpleXMLElement  $section)

Parameters

\SimpleXMLElement

$section

retrieveIgnoredParameters()

retrieveIgnoredParameters(\SimpleXMLElement  $section)

Parameters

\SimpleXMLElement

$section

retrieveWhitelistParameters()

retrieveWhitelistParameters(\SimpleXMLElement  $section)

Parameters

\SimpleXMLElement

$section

retrieveRequiredParameters()

retrieveRequiredParameters(\SimpleXMLElement  $section)

Parameters

\SimpleXMLElement

$section