Tag/Cloud/Decorator/HtmlTag.php

Show:

inherited

Classes
- \Zend_Tag_Cloud_Decorator_HtmlTag

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Tag
Subpackage: Cloud
Version: $Id$

\Zend_Tag_Cloud_Decorator_HtmlTag
jump to top

Package: Zend_Tag

Simple HTML decorator for tags

Parent(s): \Zend_Tag_Cloud_Decorator_Tag
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses

Properties

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

Allowed fontsize units

Default valuearray('em', 'ex', 'px', 'in', 'cm', 'mm', 'pt', 'pc', '%')Details

Type: array

array $_classList = null

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

Default valuenullDetails

Type: array

string $_encoding = 'UTF-8'

Encoding to utilize

Default value'UTF-8'Details

Type: string

string $_fontSizeUnit = 'px'

Unit for the fontsize

Default value'px'Details

Type: string

array $_htmlTags = array('li')

List of HTML tags

Default valuearray('li')Details

Type: array

integer $_maxFontSize = 20

Maximum fontsize

Default value20Details

Type: integer

integer $_minFontSize = 10

Minimum fontsize

Default value10Details

Type: integer

Methods

getClassList() : array

Get class list

Returns

Type	Description
array

getEncoding() : string

Get encoding

Returns

Type	Description
string

getFontSizeUnit() : string

Retrieve font size unit

Returns

Type	Description
string

getHtmlTags() : array

Get HTML tags map

Returns

Type	Description
array

getMaxFontSize() : int

Retrieve maximum font size

Returns

Type	Description
int

getMinFontSize() : int

Retrieve minimum font size

Returns

Type	Description
int

render(\Zend_Tag_ItemList $tags) : array

Defined by Zend_Tag_Cloud_Decorator_Tag

Parameters

Name	Type	Description
$tags	\Zend_Tag_ItemList

Returns

Type	Description
array

setClassList(array $classList = null) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set a list of classes to use instead of fontsizes

Parameters

Name	Type	Description
$classList	array

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

Throws

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

setEncoding(string $value) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set encoding

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

setFontSizeUnit(string $fontSizeUnit) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set the font size unit

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

Parameters

Name	Type	Description
$fontSizeUnit	string

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

Throws

Exception	Description
\Zend_Tag_Cloud_Decorator_Exception	When an invalid fontsize unit is specified

setHtmlTags(array $htmlTags) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set the HTML tags surrounding the element

Parameters

Name	Type	Description
$htmlTags	array

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

setMaxFontSize(integer $maxFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set maximum font size

Parameters

Name	Type	Description
$maxFontSize	integer

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

Throws

Exception	Description
\Zend_Tag_Cloud_Decorator_Exception	When fontsize is not numeric

setMinFontSize(int $minFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set minimum font size

Parameters

Name	Type	Description
$minFontSize	int

Returns

Type	Description
\Zend_Tag_Cloud_Decorator_HtmlTag

Throws

Exception	Description
\Zend_Tag_Cloud_Decorator_Exception	When fontsize is not numeric

Tag/Cloud/Decorator/HtmlTag.php

\Zend_Tag_Cloud_Decorator_HtmlTagjump to top

Properties

Methods

\Zend_Tag_Cloud_Decorator_HtmlTag
jump to top