PHP Класс eZ\Publish\Core\SignalSlot\URLAliasService

Наследование: implements eZ\Publish\API\Repository\URLAliasService
Показать файл Открыть проект

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

Свойство Тип Описание
$service eZ\Publish\API\Repository\URLAliasService Aggregated service.
$signalDispatcher SignalDispatcher SignalDispatcher.

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

Метод Описание
__construct ( eZ\Publish\API\Repository\URLAliasService $service, SignalDispatcher $signalDispatcher ) Constructor.
createGlobalUrlAlias ( string $resource, string $path, string $languageCode, boolean $forwarding = false, boolean $alwaysAvailable = false ) : eZ\Publish\API\Repository\Values\Content\URLAlias Create a user chosen $alias pointing to a resource in $languageCode.
createUrlAlias ( eZ\Publish\API\Repository\Values\Content\Location $location, string $path, string $languageCode, boolean $forwarding = false, boolean $alwaysAvailable = false ) : eZ\Publish\API\Repository\Values\Content\URLAlias Create a user chosen $alias pointing to $location in $languageCode.
listGlobalAliases ( string $languageCode = null, integer $offset, integer $limit ) : eZ\Publish\API\Repository\Values\Content\URLAlias[] List global aliases.
listLocationAliases ( eZ\Publish\API\Repository\Values\Content\Location $location, boolean $custom = true, string $languageCode = null, null | boolean $showAllTranslations = null, array $prioritizedLanguageList = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias[] List of url aliases pointing to $location, sorted by language priority.
load ( string $id ) : eZ\Publish\API\Repository\Values\Content\URLAlias Loads URL alias by given $id.
lookup ( string $url, string $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias looks up the URLAlias for the given url.
removeAliases ( array $aliasList ) Removes urls aliases.
reverseLookup ( eZ\Publish\API\Repository\Values\Content\Location $location, string $languageCode = null, null | boolean $showAllTranslations = null, array $prioritizedLanguageList = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias Returns the URL alias for the given location in the given language.

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

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

Construct service object from aggregated service and signal dispatcher
public __construct ( eZ\Publish\API\Repository\URLAliasService $service, SignalDispatcher $signalDispatcher )
$service eZ\Publish\API\Repository\URLAliasService
$signalDispatcher SignalDispatcher

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

This method does not handle location resources - if a user enters a location target the createCustomUrlAlias method has to be used. This method runs URL filters and and transformers before storing them. Hence the path returned in the URLAlias Value may differ from the given. $alwaysAvailable makes the alias available in all languages.
public createGlobalUrlAlias ( string $resource, string $path, string $languageCode, boolean $forwarding = false, boolean $alwaysAvailable = false ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$resource string
$path string
$languageCode string
$forwarding boolean
$alwaysAvailable boolean
Результат eZ\Publish\API\Repository\Values\Content\URLAlias

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

This method runs URL filters and transformers before storing them. Hence the path returned in the URLAlias Value may differ from the given. $alwaysAvailable makes the alias available in all languages.
public createUrlAlias ( eZ\Publish\API\Repository\Values\Content\Location $location, string $path, string $languageCode, boolean $forwarding = false, boolean $alwaysAvailable = false ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$location eZ\Publish\API\Repository\Values\Content\Location
$path string
$languageCode string the languageCode for which this alias is valid
$forwarding boolean if true a redirect is performed
$alwaysAvailable boolean
Результат eZ\Publish\API\Repository\Values\Content\URLAlias

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

List global aliases.
public listGlobalAliases ( string $languageCode = null, integer $offset, integer $limit ) : eZ\Publish\API\Repository\Values\Content\URLAlias[]
$languageCode string filters those which are valid for the given language
$offset integer
$limit integer
Результат eZ\Publish\API\Repository\Values\Content\URLAlias[]

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

List of url aliases pointing to $location, sorted by language priority.
public listLocationAliases ( eZ\Publish\API\Repository\Values\Content\Location $location, boolean $custom = true, string $languageCode = null, null | boolean $showAllTranslations = null, array $prioritizedLanguageList = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias[]
$location eZ\Publish\API\Repository\Values\Content\Location
$custom boolean if true the user generated aliases are listed otherwise the autogenerated
$languageCode string filters those which are valid for the given language
$showAllTranslations null | boolean
$prioritizedLanguageList array
Результат eZ\Publish\API\Repository\Values\Content\URLAlias[]

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

Loads URL alias by given $id.
public load ( string $id ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$id string
Результат eZ\Publish\API\Repository\Values\Content\URLAlias

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

looks up the URLAlias for the given url.
public lookup ( string $url, string $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$url string
$languageCode string
Результат eZ\Publish\API\Repository\Values\Content\URLAlias

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

This method does not remove autogenerated aliases for locations.
public removeAliases ( array $aliasList )
$aliasList array

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

If $languageCode is null the method returns the url alias in the most prioritized language.
public reverseLookup ( eZ\Publish\API\Repository\Values\Content\Location $location, string $languageCode = null, null | boolean $showAllTranslations = null, array $prioritizedLanguageList = null ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$location eZ\Publish\API\Repository\Values\Content\Location
$languageCode string
$showAllTranslations null | boolean
$prioritizedLanguageList array
Результат eZ\Publish\API\Repository\Values\Content\URLAlias

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

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

Aggregated service.
protected URLAliasService,eZ\Publish\API\Repository $service
Результат eZ\Publish\API\Repository\URLAliasService

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

SignalDispatcher.
protected SignalDispatcher,eZ\Publish\Core\SignalSlot $signalDispatcher
Результат SignalDispatcher