phpdoc params is always an array in api

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

diff --git a/api/v3/UFField.php b/api/v3/UFField.php
index 2e9cf6794462ad5eacaa7191717a023bd4cafc5e..489c2c54ec36aa863a9f4d52297c2e16a80a1dfc 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                                |
  +--------------------------------------------------------------------+
@@ -40,12 +39,13 @@
 /**
  * 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 Associative array of property name/value pairs to create new uf field.
  *
  * @throws API_Exception
- * @internal param int $groupId Valid uf_group id
  *
- * @return Newly created $ufFieldArray array
+ * @return array
+ *   Newly created $ufFieldArray
  *
  * @access public
  * {@getfields UFField_create}
@@ -112,9 +112,10 @@ function civicrm_api3_uf_field_create($params) {
 /**
  * Gets field for civicrm_uf_field create
  *
- * @param $params
+ * @param array $params
  *
- * @return array fields valid for other functions
+ * @return array
+ *   fields valid for other functions
  */
 function _civicrm_api3_uf_field_create_spec(&$params) {
   $params['option.autoweight'] = array(
@@ -123,17 +124,20 @@ function _civicrm_api3_uf_field_create_spec(&$params) {
     'api.default' => TRUE,
   );
   $params['created_id']['api.default'] = 'user_contact_id';
+  $params['created_id']['title']  = 'Created By';
   $params['is_active']['api.default'] = TRUE;
 }
 
 /**
  * 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
+ * @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
  *
- * @return array  (reference) Array
+ * @return array
+ *   (reference) Array
  * {@getfields UFField_get
  * @example UFFieldGet.php
  * @access public
@@ -145,12 +149,11 @@ function civicrm_api3_uf_field_get($params) {
 /**
  * Delete uf field
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @internal param int $fieldId Valid uf_field id that to be deleted
  *
- * @return true on successful delete or return error
+ * @return array
  *
  * @access public
  * {@getfields UFField_delete}
@@ -171,11 +174,12 @@ function civicrm_api3_uf_field_delete($params) {
 
   return civicrm_api3_create_success($result, $params);
 }
+
 /**
  * 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');
 }
-