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

oxSeoEncoderArticle Class Reference

Inheritance diagram for oxSeoEncoderArticle:
Collaboration diagram for oxSeoEncoderArticle:

List of all members.

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)

Static Public Member Functions

static getInstance ()

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)

Static Protected Attributes

static $_instance = null
static $_aTitleCache = array()

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 $oArticle article object
oxCategory $oCategory category object
int $iLang language to generate uri for
Returns:
string

Definition at line 191 of file oxseoencoderarticle.php.

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

oxSeoEncoderArticle._getCategory ( oArticle,
iLang 
) [protected]

Returns active category if available

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
oxcategory | null

Definition at line 275 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getListType (  )  [protected]

Returns active list type

Returns:
string

Definition at line 132 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getMainCategory ( oArticle  )  [protected]

Returns products main category id

Parameters:
oxArticle $oArticle product
Returns:
string

Definition at line 292 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getManufacturer ( oArticle,
iLang 
) [protected]

Returns active manufacturer if available

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
oxmanufacturer | null

Definition at line 537 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 $oArticle article to check language
int $iLang user defined language id
Returns:
oxarticle

Definition at line 54 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getRecomm ( oArticle,
iLang 
) [protected]

Returns active recommendation list object if available

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
oxrecommlist | null

Definition at line 117 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getTag ( oArticle,
iLang 
) [protected]

Returns active tag if available

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
string | null

Definition at line 172 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getUrlExtension (  )  [protected]

Returns target "extension" (.html)

Returns:
string

Reimplemented from oxSeoEncoder.

Definition at line 40 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getVendor ( oArticle,
iLang 
) [protected]

Returns active vendor if available

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
oxvendor | null

Definition at line 460 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 $oArticle article object
Returns:
string

Definition at line 374 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleMainUri ( oArticle,
iLang 
)

Returns SEO uri for passed article

Parameters:
oxarticle $oArticle article object
int $iLang language id
Returns:
string

Definition at line 331 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleMainUrl ( oArticle,
iLang = null 
)

return article main url, with path of its default category

Parameters:
oxarticle $oArticle product
int $iLang language id
Returns:
string

Definition at line 568 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleManufacturerUri ( oArticle,
iLang,
blRegenerate = false 
)

Returns manufacturer seo uri for current article

Parameters:
oxarticle $oArticle article object
int $iLang language id
bool $blRegenerate if TRUE forces seo url regeneration
Returns:
string

Definition at line 491 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleRecommUri ( oArticle,
iLang 
)

Returns SEO uri for passed article and active tag

Parameters:
oxarticle $oArticle article object
int $iLang language id
Returns:
string

Definition at line 74 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleTagUri ( oArticle,
iLang,
blRegenerate = false 
)

Returns SEO uri for passed article and active tag

Parameters:
oxarticle $oArticle article object
int $iLang language id
bool $blRegenerate if TRUE forces seo url regeneration
Returns:
string

Definition at line 146 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleUri ( oArticle,
iLang,
blRegenerate = false 
)

Returns SEO uri for passed article

Parameters:
oxarticle $oArticle article object
int $iLang language id
bool $blRegenerate if TRUE forces seo url regeneration
Returns:
string

Definition at line 233 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleUrl ( oArticle,
iLang = null,
iType = 0 
)

Encodes article URLs into SEO format

Parameters:
oxArticle $oArticle Article object
int $iLang language
int $iType type
Returns:
string

Definition at line 586 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.getArticleVendorUri ( oArticle,
iLang,
blRegenerate = false 
)

Returns vendor seo uri for current article

Parameters:
oxarticle $oArticle article object
int $iLang language id
bool $blRegenerate if TRUE forces seo url regeneration
Returns:
string

Definition at line 413 of file oxseoencoderarticle.php.

static oxSeoEncoderArticle.getInstance (  )  [static]

Singleton method

Deprecated:
since v5.0 (2012-08-10); Use oxRegistry.get("oxSeoEncoderArticle") instead.
Returns:
oxSeoEncoderArticle

Reimplemented from oxSeoEncoder.

Definition at line 30 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.onDeleteArticle ( oArticle  ) 

deletes article seo entries

Parameters:
oxarticle $oArticle article to remove
Returns:
null

Definition at line 627 of file oxseoencoderarticle.php.


Member Data Documentation

oxSeoEncoderArticle.$_aTitleCache = array() [static, protected]

Definition at line 21 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.$_instance = null [static, protected]

Reimplemented from oxSeoEncoder.

Definition at line 14 of file oxseoencoderarticle.php.


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