Alpha Framework alpha--view--widgets
[ class tree: alpha--view--widgets ] [ index: alpha--view--widgets ] [ all elements ]

Class: TagCloud

Source Location: /view/widgets/TagCloud.inc

Class TagCloud

Class Overview

A widget for rendering a tag cloud, based off the TagObject instances in the database.

Located in /view/widgets/TagCloud.inc [line 53]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: TagCloud.inc 1468 2011-12-13 19:52:58Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
TagCloud   __construct()   Constructor
string   render()   Render the tag cloud and return all of the HTML links in a single paragraph.

[ Top ]
Methods
Constructor __construct  [line 78]

  TagCloud __construct( $limit $limit, [$cacheKey $cacheKey = '']  )

Constructor

Parameters:
$limit   $limit:  The maximum amount of tags to include in the cloud.
$cacheKey   $cacheKey:  Set this optional value to attempt to store the tag cloud array in the available cache for 24hrs (sysCacheProviderName).

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
render  [line 112]

  string render( [$minLinkSize $minLinkSize = 8], [$maxLinkSize $maxLinkSize = 20], [$target $target = '']  )

Render the tag cloud and return all of the HTML links in a single paragraph.

Parameters:
$minLinkSize   $minLinkSize:  The minimum font size for any tag link, in points.
$maxLinkSize   $maxLinkSize:  The maximum font size for any tag link, in points.
$target   $target:  The target attribute for the links

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:35 +0000 by phpDocumentor 1.4.3