api/v3/OptionValue.php

   1 <?php
   2 // $Id$
   3
   4 /**
   5  * Retrieve one or more OptionValues
   6  *
   7  * @param  array  $ params input parameters
   8  *
   9  * {@example OptionValueGet.php 0}
  10  * @example OptionValueGet.php
  11  *
  12  * @return  array 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  * @return array of newly created option_value property values.
  38  * {@getfields OptionValue_create}
  39  * @access public
  40  */
  41 function civicrm_api3_option_value_create($params) {
  42
  43   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  44   civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $params['option_group_id']));
  45   return $result;
  46 }
  47
  48 /**
  49  * Adjust Metadata for Create action
  50  *
  51  * The metadata is used for setting defaults, documentation & validation
  52  * @param array $params array or parameters determined by getfields
  53  */
  54 function _civicrm_api3_option_value_create_spec(&$params) {
  55   $params['is_active']['api.default'] = 1;
  56   //continue to support component
  57   $params['component_id']['api.aliases'] = array('component');
  58   $params['name']['api.aliases'] = array('label');
  59   $params['option_group_id']['api.required'] = TRUE;
  60 }
  61
  62 /**
  63  * Deletes an existing OptionValue
  64  *
  65  * @param  array  $params
  66  *
  67  * {@example OptionValueDelete.php 0}
  68  *
  69  * @return array Api result
  70  * {@getfields OptionValue_create}
  71  * @access public
  72  */
  73 function civicrm_api3_option_value_delete($params) {
  74   // we will get the option group id before deleting so we can flush pseudoconstants
  75   $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
  76   if(CRM_Core_BAO_OptionValue::del((int) $params['id'])){
  77     civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
  78     return civicrm_api3_create_success();
  79   }
  80   else{
  81     civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);
  82   }
  83 }
  84