Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes

oxUtilsUrl Class Reference

Inheritance diagram for oxUtilsUrl:
Collaboration diagram for oxUtilsUrl:

List of all members.

Public Member Functions

 getBaseAddUrlParams ()
 getAddUrlParams ()
 prepareUrlForNoSession ($sUrl)
 prepareCanonicalUrl ($sUrl)
 appendUrl ($sUrl, $aAddParams)
 cleanUrl ($sUrl, $aParams=null)
 processUrl ($sUrl, $blFinalUrl=true, $aParams=null, $iLang=null)
 processSeoUrl ($sUrl)
 processStdUrl ($sUrl, $aParams, $iLang, $blAddLangParam)
 appendParamSeparator ($sUrl)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _appendUrl ($sUrl, $aAddParams)

Protected Attributes

 $_aAddUrlParams = null

Static Private Attributes

static $_instance = null

Detailed Description

URL utility class

Definition at line 6 of file oxutilsurl.php.


Member Function Documentation

oxUtilsUrl._appendUrl ( sUrl,
aAddParams 
) [protected]

Appends url with given parameters

Parameters:
atring $sUrl url to append
array $aAddParams parameters to append
Deprecated:
See also:
oxUtilsUrl.appendUrl()
Returns:
string

Definition at line 185 of file oxutilsurl.php.

oxUtilsUrl.appendParamSeparator ( sUrl  ) 

append parameter separator - '?' if it is not in the url or & otherwise

Parameters:
string $sUrl url
Returns:
string

Definition at line 285 of file oxutilsurl.php.

oxUtilsUrl.appendUrl ( sUrl,
aAddParams 
)

Appends url with given parameters

Parameters:
atring $sUrl url to append
array $aAddParams parameters to append
Returns:
string

Definition at line 155 of file oxutilsurl.php.

oxUtilsUrl.cleanUrl ( sUrl,
aParams = null 
)

Removes any or specified dynamic parameter from given url

Parameters:
string $sUrl url to clean
array $aParams parameters to remove [optional]
Returns:
string

Definition at line 198 of file oxutilsurl.php.

oxUtilsUrl.getAddUrlParams (  ) 

Returns parameters which should be appended to seo or std url

Returns:
array

Definition at line 60 of file oxutilsurl.php.

oxUtilsUrl.getBaseAddUrlParams (  ) 

Returns core parameters which must be added to each url

Returns:
array

Definition at line 48 of file oxutilsurl.php.

static oxUtilsUrl.getInstance (  )  [static]

resturns a single instance of this class

Returns:
oxUtilsUrl

Definition at line 27 of file oxutilsurl.php.

oxUtilsUrl.prepareCanonicalUrl ( sUrl  ) 

Prepares canonical url

Parameters:
string $sUrl given url

public

Returns:
string

Definition at line 125 of file oxutilsurl.php.

oxUtilsUrl.prepareUrlForNoSession ( sUrl  ) 

prepareUrlForNoSession adds extra url params making it usable without session also removes sid=xxxx&

Parameters:
string $sUrl given url

public

Returns:
string

Definition at line 82 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 252 of file oxutilsurl.php.

oxUtilsUrl.processStdUrl ( sUrl,
aParams,
iLang,
blAddLangParam 
)

Standard/dynamic url processor: adds various needed parameters, like language id, currency, shop id This method is deprecated, see oxUtilsUrl.processUrl instead

Parameters:
string $sUrl url to process
array $aParams additional parameters add to url
int $iLang url language id
bool $blAddLangParam add language parameter or not
Deprecated:
See also:
oxUtilsUrl.processUrl
Returns:
string

Definition at line 273 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 222 of file oxutilsurl.php.


Member Data Documentation

oxUtilsUrl.$_aAddUrlParams = null [protected]

Definition at line 20 of file oxutilsurl.php.

oxUtilsUrl.$_instance = null [static, private]

Definition at line 13 of file oxutilsurl.php.


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