Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
b081365f | 29 | * This api exposes CiviCRM tags. |
6a488035 | 30 | * |
b081365f | 31 | * Tags are used to classify CRM entities (including Contacts, Groups and Actions). |
6a488035 | 32 | * |
b081365f CW |
33 | * @note this api is for working with tags themselves. To add/remove tags from |
34 | * a contact or other entity, use the EntityTag api. | |
35 | * | |
36 | * @package CiviCRM_APIv3 | |
6a488035 TO |
37 | */ |
38 | ||
6a488035 | 39 | /** |
b081365f | 40 | * Create or update a tag. |
2fb1dd66 EM |
41 | * |
42 | * Tags are used to classify CRM entities (including Contacts, Groups and Actions). | |
6a488035 | 43 | * |
c490a46a | 44 | * @param array $params |
2e66abf8 | 45 | * Array per getfields metadata. |
77b97be7 | 46 | * |
a6c01b45 | 47 | * @return array |
00f8641b | 48 | * API result array |
6a488035 TO |
49 | */ |
50 | function civicrm_api3_tag_create($params) { | |
d989d349 | 51 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
52 | } | |
11e09c59 TO |
53 | |
54 | /** | |
2fb1dd66 EM |
55 | * Specify Meta data for create. |
56 | * | |
57 | * Note that this data is retrievable via the getfields function | |
6a488035 | 58 | * and is used for pre-filling defaults and ensuring mandatory requirements are met. |
9657ccf2 EM |
59 | * |
60 | * @param array $params | |
6a488035 TO |
61 | */ |
62 | function _civicrm_api3_tag_create_spec(&$params) { | |
63 | $params['used_for']['api.default'] = 'civicrm_contact'; | |
64 | $params['name']['api.required'] = 1; | |
641cb0ba | 65 | $params['id']['api.aliases'] = array('tag'); |
6a488035 TO |
66 | } |
67 | ||
68 | /** | |
2fb1dd66 | 69 | * Delete an existing Tag. |
6a488035 | 70 | * |
cf470720 | 71 | * @param array $params |
6a488035 | 72 | * |
a6c01b45 | 73 | * @return array |
72b3a70c | 74 | * API result array |
6a488035 TO |
75 | */ |
76 | function civicrm_api3_tag_delete($params) { | |
77 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } | |
79 | ||
80 | /** | |
81 | * Get a Tag. | |
82 | * | |
83 | * This api is used for finding an existing tag. | |
84 | * Either id or name of tag are required parameters for this api. | |
85 | * | |
cf470720 | 86 | * @param array $params |
2e66abf8 | 87 | * Array per getfields metadata. |
6a488035 | 88 | * |
a6c01b45 | 89 | * @return array |
00f8641b | 90 | * API result array |
6a488035 TO |
91 | */ |
92 | function civicrm_api3_tag_get($params) { | |
93 | ||
94 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
95 | } |