Simple HTML decorator for tags

category Zend
package Zend_Tag
uses
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Tag_Cloud_Decorator_Tag

 Methods

Create a new cloud decorator with options

__construct(mixed $options = null
Inherited

Parameters

$options

mixed

Get class list

getClassList() : array

Returns

array

Get encoding

getEncoding() : string

Returns

string

Retrieve font size unit

getFontSizeUnit() : string

Returns

string

Get HTML tags map

getHtmlTags() : array

Returns

array

Retrieve maximum font size

getMaxFontSize() : integer

Returns

integer

Retrieve minimum font size

getMinFontSize() : integer

Returns

integer

Defined by Zend_Tag_Cloud_Decorator_Tag

render(\Zend_Tag_ItemList $tags) : array
inherited_from \Zend_Tag_Cloud_Decorator_Tag::render()

Parameters

$tags

\Zend_Tag_ItemList

Returns

array

Render a list of tags

render(\Zend_Tag_ItemList $tags) : array
Inherited

Parameters

$tags

\Zend_Tag_ItemList

Returns

array

Set a list of classes to use instead of fontsizes

setClassList(array $classList = null) : \Zend_Tag_Cloud_Decorator_HtmlTag

Parameters

$classList

array

Exceptions

\Zend_Tag_Cloud_Decorator_Exception When the classlist is empty
\Zend_Tag_Cloud_Decorator_Exception When the classlist contains an invalid classname

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set encoding

setEncoding(string $value) : \Zend_Tag_Cloud_Decorator_HtmlTag

Parameters

$value

string

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set the font size unit

setFontSizeUnit(string $fontSizeUnit) : \Zend_Tag_Cloud_Decorator_HtmlTag

Possible values are: em, ex, px, in, cm, mm, pt, pc and %

Parameters

$fontSizeUnit

string

Exceptions

\Zend_Tag_Cloud_Decorator_Exception When an invalid fontsize unit is specified

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set the HTML tags surrounding the <a> element

setHtmlTags(array $htmlTags) : \Zend_Tag_Cloud_Decorator_HtmlTag

Parameters

$htmlTags

array

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set maximum font size

setMaxFontSize(integer $maxFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Parameters

$maxFontSize

integer

Exceptions

\Zend_Tag_Cloud_Decorator_Exception When fontsize is not numeric

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set minimum font size

setMinFontSize(integer $minFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Parameters

$minFontSize

integer

Exceptions

\Zend_Tag_Cloud_Decorator_Exception When fontsize is not numeric

Returns

\Zend_Tag_Cloud_Decorator_HtmlTag

Set options from array

setOptions(array $options) : \Zend_Tag_Cloud
Inherited

Parameters

$options

array

Configuration for the decorator

Returns

\Zend_Tag_Cloud

 Properties

 

Allowed fontsize units

$_alloweFontSizeUnits : array

Default

array('em', 'ex', 'px', 'in', 'cm', 'mm', 'pt', 'pc', '%')
 

List of tags which get assigned to the inner element instead of font-sizes.

$_classList : array

Default

null
 

Encoding to utilize

$_encoding : string

Default

'UTF-8'
 

Unit for the fontsize

$_fontSizeUnit : string

Default

'px'
 

List of HTML tags

$_htmlTags : array

Default

array('li')
 

Maximum fontsize

$_maxFontSize : integer

Default

20
 

Minimum fontsize

$_minFontSize : integer

Default

10
 

Option keys to skip when calling setOptions()

$_skipOptions : array

Default

array('options', 'config')