Docs For Class ModRewriteUrlUtil

Description

Mod Rewrite url utility class. Handles convertion of Urls from contenido core based url composition pattern to AMR (Advanced Mod Rewrite) url composition pattern and vice versa.

author: Murat Purc <murat@purc.de>
date: 28.10.2008

Located in /contenido/plugins/mod_rewrite/classes/class.modrewriteurlutil.php (line 25)

ModRewriteBase
   |
   --ModRewriteUrlUtil

Variable Summary

static ModRewriteUrlUtil $_instance

string $_artSep

string $_artWordSep

string $_catSep

string $_catWordSep

string $_mrArtSep

string $_mrArtWordSep

string $_mrCatSep

string $_mrCatWordSep

string $_mrExt

Method Summary

static ModRewriteUrlUtil getInstance ()

ModRewriteUrlUtil __construct ()

string toContenidoUrl (string $url)

string toContenidoUrlName (string $urlName)

string toContenidoUrlPath (string $urlPath)

string toModRewriteUrl (string $url)

string toModRewriteUrlName (string $urlName)

string toModRewriteUrlPath (string $urlPath)

string _toUrl ( $url, string $fromCatSep, string $toCatSep, string $fromCatWordSep, string $toCatWordSep, string $fromArtSep, string $toArtSep, string $fromArtWordSep, string $toArtWordSep, string $urlPath)

string _toUrlName (string $urlName, string $fromArtWordSep, string $toArtWordSep)

string _toUrlPath (string $urlPath, string $fromCatSep, string $toCatSep, string $fromCatWordSep, string $toCatWordSep, string $fromArtSep, string $toArtSep)

Variables

static ModRewriteUrlUtil $_instance (line 31)

Self instance (singleton implementation)

access: private

string $_artSep = '/' (line 61)

Contenido article separator

access: private

string $_artWordSep = '-' (line 73)

Contenido article word separator

access: private

string $_catSep = '/' (line 49)

Contenido category separator

access: private

string $_catWordSep = '-' (line 37)

Contenido category word separator

access: private

string $_mrArtSep (line 67)

AMR article separator

access: private

string $_mrArtWordSep (line 79)

AMR article word separator

access: private

string $_mrCatSep (line 55)

AMR category separator

access: private

string $_mrCatWordSep (line 43)

AMR category word separator

access: private

string $_mrExt (line 85)

AMR extension used for articlenames (e. g. .html)

access: private

Inherited Variables

Inherited from ModRewriteBase

ModRewriteBase::$_oDebug
ModRewriteBase::$_oGlobals

Methods

static getInstance (line 107)

Returns self instance (singleton pattern)

access: public

ModRewriteUrlUtil getInstance ()

Constructor __construct (line 91)

Contructor, sets some AMR configuration related properties

access: private

ModRewriteUrlUtil __construct ()

toContenidoUrl (line 234)

Converts passed AMR url to Contenido url.

return: Contenido url
access: public

string toContenidoUrl (string $url)

string $url: AMR url

toContenidoUrlName (line 186)

Converts passed AMR url name to Contenido url name.

return: Contenido url name
access: public

string toContenidoUrlName (string $urlName)

string $urlName: AMR url name

toContenidoUrlPath (line 121)

Converts passed AMR url path to Contenido url path.

return: Contenido url path
access: public

string toContenidoUrlPath (string $urlPath)

string $urlPath: AMR url path

toModRewriteUrl (line 253)

Converts passed AMR url to Contenido url.

return: Contenido url
access: public

string toModRewriteUrl (string $url)

string $url: AMR url

toModRewriteUrlName (line 198)

Converts passed Contenido url name to AMR url name.

return: AMR url name
access: public

string toModRewriteUrlName (string $urlName)

string $urlName: Contenido url name

toModRewriteUrlPath (line 135)

Converts passed Contenido url path to AMR url path.

return: AMR url path
access: public

string toModRewriteUrlPath (string $urlPath)

string $urlPath: Contenido url path

_toUrl (line 282)

Converts passed url to a another url (Contenido to AMR and vice versa).

return: Destination url
deprecated: No more used, is to delete
access: private

string _toUrl ( $url, string $fromCatSep, string $toCatSep, string $fromCatWordSep, string $toCatWordSep, string $fromArtSep, string $toArtSep, string $fromArtWordSep, string $toArtWordSep, string $urlPath)

string $urlPath: Source url path
string $fromCatSep: Source category seperator
string $toCatSep: Destination category seperator
string $fromCatWordSep: Source category word seperator
string $toCatWordSep: Destination category word seperator
string $fromArtSep: Source article seperator
string $toArtSep: Destination article seperator
string $fromArtWordSep: Source article word seperator
string $toArtWordSep: Destination article word seperator
$url

_toUrlName (line 212)

Converts passed url name to a another url name (Contenido to AMR and vice versa).

return: Destination url name
access: private

string _toUrlName (string $urlName, string $fromArtWordSep, string $toArtWordSep)

string $urlName: Source url name
string $fromArtWordSep: Source article word seperator
string $toArtWordSep: Destination article word seperator

_toUrlPath (line 156)

Converts passed url path to a another url path (Contenido to AMR and vice versa).

return: Destination url path
access: private

string _toUrlPath (string $urlPath, string $fromCatSep, string $toCatSep, string $fromCatWordSep, string $toCatWordSep, string $fromArtSep, string $toArtSep)

string $urlPath: Source url path
string $fromCatSep: Source category seperator
string $toCatSep: Destination category seperator
string $fromCatWordSep: Source category word seperator
string $toCatWordSep: Destination category word seperator
string $fromArtSep: Source article seperator
string $toArtSep: Destination article seperator

Inherited Methods

Inherited From ModRewriteBase

ModRewriteBase::getConfig()
ModRewriteBase::initialize()
ModRewriteBase::isEnabled()