3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 function __construct() {
41 parent
::__construct();
45 * Takes a bunch of params that are needed to match certain criteria and
46 * retrieves the relevant objects. Typically the valid params are only
47 * contact_id. We'll tweak this function to be more full featured over a period
48 * of time. This is the inverse function of create. It also stores all the retrieved
49 * values in the default array
51 * @param array $params (reference ) an assoc array of name/value pairs
52 * @param array $defaults (reference ) an assoc array to hold the flattened values
54 * @return object CRM_Core_DAO_Tag object on success, otherwise null
58 static function retrieve(&$params, &$defaults) {
59 $tag = new CRM_Core_DAO_Tag();
60 $tag->copyValues($params);
61 if ($tag->find(TRUE)) {
62 CRM_Core_DAO
::storeValues($tag, $defaults);
69 * @param null $usedFor
70 * @param bool $excludeHidden
74 function getTree($usedFor = NULL, $excludeHidden = FALSE) {
75 if (!isset($this->tree
)) {
76 $this->buildTree($usedFor, $excludeHidden);
82 * @param null $usedFor
83 * @param bool $excludeHidden
85 function buildTree($usedFor = NULL, $excludeHidden = FALSE) {
86 $sql = "SELECT civicrm_tag.id, civicrm_tag.parent_id,civicrm_tag.name FROM civicrm_tag ";
88 $whereClause = array();
90 $whereClause[] = "used_for like '%{$usedFor}%'";
93 $whereClause[] = "is_tagset = 0";
96 if (!empty($whereClause)) {
97 $sql .= " WHERE " . implode(' AND ', $whereClause);
100 $sql .= " ORDER BY parent_id,name";
102 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray, TRUE, NULL, FALSE, FALSE);
105 while ($dao->fetch()) {
106 if (!$dao->parent_id
) {
107 $this->tree
[$dao->id
]['name'] = $dao->name
;
110 if (array_key_exists($dao->parent_id
, $this->tree
)) {
111 $parent = &$this->tree
[$dao->parent_id
];
112 if (!isset($this->tree
[$dao->parent_id
]['children'])) {
113 $this->tree
[$dao->parent_id
]['children'] = array();
118 if (!array_key_exists($dao->parent_id
, $orphan)) {
119 $orphan[$dao->parent_id
] = array('children' => array());
121 $parent = &$orphan[$dao->parent_id
];
123 $parent['children'][$dao->id
] = array('name' => $dao->name
);
126 if (sizeof($orphan)) {
127 //hang the 3rd level lists at the right place
128 foreach ($this->tree
as & $level1) {
129 if (!isset($level1['children'])) {
133 foreach ($level1['children'] as $key => & $level2) {
134 if (array_key_exists($key, $orphan)) {
135 $level2['children'] = $orphan[$key]['children'];
143 * @param array $usedFor
144 * @param bool $buildSelect
146 * @param null $parentId
150 static function getTagsUsedFor($usedFor = array('civicrm_contact'),
157 if (empty($usedFor)) {
160 if (!is_array($usedFor)) {
161 $usedFor = array($usedFor);
164 if ($parentId === NULL) {
165 $parentClause = " parent_id IS NULL AND ";
168 $parentClause = " parent_id = {$parentId} AND ";
171 foreach ($usedFor as $entityTable) {
172 $tag = new CRM_Core_DAO_Tag();
174 $tag->orderBy('parent_id');
176 $tag->whereAdd("is_tagset = 0 AND {$parentClause} used_for LIKE '%{$entityTable}%'");
179 $tag->whereAdd("used_for LIKE '%{$entityTable}%'");
186 while ($tag->fetch()) {
188 $tags[$tag->id
] = $tag->name
;
191 $tags[$tag->id
]['name'] = $tag->name
;
192 $tags[$tag->id
]['parent_id'] = $tag->parent_id
;
193 $tags[$tag->id
]['is_tagset'] = $tag->is_tagset
;
194 $tags[$tag->id
]['used_for'] = $tag->used_for
;
204 * @param string $usedFor
206 * @param null $parentId
207 * @param string $separator
211 static function getTags($usedFor = 'civicrm_contact',
214 $separator = ' '
216 if (!is_array($tags)) {
219 // We need to build a list of tags ordered by hierarchy and sorted by
220 // name. The heirarchy will be communicated by an accumulation of
221 // separators in front of the name to give it a visual offset.
222 // Instead of recursively making mysql queries, we'll make one big
223 // query and build the heirarchy with the algorithm below.
224 $args = array(1 => array('%' . $usedFor . '%', 'String'));
225 $query = "SELECT id, name, parent_id, is_tagset
227 WHERE used_for LIKE %1";
229 $query .= " AND parent_id = %2";
230 $args[2] = array($parentId, 'Integer');
232 $query .= " ORDER BY name";
233 $dao = CRM_Core_DAO
::executeQuery($query, $args, TRUE, NULL, FALSE, FALSE);
235 // Sort the tags into the correct storage by the parent_id/is_tagset
236 // filter the filter was in place previously, we're just reusing it.
237 // $roots represents the current leaf nodes that need to be checked for
238 // children. $rows represents the unplaced nodes, not all of much
239 // are necessarily placed.
240 $roots = $rows = array();
241 while ($dao->fetch()) {
242 if ($dao->parent_id
== $parentId && $dao->is_tagset
== 0) {
243 $roots[] = array('id' => $dao->id
, 'prefix' => '', 'name' => $dao->name
);
246 $rows[] = array('id' => $dao->id
, 'prefix' => '', 'name' => $dao->name
, 'parent_id' => $dao->parent_id
);
250 // While we have nodes left to build, shift the first (alphabetically)
251 // node of the list, place it in our tags list and loop through the
252 // list of unplaced nodes to find its children. We make a copy to
253 // iterate through because we must modify the unplaced nodes list
255 while (count($roots)) {
256 $new_roots = array();
257 $current_rows = $rows;
258 $root = array_shift($roots);
259 $tags[$root['id']] = array($root['prefix'], $root['name']);
261 // As you find the children, append them to the end of the new set
262 // of roots (maintain alphabetical ordering). Also remove the node
263 // from the set of unplaced nodes.
264 if (is_array($current_rows)) {
265 foreach ($current_rows as $key => $row) {
266 if ($row['parent_id'] == $root['id']) {
267 $new_roots[] = array('id' => $row['id'], 'prefix' => $tags[$root['id']][0] . $separator, 'name' => $row['name']);
273 //As a group, insert the new roots into the beginning of the roots
274 //list. This maintains the hierarchical ordering of the tags.
275 $roots = array_merge($new_roots, $roots);
278 // Prefix each name with the calcuated spacing to give the visual
279 // appearance of ordering when transformed into HTML in the form layer.
280 foreach ($tags as & $tag) {
281 $tag = $tag[0] . $tag[1];
288 * Function to delete the tag
290 * @param int $id tag id
297 static function del($id) {
298 // since this is a destructive operation, lets make sure
299 // id is a postive number
300 CRM_Utils_Type
::validate($id, 'Positive');
302 // delete all crm_entity_tag records with the selected tag id
303 $entityTag = new CRM_Core_DAO_EntityTag();
304 $entityTag->tag_id
= $id;
305 $entityTag->delete();
307 // delete from tag table
308 $tag = new CRM_Core_DAO_Tag();
311 CRM_Utils_Hook
::pre('delete', 'Tag', $id, $tag);
313 if ($tag->delete()) {
314 CRM_Utils_Hook
::post('delete', 'Tag', $id, $tag);
321 * takes an associative array and creates a contact object
323 * The function extract all the params it needs to initialize the create a
324 * contact object. the params array could contain additional unused name/value
327 * @param array $params (reference) an assoc array of name/value pairs
328 * @param array $ids (optional) the array that holds all the db ids - we are moving away from this in bao
331 * @return object CRM_Core_DAO_Tag object on success, otherwise null
335 static function add(&$params, $ids = array()) {
336 if (!self
::dataExists($params)) {
340 $tag = new CRM_Core_DAO_Tag();
342 // if parent id is set then inherit used for and is hidden properties
343 if (!empty($params['parent_id'])) {
344 // get parent details
345 $params['used_for'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Tag', $params['parent_id'], 'used_for');
348 $tag->copyValues($params);
349 $tag->id
= CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('tag', $ids));
350 $hook = empty($params['id']) ?
'create' : 'edit';
351 CRM_Utils_Hook
::pre($hook, 'Tag', $tag->id
, $params);
353 // save creator id and time
355 $session = CRM_Core_Session
::singleton();
356 $tag->created_id
= $session->get('userID');
357 $tag->created_date
= date('YmdHis');
361 CRM_Utils_Hook
::post($hook, 'Tag', $tag->id
, $tag);
363 // if we modify parent tag, then we need to update all children
364 if ($tag->parent_id
=== 'null') {
365 CRM_Core_DAO
::executeQuery("UPDATE civicrm_tag SET used_for=%1 WHERE parent_id = %2",
366 array(1 => array($params['used_for'], 'String'),
367 2 => array($tag->id
, 'Integer'),
376 * Check if there is data to create the object
378 * @param array $params (reference ) an assoc array of name/value pairs
384 static function dataExists(&$params) {
385 // Disallow empty values except for the number zero.
386 // TODO: create a utility for this since it's needed in many places
387 if (!empty($params['name']) ||
(string) $params['name'] === '0') {
395 * Function to get the tag sets for a entity object
397 * @param string $entityTable entity_table
399 * @return array $tagSets array of tag sets
403 static function getTagSet($entityTable) {
405 $query = "SELECT name, id FROM civicrm_tag
406 WHERE is_tagset=1 AND parent_id IS NULL and used_for LIKE %1";
407 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array('%' . $entityTable . '%', 'String')), TRUE, NULL, FALSE, FALSE);
408 while ($dao->fetch()) {
409 $tagSets[$dao->id
] = $dao->name
;
416 * Function to get the tags that are not children of a tagset.
418 * @return array $tags associated array of tag name and id@access public
421 static function getTagsNotInTagset() {
422 $tags = $tagSets = array();
423 // first get all the tag sets
424 $query = "SELECT id FROM civicrm_tag WHERE is_tagset=1 AND parent_id IS NULL";
425 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
426 while ($dao->fetch()) {
427 $tagSets[] = $dao->id
;
431 if (!empty($tagSets)) {
432 $parentClause = ' WHERE ( parent_id IS NULL ) OR ( parent_id NOT IN ( ' . implode(',', $tagSets) . ' ) )';
435 // get that tags that don't have tagset as parent
436 $query = "SELECT id, name FROM civicrm_tag {$parentClause}";
437 $dao = CRM_Core_DAO
::executeQuery($query);
438 while ($dao->fetch()) {
439 $tags[$dao->id
] = $dao->name
;