CRM/Admin/Form/Tag.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Tag
  38  *
  39  */
  40 class CRM_Admin_Form_Tag extends CRM_Admin_Form {
  41   protected $_isTagSet;
  42
  43   /**
  44    * Explicitly declare the entity api name.
  45    */
  46   public function getDefaultEntity() {
  47     return 'Tag';
  48   }
  49
  50   /**
  51    * Build the form object.
  52    *
  53    * @return void
  54    */
  55   public function buildQuickForm() {
  56     $this->setPageTitle($this->_isTagSet ? ts('Tag Set') : ts('Tag'));
  57
  58     if ($this->_action == CRM_Core_Action::DELETE) {
  59       if ($this->_id && $tag = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Tag', $this->_id, 'name', 'parent_id')) {
  60         $url = CRM_Utils_System::url('civicrm/admin/tag', "reset=1");
  61         CRM_Core_Error::statusBounce(ts("This tag cannot be deleted. You must delete all its child tags ('%1', etc) prior to deleting this tag.", array(1 => $tag)), $url);
  62       }
  63       if ($this->_values['is_reserved'] == 1 && !CRM_Core_Permission::check('administer reserved tags')) {
  64         CRM_Core_Error::statusBounce(ts("You do not have sufficient permission to delete this reserved tag."));
  65       }
  66     }
  67     else {
  68       $this->_isTagSet = CRM_Utils_Request::retrieve('tagset', 'Positive', $this);
  69
  70       if (!$this->_isTagSet &&
  71         $this->_id &&
  72         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Tag', $this->_id, 'is_tagset')
  73       ) {
  74         $this->_isTagSet = TRUE;
  75       }
  76
  77       $allTag = array('' => ts('- select -')) + CRM_Core_BAO_Tag::getTagsNotInTagset();
  78
  79       if ($this->_id) {
  80         unset($allTag[$this->_id]);
  81       }
  82
  83       if (!$this->_isTagSet) {
  84         $this->add('select', 'parent_id', ts('Parent Tag'), $allTag, FALSE, array('class' => 'crm-select2'));
  85
  86         // Tagsets are not selectable by definition so only include the selectable field if NOT a tagset.
  87         $selectable = $this->add('checkbox', 'is_selectable', ts('Selectable?'));
  88         // Selectable should be checked by default when creating a new tag
  89         if ($this->_action == CRM_Core_Action::ADD) {
  90           $selectable->setValue(1);
  91         }
  92
  93       }
  94
  95       $this->assign('isTagSet', $this->_isTagSet);
  96
  97       $this->applyFilter('__ALL__', 'trim');
  98
  99       $this->add('text', 'name', ts('Name'),
 100         CRM_Core_DAO::getAttribute('CRM_Core_DAO_Tag', 'name'), TRUE
 101       );
 102       $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array(
 103           'CRM_Core_DAO_Tag',
 104           $this->_id,
 105         ));
 106
 107       $this->add('text', 'description', ts('Description'),
 108         CRM_Core_DAO::getAttribute('CRM_Core_DAO_Tag', 'description')
 109       );
 110
 111       $isReserved = $this->add('checkbox', 'is_reserved', ts('Reserved?'));
 112
 113       $usedFor = $this->addSelect('used_for', array('multiple' => TRUE, 'option_url' => NULL));
 114
 115       if ($this->_id &&
 116         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Tag', $this->_id, 'parent_id')
 117       ) {
 118         $usedFor->freeze();
 119       }
 120
 121       $adminTagset = TRUE;
 122       if (!CRM_Core_Permission::check('administer Tagsets')) {
 123         $adminTagset = FALSE;
 124       }
 125       $this->assign('adminTagset', $adminTagset);
 126
 127       $adminReservedTags = TRUE;
 128       if (!CRM_Core_Permission::check('administer reserved tags')) {
 129         $isReserved->freeze();
 130         $adminReservedTags = FALSE;
 131       }
 132       $this->assign('adminReservedTags', $adminReservedTags);
 133
 134     }
 135     parent::buildQuickForm();
 136   }
 137
 138   /**
 139    * Process the form submission.
 140    *
 141    *
 142    * @return void
 143    */
 144   public function postProcess() {
 145     $params = $ids = array();
 146
 147     // store the submitted values in an array
 148     $params = $this->exportValues();
 149
 150     $ids['tag'] = $this->_id;
 151     if ($this->_action == CRM_Core_Action::ADD ||
 152       $this->_action == CRM_Core_Action::UPDATE
 153     ) {
 154       $params['used_for'] = implode(",", $params['used_for']);
 155     }
 156
 157     $params['is_tagset'] = 0;
 158     if ($this->_isTagSet) {
 159       $params['is_tagset'] = 1;
 160     }
 161
 162     if (!isset($params['is_reserved'])) {
 163       $params['is_reserved'] = 0;
 164     }
 165
 166     if (!isset($params['is_selectable'])) {
 167       $params['is_selectable'] = 0;
 168     }
 169
 170     if ($this->_action == CRM_Core_Action::DELETE) {
 171       if ($this->_id > 0) {
 172         $tag = civicrm_api3('tag', 'getsingle', array('id' => $this->_id));
 173         CRM_Core_BAO_Tag::del($this->_id);
 174         CRM_Core_Session::setStatus(ts('The tag \'%1\' has been deleted.', array(1 => $tag['name'])), ts('Deleted'), 'success');
 175       }
 176     }
 177     else {
 178       $tag = CRM_Core_BAO_Tag::add($params, $ids);
 179       CRM_Core_Session::setStatus(ts('The tag \'%1\' has been saved.', array(1 => $tag->name)), ts('Saved'), 'success');
 180     }
 181   }
 182
 183 }