PHP Класс DmitryDulepov\Realurl\EncodeDecoderBase

Автор: Dmitry Dulepov ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$pageTitleFields array

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

Свойство Тип Описание
$cache DmitryDulepov\Realurl\Cache\CacheInterface
$configuration DmitryDulepov\Realurl\Configuration\ConfigurationReader
$databaseConnection TYPO3\CMS\Core\Database\DatabaseConnection
$emptySegmentValue string
$ignoredUrlParameters array
$pageRepository TYPO3\CMS\Frontend\Page\PageRepository
$rootPageId integer
$separatorCharacter string Undocumented, unsupported & deprecated.
$tsfe TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController
$utility Utility

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

Метод Описание
__construct ( ) Initializes the class.

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

Метод Описание
checkLegacyCondition ( array $conditionConfiguration, string $previousValue ) : boolean Checks conditions for xxxVar.
createQueryStringFromParameters ( array $parameters ) : mixed Creates a query string (without preceeding question mark) from parameters.
getConfigurationForPostVars ( array $configuration, integer $pageId ) : array Sets configuration blocks for fixedPostVars and postVarSets according to priority: current page id first, _DEFAULT last. Also resolves aliases for configuration.
getFromAliasCacheByAliasValue ( array $configuration, string $aliasValue, boolean $onlyNonExpired ) : integer Looks up an ID value (integer) in lookup-table based on input alias value.
getSortedUrl ( string $url ) : string Obtains URL with all query parameters sorted.
initialize ( ) Initializes the instance.
initializeConfiguration ( ) : void Initializes confguration reader.
isInWorkspace ( ) : boolean Checks if system runs in non-live workspace
removeIgnoredParametersFromQueryString ( string $queryString ) : string Removes ignored parameters from the query string.
removeIgnoredParametersFromURL ( string $url ) : string Removes ignored parameters from the URL. Removed parameters are stored in $this->ignoredUrlParameters and can be restored using restoreIgnoredUrlParameters.
restoreIgnoredUrlParameters ( array &$urlParameters ) Restores ignored URL parameters.
restoreIgnoredUrlParametersInURL ( string $url ) : string Restores ignored URL parameters.
sortArrayDeep ( array &$pathParts ) : void Sorts the array deeply.

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

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

Initializes the class.
public __construct ( )

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

Checks conditions for xxxVar.
protected checkLegacyCondition ( array $conditionConfiguration, string $previousValue ) : boolean
$conditionConfiguration array
$previousValue string
Результат boolean

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

Creates a query string (without preceeding question mark) from parameters.
protected createQueryStringFromParameters ( array $parameters ) : mixed
$parameters array
Результат mixed

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

Sets configuration blocks for fixedPostVars and postVarSets according to priority: current page id first, _DEFAULT last. Also resolves aliases for configuration.
protected getConfigurationForPostVars ( array $configuration, integer $pageId ) : array
$configuration array
$pageId integer
Результат array

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

(The lookup table for id<->alias is meant to contain UNIQUE alias strings for id integers) In the lookup table 'tx_realurl_uniqalias' the field "value_alias" should be unique (per combination of field_alias+field_id+tablename)! However the "value_id" field doesn't have to; that is a feature which allows more aliases to point to the same id. The alias selected for converting id to alias will be the first inserted at the moment. This might be more intelligent in the future, having an order column which can be controlled from the backend for instance!
protected getFromAliasCacheByAliasValue ( array $configuration, string $aliasValue, boolean $onlyNonExpired ) : integer
$configuration array
$aliasValue string
$onlyNonExpired boolean
Результат integer ID integer. If none is found: false

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

Obtains URL with all query parameters sorted.
protected getSortedUrl ( string $url ) : string
$url string
Результат string

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

Initializes the instance.
protected initialize ( )

initializeConfiguration() абстрактный защищенный Метод

Initializes confguration reader.
abstract protected initializeConfiguration ( ) : void
Результат void

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

Checks if system runs in non-live workspace
protected isInWorkspace ( ) : boolean
Результат boolean

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

Removes ignored parameters from the query string.
protected removeIgnoredParametersFromQueryString ( string $queryString ) : string
$queryString string
Результат string

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

Removes ignored parameters from the URL. Removed parameters are stored in $this->ignoredUrlParameters and can be restored using restoreIgnoredUrlParameters.
protected removeIgnoredParametersFromURL ( string $url ) : string
$url string
Результат string

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

Restores ignored URL parameters.
protected restoreIgnoredUrlParameters ( array &$urlParameters )
$urlParameters array

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

Restores ignored URL parameters.
protected restoreIgnoredUrlParametersInURL ( string $url ) : string
$url string
Результат string

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

Sorts the array deeply.
protected sortArrayDeep ( array &$pathParts ) : void
$pathParts array
Результат void

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

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

protected CacheInterface,DmitryDulepov\Realurl\Cache $cache
Результат DmitryDulepov\Realurl\Cache\CacheInterface

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

protected ConfigurationReader,DmitryDulepov\Realurl\Configuration $configuration
Результат DmitryDulepov\Realurl\Configuration\ConfigurationReader

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

protected DatabaseConnection,TYPO3\CMS\Core\Database $databaseConnection
Результат TYPO3\CMS\Core\Database\DatabaseConnection

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

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

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

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

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

protected PageRepository,TYPO3\CMS\Frontend\Page $pageRepository
Результат TYPO3\CMS\Frontend\Page\PageRepository

$pageTitleFields публичное статическое свойство

public static array $pageTitleFields
Результат array

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

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

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

Undocumented, unsupported & deprecated.
protected string $separatorCharacter
Результат string

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

protected TypoScriptFrontendController,TYPO3\CMS\Frontend\Controller $tsfe
Результат TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController

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

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