CRM/Activity/Form/Task/RemoveFromTag.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to remove tags of contact(s).
  38  */
  39 class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task {
  40
  41   /**
  42    * Name of the tag
  43    *
  44    * @var string
  45    */
  46   protected $_name;
  47
  48   /**
  49    * All the tags in the system
  50    *
  51    * @var array
  52    */
  53   protected $_tags;
  54
  55   /**
  56    * Build the form object
  57    *
  58    * @access public
  59    *
  60    * @return void
  61    */
  62   function buildQuickForm() {
  63     // add select for tag
  64     $this->_tags = CRM_Core_BAO_Tag::getTags('civicrm_activity');
  65     foreach ($this->_tags as $tagID => $tagName) {
  66       $this->_tagElement = &$this->addElement('checkbox', "tag[$tagID]", NULL, $tagName);
  67     }
  68
  69     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_activity');
  70     CRM_Core_Form_Tag::buildQuickForm($this, $parentNames, 'civicrm_activity', NULL, TRUE, FALSE);
  71
  72     $this->addDefaultButtons(ts('Remove Tags from activities'));
  73   }
  74
  75   function addRules() {
  76     $this->addFormRule(array('CRM_Activity_Form_Task_RemoveFromTag', 'formRule'));
  77   }
  78
  79   /**
  80    * @param CRM_Core_Form $form
  81    * @param $rule
  82    *
  83    * @return array
  84    */
  85   static function formRule($form, $rule) {
  86     $errors = array();
  87     if (empty($form['tag']) && empty($form['activity_taglist'])) {
  88       $errors['_qf_default'] = "Please select atleast one tag.";
  89     }
  90     return $errors;
  91   }
  92
  93   /**
  94    * Process the form after the input has been submitted and validated
  95    *
  96    * @access public
  97    *
  98    * @return void
  99    */
 100   public function postProcess() {
 101     //get the submitted values in an array
 102     $params = $this->controller->exportValues($this->_name);
 103
 104     $activityTags = $tagList = array();
 105
 106     // check if contact tags exists
 107     if (!empty($params['tag'])) {
 108       $activityTags = $params['tag'];
 109     }
 110
 111     // check if tags are selected from taglists
 112     if (!empty($params['activity_taglist'])) {
 113       foreach ($params['activity_taglist'] as $val) {
 114         if ($val) {
 115           if (is_numeric($val)) {
 116             $tagList[$val] = 1;
 117           }
 118           else {
 119             list($label, $tagID) = explode(',', $val);
 120             $tagList[$tagID] = 1;
 121           }
 122         }
 123       }
 124     }
 125     $tagSets = CRM_Core_BAO_Tag::getTagsUsedFor('civicrm_activity', FALSE, TRUE);
 126
 127     foreach ($tagSets as $key => $value) {
 128       $this->_tags[$key] = $value['name'];
 129     }
 130     // merge contact and taglist tags
 131     $allTags = CRM_Utils_Array::crmArrayMerge($activityTags, $tagList);
 132
 133     $this->_name = array();
 134     foreach ($allTags as $key => $dnc) {
 135       $this->_name[] = $this->_tags[$key];
 136
 137       list($total, $removed, $notRemoved) = CRM_Core_BAO_EntityTag::removeEntitiesFromTag($this->_activityHolderIds, $key, 'civicrm_activity');
 138
 139       $status = array(ts('%count activities un-tagged', array('count' => $removed, 'plural' => '%count activities un-tagged')));
 140       if ($notRemoved) {
 141         $status[] = ts('1 activity already did not have this tag', array('count' => $notRemoved, 'plural' => '%count activities already did not have this tag'));
 142       }
 143       $status = '<ul><li>' . implode('</li><li>', $status) . '</li></ul>';
 144       CRM_Core_Session::setStatus($status, ts("Removed Tag <em>%1</em>", array(1 => $this->_tags[$key])), 'success', array('expires' => 0));
 145     }
 146   }
 147 }
 148