From dd244018f95de3e8799532a4ebbc05490fd9f68f Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 13:09:44 +1200 Subject: [PATCH] bulk comment fixes --- CRM/Activity/BAO/Activity.php | 4 +++- CRM/Activity/Selector/Activity.php | 8 +++++-- CRM/Activity/Selector/Search.php | 17 ++++++++------ CRM/Admin/Form/PaymentProcessorType.php | 2 ++ CRM/Admin/Page/CaseType.php | 2 ++ CRM/Admin/Page/JobLog.php | 2 ++ CRM/Admin/Page/LabelFormats.php | 2 ++ CRM/Admin/Page/Mapping.php | 2 ++ CRM/Admin/Page/Navigation.php | 2 ++ CRM/Admin/Page/Options.php | 2 ++ CRM/Admin/Page/PaymentProcessorType.php | 2 ++ CRM/Admin/Page/PdfFormats.php | 4 ++++ CRM/Admin/Page/PreferencesDate.php | 2 ++ CRM/Badge/BAO/Badge.php | 3 ++- CRM/Campaign/BAO/Query.php | 2 ++ CRM/Campaign/BAO/Survey.php | 2 ++ CRM/Campaign/PseudoConstant.php | 2 ++ CRM/Campaign/Selector/Search.php | 19 ++++++++------- .../Form/Activity/ChangeCaseStartDate.php | 3 +++ CRM/Case/Form/Activity/ChangeCaseStatus.php | 4 ++++ CRM/Case/Form/Activity/LinkCases.php | 3 +++ CRM/Case/Form/Activity/OpenCase.php | 2 ++ CRM/Case/Form/Task.php | 6 ++++- CRM/Case/Selector/Search.php | 17 ++++++++------ CRM/Contact/BAO/Contact.php | 13 +++++++---- CRM/Contact/BAO/Contact/Permission.php | 7 +++--- CRM/Contact/BAO/ContactType.php | 5 ++-- CRM/Contact/BAO/GroupNesting.php | 2 +- CRM/Contact/BAO/Relationship.php | 5 ++-- CRM/Contact/Form/Edit/Address.php | 8 +++++-- CRM/Contact/Form/Inline/Lock.php | 8 ++++--- CRM/Contact/Form/Task/ProximityCommon.php | 8 ++++--- CRM/Contact/Form/Task/SMSCommon.php | 2 ++ CRM/Contact/Import/Form/MapField.php | 2 ++ CRM/Contribute/BAO/ContributionRecur.php | 6 +++-- CRM/Contribute/BAO/ContributionSoft.php | 19 +++++++++------ CRM/Contribute/BAO/Query.php | 2 ++ CRM/Contribute/Form/AdditionalInfo.php | 2 ++ .../Form/Contribution/OnBehalfOf.php | 2 ++ .../Form/ContributionPage/Settings.php | 5 +++- CRM/Contribute/Form/ManagePremiums.php | 2 ++ CRM/Contribute/Form/SoftCredit.php | 2 ++ CRM/Contribute/Page/Premium.php | 2 ++ CRM/Contribute/PseudoConstant.php | 6 +++++ CRM/Contribute/Task.php | 2 ++ CRM/Core/BAO/ConfigSetting.php | 4 ++++ CRM/Core/BAO/CustomGroup.php | 20 +++++++++------- CRM/Core/BAO/CustomOption.php | 1 + CRM/Core/BAO/Discount.php | 5 ++-- CRM/Core/BAO/Email.php | 2 ++ CRM/Core/BAO/EntityTag.php | 7 +++++- CRM/Core/BAO/FinancialTrxn.php | 9 +++++--- CRM/Core/BAO/LocationType.php | 3 ++- CRM/Core/BAO/Log.php | 4 +++- CRM/Core/BAO/MessageTemplate.php | 2 ++ CRM/Core/BAO/OptionValue.php | 4 +++- CRM/Core/BAO/Phone.php | 4 ++++ CRM/Core/BAO/Setting.php | 7 ++++++ CRM/Core/BAO/Website.php | 5 +++- CRM/Core/BAO/WordReplacement.php | 2 ++ CRM/Core/Block.php | 2 ++ CRM/Core/Component/Info.php | 4 +++- CRM/Core/Config/Defaults.php | 4 ++-- CRM/Core/DAO.php | 13 +++++++---- CRM/Core/Error.php | 6 +++++ CRM/Core/Form.php | 12 +++++----- CRM/Core/Payment/BaseIPN.php | 3 +++ CRM/Core/Payment/Dummy.php | 5 +++- CRM/Core/Payment/Elavon.php | 3 ++- CRM/Core/Payment/Form.php | 2 ++ CRM/Core/Payment/GoogleIPN.php | 5 ++-- CRM/Core/Payment/PayJunction.php | 5 +++- CRM/Core/Payment/PaymentExpress.php | 5 +++- CRM/Core/Payment/PaymentExpressIPN.php | 12 ++++++++-- CRM/Core/Payment/eWAY.php | 11 ++++++--- CRM/Core/PseudoConstant.php | 20 +++++++++------- CRM/Core/QuickForm/Action/Display.php | 5 ++-- CRM/Core/Resources.php | 4 +++- CRM/Core/Session.php | 2 ++ CRM/Core/StateMachine.php | 6 +++-- CRM/Custom/Form/Group.php | 8 ++++--- CRM/Event/BAO/Event.php | 23 ++++++++++++++++--- CRM/Event/Form/EventFees.php | 2 ++ CRM/Event/Form/Registration.php | 3 +++ CRM/Event/Form/Registration/Confirm.php | 16 +++++++++++++ CRM/Event/Import/Parser.php | 2 ++ CRM/Event/Page/ManageEvent.php | 4 +++- CRM/Export/Form/Map.php | 3 +++ CRM/Extension/Container/Basic.php | 2 +- CRM/Extension/Container/Collection.php | 4 +++- CRM/Financial/Page/BatchTransaction.php | 2 ++ CRM/Mailing/Event/BAO/Opened.php | 4 +++- CRM/Mailing/MailStore/Imap.php | 12 +++++----- CRM/Mailing/MailStore/Localdir.php | 4 ++-- CRM/Mailing/MailStore/Maildir.php | 4 ++-- CRM/Mailing/MailStore/Mbox.php | 4 ++-- CRM/Mailing/MailStore/Pop3.php | 10 ++++---- CRM/Mailing/Page/Component.php | 2 ++ CRM/Mailing/Selector/Browse.php | 7 ++++-- CRM/Mailing/Selector/Search.php | 9 +++++--- CRM/PCP/BAO/PCP.php | 19 ++++++++++----- CRM/PCP/Form/Campaign.php | 8 ++++--- CRM/PCP/Form/Contribute.php | 3 +++ CRM/PCP/Form/Event.php | 3 +++ CRM/Pledge/Form/Task.php | 6 ++++- CRM/Price/BAO/LineItem.php | 11 +++++++-- CRM/Price/BAO/PriceFieldValue.php | 2 +- CRM/Price/BAO/PriceSet.php | 2 ++ CRM/Queue/Queue/Memory.php | 2 +- CRM/Report/BAO/ReportInstance.php | 4 ++-- CRM/Utils/Cache/Memcached.php | 5 ++-- api/v3/examples/SurveyRespondant/Get.php | 2 +- .../main.php | 5 ++++ 113 files changed, 464 insertions(+), 165 deletions(-) diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index d1a8cccb51..57be253e39 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -1643,7 +1643,9 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * scheme. Adding weight is super important and should be done in the * next week or so, before this can be called complete. * - * @param NULL + * @param bool $status + * + * @internal param $NULL * * @return array array of importable Fields * @access public diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 06f895a181..65785e5c63 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -69,8 +69,12 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * @param int $contactId - contact whose activities we want to display * @param int $permission - the permission we have for this contact * - * @return CRM_Contact_Selector_Activity - * @access public + * @param bool $admin + * @param string $context + * @param null $activityTypeIDs + * + * @return \CRM_Activity_Selector_Activity + @access public */ function __construct($contactId, $permission, diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 2bac2f3e69..96d9e00f1c 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -147,14 +147,17 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $activityClause if the caller wants to further restrict the search (used in activities) + * @param array $queryParams array of parameters for query + * @param \const|int $action - action of search basic or advanced. + * @param string $activityClause if the caller wants to further restrict the search (used in activities) * @param boolean $single are we dealing only with one contact? - * @param int $limit how many activities do we want returned + * @param int $limit how many activities do we want returned * - * @return CRM_Contact_Selector - * @access public + * @param string $context + * @param null $compContext + * + * @return \CRM_Activity_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, @@ -253,7 +256,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts); $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts); //get all activity types - $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE); + $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE); while ($result->fetch()) { $row = array(); diff --git a/CRM/Admin/Form/PaymentProcessorType.php b/CRM/Admin/Form/PaymentProcessorType.php index 9619a81fac..5e58b6d70b 100644 --- a/CRM/Admin/Form/PaymentProcessorType.php +++ b/CRM/Admin/Form/PaymentProcessorType.php @@ -148,6 +148,8 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { /** * Function to build the form * + * @param bool $check + * * @return void * @access public */ diff --git a/CRM/Admin/Page/CaseType.php b/CRM/Admin/Page/CaseType.php index 7f4e393f5b..d1bf11ea4a 100644 --- a/CRM/Admin/Page/CaseType.php +++ b/CRM/Admin/Page/CaseType.php @@ -114,6 +114,8 @@ class CRM_Admin_Page_CaseType extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/JobLog.php b/CRM/Admin/Page/JobLog.php index bafca22770..33b7db99b4 100644 --- a/CRM/Admin/Page/JobLog.php +++ b/CRM/Admin/Page/JobLog.php @@ -90,6 +90,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { /** * Browse all jobs. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/LabelFormats.php b/CRM/Admin/Page/LabelFormats.php index 0ea10a6b1c..c2ba8a8321 100644 --- a/CRM/Admin/Page/LabelFormats.php +++ b/CRM/Admin/Page/LabelFormats.php @@ -121,6 +121,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { /** * Browse all Label Format settings. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/Mapping.php b/CRM/Admin/Page/Mapping.php index 2746038eff..95c1ed9eb3 100644 --- a/CRM/Admin/Page/Mapping.php +++ b/CRM/Admin/Page/Mapping.php @@ -112,6 +112,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/Navigation.php b/CRM/Admin/Page/Navigation.php index 2a61bf86c4..8601ece1ab 100644 --- a/CRM/Admin/Page/Navigation.php +++ b/CRM/Admin/Page/Navigation.php @@ -83,6 +83,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/Options.php b/CRM/Admin/Page/Options.php index 6165a283b6..efdba99f13 100644 --- a/CRM/Admin/Page/Options.php +++ b/CRM/Admin/Page/Options.php @@ -281,6 +281,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/PaymentProcessorType.php b/CRM/Admin/Page/PaymentProcessorType.php index 52d7bf1fe2..ee2e4ac729 100644 --- a/CRM/Admin/Page/PaymentProcessorType.php +++ b/CRM/Admin/Page/PaymentProcessorType.php @@ -111,6 +111,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/PdfFormats.php b/CRM/Admin/Page/PdfFormats.php index 03f87ad24a..aa02684c29 100644 --- a/CRM/Admin/Page/PdfFormats.php +++ b/CRM/Admin/Page/PdfFormats.php @@ -106,6 +106,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { @@ -115,6 +117,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Browse all PDF Page Formats * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/PreferencesDate.php b/CRM/Admin/Page/PreferencesDate.php index 348f2a0535..638b1e7d8f 100644 --- a/CRM/Admin/Page/PreferencesDate.php +++ b/CRM/Admin/Page/PreferencesDate.php @@ -112,6 +112,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index cce71e3a7d..3658609603 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -338,7 +338,8 @@ class CRM_Badge_BAO_Badge { /** * function to build badges parameters before actually creating badges. * - * @param array $params associated array of submitted values + * @param array $params associated array of submitted values + * @param $form * @params object $form form/controller object * * @return void diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 40b572c41b..b216bbaf23 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -67,6 +67,8 @@ class CRM_Campaign_BAO_Query { /** * if survey, campaign are involved, add the specific fields. * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index c90b0dd14c..448ac7ad2a 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -1033,6 +1033,8 @@ INNER JOIN civicrm_survey survey ON ( activity.source_record_id = survey.id ) /** * Check and update the survey respondents. * + * @param $params + * * @return array success message */ public function releaseRespondent($params) { diff --git a/CRM/Campaign/PseudoConstant.php b/CRM/Campaign/PseudoConstant.php index c70de9a079..0314808037 100755 --- a/CRM/Campaign/PseudoConstant.php +++ b/CRM/Campaign/PseudoConstant.php @@ -72,6 +72,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param string $returnColumn + * * @return array - array reference of all survey activity types. * @static */ diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 6f22dceeba..1a8042144a 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -139,15 +139,18 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $surveyClause if the caller wants to further restrict the search. - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many voters do we want returned + * @param array $queryParams array of parameters for query + * @param \const|int $action - action of search basic or advanced. + * @param string $surveyClause if the caller wants to further restrict the search. + * @param boolean $single are we dealing only with one contact? + * @param int $limit how many voters do we want returned * - * @return CRM_Contact_Selector - * @access public - */ function __construct(&$queryParams, + * @param string $context + * + * @return \CRM_Campaign_Selector_Search + @access public + */ + function __construct(&$queryParams, $action = CRM_Core_Action::NONE, $surveyClause = NULL, $single = FALSE, diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index 2f2f9ef875..4b266633ca 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -93,6 +93,9 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * * @param array $values posted values of the form * + * @param $files + * @param $form + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index 0e7a68fb02..25a971ef34 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -125,6 +125,10 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @access public * + * @param $form + * @param $params + * @param $activity + * * @return void */ static function endPostProcess(&$form, &$params, $activity) { diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 636036fd7b..72a30c5344 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -111,6 +111,9 @@ class CRM_Case_Form_Activity_LinkCases { * * @access public * + * @param $form + * @param $params + * * @return void */ static function beginPostProcess(&$form, &$params) {} diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index 03f4ea68fd..92334f738c 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -89,6 +89,8 @@ class CRM_Case_Form_Activity_OpenCase { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index 794720600b..bbecf90cf8 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -150,7 +150,11 @@ class CRM_Case_Form_Task extends CRM_Core_Form { * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $type button type for the form after processing + * @param string $nextType + * @param string $backType + * @param bool $submitOnce + * + * @internal param string $type button type for the form after processing * * @return void * @access public diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 6d4fbaf356..3f6aca3a93 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -135,15 +135,18 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $additionalClause if the caller wants to further restrict the search (used in participations) + * @param array $queryParams array of parameters for query + * @param \const|int $action - action of search basic or advanced. + * @param string $additionalClause if the caller wants to further restrict the search (used in participations) * @param boolean $single are we dealing only with one contact? - * @param int $limit how many signers do we want returned + * @param int $limit how many signers do we want returned * - * @return CRM_Contact_Selector - * @access public - */ function __construct(&$queryParams, + * @param string $context + * + * @return \CRM_Case_Selector_Search + @access public + */ + function __construct(&$queryParams, $action = CRM_Core_Action::NONE, $additionalClause = NULL, $single = FALSE, diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index c0cada5018..c44d138b2d 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -1035,12 +1035,13 @@ WHERE id={$id}; "; * * @param int $id - id of the contact whose contact sub type is needed * + * @param null $implodeDelimiter + * * @return string contact_sub_type if $id found else null "" * * @access public * * @static - * */ public static function getContactSubType($id, $implodeDelimiter = NULL) { $subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type'); @@ -1096,12 +1097,14 @@ WHERE id={$id}; "; * The ordering is important, since currently we do not have a weight * scheme. Adding weight is super important * - * @param int $contactType contact Type - * @param boolean $status status is used to manipulate first title - * @param boolean $showAll if true returns all fields (includes disabled fields) - * @param boolean $isProfile if its profile mode + * @param int|string $contactType contact Type + * @param boolean $status status is used to manipulate first title + * @param boolean $showAll if true returns all fields (includes disabled fields) + * @param boolean $isProfile if its profile mode * @param boolean $checkPermission if false, do not include permissioning clause (for custom data) * + * @param bool $withMultiCustomFields + * * @return array array of importable Fields * @access public * @static diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 8243b9989f..19fe9e5236 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -83,10 +83,11 @@ WHERE contact_a.id = %1 AND $permission"; /** * fill the acl contact cache for this contact id if empty * - * @param int $id contact id - * @param string $type the type of operation (view|edit) - * @param boolean $force should we force a recompute + * @param $userID + * @param int|string $type the type of operation (view|edit) + * @param boolean $force should we force a recompute * + * @internal param int $id contact id * @return void * @access public * @static diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 747a2dec5c..4f2a747e64 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -68,9 +68,10 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { * *function to retrieve basic contact type information. * - *@return array of basic contact types information. - *@static + * @param bool $all * + * @return array of basic contact types information. + * @static */ static function &basicTypeInfo($all = FALSE) { static $_cache = NULL; diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 73ea6d8e94..d81842a884 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -280,9 +280,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * identified by $groupId; does not delete child group, just the * association between the two * - * @param $parentID The id of the group to remove the child from * @param $childID The id of the child group being removed * + * @internal param \The $parentID id of the group to remove the child from * @return void * * @access public diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 1a3750ea34..ec2c1b12ea 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -1174,10 +1174,11 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) * @param $contactId Int contact id * @param $params array array of values submitted by POST * @param $ids array array of ids - * @param $action which action called this function + * @param \const|\which $action which action called this function * - * @static + * @param bool $active * + * @static */ static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action::ADD, $active = TRUE) { // Check the end date and set the status of the relationship diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index 773621dcd6..c786bfaab4 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -294,8 +294,12 @@ class CRM_Contact_Form_Edit_Address { /** * check for correct state / country mapping. * - * @param array reference $fields - submitted form values. - * @param array reference $errors - if any errors found add to this array. please. + * @param $fields + * @param $files + * @param $self + * + * @internal param \reference $array $fields - submitted form values. + * @internal param \reference $array $errors - if any errors found add to this array. please. * * @return true if no errors * array of errors if any present. diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 72423c5c9f..bace5d842e 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -66,9 +66,11 @@ class CRM_Contact_Form_Inline_Lock { /** * Ensure that oplock_ts 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/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 4a6e623040..9447561c9d 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -122,9 +122,11 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { /** * global form rule * - * @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 $form + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 76350522b2..6632f9ba8d 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -84,6 +84,8 @@ class CRM_Contact_Form_Task_SMSCommon { * * @access public * + * @param $form + * * @return void */ static function buildQuickForm(&$form) { diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index 03ef69cc93..e6f03f3f20 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -971,6 +971,8 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { * format custom field name. * combine group and field name to avoid conflict. * + * @param $fields + * * @return void * @access public */ diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index d098e9e0ea..b8400623bd 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -220,10 +220,12 @@ SELECT r.payment_processor_id /** * Cancel Recurring contribution. * - * @param integer $recurId recur contribution id. - * @param array $objects an array of objects that is to be cancelled like + * @param integer $recurId recur contribution id. + * @param array $objects an array of objects that is to be cancelled like * contribution, membership, event. At least contribution object is a must. * + * @param array $activityParams + * * @return true / false. * @access public * @static diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index decd095431..f67c0da6cc 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -138,11 +138,13 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Function to retrieve soft contributions for contribution record. - * @param array $params an associated array - * @param boolean $all include PCP data * - * @return array of soft contribution ids, amounts, and associated contact ids - * @static + * @param $contributionID + * @param boolean $all include PCP data + * + * @internal param array $params an associated array + * @return array of soft contribution ids, amounts, and associated contact ids + * @static */ static function getSoftContribution($contributionID, $all = FALSE) { $pcpFields = array( @@ -222,10 +224,13 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Function to retrieve the list of soft contributions for given contact. - * @param int $contact_id contact id * - * @return array - * @static + * @param int $contact_id contact id + * + * @param int $isTest + * + * @return array + * @static */ static function getSoftContributionList($contact_id, $isTest = 0) { $query = ' diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index 1170b22c2e..dc6006a533 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -66,6 +66,8 @@ class CRM_Contribute_BAO_Query { /** * if contributions are involved, add the specific contribute fields * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 1e9c8fc424..54a64d74cd 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -39,6 +39,8 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * + * @param $form + * * @return void */ static function buildPremium(&$form) { diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index 3ce3f6b851..15c9fc411d 100644 --- a/CRM/Contribute/Form/Contribution/OnBehalfOf.php +++ b/CRM/Contribute/Form/Contribution/OnBehalfOf.php @@ -37,6 +37,8 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { /** * Function to set variables up before form is built * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index 5da4d04e33..97cddfafce 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -233,6 +233,9 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ * * @param array $values posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public @@ -257,7 +260,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ if (! CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional) && ! CRM_Core_BAO_UFGroup::checkValidProfile($id, $requiredProfileFields) ) { $errors['onbehalf_profile_id'] = ts('Profile does not contain the minimum required fields for an On Behalf Of Organization'); - } + } } } diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 0275bc637d..7c576cd69f 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -231,6 +231,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * * @return mixed true or array of errors * @access public * @static diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index a61dbff988..337eef6ae5 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -41,6 +41,8 @@ class CRM_Contribute_Form_SoftCredit { /** * Function to set variables up before form is built * + * @param $form + * * @return void * @access static */ diff --git a/CRM/Contribute/Page/Premium.php b/CRM/Contribute/Page/Premium.php index 39d9425e89..c816e7caed 100644 --- a/CRM/Contribute/Page/Premium.php +++ b/CRM/Contribute/Page/Premium.php @@ -218,6 +218,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index dd5977c251..5811c00277 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -148,6 +148,12 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * Get all the financial Accounts * * @access public + * + * @param null $id + * @param null $financialAccountTypeId + * @param string $retrieveColumn + * @param string $key + * * @return array - array reference of all financial accounts if any * @static */ diff --git a/CRM/Contribute/Task.php b/CRM/Contribute/Task.php index 72c85291e0..146daba42d 100644 --- a/CRM/Contribute/Task.php +++ b/CRM/Contribute/Task.php @@ -151,6 +151,8 @@ class CRM_Contribute_Task { * * @param int $permission * + * @param bool $softCreditFiltering + * * @return array set of tasks that are valid for the user * @access public */ diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 5ce9603c3a..5faaeebd46 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -64,6 +64,8 @@ class CRM_Core_BAO_ConfigSetting { * * @params array $params associated array of civicrm variables * + * @param $params + * * @return null * @static */ @@ -145,6 +147,8 @@ class CRM_Core_BAO_ConfigSetting { * * @params array $params associated array of civicrm variables * + * @param $params + * * @return null * @static */ diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index ad3b3b76e2..77576d3559 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -296,14 +296,18 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * * @param string $entityType - of the contact whose contact type is needed * @param object $form - not used but required - * @param int $entityId - optional - id of entity if we need to populate the tree with custom values. - * @param int $groupId - optional group id (if we need it for a single group only) - * - if groupId is 0 it gets for inline groups only - * - if groupId is -1 we get for all groups + * @param null $entityID + * @param null $groupID * @param string $subType * @param string $subName * @param boolean $fromCache * + * @param null $onlySubType + * + * @internal param int $entityId - optional - id of entity if we need to populate the tree with custom values. + * @internal param int $groupId - optional group id (if we need it for a single group only) + * - if groupId is 0 it gets for inline groups only + * - if groupId is -1 we get for all groups * @return array $groupTree - array The returned array is keyed by group id and has the custom group table fields * and a subkey 'fields' holding the specific custom fields. * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data @@ -316,7 +320,6 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @access public * * @static - * */ public static function &getTree( $entityType, @@ -833,16 +836,17 @@ ORDER BY civicrm_custom_group.weight, * * An array containing custom group details (including their custom field) is returned. * - * @param int $groupId - group id whose details are needed + * @param int $groupId - group id whose details are needed * @param boolean $searchable - is this field searchable - * @param array $extends - which table does it extend if any + * @param array $extends - which table does it extend if any + * + * @param null $inSelector * * @return array $groupTree - array consisting of all group and field details * * @access public * * @static - * */ public static function &getGroupDetail($groupId = NULL, $searchable = NULL, &$extends = NULL, $inSelector = NULL) { // create a new tree diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index eca547815a..0317c867d7 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -114,6 +114,7 @@ class CRM_Core_BAO_CustomOption { * * @param $fieldId int the custom field ID * @pram $value string the value (typically from the DB) of this custom field + * @param $value * @param $htmlType string the html type of the field (optional) * @param $dataType string the data type of the field (optional) * diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index 8d24c15d5a..1644cee4e3 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -108,9 +108,10 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { /** * Determine in which discount set the registration date falls * - * @param integer $entityId entity id to be searched - * @param string $entityTable entity table to be searched + * @param $entityID + * @param string $entityTable entity table to be searched * + * @internal param int $entityId entity id to be searched * @return integer $dao->id discount id of the set which matches * the date criteria */ diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index 6e0872681a..258cb4de4e 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -128,6 +128,8 @@ WHERE contact_id = {$params['contact_id']} * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * * @return array the array of email id's * @access public * @static diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 17d2651b30..62c7c629ba 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -103,6 +103,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @params array $params (reference ) an assoc array of name/value pairs * + * @param $params + * * @return boolean * @access public * @static @@ -221,7 +223,10 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * takes an associative array and creates tag entity record for all tag entities * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $contactId contact id + * @param $entityTable + * @param $entityID + * + * @internal param array $contactId contact id * * @return void * @access public diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 9169b8e579..2afa4b2159 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -133,10 +133,13 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param string $entityTable name of the entity table usually 'civicrm_contact' - * @param int $entityID id of the entity usually the contactID. - * @param string $orderBy to get single trxn id for a entity table i.e last or first. + * @param $entity_id + * @param string $orderBy to get single trxn id for a entity table i.e last or first. * + * @param bool $newTrxn + * + * @internal param string $entityTable name of the entity table usually 'civicrm_contact' + * @internal param int $entityID id of the entity usually the contactID. * @return array( ) reference $tag array of catagory id's the contact belongs to. * * @access public diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index f8247a1711..de2f9384cc 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -121,7 +121,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { * Function to add a Location Type * * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * + * @internal param array $ids reference array contains the id * * @access public * @static diff --git a/CRM/Core/BAO/Log.php b/CRM/Core/BAO/Log.php index 8500c27034..dac5f77e9d 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -141,7 +141,9 @@ UPDATE civicrm_log /** * Function to get log record count for a Contact * - * @param int $contactId Contact ID + * @param $contactID + * + * @internal param int $contactId Contact ID * * @return int count of log records * @access public diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 9ac565358f..947fb4482f 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -131,6 +131,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * @access public * @static * + * @param bool $all + * * @return object */ static function getMessageTemplates($all = TRUE) { diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 33816630e2..dd9a80d726 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -229,7 +229,9 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * Function to delete Option Value * - * @param int $optionGroupId Id of the Option Group to be deleted. + * @param $optionValueId + * + * @internal param int $optionGroupId Id of the Option Group to be deleted. * * @return boolean * diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 3ffa3db2ce..31d9cfdee7 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -103,6 +103,10 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * @param null $type + * @param array $filters + * * @return array the array of phone ids which are potential numbers * @access public * @static diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 858a791370..04b1ce0ae1 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -233,6 +233,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Store multiple items in the setting table * * @param array $params (required) An api formatted array of keys and values + * @param null $domains + * @param $settingsToReturn + * * @domains array an array of domains to get settings for. Default is the current domain * @return void * @static @@ -1032,6 +1035,10 @@ AND domain_id = %3 * Determine what, if any, overrides have been provided * for a setting. * + * @param $group + * @param $name + * @param $default + * * @return mixed, NULL or an overriden value */ protected static function getOverride($group, $name, $default) { diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index bb8e1587d3..7f93736430 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -129,7 +129,10 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array entityBlock input parameters to find object + * @param $params + * @param $values + * + * @internal param \entityBlock $array input parameters to find object * * @return boolean * @access public diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index fff0161f9e..f8008a290e 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -102,6 +102,8 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Create a new WordReplacement * + * @param $params + * * @return WordReplacement array * @access public */ diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index 537ef02d09..f2a71281be 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -280,6 +280,8 @@ class CRM_Core_Block { * php is lame and u cannot call functions from static initializers * hence this hack * + * @param $id + * * @return void * @access private */ diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 7490c2af38..24bef08f9d 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -153,9 +153,11 @@ abstract class CRM_Core_Component_Info { * * NOTE: if using conditionally permission return, * implementation of $getAllUnconditionally is required. + * + * @param bool $getAllUnconditionally + * * @return array|null collection of permissions, null if none * @access public - * */ abstract public function getPermissions($getAllUnconditionally = FALSE); diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php index 3b7e5e6547..3cc1480ed7 100644 --- a/CRM/Core/Config/Defaults.php +++ b/CRM/Core/Config/Defaults.php @@ -88,8 +88,8 @@ class CRM_Core_Config_Defaults { /** * Function to set the default values * - * @param array $defaults associated array of form elements - * @param boolena $formMode this funtion is called to set default + * @param array $defaults associated array of form elements + * @param bool|\boolena $formMode this funtion is called to set default * values in an empty db, also called when setting component using GUI * this variable is set true for GUI * mode (eg: Global setting >> Components) diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 0eec8b1632..9d0bcc6a4e 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -1162,11 +1162,14 @@ SELECT contact_id * of time. This is the inverse function of create. It also stores all the retrieved * values in the default array * - * @param string $daoName name of the dao object - * @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 $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') - * + * @param string $daoName name of the dao object + * @param string $fieldIdName + * @param $fieldId + * @param $details + * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') + * + * @internal param array $params (reference ) an assoc array of name/value pairs + * @internal param array $defaults (reference ) an assoc array to hold the flattened values * @return object an object of type referenced by daoName * @access public * @static diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index f9a49c894c..5522abda16 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -83,6 +83,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * singleton function used to manage this object. * + * @param null $package + * @param bool $msgCallback + * @param bool $contextCallback + * @param bool $throwPEAR_Error + * @param string $stackClass + * * @return object * @static */ diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 052c71ec02..0935d33487 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -142,13 +142,13 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * We should not use QuickForm directly. This class provides a lot * of default convenient functions, rules and buttons * - * @param object $state State associated with this form - * @param enum $action The mode the form is operating in (None/Create/View/Update/Delete) - * @param string $method The type of http method used (GET/POST) - * @param string $name The name of the form if different from class name + * @param object $state State associated with this form + * @param \const|\enum $action The mode the form is operating in (None/Create/View/Update/Delete) + * @param string $method The type of http method used (GET/POST) + * @param string $name The name of the form if different from class name * - * @return object - * @access public + * @return \CRM_Core_Form + @access public */ function __construct( $state = NULL, diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index ad3cf45306..747f8f0d29 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -112,11 +112,14 @@ class CRM_Core_Payment_BaseIPN { * Load objects related to contribution * * @input array information from Payment processor + * + * @param $input * @param array $ids * @param array $objects * @param boolean $required * @param integer $paymentProcessorID * @param array $error_handling + * * @return multitype:number NULL |boolean */ function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) { diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index 4491ba8987..ac58928aa9 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -54,9 +54,12 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index 95c0e33149..55ded8b3e6 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -58,9 +58,10 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 0ef3495ed2..02628ac23e 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -140,6 +140,8 @@ class CRM_Core_Payment_Form { /** * create all fields needed for a credit card transaction * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index c2f291e6e2..c87d52f02d 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -91,11 +91,12 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { /** * The function gets called when a new order takes place. * - * @param xml $dataRoot response send by google in xml format + * @param xml $dataRoot response send by google in xml format * @param array $privateData contains the name value pair of * - * @return void + * @param $component * + * @return void */ function newOrderNotify($dataRoot, $privateData, $component) { $ids = $input = $params = array(); diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 760ad6c038..509d07774f 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -51,9 +51,12 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = false) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index 205fdb67ea..653eabf65b 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -67,9 +67,12 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static - * */ static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index b519abb2f0..b46c792b8b 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -90,6 +90,10 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { * * @param string $mode the mode of operation: live or test * + * @param $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static */ @@ -103,11 +107,15 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { /** * The function gets called when a new order takes place. * - * @param xml $dataRoot response send by google in xml format + * @param $success * @param array $privateData contains the name value pair of * - * @return void + * @param $component + * @param $amount + * @param $transactionReference * + * @internal param \xml $dataRoot response send by google in xml format + * @return void */ function newOrderNotify($success, $privateData, $component, $amount, $transactionReference) { $ids = $input = $params = array(); diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 322d108af4..cbf81ec2bc 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -108,8 +108,10 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void - **********************************************************/ + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_eWAY ******************************************************* + */ function __construct($mode, &$paymentProcessor) { // require Standaard eWAY API libraries require_once 'eWAY/eWAY_GatewayRequest.php'; @@ -126,9 +128,12 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = false) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index febe9249c3..971722508a 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -819,10 +819,11 @@ WHERE id = %1"; * @access public * @static * - * @param int $id - Optional id to return + * @param bool|int $id - Optional id to return * - * @return array - array reference of all countries. + * @param bool $applyLimit * + * @return array - array reference of all countries. */ public static function country($id = FALSE, $applyLimit = TRUE) { if (($id && !CRM_Utils_Array::value($id, self::$country)) || !self::$country || !$id) { @@ -961,8 +962,9 @@ WHERE id = %1"; * @access public * @static * - * @return mixed - instance of CRM_Contact_BAO_GroupNesting + * @param bool $styledLabels * + * @return mixed - instance of CRM_Contact_BAO_GroupNesting */ public static function &groupIterator($styledLabels = FALSE) { if (!self::$groupIterator) { @@ -986,14 +988,13 @@ WHERE id = %1"; * * Note: any database errors will be trapped by the DAO. * - * @param string $groupType type of group(Access/Mailing) - * @param boolen $excludeHidden exclude hidden groups. - + * @param string $groupType type of group(Access/Mailing) + * @param bool|\boolen $excludeHidden exclude hidden groups. + * * @access public * @static * * @return array - array reference of all groups. - * */ public static function group($groupType = NULL, $excludeHidden = TRUE) { return CRM_Core_Permission::group($groupType, $excludeHidden); @@ -1011,8 +1012,11 @@ WHERE id = %1"; * @access public * @static * - * @return array - array reference of all groups. + * @param bool $onlyPublic + * @param null $groupType + * @param bool $excludeHidden * + * @return array - array reference of all groups. */ public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) { if (!self::$staticGroup) { diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index a6ec11548a..0501b2c19c 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -104,8 +104,9 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { * render the page using a custom templating * system * - * @param object $page the CRM_Core_Form page - * @param boolean $ret should we echo or return output + * @param object $page the CRM_Core_Form page + * + * @internal param bool $ret should we echo or return output * * @return void * @access public diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 070ec48ba2..7343de9249 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -128,6 +128,8 @@ class CRM_Core_Resources { * Construct a resource manager * * @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs. + * @param $cache + * @param null $cacheCodeKey */ public function __construct($extMapper, $cache, $cacheCodeKey = NULL) { $this->extMapper = $extMapper; @@ -545,7 +547,7 @@ class CRM_Core_Resources { */ function addLocalization(&$js) { $config = CRM_Core_Config::singleton(); - + // Localize select2 strings $contactSearch = json_encode($config->includeEmailInName ? ts('Start typing a name or email...') : ts('Start typing a name...')); $otherSearch = json_encode(ts('Enter search term...')); diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 50a8ff605b..964d423315 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -149,6 +149,8 @@ class CRM_Core_Session { * * @access public * + * @param int $all + * * @return void */ function reset($all = 1) { diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index 33ac082296..f5ae04d230 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -87,8 +87,10 @@ class CRM_Core_StateMachine { * * @param object $controller the controller for this state machine * - * @return object - * @access public + * @param const $action + * + * @return \CRM_Core_StateMachine + @access public */ function __construct(&$controller, $action = CRM_Core_Action::NONE) { $this->_controller = &$controller; diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index fa8fb645da..82720dcc0a 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -112,9 +112,11 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { /** * global form rule * - * @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 $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index d62dcf05fd..76c886b071 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -231,12 +231,14 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * Function to delete the location block associated with an event, * if not being used by any other event. * - * @param int $loc_block_id location block id to be deleted - * @param int $eventid event id with which loc block is associated + * @param $locBlockId + * @param null $eventId + * + * @internal param int $loc_block_id location block id to be deleted + * @internal param int $eventid event id with which loc block is associated * * @access public * @static - * */ static function deleteEventLocBlock($locBlockId, $eventId = NULL) { $query = "SELECT count(ce.id) FROM civicrm_event ce WHERE ce.loc_block_id = $locBlockId"; @@ -1016,6 +1018,12 @@ WHERE civicrm_event.is_active = 1 /** * Process that send e-mails * + * @param $contactID + * @param $values + * @param $participantId + * @param bool $isTest + * @param bool $returnMessageText + * * @return void * @access public */ @@ -1182,6 +1190,15 @@ WHERE civicrm_event.is_active = 1 * Function to add the custom fields OR array of participant's * profile info * + * @param $id + * @param $name + * @param $cid + * @param $template + * @param $participantId + * @param $isTest + * @param bool $isCustomProfile + * @param array $participantParams + * * @return void * @access public */ diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index b57cf83e10..046fe4e8a1 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -73,6 +73,8 @@ class CRM_Event_Form_EventFees { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 7a55d39b56..50fe65fba4 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -832,6 +832,9 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * Process the participant * + * @param $params + * @param $contactID + * * @return void * @access public */ diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php index 10bb2773c9..4905bc8f1a 100644 --- a/CRM/Event/Form/Registration/Confirm.php +++ b/CRM/Event/Form/Registration/Confirm.php @@ -821,6 +821,13 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { /** * Process the contribution * + * @param $form + * @param $params + * @param $result + * @param $contactID + * @param bool $pending + * @param bool $isAdditionalAmount + * * @return void * @access public */ @@ -934,6 +941,10 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { /** * Fix the Location Fields * + * @param $params + * @param $fields + * @param $form + * * @return void * @access public */ @@ -978,6 +989,11 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { /** * function to update contact fields * + * @param $contactID + * @param $params + * @param $fields + * @param $form + * * @return void * @access public */ diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index 123be8b2b5..3d74af6548 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -341,6 +341,8 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ diff --git a/CRM/Event/Page/ManageEvent.php b/CRM/Event/Page/ManageEvent.php index 31d46c50ff..85b2ab12f7 100644 --- a/CRM/Event/Page/ManageEvent.php +++ b/CRM/Event/Page/ManageEvent.php @@ -100,6 +100,8 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { /** * Get tab Links for events * + * @param $enableCart + * * @return array (reference) of tab links */ static function &tabs($enableCart) { @@ -359,7 +361,7 @@ ORDER BY start_date desc $manageEvent[$dao->id]['reminder'] = CRM_Core_BAO_ActionSchedule::isConfigured($dao->id, $mappingID); $manageEvent[$dao->id]['is_pcp_enabled'] = CRM_Utils_Array::value($dao->id, $eventPCPS); $manageEvent[$dao->id]['event_type'] = CRM_Utils_Array::value($manageEvent[$dao->id]['event_type_id'], $eventType); - + // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled CRM_Utils_Hook::tabset('civicrm/event/manage/rows', $manageEvent, array('event_id' => $dao->id)); } diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index b17ccb8a9b..4fc943f9c9 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -112,6 +112,9 @@ class CRM_Export_Form_Map extends CRM_Core_Form { * * @param array $fields posted values of the form * + * @param $values + * @param $mappingTypeId + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php index ad6610dabb..a469436713 100644 --- a/CRM/Extension/Container/Basic.php +++ b/CRM/Extension/Container/Basic.php @@ -231,7 +231,7 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface /** * Scan $basedir for a list of extension-keys * - * @param string $dirSep the local system's directory separator + * @internal param string $dirSep the local system's directory separator * @return array($key => $relUrl) */ protected function getRelUrls() { diff --git a/CRM/Extension/Container/Collection.php b/CRM/Extension/Container/Collection.php index 4a2a12b430..1ea76c7ab8 100644 --- a/CRM/Extension/Container/Collection.php +++ b/CRM/Extension/Container/Collection.php @@ -124,8 +124,10 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte /** * Get the container which defines a particular key * + * @param $key + * + * @throws CRM_Extension_Exception_MissingException * @return CRM_Extension_Container_Interface - * @throws CRM_Extension_Exception */ public function getContainer($key) { $k2c = $this->getKeysToContainer(); diff --git a/CRM/Financial/Page/BatchTransaction.php b/CRM/Financial/Page/BatchTransaction.php index 33c571d7de..1462f46254 100644 --- a/CRM/Financial/Page/BatchTransaction.php +++ b/CRM/Financial/Page/BatchTransaction.php @@ -150,6 +150,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = null) { diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index b9cb07fc29..7d34c59ac8 100644 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -124,7 +124,9 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * CRM-12814 * Get opened count for each mailing for a given set of mailing IDs * - * @param int $contactID ID of the mailing + * @param $mailingIDs + * + * @internal param int $contactID ID of the mailing * * @return array Opened count per mailing ID * @access public diff --git a/CRM/Mailing/MailStore/Imap.php b/CRM/Mailing/MailStore/Imap.php index 4489e384af..c45afc6d99 100644 --- a/CRM/Mailing/MailStore/Imap.php +++ b/CRM/Mailing/MailStore/Imap.php @@ -40,13 +40,13 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { /** * Connect to the supplied IMAP server and make sure the two mailboxes exist * - * @param string $host host to connect to - * @param string $username authentication username - * @param string $password authentication password - * @param bool $ssl whether to use IMAP or IMAPS - * @param string $folder name of the inbox folder + * @param string $host host to connect to + * @param string $username authentication username + * @param string $password authentication password + * @param bool $ssl whether to use IMAP or IMAPS + * @param string $folder name of the inbox folder * - * @return void + * @return \CRM_Mailing_MailStore_Imap */ function __construct($host, $username, $password, $ssl = TRUE, $folder = 'INBOX') { // default to INBOX if an empty string diff --git a/CRM/Mailing/MailStore/Localdir.php b/CRM/Mailing/MailStore/Localdir.php index cf032d7d7c..fc9ad0619b 100644 --- a/CRM/Mailing/MailStore/Localdir.php +++ b/CRM/Mailing/MailStore/Localdir.php @@ -40,9 +40,9 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Connect to the supplied dir and make sure the two mail dirs exist * - * @param string $dir dir to operate upon + * @param string $dir dir to operate upon * - * @return void + * @return \CRM_Mailing_MailStore_Localdir */ function __construct($dir) { $this->_dir = $dir; diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php index cbc5abb1e6..6af2f38a4b 100644 --- a/CRM/Mailing/MailStore/Maildir.php +++ b/CRM/Mailing/MailStore/Maildir.php @@ -40,9 +40,9 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Connect to the supplied dir and make sure the two mail dirs exist * - * @param string $dir dir to operate upon + * @param string $dir dir to operate upon * - * @return void + * @return \CRM_Mailing_MailStore_Maildir */ function __construct($dir) { $this->_dir = $dir; diff --git a/CRM/Mailing/MailStore/Mbox.php b/CRM/Mailing/MailStore/Mbox.php index 4eefb41c8c..640a4565d7 100644 --- a/CRM/Mailing/MailStore/Mbox.php +++ b/CRM/Mailing/MailStore/Mbox.php @@ -40,9 +40,9 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { /** * Connect to and lock the supplied file and make sure the two mail dirs exist * - * @param string $file mbox to operate upon + * @param string $file mbox to operate upon * - * @return void + * @return \CRM_Mailing_MailStore_Mbox */ function __construct($file) { $this->_transport = new ezcMailMboxTransport($file); diff --git a/CRM/Mailing/MailStore/Pop3.php b/CRM/Mailing/MailStore/Pop3.php index 3b52920d8c..6927b982bd 100644 --- a/CRM/Mailing/MailStore/Pop3.php +++ b/CRM/Mailing/MailStore/Pop3.php @@ -40,12 +40,12 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { /** * Connect to the supplied POP3 server and make sure the two mail dirs exist * - * @param string $host host to connect to - * @param string $username authentication username - * @param string $password authentication password - * @param bool $ssl whether to use POP3 or POP3S + * @param string $host host to connect to + * @param string $username authentication username + * @param string $password authentication password + * @param bool $ssl whether to use POP3 or POP3S * - * @return void + * @return \CRM_Mailing_MailStore_Pop3 */ function __construct($host, $username, $password, $ssl = TRUE) { if ($this->_debug) { diff --git a/CRM/Mailing/Page/Component.php b/CRM/Mailing/Page/Component.php index 8e9c0dc3a2..29b1ce633b 100644 --- a/CRM/Mailing/Page/Component.php +++ b/CRM/Mailing/Page/Component.php @@ -106,6 +106,8 @@ class CRM_Mailing_Page_Component 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 e26cbf1f92..c023780a84 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -83,7 +83,10 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -374,7 +377,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } } - if (in_array($row['status'], array('Complete', 'Canceled')) && + if (in_array($row['status'], array('Complete', 'Canceled')) && !$row['archived']) { if ($allAccess || $showCreateLinks) { $actionMask |= CRM_Core_Action::RENEW; diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index b2fb3f8d87..91a838ed65 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -227,7 +227,10 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -308,7 +311,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ $row['action'] = CRM_Core_Action::formLink( self::links($qfKey, $this->_context), - $mask, + $mask, $actions, ts('more'), FALSE, @@ -405,4 +408,4 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ function getExportFileName($output = 'csv') { return ts('CiviCRM Mailing Search'); } -} \ No newline at end of file +} diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 196a26356a..65986ebabc 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -108,6 +108,8 @@ WHERE civicrm_pcp.contact_id = civicrm_contact.id /** * Function to return PCP Block info for dashboard * + * @param $contactId + * * @return array array of Pcp if found * @access public * @static @@ -788,12 +790,13 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get email is enabled for supporter's profile * - * @param int $id supporter's profile id + * @param $profileId + * + * @internal param int $id supporter's profile id * * @return boolean * @access public * @static - * */ static function checkEmailProfile($profileId) { $query = " @@ -812,12 +815,14 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; /** * Function to obtain the title of page associated with a pcp * - * @param int $id campaign page id + * @param $pcpId + * @param $component + * + * @internal param int $id campaign page id * * @return int * @access public * @static - * */ static function getPcpPageTitle($pcpId, $component) { if ($component == 'contribute') { @@ -842,12 +847,14 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; /** * Function to get pcp block & entity id given pcp id * - * @param int $id campaign page id + * @param $pcpId + * @param $component + * + * @internal param int $id campaign page id * * @return String * @access public * @static - * */ static function getPcpBlockEntityId($pcpId, $component) { $entity_table = self::getPcpEntityTable($component); diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 8748975e03..81fb98a54e 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -149,9 +149,11 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { /** * global form rule * - * @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 $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index 93ebe2a570..763d00ed0f 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -107,6 +107,9 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * @param $self + * * @return mixed true or array of errors * @access public * @static diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index 29c8f4db4c..fee8dd964a 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -135,6 +135,9 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * @param $self + * * @return mixed true or array of errors * @access public * @static diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 746d94ab4e..e6409af0fe 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -147,7 +147,11 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $type button type for the form after processing + * @param string $nextType + * @param string $backType + * @param bool $submitOnce + * + * @internal param string $type button type for the form after processing * * @return void * @access public diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index efb7957048..20ff8f740e 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -109,6 +109,9 @@ AND li.entity_id = {$entityId} * @param $entityId int participant/contribution id * @param $entity string participant/contribution. * + * @param null $isQuick + * @param bool $isQtyZero + * * @return array of line items */ static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE) { @@ -277,12 +280,16 @@ AND li.entity_id = {$entityId} /** * Function to process price set and line items. - * @param int $contributionId contribution id + * + * @param $entityId * @param array $lineItem line item array * @param object $contributionDetails - * @param decimal $initAmount amount * @param string $entityTable entity table * + * @param bool $update + * + * @internal param int $contributionId contribution id + * @internal param \decimal $initAmount amount * @access public * @return void * @static diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 579450d375..2183747326 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -130,7 +130,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param int $fieldId price_field_id * @param array $values (reference ) to hold the values * @param string $orderBy for order by, default weight - * @param int $isActive is_active, default false + * @param bool|int $isActive is_active, default false * * @return array $values * diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 691badd6e5..d2413bac5b 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -788,6 +788,8 @@ WHERE id = %1"; /** * Function to build the price set form. * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index ff7585774c..31cef0b8e5 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -146,7 +146,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { /** * Get 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/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index afd4cf0dd4..b612a78f4a 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -231,9 +231,9 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { /** * Delete the instance of the Report * - * @return $results no of deleted Instance on success, false otherwise - * @access public + * @param null $id * + * @return mixed $results no of deleted Instance on success, false otherwise@access public */ static function del($id = NULL) { $dao = new CRM_Report_DAO_ReportInstance(); diff --git a/CRM/Utils/Cache/Memcached.php b/CRM/Utils/Cache/Memcached.php index 9962f7bf8f..9fcaff8261 100644 --- a/CRM/Utils/Cache/Memcached.php +++ b/CRM/Utils/Cache/Memcached.php @@ -81,8 +81,9 @@ class CRM_Utils_Cache_Memcached { /** * Constructor * - * @param array $config an array of configuration params - * @return void + * @param array $config an array of configuration params + * + * @return \CRM_Utils_Cache_Memcached */ function __construct($config) { if (isset($config['host'])) { diff --git a/api/v3/examples/SurveyRespondant/Get.php b/api/v3/examples/SurveyRespondant/Get.php index 8f0c63c0f8..db6f90510b 100644 --- a/api/v3/examples/SurveyRespondant/Get.php +++ b/api/v3/examples/SurveyRespondant/Get.php @@ -1,6 +1,6 @@