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 * File for the CiviCRM APIv3 tag functions
31 * @package CiviCRM_APIv3
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Tag.php 30486 2010-11-02 16:12:09Z shot $
41 * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
43 * @param array $params
44 * Array per getfields metadata.
48 function civicrm_api3_tag_create($params) {
49 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
53 * Specify Meta data for create.
55 * Note that this data is retrievable via the getfields function
56 * and is used for pre-filling defaults and ensuring mandatory requirements are met.
58 * @param array $params
60 function _civicrm_api3_tag_create_spec(&$params) {
61 $params['used_for']['api.default'] = 'civicrm_contact';
62 $params['name']['api.required'] = 1;
63 $params['id']['api.aliases'] = array('tag');
67 * Delete an existing Tag.
69 * @param array $params
74 function civicrm_api3_tag_delete($params) {
75 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
81 * This api is used for finding an existing tag.
82 * Either id or name of tag are required parameters for this api.
84 * @param array $params
85 * Array per getfields metadata.
88 * details of found tags else error
90 function civicrm_api3_tag_get($params) {
92 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);