File controllers/modules/tags_controller.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

App::import('Model', 'Category');

/**
 * Tags handling
 * 
 * @property-read Category $Category
 * @property RequestHandlerComponent $RequestHandler
 * @property ResponseHandlerComponent $ResponseHandler
 */
class TagsController extends ModulesController {

    var $helpers    = array('BeTree', 'BePaginatorToolbar');
    var $components = array('BeTree', 'BeSecurity');
    var $uses = array('Category') ;
    
    protected $moduleName = 'tags';

    /**
     * Pagination options.
     *
     * @var array
     */
    public $paginate = array(
        'fields' => array(
            'Category.id',
            'Category.name',
            'Category.label',
            'Category.status',
            'count(ObjectCategory.object_id) as weight',
        ),
        'limit' => 20,
        'page' => 1,
        'order' => array('label' => 'asc'),
        'conditions' => array('Category.object_type_id' => null),
        'joins' => array(
            array(
                'table' => 'object_categories',
                'alias' => 'ObjectCategory',
                'type' => 'LEFT',
                'conditions' => 'ObjectCategory.category_id = Category.id',
            ),
        ),
        'group' => array('Category.id', 'Category.name', 'Category.label', 'Category.status'),
        Category::COUNT_DENY_OPTIONS => array('joins', 'group'),
    );

    /**
     * Index tags.
     *
     * @return void
     */
    public function index() {
        $this->setupFilter();

        $this->set('tags', $this->paginate());
    }

    /**
     * Setup filter.
     *
     * @return void
     */
    protected function setupFilter() {
        $query = $this->SessionFilter->read('query');
        if (($this->RequestHandler->isPost() && empty($this->params['form']['filter'])) || ($query && strlen($query) <= 3)) {
            $this->SessionFilter->clean();

            return;
        }
        
        if ($query) {
            $this->paginate['conditions'][] = array(
                'OR' => array(
                    'Category.name LIKE' => '%' . $query . '%',
                    'Category.label LIKE' => '%' . $query . '%',
                ),
            );
        }
    }

    public function view($id = null) {
        $tag = array();
        $referenced = array();
        
        if(isset($id)) {
            $tag = $this->Category->findById($id);
            if($tag == null || $tag === false) {
                throw new BeditaException(__("Error loading tag: ", true).$id);
            }
        
            $referenced = $this->Category->getContentsByTag($tag["name"]);
            $tag["weight"] = count($referenced);
        }
        
        $this->set('tag',   $tag);
        $this->set("referenced", $referenced);      
     }

    public function save() {
        $this->checkWriteModulePermission();
        if(empty($this->data)) 
            throw new BeditaException( __("No data", true));
        $new = (empty($this->data['id'])) ? true : false ;
        $exclude_id = (empty($this->data['id']))? null : $this->data['id'];
        if($this->Category->tagLabelPresent($this->data["label"],$exclude_id)) {
            throw new BeditaException(__("Tag already present", true)." - ".$this->data["label"]);
        }
        
        // format custom properties
        $this->Transaction->begin() ;
        if(!$this->Category->save($this->data)) {
            throw new BeditaException(__("Error saving tag", true), $this->Category->validationErrors);
        }
        $this->Transaction->commit();
        $this->userInfoMessage(__("Tag saved", true)." - ".$this->data["label"]);
        $this->eventInfo("tag [". $this->data["label"]."] saved");
    }

    public function delete() {
        $this->checkWriteModulePermission();
        
        if(empty($this->params["form"]["tags_selected"])) 
            throw new BeditaException( __("No tag selected", true));
            
        $this->Transaction->begin();
        foreach ($this->params["form"]["tags_selected"] as $id) {
            $this->Category->delete($id);
        }
        $this->Transaction->commit();
        
        $tagsListDeleted = implode(",", $this->params["form"]["tags_selected"]);
        
        $this->userInfoMessage(__("Tag deleted", true) . " -  " . $tagsListDeleted);
        $this->eventInfo("Tag $tagsListDeleted deleted");
    }

    public function deleteSelected() {
        $this->checkWriteModulePermission();
        if(empty($this->params["form"]["tags_selected"])) 
            throw new BeditaException( __("No tag selected", true));
        $this->Transaction->begin();
        foreach ($this->params["form"]["tags_selected"] as $id) {
            $this->Category->delete($id);
        }
        $this->Transaction->commit();
        $tagsListDeleted = implode(",", $this->params["form"]["tags_selected"]);
        $this->userInfoMessage(__("Tag deleted", true) . " -  " . $tagsListDeleted);
        $this->eventInfo("Tag $tagsListDeleted deleted");
    }

    /**
     * List all tags.
     *
     * @param bool $href If set href view vars to true
     * @return void
     */
    public function listAllTags($href = false) {
        $this->layout = 'ajax';
        $options = array_intersect_key((array)$this->data, array_flip(array('limit', 'order', 'dir')));
        $options['cloud'] = true;

        $this->set('listTags', $this->Category->getTags($options));
        if ($href) {
            $this->set('href', true);
        }
    }
    
    /**
     * save tags from text area
     *
     */
    public function addMultipleTags() {
        $this->checkWriteModulePermission();
        
        if(empty($this->params["form"]["addtaglist"])) 
            throw new BeditaException( __("No tag in text area", true));
            
        $this->Transaction->begin();
        $tag_ids = $this->Category->saveTagList($this->params["form"]["addtaglist"]);
        $this->Transaction->commit();
        $listTagIds = implode(",", $tag_ids);
        $this->userInfoMessage(__("Tags saved", true)." - " . $listTagIds);
        $this->eventInfo("tags [". $listTagIds ."] saved");
        
    }
    
    public function changeStatus() {
        $this->checkWriteModulePermission();
        
        if(empty($this->params["form"]["tags_selected"])) 
            throw new BeditaException( __("No tag selected", true));
            
        $this->Transaction->begin();
        foreach ($this->params["form"]["tags_selected"] as $id) {
            $this->Category->id = $id;
            $this->Category->saveField("status", $this->params["form"]["newStatus"]); 
        }
        $this->Transaction->commit();
    }

    /**
     * Search tag by label or id.
     *
     * @return void
     */
    public function search() {
        if (!$this->RequestHandler->isAjax()) {
            throw new BeditaBadRequestException();
        }

        $this->ResponseHandler->setType('json');
        unset($this->paginate['fields'], $this->paginate['joins'], $this->paginate['group']);
        if (!empty($this->params['url']['q'])) {
            $this->paginate['conditions']['Category.label LIKE'] = sprintf('%s%%', $this->params['url']['q']);
        }
        if (!empty($this->params['url']['id'])) {
            $this->paginate['conditions']['Category.id'] = $this->params['url']['id'];
        }
        $tags = $this->paginate();

        $this->set(array(
            'tags' => $tags,
            'query' => isset($this->params['url']['q']) ? $this->params['url']['q'] : null,
            'paging' => $this->params['paging']['Category'],
            '_serialize' => array('tags', 'query', 'paging'),
        ));
    }

    protected function forward($action, $result) {
        $moduleRedirect = array(
            'addMultipleTags' => array(
                'OK' => $this->referer(),
                'ERROR' => $this->referer(),
            ),
            'changeStatus' =>  array(
                'OK' => $this->referer(),
                'ERROR' => $this->referer(),
            ),
        );
        return $this->moduleForward($action, $result, $moduleRedirect);
    }
}

Classes

Interfaces

Exceptions