20183361fca5be4ad62956d5ad2474a218d437bb
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 $
39 * Add a Tag. Tags are used to classify CRM entities (including Contacts, Groups and Actions).
41 * Allowed @params array keys are:
43 * {@example TagCreate.php}
45 * @param array $params
47 * @return array of newly created tag property values.
48 * {@getfields tag_create}
51 function civicrm_api3_tag_create($params) {
52 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
56 * Specify Meta data for create. 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 * Deletes an existing Tag
70 * @param array $params
72 * @example TagDelete.ph
74 * @return array API result array
75 * {@getfields tag_delete}
78 function civicrm_api3_tag_delete($params) {
79 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
85 * This api is used for finding an existing tag.
86 * Either id or name of tag are required parameters for this api.
90 * @param array $params an associative array of name/value pairs.
92 * @return array details of found tags else error
93 * {@getfields tag_get}
96 function civicrm_api3_tag_get($params) {
98 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);