Public Member Functions | Protected Member Functions | Protected Attributes

Tag Class Reference

Inheritance diagram for Tag:
Collaboration diagram for Tag:

List of all members.

Public Member Functions

 render ()
 getAddUrlParams ()
 getSorting ($sCnid)
 setItemSorting ($sCnid, $sSortBy, $sSortOrder=null)
 generatePageNavigationUrl ()
 getArticleList ()
 getTag ()
 getTitle ()
 getTreePath ()
 getCanonicalUrl ()
 getBreadCrumb ()

Protected Member Functions

 _getProductLinkType ()
 _loadArticles ($oCategory)
 _getCatPathString ()
 _getSeoObjectId ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)

Protected Attributes

 $_sListType = 'tag'
 $_blShowSorting = true
 $_sTag
 $_sTagTitle
 $_oPageNavigation = null
 $_sTemplateLocation
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX

Detailed Description

Tag filter for articles

Definition at line 6 of file tag.php.


Member Function Documentation

Tag._addPageNrParam ( sUrl,
iPage,
iLang = null 
) [protected]

Adds page number parameter to current Url and returns formatted url

Parameters:
string $sUrl url to append page numbers
int $iPage current page number
int $iLang requested language
Returns:
string

Reimplemented from aList.

Definition at line 195 of file tag.php.

Tag._getCatPathString (  )  [protected]

Returns string for "we are here string"

Returns:
string

Reimplemented from aList.

Definition at line 128 of file tag.php.

Tag._getProductLinkType (  )  [protected]

Returns product link type (OXARTICLE_LINKTYPE_TAG)

Returns:
int

Reimplemented from aList.

Definition at line 81 of file tag.php.

Tag._getSeoObjectId (  )  [protected]

Returns active product id to load its seo meta info

Returns:
string

Reimplemented from aList.

Definition at line 138 of file tag.php.

Tag._loadArticles ( oCategory  )  [protected]

Loads and returns article list according active tag.

Parameters:
object $oCategory category object
Returns:
array

Reimplemented from aList.

Definition at line 108 of file tag.php.

Tag._prepareMetaDescription ( sMeta,
iLength = 1024,
blDescTag = false 
) [protected]

Returns current view meta description data (calls parent._collectMetaDescription())

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 $sString converted string

Reimplemented from aList.

Definition at line 300 of file tag.php.

Tag._prepareMetaKeyword ( sKeywords,
blRemoveDuplicatedWords = true 
) [protected]

Returns current view keywords seperated by comma (calls parent._collectMetaKeyword())

Parameters:
string $sKeywords data to use as keywords
bool $blRemoveDuplicatedWords remove dublicated words
Returns:
string

Reimplemented from aList.

Definition at line 285 of file tag.php.

Tag.generatePageNavigationUrl (  ) 

Generates Url for page navigation

Returns:
string

Reimplemented from aList.

Definition at line 178 of file tag.php.

Tag.getAddUrlParams (  ) 

Returns additional URL parameters which must be added to list products dynamic urls

Returns:
string

Reimplemented from aList.

Definition at line 91 of file tag.php.

Tag.getArticleList (  ) 

Template variable getter. Returns article list

Returns:
array

Reimplemented from aList.

Definition at line 213 of file tag.php.

Tag.getBreadCrumb (  ) 

Returns Bread Crumb - you are here page1/page2/page3...

Returns:
array

Reimplemented from aList.

Definition at line 324 of file tag.php.

Tag.getCanonicalUrl (  ) 

Returns view canonical url

Returns:
string

Reimplemented from aList.

Definition at line 310 of file tag.php.

Tag.getSorting ( sCnid  ) 

Returns search sorting config

Parameters:
string $sCnid sortable item id
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns:
string

Reimplemented from aList.

Definition at line 152 of file tag.php.

Tag.getTag (  ) 

Template variable getter. Returns current tag

Returns:
string

Definition at line 229 of file tag.php.

Tag.getTitle (  ) 

Template variable getter. Returns tag title

Returns:
string

Reimplemented from aList.

Definition at line 242 of file tag.php.

Tag.getTreePath (  ) 

Template variable getter. Returns category path array

Returns:
array

Reimplemented from aList.

Definition at line 260 of file tag.php.

Tag.render (  ) 

Executes parent.render(), loads article list according active tag

Returns:
string $this->_sThisTemplate current template file name

Reimplemented from aList.

Definition at line 59 of file tag.php.

Tag.setItemSorting ( sCnid,
sSortBy,
sSortOrder = null 
)

Sets search sorting config

Parameters:
string $sCnid sortable item id
string $sSortBy sort field
string $sSortOrder sort order
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns:
null

Reimplemented from oxUBase.

Definition at line 168 of file tag.php.


Member Data Documentation

Tag.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 18 of file tag.php.

Tag.$_iViewIndexState = VIEW_INDEXSTATE_INDEX [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 52 of file tag.php.

Tag.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 38 of file tag.php.

Tag.$_sListType = 'tag' [protected]

Reimplemented from oxUBase.

Definition at line 12 of file tag.php.

Tag.$_sTag [protected]

Definition at line 25 of file tag.php.

Tag.$_sTagTitle [protected]

Definition at line 32 of file tag.php.

Tag.$_sTemplateLocation [protected]

Definition at line 45 of file tag.php.


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