CRM/Core/Form/Tag.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 generates form element for free tag widget
  38  *
  39  */
  40 class CRM_Core_Form_Tag {
  41   public $_entityTagValues;
  42
  43   /**
  44    * Function to build tag widget if correct parent is passed
  45    *
  46    * @param CRM_Core_Form $form form object
  47    * @param string $parentNames parent name ( tag name)
  48    * @param string $entityTable entitytable 'eg: civicrm_contact'
  49    * @param int $entityId entityid  'eg: contact id'
  50    * @param boolean $skipTagCreate true if tag need be created using ajax
  51    * @param boolean $skipEntityAction true if need to add entry in entry table via ajax
  52    * @param string $tagsetElementName if you need to create tagsetlist with specific name
  53    *
  54    * @internal param bool $searchMode true if widget is used in search eg: advanced search
  55    * @return void
  56    * @access public
  57    * @static
  58    */
  59   static function buildQuickForm(&$form, $parentNames, $entityTable, $entityId = NULL, $skipTagCreate = FALSE,
  60     $skipEntityAction = FALSE, $tagsetElementName = NULL ) {
  61     $tagset = $form->_entityTagValues = array();
  62     $form->assign("isTagset", FALSE);
  63     $mode = NULL;
  64
  65     foreach ($parentNames as &$parentNameItem) {
  66       // get the parent id for tag list input for keyword
  67       $parentId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Tag', $parentNameItem, 'id', 'name');
  68
  69       // check if parent exists
  70       if ($parentId) {
  71         $tagsetItem = $tagsetElementName . 'parentId_' . $parentId;
  72         $tagset[$tagsetItem]['parentID'] = $parentId;
  73
  74         list(, $mode) = explode('_', $entityTable);
  75         if (!$tagsetElementName) {
  76           $tagsetElementName = $mode . "_taglist";
  77         }
  78         $tagset[$tagsetItem]['tagsetElementName'] = $tagsetElementName;
  79
  80         $form->addEntityRef("{$tagsetElementName}[{$parentId}]", $parentNameItem, array(
  81           'entity' => 'tag',
  82           'multiple' => TRUE,
  83           'create' => !$skipTagCreate,
  84           'api' => array('params' => array('parent_id' => $parentId)),
  85           'data-entity_table' => $entityTable,
  86           'data-entity_id' => $entityId,
  87           'class' => "crm-$mode-tagset",
  88         ));
  89
  90         if ($entityId) {
  91           $tagset[$tagsetItem]['entityId'] = $entityId;
  92           $entityTags = CRM_Core_BAO_EntityTag::getChildEntityTags($parentId, $entityId, $entityTable);
  93           if ($entityTags) {
  94             $form->setDefaults(array("{$tagsetElementName}[{$parentId}]" => implode(',', array_keys($entityTags))));
  95           }
  96         }
  97         else {
  98           $skipEntityAction = TRUE;
  99         }
 100         $tagset[$tagsetItem]['skipEntityAction'] = $skipEntityAction;
 101       }
 102     }
 103
 104     if (!empty($tagset)) {
 105       // assign current tagsets which is used in postProcess
 106       $form->_tagsetInfo = $tagset;
 107       $form->assign("tagsetType", $mode);
 108       // Merge this tagset info with possibly existing info in the template
 109       $tagsetInfo = (array) $form->get_template_vars("tagsetInfo");
 110       if (empty($tagsetInfo[$mode])) {
 111         $tagsetInfo[$mode] = array();
 112       }
 113       $tagsetInfo[$mode] = array_merge($tagsetInfo[$mode], $tagset);
 114       $form->assign("tagsetInfo", $tagsetInfo);
 115       $form->assign("isTagset", TRUE);
 116     }
 117   }
 118
 119   /**
 120    * Function to save entity tags when it is not save used AJAX
 121    *
 122    * @param array   $params      associated array
 123    * @param int     $entityId    entity id, eg: contact id, activity id, case id, file id
 124    * @param string  $entityTable entity table
 125    * @param object  $form        form object
 126    *
 127    * @return void
 128    * @access public
 129    * @static
 130    */
 131   static function postProcess(&$params, $entityId, $entityTable = 'civicrm_contact', &$form) {
 132     if ($form && !empty($form->_entityTagValues)) {
 133       $existingTags = $form->_entityTagValues;
 134     }
 135     else {
 136       $existingTags = CRM_Core_BAO_EntityTag::getTag($entityId, $entityTable);
 137     }
 138
 139     if ($form) {
 140       // if the key is missing from the form response then all the tags were deleted / cleared
 141       // in that case we create empty tagset params so that below logic works and tagset are
 142       // deleted correctly
 143       foreach ($form->_tagsetInfo as $tagsetName => $tagsetInfo) {
 144         $tagsetId = explode('parentId_', $tagsetName);
 145         $tagsetId = $tagsetId[1];
 146         if (empty($params[$tagsetId])) {
 147           $params[$tagsetId] = '';
 148         }
 149       }
 150     }
 151
 152     // when form is submitted with tagset values below logic will work and in the case when all tags in a tagset
 153     // are deleted we will have to set $params[tagset id] = '' which is done by above logic
 154     foreach ($params as $parentId => $value) {
 155       $newTagIds = array();
 156       $realTagIds = array();
 157
 158       if ($value) {
 159         $tagsIDs = explode(',', $value);
 160         foreach ($tagsIDs as $tagId) {
 161           if (!is_numeric($tagId)) {
 162             // check if user has selected existing tag or is creating new tag
 163             // this is done to allow numeric tags etc.
 164             $tagValue = explode(':::', $tagId);
 165
 166             if (isset($tagValue[1]) && $tagValue[1] == 'value') {
 167               $tagParams = array(
 168                 'name' => $tagValue[0],
 169                 'parent_id' => $parentId,
 170               );
 171               $tagObject = CRM_Core_BAO_Tag::add($tagParams, CRM_Core_DAO::$_nullArray);
 172               $tagId = $tagObject->id;
 173             }
 174           }
 175
 176           $realTagIds[] = $tagId;
 177           if ($form && $form->_action != CRM_Core_Action::UPDATE) {
 178             $newTagIds[] = $tagId;
 179           }
 180           elseif (!array_key_exists($tagId, $existingTags)) {
 181             $newTagIds[] = $tagId;
 182           }
 183         }
 184       }
 185
 186       // Any existing entity tags from this tagset missing from the $params should be deleted
 187       $deleteSQL = "DELETE FROM civicrm_entity_tag
 188                     USING civicrm_entity_tag, civicrm_tag
 189                     WHERE civicrm_tag.id=civicrm_entity_tag.tag_id
 190                       AND civicrm_entity_tag.entity_table='{$entityTable}'
 191                       AND entity_id={$entityId} AND parent_id={$parentId}";
 192       if (!empty($realTagIds)) {
 193         $deleteSQL .= " AND tag_id NOT IN (" . implode(', ', $realTagIds) . ");";
 194       }
 195
 196       CRM_Core_DAO::executeQuery($deleteSQL);
 197
 198       if (!empty($newTagIds)) {
 199         // New tag ids can be inserted directly into the db table.
 200         $insertValues = array();
 201         foreach ($newTagIds as $tagId) {
 202           $insertValues[] = "( {$tagId}, {$entityId}, '{$entityTable}' ) ";
 203         }
 204         $insertSQL = 'INSERT INTO civicrm_entity_tag ( tag_id, entity_id, entity_table )
 205           VALUES ' . implode(', ', $insertValues) . ';';
 206         CRM_Core_DAO::executeQuery($insertSQL);
 207       }
 208     }
 209   }
 210 }
 211