Zend Framework
Back to top  

package Default

 Methods

Create a new tag cloud with options

__construct(array|\Traversable $options = null) 

Parameters

$options

array\Traversable

Render the tag cloud

__toString() : string

Returns

string

Append a single tag to the cloud

appendTag(\Zend\Tag\TaggableInterface|array $tag) : \Zend\Tag\Cloud

Parameters

$tag

\Zend\Tag\TaggableInterfacearray

Exceptions

\Zend\Tag\Exception\InvalidArgumentException

Returns

\Zend\Tag\Cloud

Get the decorator for the cloud

getCloudDecorator() : \Zend\Tag\Cloud\Decorator\AbstractCloud

Returns

\Zend\Tag\Cloud\Decorator\AbstractCloud

Get the plugin manager for decorators

getDecoratorPluginManager() : \Zend\Tag\Cloud\DecoratorPluginManager

Returns

\Zend\Tag\Cloud\DecoratorPluginManager

Retrieve the item list

getItemList() : \Zend\Tag\ItemList

If item list is undefined, creates one.

Returns

\Zend\Tag\ItemList

Get the decorator for the tags

getTagDecorator() : \Zend\Tag\Cloud\Decorator\AbstractTag

Returns

\Zend\Tag\Cloud\Decorator\AbstractTag

Render the tag cloud

render() : string

Returns

string

Set the decorator for the cloud

setCloudDecorator(mixed $decorator) : \Zend\Tag\Cloud

Parameters

$decorator

mixed

Exceptions

\Zend\Tag\Exception\InvalidArgumentException

Returns

\Zend\Tag\Cloud

Set plugin manager for use with decorators

setDecoratorPluginManager(\Zend\Tag\Cloud\DecoratorPluginManager $decorators) : \Zend\Tag\Cloud

Parameters

$decorators

\Zend\Tag\Cloud\DecoratorPluginManager

Returns

\Zend\Tag\Cloud

Set the item list

setItemList(\Zend\Tag\ItemList $itemList) : \Zend\Tag\Cloud

Parameters

$itemList

\Zend\Tag\ItemList

Returns

\Zend\Tag\Cloud

Set options from array

setOptions(array $options) : \Zend\Tag\Cloud

Parameters

$options

array

Configuration for Cloud

Returns

\Zend\Tag\Cloud

Set the decorator for the tags

setTagDecorator(mixed $decorator) : \Zend\Tag\Cloud

Parameters

$decorator

mixed

Exceptions

\Zend\Tag\Exception\InvalidArgumentException

Returns

\Zend\Tag\Cloud

Set the tags for the tag cloud.

setTags(array $tags) : \Zend\Tag\Cloud

$tags should be an array containing single tags as array. Each tag array should at least contain the keys 'title' and 'weight'. Optionally you may supply the key 'url', to which the tag links to. Any additional parameter in the array is silently ignored and can be used by custom decorators.

Parameters

$tags

array

Exceptions

\Zend\Tag\Exception\InvalidArgumentException

Returns

\Zend\Tag\Cloud

 Properties

 

DecoratorInterface for the cloud

$cloudDecorator : \Zend\Tag\Cloud\Decorator\AbstractCloud

Default

null
 

Plugin manager for decorators

$decorators : \Zend\Tag\Cloud\DecoratorPluginManager

Default

null
 

Option keys to skip when calling setOptions()

$skipOptions : array

Default

array('options', 'config')
 

DecoratorInterface for the tags

$tagDecorator : \Zend\Tag\Cloud\Decorator\AbstractTag

Default

null
 

List of all tags

$tags : \Zend\Tag\ItemList

Default

null