PHP Class eZ\Publish\Core\SignalSlot\URLAliasService

Inheritance: implements eZ\Publish\API\Repository\URLAliasService

Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property	Type	Description
$service	eZ\Publish\API\Repository\URLAliasService	Aggregated service.
$signalDispatcher	SignalDispatcher	SignalDispatcher.

Public Methods

Method	Description
__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.

Method Details

__construct() public method

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() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias

createUrlAlias() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias

listGlobalAliases() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias[]

listLocationAliases() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias[]

load() public method

Loads URL alias by given $id.

public load ( string $id ) : eZ\Publish\API\Repository\Values\Content\URLAlias
$id	string
return	eZ\Publish\API\Repository\Values\Content\URLAlias

lookup() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias

removeAliases() public method

This method does not remove autogenerated aliases for locations.

public removeAliases ( array $aliasList )
$aliasList	array

reverseLookup() public method

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
return	eZ\Publish\API\Repository\Values\Content\URLAlias

Property Details

$service protected property

Aggregated service.

protected URLAliasService,eZ\Publish\API\Repository $service
return	eZ\Publish\API\Repository\URLAliasService

$signalDispatcher protected property

SignalDispatcher.

protected SignalDispatcher,eZ\Publish\Core\SignalSlot $signalDispatcher
return	SignalDispatcher