OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle Class Reference

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

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

Public Member Functions
	getArticleRecommUri ($oArticle, $iLang)
	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)

Protected Member Functions
	_getUrlExtension ()
	_getProductForLang ($oArticle, $iLang)
	_getRecomm ($oArticle, $iLang)
	_getListType ()
	_createArticleCategoryUri ($oArticle, $oCategory, $iLang)
	_getCategory ($oArticle, $iLang)
	_getMainCategory ($oArticle)
	_prepareArticleTitle ($oArticle)
	_getVendor ($oArticle, $iLang)
	_getManufacturer ($oArticle, $iLang)
	_getAltUri ($sObjectId, $iLang)

Static Protected Attributes
static	$_aTitleCache = []

Detailed Description

Seo encoder for articles

Member Function Documentation

_createArticleCategoryUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_createArticleCategoryUri (   $oArticle,   $oCategory,   $iLang  )

protected

create article uri for given category and save it

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
\OxidEsales\Eshop\Application\Model\Category	$oCategory	category object
int	$iLang	language to generate uri for

Returns

string

_getAltUri()

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

protected

Returns alternative uri used while updating seo

Parameters

string	$sObjectId	object id
int	$iLang	language id

Returns

string

_getCategory()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getCategory (   $oArticle,   $iLang  )

protected

Returns active category if available

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	product
int	$iLang	language id

Returns

\OxidEsales\Eshop\Application\Model\Category | null

_getListType()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getListType ( )

protected

Returns active list type

Returns

string

_getMainCategory()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getMainCategory (   $oArticle )

protected

Returns products main category id

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

product

Returns

string

_getManufacturer()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getManufacturer (   $oArticle,   $iLang  )

protected

Returns active manufacturer if available

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	product
int	$iLang	language id

Returns

\OxidEsales\Eshop\Application\Model\Manufacturer | null

_getProductForLang()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_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

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article to check language
int	$iLang	user defined language id

Returns

\OxidEsales\Eshop\Application\Model\Article

_getRecomm()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getRecomm (   $oArticle,   $iLang  )

protected

Returns active recommendation list object if available

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	product
int	$iLang	language id

Deprecated:

since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns

\OxidEsales\Eshop\Application\Model\RecommendationList | null

_getUrlExtension()

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

protected

Returns target "extension" (.html)

Returns

string

_getVendor()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_getVendor (   $oArticle,   $iLang  )

protected

Returns active vendor if available

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	product
int	$iLang	language id

Returns

\OxidEsales\Eshop\Application\Model\Vendor | null

_prepareArticleTitle()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::_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

\OxidEsales\Eshop\Application\Model\Article

$oArticle

article object

Returns

string

getArticleMainUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleMainUri	(		$oArticle,
			$iLang
	)

Returns SEO uri for passed article

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
int	$iLang	language id

Returns

string

getArticleMainUrl()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleMainUrl	(		$oArticle,
			$iLang = null
	)

return article main url, with path of its default category

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	product
int	$iLang	language id

Returns

string

getArticleManufacturerUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleManufacturerUri	(		$oArticle,
			$iLang,
			$blRegenerate = false
	)

Returns manufacturer seo uri for current article

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
int	$iLang	language id
bool	$blRegenerate	if TRUE forces seo url regeneration

Returns

string

getArticleRecommUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleRecommUri	(		$oArticle,
			$iLang
	)

Returns SEO uri for passed article and active tag

Deprecated:

since v5.3 (2016-06-17); Listmania will be moved to an own module.

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
int	$iLang	language id

Returns

string

getArticleUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleUri	(		$oArticle,
			$iLang,
			$blRegenerate = false
	)

Returns SEO uri for passed article

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
int	$iLang	language id
bool	$blRegenerate	if TRUE forces seo url regeneration

Returns

string

getArticleUrl()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleUrl	(		$oArticle,
			$iLang = null,
			$iType = 0
	)

Encodes article URLs into SEO format

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	Article object
int	$iLang	language
int	$iType	type

Returns

string

getArticleVendorUri()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::getArticleVendorUri	(		$oArticle,
			$iLang,
			$blRegenerate = false
	)

Returns vendor seo uri for current article

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oArticle	article object
int	$iLang	language id
bool	$blRegenerate	if TRUE forces seo url regeneration

Returns

string

onDeleteArticle()

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::onDeleteArticle

(

$oArticle

)

deletes article seo entries

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

article to remove

Member Data Documentation

$_aTitleCache

OxidEsales\EshopCommunity\Application\Model\SeoEncoderArticle::$_aTitleCache = []

staticprotected

---

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

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