CRM/Tag/Form/Tag.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for tags
  38  *
  39  */
  40 class CRM_Tag_Form_Tag extends CRM_Core_Form {
  41
  42   /**
  43    * The contact id, used when add/edit tag
  44    *
  45    * @var int
  46    */
  47   protected $_entityID;
  48   protected $_entityTable;
  49
  50   public function preProcess() {
  51     if ($this->get('entityID')) {
  52       $this->_entityID = $this->get('entityID');
  53     }
  54     else {
  55       $this->_entityID = $this->get('contactId');
  56     }
  57
  58     $this->_entityTable = $this->get('entityTable');
  59
  60     if (empty($this->_entityTable)) {
  61       $this->_entityTable = 'civicrm_contact';
  62     }
  63
  64     $this->assign('entityID', $this->_entityID);
  65     $this->assign('entityTable', $this->_entityTable);
  66   }
  67
  68   /**
  69    * Build the form object.
  70    *
  71    * @return void
  72    */
  73   public function buildQuickForm() {
  74     // get categories for the contact id
  75     $entityTag = CRM_Core_BAO_EntityTag::getTag($this->_entityID, $this->_entityTable);
  76     $this->assign('tagged', $entityTag);
  77
  78     // get the list of all the categories
  79     $allTags = CRM_Core_BAO_Tag::getTagsUsedFor($this->_entityTable, FALSE);
  80
  81     // need to append the array with the " checked " if contact is tagged with the tag
  82     foreach ($allTags as $tagID => $varValue) {
  83       if (in_array($tagID, $entityTag)) {
  84         $tagAttribute = array(
  85           'checked' => 'checked',
  86           'id' => "tag_{$tagID}",
  87         );
  88       }
  89       else {
  90         $tagAttribute = array(
  91           'id' => "tag_{$tagID}",
  92         );
  93       }
  94
  95       $tagChk[$tagID] = $this->createElement('checkbox', $tagID, '', '', $tagAttribute);
  96     }
  97
  98     $this->addGroup($tagChk, 'tagList', NULL, NULL, TRUE);
  99
 100     $tags = new CRM_Core_BAO_Tag();
 101     $tree = $tags->getTree($this->_entityTable, TRUE);
 102     $this->assign('tree', $tree);
 103
 104     $this->assign('allTags', $allTags);
 105
 106     //build tag widget
 107     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_contact');
 108     CRM_Core_Form_Tag::buildQuickForm($this, $parentNames, $this->_entityTable, $this->_entityID);
 109   }
 110
 111   /**
 112    *
 113    * @return void
 114    */
 115   public function postProcess() {
 116     CRM_Utils_System::flushCache('CRM_Core_DAO_Tag');
 117
 118     // array contains the posted values
 119     // exportvalues is not used because its give value 1 of the checkbox which were checked by default,
 120     // even after unchecking them before submitting them
 121     $entityTag = $_POST['tagList'];
 122
 123     CRM_Core_BAO_EntityTag::create($entityTag, $this->_entityTable, $this->_entityID);
 124
 125     CRM_Core_Session::setStatus(ts('Your update(s) have been saved.'), ts('Saved'), 'success');
 126   }
 127
 128 }