phpdoc params is always an array in api

diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php
index f9e6dc80abddc63a0161e7784d8250d41a4d240b..777935839359096fb6b4c9284804bb3cdc7f5d56 100644 (file)
--- a/api/v3/ActionSchedule.php
+++ b/api/v3/ActionSchedule.php
@@ -38,7 +38,7 @@
 /**
  * Get CiviCRM Action Schedule details
  * {@getfields action_schedule_create}
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_action_schedule_get($params) {

diff --git a/api/v3/Contact.php b/api/v3/Contact.php
index 7029bc5f716452f1bd80f9b85b4a99609f903bb7..013a31c481919723dc9478a500f68d7578dacbc8 100644 (file)
--- a/api/v3/Contact.php
+++ b/api/v3/Contact.php
@@ -560,7 +560,7 @@ function _civicrm_api3_greeting_format_params($params) {
  * @deprecated
  *
  * {@example ContactGetquick.php 0}
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */

diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php
index fc73fe82d476ca7a911682dc226e6f90097937bc..ea2916a3e0318eb12759e890b6e3f2aae934e10a 100644 (file)
--- a/api/v3/Contribution.php
+++ b/api/v3/Contribution.php
@@ -151,7 +151,7 @@ function _civicrm_api3_contribution_create_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
   //legacy soft credit handling - recommended approach is chaining
@@ -197,7 +197,7 @@ function civicrm_api3_contribution_delete($params) {
 
 /**
  * modify metadata. Legacy support for contribution_id
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_contribution_delete_spec(&$params) {
   $params['id']['api.aliases'] = array('contribution_id');

diff --git a/api/v3/Country.php b/api/v3/Country.php
index 524c7d97f32b624666c50e999f718d7636b97120..05b088e1f027b7c6c39424b6a1c124a9f4211726 100644 (file)
--- a/api/v3/Country.php
+++ b/api/v3/Country.php
@@ -46,9 +46,10 @@ require_once 'CRM/Core/DAO/Country.php';
  *
  * @example CountryCreate.php Standard Create Example
  *
- * @return array
- *   API result array
- * {@getfields country_create}
+ * @param array $params
+ * @return array API result array
+ * API result array
+ * @throws \API_Exception
  * @access public
  */
 function civicrm_api3_country_create($params) {

diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php
index 13bd9d4dc70825084a4a51341cb2dd2981463b7e..4c455090c0e12b0c3e623cce60e8de15ca8fa66c 100644 (file)
--- a/api/v3/CustomField.php
+++ b/api/v3/CustomField.php
@@ -262,7 +262,7 @@ SELECT count(*)
 
 /**
  * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_custom_field_setvalue($params) {

diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php
index e089ed30a1fee4e08b6a39e5bea330927e43d069..4246321e8ff709095514f477c1de6cf568fa34e2 100644 (file)
--- a/api/v3/CustomGroup.php
+++ b/api/v3/CustomGroup.php
@@ -131,7 +131,7 @@ function civicrm_api3_custom_group_get($params) {
 
 /**
  * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_custom_group_setvalue($params) {

diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php
index bb3b1f5b390211474164203653eceabce0492405..3ee7f1ef6a43dd20ef5e048f5b6af5f0551a2f3e 100644 (file)
--- a/api/v3/DashboardContact.php
+++ b/api/v3/DashboardContact.php
@@ -108,7 +108,7 @@ function _civicrm_api3_dashboard_contact_check_params(&$params) {
  *
  * {@getfields dashboard_contact_delete}
  * @access public
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */

diff --git a/api/v3/Domain.php b/api/v3/Domain.php
index 5c74b5c929edc447ada1904056d1aab05509a561..da334b8f28527f27501206a7a331b3073039c423 100644 (file)
--- a/api/v3/Domain.php
+++ b/api/v3/Domain.php
@@ -40,7 +40,7 @@
  * Get CiviCRM domain details
  * {@getfields domain_create}
  * @example DomainGet.php
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */

diff --git a/api/v3/Entity.php b/api/v3/Entity.php
index 5b70b6e5ee2e26d7a6d5ea41621ed8c1c5547993..10234aababcb9289e32e3c2db4af2ff93179ccd3 100644 (file)
--- a/api/v3/Entity.php
+++ b/api/v3/Entity.php
@@ -20,7 +20,7 @@ function _civicrm_api3_entity_deprecation($entities) {
 
 /**
  *  Placeholder function. This should never be called, as it doesn't have any meaning
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_entity_create($params) {
@@ -29,7 +29,7 @@ function civicrm_api3_entity_create($params) {
 
 /**
  *  Placeholder function. This should never be called, as it doesn't have any meaning
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_entity_delete($params) {
@@ -38,7 +38,7 @@ function civicrm_api3_entity_delete($params) {
 
 /**
  *  Placeholder function. This should never be called, as it doesn't have any meaning
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_entity_getfields($params) {

diff --git a/api/v3/EntityTag.php b/api/v3/EntityTag.php
index 8aab9012569602f360d8b90eabea1ee77dca703c..cf265e226b3522cc02ab1fc780b4f7f6cf9d3b0c 100644 (file)
--- a/api/v3/EntityTag.php
+++ b/api/v3/EntityTag.php
@@ -102,7 +102,7 @@ function civicrm_api3_entity_tag_delete($params) {
 
 /**
  * modify metadata
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_entity_tag_delete_spec(&$params) {
   // set as not required as tag_id also acceptable & no either/or std yet

diff --git a/api/v3/Event.php b/api/v3/Event.php
index 3a3251bc32d40c8d48dc4451faedf1afe9793d26..c9bc92e6fbac9627b24232d4529b9be9653f2096 100644 (file)
--- a/api/v3/Event.php
+++ b/api/v3/Event.php
@@ -85,7 +85,7 @@ function _civicrm_api3_event_create_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_event_create_legacy_support_42(&$params) {
   if (!empty($params['payment_processor_id'])) {
@@ -189,7 +189,7 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
  *
  * This API is used for deleting a event
  *
- * @param $params
+ * @param array $params
  * @return array
  *
  * @access public

diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php
index 1c01e9d6f32644f91b29f15b89d7a07f62815414..1879cd8246f4fc495f55986abe70cd863f73be1c 100644 (file)
--- a/api/v3/GroupContact.php
+++ b/api/v3/GroupContact.php
@@ -139,7 +139,7 @@ function civicrm_api3_group_contact_delete($params) {
 
 /**
  * modify metadata
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_group_contact_delete_spec(&$params) {
   // set as not required no either/or std yet
@@ -229,7 +229,7 @@ function _civicrm_api3_group_contact_common($params, $op = 'Added') {
 
 /**
  * @deprecated - this should be part of create but need to know we aren't missing something
- * @param $params
+ * @param array $params
  * @return bool
  * @throws \API_Exception
  */

diff --git a/api/v3/Location.php b/api/v3/Location.php
index 824f708c3db37b853e8b2fbf35b6234a39d30c5d..40fbdb62633624938dd951221ad2140b048518e8 100644 (file)
--- a/api/v3/Location.php
+++ b/api/v3/Location.php
@@ -2,7 +2,7 @@
 
 /**
  *  Functions to inform caller that Location is obsolete and Address, Phone, Email, Website should be used
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_location_create($params) {

diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php
index 2a1119c2199c85136f1feb5c5e52932effccd60a..3c441888569a6f90bd38b3a2d110085e3afe70b0 100755 (executable)
--- a/api/v3/Mailing.php
+++ b/api/v3/Mailing.php
@@ -583,7 +583,7 @@ function civicrm_api3_mailing_stats($params) {
  * Fix the reset dates on the email record based on when a mail was last delivered
  * We only consider mailings that were completed and finished in the last 3 to 7 days
  * Both the min and max days can be set via the params
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_mailing_update_email_resetdate($params) {

diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php
index eeaee7681e74e3bfe8961d21581f757ac85b02ed..595755b7e9bd66392711e64c1fe1aa8409ee9af0 100644 (file)
--- a/api/v3/MailingJob.php
+++ b/api/v3/MailingJob.php
@@ -38,7 +38,7 @@
 
 /**
  * Handle creation of a Mailing Job for a Mailing.
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */
@@ -77,7 +77,7 @@ function civicrm_api3_mailing_job_get($params, $ids = array()) {
 
 /**
  * Handle deletion of a Mailing Job for a Mailing.
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */

diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php
index d72c1ef8dfbc81d156e7efc32dad964215e549b2..41db4ce4d1e6acbd7a2ee5c68b3b7216cf5da431 100644 (file)
--- a/api/v3/MessageTemplate.php
+++ b/api/v3/MessageTemplate.php
@@ -33,7 +33,7 @@
 
 /**
  * @access public
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */
@@ -97,7 +97,7 @@ function civicrm_api3_message_template_get($params) {
 
 /**
  * Sends a template.
- * @param $params
+ * @param array $params
  */
 function civicrm_api3_message_template_send($params) {
   CRM_Core_BAO_MessageTemplates::sendTemplate($params);

diff --git a/api/v3/Participant.php b/api/v3/Participant.php
index a1cb21aca2c504e7b1a9e7d2523055bab948a918..4480d49ae1ef89f15a767ee00b2f18900d012fe7 100644 (file)
--- a/api/v3/Participant.php
+++ b/api/v3/Participant.php
@@ -77,7 +77,7 @@ function civicrm_api3_participant_create($params) {
 /**
  * @todo this should be done in the BAO not the api
  * Create a default participant line item
- * @param $params
+ * @param array $params
  * @param $participant
  * @throws \CiviCRM_API3_Exception
  */

diff --git a/api/v3/PaymentProcessorType.php b/api/v3/PaymentProcessorType.php
index 1cdac8dd31d15dfdee93ca7d5ec5d514fab1f091..861251c540eafb80980eec93887b7fe7e54c6029 100644 (file)
--- a/api/v3/PaymentProcessorType.php
+++ b/api/v3/PaymentProcessorType.php
@@ -90,7 +90,7 @@ function _civicrm_api3_payment_processor_type_create_spec(&$params) {
  * @access  public
  * {@getfields PaymentProcessorType_get}
  * @example PaymentProcessorTypeGet.php
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_payment_processor_type_get($params) {

diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php
index 958f38d30513834ade23606ae83d29ab31658104..602293249055fa2458e7dd33c526b51302f07f74 100644 (file)
--- a/api/v3/Pledge.php
+++ b/api/v3/Pledge.php
@@ -96,7 +96,7 @@ function _civicrm_api3_pledge_delete_spec(&$params) {
 
 /**
  * return field specification specific to get requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_pledge_get_spec(&$params) {
   $params['next_pay_date'] = array(
@@ -113,7 +113,7 @@ function _civicrm_api3_pledge_get_spec(&$params) {
 
 /**
  * return field specification specific to get requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_pledge_create_spec(&$params) {
 

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index 348bab99cd9ff1681eb46559253e30e874940aaf..ca1bdda2d04425ded38ad70cf399bbf4559f3d9d 100644 (file)
--- a/api/v3/Premium.php
+++ b/api/v3/Premium.php
@@ -88,7 +88,7 @@ function civicrm_api3_premium_delete($params) {
 
 /**
  * return field specification specific to get requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_premium_get_spec(&$params) {
   $params['premiums_active']['api.aliases'] = array('is_active');
@@ -96,7 +96,7 @@ function _civicrm_api3_premium_get_spec(&$params) {
 
 /**
  * return field specification specific to create requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_premium_create_spec(&$params) {
   $params['premiums_active']['api.aliases'] = array('is_active');

diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php
index aa72f1366598057873fbbafa5742d7eebc572c7f..a3635e77219595ead413823cc2eb0c71f2d58112 100644 (file)
--- a/api/v3/RelationshipType.php
+++ b/api/v3/RelationshipType.php
@@ -98,7 +98,7 @@ function _civicrm_api3_relationship_type_create_spec(&$params) {
  * @access  public
  * {@getfields RelationshipType_get}
  * @example RelationshipTypeGet.php
- * @param $params
+ * @param array $params
  * @return array
  */
 function civicrm_api3_relationship_type_get($params) {

diff --git a/api/v3/Setting.php b/api/v3/Setting.php
index 0d0d3cdeb3ff8b1b20aadcd45725d89cfa1c1066..7c2c7249e578acb82eec45d4627dd7a3f7490e2f 100644 (file)
--- a/api/v3/Setting.php
+++ b/api/v3/Setting.php
@@ -32,7 +32,7 @@
  * @subpackage API_Settings
  * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Settings.php
- * @param $params
+ * @param array $params
  * @return array
  */
 
@@ -74,7 +74,7 @@ function civicrm_api3_setting_getfields($params) {
 
 /**
  * Alter metadata for getfields functions
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_setting_getfields_spec(&$params) {
   $params['filters'] = array('title' => 'Fields you wish to filter by e.g. array("group_name" => "CiviCRM Preferences")');
@@ -86,7 +86,7 @@ function _civicrm_api3_setting_getfields_spec(&$params) {
  * Return default values for settings. We will domain key this as it could vary by domain (ie. urls)
  * as we will be creating the option for a function rather than an value to be in the defaults
  * Note that is not in place as yet
- * @param $params
+ * @param array $params
  * @return array
  * @throws \CiviCRM_API3_Exception
  * @throws \Exception
@@ -130,7 +130,7 @@ function _civicrm_api3_setting_getdefaults_spec(&$params) {
 
 /**
  * Revert settings to defaults
- * @param $params
+ * @param array $params
  * @return array
  * @throws \Exception
  */
@@ -155,7 +155,7 @@ function civicrm_api3_setting_revert(&$params) {
 
 /**
  * Alter metadata for getfields functions
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_setting_revert_spec(&$params) {
   $params['name'] = array('title' => 'Setting Name belongs to');
@@ -170,7 +170,7 @@ function _civicrm_api3_setting_revert_spec(&$params) {
 
 /**
  * Revert settings to defaults
- * @param $params
+ * @param array $params
  * @return array
  * @throws \CiviCRM_API3_Exception
  * @throws \Exception
@@ -195,7 +195,7 @@ function civicrm_api3_setting_fill(&$params) {
 
 /**
  * Alter metadata for getfields functions
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_setting_fill_spec(&$params) {
   $params['name'] = array('title' => 'Setting Name belongs to');
@@ -346,7 +346,7 @@ function _civicrm_api3_setting_getvalue_spec(&$params) {
  * Really domain_id should always be set but doing an empty check because at the moment
  * using crm-editable will pass an id & default won't be applied
  * we did talk about id being a pseudonym for domain_id in this api so applying it here
- * @param $params
+ * @param array $params
  * @return array
  * @throws \Exception
  */

diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php
index 31b900ef3a49ea3093032b628f34123c8d914aff..3ea6f75b276706dc06e35ef86ff2ad3e98535f10 100644 (file)
--- a/api/v3/SurveyRespondant.php
+++ b/api/v3/SurveyRespondant.php
@@ -81,7 +81,7 @@ function civicrm_api3_survey_respondant_get(&$params) {
 
 /**
  * @deprecated - api currently not supported
- * @param $params
+ * @param array $params
  * @return array
  */
 function &civicrm_api3_survey_respondant_count($params) {

diff --git a/api/v3/UFField.php b/api/v3/UFField.php
index 122179e9b2aa9af7a4a33fdf95264dd0f108c4cc..489c2c54ec36aa863a9f4d52297c2e16a80a1dfc 100644 (file)
--- a/api/v3/UFField.php
+++ b/api/v3/UFField.php
@@ -177,7 +177,7 @@ function civicrm_api3_uf_field_delete($params) {
 
 /**
  * field id accepted for backward compatibility - unset required on id
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_uf_field_delete_spec(&$params) {
   // legacy support for field_id

diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php
index d019bd4cb92e14c516db75f2739c5b546d8ff633..495bbeb777e7064f062603f51c8060202fec5ac6 100644 (file)
--- a/api/v3/WordReplacement.php
+++ b/api/v3/WordReplacement.php
@@ -39,7 +39,7 @@
 /**
  * Get CiviCRM Word Replacement details
  * {@getfields word_replacement_create}
- * @param $params
+ * @param array $params
  * @return array
  * @throws \API_Exception
  */

diff --git a/api/v3/utils.php b/api/v3/utils.php
index 53076f73e64bf57f3b0d8f791486b05ed2894105..53af3b736d31761ba441b4803a6cf7d03605371c 100644 (file)
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -1719,7 +1719,7 @@ function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array()) {
  * Return an array of fields for a given entity - this is the same as the BAO function but
  * fields are prefixed with 'custom_' to represent api params
  * @param $entity
- * @param $params
+ * @param array $params
  * @return array
  */
 function _civicrm_api_get_custom_fields($entity, &$params) {