api/v3/Tag.php

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