API Documentation

Tag/Cloud.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: Cloud.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tag_Cloud

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

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
Properties
$_cloudDecorator
$_tagDecorator
$_tags
$_pluginLoader
$_skipOptions
Methods
__construct
setConfig
setOptions
setTags
appendTag
setItemList
getItemList
setCloudDecorator
getCloudDecorator
setTagDecorator
getTagDecorator
setPluginLoader
getPluginLoader
addPrefixPaths
addPrefixPath
render
__toString

Description

Properties

$_cloudDecorator

Zend_Tag_Cloud_Decorator_Cloud $_cloudDecorator = 'null'

Decorator for the cloud

Details

$_cloudDecorator
Zend_Tag_Cloud_Decorator_Cloud
visibility
protected
default
null
final
false
static
false

$_pluginLoader

Zend_Loader_PluginLoader $_pluginLoader = 'null'

Plugin loader for decorators

Details

$_pluginLoader
Zend_Loader_PluginLoader
visibility
protected
default
null
final
false
static
false

$_skipOptions

array $_skipOptions = 'array'

Option keys to skip when calling setOptions()

Details

$_skipOptions
array
visibility
protected
default
array
final
false
static
false

$_tagDecorator

Zend_Tag_Cloud_Decorator_Tag $_tagDecorator = 'null'

Decorator for the tags

Details

$_tagDecorator
Zend_Tag_Cloud_Decorator_Tag
visibility
protected
default
null
final
false
static
false

$_tags

Zend_Tag_ItemList $_tags = 'null'

List of all tags

Details

$_tags
Zend_Tag_ItemList
visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( mixed $options = null ) :

Create a new tag cloud with options

Arguments
$options
mixed
Details
visibility
public
final
false
static
false

__toString

__toString( ) : string

Render the tag cloud

Output
string
Details
visibility
public
final
false
static
false

addPrefixPath

addPrefixPath( string $prefix, string $path ) : Zend_Tag_Cloud

Add prefix path for plugin loader

Arguments
$prefix
string
$path
string
Details
visibility
public
final
false
static
false

addPrefixPaths

addPrefixPaths( array $paths ) : Zend_Tag_Cloud

Add many prefix paths at once

Arguments
$paths
array
Details
visibility
public
final
false
static
false

appendTag

appendTag( Zend_Tag_Taggable|array $tag ) : Zend_Tag_Cloud

Append a single tag to the cloud

Arguments
$tag
Zend_Tag_Taggablearray
Details
visibility
public
final
false
static
false

getCloudDecorator

getCloudDecorator( ) : Zend_Tag_Cloud_Decorator_Cloud

Get the decorator for the cloud

Details
visibility
public
final
false
static
false

getItemList

getItemList( ) : Zend_Tag_ItemList

Retrieve the item list

If item list is undefined, creates one.

Details
visibility
public
final
false
static
false

getPluginLoader

getPluginLoader( ) : Zend_Loader_PluginLoader

Get the plugin loader for decorators

Details
visibility
public
final
false
static
false

getTagDecorator

getTagDecorator( ) : Zend_Tag_Cloud_Decorator_Tag

Get the decorator for the tags

Details
visibility
public
final
false
static
false

render

render( ) : string

Render the tag cloud

Output
string
Details
visibility
public
final
false
static
false

setCloudDecorator

setCloudDecorator( mixed $decorator ) : Zend_Tag_Cloud

Set the decorator for the cloud

Arguments
$decorator
mixed
Details
visibility
public
final
false
static
false

setConfig

setConfig( Zend_Config $config ) : Zend_Tag_Cloud

Set options from Zend_Config

Arguments
$config
Zend_Config
Details
visibility
public
final
false
static
false

setItemList

setItemList( Zend_Tag_ItemList $itemList ) : Zend_Tag_Cloud

Set the item list

Arguments
$itemList
Zend_Tag_ItemList
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Tag_Cloud

Set options from array

Arguments
$options
array
Configuration for Zend_Tag_Cloud
Details
visibility
public
final
false
static
false

setPluginLoader

setPluginLoader( Zend_Loader_PluginLoader_Interface $loader ) : Zend_Tag_Cloud

Set plugin loaders for use with decorators

Arguments
$loader
Zend_Loader_PluginLoader_Interface
Details
visibility
public
final
false
static
false

setTagDecorator

setTagDecorator( mixed $decorator ) : Zend_Tag_Cloud

Set the decorator for the tags

Arguments
$decorator
mixed
Details
visibility
public
final
false
static
false

setTags

setTags( array $tags ) : Zend_Tag_Cloud

Set 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.

Arguments
$tags
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.