TbTags.php

Go to the documentation of this file.

<?php
class TbTags extends CInputWidget {
        
        public $form;

        public $suggestions = array();

        public $events = array(
                // whenAddingTag (tag:string) : anything external you'd like to do with the tag
                'whenAddingTag' => null,
                // tagRemoved (tag:string) : find out which tag was removed by either presseing delete key or clicking the (x)
                'tagRemoved' => null,
                // definePopover (tag:string) : must return the popover content for the tag that is being added. (eg "Content for [tag]")
                'definePopover' => null,
                // excludes (tag:string) : returns true if you want the tag to be excluded, false if allowed
                'exclude' => null,
                // pressedReturn (e:triggering event)
                'pressedReturn' => null,
                // pressedDelete (e:triggering event)
                'pressedDelete' => null,
                // pressedDown (e:triggering event)
                'pressedDown' => null,
                // pressedUp (e:triggering event)
                'pressedUp' => null,
        );

        public $restrictTo;

        public $tagData = array();

        public $popoverData;

        public $exclude = array();

        public $displayPopovers;

        public $tagClass = 'btn-success';

        public $promptText = 'Please, type in your tags...';

        protected $options = array();

        public function init() {
                
                parent::init();
                
                $this->options = CMap::mergeArray(
                        array(
                                'suggestions' => $this->suggestions,
                                'restrictTo' => $this->restrictTo,
                                'exclude' => $this->exclude,
                                'displayPopovers' => $this->displayPopovers,
                                'tagClass' => $this->tagClass,
                                'tagData' => $this->tagData,
                                'popoverData' => $this->popoverData
                        ),
                        $this->options
                );
        }

        public function run() {
                
                list($name, $id) = $this->resolveNameID();

                $this->renderContent($id, $name);
                $this->registerClientScript($id);
        }

        public function renderContent($id, $name) {

                if ($this->hasModel()) {
                        if ($this->form) {
                                echo $this->form->hiddenField($this->model, $this->attribute);
                        } else {
                                echo CHtml::activeHiddenField($this->model, $this->attribute);
                        }

                } else {
                        echo CHtml::hiddenField($name, $this->value);
                }

                $this->htmlOptions['id'] = 'tags_'.$id;
                if(isset($this->htmlOptions['class']) && !empty($this->htmlOptions['class']))
                        $this->htmlOptions['class'] .= ' tag-list';
                else
                        $this->htmlOptions['class'] = 'tag-list';
                
                echo CHtml::openTag('div', $this->htmlOptions);
                echo "<div class='tags'></div>";
                echo CHtml::closeTag('div');
        }

        public function registerClientScript($id) {
                
        $booster = Booster::getBooster();
        $booster->registerPackage('bootstrap-tags');

                $options = !empty($this->options) ? CJavaScript::encode($this->options) : '';

                Yii::app()->getClientScript()->registerScript(
                        __CLASS__ . '#' . $this->getId(),
                        "jQuery('#tags_{$id}').tags({$options});"
                );
        }
}