3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Core_BAO_Tag
extends CRM_Core_DAO_Tag
{
40 public function __construct() {
41 parent
::__construct();
45 * Fetch object based on array of properties
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
49 * @param array $defaults
50 * (reference ) an assoc array to hold the flattened values.
53 * CRM_Core_DAO_Tag object on success, otherwise null
55 public static function retrieve(&$params, &$defaults) {
56 $tag = new CRM_Core_DAO_Tag();
57 $tag->copyValues($params);
58 if ($tag->find(TRUE)) {
59 CRM_Core_DAO
::storeValues($tag, $defaults);
66 * @param null $usedFor
67 * @param bool $excludeHidden
71 public function getTree($usedFor = NULL, $excludeHidden = FALSE) {
72 if (!isset($this->tree
)) {
73 $this->buildTree($usedFor, $excludeHidden);
79 * Build a nested array from hierarchical tags. Supports infinite levels of nesting.
80 * @param null $usedFor
81 * @param bool $excludeHidden
83 public function buildTree($usedFor = NULL, $excludeHidden = FALSE) {
84 $sql = "SELECT id, parent_id, name, description, is_selectable FROM civicrm_tag";
86 $whereClause = array();
88 $whereClause[] = "used_for like '%{$usedFor}%'";
91 $whereClause[] = "is_tagset = 0";
94 if (!empty($whereClause)) {
95 $sql .= " WHERE " . implode(' AND ', $whereClause);
98 $sql .= " ORDER BY parent_id,name";
100 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray, TRUE, NULL, FALSE, FALSE);
103 while ($dao->fetch()) {
104 $thisref = &$refs[$dao->id
];
106 $thisref['parent_id'] = $dao->parent_id
;
107 $thisref['name'] = $dao->name
;
108 $thisref['description'] = $dao->description
;
109 $thisref['is_selectable'] = $dao->is_selectable
;
111 if (!$dao->parent_id
) {
112 $this->tree
[$dao->id
] = &$thisref;
115 $refs[$dao->parent_id
]['children'][$dao->id
] = &$thisref;
122 * @param array $usedFor
123 * @param bool $buildSelect
125 * @param int $parentId
129 public static function getTagsUsedFor($usedFor = array(
138 if (empty($usedFor)) {
141 if (!is_array($usedFor)) {
142 $usedFor = array($usedFor);
145 if ($parentId === NULL) {
146 $parentClause = " parent_id IS NULL AND ";
149 $parentClause = " parent_id = {$parentId} AND ";
152 foreach ($usedFor as $entityTable) {
153 $tag = new CRM_Core_DAO_Tag();
155 $tag->orderBy('parent_id');
157 $tag->whereAdd("is_tagset = 0 AND {$parentClause} used_for LIKE '%{$entityTable}%'");
160 $tag->whereAdd("used_for LIKE '%{$entityTable}%'");
167 while ($tag->fetch()) {
169 $tags[$tag->id
] = $tag->name
;
172 $tags[$tag->id
]['name'] = $tag->name
;
173 $tags[$tag->id
]['parent_id'] = $tag->parent_id
;
174 $tags[$tag->id
]['is_tagset'] = $tag->is_tagset
;
175 $tags[$tag->id
]['used_for'] = $tag->used_for
;
185 * Function to retrieve tags
187 * @param string $usedFor
188 * Which type of tag entity.
191 * @param int $parentId
192 * Parent id if you want need only children.
193 * @param string $separator
194 * Separator to indicate children.
195 * @param bool $formatSelectable
196 * Add special property for non-selectable.
197 * tag, so they cannot be selected
201 static function getTags(
202 $usedFor = 'civicrm_contact',
205 $separator = ' ',
206 $formatSelectable = FALSE
208 if (!is_array($tags)) {
211 // We need to build a list of tags ordered by hierarchy and sorted by
212 // name. The heirarchy will be communicated by an accumulation of
213 // separators in front of the name to give it a visual offset.
214 // Instead of recursively making mysql queries, we'll make one big
215 // query and build the heirarchy with the algorithm below.
216 $args = array(1 => array('%' . $usedFor . '%', 'String'));
217 $query = "SELECT id, name, parent_id, is_tagset, is_selectable
219 WHERE used_for LIKE %1";
221 $query .= " AND parent_id = %2";
222 $args[2] = array($parentId, 'Integer');
224 $query .= " ORDER BY name";
225 $dao = CRM_Core_DAO
::executeQuery($query, $args, TRUE, NULL, FALSE, FALSE);
227 // Sort the tags into the correct storage by the parent_id/is_tagset
228 // filter the filter was in place previously, we're just reusing it.
229 // $roots represents the current leaf nodes that need to be checked for
230 // children. $rows represents the unplaced nodes, not all of much
231 // are necessarily placed.
232 $roots = $rows = array();
233 while ($dao->fetch()) {
234 // note that we are prepending id with "crm_disabled_opt" which identifies
235 // them as disabled so that they cannot be selected. We do some magic
236 // in crm-select2 js function that marks option values to "disabled"
237 // current QF version in CiviCRM does not support passing this attribute,
238 // so this is another ugly hack / workaround,
239 // also know one is too keen to upgrade QF :P
241 if ($formatSelectable && !$dao->is_selectable
) {
242 $idPrefix = "crm_disabled_opt";
244 if ($dao->parent_id
== $parentId && $dao->is_tagset
== 0) {
248 'name' => $dao->name
,
249 'idPrefix' => $idPrefix,
256 'name' => $dao->name
,
257 'parent_id' => $dao->parent_id
,
258 'idPrefix' => $idPrefix,
264 // While we have nodes left to build, shift the first (alphabetically)
265 // node of the list, place it in our tags list and loop through the
266 // list of unplaced nodes to find its children. We make a copy to
267 // iterate through because we must modify the unplaced nodes list
269 while (count($roots)) {
270 $new_roots = array();
271 $current_rows = $rows;
272 $root = array_shift($roots);
273 $tags[$root['id']] = array(
279 // As you find the children, append them to the end of the new set
280 // of roots (maintain alphabetical ordering). Also remove the node
281 // from the set of unplaced nodes.
282 if (is_array($current_rows)) {
283 foreach ($current_rows as $key => $row) {
284 if ($row['parent_id'] == $root['id']) {
285 $new_roots[] = array(
287 'prefix' => $tags[$root['id']][0] . $separator,
288 'name' => $row['name'],
289 'idPrefix' => $row['idPrefix'],
296 //As a group, insert the new roots into the beginning of the roots
297 //list. This maintains the hierarchical ordering of the tags.
298 $roots = array_merge($new_roots, $roots);
301 // Prefix each name with the calcuated spacing to give the visual
302 // appearance of ordering when transformed into HTML in the form layer.
303 // here is the actual code that to prepends and set disabled attribute for
304 // non-selectable tags
305 $formattedTags = array();
306 foreach ($tags as $key => $tag) {
307 if (!empty($tag[2])) {
308 $key = $tag[2] . "-" . $key;
310 $formattedTags[$key] = $tag[0] . $tag[1];
313 $tags = $formattedTags;
325 public static function del($id) {
326 // since this is a destructive operation, lets make sure
327 // id is a postive number
328 CRM_Utils_Type
::validate($id, 'Positive');
330 // delete all crm_entity_tag records with the selected tag id
331 $entityTag = new CRM_Core_DAO_EntityTag();
332 $entityTag->tag_id
= $id;
333 $entityTag->delete();
335 // delete from tag table
336 $tag = new CRM_Core_DAO_Tag();
339 CRM_Utils_Hook
::pre('delete', 'Tag', $id, $tag);
341 if ($tag->delete()) {
342 CRM_Utils_Hook
::post('delete', 'Tag', $id, $tag);
349 * Takes an associative array and creates a contact object
351 * The function extract all the params it needs to initialize the create a
352 * contact object. the params array could contain additional unused name/value
355 * @param array $params
356 * (reference) an assoc array of name/value pairs.
358 * (optional) the array that holds all the db ids - we are moving away from this in bao.
362 * CRM_Core_DAO_Tag object on success, otherwise null
364 public static function add(&$params, $ids = array()) {
365 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('tag', $ids));
366 if (!$id && !self
::dataExists($params)) {
370 $tag = new CRM_Core_DAO_Tag();
372 // if parent id is set then inherit used for and is hidden properties
373 if (!empty($params['parent_id'])) {
374 // get parent details
375 $params['used_for'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Tag', $params['parent_id'], 'used_for');
378 $tag->copyValues($params);
380 $hook = !$id ?
'create' : 'edit';
381 CRM_Utils_Hook
::pre($hook, 'Tag', $tag->id
, $params);
383 // save creator id and time
385 $session = CRM_Core_Session
::singleton();
386 $tag->created_id
= $session->get('userID');
387 $tag->created_date
= date('YmdHis');
391 CRM_Utils_Hook
::post($hook, 'Tag', $tag->id
, $tag);
393 // if we modify parent tag, then we need to update all children
394 if ($tag->parent_id
=== 'null') {
395 CRM_Core_DAO
::executeQuery("UPDATE civicrm_tag SET used_for=%1 WHERE parent_id = %2",
397 1 => array($params['used_for'], 'String'),
398 2 => array($tag->id
, 'Integer'),
407 * Check if there is data to create the object
409 * @param array $params
410 * (reference ) an assoc array of name/value pairs.
414 public static function dataExists(&$params) {
415 // Disallow empty values except for the number zero.
416 // TODO: create a utility for this since it's needed in many places
417 if (!empty($params['name']) ||
(string) $params['name'] === '0') {
425 * Get the tag sets for a entity object
427 * @param string $entityTable
433 public static function getTagSet($entityTable) {
435 $query = "SELECT name, id FROM civicrm_tag
436 WHERE is_tagset=1 AND parent_id IS NULL and used_for LIKE %1";
437 $dao = CRM_Core_DAO
::executeQuery($query, array(
439 '%' . $entityTable . '%',
442 ), TRUE, NULL, FALSE, FALSE);
443 while ($dao->fetch()) {
444 $tagSets[$dao->id
] = $dao->name
;
451 * Get the tags that are not children of a tagset.
454 * associated array of tag name and id
456 public static function getTagsNotInTagset() {
457 $tags = $tagSets = array();
458 // first get all the tag sets
459 $query = "SELECT id FROM civicrm_tag WHERE is_tagset=1 AND parent_id IS NULL";
460 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
461 while ($dao->fetch()) {
462 $tagSets[] = $dao->id
;
466 if (!empty($tagSets)) {
467 $parentClause = ' WHERE ( parent_id IS NULL ) OR ( parent_id NOT IN ( ' . implode(',', $tagSets) . ' ) )';
470 // get that tags that don't have tagset as parent
471 $query = "SELECT id, name FROM civicrm_tag {$parentClause}";
472 $dao = CRM_Core_DAO
::executeQuery($query);
473 while ($dao->fetch()) {
474 $tags[$dao->id
] = $dao->name
;