oxTagCloud Class Reference

Inheritance diagram for oxTagCloud:
Inheritance graph
[legend]
Collaboration diagram for oxTagCloud:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 setProductId ($sProductId)
 setLanguageId ($iLangId)
 setExtendedMode ($blExtended)
 getLanguageId ()
 getProductId ()
 isExtended ()
 getCloudArray ($sProductId=null, $blExtended=null, $iLang=null)
 getTagLink ($sTag)
 getTagTitle ($sTag)
 getTagSize ($sTag)
 getTags ($sArtId=null, $blExtended=false, $iLang=null)
 getTagCloud ($sArtId=null, $blExtended=false, $iLang=null)
 prepareTags ($sTags)
 trimTags ($sTags)
 resetTagCache ($iLang=null)

Protected Member Functions

 _getMaxHit ()
 _sortTags ($aTags, $iLang=null)
 _getFontSize ($iHit, $iMaxHit)
 _getCacheKey ($blExtended, $iLang=null)

Protected Attributes

 $_sCacheKey = "tagcloud_"
 $_blExtended = false
 $_sProductId = null
 $_iLangId = null
 $_iMaxHit = null
 $_aCloudArray = null
 $_sSeparator = ' '

Detailed Description

Class dedicateg to tag cloud handling

Definition at line 17 of file oxtagcloud.php.


Constructor & Destructor Documentation

oxTagCloud.__construct (  ) 

Object constructor. Initializes separator.

Reimplemented from oxSuperCfg.

Definition at line 73 of file oxtagcloud.php.


Member Function Documentation

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 505 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 410 of file oxtagcloud.php.

oxTagCloud._getMaxHit (  )  [protected]

Returns max hit

Returns:
int

Definition at line 226 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 311 of file oxtagcloud.php.

oxTagCloud.getCloudArray ( sProductId = null,
blExtended = null,
iLang = null 
)

Returns extended tag cloud array

Parameters:
string $sProductId product id [optional]
bool $blExtended extended clour array mode [optional]
int $iLang language id [optional]
Returns:
array

Definition at line 158 of file oxtagcloud.php.

oxTagCloud.getLanguageId (  ) 

Returns current tag cloud language id

Returns:
int

Definition at line 121 of file oxtagcloud.php.

oxTagCloud.getProductId (  ) 

Returns current tag cloud product id (if available)

Returns:
string

Definition at line 134 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]
Deprecated:
should ne used oxTagCloud.getCloudArray()
Returns:
string

Definition at line 353 of file oxtagcloud.php.

oxTagCloud.getTagLink ( sTag  ) 

Returns tag url (seo or dynamic depends on shop mode)

Parameters:
string $sTag tag title
Returns:
string

Definition at line 195 of file oxtagcloud.php.

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 260 of file oxtagcloud.php.

oxTagCloud.getTagSize ( sTag  ) 

Returns tag size

Parameters:
string $sTag tag title
Returns:
int

Definition at line 241 of file oxtagcloud.php.

oxTagCloud.getTagTitle ( sTag  ) 

Returns html safe tag title

Parameters:
string $sTag tag title
Returns:
string

Definition at line 216 of file oxtagcloud.php.

oxTagCloud.isExtended (  ) 

Extended mode getter

Returns:
bool

Definition at line 144 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 438 of file oxtagcloud.php.

oxTagCloud.resetTagCache ( iLang = null  ) 

Resets tag cache

Parameters:
int $iLang preferred language [optional]
Returns:
null

Definition at line 486 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
Returns:
null

Definition at line 111 of file oxtagcloud.php.

oxTagCloud.setLanguageId ( iLangId  ) 

Tag cloud language id setter

Parameters:
int $iLangId language id
Returns:
null

Definition at line 99 of file oxtagcloud.php.

oxTagCloud.setProductId ( sProductId  ) 

Tag cloud product id setter

Parameters:
string $sProductId product id
Returns:
null

Definition at line 87 of file oxtagcloud.php.

oxTagCloud.trimTags ( sTags  ) 

Trims underscores and spaces from tags.

Parameters:
string $sTags given tag
Returns:
string

Definition at line 464 of file oxtagcloud.php.


Member Data Documentation

oxTagCloud.$_aCloudArray = null [protected]

Definition at line 59 of file oxtagcloud.php.

oxTagCloud.$_blExtended = false [protected]

Definition at line 31 of file oxtagcloud.php.

oxTagCloud.$_iLangId = null [protected]

Definition at line 45 of file oxtagcloud.php.

oxTagCloud.$_iMaxHit = null [protected]

Definition at line 52 of file oxtagcloud.php.

oxTagCloud.$_sCacheKey = "tagcloud_" [protected]

Definition at line 24 of file oxtagcloud.php.

oxTagCloud.$_sProductId = null [protected]

Definition at line 38 of file oxtagcloud.php.

oxTagCloud.$_sSeparator = ' ' [protected]

Definition at line 67 of file oxtagcloud.php.


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

Generated by  doxygen 1.6.2