fzTagPlugin
1.2.1stable
for sf 1.4sf 1.3 and Doctrine
MIT
fzTagPlugin is backported to symfony dmTagPlugin, that originally was created for Diem 5.x. Now you can easily tag every model in your app.
Developers
License
--------------------------------------------------------------------------------
fzTagPlugin
--------------------------------------------------------------------------------
Copyright (c) 2010 Grzegorz Śliwiński
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
fzTagPlugin
This plugin provides similar functionality to that provided by
dmTagPlugin for
Diem CMF. It's in fact backported dmTagPlugin, with
few tweaks more than just clearing all diem specific code:
- Uses non modified fcbkcomplete library (http://www.emposha.com/javascript/fcbkcomplete.html)
- Uses modified sfWidgetFormDoctrineFBAutocompleter widget from
sfDoctrineFBAutocompletePlugin
version 0.1.3
Installation
To install plugin from symfony plugin repository run:
./symfony plugin:install fzTagPlugin
To install plugin from package, copy it to your project root's directory and run:
./symfony plugin:install fzTagPlugin-1.0.3.tgz
After installing, you have to run:
./symfony doctrine:generate-migrations-diff
./symfony doctrine:migrate
./symfony doctrine:build --all-classes
Now you're ready to configure and use tags for your project
Configuration
Some basic configuration is being done automaticlly:
- Route is being registered when you enable fzTagAutocomplete module for app
- Tag widget is being added, when you add fzTaggable behaviour to your model.
Behaviour
To add taggable behaviour to your model edit your schema.yml file:
/config/doctrine/schema.yml
Model:
actAs:
#Other behaviours
fzTaggable:
#Other behaviours
columns:
#Columns
After adding behaviour run:
./symfony doctrine:generate-migrations-diff
./symfony doctrine:migrate
./symfony doctrine:build --all-classes
Autocomplete widget appearance
If you want to show autocomplete widget to the user, first of all, you have to
enable fzTagAutocomplete module for the app, that the widget has to be included:
all:
.settings:
# Some settings
enabled_modules: [default, fzTagAutocomplete]
Without this, autocomplete widget wouldn't be included into the form of taggable
object. Enabling this module will also append a route that the widget is getting
tags from.
There might be however some cases, where you wouldn't like the autocomplete widget to show
for specified form only, if that's the case, all you need to do, is to unset
tags_list field in your form's configure() method:
public function configure()
{
unset( $this['tags_list'] );
}
Settings
To be able to use FCBKcomplete, you have to include jQuery library. Either locally,
or from Google code.
FCBKcomplete won't be working without it!
Here are settings for fcbkcomplete script that can be set for tagging per app basis:
all:
fzTagPlugin:
fcbkcomplete: # options to pass to the jQuery.fcbkcomplete plugin
# see http://www.emposha.com/javascript/fcbkcomplete.html
newel: true # show typed text like a element
filter_case: false # case sensitive filter
filter_hide: false # show/hide filtered items
maxshownitems: 30 # maximum numbers that will be shown at drop-down list (less better performance)
maxitems: # maximum item that can be added to the list
firstselected: false # automatically select first element from drop-down
Unlike in dmTagPlugin, the complete_text parameter is configured through i18n string.
You can also configure some options on per model basis:
Model:
actAs:
#Other behaviours
fzTaggable:
options:
maxshownitems: 10
maxitems: 15
newel: false
firstselected: false
#Other behaviours
columns:
#Columns
If you won't configure these options per model, it'll default to those defined in app.yml
Modules
fzTagAdmin
There's an admin module, that you can activate in your backend app:
all:
.settings:
# Some settings
enabled_modules: [default, fzTagAdmin]
The route for the fzTagAdmin module is fz_tag and will be added to your app when
the fzTagAdmin module is enabled.
fzTag
plugin also contains front end module to show either tags list or tag's page.
Both actions get routes included as soon as fzTag module is enabled:
all:
.settings:
# Some settings
enabled_modules: [default, fzTag]
Routes names are:
- fz_tag - for tags list
- fz_tag_show - for tag's show page
Tasks
- fzTag:calculate-weight - this task should update each tag's count attribiute - number indicating how many times tag was used. Depends on how many tags and taggable models are in project it may take quite a lot of time and/or memory to do that.
Components
fzTag comes with two components:
- list - is a simple component showing list of tags
tagCloud - is a simple tag cloud component. By default it shows 20 most popular tags ordered by their popularity.
You can overwrite that by passing limit parameter to component:
<?php include_component('fzTag', 'tagCloud', array('limit' => 25 )); ?>
3dTagCloud - components that generates spherical tag cloud using jquery.tagsphere jQuery plugin created by elbeanio. It's functionality extends that of tagCloud component.
Call and options (default values):
<?php include_component('fzTag', '3dTagCloud',
array(
'limit' => 25,
'width' => 100,
'height' => 100,
'min_font_size' => 10,
'max_font_size' => 16,
'zoom' => 100
)); ?>
canvasTagCloud - components generating tag cloud in canvas html5 element using TagCanvas jQuery plugin created by Graham Breach.
it supports all plugin's options as component's options as well as width and height for canvas element:
<?php include_component('fzTag', 'canvasTagCloud',
array(
'limit' => 25,
'height' => 100,
'width' => 100,
'maxSpeed' => 0.05,
'minSpeed' => 0.0,
'decel' => 0.95,
'minBrightness' => 0.1,
'textColour' => "#000000",
'textHeight' => 15,
'textFont' => "Helvetica, Arial, sans-serif",
'outlineColour' => "#000000",
'outlineThickness' => 1,
'outlineOffset' => 5,
'pulsateTo' => 1.0,
'pulsateTime' => 3,
'depth' => 0.5,
'initial' => null,
'freezeActive' => false,
'reverse' => false,
'hideTags' => true,
)); ?>
Libraries
Emposha's FCBKcomplete (2.7.4)
Graham Breach's TagCanvas (1.4.1)
elbeanio's jquery.tagsphere.
Thanks
Great thanks to Thibault Duplesis, who developed the original
dmTagPlugin for
Diem CMF
Support
fzTagPlugin is completely free, but you can support it's creator:
Grzegorz Śliwiński 