Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 tag functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Tag | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: Tag.php 30486 2010-11-02 16:12:09Z shot $ | |
38 | */ | |
39 | ||
6a488035 TO |
40 | /** |
41 | * Add a Tag. Tags are used to classify CRM entities (including Contacts, Groups and Actions). | |
42 | * | |
43 | * Allowed @params array keys are: | |
44 | * | |
45 | * {@example TagCreate.php} | |
46 | * | |
47 | * @return array of newly created tag property values. | |
48 | * {@getfields tag_create} | |
49 | * @access public | |
50 | */ | |
51 | function civicrm_api3_tag_create($params) { | |
52 | ||
53 | $ids = array('tag' => CRM_Utils_Array::value('tag', $params)); | |
54 | if (CRM_Utils_Array::value('tag', $params)) { | |
55 | $ids['tag'] = $params['tag']; | |
56 | } | |
57 | if (CRM_Utils_Array::value('id', $params)) { | |
58 | $ids['tag'] = $params['id']; | |
59 | } | |
60 | $tagBAO = CRM_Core_BAO_Tag::add($params, $ids); | |
61 | ||
62 | $values = array(); | |
63 | _civicrm_api3_object_to_array($tagBAO, $values[$tagBAO->id]); | |
64 | return civicrm_api3_create_success($values, $params, 'tag', 'create', $tagBAO); | |
65 | } | |
11e09c59 TO |
66 | |
67 | /** | |
6a488035 TO |
68 | * Specify Meta data for create. Note that this data is retrievable via the getfields function |
69 | * and is used for pre-filling defaults and ensuring mandatory requirements are met. | |
70 | */ | |
71 | function _civicrm_api3_tag_create_spec(&$params) { | |
72 | $params['used_for']['api.default'] = 'civicrm_contact'; | |
73 | $params['name']['api.required'] = 1; | |
74 | } | |
75 | ||
76 | /** | |
77 | * Deletes an existing Tag | |
78 | * | |
79 | * @param array $params | |
80 | * | |
81 | * @example TagDelete.ph | |
82 | * | |
83 | * @return boolean | error true if successfull, error otherwise | |
84 | * {@getfields tag_delete} | |
85 | * @access public | |
86 | */ | |
87 | function civicrm_api3_tag_delete($params) { | |
88 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
89 | } | |
90 | ||
91 | /** | |
92 | * Get a Tag. | |
93 | * | |
94 | * This api is used for finding an existing tag. | |
95 | * Either id or name of tag are required parameters for this api. | |
96 | * | |
97 | * @example TagGet.php | |
98 | * | |
99 | * @param array $params an associative array of name/value pairs. | |
100 | * | |
101 | * @return array details of found tags else error | |
102 | * {@getfields tag_get} | |
103 | * @access public | |
104 | */ | |
105 | function civicrm_api3_tag_get($params) { | |
106 | ||
107 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
108 | } | |
109 |