From 2e66abf8190dde0439f825a12234323404ea49ef Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 19:40:51 +1300 Subject: [PATCH] comment fixes --- api/Exception.php | 2 ++ api/v3/Address.php | 22 ++++++++-------------- api/v3/ContactType.php | 3 +-- api/v3/ContributionPage.php | 29 +++++++++-------------------- api/v3/ContributionRecur.php | 6 ++---- api/v3/ContributionSoft.php | 10 +++++----- api/v3/Country.php | 25 +++++++------------------ api/v3/CustomField.php | 15 ++++++++++----- api/v3/CustomGroup.php | 18 ++++-------------- api/v3/DashboardContact.php | 9 +++++---- api/v3/Email.php | 20 ++++++++------------ api/v3/File.php | 15 ++++----------- api/v3/Grant.php | 23 ++++++----------------- api/v3/MailingEventQueue.php | 10 +++++++--- api/v3/Phone/Get.php | 2 +- api/v3/PriceField.php | 10 +++------- api/v3/RelationshipType.php | 2 +- api/v3/SmsProvider.php | 19 +++---------------- api/v3/Survey.php | 13 ++++--------- api/v3/Tag.php | 12 ++---------- api/v3/UFField.php | 2 +- api/v3/UFGroup.php | 2 +- api/v3/UFJoin.php | 2 +- 23 files changed, 95 insertions(+), 176 deletions(-) diff --git a/api/Exception.php b/api/Exception.php index 406997be46..8ec7eb3ae6 100644 --- a/api/Exception.php +++ b/api/Exception.php @@ -24,6 +24,8 @@ class API_Exception extends Exception { private $extraParams = array(); /** + * Class constructor. + * * @param string $message * The human friendly error message. * @param mixed $error_code diff --git a/api/v3/Address.php b/api/v3/Address.php index 6cbf1d9e72..463490bd18 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -36,13 +36,10 @@ */ /** - * Add an Address for a contact - * - * Allowed @params array keys are: - * {@getfields address_create} - * {@example AddressCreate.php} + * Add an Address for a contact. * * @param array $params + * Array per getfields metadata. * * @return array * Array of newly created tag property values. @@ -108,10 +105,10 @@ function _civicrm_api3_address_create_spec(&$params) { ); } /** - * Adjust Metadata for Get action + * Adjust Metadata for Get action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_address_get_spec(&$params) { $params['world_region'] = array( @@ -122,12 +119,10 @@ function _civicrm_api3_address_get_spec(&$params) { } /** - * Deletes an existing Address + * Delete an existing Address. * * @param array $params - * - * {@getfields address_delete} - * {@example AddressDelete.php 0} + * Array per getfields metadata. * * @return array * api result array @@ -137,11 +132,10 @@ function civicrm_api3_address_delete($params) { } /** - * Retrieve one or more addresses on address_id, contact_id, street_name, city - * or a combination of those + * Retrieve one or more addresses. * * @param array $params - * An associative array of name/value pairs. + * Array per getfields metadata. * * @return array * details of found addresses else error diff --git a/api/v3/ContactType.php b/api/v3/ContactType.php index 5eb990eda5..9200a210b8 100644 --- a/api/v3/ContactType.php +++ b/api/v3/ContactType.php @@ -41,8 +41,7 @@ * be in $params array. * * @param array $params - * (reference) Associative array of property. - * name/value pairs to insert in new 'contact_type' + * Array per getfields metadata. * * @return array * contact_type array diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php index 0c838cb4af..a2ac132a9d 100644 --- a/api/v3/ContributionPage.php +++ b/api/v3/ContributionPage.php @@ -35,16 +35,13 @@ */ /** - * Create or update a contribution_page + * Create or update a contribution_page. * * @param array $params - * Associative array of property. - * name/value pairs to insert in new 'contribution_page' - * @example ContributionPageCreate.php Std Create example + * Array per getfields metadata. * * @return array * api result array - * {@getfields contribution_page_create} */ function civicrm_api3_contribution_page_create($params) { $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -59,7 +56,7 @@ function civicrm_api3_contribution_page_create($params) { * The metadata is used for setting defaults, documentation & validation. * * @param array $params - * Array or parameters determined by getfields. + * Array per getfields metadata. */ function _civicrm_api3_contribution_page_create_spec(&$params) { $params['financial_type_id']['api.required'] = 1; @@ -68,50 +65,42 @@ function _civicrm_api3_contribution_page_create_spec(&$params) { } /** - * Returns array of contribution_pages matching a set of one or more group properties + * Returns array of contribution_pages matching a set of one or more group properties. * * @param array $params - * Array of one or more valid property_name=>value pairs. + * Array per getfields metadata. * * @return array * API Result array Array of matching contribution_pages - * {@getfields contribution_page_get} */ function civicrm_api3_contribution_page_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * delete an existing contribution_page + * Delete an existing contribution_page. * * This method is used to delete any existing contribution_page. id of the group * to be deleted is required field in $params array * * @param array $params - * Array containing id of the group. - * to be deleted + * Array per getfields metadata. * * @return array * API result Array - * {@getfields contribution_page_delete} */ function civicrm_api3_contribution_page_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * delete an existing contribution_page - * - * This method is used to delete any existing contribution_page. id of the group - * to be deleted is required field in $params array + * Submit a contribution_page. * * @param array $params - * (reference) array containing id of the group. - * to be deleted + * Array per getfields metadata. * * @return array * API result array - * {@getfields contribution_page_delete} */ function civicrm_api3_contribution_page_submit($params) { $result = CRM_Contribute_Form_Contribution_Confirm::submit($params); diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php index c30303bef3..0933e59cf2 100644 --- a/api/v3/ContributionRecur.php +++ b/api/v3/ContributionRecur.php @@ -34,12 +34,10 @@ */ /** - * Create or update a contribution_recur + * Create or update a contribution_recur. * * @param array $params - * Associative array of property. - * name/value pairs to insert in new 'contribution_recur' - * @example ContributionRecurCreate.php Std Create example + * Array per getfields metadata. * * @return array * api result array diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php index dcf39fe1e1..8805cfedc3 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -70,7 +70,7 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) { * @param array $params */ function civicrm_api3_contribution_soft_delete($params) { - // non standard BAO - we have to write custom code to cope + // Non standard BAO - we have to write custom code to cope. CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id'])); } @@ -78,11 +78,11 @@ function civicrm_api3_contribution_soft_delete($params) { /** * Retrieve one or more Soft Credits. * - * @example ContributionSoftGet.php Standard Get Example - * - * @param array $params An associative array of name/value pairs. + * @param array $params + * Array per getfields metadata. * - * @return array api result {@getfields contribution_soft_get} + * @return array + * API result */ function civicrm_api3_contribution_soft_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Country.php b/api/v3/Country.php index 2a854bc690..5683691ebf 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -37,16 +37,12 @@ * @version $Id: Country.php 2011-02-16 ErikHommel $ */ -require_once 'CRM/Core/DAO/Country.php'; - /** - * Add an Country for a contact - * - * Allowed @params array keys are: - * - * @example CountryCreate.php Standard Create Example + * Add an Country for a contact. * * @param array $params + * Array per getfields metadata. + * * @return array * API result array * @throws \API_Exception @@ -68,31 +64,24 @@ function _civicrm_api3_country_create_spec(&$params) { } /** - * Deletes an existing Country + * Deletes an existing Country. * * @param array $params * - * @example CountryDelete.php Standard Delete Example - * - * @return bool - * | error true if successfull, error otherwise - * {@getfields country_delete} + * @return array */ function civicrm_api3_country_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); } /** - * Retrieve one or more countrys - * - * @example CountryGet.php Standard Get Example + * Retrieve one or more countryies. * * @param array $params - * An associative array of name/value pairs. + * Array per getfields metadata. * * @return array * api result array - * {@getfields country_get} */ function civicrm_api3_country_get($params) { diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index 57b09a1a16..bfcf45e4cd 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -37,19 +37,20 @@ /** * 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 array $params - * Array Associative array of property name/value pairs to create new custom field. + * 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'])) { foreach ($params['option_values'] as $key => $value) { $params['option_label'][$key] = $value['label']; @@ -66,7 +67,7 @@ function civicrm_api3_custom_field_create($params) { } /** - * 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)); @@ -122,7 +123,8 @@ function civicrm_api3_custom_field_get($params) { } /** - * Helper function to validate custom field value + * Helper function to validate custom field value. + * * @deprecated * * @param string $fieldName @@ -246,8 +248,11 @@ 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) { diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index 672f98352c..0fcba799c0 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -35,17 +35,6 @@ * @version $Id: CustomGroup.php 30879 2010-11-22 15:45:55Z shot $ */ -/** - * Most API functions take in associative arrays ( name => 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 - * @todo missing get function - */ - /** * Use this API to create a new group. * @@ -56,7 +45,7 @@ * $params['class_name'] is a required field, class being extended. * * @param array $params - * Array of property name/value pairs to insert in group. + * Array per getfields metadata. * * @return array * @todo $params['extends'] is array format - is that std compatible @@ -108,10 +97,10 @@ function civicrm_api3_custom_group_delete($params) { } /** - * Use this API to get existing custom fields. + * API to get existing custom fields. * * @param array $params - * Array to search on. + * Array per getfields metadata. * * @return array */ @@ -123,6 +112,7 @@ function civicrm_api3_custom_group_get($params) { * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group. * * @param array $params + * Array per getfields metadata. * * @return array */ diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php index f6c60ddabd..e96ef599e8 100644 --- a/api/v3/DashboardContact.php +++ b/api/v3/DashboardContact.php @@ -59,14 +59,12 @@ function civicrm_api3_dashboard_contact_create($params) { } /** - * Gets a CiviCRM Dashlets of Contacts according to parameters + * Gets a CiviCRM Dashlets of Contacts according to parameters. * * @param array $params - * Associative array of property name/value. - * pairs for the activity. + * Array per getfields metadata. * * @return array - * */ function civicrm_api3_dashboard_contact_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -85,7 +83,10 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) { } /** + * Check permissions on contact dashboard retrieval. + * * @param array $params + * Array per getfields metadata. * * @return array|null */ diff --git a/api/v3/Email.php b/api/v3/Email.php index b1cee27187..ff2ae35a27 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -36,13 +36,10 @@ */ /** - * Add an Email for a contact - * - * Allowed @params array keys are: - * - * @example EmailCreate.php Standard Create Example + * Add an Email for a contact. * * @param array $params + * Array per getfields metadata. * * @return array * API result array @@ -67,24 +64,23 @@ function _civicrm_api3_email_create_spec(&$params) { } /** - * Deletes an existing Email + * Deletes an existing Email. * * @param array $params + * Array per getfields metadata. * - * @example EmailDelete.php Standard Delete Example - * - * @return bool - * | error true if successfull, error otherwise + * @return array + * API result array. */ function civicrm_api3_email_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * Retrieve one or more emails + * Retrieve one or more emails. * * @param array $params - * An associative array of name/value pairs. + * Array per getfields metadata. * * @return array * api result array diff --git a/api/v3/File.php b/api/v3/File.php index c75c8e3e72..682775b1e7 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -41,10 +41,8 @@ /** * Create a file. * - * This API is used for creating a file - * * @param array $params - * An associative array of name/value property values of civicrm_file. + * Array per getfields metadata. * * @return array * Array of newly created file property values. @@ -85,11 +83,8 @@ function civicrm_api3_file_create($params) { /** * Get a file. * - * This api is used for finding an existing file. - * Required parameters : id OR file_type_id of a file - * * @param array $params - * An associative array of name/value property values of civicrm_file. + * Array per getfields metadata. * * @return array * Array of all found file object property values. @@ -102,9 +97,8 @@ function civicrm_api3_file_get($params) { /** * Update an existing file. * - * This api is used for updating an existing file. - * * @param array $params + * Array per getfields metadata. * * @return array */ @@ -131,9 +125,8 @@ function civicrm_api3_file_update($params) { /** * Delete an existing file. * - * This API is used for deleting a file - * * @param array $params + * Array per getfields metadata. * * @return array * API result array diff --git a/api/v3/Grant.php b/api/v3/Grant.php index 2e19211283..0d7520dc51 100644 --- a/api/v3/Grant.php +++ b/api/v3/Grant.php @@ -34,19 +34,13 @@ */ /** - * create/update grant - * - * This API is used to create new grant or update any of the existing - * In case of updating existing grant, id of that particular grant must - * be in $params array. + * Create/update grant. * * @param array $params - * Associative array of property. - * name/value pairs to insert in new 'grant' + * Array per getfields metadata. * * @return array * grant array - * {@getfields grant_create} */ function civicrm_api3_grant_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant'); @@ -66,34 +60,29 @@ function _civicrm_api3_grant_create_spec(&$params) { } /** - * Returns array of grants matching a set of one or more group properties + * Returns array of grants matching a set of one or more group properties. * * @param array $params - * Array of one or more valid. - * property_name=>value pairs. If $params is set - * as null, all grants will be returned + * Array per getfields metadata. * * @return array * Array of matching grants - * {@getfields grant_get} */ function civicrm_api3_grant_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant'); } /** - * delete an existing grant + * Delete an existing grant. * * This method is used to delete any existing grant. id of the group * to be deleted is required field in $params array * * @param array $params - * Array containing id of the group. - * to be deleted + * Array per getfields metadata. * * @return array * API Result Array - * {@getfields grant_delete} */ function civicrm_api3_grant_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index a2bdbba103..a0f56e1edb 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -32,14 +32,13 @@ * @subpackage API_MailerGroup * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ /** - * Handle a confirm event + * Handle a confirm event. * * @param array $params - * Associative array of property. + * Array of property. * * @throws Exception * @return array @@ -58,6 +57,8 @@ function civicrm_api3_mailing_event_queue_create($params) { } /** + * Get mailing event queue record. + * * @param array $params * @return array */ @@ -66,7 +67,10 @@ function civicrm_api3_mailing_event_queue_get($params) { } /** + * Delete mailing event queue record. + * * @param array $params + * * @return array * @throws \API_Exception */ diff --git a/api/v3/Phone/Get.php b/api/v3/Phone/Get.php index 8edc255b98..afa99b2f7a 100644 --- a/api/v3/Phone/Get.php +++ b/api/v3/Phone/Get.php @@ -10,7 +10,7 @@ * your module under api/v3/Phone/Dial.php. * * @param array $params - * An associative array of name/value pairs. + * Array per getfields metadata. * * @return array * details of found phones else error diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php index 530a581fa9..fd9d00e1f1 100644 --- a/api/v3/PriceField.php +++ b/api/v3/PriceField.php @@ -35,16 +35,14 @@ */ /** - * Create or update a price_field + * Create or update a price_field. * * @param array $params * Associative array of property. * name/value pairs to insert in new 'price_field' - * @example PriceFieldCreate.php Std Create example * * @return array * api result array - * {@getfields price_field_create} */ function civicrm_api3_price_field_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -63,7 +61,7 @@ function _civicrm_api3_price_field_create_spec(&$params) { } /** - * Returns array of price_fields matching a set of one or more group properties + * Returns array of price_fields matching a set of one or more group properties. * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. @@ -71,14 +69,13 @@ function _civicrm_api3_price_field_create_spec(&$params) { * * @return array * Array of matching price_fields - * {@getfields price_field_get} */ function civicrm_api3_price_field_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * delete an existing price_field + * Delete an existing price_field. * * This method is used to delete any existing price_field. id of the group * to be deleted is required field in $params array @@ -89,7 +86,6 @@ function civicrm_api3_price_field_get($params) { * * @return array * API result array - * {@getfields price_field_delete} */ function civicrm_api3_price_field_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index 8553e244aa..29fe4a8941 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -39,7 +39,7 @@ * Create relationship type. * * @param array $params - * Associative array of property name/value pairs to insert in new relationship type. + * Array per getfields metadata. * * @return array */ diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 0e049ca49e..79840a91f7 100644 --- a/api/v3/SmsProvider.php +++ b/api/v3/SmsProvider.php @@ -30,15 +30,10 @@ * * @package CiviCRM_APIv3 * @subpackage API_sms_provider - * */ /** - * Save an sms_provider - * - * Allowed @params array keys are: - * {@getfields sms_provider_create} - * @example sms_providerCreate.php + * Save an sms_provider. * * @param array $params * @@ -50,11 +45,7 @@ function civicrm_api3_sms_provider_create($params) { } /** - * Get an sms_provider - * - * Allowed @params array keys are: - * {@getfields sms_provider_get} - * @example sms_providerCreate.php + * Get an sms_provider. * * @param array $params * @@ -66,11 +57,7 @@ function civicrm_api3_sms_provider_get($params) { } /** - * Delete an sms_provider - * - * Allowed @params array keys are: - * {@getfields sms_provider_delete} - * @example sms_providerCreate.php + * Delete an sms_provider. * * @param array $params * diff --git a/api/v3/Survey.php b/api/v3/Survey.php index 1f088337cb..f270127a21 100644 --- a/api/v3/Survey.php +++ b/api/v3/Survey.php @@ -35,16 +35,13 @@ /** - * Create or update a survey + * Create or update a survey. * * @param array $params - * Associative array of property. - * name/value pairs to insert in new 'survey' - * @example SurveyCreate.php Std Create example + * Array per getfields metadata. * * @return array * api result array - * {@getfields survey_create} */ function civicrm_api3_survey_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey'); @@ -63,7 +60,7 @@ function _civicrm_api3_survey_create_spec(&$params) { } /** - * Returns array of surveys matching a set of one or more group properties + * Returns array of surveys matching a set of one or more group properties. * * @param array $params * Array of one or more valid. @@ -72,14 +69,13 @@ function _civicrm_api3_survey_create_spec(&$params) { * * @return array * API result Array of matching surveys - * {@getfields survey_get} */ function civicrm_api3_survey_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey'); } /** - * delete an existing survey + * Delete an existing survey. * * This method is used to delete any existing survey. id of the group * to be deleted is required field in $params array @@ -90,7 +86,6 @@ function civicrm_api3_survey_get($params) { * * @return array * api result array - * {@getfields survey_delete} */ function civicrm_api3_survey_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/Tag.php b/api/v3/Tag.php index cc8036ba54..d9b0e2ca09 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -40,15 +40,10 @@ * * Tags are used to classify CRM entities (including Contacts, Groups and Actions). * - * Allowed @params array keys are: - * - * {@example TagCreate.php} - * * @param array $params + * Array per getfields metadata. * * @return array - * Array of newly created tag property values. - * {@getfields tag_create} */ function civicrm_api3_tag_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -86,14 +81,11 @@ function civicrm_api3_tag_delete($params) { * This api is used for finding an existing tag. * Either id or name of tag are required parameters for this api. * - * @example TagGet.php - * * @param array $params - * An associative array of name/value pairs. + * Array per getfields metadata. * * @return array * details of found tags else error - * {@getfields tag_get} */ function civicrm_api3_tag_get($params) { diff --git a/api/v3/UFField.php b/api/v3/UFField.php index 510f0e221b..be1dc78364 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -39,7 +39,7 @@ * Defines 'uf field' within a group. * * @param array $params - * Array Associative array of property name/value pairs to create new uf field. + * Array per getfields metadata. * * @throws API_Exception * diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index a68efb0b27..57a1e0bced 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -54,7 +54,7 @@ function _civicrm_api3_uf_group_create_spec(&$params) { * See the CRM Data Model for uf_group property definitions * * @param array $params - * Array Associative array of property name/value pairs to insert in group. + * Array per getfields metadata. * * @return array * API result array diff --git a/api/v3/UFJoin.php b/api/v3/UFJoin.php index fc164f74aa..b8fe74dc77 100644 --- a/api/v3/UFJoin.php +++ b/api/v3/UFJoin.php @@ -39,7 +39,7 @@ * Takes an associative array and creates a uf join in the database. * * @param array $params - * Assoc array of name/value pairs. + * Array per getfields metadata. * * @return array * CRM_Core_DAO_UFJoin Array -- 2.25.1