OxidEsales\EshopCommunity\Application\Controller\StartController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\StartController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\StartController:

Public Member Functions
	render ()
	getArticleList ()
	getTopArticleList ()
	getNewestArticles ()
	getFirstArticle ()
	getCatOfferArticle ()
	getCatOfferArticleList ()
	getTitleSuffix ()
	getCanonicalUrl ()
	getBanners ()
	getManufacturerForSlider ()

Protected Member Functions
	_prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_getLoadActionsParam ()

Protected Attributes
	$_sListDisplayType = null
	$_sThisTemplate = 'page/shop/start.tpl'
	$_sMetaDescriptionIdent = 'oxstartmetadescription'
	$_sMetaKeywordsIdent = 'oxstartmetakeywords'
	$_blLoadActions = null
	$_aTopArticleList = null
	$_aNewArticleList = null
	$_oFirstArticle = null
	$_oCatOfferArticle = null
	$_oCatOfferArtList = null
	$_blTop5Action = true
	$_blBargainAction = true

Detailed Description

Starting shop page. Shop starter, manages starting visible articles, etc.

Member Function Documentation

_getLoadActionsParam()

OxidEsales\EshopCommunity\Application\Controller\StartController::_getLoadActionsParam ( )

protected

Template variable getter. Returns if actions are ON

Returns

string

_prepareMetaDescription()

OxidEsales\EshopCommunity\Application\Controller\StartController::_prepareMetaDescription (   $sMeta,   $iLength = 1024,   $blDescTag = false  )

protected

Returns current view meta data If $sMeta parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters

string	$sMeta	category path
int	$iLength	max length of result, -1 for no truncation
bool	$blDescTag	if true - performs additional duplicate cleaning

Returns

string

_prepareMetaKeyword()

OxidEsales\EshopCommunity\Application\Controller\StartController::_prepareMetaKeyword (   $sKeywords,   $blRemoveDuplicatedWords = true  )

protected

Returns current view keywords seperated by comma If $sKeywords parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters

string	$sKeywords	data to use as keywords
bool	$blRemoveDuplicatedWords	remove duplicated words

Returns

string

getArticleList()

OxidEsales\EshopCommunity\Application\Controller\StartController::getArticleList

(

)

Template variable getter. Returns start page articles (OXSTART)

Returns

array

getBanners()

OxidEsales\EshopCommunity\Application\Controller\StartController::getBanners

(

)

Returns active banner list

Returns

objects

getCanonicalUrl()

OxidEsales\EshopCommunity\Application\Controller\StartController::getCanonicalUrl

(

)

Returns view canonical url

Returns

string

getCatOfferArticle()

OxidEsales\EshopCommunity\Application\Controller\StartController::getCatOfferArticle

(

)

Template variable getter. Returns category offer article (OXCATOFFER)

Returns

object

getCatOfferArticleList()

OxidEsales\EshopCommunity\Application\Controller\StartController::getCatOfferArticleList

(

)

Template variable getter. Returns category offer article list (OXCATOFFER)

Returns

array

getFirstArticle()

OxidEsales\EshopCommunity\Application\Controller\StartController::getFirstArticle

(

)

Template variable getter. Returns first article

Returns

object

getManufacturerForSlider()

OxidEsales\EshopCommunity\Application\Controller\StartController::getManufacturerForSlider

(

)

Returns manufacturer list for manufacturer slider

Returns

objects

getNewestArticles()

OxidEsales\EshopCommunity\Application\Controller\StartController::getNewestArticles

(

)

Template variable getter. Returns newest article list

Returns

array

getTitleSuffix()

OxidEsales\EshopCommunity\Application\Controller\StartController::getTitleSuffix

(

)

Returns SEO suffix for page title

Returns

string

getTopArticleList()

OxidEsales\EshopCommunity\Application\Controller\StartController::getTopArticleList

(

)

Template variable getter. Returns Top article list (OXTOPSTART)

Returns

array

render()

OxidEsales\EshopCommunity\Application\Controller\StartController::render

(

)

Executes parent::render(), loads action articles (oxarticlelist::loadActionArticles()). Returns name of template file to render.

Returns

string cuurent template file name

Member Data Documentation

$_aNewArticleList

OxidEsales\EshopCommunity\Application\Controller\StartController::$_aNewArticleList = null

protected

$_aTopArticleList

OxidEsales\EshopCommunity\Application\Controller\StartController::$_aTopArticleList = null

protected

$_blBargainAction

OxidEsales\EshopCommunity\Application\Controller\StartController::$_blBargainAction = true

protected

$_blLoadActions

OxidEsales\EshopCommunity\Application\Controller\StartController::$_blLoadActions = null

protected

$_blTop5Action

OxidEsales\EshopCommunity\Application\Controller\StartController::$_blTop5Action = true

protected

$_oCatOfferArticle

OxidEsales\EshopCommunity\Application\Controller\StartController::$_oCatOfferArticle = null

protected

$_oCatOfferArtList

OxidEsales\EshopCommunity\Application\Controller\StartController::$_oCatOfferArtList = null

protected

$_oFirstArticle

OxidEsales\EshopCommunity\Application\Controller\StartController::$_oFirstArticle = null

protected

$_sListDisplayType

OxidEsales\EshopCommunity\Application\Controller\StartController::$_sListDisplayType = null

protected

$_sMetaDescriptionIdent

OxidEsales\EshopCommunity\Application\Controller\StartController::$_sMetaDescriptionIdent = 'oxstartmetadescription'

protected

$_sMetaKeywordsIdent

OxidEsales\EshopCommunity\Application\Controller\StartController::$_sMetaKeywordsIdent = 'oxstartmetakeywords'

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\StartController::$_sThisTemplate = 'page/shop/start.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/StartController.php