lotsofcode / tag-cloud
PHP tag cloud class http://lotsofcode.github.com/tag-cloud
Installs: 3 793
Dependents: 0
Suggesters: 0
Security: 0
Stars: 56
Watchers: 8
Forks: 20
Open Issues: 1
Requires (Dev)
- phpunit/phpunit: 3.7.*
This package is not auto-updated.
Last update: 2024-11-18 15:54:58 UTC
README
v4.0.1
Install with composer
composer require lotsofcode/tag-cloud
Basic usage
$cloud = new TagCloud(); $cloud->addTag("tag-cloud"); $cloud->addTag("programming"); echo $cloud->render();
Convert a string
$cloud->addString("This is a tag-cloud script, written by Del Harvey. I wrote this tag-cloud class because I just love writing code.");
Adding multiple tags
$cloud->addTags(array('tag-cloud','php','github'));
Removing a tag
$cloud->setRemoveTag('github');
Removing multiple tags
$cloud->setRemoveTags(array('del','harvey'));
More complex adding
$cloud->addTag(array('tag' => 'php', 'url' => 'http://www.php.net', 'colour' => 1)); $cloud->addTag(array('tag' => 'ajax', 'url' => 'http://www.php.net', 'colour' => 2)); $cloud->addTag(array('tag' => 'css', 'url' => 'http://www.php.net', 'colour' => 3));
Set the minimum length required
$cloud->setMinLength(3);
Limiting the output
$cloud->setLimit(10);
Set the order
$cloud->setOrder('colour','DESC');
Set a custom HTML output
$cloud->setHtmlizeTagFunction(function($tag, $size) use ($baseUrl) { $link = '<a href="'.$baseUrl.'/'.$tag['url'].'">'.$tag['tag'].'</a>'; return "<span class='tag size{$size} colour-{$tag['colour']}'>{$link}</span> "; });
Outputting the cloud (shown above)
echo $cloud->render();
Transliteration
By default, all accented characters will be converted into their non-accented equivalent, this is to circumvent duplicate similar tags in the same cloud, to disable this functionality and display the UTF-8 characters you can do the following:
$tagCloud->setOption('transliterate', false);
More usages on in a prettier format can be found here: http://lotsofcode.github.com/tag-cloud
Tests
To run the unit test suite, first install the dependencies:
curl -s https://getcomposer.org/installer | php
php composer.phar install
Then execute phpunit in the root directory
./vendor/bin/phpunit
Submitting pull requests
Indentation style, size and encoding should be followed as per .editorconfig settings.