<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
*/
/**
- * File for the CiviCRM APIv3 custom group functions
+ * This api exposes CiviCRM custom field.
*
* @package CiviCRM_APIv3
- * @subpackage API_CustomField
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $
*/
/**
* 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.
+ * @param array $params
+ * Array per getfields metadata.
*
* @return array
* API success array
- *
- * @access public
- *
- * @example CustomFieldCreate.php
- * {@getfields CustomField_create}
- * {@example CustomFieldCreate.php 0}
- *
*/
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'])) {
foreach ($params['option_values'] as $key => $value) {
$params['option_label'][$key] = $value['label'];
}
/**
- * 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));
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_custom_field_create_spec(&$params) {
$params['label']['api.required'] = 1;
}
/**
- * Use this API to delete an existing custom group field.
+ * Use this API to delete an existing custom field.
*
- * @param $params
+ * @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'];
* 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
* @param array $errors
* Collect validation errors.
*
- * @return array
+ * @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;
+ return NULL;
//see comment block
if (!$value) {
return $errors;
}
/**
- * 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';