API Documentation

Tag/Cloud/Decorator/HtmlCloud.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tag  
subpackage
Cloud  
version
$Id: HtmlCloud.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Tag_Cloud_Decorator_HtmlCloud

Simple HTML decorator for clouds

Extends from
\Zend_Tag_Cloud_Decorator_Cloud
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tag  
uses
\Zend_Tag_Cloud_Decorator_Cloud  

Properties

Propertyprotectedstring  $_encoding= 'UTF-8'

Encoding to use
Default valueUTF-8Details
Type
string
Propertyprotectedarray  $_htmlTags= 'array'

List of HTML tags

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_separator= ' '

Separator for the single tags

Default value Details
Type
string

Methods

methodpublic__construct( mixed $options = null ) : void

Create a new cloud decorator with options

Inherited from: \Zend_Tag_Cloud_Decorator_Cloud::__construct()
Parameters
Name Type Description
$options mixed
methodpublicgetEncoding( ) : string

Get encoding

Returns
Type Description
string
methodpublicgetHtmlTags( ) : array

Retrieve HTML tag map

Returns
Type Description
array
methodpublicgetSeparator( ) : string

Get tag separator

Returns
Type Description
string
methodpublicrender( array $tags ) : string

Defined by Zend_Tag_Cloud_Decorator_Cloud

Parameters
Name Type Description
$tags array
Returns
Type Description
string
methodpublicsetEncoding(  $value ) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set encoding

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Tag_Cloud_Decorator_HtmlCloud
methodpublicsetHtmlTags( array $htmlTags ) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set the HTML tags surrounding all tags

Parameters
Name Type Description
$htmlTags array
Returns
Type Description
\Zend_Tag_Cloud_Decorator_HtmlCloud
methodpublicsetOptions( array $options ) : \Zend_Tag_Cloud

Set options from array

Inherited from: \Zend_Tag_Cloud_Decorator_Cloud::setOptions()
Parameters
Name Type Description
$options array Configuration for the decorator
Returns
Type Description
\Zend_Tag_Cloud
methodpublicsetSeparator(  $separator ) : \Zend_Tag_Cloud_Decorator_HtmlCloud

Set the separator between the single tags

Parameters
Name Type Description
$separator string
Returns
Type Description
\Zend_Tag_Cloud_Decorator_HtmlCloud
Documentation was generated by DocBlox 0.13.3.