Start Class Reference

Inheritance diagram for Start:

Inheritance graph
[legend]
Collaboration diagram for Start:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

Public Member Functions

 init ()
 render ()
 setMetaDescription ($sInput, $iLength=1024, $blDescTag=false)
 setMetaKeywords ($sInput)
 _getLoadActionsParam ()
 getArticleList ()
 getTopArticleList ()
 getNewestArticles ()
 getFirstArticle ()
 getCatOfferArticle ()
 getCatOfferArticleList ()
 getTagCloud ()
 isMoreTagsVisible ()
 getTitleSuffix ()

Protected Attributes

 $_sThisTemplate = 'start.tpl'
 $_sMetaDescriptionIdent = 'oxstartmetadescription'
 $_sMetaKeywordsIdent = 'oxstartmetakeywords'
 $_blLoadActions = null
 $_aTopArticleList = null
 $_aNewArticleList = null
 $_oFirstArticle = null
 $_oCatOfferArticle = null
 $_oCatOfferArtList = null
 $_sTagCloud = null

Member Function Documentation

Start.init (  ) 

Unsets SEO category and call parent.init();

Returns:
null

Reimplemented from oxUBase.

Start.render (  ) 

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

Template variables: articlelist, firstarticle, toparticlelist, articlebargainlist

Returns:
string cuurent template file name

Reimplemented from oxUBase.

Start.setMetaDescription ( sInput,
iLength = 1024,
blDescTag = false 
)

Sets the view parameter "meta_description". First tries to fetch data from content by ident (start._sMetaContentIdent) and if data is not found - prepares keywords from given input params

Parameters:
mixed $sInput meta description
int $iLength max length of result, -1 for no truncation
bool $blDescTag if true - performs additional dublicate cleaning
Returns:
null

Reimplemented from oxView.

Start.setMetaKeywords ( sInput  ) 

Sets the view parameter 'meta_keywords'. First tries to fetch data from content by ident (start._sMetaContentIdent) and if data is not found - prepares keywords from given input params

Parameters:
mixed $sInput keywords
Returns:
null

Reimplemented from oxView.

Start._getLoadActionsParam (  ) 

Template variable getter. Returns if actions are ON

Returns:
string

Start.getArticleList (  ) 

Template variable getter. Returns start page articles (OXSTART)

Returns:
array

Start.getTopArticleList (  ) 

Template variable getter. Returns Top article list (OXTOPSTART)

Returns:
array

Start.getNewestArticles (  ) 

Template variable getter. Returns newest article list

Returns:
array

Start.getFirstArticle (  ) 

Template variable getter. Returns first article

Returns:
object

Start.getCatOfferArticle (  ) 

Template variable getter. Returns category offer article (OXCATOFFER)

Returns:
object

Start.getCatOfferArticleList (  ) 

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

Returns:
array

Start.getTagCloud (  ) 

Template variable getter. Returns tag cloud

Returns:
array

Start.isMoreTagsVisible (  ) 

Template variable getter. Returns true

Returns:
bool

Reimplemented from oxView.

Start.getTitleSuffix (  ) 

Returns SEO suffix for page title

Returns:
string

Reimplemented from oxView.


Member Data Documentation

Start.$_sThisTemplate = 'start.tpl' [protected]

Reimplemented from oxView.

Start.$_sMetaDescriptionIdent = 'oxstartmetadescription' [protected]

Start.$_sMetaKeywordsIdent = 'oxstartmetakeywords' [protected]

Start.$_blLoadActions = null [protected]

Start.$_aTopArticleList = null [protected]

Start.$_aNewArticleList = null [protected]

Start.$_oFirstArticle = null [protected]

Start.$_oCatOfferArticle = null [protected]

Start.$_oCatOfferArtList = null [protected]

Start.$_sTagCloud = null [protected]


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

Generated on Wed Oct 29 23:47:48 2008 for OXID eShop CE by  doxygen 1.5.5