kernel/classes/ezurlaliasfilter.php
inherited
Classes
File containing the eZURLAliasFilter class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\eZURLAliasFilter
The eZURLAliasFilter class the interface for all url alias filters, the filter implementation must implement the process method.
For execution of the configured filters use the static method processFilters. Help with configuration is found in settings/site.ini under the group URLTranslator.
- Children
- \eZURLAliasFilterAppendNodeID
- Abstract
Methods
eZURLAliasFilter(
)
:
voidInitialize the filter object.
process(
$text, $languageObject, $caller
)
:
void| Name | Type | Description |
|---|---|---|
| $text | ||
| $languageObject | ||
| $caller |
processFilters(
string $text, string $languageObject, object $caller
)
:
stringProcess all configured filters and return the resulting text.
Filters are found in the INI group URLTranslator and the setting Filters. This is done in combination with the setting Extensions which controls which extensions have filter classes.
The parameters $text, $languageObject and $caller are sent to the method process on the filter object.
Note: The filter list will be cached in memory to improve performance of subsequent calls.
| Name | Type | Description |
|---|---|---|
| $text | string | The URL alias |
| $languageObject | string | The current language object used for the string $text. |
| $caller | object | The object which called the filtering process, can be null. |
| Type | Description |
|---|---|
| string | the URL alias processed by the process() method |
- Static