Alpha Framework 3.1.0 API Documentation

TagCloud

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

Tags
since
1.0
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2019, 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.

Table of Contents

$logger  : Logger
Trace logger.
$popTags  : array<string|int, mixed>
A hash array of popular tags.
__construct()  : mixed
Constructor.
getPopTags()  : array<string|int, mixed>
Get the array of popular tags.
render()  : string
Render the tag cloud and return all of the HTML links in a single paragraph.

Properties

$logger

Trace logger.

private static Logger $logger = null
Tags
since
1.0

$popTags

A hash array of popular tags.

private array<string|int, mixed> $popTags = array()
Tags
since
1.0

Methods

__construct()

Constructor.

public __construct( $limit[,  $cacheKey = '' ]) : mixed
Parameters
$limit :

The maximum amount of tags to include in the cloud.

$cacheKey : = ''

Set this optional value to attempt to store the tag cloud array in the available cache for 24hrs (cache.provider.name).

Tags
since
1.0
Return values
mixed —

getPopTags()

Get the array of popular tags.

public getPopTags() : array<string|int, mixed>
Tags
since
2.0.1
Return values
array<string|int, mixed> —

render()

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

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

The minimum font size for any tag link, in points.

$maxLinkSize : = 20

The maximum font size for any tag link, in points.

$target : = ''

The target attribute for the links

Tags
since
1.0
Return values
string —

Search results