api/v3/OptionValue.php

   1 <?php
   2
   3 /**
   4  * Retrieve one or more OptionValues
   5  *
   6  * @param $params
   7  *
   8  * @internal param $array $ params input parameters
   9  *
  10  * {@example OptionValueGet.php 0}
  11  * @example OptionValueGet.php
  12  *
  13  * @return  array details of found Option Values
  14  * {@getfields OptionValue_get}
  15  * @access public
  16  */
  17 function civicrm_api3_option_value_get($params) {
  18
  19   if (empty($params['option_group_id']) && !empty($params['option_group_name'])) {
  20     $opt = array('version' => 3, 'name' => $params['option_group_name']);
  21     $optionGroup = civicrm_api('OptionGroup', 'Get', $opt);
  22     if (empty($optionGroup['id'])) {
  23       return civicrm_api3_create_error("option group name does not correlate to a single option group");
  24     }
  25     $params['option_group_id'] = $optionGroup['id'];
  26   }
  27
  28   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  29 }
  30
  31 /**
  32  *  Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
  33  *
  34  * Allowed @params array keys are:
  35  *
  36  * {@example OptionValueCreate.php}
  37  *
  38  * @param $params
  39  *
  40  * @throws API_Exception
  41  * @return 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 array or parameters determined by getfields
  65  */
  66 function _civicrm_api3_option_value_create_spec(&$params) {
  67   $params['is_active']['api.default'] = 1;
  68   //continue to support component
  69   $params['component_id']['api.aliases'] = array('component');
  70   $params['name']['api.aliases'] = array('label');
  71   $params['option_group_id']['api.required'] = TRUE;
  72 }
  73
  74 /**
  75  * Deletes an existing OptionValue
  76  *
  77  * @param  array  $params
  78  *
  79  * {@example OptionValueDelete.php 0}
  80  *
  81  * @return array Api result
  82  * {@getfields OptionValue_create}
  83  * @access public
  84  */
  85 function civicrm_api3_option_value_delete($params) {
  86   // we will get the option group id before deleting so we can flush pseudoconstants
  87   $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
  88   if(CRM_Core_BAO_OptionValue::del((int) $params['id'])){
  89     civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
  90     return civicrm_api3_create_success();
  91   }
  92   else{
  93     civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);
  94   }
  95 }
  96