oxTagCloud Class Reference

Inheritance diagram for oxTagCloud:

[legend]

Collaboration diagram for oxTagCloud:

[legend]

List of all members.

---

Detailed Description

Class dedicateg to tag cloud handling

Definition at line 17 of file oxtagcloud.php.

Public Member Functions
	getTags ($sArtId=null, $blExtended=false, $iLang=null)
	getTagCloud ($sArtId=null, $blExtended=false, $iLang=null)
	prepareTags ($sTags)
	trimTags ($sTags)
	resetTagCache ($iLang=null)
Protected Member Functions
	_sortTags ($aTags, $iLang=null)
	_getFontSize ($iHit, $iMaxHit)
	_getCacheKey ($blExtended, $iLang=null)
Protected Attributes
	$_sCacheKey = "tagcloud_"

---

Member Function Documentation

oxTagCloud.getTags	(	$	sArtId = null,
		$	blExtended = false,
		$	iLang = null
	)

Returns tag array

Parameters:

	string	$sArtId article id
	bool	$blExtended if can extend tags
	int	$iLang preferred language [optional]

Returns:

array

Definition at line 35 of file oxtagcloud.php.

oxTagCloud._sortTags	(	$	aTags,
		$	iLang = null
	)			[protected]

Sorts passed tag array. Using MySQL for sorting (to keep user defined ordering way).

Parameters:

	array	$aTags tags to sort
	int	$iLang preferred language [optional]

Returns:

array

Definition at line 86 of file oxtagcloud.php.

oxTagCloud.getTagCloud	(	$	sArtId = null,
		$	blExtended = false,
		$	iLang = null
	)

Returns HTML formated Tag Cloud

Parameters:

	string	$sArtId article id
	bool	$blExtended if can extend tags
	int	$iLang preferred language [optional]

Returns:

string

Definition at line 126 of file oxtagcloud.php.

oxTagCloud._getFontSize	(	$	iHit,
		$	iMaxHit
	)			[protected]

Returns font size value for current occurence depending on max occurence.

Parameters:

	int	$iHit hit count
	int	$iMaxHit max hits count

Returns:

int

Definition at line 183 of file oxtagcloud.php.

oxTagCloud.prepareTags

(

$

sTags

)

Takes tag string and makes shorter tags longer by adding underscore. This is needed for FULLTEXT index

Parameters:

string

$sTags given tag

Returns:

string

Definition at line 211 of file oxtagcloud.php.

oxTagCloud.trimTags

(

$

sTags

)

Trims underscores from tags.

Parameters:

string

$sTags given tag

Returns:

string

Definition at line 236 of file oxtagcloud.php.

oxTagCloud.resetTagCache

(

$

iLang = null

)

Resets tag cache

Parameters:

int

$iLang preferred language [optional]

Returns:

null

Definition at line 257 of file oxtagcloud.php.

oxTagCloud._getCacheKey	(	$	blExtended,
		$	iLang = null
	)			[protected]

Returns tag cache key name.

Parameters:

	bool	$blExtended Whether to display full list
	int	$iLang preferred language [optional]

Returns:

null

Definition at line 276 of file oxtagcloud.php.

---

Member Data Documentation

oxTagCloud.$_sCacheKey = "tagcloud_" [protected]

Definition at line 24 of file oxtagcloud.php.

---

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

• core/oxtagcloud.php