OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory:

Public Member Functions
	getCategoryUri ($oCat, $iLang=null, $blRegenerate=false)
	getCategoryPageUrl ($category, $pageNumber, $languageId=null, $isFixed=null)
	getCategoryUrl ($oCategory, $iLang=null)
	markRelatedAsExpired ($oCategory)
	onDeleteCategory ($oCategory)

Protected Member Functions
	_getUrlExtension ()
	_categoryUrlLoader ($oCat, $iLang)
	_getAltUri ($sObjectId, $iLang)

Protected Attributes
	$_aCatCache = []

Private Member Functions
	_getCategoryCacheId ($oCat, $iLang)

Detailed Description

Seo encoder category

Member Function Documentation

_categoryUrlLoader()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::_categoryUrlLoader (   $oCat,   $iLang  )

protected

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

Parameters

\OxidEsales\Eshop\Application\Model\Category	$oCat	category object
int	$iLang	active language id

@access protected

Returns

boolean

_getAltUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::_getAltUri (   $sObjectId,   $iLang  )

protected

Returns alternative uri used while updating seo

Parameters

string	$sObjectId	object id
int	$iLang	language id

Returns

string

_getCategoryCacheId()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::_getCategoryCacheId (   $oCat,   $iLang  )

private

_getCatecgoryCacheId return string for isntance cache id

Parameters

\OxidEsales\Eshop\Application\Model\Category	$oCat	category object
int	$iLang	active language

@access private

Returns

string

_getUrlExtension()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::_getUrlExtension ( )

protected

Returns target "extension" (/)

Returns

string

getCategoryPageUrl()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::getCategoryPageUrl	(		$category,
			$pageNumber,
			$languageId = null,
			$isFixed = null
	)

Returns category SEO url for specified page

Parameters

\OxidEsales\Eshop\Application\Model\Category	$category	Category object.
int	$pageNumber	Number of the page which should be prepared.
int	$languageId	Language id.
bool	$isFixed	Fixed url marker (default is null).

Returns

string

getCategoryUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::getCategoryUri	(		$oCat,
			$iLang = null,
			$blRegenerate = false
	)

Returns SEO uri for passed category

Parameters

\OxidEsales\Eshop\Application\Model\Category	$oCat	category object
int	$iLang	language
bool	$blRegenerate	if TRUE forces seo url regeneration

Returns

string

getCategoryUrl()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::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 (\OxidEsales\Eshop\Core\SeoEncoder::_getSeoId()). If category has subcategories, it iterates through them.

Parameters

\OxidEsales\Eshop\Application\Model\Category	$oCategory	Category object
int	$iLang	Language

Returns

string

markRelatedAsExpired()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::markRelatedAsExpired

(

$oCategory

)

Marks related to category objects as expired

Parameters

\OxidEsales\Eshop\Application\Model\Category

$oCategory

Category object

onDeleteCategory()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::onDeleteCategory

(

$oCategory

)

deletes Category seo entries

Parameters

\OxidEsales\Eshop\Application\Model\Category

$oCategory

Category object

Member Data Documentation

$_aCatCache

OxidEsales\EshopCommunity\Application\Model\SeoEncoderCategory::$_aCatCache = []

protected

---

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

• /oxideshop-ce/source/Application/Model/SeoEncoderCategory.php