X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FOptionValue.php;h=c3120527cb2770b6a2632fccbb5d421394217ac5;hb=2b37475d476ba66508442e90931e40e89e786ef0;hp=6f83e2b564537dce44f8ec7ed9e3df9d059bdaa2;hpb=a5cea5e90a3ad463c363d53c49ed0bb1b6868dbc;p=civicrm-core.git diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index 6f83e2b564..c3120527cb 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -3,14 +3,12 @@ /** * Retrieve one or more OptionValues * - * @param $params - * - * @internal param $array $ params input parameters + * @param array $params * * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -35,7 +33,7 @@ function civicrm_api3_option_value_get($params) { * * {@example OptionValueCreate.php} * - * @param $params + * @param array $params * * @throws API_Exception * @return array of newly created option_value property values. @@ -61,7 +59,8 @@ function civicrm_api3_option_value_create($params) { * Adjust Metadata for Create action * * The metadata is used for setting defaults, documentation & validation - * @param array $params array or parameters determined by getfields + * @param array $params + * Array or parameters determined by getfields. */ function _civicrm_api3_option_value_create_spec(&$params) { $params['is_active']['api.default'] = 1; @@ -74,7 +73,7 @@ function _civicrm_api3_option_value_create_spec(&$params) { /** * Deletes an existing OptionValue * - * @param array $params + * @param array $params * * {@example OptionValueDelete.php 0} * @@ -85,12 +84,11 @@ function _civicrm_api3_option_value_create_spec(&$params) { function civicrm_api3_option_value_delete($params) { // we will get the option group id before deleting so we can flush pseudoconstants $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id')); - if(CRM_Core_BAO_OptionValue::del((int) $params['id'])){ + if (CRM_Core_BAO_OptionValue::del((int) $params['id'])) { civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID)); return civicrm_api3_create_success(); } - else{ + else { civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']); } } -