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

oxSeoEncoderCategory Class Reference

Inheritance diagram for oxSeoEncoderCategory:
Collaboration diagram for oxSeoEncoderCategory:

List of all members.

Public Member Functions

 getCategoryUri ($oCat, $iLang=null, $blRegenerate=false)
 getCategoryPageUrl ($oCategory, $iPage, $iLang=null, $blFixed=null)
 getCategoryUrl ($oCategory, $iLang=null)
 markRelatedAsExpired ($oCategory)
 onDeleteCategory ($oCategory)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _getUrlExtension ()
 _categoryUrlLoader ($oCat, $iLang)
 _getAltUri ($sObjectId, $iLang)

Protected Attributes

 $_aCatCache = array()

Static Protected Attributes

static $_instance = null

Private Member Functions

 _getCategoryCacheId ($oCat, $iLang)

Detailed Description

Seo encoder base

Definition at line 7 of file oxseoencodercategory.php.


Member Function Documentation

oxSeoEncoderCategory._categoryUrlLoader ( oCat,
iLang 
) [protected]

_categoryUrlLoader loads category from db returns false if cat needs to be encoded (load failed)

Parameters:
oxCategory $oCat category object
int $iLang active language id

protected

Returns:
boolean

Definition at line 69 of file oxseoencodercategory.php.

oxSeoEncoderCategory._getAltUri ( sObjectId,
iLang 
) [protected]

Returns alternative uri used while updating seo

Parameters:
string $sObjectId object id
int $iLang language id
Returns:
string

Reimplemented from oxSeoEncoder.

Definition at line 264 of file oxseoencodercategory.php.

oxSeoEncoderCategory._getCategoryCacheId ( oCat,
iLang 
) [private]

_getCatecgoryCacheId return string for isntance cache id

Parameters:
oxCategory $oCat category object
int $iLang active language

private

Returns:
string

Definition at line 94 of file oxseoencodercategory.php.

oxSeoEncoderCategory._getUrlExtension (  )  [protected]

Returns target "extension" (/)

Returns:
string

Reimplemented from oxSeoEncoder.

Definition at line 53 of file oxseoencodercategory.php.

oxSeoEncoderCategory.getCategoryPageUrl ( oCategory,
iPage,
iLang = null,
blFixed = null 
)

Returns category SEO url for specified page

Parameters:
oxcategory $oCategory category object
int $iPage page tu prepare number
int $iLang language
bool $blFixed fixed url marker (default is null)
Returns:
string

Definition at line 171 of file oxseoencodercategory.php.

oxSeoEncoderCategory.getCategoryUri ( oCat,
iLang = null,
blRegenerate = false 
)

Returns SEO uri for passed category

Parameters:
oxcategory $oCat category object
int $iLang language
bool $blRegenerate if TRUE forces seo url regeneration
Returns:
string

Definition at line 108 of file oxseoencodercategory.php.

oxSeoEncoderCategory.getCategoryUrl ( oCategory,
iLang = null 
)

Category URL encoder. If category has external URLs, skip encoding for this category. If SEO id is not set, generates and saves SEO id for category (oxSeoEncoder._getSeoId()). If category has subcategories, it iterates through them.

Parameters:
oxCategory $oCategory Category object
int $iLang Language
Returns:
string

Definition at line 199 of file oxseoencodercategory.php.

static oxSeoEncoderCategory.getInstance (  )  [static]

Singleton method

Returns:
oxseoencodercategory

Reimplemented from oxSeoEncoder.

Definition at line 27 of file oxseoencodercategory.php.

oxSeoEncoderCategory.markRelatedAsExpired ( oCategory  ) 

Marks related to category objects as expired

Parameters:
oxCategory $oCategory Category object
Returns:
null

Definition at line 219 of file oxseoencodercategory.php.

oxSeoEncoderCategory.onDeleteCategory ( oCategory  ) 

deletes Category seo entries

Parameters:
oxCategory $oCategory Category object
Returns:
null

Definition at line 247 of file oxseoencodercategory.php.


Member Data Documentation

oxSeoEncoderCategory.$_aCatCache = array() [protected]

Definition at line 20 of file oxseoencodercategory.php.

oxSeoEncoderCategory.$_instance = null [static, protected]

Singleton instance.

Reimplemented from oxSeoEncoder.

Definition at line 12 of file oxseoencodercategory.php.


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