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 * Build a nested array from hierarchical tags. Supports infinite levels of nesting.
83 * @param null $usedFor
84 * @param bool $excludeHidden
86 function buildTree($usedFor = NULL, $excludeHidden = FALSE) {
87 $sql = "SELECT id, parent_id, name, description, is_selectable FROM civicrm_tag";
89 $whereClause = array();
91 $whereClause[] = "used_for like '%{$usedFor}%'";
94 $whereClause[] = "is_tagset = 0";
97 if (!empty($whereClause)) {
98 $sql .= " WHERE " . implode(' AND ', $whereClause);
101 $sql .= " ORDER BY parent_id,name";
103 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray, TRUE, NULL, FALSE, FALSE);
106 while ($dao->fetch()) {
107 $thisref = &$refs[$dao->id
];
109 $thisref['parent_id'] = $dao->parent_id
;
110 $thisref['name'] = $dao->name
;
111 $thisref['description'] = $dao->description
;
112 $thisref['is_selectable'] = $dao->is_selectable
;
114 if (!$dao->parent_id
) {
115 $this->tree
[$dao->id
] = &$thisref;
118 $refs[$dao->parent_id
]['children'][$dao->id
] = &$thisref;
125 * @param array $usedFor
126 * @param bool $buildSelect
128 * @param null $parentId
132 static function getTagsUsedFor($usedFor = array('civicrm_contact'),
139 if (empty($usedFor)) {
142 if (!is_array($usedFor)) {
143 $usedFor = array($usedFor);
146 if ($parentId === NULL) {
147 $parentClause = " parent_id IS NULL AND ";
150 $parentClause = " parent_id = {$parentId} AND ";
153 foreach ($usedFor as $entityTable) {
154 $tag = new CRM_Core_DAO_Tag();
156 $tag->orderBy('parent_id');
158 $tag->whereAdd("is_tagset = 0 AND {$parentClause} used_for LIKE '%{$entityTable}%'");
161 $tag->whereAdd("used_for LIKE '%{$entityTable}%'");
168 while ($tag->fetch()) {
170 $tags[$tag->id
] = $tag->name
;
173 $tags[$tag->id
]['name'] = $tag->name
;
174 $tags[$tag->id
]['parent_id'] = $tag->parent_id
;
175 $tags[$tag->id
]['is_tagset'] = $tag->is_tagset
;
176 $tags[$tag->id
]['used_for'] = $tag->used_for
;
186 * @param string $usedFor
188 * @param null $parentId
189 * @param string $separator
193 static function getTags($usedFor = 'civicrm_contact',
196 $separator = ' '
198 if (!is_array($tags)) {
201 // We need to build a list of tags ordered by hierarchy and sorted by
202 // name. The heirarchy will be communicated by an accumulation of
203 // separators in front of the name to give it a visual offset.
204 // Instead of recursively making mysql queries, we'll make one big
205 // query and build the heirarchy with the algorithm below.
206 $args = array(1 => array('%' . $usedFor . '%', 'String'));
207 $query = "SELECT id, name, parent_id, is_tagset
209 WHERE used_for LIKE %1";
211 $query .= " AND parent_id = %2";
212 $args[2] = array($parentId, 'Integer');
214 $query .= " ORDER BY name";
215 $dao = CRM_Core_DAO
::executeQuery($query, $args, TRUE, NULL, FALSE, FALSE);
217 // Sort the tags into the correct storage by the parent_id/is_tagset
218 // filter the filter was in place previously, we're just reusing it.
219 // $roots represents the current leaf nodes that need to be checked for
220 // children. $rows represents the unplaced nodes, not all of much
221 // are necessarily placed.
222 $roots = $rows = array();
223 while ($dao->fetch()) {
224 if ($dao->parent_id
== $parentId && $dao->is_tagset
== 0) {
225 $roots[] = array('id' => $dao->id
, 'prefix' => '', 'name' => $dao->name
);
228 $rows[] = array('id' => $dao->id
, 'prefix' => '', 'name' => $dao->name
, 'parent_id' => $dao->parent_id
);
232 // While we have nodes left to build, shift the first (alphabetically)
233 // node of the list, place it in our tags list and loop through the
234 // list of unplaced nodes to find its children. We make a copy to
235 // iterate through because we must modify the unplaced nodes list
237 while (count($roots)) {
238 $new_roots = array();
239 $current_rows = $rows;
240 $root = array_shift($roots);
241 $tags[$root['id']] = array($root['prefix'], $root['name']);
243 // As you find the children, append them to the end of the new set
244 // of roots (maintain alphabetical ordering). Also remove the node
245 // from the set of unplaced nodes.
246 if (is_array($current_rows)) {
247 foreach ($current_rows as $key => $row) {
248 if ($row['parent_id'] == $root['id']) {
249 $new_roots[] = array('id' => $row['id'], 'prefix' => $tags[$root['id']][0] . $separator, 'name' => $row['name']);
255 //As a group, insert the new roots into the beginning of the roots
256 //list. This maintains the hierarchical ordering of the tags.
257 $roots = array_merge($new_roots, $roots);
260 // Prefix each name with the calcuated spacing to give the visual
261 // appearance of ordering when transformed into HTML in the form layer.
262 foreach ($tags as & $tag) {
263 $tag = $tag[0] . $tag[1];
270 * Function to delete the tag
272 * @param int $id tag id
279 static function del($id) {
280 // since this is a destructive operation, lets make sure
281 // id is a postive number
282 CRM_Utils_Type
::validate($id, 'Positive');
284 // delete all crm_entity_tag records with the selected tag id
285 $entityTag = new CRM_Core_DAO_EntityTag();
286 $entityTag->tag_id
= $id;
287 $entityTag->delete();
289 // delete from tag table
290 $tag = new CRM_Core_DAO_Tag();
293 CRM_Utils_Hook
::pre('delete', 'Tag', $id, $tag);
295 if ($tag->delete()) {
296 CRM_Utils_Hook
::post('delete', 'Tag', $id, $tag);
303 * takes an associative array and creates a contact object
305 * The function extract all the params it needs to initialize the create a
306 * contact object. the params array could contain additional unused name/value
309 * @param array $params (reference) an assoc array of name/value pairs
310 * @param array $ids (optional) the array that holds all the db ids - we are moving away from this in bao
313 * @return object CRM_Core_DAO_Tag object on success, otherwise null
317 static function add(&$params, $ids = array()) {
318 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('tag', $ids));
319 if (!$id && !self
::dataExists($params)) {
323 $tag = new CRM_Core_DAO_Tag();
325 // if parent id is set then inherit used for and is hidden properties
326 if (!empty($params['parent_id'])) {
327 // get parent details
328 $params['used_for'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Tag', $params['parent_id'], 'used_for');
331 $tag->copyValues($params);
333 $hook = !$id ?
'create' : 'edit';
334 CRM_Utils_Hook
::pre($hook, 'Tag', $tag->id
, $params);
336 // save creator id and time
338 $session = CRM_Core_Session
::singleton();
339 $tag->created_id
= $session->get('userID');
340 $tag->created_date
= date('YmdHis');
344 CRM_Utils_Hook
::post($hook, 'Tag', $tag->id
, $tag);
346 // if we modify parent tag, then we need to update all children
347 if ($tag->parent_id
=== 'null') {
348 CRM_Core_DAO
::executeQuery("UPDATE civicrm_tag SET used_for=%1 WHERE parent_id = %2",
349 array(1 => array($params['used_for'], 'String'),
350 2 => array($tag->id
, 'Integer'),
359 * Check if there is data to create the object
361 * @param array $params (reference ) an assoc array of name/value pairs
367 static function dataExists(&$params) {
368 // Disallow empty values except for the number zero.
369 // TODO: create a utility for this since it's needed in many places
370 if (!empty($params['name']) ||
(string) $params['name'] === '0') {
378 * Function to get the tag sets for a entity object
380 * @param string $entityTable entity_table
382 * @return array $tagSets array of tag sets
386 static function getTagSet($entityTable) {
388 $query = "SELECT name, id FROM civicrm_tag
389 WHERE is_tagset=1 AND parent_id IS NULL and used_for LIKE %1";
390 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array('%' . $entityTable . '%', 'String')), TRUE, NULL, FALSE, FALSE);
391 while ($dao->fetch()) {
392 $tagSets[$dao->id
] = $dao->name
;
399 * Function to get the tags that are not children of a tagset.
401 * @return array $tags associated array of tag name and id@access public
404 static function getTagsNotInTagset() {
405 $tags = $tagSets = array();
406 // first get all the tag sets
407 $query = "SELECT id FROM civicrm_tag WHERE is_tagset=1 AND parent_id IS NULL";
408 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
409 while ($dao->fetch()) {
410 $tagSets[] = $dao->id
;
414 if (!empty($tagSets)) {
415 $parentClause = ' WHERE ( parent_id IS NULL ) OR ( parent_id NOT IN ( ' . implode(',', $tagSets) . ' ) )';
418 // get that tags that don't have tagset as parent
419 $query = "SELECT id, name FROM civicrm_tag {$parentClause}";
420 $dao = CRM_Core_DAO
::executeQuery($query);
421 while ($dao->fetch()) {
422 $tags[$dao->id
] = $dao->name
;