api/v3/OptionGroup.php

   1 <?php
   2
   3 /**
   4  * Get option groups.
   5  *
   6  * @param array $params
   7  *
   8  * @return array
   9  */
  10 function civicrm_api3_option_group_get($params) {
  11   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  12 }
  13
  14 /**
  15  * Create/update option group.
  16  *
  17  * @param array $params
  18  *   Array per getfields metadata.
  19  *
  20  * @return array
  21  */
  22 function civicrm_api3_option_group_create($params) {
  23   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  24 }
  25
  26 /**
  27  * Adjust Metadata for Create action.
  28  *
  29  * The metadata is used for setting defaults, documentation & validation.
  30  *
  31  * @param array $params
  32  *   Array or parameters determined by getfields.
  33  */
  34 function _civicrm_api3_option_group_create_spec(&$params) {
  35   $params['name']['api.unique'] = 1;
  36 }
  37
  38 /**
  39  * Delete an existing Option Group.
  40  *
  41  * This method is used to delete any existing Option Group. id of the group
  42  * to be deleted is required field in $params array
  43  *
  44  * @param array $params
  45  *   Array containing id of the group.
  46  *                       to be deleted
  47  *
  48  * @return array
  49  *   API Result Array
  50  */
  51 function civicrm_api3_option_group_delete($params) {
  52   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  53 }