3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This class contains functions for managing Tag(tag) for a contact
32 * @copyright CiviCRM LLC (c) 2004-2013
36 class CRM_Core_BAO_EntityTag
extends CRM_Core_DAO_EntityTag
{
40 * Given a contact id, it returns an array of tag id's the
43 * @param int $entityID id of the entity usually the contactID.
44 * @param string $entityTable name of the entity table usually 'civicrm_contact'
47 ) reference $tag array of catagory id's the contact belongs to.
52 static function &getTag($entityID, $entityTable = 'civicrm_contact') {
55 $entityTag = new CRM_Core_BAO_EntityTag();
56 $entityTag->entity_id
= $entityID;
57 $entityTag->entity_table
= $entityTable;
60 while ($entityTag->fetch()) {
61 $tags[$entityTag->tag_id
] = $entityTag->tag_id
;
67 * takes an associative array and creates a entityTag object
69 * the function extract all the params it needs to initialize the create a
70 * group object. the params array could contain additional unused name/value
73 * @param array $params (reference ) an assoc array of name/value pairs
75 * @return object CRM_Core_BAO_EntityTag object
79 static function add(&$params) {
80 $dataExists = self
::dataExists($params);
85 $entityTag = new CRM_Core_BAO_EntityTag();
86 $entityTag->copyValues($params);
88 // dont save the object if it already exists, CRM-1276
89 if (!$entityTag->find(TRUE)) {
92 //invoke post hook on entityTag
93 // we are using this format to keep things consistent between the single and bulk operations
94 // so a bit different from other post hooks
95 $object = array(0 => array(0 => $params['entity_id']), 1 => $params['entity_table']);
96 CRM_Utils_Hook
::post('create', 'EntityTag', $params['tag_id'], $object);
102 * Check if there is data to create the object
104 * @params array $params (reference ) an assoc array of name/value pairs
110 static function dataExists(&$params) {
111 return ($params['tag_id'] == 0) ?
FALSE : TRUE;
115 * Function to delete the tag for a contact
117 * @param array $params (reference ) an assoc array of name/value pairs
119 * @return object CRM_Core_BAO_EntityTag object
124 static function del(&$params) {
125 $entityTag = new CRM_Core_BAO_EntityTag();
126 $entityTag->copyValues($params);
127 if ($entityTag->find(TRUE)) {
128 $entityTag->delete();
130 //invoke post hook on entityTag
131 $object = array(0 => array(0 => $params['entity_id']), 1 => $params['entity_table']);
132 CRM_Utils_Hook
::post('delete', 'EntityTag', $params['tag_id'], $object);
137 * Given an array of entity ids and entity table, add all the entity to the tags
139 * @param array $entityIds (reference ) the array of entity ids to be added
140 * @param int $tagId the id of the tag
141 * @params string $entityTable name of entity table default:civicrm_contact
143 * @return array (total, added, notAdded) count of enities added to tag
147 static function addEntitiesToTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') {
148 $numEntitiesAdded = 0;
149 $numEntitiesNotAdded = 0;
150 $entityIdsAdded = array();
152 foreach ($entityIds as $entityId) {
153 $tag = new CRM_Core_DAO_EntityTag();
155 $tag->entity_id
= $entityId;
156 $tag->tag_id
= $tagId;
157 $tag->entity_table
= $entityTable;
160 $entityIdsAdded[] = $entityId;
164 $numEntitiesNotAdded++
;
168 //invoke post hook on entityTag
169 $object = array($entityIdsAdded, $entityTable);
170 CRM_Utils_Hook
::post('create', 'EntityTag', $tagId, $object);
172 // reset the group contact cache for all groups
173 // if tags are being used in a smart group
174 CRM_Contact_BAO_GroupContactCache
::remove();
176 return array(count($entityIds), $numEntitiesAdded, $numEntitiesNotAdded);
180 * Given an array of entity ids and entity table, remove entity(s) tags
182 * @param array $entityIds (reference ) the array of entity ids to be removed
183 * @param int $tagId the id of the tag
184 * @params string $entityTable name of entity table default:civicrm_contact
186 * @return array (total, removed, notRemoved) count of entities removed from tags
190 static function removeEntitiesFromTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') {
191 $numEntitiesRemoved = 0;
192 $numEntitiesNotRemoved = 0;
193 $entityIdsRemoved = array();
195 foreach ($entityIds as $entityId) {
196 $tag = new CRM_Core_DAO_EntityTag();
198 $tag->entity_id
= $entityId;
199 $tag->tag_id
= $tagId;
200 $tag->entity_table
= $entityTable;
203 $entityIdsRemoved[] = $entityId;
204 $numEntitiesRemoved++
;
207 $numEntitiesNotRemoved++
;
211 //invoke post hook on entityTag
212 $object = array($entityIdsRemoved, $entityTable);
213 CRM_Utils_Hook
::post('delete', 'EntityTag', $tagId, $object);
215 // reset the group contact cache for all groups
216 // if tags are being used in a smart group
217 CRM_Contact_BAO_GroupContactCache
::remove();
219 return array(count($entityIds), $numEntitiesRemoved, $numEntitiesNotRemoved);
223 * takes an associative array and creates tag entity record for all tag entities
225 * @param array $params (reference ) an assoc array of name/value pairs
226 * @param array $contactId contact id
232 static function create(&$params, $entityTable, $entityID) {
233 // get categories for the entity id
234 $entityTag = CRM_Core_BAO_EntityTag
::getTag($entityID, $entityTable);
236 // get the list of all the categories
237 $allTag = CRM_Core_BAO_Tag
::getTags($entityTable);
239 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
240 if (!is_array($params)) {
244 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
245 if (!is_array($entityTag)) {
246 $entityTag = array();
249 // check which values has to be inserted/deleted for contact
250 foreach ($allTag as $key => $varValue) {
251 $tagParams['entity_table'] = $entityTable;
252 $tagParams['entity_id'] = $entityID;
253 $tagParams['tag_id'] = $key;
255 if (array_key_exists($key, $params) && !array_key_exists($key, $entityTag)) {
256 // insert a new record
257 CRM_Core_BAO_EntityTag
::add($tagParams);
259 elseif (!array_key_exists($key, $params) && array_key_exists($key, $entityTag)) {
260 // delete a record for existing contact
261 CRM_Core_BAO_EntityTag
::del($tagParams);
267 * This function returns all entities assigned to a specific tag
269 * @param object $tag an object of a tag.
271 * @return array $entityIds array of entity ids
274 function getEntitiesByTag($tag) {
275 $entityIds = array();
276 $entityTagDAO = new CRM_Core_DAO_EntityTag();
277 $entityTagDAO->tag_id
= $tag->id
;
278 $entityTagDAO->find();
279 while ($entityTagDAO->fetch()) {
280 $entityIds[] = $entityTagDAO->entity_id
;
286 * Function to get contact tags
288 static function getContactTags($contactID, $count = FALSE) {
289 $contactTags = array();
291 $select = "SELECT name ";
294 $select = "SELECT count(*) as cnt";
299 INNER JOIN civicrm_entity_tag et ON ( ct.id = et.tag_id AND
300 et.entity_id = {$contactID} AND
301 et.entity_table = 'civicrm_contact' AND
304 $dao = CRM_Core_DAO
::executeQuery($query);
311 while ($dao->fetch()) {
312 $contactTags[] = $dao->name
;
319 * Function to get child contact tags given parentId
321 static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') {
322 $entityTags = array();
323 $query = "SELECT ct.id as tag_id, name FROM civicrm_tag ct
324 INNER JOIN civicrm_entity_tag et ON ( et.entity_id = {$entityId} AND
325 et.entity_table = '{$entityTable}' AND et.tag_id = ct.id)
326 WHERE ct.parent_id = {$parentId}";
328 $dao = CRM_Core_DAO
::executeQuery($query);
330 while ($dao->fetch()) {
331 $entityTags[$dao->tag_id
] = array(
332 'id' => $dao->tag_id
,
333 'name' => $dao->name
,
341 * Function to merge two tags: tag B into tag A.
343 function mergeTags($tagAId, $tagBId) {
344 $queryParams = array(1 => array($tagBId, 'Integer'),
345 2 => array($tagAId, 'Integer'),
348 // re-compute used_for field
349 $query = "SELECT id, name, used_for FROM civicrm_tag WHERE id IN (%1, %2)";
350 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
352 while ($dao->fetch()) {
353 $label = ($dao->id
== $tagAId) ?
'tagA' : 'tagB';
354 $tags[$label] = $dao->name
;
355 $tags["{$label}_used_for"] = $dao->used_for ?
explode(",", $dao->used_for
) : array();
357 $usedFor = array_merge($tags["tagA_used_for"], $tags["tagB_used_for"]);
358 $usedFor = implode(',', array_unique($usedFor));
359 $tags["tagB_used_for"] = explode(",", $usedFor);
361 // get all merge queries together
363 // 1. update entity tag entries
364 "UPDATE IGNORE civicrm_entity_tag SET tag_id = %1 WHERE tag_id = %2",
365 // 2. update used_for info for tag B
366 "UPDATE civicrm_tag SET used_for = '{$usedFor}' WHERE id = %1",
367 // 3. remove tag A, if tag A is getting merged into B
368 "DELETE FROM civicrm_tag WHERE id = %2",
369 // 4. remove duplicate entity tag records
370 "DELETE et2.* from civicrm_entity_tag et1 INNER JOIN civicrm_entity_tag et2 ON et1.entity_table = et2.entity_table AND et1.entity_id = et2.entity_id AND et1.tag_id = et2.tag_id WHERE et1.id < et2.id",
371 // 5. remove orphaned entity_tags
372 "DELETE FROM civicrm_entity_tag WHERE tag_id = %2",
374 $tables = array('civicrm_entity_tag', 'civicrm_tag');
376 // Allow hook_civicrm_merge() to add SQL statements for the merge operation AND / OR
377 // perform any other actions like logging
378 CRM_Utils_Hook
::merge('sqls', $sqls, $tagAId, $tagBId, $tables);
380 // call the SQL queries in one transaction
381 $transaction = new CRM_Core_Transaction();
382 foreach ($sqls as $sql) {
383 CRM_Core_DAO
::executeQuery($sql, $queryParams, TRUE, NULL, TRUE);
385 $transaction->commit();
387 $tags['status'] = TRUE;