api/v3/Tag.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  * File for the CiviCRM APIv3 tag functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Tag
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2013
  35  * @version $Id: Tag.php 30486 2010-11-02 16:12:09Z shot $
  36  */
  37
  38 /**
  39  *  Add a Tag. Tags are used to classify CRM entities (including Contacts, Groups and Actions).
  40  *
  41  * Allowed @params array keys are:
  42  *
  43  * {@example TagCreate.php}
  44  *
  45  * @return array of newly created tag property values.
  46  * {@getfields tag_create}
  47  * @access public
  48  */
  49 function civicrm_api3_tag_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Specify Meta data for create. Note that this data is retrievable via the getfields function
  55  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
  56  */
  57 function _civicrm_api3_tag_create_spec(&$params) {
  58   $params['used_for']['api.default'] = 'civicrm_contact';
  59   $params['name']['api.required'] = 1;
  60   $params['id']['api.aliases'] = array('tag');
  61 }
  62
  63 /**
  64  * Deletes an existing Tag
  65  *
  66  * @param  array  $params
  67  *
  68  * @example TagDelete.ph
  69  *
  70  * @return boolean | error  true if successfull, error otherwise
  71  * {@getfields tag_delete}
  72  * @access public
  73  */
  74 function civicrm_api3_tag_delete($params) {
  75   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  * Get a Tag.
  80  *
  81  * This api is used for finding an existing tag.
  82  * Either id or name of tag are required parameters for this api.
  83  *
  84  * @example TagGet.php
  85  *
  86  * @param  array $params  an associative array of name/value pairs.
  87  *
  88  * @return  array details of found tags else error
  89  * {@getfields tag_get}
  90  * @access public
  91  */
  92 function civicrm_api3_tag_get($params) {
  93
  94   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95 }
  96