Tag/Cloud/Decorator/HtmlCloud.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: HtmlCloud.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Tag_Cloud_Decorator_HtmlCloud

Package: Zend\Tag
Simple HTML decorator for clouds
Parent(s)
\Zend_Tag_Cloud_Decorator_Cloud
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_Cloud  

Properties

>VPropertyprotectedstring $_encoding = 'UTF-8'

Encoding to use

Default value'UTF-8'Details
Type
string
>VPropertyprotectedarray $_htmlTags = array('ul' => array('class' => 'Zend_Tag_Cloud'))
List of HTML tags
Default valuearray('ul' => array('class' => 'Zend_Tag_Cloud'))Details
Type
array
>VPropertyprotectedstring $_separator = ' '
Separator for the single tags
Default value' 'Details
Type
string
>VPropertyprotectedarray $_skipOptions = array('options', 'config')
inherited
Option keys to skip when calling setOptions()
Inherited from: \Zend_Tag_Cloud_Decorator_Cloud::$$_skipOptions
Default valuearray('options', 'config')Details
Type
array
Inherited_from
\Zend_Tag_Cloud_Decorator_Cloud::$$_skipOptions  

Methods

methodpublic__construct(mixed $options = null) : void
inherited

Create a new cloud decorator with options

Inherited from: \Zend_Tag_Cloud_Decorator_Cloud::__construct()
Parameters
NameTypeDescription
$optionsmixed
methodpublicgetEncoding() : string

Get encoding

Returns
TypeDescription
string
methodpublicgetHtmlTags() : array

Retrieve HTML tag map

Returns
TypeDescription
array
methodpublicgetSeparator() : string

Get tag separator

Returns
TypeDescription
string
methodpublicrender(array $tags) : string

Defined by Zend_Tag_Cloud_Decorator_Cloud

Parameters
NameTypeDescription
$tagsarray
Returns
TypeDescription
string
methodpublicsetEncoding(string $value) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set encoding

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlCloud
methodpublicsetHtmlTags(array $htmlTags) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set the HTML tags surrounding all tags

Parameters
NameTypeDescription
$htmlTagsarray
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlCloud
methodpublicsetOptions(array $options) : \Zend_Tag_Cloud
inherited

Set options from array

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

Configuration for the decorator

Returns
TypeDescription
\Zend_Tag_Cloud
methodpublicsetSeparator(string $separator) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set the separator between the single tags

Parameters
NameTypeDescription
$separatorstring
Returns
TypeDescription
\Zend_Tag_Cloud_Decorator_HtmlCloud
Documentation was generated by phpDocumentor 2.0.0a12.