Class ModRewriteController

Mod Rewrite controller class. Extracts url parts and sets some necessary globals like:

$idart
$idcat
$client
$changeclient
$lang
$changelang

ModRewriteController

Package: Plugin\ModRewrite
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Murat Purc <murat@purc.de>
Located at plugins/mod_rewrite/classes/class.modrewritecontroller.php

Methods summary
`public`	# `__construct( string $incommingUrl )` Constructor, sets several properties. Constructor, sets several properties. Parameters `$incommingUrl` `string` $incommingUrl Incomming URL
`public integer`	# `getClient( )` Getter for overwritten client id (see $GLOBALS['client']) Getter for overwritten client id (see $GLOBALS['client']) Returns `integer` Client id
`public integer`	# `getChangeClient( )` Getter for overwritten change client id (see $GLOBALS['changeclient']) Getter for overwritten change client id (see $GLOBALS['changeclient']) Returns `integer` Change client id
`public integer`	# `getIdArt( )` Getter for article id (see $GLOBALS['idart']) Getter for article id (see $GLOBALS['idart']) Returns `integer` Article id
`public integer`	# `getIdCat( )` Getter for category id (see $GLOBALS['idcat']) Getter for category id (see $GLOBALS['idcat']) Returns `integer` Category id
`public integer`	# `getLang( )` Getter for language id (see $GLOBALS['lang']) Getter for language id (see $GLOBALS['lang']) Returns `integer` Language id
`public integer`	# `getChangeLang( )` Getter for change language id (see $GLOBALS['changelang']) Getter for change language id (see $GLOBALS['changelang']) Returns `integer` Change language id
`public string`	# `getPath( )` Getter for path (see $GLOBALS['path']) Getter for path (see $GLOBALS['path']) Returns `string` Path, used by path resolver
`public string`	# `getResolvedUrl( )` Getter for resolved url Getter for resolved url Returns `string` Resolved url
`public`	# `getRoutingFoundState( )` Returns a flag about found routing definition Returns a flag about found routing definition return bool Flag about found routing
`public boolean`	# `errorOccured( )` Getter for occured error state Getter for occured error state Returns `boolean` Flag for occured error
`public integer`	# `getError( )` Getter for occured error state Getter for occured error state Returns `integer` Numeric error code
`public`	# `execute( )` Main function to call for mod rewrite related preprocessing jobs. Main function to call for mod rewrite related preprocessing jobs. Executes some private functions to extract request URI and to set needed membervariables (client, language, article id, category id, etc.)
`private`	# `_extractRequestUri( boolean $secondCall = false )` Extracts request URI and sets member variables $this->_sArtName and $this->_aParts Extracts request URI and sets member variables $this->_sArtName and $this->_aParts Parameters `$secondCall` `boolean` $secondCall Flag about second call of this function, is needed to re extract url if a routing definition was found
`private`	# `_initializeClientId( )` Tries to initialize the client id. This is required to load the proper plugin configuration for current client. Tries to initialize the client id. This is required to load the proper plugin configuration for current client.
`private`	# `_initializeLanguageId( )` Tries to initialize the language id. Tries to initialize the language id.
`private`	# `_setClientId( )` Detects client id from given url Detects client id from given url
`private`	# `_setLanguageId( )` Sets language id Sets language id
`private`	# `_setPathresolverSetting( )` Sets path resolver and category id Sets path resolver and category id
`private`	# `_setIdart( )` Sets article id Sets article id
`private`	# `_postValidation( )` Does post validation of the extracted data. Does post validation of the extracted data. One main goal of this function is to prevent duplicated content, which could happen, if the configuration 'startfromroot' is activated.
`private string`	# `_parseUrl( string $url )` Parses the url using defined separators Parses the url using defined separators Parameters `$url` `string` $url Incoming url Returns `string` Parsed url
`private boolean`	# `_hasPartArrayItems( )` Returns state of parts property. Returns state of parts property. Returns `boolean` True if $this->_aParts propery contains items
`private boolean`	# `_isRootRequest( )` Checks if current request was a root request. Checks if current request was a root request. Returns `boolean`
`private`	# `_setError( integer $errCode )` Sets error code and error flag (everything greater than 0 is an error) Sets error code and error flag (everything greater than 0 is an error) Parameters `$errCode` `integer` $errCode

Methods inherited from ModRewriteBase
`getConfig(), isEnabled(), setConfig(), setEnabled()`

Constants summary
`integer`	`ERROR_CLIENT`	`1`	#
`integer`	`ERROR_LANGUAGE`	`2`	#
`integer`	`ERROR_CATEGORY`	`3`	#
`integer`	`ERROR_ARTICLE`	`4`	#
`integer`	`ERROR_POST_VALIDATION`	`5`	#
`string`	`FRONT_CONTENT`	`'front_content.php'`	#

Properties summary
`private array`	`$_aParts`		# Extracted request uri path parts by path separator '/' Extracted request uri path parts by path separator '/'
`private string`	`$_sArtName`		# Extracted article name from request uri Extracted article name from request uri
`private string`	`$_sPath`		# Remaining path for path resolver (see $GLOBALS['path']) Remaining path for path resolver (see $GLOBALS['path'])
`private string`	`$_sIncommingUrl`		# Incomming URL Incomming URL
`private string`	`$_sResolvedUrl`		# Resolved URL Resolved URL
`private integer`	`$_iClientMR`		# Client id used by this class Client id used by this class
`private integer`	`$_iLangMR`		# Language id used by this class Language id used by this class
`private boolean`	`$_bError`	`false`	# Flag about occured errors Flag about occured errors
`private integer`	`$_iError`	`0`	# One of ERROR_* constants or 0 One of ERROR_* constants or 0
`private boolean`	`$_bRoutingFound`	`false`	# Flag about found routing definition Flag about found routing definition

Packages

Classes

Functions

Class ModRewriteController

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Returns

Returns

Returns

Parameters