Tag Class Reference

Inheritance diagram for Tag:

[legend]

Collaboration diagram for Tag:

[legend]

List of all members.

---

Detailed Description

Tag filter for articles

Definition at line 6 of file tag.php.

Public Member Functions
	init ()
	render ()
	getAddUrlParams ()
	getSorting ($sCnid)
	setItemSorting ($sCnid, $sSortBy, $sSortOrder=null)
	generatePageNavigation ()
	generatePageNavigationUrl ()
	getArticleList ()
	getTag ()
	getTitle ()
	getTemplateLocation ()
	getPageNavigation ()
	getActiveCategory ()
Protected Member Functions
	_loadArticles ($oVendor)
	_getCatPathString ()
	_getSeoObjectId ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_prepareMetaKeyword ($sKeywords)
	_prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
Protected Attributes
	$_sListType = 'tag'
	$_blShowSorting = true
	$_sTag
	$_sTagTitle
	$_oPageNavigation = null
	$_sTemplateLocation

---

Member Function Documentation

Tag.init

(

)

Calls self._processRequest(), initializes components which needs to be loaded, sets current list type, calls parent.init()

Returns:

null

Reimplemented from oxUBase.

Definition at line 47 of file tag.php.

Tag.render

(

)

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

Template variables: articlelist, pageNavigation, subcatlist, meta_keywords, meta_description

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from aList.

Definition at line 62 of file tag.php.

Tag.getAddUrlParams

(

)

Returns additional URL paramerets which must be added to list products urls

Returns:

string

Reimplemented from oxUBase.

Definition at line 88 of file tag.php.

Tag._loadArticles

(

$

oVendor

)

[protected]

Loads and returns article list of active vendor.

Parameters:

object

$oVendor vendor object

Returns:

array

Reimplemented from aList.

Definition at line 107 of file tag.php.

Tag._getCatPathString

(

)

[protected]

Returns string for "we are here string"

Returns:

string

Reimplemented from aList.

Definition at line 129 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 139 of file tag.php.

Tag.getSorting

(

$

sCnid

)

Returns search sorting config

Parameters:

string

$sCnid sortable item id

Returns:

string

Reimplemented from aList.

Definition at line 151 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

Returns:

null

Reimplemented from oxUBase.

Definition at line 165 of file tag.php.

Tag.generatePageNavigation

(

)

Generates Url for page navigation

Returns:

string

Reimplemented from oxUBase.

Definition at line 175 of file tag.php.

Tag.generatePageNavigationUrl

(

)

Generates Url for page navigation

Parameters:

string

$sClass active class name (optional)

Returns:

string

Reimplemented from aList.

Definition at line 187 of file tag.php.

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 201 of file tag.php.

Tag.getArticleList

(

)

Template variable getter. Returns article list

Returns:

array

Reimplemented from aList.

Definition at line 211 of file tag.php.

Tag.getTag

(

)

Template variable getter. Returns current tag

Returns:

string

Definition at line 226 of file tag.php.

Tag.getTitle

(

)

Template variable getter. Returns tag title

Returns:

string

Reimplemented from aList.

Definition at line 236 of file tag.php.

Tag.getTemplateLocation

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 254 of file tag.php.

Tag.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Reimplemented from aList.

Definition at line 272 of file tag.php.

Tag.getActiveCategory

(

)

Template variable getter. Returns active search

Returns:

object

Reimplemented from aList.

Definition at line 286 of file tag.php.

Tag._prepareMetaKeyword

(

$

sKeywords

)

[protected]

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

Parameters:

string

$sKeywords data to use as keywords

Returns:

string

Reimplemented from aList.

Definition at line 299 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 314 of file tag.php.

---

Member Data Documentation

Tag.$_sListType = 'tag' [protected]

Reimplemented from oxUBase.

Definition at line 12 of file tag.php.

Tag.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 18 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.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 38 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:

• views/tag.php