Tag/Cloud/Decorator/HtmlTag.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Tag
- Subpackage
- Cloud
- Version
- $Id: HtmlTag.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Tag_Cloud_Decorator_HtmlTag
Package: Zend\Tag






Parameters
Returns
Throws




Simple HTML decorator for tags
- Parent(s)
- \Zend_Tag_Cloud_Decorator_Tag
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Tag_Cloud_Decorator_Tag
Properties


array $_alloweFontSizeUnits = array('em', 'ex', 'px', 'in', 'cm', 'mm', 'pt', 'pc', '%')
Allowed fontsize units
Default value
array('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 value
null
Details- Type
- array


array $_skipOptions = array('options', 'config')
inherited
Option keys to skip when calling setOptions()
Inherited from:
\Zend_Tag_Cloud_Decorator_Tag::$$_skipOptionsDefault value
array('options', 'config')
Details- Type
- array
- Inherited_from
- \Zend_Tag_Cloud_Decorator_Tag::$$_skipOptions
Methods


__construct(mixed $options = null) : void
inherited
Create a new cloud decorator with options
Inherited from: \Zend_Tag_Cloud_Decorator_Tag::__construct()Parameters
Name | Type | Description |
---|---|---|
$options | mixed |


render(\Zend_Tag_ItemList $tags) : array
Defined by Zend_Tag_Cloud_Decorator_Tag
Parameters
Returns
Name | Type | Description |
---|---|---|
$tags | \Zend_Tag_ItemList |
Type | Description |
---|---|
array |


setClassList(array $classList = null) : \Zend_Tag_Cloud_Decorator_HtmlTag
Set a list of classes to use instead of fontsizes
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$classList | array |
Type | Description |
---|---|
\Zend_Tag_Cloud_Decorator_HtmlTag |
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
Returns
Name | Type | Description |
---|---|---|
$value | string |
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 %
Name | Type | Description |
---|---|---|
$fontSizeUnit | string |
Type | Description |
---|---|
\Zend_Tag_Cloud_Decorator_HtmlTag |
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
Returns
Name | Type | Description |
---|---|---|
$htmlTags | array |
Type | Description |
---|---|
\Zend_Tag_Cloud_Decorator_HtmlTag |


setMaxFontSize(integer $maxFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag
Set maximum font size
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$maxFontSize | integer |
Type | Description |
---|---|
\Zend_Tag_Cloud_Decorator_HtmlTag |
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
Returns
Throws
Name | Type | Description |
---|---|---|
$minFontSize | int |
Type | Description |
---|---|
\Zend_Tag_Cloud_Decorator_HtmlTag |
Exception | Description |
---|---|
\Zend_Tag_Cloud_Decorator_Exception | When fontsize is not numeric |


setOptions(array $options) : \Zend_Tag_Cloud
Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array | Configuration for the decorator |
Type | Description |
---|---|
\Zend_Tag_Cloud |