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.

Definition at line 7 of file start.php.


Public Member Functions

 render ()
 getArticleList ()
 getTopArticleList ()
 getNewestArticles ()
 getFirstArticle ()
 getCatOfferArticle ()
 getCatOfferArticleList ()
 getTagCloud ()
 isMoreTagsVisible ()
 getTitleSuffix ()
 getCanonicalUrl ()

Protected Member Functions

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

Protected Attributes

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

Member Function Documentation

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.

Definition at line 101 of file start.php.

Start._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 dublicate cleaning
Returns:
string

Reimplemented from oxUBase.

Definition at line 173 of file start.php.

Start._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 dublicated words
Returns:
string

Reimplemented from oxUBase.

Definition at line 194 of file start.php.

Start._getLoadActionsParam (  )  [protected]

Template variable getter. Returns if actions are ON

Returns:
string

Definition at line 211 of file start.php.

Start.getArticleList (  ) 

Template variable getter. Returns start page articles (OXSTART)

Returns:
array

Definition at line 227 of file start.php.

Start.getTopArticleList (  ) 

Template variable getter. Returns Top article list (OXTOPSTART)

Returns:
array

Definition at line 248 of file start.php.

Start.getNewestArticles (  ) 

Template variable getter. Returns newest article list

Returns:
array

Definition at line 269 of file start.php.

Start.getFirstArticle (  ) 

Template variable getter. Returns first article

Returns:
object

Definition at line 290 of file start.php.

Start.getCatOfferArticle (  ) 

Template variable getter. Returns category offer article (OXCATOFFER)

Returns:
object

Definition at line 311 of file start.php.

Start.getCatOfferArticleList (  ) 

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

Returns:
array

Definition at line 327 of file start.php.

Start.getTagCloud (  ) 

Template variable getter. Returns tag cloud

Returns:
array

Definition at line 348 of file start.php.

Start.isMoreTagsVisible (  ) 

Template variable getter. Returns true

Returns:
bool

Reimplemented from oxUBase.

Definition at line 363 of file start.php.

Start.getTitleSuffix (  ) 

Returns SEO suffix for page title

Returns:
string

Reimplemented from oxUBase.

Definition at line 373 of file start.php.

Start.getCanonicalUrl (  ) 

Returns view canonical url

Returns:
string

Reimplemented from oxUBase.

Definition at line 383 of file start.php.


Member Data Documentation

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

Reimplemented from oxView.

Definition at line 13 of file start.php.

Start.$_sMetaDescriptionIdent = 'oxstartmetadescription' [protected]

Reimplemented from oxUBase.

Definition at line 20 of file start.php.

Start.$_sMetaKeywordsIdent = 'oxstartmetakeywords' [protected]

Reimplemented from oxUBase.

Definition at line 27 of file start.php.

Start.$_blLoadActions = null [protected]

Definition at line 34 of file start.php.

Start.$_aTopArticleList = null [protected]

Definition at line 41 of file start.php.

Start.$_aNewArticleList = null [protected]

Definition at line 48 of file start.php.

Start.$_oFirstArticle = null [protected]

Definition at line 55 of file start.php.

Start.$_oCatOfferArticle = null [protected]

Definition at line 62 of file start.php.

Start.$_oCatOfferArtList = null [protected]

Definition at line 69 of file start.php.

Start.$_sTagCloud = null [protected]

Definition at line 76 of file start.php.

Start.$_blTop5Action = true [protected]

Reimplemented from oxUBase.

Definition at line 82 of file start.php.

Start.$_blBargainAction = true [protected]

Reimplemented from oxUBase.

Definition at line 88 of file start.php.


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

Generated on Mon Oct 26 20:12:31 2009 for OXID eShop CE by  doxygen 1.5.5