api/v3/OptionValue.php

   1 <?php
   2
   3 /**
   4  * Retrieve one or more OptionValues
   5  *
   6  * @param array $params
   7  *
   8  * {@example OptionValueGet.php 0}
   9  * @example OptionValueGet.php
  10  *
  11  * @return array
  12  *   details of found Option Values
  13  * {@getfields OptionValue_get}
  14  * @access public
  15  */
  16 function civicrm_api3_option_value_get($params) {
  17
  18   if (empty($params['option_group_id']) && !empty($params['option_group_name'])) {
  19     $opt = array('version' => 3, 'name' => $params['option_group_name']);
  20     $optionGroup = civicrm_api('OptionGroup', 'Get', $opt);
  21     if (empty($optionGroup['id'])) {
  22       return civicrm_api3_create_error("option group name does not correlate to a single option group");
  23     }
  24     $params['option_group_id'] = $optionGroup['id'];
  25   }
  26
  27   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  28 }
  29
  30 /**
  31  *  Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
  32  *
  33  * Allowed @params array keys are:
  34  *
  35  * {@example OptionValueCreate.php}
  36  *
  37  * @param array $params
  38  *
  39  * @throws API_Exception
  40  * @return array
  41  *   Array of newly created option_value property values.
  42  * {@getfields OptionValue_create}
  43  * @access public
  44  */
  45 function civicrm_api3_option_value_create($params) {
  46   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  47   if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
  48     $groupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
  49       $params['id'], 'option_group_id', 'id'
  50     );
  51   }
  52   else {
  53     $groupId = $params['option_group_id'];
  54   }
  55
  56   civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
  57   return $result;
  58 }
  59
  60 /**
  61  * Adjust Metadata for Create action
  62  *
  63  * The metadata is used for setting defaults, documentation & validation
  64  * @param array $params
  65  *   Array or parameters determined by getfields.
  66  */
  67 function _civicrm_api3_option_value_create_spec(&$params) {
  68   $params['is_active']['api.default'] = 1;
  69   //continue to support component
  70   $params['component_id']['api.aliases'] = array('component');
  71   $params['name']['api.aliases'] = array('label');
  72   $params['option_group_id']['api.required'] = TRUE;
  73 }
  74
  75 /**
  76  * Deletes an existing OptionValue
  77  *
  78  * @param array $params
  79  *
  80  * {@example OptionValueDelete.php 0}
  81  *
  82  * @return array
  83  *   Api result
  84  * {@getfields OptionValue_create}
  85  * @access public
  86  */
  87 function civicrm_api3_option_value_delete($params) {
  88   // we will get the option group id before deleting so we can flush pseudoconstants
  89   $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
  90   if (CRM_Core_BAO_OptionValue::del((int) $params['id'])) {
  91     civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
  92     return civicrm_api3_create_success();
  93   }
  94   else {
  95     civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);
  96   }
  97 }