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