Merge branch 4.5 into master

[civicrm-core.git] / api / v3 / UFField.php

diff --git a/api/v3/UFField.php b/api/v3/UFField.php
index 13652074dffc0515f4c86761c5881cf22d27e8df..38790df84138faa1c60a8f20d875843b73302b2f 100644 (file)
--- a/api/v3/UFField.php
+++ b/api/v3/UFField.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -34,21 +33,18 @@
  *
  * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: UFField.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
  * Defines 'uf field' within a group.
  *
- * @param $params  array  Associative array of property name/value pairs to create new uf field.
+ * @param array $params
+ *   Array per getfields metadata.
  *
  * @throws API_Exception
  *
- * @return array Newly created $ufFieldArray
- *
- * @access public
- * {@getfields UFField_create}
- * @example UFFieldCreate.php
+ * @return array
+ *   Newly created $ufFieldArray
  */
 function civicrm_api3_uf_field_create($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('field_name', 'uf_group_id'));
@@ -62,7 +58,7 @@ function civicrm_api3_uf_field_create($params) {
   $location_type_id = CRM_Utils_Array::value('location_type_id', $params);
   $phone_type       = CRM_Utils_Array::value('phone_type_id', $params, CRM_Utils_Array::value('phone_type', $params));
 
-  if (! CRM_Core_BAO_UFField::isValidFieldName($field_name)) {
+  if (!CRM_Core_BAO_UFField::isValidFieldName($field_name)) {
     throw new API_Exception('The field_name is not valid');
   }
   $params['field_name'] = array($field_type, $field_name, $location_type_id, $phone_type);
@@ -109,11 +105,9 @@ function civicrm_api3_uf_field_create($params) {
 }
 
 /**
- * Gets field for civicrm_uf_field create
+ * Adjust metadata for civicrm_uf_field create.
  *
  * @param array $params
- *
- * @return array fields valid for other functions
  */
 function _civicrm_api3_uf_field_create_spec(&$params) {
   $params['option.autoweight'] = array(
@@ -127,33 +121,25 @@ function _civicrm_api3_uf_field_create_spec(&$params) {
 }
 
 /**
- * Returns array of uf groups (profiles)  matching a set of one or more group properties
+ * Returns array of uf groups (profiles) matching a set of one or more group properties.
  *
- * @param array $params  (reference) Array of one or more valid
- *                       property_name=>value pairs. If $params is set
- *                       as null, all surveys will be returned
+ * @param array $params
+ *   Array per getfields metadata.
  *
- * @return array  (reference) Array
- * {@getfields UFField_get
- * @example UFFieldGet.php
- * @access public
+ * @return array
  */
 function civicrm_api3_uf_field_get($params) {
   return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
 }
 
 /**
- * Delete uf field
+ * Delete uf field.
  *
  * @param array $params
  *
  * @throws API_Exception
  *
- * @return true on successful delete or return error
- *
- * @access public
- * {@getfields UFField_delete}
- * @example UFFieldDelete.php
+ * @return array
  */
 function civicrm_api3_uf_field_delete($params) {
   $fieldId = $params['id'];
@@ -170,11 +156,13 @@ function civicrm_api3_uf_field_delete($params) {
 
   return civicrm_api3_create_success($result, $params);
 }
+
 /**
- * field id accepted for backward compatibility - unset required on id
+ * Field id accepted for backward compatibility - unset required on id.
+ *
+ * @param array $params
  */
 function _civicrm_api3_uf_field_delete_spec(&$params) {
   // legacy support for field_id
   $params['id']['api.aliases'] = array('field_id');
 }
-