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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM tags.
31 * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
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.
36 * @package CiviCRM_APIv3
40 * Create or update a tag.
42 * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
44 * @param array $params
45 * Array per getfields metadata.
49 function civicrm_api3_tag_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Specify Meta data for create.
56 * Note that this data is retrievable via the getfields function
57 * and is used for pre-filling defaults and ensuring mandatory requirements are met.
59 * @param array $params
61 function _civicrm_api3_tag_create_spec(&$params) {
62 $params['used_for']['api.default'] = 'civicrm_contact';
63 $params['name']['api.required'] = 1;
64 $params['id']['api.aliases'] = array('tag');
68 * Delete an existing Tag.
70 * @param array $params
75 function civicrm_api3_tag_delete($params) {
76 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
82 * This api is used for finding an existing tag.
83 * Either id or name of tag are required parameters for this api.
85 * @param array $params
86 * Array per getfields metadata.
89 * details of found tags else error
91 function civicrm_api3_tag_get($params) {
93 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);