OXID eShop CE  4.10.0
 All Classes Namespaces Files Functions Variables Pages
oxSeoEncoderArticle Class Reference
+ Inheritance diagram for oxSeoEncoderArticle:
+ Collaboration diagram for oxSeoEncoderArticle:

Public Member Functions

 getArticleRecommUri ($oArticle, $iLang)
 getArticleTagUri ($oArticle, $iLang, $blRegenerate=false)
 getArticleUri ($oArticle, $iLang, $blRegenerate=false)
 getArticleMainUri ($oArticle, $iLang)
 getArticleVendorUri ($oArticle, $iLang, $blRegenerate=false)
 getArticleManufacturerUri ($oArticle, $iLang, $blRegenerate=false)
 getArticleMainUrl ($oArticle, $iLang=null)
 getArticleUrl ($oArticle, $iLang=null, $iType=0)
 onDeleteArticle ($oArticle)
- 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 ()
 _getProductForLang ($oArticle, $iLang)
 _getRecomm ($oArticle, $iLang)
 _getListType ()
 _getTag ($oArticle, $iLang)
 _createArticleCategoryUri ($oArticle, $oCategory, $iLang)
 _getCategory ($oArticle, $iLang)
 _getMainCategory ($oArticle)
 _prepareArticleTitle ($oArticle)
 _getVendor ($oArticle, $iLang)
 _getManufacturer ($oArticle, $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)

Static Protected Attributes

static $_aTitleCache = array()
- 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()
- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Additional Inherited Members

- Protected Attributes inherited from oxSeoEncoder
 $_iIdLength = 255
 $_sAddParams = null
 $_iMaxUrlLength = null

Detailed Description

Seo encoder for articles

Definition at line 7 of file oxseoencoderarticle.php.

Member Function Documentation

oxSeoEncoderArticle::_createArticleCategoryUri (   $oArticle,
  $oCategory,
  $iLang 
)
protected

create article uri for given category and save it

Parameters
oxArticle$oArticlearticle object
oxCategory$oCategorycategory object
int$iLanglanguage to generate uri for
Returns
string

Definition at line 190 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_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 648 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getCategory (   $oArticle,
  $iLang 
)
protected

Returns active category if available

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Returns
oxCategory | null

Definition at line 274 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getListType ( )
protected

Returns active list type

Returns
string

Definition at line 120 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getMainCategory (   $oArticle)
protected

Returns products main category id

Parameters
oxArticle$oArticleproduct
Returns
string

Definition at line 294 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getManufacturer (   $oArticle,
  $iLang 
)
protected

Returns active manufacturer if available

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Returns
oxManufacturer | null

Definition at line 542 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getProductForLang (   $oArticle,
  $iLang 
)
protected

Checks if current article is in same language as preferred (language id passed by param). In case languages are not the same - reloads article object in different language

Parameters
oxArticle$oArticlearticle to check language
int$iLanguser defined language id
Returns
oxArticle

Definition at line 36 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getRecomm (   $oArticle,
  $iLang 
)
protected

Returns active recommendation list object if available

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
oxRecommList | null

Definition at line 104 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getTag (   $oArticle,
  $iLang 
)
protected

Returns active tag if available

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Deprecated:
v5.3 (2016-05-04); Tags will be moved to own module.
Returns
string | null

Definition at line 170 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getUrlExtension ( )
protected

Returns target "extension" (.html)

Returns
string

Reimplemented from oxSeoEncoder.

Definition at line 22 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_getVendor (   $oArticle,
  $iLang 
)
protected

Returns active vendor if available

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Returns
oxvendor | null

Definition at line 464 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::_prepareArticleTitle (   $oArticle)
protected

Returns seo title for current article (if oxTitle field is empty, oxArtnum is used). Additionally - if oxVarSelect is set - title is appended with its value

Parameters
oxArticle$oArticlearticle object
Returns
string

Definition at line 377 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleMainUri (   $oArticle,
  $iLang 
)

Returns SEO uri for passed article

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
Returns
string

Definition at line 333 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleMainUrl (   $oArticle,
  $iLang = null 
)

return article main url, with path of its default category

Parameters
oxArticle$oArticleproduct
int$iLanglanguage id
Returns
string

Definition at line 573 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleManufacturerUri (   $oArticle,
  $iLang,
  $blRegenerate = false 
)

Returns manufacturer seo uri for current article

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
bool$blRegenerateif TRUE forces seo url regeneration
Returns
string

Definition at line 495 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleRecommUri (   $oArticle,
  $iLang 
)

Returns SEO uri for passed article and active tag

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
string

Definition at line 58 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleTagUri (   $oArticle,
  $iLang,
  $blRegenerate = false 
)

Returns SEO uri for passed article and active tag

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
bool$blRegenerateif TRUE forces seo url regeneration
Deprecated:
v5.3 (2016-05-04); Tags will be moved to own module.
Returns
string

Definition at line 136 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleUri (   $oArticle,
  $iLang,
  $blRegenerate = false 
)

Returns SEO uri for passed article

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
bool$blRegenerateif TRUE forces seo url regeneration
Returns
string

Definition at line 232 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleUrl (   $oArticle,
  $iLang = null,
  $iType = 0 
)

Encodes article URLs into SEO format

Parameters
oxArticle$oArticleArticle object
int$iLanglanguage
int$iTypetype
Returns
string

Definition at line 591 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::getArticleVendorUri (   $oArticle,
  $iLang,
  $blRegenerate = false 
)

Returns vendor seo uri for current article

Parameters
oxArticle$oArticlearticle object
int$iLanglanguage id
bool$blRegenerateif TRUE forces seo url regeneration
Returns
string

Definition at line 416 of file oxseoencoderarticle.php.

oxSeoEncoderArticle::onDeleteArticle (   $oArticle)

deletes article seo entries

Parameters
oxArticle$oArticlearticle to remove

Definition at line 632 of file oxseoencoderarticle.php.

Member Data Documentation

oxSeoEncoderArticle::$_aTitleCache = array()
staticprotected

Definition at line 15 of file oxseoencoderarticle.php.


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