Zend_Tag_Cloud

Zend_Tag_Cloud is the rendering part of Zend_Tag. By default it comes with a set of HTML decorators, which allow you to create tag clouds for a website, but also supplies you with two abstract classes to create your own decorators, to create tag clouds in PDF documents for example.

You can instantiate and configure Zend_Tag_Cloud either programatically or completely via an array or an instance of Zend_Config. The available options are:

  • cloudDecorator: defines the decorator for the cloud. Can either be the name of the class which should be loaded by the pluginloader, an instance of Zend_Tag_Cloud_Decorator_Cloud or an array containing the string decorator and optionally an array options, which will be passed to the decorators constructor.

  • tagDecorator: defines the decorator for individual tags. This can either be the name of the class which should be loaded by the pluginloader, an instance of Zend_Tag_Cloud_Decorator_Tag or an array containing the string decorator and optionally an array options, which will be passed to the decorators constructor.

  • pluginLoader: a different plugin loader to use. Must be an instance of Zend_Loader_PluginLoader_Interface.

  • prefixPath: prefix paths to add to the plugin loader. Must be an array containing the keys prefix and path or multiple arrays containing the keys prefix and path. Invalid elements will be skipped.

  • itemList: a different item list to use. Must be an instance of Zend_Tag_ItemList.

  • tags: a list of tags to assign to the cloud. Each tag must either implement Zend_Tag_Taggable or be an array which can be used to instantiate Zend_Tag_Item.

Example #1 Using Zend_Tag_Cloud

This example illustrates a basic example of how to create a tag cloud, add multiple tags to it and finally render it.

  1. // Create the cloud and assign static tags to it
  2. $cloud = new Zend_Tag_Cloud(array(
  3.     'tags' => array(
  4.         array('title' => 'Code', 'weight' => 50,
  5.               'params' => array('url' => '/tag/code')),
  6.         array('title' => 'Zend Framework', 'weight' => 1,
  7.               'params' => array('url' => '/tag/zend-framework')),
  8.         array('title' => 'PHP', 'weight' => 5,
  9.               'params' => array('url' => '/tag/php')),
  10.     )
  11. ));
  12.  
  13. // Render the cloud
  14. echo $cloud;

This will output the tag cloud with the three tags, spread with the default font-sizes.

Decorators

Zend_Tag_Cloud requires two types of decorators to be able to render a tag cloud. This includes a decorator which renders the single tags as well as a decorator which renders the surounding cloud. Zend_Tag_Cloud ships a default decorator set for formatting a tag cloud in HTML. This set will by default create a tag cloud as ul/li-list, spread with different font-sizes according to the weight values of the tags assigned to them.

HTML Tag decorator

The HTML tag decorator will by default render every tag in an anchor element, surounded by a li element. The anchor itself is fixed and cannot be changed, but the surounding element(s) can.

Note: URL parameter
As the HTML tag decorator always surounds the tag title with an anchor, you should define an URL parameter for every tag used in it.

The tag decorator can either spread different font-sizes over the anchors or a defined list of classnames. When setting options for one of those possibilities, the corespondening one will automatically be enabled. The following configuration options are available:

  • fontSizeUnit: defines the font-size unit used for all font-sizes. The possible values are: em, ex, px, in, cm, mm, pt, pc and %.

  • minFontSize: the minimum font-size distributed through the tags (must be an integer).

  • maxFontSize: the maximum font-size distributed through the tags (must be an integer).

  • classList: an arry of classes distributed through the tags.

  • htmlTags: an array of HTML tags surounding the anchor. Each element can either be a string, which is used as element type then, or an array containing an attribute list for the element, defined as key/value pair. In this case, the array key is used as element type.

HTML Cloud decorator

The HTML cloud decorator will suround the HTML tags with an ul-element by default and add no separation. Like in the tag decorator, you can define multiple surounding HTML tags and additionally define a separator. The available options are:

  • separator: defines the separator which is placed between all tags.

  • htmlTags: an array of HTML tags surounding all tags. Each element can either be a string, which is used as element type then, or an array containing an attribute list for the element, defined as key/value pair. In this case, the array key is used as element type.

blog comments powered by Disqus