OXID eShop CE  4.9.6
 All Classes Files Functions Variables Pages
oxSeoEncoderCategory Class Reference
+ Inheritance diagram for oxSeoEncoderCategory:
+ Collaboration diagram for oxSeoEncoderCategory:

Public Member Functions

 getCategoryUri ($oCat, $iLang=null, $blRegenerate=false)
 getCategoryPageUrl ($oCategory, $iPage, $iLang=null, $blFixed=null)
 getCategoryUrl ($oCategory, $iLang=null)
 markRelatedAsExpired ($oCategory)
 onDeleteCategory ($oCategory)
- Public Member Functions inherited from oxSeoEncoder
 addLanguageParam ($sSeoUrl, $iLang)
 __construct ()
 getDynamicObjectId ($iShopId, $sStdUrl)
 encodeString ($sString, $blReplaceChars=true, $iLang=false)
 setSeparator ($sSeparator=null)
 setPrefix ($sPrefix)
 setIdLength ($iIdlength=null)
 setReservedWords ($aReservedWords)
 markAsExpired ($sId, $iShopId=null, $iExpStat=1, $iLang=null, $sParams=null)
 encodeStaticUrls ($aStaticUrl, $iShopId, $iLang)
 copyStaticUrls ($iShopId)
 getStaticUrl ($sStdUrl, $iLang=null, $iShopId=null)
 addSeoEntry ($sObjectId, $iShopId, $iLang, $sStdUrl, $sSeoUrl, $sType, $blFixed=1, $sKeywords= '', $sDescription= '', $sParams= '', $blExclude=false, $sAltObjectId=null)
 deleteSeoEntry ($sObjectId, $iShopId, $iLang, $sType)
 getMetaData ($sObjectId, $sMetaType, $iShopId=null, $iLang=null)
 getDynamicUrl ($sStdUrl, $sSeoUrl, $iLang)
 fetchSeoUrl ($sStdUrl, $iLanguage=null)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _getUrlExtension ()
 _categoryUrlLoader ($oCat, $iLang)
 _getAltUri ($sObjectId, $iLang)
- Protected Member Functions inherited from oxSeoEncoder
 _processSeoUrl ($sSeoUrl, $sObjectId=null, $iLang=null, $blExclude=false)
 _copyToHistory ($sId, $iShopId, $iLang, $sType=null, $sNewId=null)
 _getDynamicUri ($sStdUrl, $sSeoUrl, $iLang)
 _getFullUrl ($sSeoUrl, $iLang=null, $blSsl=false)
 _getSeoIdent ($sSeoUrl)
 _getStaticUri ($sStdUrl, $iShopId, $iLang)
 _getUniqueSeoUrl ($sSeoUrl, $sObjectId=null, $iObjectLang=null)
 _isFixed ($sType, $sId, $iLang, $iShopId=null, $sParams=null, $blStrictParamsCheck=true)
 _getCacheKey ($sType, $iLang=null, $iShopId=null, $sParams=null)
 _loadFromCache ($sCacheIdent, $sType, $iLang=null, $iShopId=null, $sParams=null)
 _saveInCache ($sCacheIdent, $sCache, $sType, $iLang=null, $iShopId=null, $sParams=null)
 _loadFromDb ($sType, $sId, $iLang, $iShopId=null, $sParams=null, $blStrictParamsCheck=true)
 _getReservedEntryKeys ()
 _prepareUri ($sUri, $iLang=false)
 _prepareTitle ($sTitle, $blSkipTruncate=false, $iLang=false)
 _saveToDb ($sType, $sObjectId, $sStdUrl, $sSeoUrl, $iLang, $iShopId=null, $blFixed=null, $sParams=null)
 _trimUrl ($sUrl, $iLang=null)
 _getMaxUrlLength ()
 _getPageUri ($oObject, $sType, $sStdUrl, $sSeoUrl, $sParams, $iLang=null, $blFixed=false)
 _getStaticObjectId ($iShopId, $sStdUrl)

Protected Attributes

 $_aCatCache = array()
- Protected Attributes inherited from oxSeoEncoder
 $_iIdLength = 255
 $_sAddParams = null
 $_iMaxUrlLength = null

Private Member Functions

 _getCategoryCacheId ($oCat, $iLang)

Additional Inherited Members

- Static Protected Attributes inherited from oxSeoEncoder
static $_aReservedWords = array('admin')
static $_aReservedEntryKeys = null
static $_sSeparator = null
static $_sPrefix = null
static $_aFixedCache = array()
static $_sCacheKey = null
static $_aCache = array()

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$oCatcategory object
int$iLangactive language id

protected

Returns
boolean

Definition at line 39 of file oxseoencodercategory.php.

oxSeoEncoderCategory::_getAltUri (   $sObjectId,
  $iLang 
)
protected

Returns alternative uri used while updating seo

Parameters
string$sObjectIdobject id
int$iLanglanguage id
Returns
string

Reimplemented from oxSeoEncoder.

Definition at line 238 of file oxseoencodercategory.php.

oxSeoEncoderCategory::_getCategoryCacheId (   $oCat,
  $iLang 
)
private

_getCatecgoryCacheId return string for isntance cache id

Parameters
oxCategory$oCatcategory object
int$iLangactive language

private

Returns
string

Definition at line 64 of file oxseoencodercategory.php.

oxSeoEncoderCategory::_getUrlExtension ( )
protected

Returns target "extension" (/)

Returns
string

Reimplemented from oxSeoEncoder.

Definition at line 23 of file oxseoencodercategory.php.

oxSeoEncoderCategory::getCategoryPageUrl (   $oCategory,
  $iPage,
  $iLang = null,
  $blFixed = null 
)

Returns category SEO url for specified page

Parameters
oxcategory$oCategorycategory object
int$iPagepage tu prepare number
int$iLanglanguage
bool$blFixedfixed url marker (default is null)
Returns
string

Definition at line 141 of file oxseoencodercategory.php.

oxSeoEncoderCategory::getCategoryUri (   $oCat,
  $iLang = null,
  $blRegenerate = false 
)

Returns SEO uri for passed category

Parameters
oxcategory$oCatcategory object
int$iLanglanguage
bool$blRegenerateif TRUE forces seo url regeneration
Returns
string

Definition at line 78 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$oCategoryCategory object
int$iLangLanguage
Returns
string

Definition at line 170 of file oxseoencodercategory.php.

oxSeoEncoderCategory::markRelatedAsExpired (   $oCategory)

Marks related to category objects as expired

Parameters
oxCategory$oCategoryCategory object

Definition at line 189 of file oxseoencodercategory.php.

oxSeoEncoderCategory::onDeleteCategory (   $oCategory)

deletes Category seo entries

Parameters
oxCategory$oCategoryCategory object

Definition at line 220 of file oxseoencodercategory.php.

Member Data Documentation

oxSeoEncoderCategory::$_aCatCache = array()
protected

Definition at line 16 of file oxseoencodercategory.php.


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