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)
 getTagCloud ($sArtId=null, $blExtended=false)
 prepareTags ($sTags)
 trimTags ($sTags)
 resetTagCache ()

Static Public Member Functions

static generateTagsFromLongDescription ($iLang=0)

Protected Member Functions

 _getFontSize ($iHit, $iMaxHit)
 _getCacheKey ($blExtended)

Protected Attributes

 $_sCacheKey = "tagcloud_"

Member Function Documentation

static oxTagCloud.generateTagsFromLongDescription ( iLang = 0  )  [static]

This method generates test tags data and probably should be deleted for the release. Or if you need tags you can generate them by: oxTagCloud.generateTagsFromLongDescription(); We used this method for demo data only

Parameters:
int $iLang language
Returns:
null

Definition at line 35 of file oxtagcloud.php.

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

Returns tag array

Parameters:
string $sArtId article id
bool $blExtended if can extend tags
Returns:
array

Definition at line 78 of file oxtagcloud.php.

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

Returns HTML formated Tag Cloud

Parameters:
string $sArtId article id
bool $blExtended if can extend tags
Returns:
string

Definition at line 132 of file oxtagcloud.php.

oxTagCloud._getFontSize ( iHit,
iMaxHit 
) [protected]

Assigns article oxsearchkeys field value to article tags

Returns:
bool 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 205 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 233 of file oxtagcloud.php.

oxTagCloud.trimTags ( sTags  ) 

Trims underscores from tags.

Parameters:
string $sTags given tag
Returns:
string

Definition at line 262 of file oxtagcloud.php.

oxTagCloud.resetTagCache (  ) 

Resets tag cache

Returns:
null

Definition at line 286 of file oxtagcloud.php.

oxTagCloud._getCacheKey ( blExtended  )  [protected]

Returns tag cache key name.

Parameters:
bool $blExtended Whether to display full list
Returns:
null

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

Generated on Thu Dec 4 12:05:34 2008 for OXID eShop CE by  doxygen 1.5.5