api/v3/OptionGroup.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 option groups.
  30  *
  31  * OptionGroups are containers for option values.
  32  *
  33  * @package CiviCRM_APIv3
  34  */
  35
  36 /**
  37  * Get option groups.
  38  *
  39  * @param array $params
  40  *
  41  * @return array
  42  */
  43 function civicrm_api3_option_group_get($params) {
  44   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  45 }
  46
  47 /**
  48  * Create/update option group.
  49  *
  50  * @param array $params
  51  *   Array per getfields metadata.
  52  *
  53  * @return array
  54  */
  55 function civicrm_api3_option_group_create($params) {
  56   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'OptionGroup');
  57   civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1));
  58   return $result;
  59 }
  60
  61 /**
  62  * Adjust Metadata for Create action.
  63  *
  64  * The metadata is used for setting defaults, documentation & validation.
  65  *
  66  * @param array $params
  67  *   Array of parameters determined by getfields.
  68  */
  69 function _civicrm_api3_option_group_create_spec(&$params) {
  70   $params['name']['api.unique'] = 1;
  71   $params['is_active']['api.default'] = TRUE;
  72 }
  73
  74 /**
  75  * Delete an existing Option Group.
  76  *
  77  * This method is used to delete any existing OptionGroup given its id.
  78  *
  79  * @param array $params
  80  *   [id]
  81  *
  82  * @return array
  83  *   API Result Array
  84  */
  85 function civicrm_api3_option_group_delete($params) {
  86   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }