Tag/Cloud/Decorator/HtmlTag.php

Show: PublicProtectedPrivateinherited
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-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
jump to top

Package: Zend\Tag
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

>VPropertyprotectedarray $_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
>VPropertyprotectedarray $_classList = null
List of tags which get assigned to the inner element instead of font-sizes.
Default valuenullDetails
Type
array
>VPropertyprotectedstring $_encoding = 'UTF-8'

Encoding to utilize

Default value'UTF-8'Details
Type
string
>VPropertyprotectedstring $_fontSizeUnit = 'px'
Unit for the fontsize
Default value'px'Details
Type
string
>VPropertyprotectedarray $_htmlTags = array('li')
List of HTML tags
Default valuearray('li')Details
Type
array
>VPropertyprotectedinteger $_maxFontSize = 20
Maximum fontsize
Default value20Details
Type
integer
>VPropertyprotectedinteger $_minFontSize = 10
Minimum fontsize
Default value10Details
Type
integer
>VPropertyprotectedarray $_skipOptions = array('options', 'config')
inherited
Option keys to skip when calling setOptions()
Inherited from: \Zend_Tag_Cloud_Decorator_Tag::$$_skipOptions
Default valuearray('options', 'config')Details
Type
array
Inherited_from
\Zend_Tag_Cloud_Decorator_Tag::$$_skipOptions  

Methods

methodpublic__construct(mixed $options = null) : void
inherited

Create a new cloud decorator with options

Inherited from: \Zend_Tag_Cloud_Decorator_Tag::__construct()
Parameters
NameTypeDescription
$optionsmixed
methodpublicgetClassList() : array

Get class list

Returns
TypeDescription
array
methodpublicgetEncoding() : string

Get encoding

Returns
TypeDescription
string
methodpublicgetFontSizeUnit() : string

Retrieve font size unit

Returns
TypeDescription
string
methodpublicgetHtmlTags() : array

Get HTML tags map

Returns
TypeDescription
array
methodpublicgetMaxFontSize() : int

Retrieve maximum font size

Returns
TypeDescription
int
methodpublicgetMinFontSize() : int

Retrieve minimum font size

Returns
TypeDescription
int
methodpublicrender(\Zend_Tag_ItemList $tags) : array

Defined by Zend_Tag_Cloud_Decorator_Tag

Parameters
NameTypeDescription
$tags\Zend_Tag_ItemList
Returns
TypeDescription
array
methodpublicsetClassList(array $classList = null) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set a list of classes to use instead of fontsizes

Parameters
NameTypeDescription
$classListarray
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
Throws
ExceptionDescription
\Zend_Tag_Cloud_Decorator_ExceptionWhen the classlist is empty
\Zend_Tag_Cloud_Decorator_ExceptionWhen the classlist contains an invalid classname
methodpublicsetEncoding(string $value) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set encoding

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
methodpublicsetFontSizeUnit(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
NameTypeDescription
$fontSizeUnitstring
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
Throws
ExceptionDescription
\Zend_Tag_Cloud_Decorator_ExceptionWhen an invalid fontsize unit is specified
methodpublicsetHtmlTags(array $htmlTags) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set the HTML tags surrounding the element

Parameters
NameTypeDescription
$htmlTagsarray
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
methodpublicsetMaxFontSize(integer $maxFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set maximum font size

Parameters
NameTypeDescription
$maxFontSizeinteger
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
Throws
ExceptionDescription
\Zend_Tag_Cloud_Decorator_ExceptionWhen fontsize is not numeric
methodpublicsetMinFontSize(int $minFontSize) : \Zend_Tag_Cloud_Decorator_HtmlTag

Set minimum font size

Parameters
NameTypeDescription
$minFontSizeint
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlTag
Throws
ExceptionDescription
\Zend_Tag_Cloud_Decorator_ExceptionWhen fontsize is not numeric
methodpublicsetOptions(array $options) : \Zend_Tag_Cloud
inherited

Set options from array

Inherited from: \Zend_Tag_Cloud_Decorator_Tag::setOptions()
Parameters
NameTypeDescription
$optionsarray

Configuration for the decorator

Returns
TypeDescription
\Zend_Tag_Cloud
Documentation was generated by phpDocumentor 2.0.0a12.