oxSeoEncoderCategory Class Reference

Inheritance diagram for oxSeoEncoderCategory:

[legend]

Collaboration diagram for oxSeoEncoderCategory:

[legend]

List of all members.

Public Member Functions
	getCategoryUri ($oCat, $iLang=null)
	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)
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._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 170 of file oxseoencodercategory.php.

oxSeoEncoderCategory.getCategoryUri	(	$	oCat,
		$	iLang = null
	)

Returns SEO uri for passed category

Parameters:

	oxcategory	$oCat category object
	int	$iLang language

Returns:

string

Definition at line 107 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 198 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 218 of file oxseoencodercategory.php.

oxSeoEncoderCategory.onDeleteCategory

(

$

oCategory

)

deletes Category seo entries

Parameters:

oxCategory

$oCategory Category object

Returns:

null

Definition at line 246 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:

• core/oxseoencodercategory.php