X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FCustomField.php;h=2cea880732ab606f03fbd7a5d59564cd27d6a33c;hb=f36c9ebc31dd6049ad9e6821b6f0b18bb3c4820d;hp=cd1574e7427ea82aedddd02822a5554c7b12ef6b;hpb=95ca1e4e775ce88e3f371abe8390a3526ba537e7;p=civicrm-core.git diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index cd1574e742..2cea880732 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -1,10 +1,9 @@ value pairs - * as parameters. Some of the most commonly used parameters are - * described below - * - * @param array $params an associative array used in construction - * retrieval of the object - * */ /** * Create a 'custom field' within a custom field group. + * * We also empty the static var in the getfields * function after deletion so that the field is available for us (getfields manages date conversion * among other things * - * @param $params array Associative array of property name/value pairs to create new custom field. - * - * @return Newly API success object - * - * @access public - * - * @example CustomFieldCreate.php - * {@getfields CustomField_create} - * {@example CustomFieldCreate.php 0} + * @param array $params + * Array per getfields metadata. * + * @return array + * API success array */ function civicrm_api3_custom_field_create($params) { - // Array created for passing options in params + // Array created for passing options in params. if (isset($params['option_values']) && is_array($params['option_values'])) { + $weight = 0; foreach ($params['option_values'] as $key => $value) { + // Translate simple key/value pairs into full-blown option values + if (!is_array($value)) { + $value = array( + 'label' => $value, + 'value' => $key, + 'is_active' => 1, + 'weight' => $weight, + ); + $key = $weight++; + } $params['option_label'][$key] = $value['label']; $params['option_value'][$key] = $value['value']; $params['option_status'][$key] = $value['is_active']; @@ -78,27 +70,35 @@ function civicrm_api3_custom_field_create($params) { $customField = CRM_Core_BAO_CustomField::create($params); _civicrm_api3_object_to_array_unique_fields($customField, $values[$customField->id]); _civicrm_api3_custom_field_flush_static_caches(); - return civicrm_api3_create_success($values, $params, 'custom_field', $customField); + return civicrm_api3_create_success($values, $params, 'CustomField', $customField); } /** - * Flush static caches in functions that might have stored available custom fields + * Flush static caches in functions that might have stored available custom fields. */ -function _civicrm_api3_custom_field_flush_static_caches(){ - civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1)); +function _civicrm_api3_custom_field_flush_static_caches() { + civicrm_api('CustomField', 'getfields', array('version' => 3, 'cache_clear' => 1)); CRM_Core_BAO_UFField::getAvailableFieldsFlat(TRUE); } + /** - * Adjust Metadata for Create action + * Adjust Metadata for Create action. * - * @param array $params array or parameters determined by getfields + * @param array $params + * Array of parameters determined by getfields. */ function _civicrm_api3_custom_field_create_spec(&$params) { $params['label']['api.required'] = 1; $params['custom_group_id']['api.required'] = 1; $params['is_active']['api.default'] = 1; + $params['option_values'] = array( + 'title' => 'Option Values', + 'description' => "Pass an array of options (value => label) to create this field's option values", + ); + // TODO: Why expose this to the api at all? $params['option_type'] = array( - 'title' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate', + 'title' => 'Option Type', + 'description' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate', 'api.default' => 1, 'type' => CRM_Utils_Type::T_BOOLEAN, ); @@ -107,58 +107,56 @@ function _civicrm_api3_custom_field_create_spec(&$params) { } /** - * Use this API to delete an existing custom group field. + * Use this API to delete an existing custom field. * - * @param $params Array id of the field to be deleted + * @param array $params + * Array id of the field to be deleted. * * @return array - * @example CustomFieldDelete.php - * - * {@example CustomFieldDelete.php 0} - * {@getfields CustomField_delete} - * @access public - **/ + */ function civicrm_api3_custom_field_delete($params) { - $field = new CRM_Core_BAO_CustomField(); $field->id = $params['id']; $field->find(TRUE); $customFieldDelete = CRM_Core_BAO_CustomField::deleteField($field); - civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1)); + civicrm_api('CustomField', 'getfields', array('version' => 3, 'cache_clear' => 1)); return $customFieldDelete ? civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success(); } /** * Use this API to get existing custom fields. * - * @param array $params Array to search on - *{* + * @param array $params + * Array to search on. * * @return array -@getfields CustomField_get} - * @access public - * - **/ + */ function civicrm_api3_custom_field_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * Helper function to validate custom field value + * Helper function to validate custom field value. + * * @deprecated * - * @param String $fieldName Custom field name (eg: custom_8 ) - * @param Mixed $value Field value to be validate - * @param Array $fieldDetails Field Details - * @param Array $errors Collect validation errors + * @param string $fieldName + * Custom field name (eg: custom_8 ). + * @param mixed $value + * Field value to be validate. + * @param array $fieldDetails + * Field Details. + * @param array $errors + * Collect validation errors. * - * @return array Validation errors + * @return array|NULL + * Validation errors * @todo remove this function - not in use but need to review functionality before * removing as it might be useful in wrapper layer */ function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = array()) { - return; - //see comment block + return NULL; + //see comment block if (!$value) { return $errors; } @@ -263,11 +261,16 @@ SELECT count(*) } /** - * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field + * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field. + * + * @param array $params + * Array per getfields metadata. + * + * @return array */ function civicrm_api3_custom_field_setvalue($params) { require_once 'api/v3/Generic/Setvalue.php'; - $result = civicrm_api3_generic_setValue(array("entity" => 'custom_field', 'params' => $params)); + $result = civicrm_api3_generic_setValue(array("entity" => 'CustomField', 'params' => $params)); if (empty($result['is_error'])) { CRM_Utils_System::flushCache(); }