PHP Класс DmitryDulepov\Realurl\Configuration\ConfigurationReader

Автор: Dmitry Dulepov ([email protected])
Наследование: implements TYPO3\CMS\Core\SingletonInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$alternativeHostName string
$configuration array
$defaultValues array Default values for some configuration options.
$domainConfiguration array | null
$exception Exception
$extConfiguration array
$getVarsToSet array
$hostName string
$mode integer
$urlParameters array
$utility DmitryDulepov\Realurl\Utility

Открытые методы

Метод Описание
__construct ( integer $mode, array $urlParameters = [] ) Initializes the class.
get ( string $path ) : mixed Obtains the configuration by its path. Paths are separated by '/'.
getGetVarsToSet ( ) : array Returns _GET vars to set.
getMode ( ) : integer Returns the current mode.
validate ( ) If the configuration is invalid throws an exception stored earlier. This makes sense only we are have a speaking url.

Защищенные методы

Метод Описание
getConfigurationKey ( ) : string Obtains the configuration key to use.
getConfigurationKeyByDomainDecode ( string $configurationKey ) : string Adjusts configration key for decoding.
getDefaultValue ( string $path ) : mixed Obtains the default value for the option.
getFromConfiguration ( string $path ) : mixed Obtains the value by path from the configuration.
loadExtConfiguration ( ) : void Loads extension configuration.
performAutomaticConfiguration ( ) : void Performs automatic configuration if necessary.
postProcessConfiguration ( ) : void Runs post-processing hooks for extensions.
resolveConfigurationKey ( string $keyAlias ) : string Resolves configuration aliases. For example: 'domain1' => 'domain2', 'domain2' => 'domain3', 'domain3' => array(.
setConfigurationForTheCurrentDomain ( ) : void Sets the configuration from the current domain.
setHostnames ( ) : void Sets host name variables.
setHostnamesForDecoding ( ) : void Sets host name variables for decoding.
setHostnamesForEncoding ( ) : void Sets host name variables for encoding.
setRootPageId ( ) : void Sets the root page id from the current host if that is not set already.
setRootPageIdFromDomainRecord ( ) : boolean Sets the root page id from domain records.
setRootPageIdFromRootFlag ( ) : boolean Sets the root page id from pages with the root flag.
setRootPageIdFromTopLevelPages ( ) : boolean Sets the root page id from the top level pages.
updateConfigurationForEncoding ( string &$configurationKey ) : void Updates _DOMAINS configuration to include only relevant entries and remove rootpage_id option.

Описание методов

__construct() публичный Метод

Initializes the class.
public __construct ( integer $mode, array $urlParameters = [] )
$mode integer One of MODE_* constants
$urlParameters array

get() публичный Метод

Leading and trailing slashes are removed. Special use: 'extconf/xxx' gets the entry from the ext_conf_template.txt.
public get ( string $path ) : mixed
$path string
Результат mixed

getConfigurationKey() защищенный Метод

Obtains the configuration key to use.
protected getConfigurationKey ( ) : string
Результат string

getConfigurationKeyByDomainDecode() защищенный Метод

Adjusts configration key for decoding.
protected getConfigurationKeyByDomainDecode ( string $configurationKey ) : string
$configurationKey string
Результат string

getDefaultValue() защищенный Метод

Obtains the default value for the option.
protected getDefaultValue ( string $path ) : mixed
$path string
Результат mixed

getFromConfiguration() защищенный Метод

Obtains the value by path from the configuration.
См. также: get()
protected getFromConfiguration ( string $path ) : mixed
$path string
Результат mixed

getGetVarsToSet() публичный Метод

Returns _GET vars to set.
public getGetVarsToSet ( ) : array
Результат array

getMode() публичный Метод

Returns the current mode.
public getMode ( ) : integer
Результат integer

loadExtConfiguration() защищенный Метод

Loads extension configuration.
protected loadExtConfiguration ( ) : void
Результат void

performAutomaticConfiguration() защищенный Метод

Performs automatic configuration if necessary.
protected performAutomaticConfiguration ( ) : void
Результат void

postProcessConfiguration() защищенный Метод

Runs post-processing hooks for extensions.
protected postProcessConfiguration ( ) : void
Результат void

resolveConfigurationKey() защищенный Метод

...) will resolve 'domain1' and 'domain2' to 'domain3'.
protected resolveConfigurationKey ( string $keyAlias ) : string
$keyAlias string
Результат string

setConfigurationForTheCurrentDomain() защищенный Метод

Sets the configuration from the current domain.
protected setConfigurationForTheCurrentDomain ( ) : void
Результат void

setHostnames() защищенный Метод

Sets host name variables.
protected setHostnames ( ) : void
Результат void

setHostnamesForDecoding() защищенный Метод

Sets host name variables for decoding.
protected setHostnamesForDecoding ( ) : void
Результат void

setHostnamesForEncoding() защищенный Метод

Sets host name variables for encoding.
protected setHostnamesForEncoding ( ) : void
Результат void

setRootPageId() защищенный Метод

Sets the root page id from the current host if that is not set already.
protected setRootPageId ( ) : void
Результат void

setRootPageIdFromDomainRecord() защищенный Метод

Sets the root page id from domain records.
protected setRootPageIdFromDomainRecord ( ) : boolean
Результат boolean

setRootPageIdFromRootFlag() защищенный Метод

Sets the root page id from pages with the root flag.
protected setRootPageIdFromRootFlag ( ) : boolean
Результат boolean

setRootPageIdFromTopLevelPages() защищенный Метод

Sets the root page id from the top level pages.
protected setRootPageIdFromTopLevelPages ( ) : boolean
Результат boolean

updateConfigurationForEncoding() защищенный Метод

Updates _DOMAINS configuration to include only relevant entries and remove rootpage_id option.
protected updateConfigurationForEncoding ( string &$configurationKey ) : void
$configurationKey string
Результат void

validate() публичный Метод

This must be called once prior to using get() call.
public validate ( )

Описание свойств

$alternativeHostName защищенное свойство

protected string $alternativeHostName
Результат string

$configuration защищенное свойство

protected array $configuration
Результат array

$defaultValues защищенное свойство

Default values for some configuration options.
protected array $defaultValues
Результат array

$domainConfiguration защищенное свойство

protected array|null $domainConfiguration
Результат array | null

$exception защищенное свойство

protected Exception $exception
Результат Exception

$extConfiguration защищенное свойство

protected array $extConfiguration
Результат array

$getVarsToSet защищенное свойство

protected array $getVarsToSet
Результат array

$hostName защищенное свойство

protected string $hostName
Результат string

$mode защищенное свойство

protected int $mode
Результат integer

$urlParameters защищенное свойство

protected array $urlParameters
Результат array

$utility защищенное свойство

protected Utility,DmitryDulepov\Realurl $utility
Результат DmitryDulepov\Realurl\Utility