Tag/Cloud.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Tag
- Subpackage
- Cloud
- Version
- $Id$
\Zend_Tag_Cloud
Package: Zend_Tag
Returns
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Tag_Cloud_Decorator_Cloud $_cloudDecorator = nullDecorator for the cloud
Default value
nullDetails\Zend_Loader_PluginLoader $_pluginLoader = nullPlugin loader for decorators
Default value
nullDetailsarray $_skipOptions = array('options', 'config')Option keys to skip when calling setOptions()
Default value
array('options', 'config')Details- Type
- array
\Zend_Tag_Cloud_Decorator_Tag $_tagDecorator = nullDecorator for the tags
Default value
nullDetailsMethods
__construct(mixed $options = null) : voidCreate a new tag cloud with options
Parameters
| Name | Type | Description |
|---|---|---|
| $options | mixed |
__toString() : stringRender the tag cloud
Returns
| Type | Description |
|---|---|
| string |
addPrefixPath(string $prefix, string $path) : \Zend_Tag_CloudAdd prefix path for plugin loader
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $prefix | string | |
| $path | string |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
addPrefixPaths(array $paths) : \Zend_Tag_CloudAdd many prefix paths at once
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $paths | array |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
appendTag(\Zend_Tag_Taggable | array $tag) : \Zend_Tag_CloudAppend a single tag to the cloud
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $tag | \Zend_Tag_Taggable | array |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
getCloudDecorator() : \Zend_Tag_Cloud_Decorator_CloudGet the decorator for the cloud
Returns
| Type | Description |
|---|---|
| \Zend_Tag_Cloud_Decorator_Cloud |
getItemList() : \Zend_Tag_ItemListRetrieve the item list
If item list is undefined, creates one.
Returns| Type | Description |
|---|---|
| \Zend_Tag_ItemList |
getPluginLoader() : \Zend_Loader_PluginLoaderGet the plugin loader for decorators
Returns
| Type | Description |
|---|---|
| \Zend_Loader_PluginLoader |
getTagDecorator() : \Zend_Tag_Cloud_Decorator_TagGet the decorator for the tags
Returns
| Type | Description |
|---|---|
| \Zend_Tag_Cloud_Decorator_Tag |
render() : stringRender the tag cloud
Returns
| Type | Description |
|---|---|
| string |
setCloudDecorator(mixed $decorator) : \Zend_Tag_CloudSet the decorator for the cloud
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $decorator | mixed |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setConfig(\Zend_Config $config) : \Zend_Tag_CloudSet options from Zend_Config
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setItemList(\Zend_Tag_ItemList $itemList) : \Zend_Tag_CloudSet the item list
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $itemList | \Zend_Tag_ItemList |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setOptions(array $options) : \Zend_Tag_CloudSet options from array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array | Configuration for Zend_Tag_Cloud |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) : \Zend_Tag_CloudSet plugin loaders for use with decorators
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $loader | \Zend_Loader_PluginLoader_Interface |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setTagDecorator(mixed $decorator) : \Zend_Tag_CloudSet the decorator for the tags
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $decorator | mixed |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |
setTags(array $tags) : \Zend_Tag_CloudSet the tags for the 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| Name | Type | Description |
|---|---|---|
| $tags | array |
| Type | Description |
|---|---|
| \Zend_Tag_Cloud |