api/v3/Tag.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM tag.
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Tag
  33  *
  34  */
  35
  36 /**
  37  * Add a Tag.
  38  *
  39  * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
  40  *
  41  * @param array $params
  42  *   Array per getfields metadata.
  43  *
  44  * @return array
  45  */
  46 function civicrm_api3_tag_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  48 }
  49
  50 /**
  51  * Specify Meta data for create.
  52  *
  53  * Note that this data is retrievable via the getfields function
  54  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
  55  *
  56  * @param array $params
  57  */
  58 function _civicrm_api3_tag_create_spec(&$params) {
  59   $params['used_for']['api.default'] = 'civicrm_contact';
  60   $params['name']['api.required'] = 1;
  61   $params['id']['api.aliases'] = array('tag');
  62 }
  63
  64 /**
  65  * Delete an existing Tag.
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  *   API result array
  71  */
  72 function civicrm_api3_tag_delete($params) {
  73   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  74 }
  75
  76 /**
  77  * Get a Tag.
  78  *
  79  * This api is used for finding an existing tag.
  80  * Either id or name of tag are required parameters for this api.
  81  *
  82  * @param array $params
  83  *   Array per getfields metadata.
  84  *
  85  * @return array
  86  *   details of found tags else error
  87  */
  88 function civicrm_api3_tag_get($params) {
  89
  90   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }