eZPublish(LegacyStack)  5.1
eZURLAliasFilter Class Reference

The eZURLAliasFilter class the interface for all url alias filters, the filter implementation must implement the process method. More...

+ Inheritance diagram for eZURLAliasFilter:

Public Member Functions

 eZURLAliasFilter ()
 Initialize the filter object. More...
 
 process ($text, &$languageObject, &$caller)
 

Static Public Member Functions

static processFilters ($text, $languageObject, $caller)
 Process all configured filters and return the resulting text. More...
 

Detailed Description

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.

Member Function Documentation

eZURLAliasFilter::eZURLAliasFilter ( )

Initialize the filter object.

eZURLAliasFilter::process (   $text,
$languageObject,
$caller 
)
static eZURLAliasFilter::processFilters (   $text,
  $languageObject,
  $caller 
)
static

Process all configured filters and return the resulting text.

Filters are found in the INI group URLTranslator and the setting FilterClasses.

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.

Parameters
string$textThe URL alias
string$languageObjectThe current language object used for the string $text.
object$callerThe object which called the filtering process, can be null.
Returns
string the URL alias processed by the process() method

Referenced by eZContentObjectTreeNode\updateSubTreePath().


The documentation for this class was generated from the following file: