oxSeoEncoderArticle Class Reference

Inheritance diagram for oxSeoEncoderArticle:

[legend]

Collaboration diagram for oxSeoEncoderArticle:

[legend]

List of all members.

Public Member Functions
	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)
	_getArticleRecommUri ($oArticle, $iLang)
	_getRecomm ($oArticle, $iLang)
	_getListType ()
	_getArticleTagUri ($oArticle, $iLang)
	_getTag ($oArticle, $iLang)
	_createArticleCategoryUri ($oArticle, $oCategory, $iLang)
	_getArticleUri ($oArticle, $iLang)
	_getCategory ($oArticle, $iLang)
	_getArticleMainUri ($oArticle, $iLang)
	_prepareArticleTitle ($oArticle)
	_getArticleVendorUri ($oArticle, $iLang)
	_getVendor ($oArticle, $iLang)
	_getArticleManufacturerUri ($oArticle, $iLang)
	_getManufacturer ($oArticle, $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 186 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleMainUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns SEO uri for passed article

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 268 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleManufacturerUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns manufacturer seo uri for current article

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 414 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleRecommUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns SEO uri for passed article and active tag

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 87 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleTagUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns SEO uri for passed article and active tag

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 144 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns SEO uri for passed article

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 215 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getArticleVendorUri	(	$	oArticle,
		$	iLang
	)			[protected]

Returns vendor seo uri for current article

Parameters:

	oxarticle	$oArticle article object
	int	$iLang language id

Returns:

string

Definition at line 351 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 252 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getListType

(

)

[protected]

Returns active list type

Returns:

string

Definition at line 131 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 447 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 68 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 118 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 169 of file oxseoencoderarticle.php.

oxSeoEncoderArticle._getUrlExtension

(

)

[protected]

Returns target "extension" (.html)

Returns:

string

Reimplemented from oxSeoEncoder.

Definition at line 54 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 385 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 311 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 475 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 493 of file oxseoencoderarticle.php.

static oxSeoEncoderArticle.getInstance

(

)

[static]

Singleton method

Returns:

oxseoencoder

Reimplemented from oxSeoEncoder.

Definition at line 28 of file oxseoencoderarticle.php.

oxSeoEncoderArticle.onDeleteArticle

(

$

oArticle

)

deletes article seo entries

Parameters:

oxarticle

$oArticle article to remove

Returns:

null

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

• core/oxseoencoderarticle.php