oxUtilsUrl Class Reference

Inheritance diagram for oxUtilsUrl:

Collaboration diagram for oxUtilsUrl:

Public Member Functions
	getBaseAddUrlParams ()
	getAddUrlParams ()
	addShopHost ($sUrl)
	processUrl ($sUrl, $blFinalUrl=true, $aParams=null, $iLang=null)
	processShopUrl ($sUrl, $blFinalUrl=true, $iLang=null)
	isCurrentShopHost ($sUrl)
	processSeoUrl ($sUrl)
	getCurrentUrl ()
	stringToParamsArray ($sValue)
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_addHost ($sUrl, &$aHosts)
	_addLanguageHost ($aLanguageUrls, &$aHosts)
	_getHosts ()
	_addMallHosts (&$aHosts)

Protected Attributes
	$_aAddUrlParams = null
	$_aHosts = null

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

URL utility class

Definition at line 6 of file oxutilsurl.php.

Member Function Documentation

oxUtilsUrl::_addHost (   $sUrl, &  $aHosts  )

protected

Extracts host from given url and appends $aHosts with it

Parameters

string	$sUrl	url to extract
array	&$aHosts	hosts array

Definition at line 428 of file oxutilsurl.php.

oxUtilsUrl::_addLanguageHost (   $aLanguageUrls, &  $aHosts  )

protected

Appends language urls to $aHosts.

Parameters

array	$aLanguageUrls	array of language urls to extract
array	&$aHosts	hosts array

Definition at line 443 of file oxutilsurl.php.

oxUtilsUrl::_addMallHosts ( &  $aHosts )

protected

Appends shop mall urls to $aHosts.

Parameters

array

&$aHosts

hosts array

Definition at line 486 of file oxutilsurl.php.

oxUtilsUrl::_getHosts ( )

protected

Collects and returns current shop hosts array.

Returns

array

Definition at line 457 of file oxutilsurl.php.

oxUtilsUrl::addShopHost

(

$sUrl

)

Adds shop host if url does not start with it.

Parameters

string

$sUrl

Returns

string

Definition at line 204 of file oxutilsurl.php.

oxUtilsUrl::getAddUrlParams

(

)

Returns parameters which should be appended to seo or std url.

Returns

array

Definition at line 40 of file oxutilsurl.php.

oxUtilsUrl::getBaseAddUrlParams

(

)

Returns core parameters which must be added to each url.

Returns

array

Definition at line 28 of file oxutilsurl.php.

oxUtilsUrl::getCurrentUrl

(

)

Return current url.

Returns

string

Definition at line 375 of file oxutilsurl.php.

oxUtilsUrl::isCurrentShopHost

(

$sUrl

)

Compares current URL to supplied string.

Parameters

string

$sUrl

Returns

bool true if $sUrl is equal to current page URL.

Definition at line 266 of file oxutilsurl.php.

oxUtilsUrl::processSeoUrl

(

$sUrl

)

Seo url processor: adds various needed parameters, like currency, shop id.

Parameters

string

$sUrl

url to process.

Returns

string

Definition at line 294 of file oxutilsurl.php.

oxUtilsUrl::processShopUrl	(		$sUrl,
			$blFinalUrl = true,
			$iLang = null
	)

Adds additional shop url parameters, session id, language id when needed.

Parameters

string	$sUrl	url to process.
bool	$blFinalUrl	should url be finalized or should it end with ? or &.
int	$iLang	url target language.

Returns

string

Definition at line 244 of file oxutilsurl.php.

oxUtilsUrl::processUrl	(		$sUrl,
			$blFinalUrl = true,
			$aParams = null,
			$iLang = null
	)

Performs base url processing - adds required parameters to given url.

Parameters

string	$sUrl	url to process.
bool	$blFinalUrl	should url be finalized or should it end with ? or & (default true).
array	$aParams	additional parameters (default null).
int	$iLang	url target language (default null).

Returns

string

Definition at line 224 of file oxutilsurl.php.

oxUtilsUrl::stringToParamsArray

(

$sValue

)

Forms parameters array out of a string. Takes & and & as delimiters. Returns associative array with parameters.

Parameters

string

$sValue

String

Returns

array

Definition at line 406 of file oxutilsurl.php.

Member Data Documentation

oxUtilsUrl::$_aAddUrlParams = null

protected

Definition at line 14 of file oxutilsurl.php.

oxUtilsUrl::$_aHosts = null

protected

Definition at line 21 of file oxutilsurl.php.

---

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

• core/oxutilsurl.php