3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
34 class CRM_Core_BAO_EntityTag
extends CRM_Core_DAO_EntityTag
{
37 * Given a contact id, it returns an array of tag id's the contact belongs to.
39 * @param int $entityID
40 * Id of the entity usually the contactID.
41 * @param string $entityTable
42 * Name of the entity table usually 'civicrm_contact'.
45 * reference $tag array of category id's the contact belongs to.
47 public static function getTag($entityID, $entityTable = 'civicrm_contact') {
50 $entityTag = new CRM_Core_BAO_EntityTag();
51 $entityTag->entity_id
= $entityID;
52 $entityTag->entity_table
= $entityTable;
55 while ($entityTag->fetch()) {
56 $tags[$entityTag->tag_id
] = $entityTag->tag_id
;
62 * Takes an associative array and creates a entityTag object.
64 * the function extract all the params it needs to initialize the create a
65 * group object. the params array could contain additional unused name/value
68 * @param array $params
69 * (reference ) an assoc array of name/value pairs.
71 * @return CRM_Core_BAO_EntityTag
73 public static function add(&$params) {
74 $dataExists = self
::dataExists($params);
79 $entityTag = new CRM_Core_BAO_EntityTag();
80 $entityTag->copyValues($params);
82 // dont save the object if it already exists, CRM-1276
83 if (!$entityTag->find(TRUE)) {
86 //invoke post hook on entityTag
87 // we are using this format to keep things consistent between the single and bulk operations
88 // so a bit different from other post hooks
89 $object = array(0 => array(0 => $params['entity_id']), 1 => $params['entity_table']);
90 CRM_Utils_Hook
::post('create', 'EntityTag', $params['tag_id'], $object);
96 * Check if there is data to create the object.
98 * @param array $params
99 * An assoc array of name/value pairs.
103 public static function dataExists($params) {
104 return !($params['tag_id'] == 0);
108 * Delete the tag for a contact.
110 * @param array $params
111 * (reference ) an assoc array of name/value pairs.
113 public static function del(&$params) {
114 $entityTag = new CRM_Core_BAO_EntityTag();
115 $entityTag->copyValues($params);
116 $entityTag->delete();
118 //invoke post hook on entityTag
119 if (!empty($params['tag_id'])) {
120 $object = array(0 => array(0 => $params['entity_id']), 1 => $params['entity_table']);
121 CRM_Utils_Hook
::post('delete', 'EntityTag', $params['tag_id'], $object);
126 * Given an array of entity ids and entity table, add all the entity to the tags.
128 * @param array $entityIds
129 * (reference ) the array of entity ids to be added.
132 * @param string $entityTable
133 * Name of entity table default:civicrm_contact.
134 * @param bool $applyPermissions
135 * Should permissions be applied in this function.
138 * (total, added, notAdded) count of entities added to tag
140 public static function addEntitiesToTag(&$entityIds, $tagId, $entityTable, $applyPermissions) {
141 $numEntitiesAdded = 0;
142 $numEntitiesNotAdded = 0;
143 $entityIdsAdded = array();
145 foreach ($entityIds as $entityId) {
146 // CRM-17350 - check if we have permission to edit the contact
147 // that this tag belongs to.
148 if ($applyPermissions && !self
::checkPermissionOnEntityTag($entityId, $entityTable)) {
149 $numEntitiesNotAdded++
;
152 $tag = new CRM_Core_DAO_EntityTag();
154 $tag->entity_id
= $entityId;
155 $tag->tag_id
= $tagId;
156 $tag->entity_table
= $entityTable;
159 $entityIdsAdded[] = $entityId;
163 $numEntitiesNotAdded++
;
167 //invoke post hook on entityTag
168 $object = array($entityIdsAdded, $entityTable);
169 CRM_Utils_Hook
::post('create', 'EntityTag', $tagId, $object);
171 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
173 return array(count($entityIds), $numEntitiesAdded, $numEntitiesNotAdded);
177 * Basic check for ACL permission on editing/creating/removing a tag.
179 * In the absence of something better contacts get a proper check and other entities
180 * default to 'edit all contacts'. This is currently only accessed from the api which previously
181 * applied edit all contacts to all - so while still too restrictive it represents a loosening.
183 * Current possible entities are attachments, activities, cases & contacts.
185 * @param int $entityID
186 * @param string $entityTable
190 public static function checkPermissionOnEntityTag($entityID, $entityTable) {
191 if ($entityTable == 'civicrm_contact') {
192 return CRM_Contact_BAO_Contact_Permission
::allow($entityID, CRM_Core_Permission
::EDIT
);
195 return CRM_Core_Permission
::check('edit all contacts');
200 * Given an array of entity ids and entity table, remove entity(s)tags.
202 * @param array $entityIds
203 * (reference ) the array of entity ids to be removed.
206 * @param string $entityTable
207 * Name of entity table default:civicrm_contact.
208 * @param bool $applyPermissions
209 * Should permissions be applied in this function.
212 * (total, removed, notRemoved) count of entities removed from tags
214 public static function removeEntitiesFromTag(&$entityIds, $tagId, $entityTable, $applyPermissions) {
215 $numEntitiesRemoved = 0;
216 $numEntitiesNotRemoved = 0;
217 $entityIdsRemoved = array();
219 foreach ($entityIds as $entityId) {
220 // CRM-17350 - check if we have permission to edit the contact
221 // that this tag belongs to.
222 if ($applyPermissions && !self
::checkPermissionOnEntityTag($entityId, $entityTable)) {
223 $numEntitiesNotRemoved++
;
226 $tag = new CRM_Core_DAO_EntityTag();
228 $tag->entity_id
= $entityId;
229 $tag->tag_id
= $tagId;
230 $tag->entity_table
= $entityTable;
233 $entityIdsRemoved[] = $entityId;
234 $numEntitiesRemoved++
;
237 $numEntitiesNotRemoved++
;
241 //invoke post hook on entityTag
242 $object = array($entityIdsRemoved, $entityTable);
243 CRM_Utils_Hook
::post('delete', 'EntityTag', $tagId, $object);
245 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
247 return array(count($entityIds), $numEntitiesRemoved, $numEntitiesNotRemoved);
251 * Takes an associative array and creates tag entity record for all tag entities.
253 * @param array $params
254 * (reference) an assoc array of name/value pairs.
255 * @param string $entityTable
256 * @param int $entityID
258 public static function create(&$params, $entityTable, $entityID) {
259 // get categories for the entity id
260 $entityTag = CRM_Core_BAO_EntityTag
::getTag($entityID, $entityTable);
262 // get the list of all the categories
263 $allTag = CRM_Core_BAO_Tag
::getTags($entityTable);
265 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
266 if (!is_array($params)) {
270 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
271 if (!is_array($entityTag)) {
272 $entityTag = array();
275 // check which values has to be inserted/deleted for contact
276 foreach ($allTag as $key => $varValue) {
277 $tagParams['entity_table'] = $entityTable;
278 $tagParams['entity_id'] = $entityID;
279 $tagParams['tag_id'] = $key;
281 if (array_key_exists($key, $params) && !array_key_exists($key, $entityTag)) {
282 // insert a new record
283 CRM_Core_BAO_EntityTag
::add($tagParams);
285 elseif (!array_key_exists($key, $params) && array_key_exists($key, $entityTag)) {
286 // delete a record for existing contact
287 CRM_Core_BAO_EntityTag
::del($tagParams);
293 * This function returns all entities assigned to a specific tag.
296 * An object of a tag.
299 * array of entity ids
301 public function getEntitiesByTag($tag) {
302 $entityIds = array();
303 $entityTagDAO = new CRM_Core_DAO_EntityTag();
304 $entityTagDAO->tag_id
= $tag->id
;
305 $entityTagDAO->find();
306 while ($entityTagDAO->fetch()) {
307 $entityIds[] = $entityTagDAO->entity_id
;
315 * @param int $contactID
320 public static function getContactTags($contactID, $count = FALSE) {
321 $contactTags = array();
323 $select = "SELECT ct.id, ct.name ";
326 $select = "SELECT count(*) as cnt";
331 INNER JOIN civicrm_entity_tag et ON ( ct.id = et.tag_id AND
332 et.entity_id = {$contactID} AND
333 et.entity_table = 'civicrm_contact' AND
336 $dao = CRM_Core_DAO
::executeQuery($query);
343 while ($dao->fetch()) {
344 $contactTags[$dao->id
] = $dao->name
;
351 * Get child contact tags given parentId.
353 * @param int $parentId
354 * @param int $entityId
355 * @param string $entityTable
359 public static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') {
360 $entityTags = array();
361 $query = "SELECT ct.id as tag_id, name FROM civicrm_tag ct
362 INNER JOIN civicrm_entity_tag et ON ( et.entity_id = {$entityId} AND
363 et.entity_table = '{$entityTable}' AND et.tag_id = ct.id)
364 WHERE ct.parent_id = {$parentId}";
366 $dao = CRM_Core_DAO
::executeQuery($query);
368 while ($dao->fetch()) {
369 $entityTags[$dao->tag_id
] = array(
370 'id' => $dao->tag_id
,
371 'name' => $dao->name
,
379 * Merge two tags: tag B into tag A.
386 public function mergeTags($tagAId, $tagBId) {
387 $queryParams = array(
388 1 => array($tagBId, 'Integer'),
389 2 => array($tagAId, 'Integer'),
392 // re-compute used_for field
393 $query = "SELECT id, name, used_for FROM civicrm_tag WHERE id IN (%1, %2)";
394 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
396 while ($dao->fetch()) {
397 $label = ($dao->id
== $tagAId) ?
'tagA' : 'tagB';
398 $tags[$label] = $dao->name
;
399 $tags["{$label}_used_for"] = $dao->used_for ?
explode(",", $dao->used_for
) : array();
401 $usedFor = array_merge($tags["tagA_used_for"], $tags["tagB_used_for"]);
402 $usedFor = implode(',', array_unique($usedFor));
403 $tags["tagB_used_for"] = explode(",", $usedFor);
405 // get all merge queries together
407 // 1. update entity tag entries
408 "UPDATE IGNORE civicrm_entity_tag SET tag_id = %1 WHERE tag_id = %2",
409 // 2. update used_for info for tag B
410 "UPDATE civicrm_tag SET used_for = '{$usedFor}' WHERE id = %1",
411 // 3. remove tag A, if tag A is getting merged into B
412 "DELETE FROM civicrm_tag WHERE id = %2",
413 // 4. remove duplicate entity tag records
414 "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",
415 // 5. remove orphaned entity_tags
416 "DELETE FROM civicrm_entity_tag WHERE tag_id = %2",
418 $tables = array('civicrm_entity_tag', 'civicrm_tag');
420 // Allow hook_civicrm_merge() to add SQL statements for the merge operation AND / OR
421 // perform any other actions like logging
422 CRM_Utils_Hook
::merge('sqls', $sqls, $tagAId, $tagBId, $tables);
424 // call the SQL queries in one transaction
425 $transaction = new CRM_Core_Transaction();
426 foreach ($sqls as $sql) {
427 CRM_Core_DAO
::executeQuery($sql, $queryParams, TRUE, NULL, TRUE);
429 $transaction->commit();
431 $tags['status'] = TRUE;
436 * Get options for a given field.
438 * @see CRM_Core_DAO::buildOptions
439 * @see CRM_Core_DAO::buildOptionsContext
441 * @param string $fieldName
442 * @param string $context
443 * As per CRM_Core_DAO::buildOptionsContext.
444 * @param array $props
445 * whatever is known about this dao object.
449 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
452 if ($fieldName == 'tag' ||
$fieldName == 'tag_id') {
453 if (!empty($props['entity_table'])) {
454 $entity = CRM_Utils_Type
::escape($props['entity_table'], 'String');
455 $params[] = "used_for LIKE '%$entity%'";
458 // Output tag list as nested hierarchy
459 // TODO: This will only work when api.entity is "entity_tag". What about others?
460 if ($context == 'search' ||
$context == 'create') {
461 return CRM_Core_BAO_Tag
::getTags(CRM_Utils_Array
::value('entity_table', $props, 'civicrm_contact'), CRM_Core_DAO
::$_nullArray, CRM_Utils_Array
::value('parent_id', $params), '- ');
465 $options = CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);