oxTagCloud Class Reference

Inheritance diagram for oxTagCloud:

Collaboration diagram for oxTagCloud:

Public Member Functions
	__construct ()
	getTagMaxLength ()
	setExtendedMode ($blExtended)
	isExtended ()
	setTagList (oxITagList $oTagList)
	getTagList ()
	setCloudArray ($aTagCloudArray)
	getCloudArray ()
	formCloudArray (oxITagList $oTagList)
	getTagSize ($sTag)
	getMaxAmount ()
	resetTagCache ($iLang=null)
	resetCache ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_formCacheKey ($sTagListCacheId=null)
	_getMaxHit ()
	_getTagHitCount ($oTag)
	_getFontSize ($iHit, $iMaxHit)

Protected Attributes
	$_sCacheKey = "tagcloud"
	$_iMaxHit = null
	$_aCloudArray = null
	$_blExtended = false
	$_iTagMaxLength = 60

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

Class dedicated to tag cloud handling

Definition at line 15 of file oxtagcloud.php.

Constructor & Destructor Documentation

oxTagCloud::__construct

(

)

Object constructor. Initializes separator.

Reimplemented from oxSuperCfg.

Definition at line 58 of file oxtagcloud.php.

Member Function Documentation

oxTagCloud::_formCacheKey (   $sTagListCacheId = null )

protected

Returns tag cache key name.

Parameters

string

$sTagListCacheId

Whether to display full list

Returns

string formed cache key

Definition at line 246 of file oxtagcloud.php.

oxTagCloud::_getFontSize (   $iHit,   $iMaxHit  )

protected

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

Parameters

int	$iHit	hit count
int	$iMaxHit	max hits count

Returns

int

Definition at line 288 of file oxtagcloud.php.

oxTagCloud::_getMaxHit ( )

protected

Returns max hit

Returns

int

Definition at line 258 of file oxtagcloud.php.

oxTagCloud::_getTagHitCount (   $oTag )

protected

Returns tag hit count. Used for _getMaxHit array mapping

Parameters

oxTag

$oTag

tag object

Returns

int

Definition at line 275 of file oxtagcloud.php.

oxTagCloud::formCloudArray

(

oxITagList

$oTagList

)

Returns tag cloud array

Parameters

oxITagList

$oTagList

Tag List

Returns

array

Definition at line 147 of file oxtagcloud.php.

oxTagCloud::getCloudArray

(

)

Returns extended tag cloud array

Returns

array

Definition at line 128 of file oxtagcloud.php.

oxTagCloud::getMaxAmount

(

)

Returns maximum amount of tags, that should be shown in list

Returns

int

Definition at line 200 of file oxtagcloud.php.

oxTagCloud::getTagList

(

)

Returns oxITagList object

Returns

oxITagList

Definition at line 107 of file oxtagcloud.php.

oxTagCloud::getTagMaxLength

(

)

Returns current maximum tag length

Returns

int

Definition at line 67 of file oxtagcloud.php.

oxTagCloud::getTagSize

(

$sTag

)

Returns tag size

Parameters

string

$sTag

tag title

Returns

int

Definition at line 183 of file oxtagcloud.php.

oxTagCloud::isExtended

(

)

Extended mode getter

Returns

bool

Definition at line 87 of file oxtagcloud.php.

oxTagCloud::resetCache

(

)

Resets tag cache

Definition at line 225 of file oxtagcloud.php.

oxTagCloud::resetTagCache

(

$iLang = null

)

Resets tag cache

Parameters

int

$iLang

preferred language [optional]

Definition at line 214 of file oxtagcloud.php.

oxTagCloud::setCloudArray

(

$aTagCloudArray

)

Sets tag cloud array

Parameters

array

$aTagCloudArray

tag cloud array

Definition at line 117 of file oxtagcloud.php.

oxTagCloud::setExtendedMode

(

$blExtended

)

Tag cloud mode setter (extended or not)

Parameters

bool

$blExtended

if true - extended cloud array will be returned

Definition at line 77 of file oxtagcloud.php.

oxTagCloud::setTagList

(

oxITagList

$oTagList

)

Sets oxITagList object

Parameters

oxITagList

$oTagList

Tag cloud set object, which implements oxITagList

Definition at line 97 of file oxtagcloud.php.

Member Data Documentation

oxTagCloud::$_aCloudArray = null

protected

Definition at line 37 of file oxtagcloud.php.

oxTagCloud::$_blExtended = false

protected

Definition at line 44 of file oxtagcloud.php.

oxTagCloud::$_iMaxHit = null

protected

Definition at line 30 of file oxtagcloud.php.

oxTagCloud::$_iTagMaxLength = 60

protected

Definition at line 53 of file oxtagcloud.php.

oxTagCloud::$_sCacheKey = "tagcloud"

protected

Definition at line 23 of file oxtagcloud.php.

---

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

• application/models/oxtagcloud.php