API Documentation

Tag/Cloud/Decorator/HtmlTag.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tag
subpackage
Cloud
version
$Id: HtmlTag.php 20104 2010-01-06 21:26:01Z matthew $
Classes
Zend_Tag_Cloud_Decorator_HtmlTag

Description

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.

Zend_Tag_Cloud_Decorator_HtmlTag
jump to top

Extends from
Zend_Tag_Cloud_Decorator_Tag
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tag
uses
Zend_Tag_Cloud_Decorator_Tag
Properties
$_classList
$_encoding
$_fontSizeUnit
$_alloweFontSizeUnits
$_htmlTags
$_maxFontSize
$_minFontSize
Methods
setClassList
getClassList
getEncoding
setEncoding
setFontSizeUnit
getFontSizeUnit
setHtmlTags
getHtmlTags
setMaxFontSize
getMaxFontSize
setMinFontSize
getMinFontSize
render

Description

Simple HTML decorator for tags

Properties

$_alloweFontSizeUnits
jump to class

array $_alloweFontSizeUnits = 'array'

Allowed fontsize units

Details

$_alloweFontSizeUnits
array
visibility
protected
default
array
final
false
static
false

$_classList
jump to class

array $_classList = 'null'

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

Details

$_classList
array
visibility
protected
default
null
final
false
static
false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Details

$_encoding
string
Encoding to utilize
visibility
protected
default
UTF-8
final
false
static
false

$_fontSizeUnit
jump to class

string $_fontSizeUnit = 'px'

Unit for the fontsize

Details

$_fontSizeUnit
string
visibility
protected
default
px
final
false
static
false

$_htmlTags
jump to class

array $_htmlTags = 'array'

List of HTML tags

Details

$_htmlTags
array
visibility
protected
default
array
final
false
static
false

$_maxFontSize
jump to class

integer $_maxFontSize = '20'

Maximum fontsize

Details

$_maxFontSize
integer
visibility
protected
default
20
final
false
static
false

$_minFontSize
jump to class

integer $_minFontSize = '10'

Minimum fontsize

Details

$_minFontSize
integer
visibility
protected
default
10
final
false
static
false

Methods

getClassList
jump to class

getClassList( ) : array

Get class list

Output
array
Details
visibility
public
final
false
static
false

getEncoding
jump to class

getEncoding( ) : string

Get encoding

Output
string
Details
visibility
public
final
false
static
false

getFontSizeUnit
jump to class

getFontSizeUnit( ) : string

Retrieve font size unit

Output
string
Details
visibility
public
final
false
static
false

getHtmlTags
jump to class

getHtmlTags( ) : array

Get HTML tags map

Output
array
Details
visibility
public
final
false
static
false

getMaxFontSize
jump to class

getMaxFontSize( ) : int

Retrieve maximum font size

Output
int
Details
visibility
public
final
false
static
false

getMinFontSize
jump to class

getMinFontSize( ) : int

Retrieve minimum font size

Output
int
Details
visibility
public
final
false
static
false

render
jump to class

render( Zend_Tag_ItemList $tags ) : array

Defined by Zend_Tag_Cloud_Decorator_Tag

Arguments
$tags
Zend_Tag_ItemList
Output
array
Details
visibility
public
final
false
static
false

setClassList
jump to class

setClassList( array $classList = null ) : Zend_Tag_Cloud_Decorator_HtmlTag

Set a list of classes to use instead of fontsizes

Arguments
$classList
array
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false
throws
When the classlist is empty
throws
When the classlist contains an invalid classname

setEncoding
jump to class

setEncoding( string $value ) : Zend_Tag_Cloud_Decorator_HtmlTag

Set encoding

Arguments
$value
string
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false

setFontSizeUnit
jump to class

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 %

Arguments
$fontSizeUnit
string
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false
throws
When an invalid fontsize unit is specified

setHtmlTags
jump to class

setHtmlTags( array $htmlTags ) : Zend_Tag_Cloud_Decorator_HtmlTag

Set the HTML tags surrounding the <a> element

Arguments
$htmlTags
array
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false

setMaxFontSize
jump to class

setMaxFontSize( integer $maxFontSize ) : Zend_Tag_Cloud_Decorator_HtmlTag

Set maximum font size

Arguments
$maxFontSize
integer
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false
throws
When fontsize is not numeric

setMinFontSize
jump to class

setMinFontSize( int $minFontSize ) : Zend_Tag_Cloud_Decorator_HtmlTag

Set minimum font size

Arguments
$minFontSize
int
Output
Zend_Tag_Cloud_Decorator_HtmlTag
Details
visibility
public
final
false
static
false
throws
When fontsize is not numeric
Documentation was generated by DocBlox.