From 6c8f6e67e62e4fc55c11e220063c4cbbe60da051 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 13:19:33 +1200 Subject: [PATCH] bulk comment fixes --- CRM/Activity/BAO/ActivityAssignment.php | 5 ++-- CRM/Activity/BAO/ActivityContact.php | 9 +++++--- CRM/Activity/BAO/ActivityTarget.php | 5 ++-- CRM/Activity/StateMachine/Search.php | 2 ++ CRM/Admin/Page/RelationshipType.php | 2 ++ CRM/Badge/Page/Layout.php | 2 ++ CRM/Campaign/Page/Petition/Confirm.php | 9 +++++--- .../Form/Activity/ChangeCaseStartDate.php | 3 +++ CRM/Case/Form/Activity/ChangeCaseType.php | 3 +++ CRM/Case/Form/Activity/LinkCases.php | 4 ++++ CRM/Contact/BAO/Contact/Location.php | 4 +++- CRM/Contact/BAO/GroupContact.php | 7 +++--- CRM/Contact/BAO/GroupOrganization.php | 4 +++- CRM/Contact/BAO/SavedSearch.php | 2 +- CRM/Contact/Form/Edit/Lock.php | 11 +++++---- CRM/Contact/Form/Inline/Email.php | 7 +++--- CRM/Contact/Form/Inline/IM.php | 7 +++--- CRM/Contact/Form/Inline/Lock.php | 4 +++- CRM/Contact/Form/Inline/OpenID.php | 7 +++--- CRM/Contact/Form/Inline/Phone.php | 7 +++--- CRM/Contact/Form/Location.php | 2 ++ CRM/Contact/Form/Task/LabelCommon.php | 6 ++++- CRM/Contact/Form/Task/PDFLetterCommon.php | 2 ++ CRM/Contact/Form/Task/ProximityCommon.php | 3 +++ CRM/Contact/Page/View/CustomData.php | 5 ++-- CRM/Contact/Selector/Custom.php | 15 ++++++++---- CRM/Contribute/BAO/ContributionSoft.php | 4 +++- CRM/Contribute/Form/AdditionalInfo.php | 2 ++ CRM/Contribute/Page/Tab.php | 4 +++- CRM/Contribute/StateMachine/Contribution.php | 7 +++--- .../StateMachine/ContributionPage.php | 7 +++--- CRM/Contribute/StateMachine/Search.php | 2 ++ CRM/Core/Payment/Google.php | 5 ++-- CRM/Core/Payment/PaymentExpress.php | 5 ++-- CRM/Export/BAO/Export.php | 23 +++++++++++-------- CRM/Extension/Info.php | 6 +++-- CRM/Extension/Manager.php | 3 +++ CRM/Extension/Mapper.php | 4 +++- CRM/Extension/System.php | 2 ++ CRM/Financial/BAO/FinancialTypeAccount.php | 4 +++- CRM/Financial/Page/Batch.php | 2 ++ CRM/Financial/Page/FinancialBatch.php | 2 ++ CRM/Grant/BAO/Query.php | 2 ++ CRM/Group/Page/Group.php | 6 +++-- CRM/Import/DataSource.php | 2 ++ CRM/Import/StateMachine.php | 5 ++-- CRM/Mailing/Event/BAO/Subscribe.php | 6 +++-- CRM/Mailing/Page/Report.php | 2 ++ CRM/Mailing/Selector/Browse.php | 6 ++--- CRM/Mailing/Selector/Event.php | 14 +++++------ CRM/Mailing/StateMachine/Send.php | 7 +++--- CRM/Member/BAO/Query.php | 2 ++ CRM/Member/PseudoConstant.php | 8 +++++++ CRM/Pledge/BAO/Query.php | 2 ++ CRM/Price/BAO/PriceSet.php | 6 +++-- CRM/Queue/Queue/Memory.php | 2 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 5 ++-- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 4 ++++ 58 files changed, 203 insertions(+), 95 deletions(-) diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index bdfecc795f..6f4e452987 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -70,12 +70,13 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta /** * Retrieve assignee_id by activity_id * - * @param int $id ID of the activity + * @param $activity_id + * + * @internal param int $id ID of the activity * * @return void * * @access public - * */ static function retrieveAssigneeIdsByActivityId($activity_id) { $assigneeArray = array(); diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 32612b0288..1a21e3d273 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -68,13 +68,16 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact /** * function to retrieve names of contact by activity_id * - * @param int $id ID of the activity - * @param string $type type of interaction + * @param $activityID + * @param $recordTypeID + * @param bool $alsoIDs + * + * @internal param int $id ID of the activity + * @internal param string $type type of interaction * * @return array * * @access public - * */ static function getNames($activityID, $recordTypeID, $alsoIDs = FALSE) { $names = array(); diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index 6c420c016d..76ae5c2f39 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -69,12 +69,13 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { /** * function to retrieve id of target contact by activity_id * - * @param int $id ID of the activity + * @param $activity_id + * + * @internal param int $id ID of the activity * * @return mixed * * @access public - * */ static function retrieveTargetIdsByActivityId($activity_id) { $targetArray = array(); diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index 1e9c2ca1f9..75b987ffe1 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -72,6 +72,8 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Admin/Page/RelationshipType.php b/CRM/Admin/Page/RelationshipType.php index ddd72bfa85..2653d5a2e1 100644 --- a/CRM/Admin/Page/RelationshipType.php +++ b/CRM/Admin/Page/RelationshipType.php @@ -119,6 +119,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Badge/Page/Layout.php b/CRM/Badge/Page/Layout.php index a67f912cb4..5d02352c90 100644 --- a/CRM/Badge/Page/Layout.php +++ b/CRM/Badge/Page/Layout.php @@ -111,6 +111,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index cf6595bd81..1ae146c23e 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -84,9 +84,12 @@ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { /** * Confirm email verification * - * @param int $contact_id The id of the contact - * @param int $subscribe_id The id of the subscription event - * @param string $hash The hash + * @param int $contact_id The id of the contact + * @param int $subscribe_id The id of the subscription event + * @param string $hash The hash + * + * @param $activity_id + * @param $petition_id * * @return boolean True on success * @access public diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index 4b266633ca..35a3197949 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -109,6 +109,9 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * * @access public * + * @param $form + * @param $params + * * @return void */ static function beginPostProcess(&$form, &$params) { diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index 9cb5864c67..8bf57ace8e 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -110,6 +110,9 @@ class CRM_Case_Form_Activity_ChangeCaseType { * * @access public * + * @param $form + * @param $params + * * @return void */ static function beginPostProcess(&$form, &$params) { diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 72a30c5344..6840c11bfc 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -123,6 +123,10 @@ class CRM_Case_Form_Activity_LinkCases { * * @access public * + * @param $form + * @param $params + * @param $activity + * * @return void */ static function endPostProcess(&$form, &$params, &$activity) { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index a9e2903996..dccdaccb53 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -78,7 +78,9 @@ WHERE civicrm_contact.id = %1"; /** * function to get the sms number and display name of a contact * - * @param int $id id of the contact + * @param int $id id of the contact + * + * @param null $type * * @return array tuple of display_name and sms if found, or (null,null) * @static diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 23bceb8009..1232f65d86 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -90,9 +90,10 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object - * @param array $ids the array that holds all the db ids + * @param array $params input parameters to find object + * @param array $values output values of the object + * + * @internal param array $ids the array that holds all the db ids * * @return array (reference) the values that could be potentially assigned to smarty * @access public diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 234c966d8d..9bf930eb63 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -119,7 +119,9 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Method to check group organization relationship exist * - * @param int $contactId + * @param $contactID + * + * @internal param int $contactId * * @return boolean * @access public diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 051ad3c5d0..95c4691608 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -42,7 +42,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** * class constructor * - * @return object CRM_Contact_BAO_SavedSearch + * @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch */ function __construct() { parent::__construct(); diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index 26a0fbde84..ff43ac489a 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -43,7 +43,8 @@ class CRM_Contact_Form_Edit_Lock { * This function provides the HTML form elements * * @param object $form form object - * @param int $inlineEditMode ( 1 for contact summary + * + * @internal param int $inlineEditMode ( 1 for contact summary * top bar form and 2 for display name edit ) * * @access public @@ -56,9 +57,11 @@ class CRM_Contact_Form_Edit_Lock { /** * Ensure that modified_date hasn't changed in the underlying DB * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields the input form values + * @param array $files the uploaded files if any + * @param null $contactID + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 55bf655258..57ea2b1cad 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -99,11 +99,10 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { /** * global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields posted values of the form + * @param array $errors list of errors to be posted back to the form * - * @return $errors - * @static + * @return array $errors@static * @access public */ static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index 5fa8dd05ec..40d7315a7e 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -99,11 +99,10 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { /** * global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields posted values of the form + * @param array $errors list of errors to be posted back to the form * - * @return $errors - * @static + * @return array $errors@static * @access public */ static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index bace5d842e..1dcc5e2bb7 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -43,7 +43,9 @@ class CRM_Contact_Form_Inline_Lock { * This function provides the HTML form elements * * @param object $form form object - * @param int $inlineEditMode ( 1 for contact summary + * @param $contactID + * + * @internal param int $inlineEditMode ( 1 for contact summary * top bar form and 2 for display name edit ) * * @access public diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 576d347a5d..f2053cf16f 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -99,11 +99,10 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { /** * global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields posted values of the form + * @param array $errors list of errors to be posted back to the form * - * @return $errors - * @static + * @return array $errors@static * @access public */ static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 5488a04f02..31c97b7718 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -99,11 +99,10 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { /** * global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields posted values of the form + * @param array $errors list of errors to be posted back to the form * - * @return $errors - * @static + * @return array $errors@static * @access public */ static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index a77a9bba22..2dac108a67 100644 --- a/CRM/Contact/Form/Location.php +++ b/CRM/Contact/Form/Location.php @@ -76,6 +76,8 @@ class CRM_Contact_Form_Location { /** * Function to build the form * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index cfeba4f747..de28724799 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -89,9 +89,13 @@ class CRM_Contact_Form_Task_LabelCommon { /** * function to get the rows for the labels * - * @param array $contactIds Contact IDS to do labels for + * @param $contactIDs * @param integer $locationTypeID * @param boolean $respectDoNotMail + * @param $mergeSameAddress + * @param $mergeSameHousehold + * + * @internal param array $contactIds Contact IDS to do labels for * @return array of rows for labels * @access public */ diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index 8037b9e24d..de6b300d5d 100644 --- a/CRM/Contact/Form/Task/PDFLetterCommon.php +++ b/CRM/Contact/Form/Task/PDFLetterCommon.php @@ -42,6 +42,8 @@ class CRM_Contact_Form_Task_PDFLetterCommon { /** * build all the data structures needed to build the form * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 9447561c9d..f070479a42 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -77,6 +77,9 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * * @access public * + * @param $form + * @param $proxSearch + * * @return void */ function buildQuickForm($form, $proxSearch) { diff --git a/CRM/Contact/Page/View/CustomData.php b/CRM/Contact/Page/View/CustomData.php index 85ca1413f6..2406084a6a 100644 --- a/CRM/Contact/Page/View/CustomData.php +++ b/CRM/Contact/Page/View/CustomData.php @@ -89,11 +89,10 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { * * @access public * - * @param object $page - the view page which created this one + * @internal param object $page - the view page which created this one * * @return void * @static - * */ function run() { $this->preProcess(); @@ -179,4 +178,4 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { } return parent::run(); } -} \ No newline at end of file +} diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index 38b27b0137..bb50c5bbeb 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -109,12 +109,19 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { /** * Class constructor * + * @param $customSearchClass * @param array $formValues array of form values imported - * @param array $params array of parameters for query - * @param int $action - action of search basic or advanced. + * @param array $params array of parameters for query + * @param null $returnProperties + * @param \const|int $action - action of search basic or advanced. * - * @return CRM_Contact_Selector - * @access public + * @param bool $includeContactIds + * @param bool $searchChildGroups + * @param string $searchContext + * @param null $contextMenu + * + * @return \CRM_Contact_Selector_Custom + @access public */ function __construct( $customSearchClass, diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index f67c0da6cc..3ee042d6f5 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -89,7 +89,9 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Function to delete soft credits * - * @param int $contributionTypeId + * @param $params + * + * @internal param int $contributionTypeId * @static */ static function del($params) { diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 54a64d74cd..294264d265 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -90,6 +90,8 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * + * @param $form + * * @return void */ static function buildAdditionalDetail(&$form) { diff --git a/CRM/Contribute/Page/Tab.php b/CRM/Contribute/Page/Tab.php index af32e5a578..30cc65e36f 100644 --- a/CRM/Contribute/Page/Tab.php +++ b/CRM/Contribute/Page/Tab.php @@ -55,9 +55,11 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { * - Edit * - Cancel * + * @param bool $recurID + * @param string $context + * * @return array * @access public - * */ static function &recurLinks($recurID = FALSE, $context = 'contribution') { if (!(self::$_links)) { diff --git a/CRM/Contribute/StateMachine/Contribution.php b/CRM/Contribute/StateMachine/Contribution.php index 91dd11abb5..f32a199d72 100644 --- a/CRM/Contribute/StateMachine/Contribution.php +++ b/CRM/Contribute/StateMachine/Contribution.php @@ -42,10 +42,11 @@ class CRM_Contribute_StateMachine_Contribution extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Contact_Import_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Contact_Import_StateMachine + * @internal param \CRM_Contact_Import_Controller $object + * @return \CRM_Contribute_StateMachine_Contribution CRM_Contact_Import_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Contribute/StateMachine/ContributionPage.php b/CRM/Contribute/StateMachine/ContributionPage.php index bd98929b23..cad1d182b8 100644 --- a/CRM/Contribute/StateMachine/ContributionPage.php +++ b/CRM/Contribute/StateMachine/ContributionPage.php @@ -42,10 +42,11 @@ class CRM_Contribute_StateMachine_ContributionPage extends CRM_Core_StateMachine /** * class constructor * - * @param object CRM_Contribute_Controller_ContributionPage - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Contribute_StateMachine_ContributionPage + * @internal param \CRM_Contribute_Controller_ContributionPage $object + * @return \CRM_Contribute_StateMachine_ContributionPage CRM_Contribute_StateMachine_ContributionPage */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Contribute/StateMachine/Search.php b/CRM/Contribute/StateMachine/Search.php index 1153089804..d3c323ee77 100644 --- a/CRM/Contribute/StateMachine/Search.php +++ b/CRM/Contribute/StateMachine/Search.php @@ -74,6 +74,8 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index cd7a36ea87..cd1ba9c0d9 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -122,11 +122,12 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Sets appropriate parameters for checking out to google * - * @param array $params name value pair of contribution datat + * @param array $params name value pair of contribution datat + * + * @param $component * * @return void * @access public - * */ function doTransferCheckout(&$params, $component) { $component = strtolower($component); diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index 653eabf65b..7160b8758b 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -122,11 +122,12 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { /** * Main transaction function * - * @param array $params name value pair of contribution data + * @param array $params name value pair of contribution data + * + * @param $component * * @return void * @access public - * */ function doTransferCheckout(&$params, $component) { $component = strtolower($component); diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index dfc0c1184f..2940f68d0d 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -46,17 +46,20 @@ class CRM_Export_BAO_Export { /** * Function to get the list the export fields * - * @param int $selectAll user preference while export - * @param array $ids contact ids - * @param array $params associated array of fields + * @param int $selectAll user preference while export + * @param array $ids contact ids + * @param array $params associated array of fields * @param string $order order by clause - * @param array $fields associated array of fields - * @param array $moreReturnProperties additional return fields - * @param int $exportMode export mode + * @param array $fields associated array of fields + * @param array $moreReturnProperties additional return fields + * @param int $exportMode export mode * @param string $componentClause component clause * @param string $componentTable component table - * @param bool $mergeSameAddress merge records if they have same address - * @param bool $mergeSameHousehold merge records if they belong to the same household + * @param bool $mergeSameAddress merge records if they have same address + * @param bool $mergeSameHousehold merge records if they belong to the same household + * + * @param array $exportParams + * @param string $queryOperator * * @static * @access public @@ -310,9 +313,9 @@ class CRM_Export_BAO_Export { $componentReturnProperties = CRM_Contact_BAO_Query::defaultReturnProperties($queryMode); if ($queryMode == CRM_Contact_BAO_Query::MODE_CONTRIBUTE) { // soft credit columns are not automatically populated, because contribution search doesn't require them by default - $componentReturnProperties = + $componentReturnProperties = array_merge( - $componentReturnProperties, + $componentReturnProperties, CRM_Contribute_BAO_Query::softCreditReturnProperties(TRUE)); } $returnProperties = array_merge($returnProperties, $componentReturnProperties); diff --git a/CRM/Extension/Info.php b/CRM/Extension/Info.php index c0cde01ffd..5f662f8a27 100644 --- a/CRM/Extension/Info.php +++ b/CRM/Extension/Info.php @@ -44,9 +44,11 @@ class CRM_Extension_Info { /** * Load extension info an XML file * - * @param string $string XML content + * @param $file + * + * @throws CRM_Extension_Exception_ParseException + * @internal param string $string XML content * @return CRM_Extension_Info - * @throws CRM_Extension_Exception */ public static function loadFromFile($file) { list ($xml, $error) = CRM_Utils_XML::parseFile($file); diff --git a/CRM/Extension/Manager.php b/CRM/Extension/Manager.php index 4409765447..6d7f172334 100644 --- a/CRM/Extension/Manager.php +++ b/CRM/Extension/Manager.php @@ -101,7 +101,10 @@ class CRM_Extension_Manager { public $statuses; /** + * @param CRM_Extension_Container_Interface $fullContainer * @param CRM_Extension_Container_Basic|FALSE $defaultContainer + * @param CRM_Extension_Mapper $mapper + * @param $typeManagers */ function __construct(CRM_Extension_Container_Interface $fullContainer, $defaultContainer, CRM_Extension_Mapper $mapper, $typeManagers) { $this->fullContainer = $fullContainer; diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php index b581fd8d64..c70f218dad 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -120,7 +120,9 @@ class CRM_Extension_Mapper { * * @access public * - * @param string $key extension key + * @param $clazz + * + * @internal param string $key extension key * * @return string full path the extension .php file */ diff --git a/CRM/Extension/System.php b/CRM/Extension/System.php index a9c099d24b..0ab76fa272 100644 --- a/CRM/Extension/System.php +++ b/CRM/Extension/System.php @@ -53,6 +53,8 @@ class CRM_Extension_System { private $_repoUrl = NULL; /** + * @param bool $fresh + * * @return CRM_Extension_System */ public static function singleton($fresh = FALSE) { diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index f22c0992ab..1510aef22c 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -56,9 +56,11 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin * of time. This is the inverse function of create. It also stores all the retrieved * values in the default array * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * + * @param array $allValues + * * @return object CRM_Contribute_BAO_ContributionType object * @access public * @static diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index 41499e470b..17e242eba5 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -83,6 +83,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Financial/Page/FinancialBatch.php b/CRM/Financial/Page/FinancialBatch.php index 7be7ee5171..64261bf30b 100644 --- a/CRM/Financial/Page/FinancialBatch.php +++ b/CRM/Financial/Page/FinancialBatch.php @@ -122,6 +122,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { * * Redirect to civicrm home page when clicked on cancel button * + * @param null $mode + * * @return string user context. */ function userContext($mode = null) { diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index 591739a307..65c3438147 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -100,6 +100,8 @@ class CRM_Grant_BAO_Query { * Given a list of conditions in params generate the required * where clause * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index a7e197af87..f0898a8aed 100644 --- a/CRM/Group/Page/Group.php +++ b/CRM/Group/Page/Group.php @@ -104,8 +104,10 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { /** * make sure that the user has permission to access this group * - * @param int $id the id of the object - * @param int $name the name or title of the object + * @param int $id the id of the object + * @param int $title + * + * @internal param int $name the name or title of the object * * @return string the permission that the user has (or null) * @access public diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 93d81a668c..14cdb9f890 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -61,6 +61,8 @@ abstract class CRM_Import_DataSource { * form snippet. It should add all fields necesarry to get the data * uploaded to the temporary table in the DB. * + * @param $form + * * @return void (operates directly on form argument) * @access public */ diff --git a/CRM/Import/StateMachine.php b/CRM/Import/StateMachine.php index dce0521002..df539b4e78 100644 --- a/CRM/Import/StateMachine.php +++ b/CRM/Import/StateMachine.php @@ -41,9 +41,10 @@ class CRM_Import_StateMachine extends CRM_Core_StateMachine { /** * Class constructor * - * @param object CRM_*_Import_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * + * @internal param \CRM_ $object *_Import_Controller */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index 33bfedcfd1..add0cdc0d1 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -48,8 +48,10 @@ class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe { * Register a subscription event. Create a new contact if one does not * already exist. * - * @param int $group_id The group id to subscribe to - * @param string $email The email address of the (new) contact + * @param int $group_id The group id to subscribe to + * @param string $email The email address of the (new) contact + * @param null $contactId + * @param null $context * @params int $contactId Currently used during event registration/contribution. * Specifically to avoid linking group to wrong duplicate contact * during event registration. diff --git a/CRM/Mailing/Page/Report.php b/CRM/Mailing/Page/Report.php index eb4e82bd41..ae40c24e50 100644 --- a/CRM/Mailing/Page/Report.php +++ b/CRM/Mailing/Page/Report.php @@ -64,6 +64,8 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index c023780a84..c4422f4d79 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -59,10 +59,10 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ /** * Class constructor * - * @param + * @internal param $ * - * @return CRM_Contact_Selector_Profile - * @access public + * @return \CRM_Mailing_Selector_Browse + @access public */ function __construct() { } diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index cf67791976..607d143025 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -84,14 +84,14 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C /** * Class constructor * - * @param string $event The event type (queue/delivered/open...) - * @param boolean $distinct Count only distinct contact events? - * @param int $mailing ID of the mailing to query - * @param int $job ID of the job to query. If null, all jobs from $mailing are queried. - * @param int $url If the event type is a click-through, do we want only those from a specific url? + * @param string $event The event type (queue/delivered/open...) + * @param boolean $distinct Count only distinct contact events? + * @param int $mailing ID of the mailing to query + * @param int $job ID of the job to query. If null, all jobs from $mailing are queried. + * @param int $url If the event type is a click-through, do we want only those from a specific url? * - * @return CRM_Contact_Selector_Profile - * @access public + * @return \CRM_Mailing_Selector_Event + @access public */ function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) { $this->_event_type = $event; diff --git a/CRM/Mailing/StateMachine/Send.php b/CRM/Mailing/StateMachine/Send.php index 221abf4b5e..ad400433de 100644 --- a/CRM/Mailing/StateMachine/Send.php +++ b/CRM/Mailing/StateMachine/Send.php @@ -42,10 +42,11 @@ class CRM_Mailing_StateMachine_Send extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Mailing_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Mailing_StateMachine + * @internal param \CRM_Mailing_Controller $object + * @return \CRM_Mailing_StateMachine_Send CRM_Mailing_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Member/BAO/Query.php b/CRM/Member/BAO/Query.php index efdd8bd68e..87b50c5de1 100644 --- a/CRM/Member/BAO/Query.php +++ b/CRM/Member/BAO/Query.php @@ -42,6 +42,8 @@ class CRM_Member_BAO_Query { /** * if membership are involved, add the specific membership fields * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index 64ee203cec..839bce7ebb 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -58,6 +58,9 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * @param bool $force + * * @return array - array reference of all membership types if any * @static */ @@ -85,6 +88,11 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * @param null $cond + * @param string $column + * @param bool $force + * * @return array - array reference of all membership statuss if any * @static */ diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index cb61a4e3f0..2ac269866b 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -42,6 +42,8 @@ class CRM_Pledge_BAO_Query { /** * build select for Pledge * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index d2413bac5b..1cf4291460 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -85,8 +85,10 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { /** * update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id id of the database record + * @param $isActive + * + * @internal param bool $is_active value we want to set the is_active field * * @return Object DAO object on sucess, null otherwise * @static diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index 31cef0b8e5..8495bfa731 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -118,7 +118,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { /** * Get and remove the next item * - * @param $leaseTime seconds + * @param int|\seconds $leaseTime seconds * * @return object with key 'data' that matches the inputted data */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 5c4136ecbf..802dcbc0b3 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -48,8 +48,9 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * price field object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params (reference ) an assoc array of name/value pairs + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object * @access public diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index eaa8b0e31f..5b0c6ef6f0 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -44,6 +44,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param array $params (reference), array $ids * + * @param $ids + * * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object * @access public * @static @@ -71,6 +73,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param array $params (reference), array $ids * + * @param $ids + * * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object * @access public * @static -- 2.25.1