From da6b46f4a1c9a3dfd1502637efad4fa003eee61a Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 13:35:28 +1200 Subject: [PATCH] bulk comment fix --- CRM/ACL/API.php | 8 +++++- CRM/Activity/BAO/Query.php | 4 +++ CRM/Activity/Selector/Activity.php | 5 +++- CRM/Activity/Selector/Search.php | 5 +++- CRM/Admin/Page/ContactType.php | 2 ++ CRM/Admin/Page/EventTemplate.php | 2 ++ CRM/Admin/Page/Extensions.php | 2 ++ CRM/Admin/Page/Job.php | 2 ++ CRM/Admin/Page/JobLog.php | 2 ++ CRM/Admin/Page/MailSettings.php | 4 ++- CRM/Admin/Page/PaymentProcessor.php | 2 ++ CRM/Campaign/Form/Petition/Signature.php | 4 +++ CRM/Campaign/Form/Task.php | 6 +++- CRM/Campaign/Form/Task/Reserve.php | 3 ++ CRM/Campaign/Page/SurveyType.php | 2 ++ CRM/Campaign/PseudoConstant.php | 3 +- CRM/Campaign/Selector/Search.php | 5 +++- CRM/Case/BAO/CaseType.php | 5 ++-- CRM/Case/Form/Activity/OpenCase.php | 3 ++ CRM/Case/Form/Case.php | 3 ++ CRM/Case/Selector/Search.php | 4 ++- CRM/Contact/BAO/Contact/Location.php | 5 +++- CRM/Contact/BAO/Contact/Permission.php | 4 +-- CRM/Contact/BAO/Contact/Utils.php | 7 +++-- CRM/Contact/BAO/ContactType.php | 5 ++-- CRM/Contact/BAO/GroupContact.php | 2 ++ CRM/Contact/Form/DedupeRules.php | 3 ++ CRM/Contact/Form/Task/AddToGroup.php | 4 ++- CRM/Contact/Form/Task/AddToHousehold.php | 4 +-- CRM/Contact/Form/Task/EmailCommon.php | 2 ++ CRM/Contact/Form/Task/ProximityCommon.php | 2 ++ CRM/Contact/Import/Form/Preview.php | 3 ++ CRM/Contact/Page/DedupeRules.php | 2 ++ CRM/Contact/Selector/Custom.php | 5 +++- CRM/Contribute/BAO/ContributionRecur.php | 2 ++ CRM/Contribute/Form/AdditionalInfo.php | 14 ++++++++-- .../Form/Contribution/OnBehalfOf.php | 5 ++-- .../Form/ContributionPage/Amount.php | 28 ++++++++++--------- .../Form/ContributionPage/Custom.php | 5 +++- .../Form/ContributionPage/Widget.php | 3 ++ CRM/Contribute/Form/SoftCredit.php | 5 +++- CRM/Contribute/Form/Task.php | 6 +++- CRM/Contribute/Form/UpdateBilling.php | 8 ++++-- CRM/Contribute/Page/ManagePremiums.php | 2 ++ CRM/Contribute/PseudoConstant.php | 8 ++++-- CRM/Contribute/Selector/Search.php | 17 +++++++---- CRM/Core/Action.php | 12 +++++--- CRM/Core/BAO/ActionSchedule.php | 5 +++- CRM/Core/BAO/Block.php | 9 ++++-- CRM/Core/BAO/ConfigSetting.php | 2 ++ CRM/Core/BAO/Dashboard.php | 5 +++- CRM/Core/BAO/Domain.php | 3 ++ CRM/Core/BAO/EntityTag.php | 10 ++++--- CRM/Core/BAO/FinancialTrxn.php | 7 +++-- CRM/Core/BAO/Mapping.php | 4 ++- CRM/Core/BAO/Navigation.php | 3 +- CRM/Core/BAO/Note.php | 6 ++-- CRM/Core/BAO/PaperSize.php | 6 ++-- CRM/Core/BAO/Phone.php | 2 ++ CRM/Core/BAO/Setting.php | 9 +++--- CRM/Core/BAO/UFGroup.php | 17 +++++++---- CRM/Core/BAO/Website.php | 2 ++ CRM/Core/Block.php | 6 ++++ CRM/Core/Controller.php | 20 ++++++++----- CRM/Core/DAO.php | 2 ++ CRM/Core/Form/Date.php | 9 +++--- CRM/Core/I18n/Schema.php | 2 ++ CRM/Core/OptionGroup.php | 4 +++ CRM/Core/OptionValue.php | 18 +++++++----- CRM/Core/Page.php | 3 +- CRM/Core/Page/Basic.php | 12 ++++---- CRM/Core/Payment/Form.php | 4 +++ CRM/Core/Payment/PayPalImpl.php | 5 +++- CRM/Core/Permission.php | 5 ++-- CRM/Core/Permission/Drupal6.php | 2 ++ CRM/Core/Selector/Controller.php | 24 +++++++++------- CRM/Custom/Import/Parser.php | 2 ++ CRM/Event/Badge.php | 6 ++-- CRM/Event/Form/ManageEvent/EventInfo.php | 4 ++- CRM/Event/Form/ManageEvent/Registration.php | 4 ++- CRM/Event/Form/Task.php | 6 +++- CRM/Event/Import/Form/MapField.php | 3 ++ CRM/Event/PseudoConstant.php | 8 ++++-- CRM/Event/Selector/Search.php | 15 ++++++---- CRM/Extension/Downloader.php | 3 ++ CRM/Extension/Manager/Payment.php | 2 ++ CRM/Financial/BAO/FinancialAccount.php | 4 ++- CRM/Financial/BAO/FinancialItem.php | 6 ++-- CRM/Financial/BAO/PaymentProcessor.php | 7 +++-- CRM/Financial/Form/FinancialAccount.php | 6 +++- CRM/Financial/Form/FinancialBatch.php | 8 +++++- CRM/Financial/Page/FinancialAccount.php | 2 ++ CRM/Mailing/Event/BAO/Opened.php | 14 ++++++---- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 4 ++- CRM/Mailing/Form/Schedule.php | 5 +++- CRM/Mailing/PseudoConstant.php | 5 ++-- CRM/Mailing/Selector/Event.php | 5 +++- CRM/Mailing/Selector/Search.php | 13 +++++---- CRM/Member/BAO/MembershipStatus.php | 15 +++++----- CRM/Member/BAO/MembershipType.php | 5 ++-- CRM/Member/Form/MembershipBlock.php | 3 ++ CRM/Member/Form/Task.php | 6 +++- CRM/Member/Page/MembershipStatus.php | 2 ++ CRM/Member/PseudoConstant.php | 3 +- CRM/Member/Selector/Search.php | 12 ++++++-- CRM/PCP/Form/PCP.php | 3 ++ CRM/PCP/Page/PCP.php | 2 ++ CRM/Pledge/Selector/Search.php | 5 +++- CRM/Price/BAO/PriceSet.php | 4 +-- CRM/Queue/Queue/Memory.php | 4 ++- CRM/Report/Page/Options.php | 2 ++ CRM/SMS/Page/Provider.php | 2 ++ 112 files changed, 465 insertions(+), 180 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index 5e57eb68f1..bd3e6574f8 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -171,7 +171,13 @@ class CRM_ACL_API { * check if the user has access to this group for operation $type * * @param int $type the type of permission needed - * @param int $contactID the contactID for whom the check is made + * @param $groupID + * @param int $contactID the contactID for whom the check is made + * + * @param string $tableName + * @param null $allGroups + * @param null $includedGroups + * @param bool $flush * * @return array the ids of the groups for which the user has permissions * @access public diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index 6706e72ce8..39dca577a9 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -158,6 +158,8 @@ class CRM_Activity_BAO_Query { * Given a list of conditions in query generate the required * where clause * + * @param $query + * * @return void * @access public */ @@ -177,6 +179,8 @@ class CRM_Activity_BAO_Query { /** * where clause for a single field * + * @param $values + * @param $query * @return void * @access public */ diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index d93eae698f..c110548ea0 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -276,7 +276,10 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 96d9e00f1c..76cf226902 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -195,7 +195,10 @@ class CRM_Activity_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) { diff --git a/CRM/Admin/Page/ContactType.php b/CRM/Admin/Page/ContactType.php index 14b1ee6021..47010c6217 100644 --- a/CRM/Admin/Page/ContactType.php +++ b/CRM/Admin/Page/ContactType.php @@ -155,6 +155,8 @@ class CRM_Admin_Page_ContactType 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/EventTemplate.php b/CRM/Admin/Page/EventTemplate.php index 360c31df82..a5e230e9cc 100644 --- a/CRM/Admin/Page/EventTemplate.php +++ b/CRM/Admin/Page/EventTemplate.php @@ -162,6 +162,8 @@ class CRM_Admin_Page_EventTemplate 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/Extensions.php b/CRM/Admin/Page/Extensions.php index 26d6f441ca..e41486d0de 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -285,6 +285,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { * * The result format resembles the old CRM_Core_Extensions_Extension. * + * @param CRM_Extension_Info $obj + * * @return array */ public static function createExtendedInfo(CRM_Extension_Info $obj) { diff --git a/CRM/Admin/Page/Job.php b/CRM/Admin/Page/Job.php index 7b2d97ef45..a77ccbbe82 100644 --- a/CRM/Admin/Page/Job.php +++ b/CRM/Admin/Page/Job.php @@ -142,6 +142,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Browse all jobs. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/JobLog.php b/CRM/Admin/Page/JobLog.php index 33b7db99b4..2daba7a533 100644 --- a/CRM/Admin/Page/JobLog.php +++ b/CRM/Admin/Page/JobLog.php @@ -154,6 +154,8 @@ class CRM_Admin_Page_JobLog 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/MailSettings.php b/CRM/Admin/Page/MailSettings.php index b3c2fceff8..f7460c958e 100644 --- a/CRM/Admin/Page/MailSettings.php +++ b/CRM/Admin/Page/MailSettings.php @@ -39,7 +39,7 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; - + /** * The action links that we need to display for the browse screen * @@ -151,6 +151,8 @@ class CRM_Admin_Page_MailSettings 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/PaymentProcessor.php b/CRM/Admin/Page/PaymentProcessor.php index adcb704963..ffadf10225 100644 --- a/CRM/Admin/Page/PaymentProcessor.php +++ b/CRM/Admin/Page/PaymentProcessor.php @@ -183,6 +183,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index f8aa519d5b..c706baeab4 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -322,6 +322,10 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { * This function is used to add the rules (mainly global rules) for form. * All local rules are added near the element * + * @param $fields + * @param $files + * @param $errors + * * @return void * @access public * @see valid_date diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index 7f7e209bea..bdf9f8324a 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/Form/Task.php @@ -136,7 +136,11 @@ class CRM_Campaign_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/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index 9136d61dbf..ff519ce89e 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -205,6 +205,9 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { * * @param array $fields posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index ac81e4081b..6503d851dc 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -198,6 +198,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Campaign/PseudoConstant.php b/CRM/Campaign/PseudoConstant.php index 0314808037..dfdea6cf6f 100755 --- a/CRM/Campaign/PseudoConstant.php +++ b/CRM/Campaign/PseudoConstant.php @@ -159,8 +159,7 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param boolean $name pseudoconstant to be flushed - * + * @param bool|string $name pseudoconstant to be flushed */ public static function flush($name = 'cache') { if (isset(self::$$name)) { diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 1a8042144a..07a355654b 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -198,7 +198,10 @@ class CRM_Campaign_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) { diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 16fd0e93f5..3b361b0154 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -138,10 +138,11 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * full featured over a period 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 name / value pairs * in a hierarchical manner - * @param array $ids (reference) the array that holds all the db ids + * + * @internal param array $ids (reference) the array that holds all the db ids * * @return object CRM_Case_BAO_CaseType object * @access public diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index 4a49875ac3..7a563cf9aa 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -271,6 +271,9 @@ class CRM_Case_Form_Activity_OpenCase { * * @access public * + * @param $form + * @param $params + * * @return void */ static function endPostProcess(&$form, &$params) { diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index c81c39179d..0b6abd1ff6 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -316,6 +316,9 @@ class CRM_Case_Form_Case extends CRM_Core_Form { * * @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/Selector/Search.php b/CRM/Case/Selector/Search.php index e3161961f7..5af458ae86 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -185,9 +185,11 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * - View * - Edit * + * @param bool $isDeleted + * @param null $key + * * @return array * @access public - * */ static function &links($isDeleted = FALSE, $key = NULL) { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index dccdaccb53..72fcf7b451 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -116,9 +116,12 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id ) /** * function to get the information to map a contact * - * @param array $ids the list of ids for which we want map info + * @param array $ids the list of ids for which we want map info * $param int $locationTypeID * + * @param null $locationTypeID + * @param bool $imageUrlOnly + * * @return null|string display name of the contact if found * @static * @access public diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 5a4a3c55ee..420ef95fa4 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -152,8 +152,8 @@ ON DUPLICATE KEY UPDATE /** * Function to check if there are any contacts in cache table * - * @param string $type the type of operation (view|edit) - * @param int $contactID contact id + * @param int|string $type the type of operation (view|edit) + * @param int $contactID contact id * * @return boolean * @access public diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 786d2d769f..875b1e20e7 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -275,8 +275,11 @@ UNION /** * Create Current employer relationship for a individual * - * @param int $contactID contact id of the individual - * @param string $organization it can be name or id of organization + * @param int $contactID contact id of the individual + * @param $organizationId + * @param null $previousEmployerID + * + * @internal param string $organization it can be name or id of organization * * @access public * @static diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index a76895e6d4..ffcfcb752b 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -115,9 +115,10 @@ WHERE parent_id IS NULL * *function to retrieve all basic contact types. * - *@return array of basic contact types - *@static + * @param bool $all * + * @return array of basic contact types + * @static */ static function basicTypes($all = FALSE) { return array_keys(self::basicTypeInfo($all)); diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index ce40ccccb3..468892b97c 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -272,6 +272,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * * @param int $contactId contact id * + * @param bool $visibility + * * @access public * * @return array $values this array has key-> group id and value group title diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index 534af8525a..0a6c4665d8 100644 --- a/CRM/Contact/Form/DedupeRules.php +++ b/CRM/Contact/Form/DedupeRules.php @@ -146,6 +146,9 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { * * @param array $fields posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 704b102c05..e8e69aca61 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -182,7 +182,9 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $params + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index 5d25dcfc15..9f757eaeef 100644 --- a/CRM/Contact/Form/Task/AddToHousehold.php +++ b/CRM/Contact/Form/Task/AddToHousehold.php @@ -178,12 +178,12 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { /** * This function is to get the result of the search for Add to * forms * - * @param array $params This contains elements for search criteria + * @param $form + * @param array $params This contains elements for search criteria * * @access public * * @return void - * */ function search(&$form, &$params) { //max records that will be listed diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index b57a182449..279394e501 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -120,6 +120,8 @@ class CRM_Contact_Form_Task_EmailCommon { * * @access public * + * @param $form + * * @return void */ static function buildQuickForm(&$form) { diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index f070479a42..0e3462d8a3 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -157,6 +157,8 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * * @access protected * + * @param $form + * * @return array the default array reference */ function setDefaultValues($form) { diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index 46779777e5..70fdd82071 100644 --- a/CRM/Contact/Import/Form/Preview.php +++ b/CRM/Contact/Import/Form/Preview.php @@ -192,6 +192,9 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { * * @param array $fields posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php index ed448ea15c..501a45576f 100644 --- a/CRM/Contact/Page/DedupeRules.php +++ b/CRM/Contact/Page/DedupeRules.php @@ -202,6 +202,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** * Get user context * + * @param null $mode + * * @return string user context */ function userContext($mode = NULL) { diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index bb50c5bbeb..6ddea8213c 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -204,7 +204,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index 1a255d9a43..d60afb5e0c 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -201,6 +201,8 @@ SELECT r.payment_processor_id /** * Delete Recurring contribution. * + * @param $recurId + * * @return true / false. * @access public * @static diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 317280e3dc..d16051062d 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -165,8 +165,9 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * - * @return void + * @param $form * + * @return void */ static function buildPaymentReminders(&$form) { //PaymentReminders section @@ -184,6 +185,10 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * + * @param $params + * @param $contributionID + * @param null $premiumID + * @param null $options * @return void */ static function processPremium(&$params, $contributionID, $premiumID = NULL, &$options = NULL) { @@ -268,6 +273,9 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * + * @param $params + * @param $formatted + * @param $form * @return void */ static function postProcessCommon(&$params, &$formatted, &$form) { @@ -316,8 +324,10 @@ class CRM_Contribute_Form_AdditionalInfo { * * @form object of Contribution form. * - * @param array $params (reference ) an assoc array of name/value pairs. + * @param $form + * @param array $params (reference ) an assoc array of name/value pairs. * @$ccContribution boolen, is it credit card contribution. + * @param bool $ccContribution * @access public. * * @return void. diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index 15c9fc411d..8d118d6a8b 100644 --- a/CRM/Contribute/Form/Contribution/OnBehalfOf.php +++ b/CRM/Contribute/Form/Contribution/OnBehalfOf.php @@ -119,8 +119,9 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { * Function to build form for related contacts / on behalf of organization. * * @param $form object invoking Object - * @param $contactType string contact type - * @param $title string fieldset title + * + * @internal param string $contactType contact type + * @internal param string $title fieldset title * * @static */ diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index e0e17d881a..32cd17749b 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -244,7 +244,7 @@ SELECT id if (empty($defaults['amount_label'])) { $defaults['amount_label'] = ts('Contribution Amount'); } - + if (!empty($defaults['value']) && is_array($defaults['value'])) { // CRM-4038: fix value display @@ -273,9 +273,11 @@ SELECT id /** * 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 @@ -378,11 +380,11 @@ SELECT id } } } - + if (!empty($fields['payment_processor']) && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($self->_defaultValues['financial_type_id'])) { - $errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType; + $errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType; } - + if (!empty($fields['is_recur_interval'])) { foreach(array_keys($fields['payment_processor']) as $paymentProcessorID) { $paymentProcessorTypeId = CRM_Core_DAO::getFieldValue( @@ -621,7 +623,7 @@ SELECT id $editedResults = array(); CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults); - + if (!$priceFieldID = CRM_Utils_Array::value('id', $editedResults)) { $fieldParams = array( 'name' => 'other_amount', @@ -637,14 +639,14 @@ SELECT id if (!$noContriAmount) { $fieldParams['is_required'] = 1; $fieldParams['option_label'][1] = $fieldParams['label'] = $params['amount_label']; - } + } else { $fieldParams['is_required'] = 0; $fieldParams['option_label'][1] = $fieldParams['label'] = 'Other Amount'; } $priceField = CRM_Price_BAO_PriceField::create($fieldParams); - } + } else { if (empty($editedResults['is_active'])) { if (!$noContriAmount) { @@ -660,10 +662,10 @@ SELECT id $priceField = CRM_Price_BAO_PriceField::add($fieldParams); } } - } + } elseif (empty($params['is_allow_other_amount']) && !empty($params['price_field_other'])) { CRM_Price_BAO_PriceField::setIsActive($params['price_field_other'], '0'); - } + } elseif ($priceFieldID = CRM_Utils_Array::value('price_field_other', $params)) { $priceFieldValueID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldID, 'id', 'price_field_id'); if (!$noContriAmount) { @@ -674,7 +676,7 @@ SELECT id ); CRM_Price_BAO_PriceField::add($fieldParams); CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', $params['amount_label']); - } + } else { CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $priceFieldID, 'is_required', 0 ); CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', 'Other Amount'); diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 9d2e4fd925..9c86c2b04f 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -162,7 +162,10 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co /** * global form rule * - * @param array $fields the input form values + * @param array $fields the input form values + * + * @param $files + * @param $contributionPageId * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index 26c91318fd..f4dc41545c 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -199,6 +199,9 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co * * @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/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 337eef6ae5..8df54b0c00 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -192,7 +192,10 @@ class CRM_Contribute_Form_SoftCredit { /** * global form rule * - * @param array $fields the input form values + * @param array $fields the input form values + * + * @param $errors + * @param $self * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index 0b547b8b68..66cbd3c0d1 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -197,7 +197,11 @@ class CRM_Contribute_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/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index 3572fd344a..486552a0e7 100644 --- a/CRM/Contribute/Form/UpdateBilling.php +++ b/CRM/Contribute/Form/UpdateBilling.php @@ -205,9 +205,11 @@ class CRM_Contribute_Form_UpdateBilling 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/Contribute/Page/ManagePremiums.php b/CRM/Contribute/Page/ManagePremiums.php index 6a5e85da54..e9e8d3de0c 100644 --- a/CRM/Contribute/Page/ManagePremiums.php +++ b/CRM/Contribute/Page/ManagePremiums.php @@ -202,6 +202,8 @@ class CRM_Contribute_Page_ManagePremiums 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 b666ffa124..4f03e3abce 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -119,6 +119,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * * @return array - array reference of all financial types if any * @static */ @@ -190,8 +192,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param boolean $name pseudoconstant to be flushed - * + * @param bool|string $name pseudoconstant to be flushed */ public static function flush($name = 'cache') { if (isset(self::$$name)) { @@ -272,6 +273,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $pageID * @return array - array of all Premiums if any * @static */ @@ -319,6 +321,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * @param string $columnName * @return array - array reference of all contribution statuses * @static */ diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 092e2a8611..95adc2f4ea 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -158,13 +158,16 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * Class constructor * * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $contributionClause if the caller wants to further restrict the search (used in contributions) + * @param \const|int $action - action of search basic or advanced. + * @param string $contributionClause if the caller wants to further restrict the search (used in contributions) * @param boolean $single are we dealing only with one contact? - * @param int $limit how many contributions do we want returned + * @param int $limit how many contributions do we want returned * - * @return CRM_Contact_Selector - * @access public + * @param string $context + * @param null $compContext + * + * @return \CRM_Contribute_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, @@ -264,7 +267,9 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index 84b307a5f7..65c264b7f3 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -194,11 +194,15 @@ class CRM_Core_Action { * given a set of links and a mask, return the html action string for * the links associated with the mask * - * @param array $links the set of link items - * @param int $mask the mask to be used. a null mask means all items + * @param array $links the set of link items + * @param int $mask the mask to be used. a null mask means all items * @param array $values the array of values for parameter substitution in the link items - * @param string $extraULName enclosed extra links in this UL. - * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL. + * @param string $extraULName enclosed extra links in this UL. + * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL. + * + * @param null $op + * @param null $objectName + * @param null $objectId * * @return string the html string * @access public diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index e00f7c674b..2a9dda2a05 100755 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -275,7 +275,10 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { /** * Retrieve list of Scheduled Reminders * - * @param bool $namesOnly return simple list of names + * @param bool $namesOnly return simple list of names + * + * @param null $entityValue + * @param null $id * * @return array (reference) reminder list * @static diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 797b7c67af..c9bb3402d0 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -212,9 +212,12 @@ class CRM_Core_BAO_Block { /** * takes an associative array and creates a block * - * @param string $blockName block name - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $requiredFields fields that's are required in a block + * @param string $blockName block name + * @param array $params (reference ) an assoc array of name/value pairs + * @param null $entity + * @param null $contactId + * + * @internal param array $requiredFields fields that's are required in a block * * @return object CRM_Core_BAO_Block object on success, null otherwise * @access public diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 5faaeebd46..15ef3bd615 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -204,6 +204,8 @@ class CRM_Core_BAO_ConfigSetting { /** * Function to retrieve the settings values from db * + * @param $defaults + * * @return array $defaults * @static */ diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 5d6662f514..098b61b1b0 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -157,7 +157,10 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Function to check dashlet permission for current user * - * @param string permission string + * @param $permission + * @param $operator + * + * @internal param \permission $string string * * @return boolean true if use has permission else false */ diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 86d0a542d9..a3236dd33f 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -155,6 +155,9 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * Save the values of a domain * + * @param $params + * @param $id + * * @return domain array * @access public */ diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 62c7c629ba..45fb90e2d9 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -136,8 +136,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Given an array of entity ids and entity table, add all the entity to the tags * - * @param array $entityIds (reference ) the array of entity ids to be added - * @param int $tagId the id of the tag + * @param array $entityIds (reference ) the array of entity ids to be added + * @param int $tagId the id of the tag + * @param string $entityTable * @params string $entityTable name of entity table default:civicrm_contact * * @return array (total, added, notAdded) count of enities added to tag @@ -179,8 +180,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Given an array of entity ids and entity table, remove entity(s) tags * - * @param array $entityIds (reference ) the array of entity ids to be removed - * @param int $tagId the id of the tag + * @param array $entityIds (reference ) the array of entity ids to be removed + * @param int $tagId the id of the tag + * @param string $entityTable * @params string $entityTable name of entity table default:civicrm_contact * * @return array (total, removed, notRemoved) count of entities removed from tags diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 2afa4b2159..f36769d949 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -181,8 +181,10 @@ LIMIT 1;"; * 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 $entity_id + * + * @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. * @@ -290,6 +292,7 @@ WHERE lt.entity_id = %1 "; /** * Delete financial transaction * + * @param $entity_id * @return true on success, false otherwise * @access public * @static diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index a6824490d3..d2f5c43ea0 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -205,8 +205,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * * @params $mapTypeId string mapping Type * - * @return boolean + * @param $nameField + * @param $mapTypeId * + * @return boolean */ static function checkMapping($nameField, $mapTypeId) { $mapping = new CRM_Core_DAO_Mapping(); diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index b7174f7f9d..dca554d4ed 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -154,8 +154,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * @param $parentID parent_id of a menu * @param $menuID menu id * - * @return $weight string - * @static + * @return int $weight string@static */ static function calculateWeight($parentID = NULL, $menuID = NULL) { $domainID = CRM_Core_Config::domainID(); diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 7653c60817..7588525bdf 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -282,12 +282,10 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Function to delete the notes * - * @param int $id note id + * @param int $id note id * @param boolean $showStatus do we need to set status or not * - * @return $return no of deleted notes on success, false otherwise - * - * @access public + * @return mixed|null $return no of deleted notes on success, false otherwise@access public * @static */ static function del($id, $showStatus = TRUE) { diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index 0c3bfc406a..d6811981af 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -199,10 +199,12 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Get Paper Size field from associative array * - * @param string $field name of a Paper Size field - * @param array (reference) $values associative array of name/value pairs containing + * @param string $field name of a Paper Size field + * @param array (reference) $values associative array of name/value pairs containing * Paper Size field selections * + * @param null $default + * * @return value * @access public * @static diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 31d9cfdee7..539b2e5454 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -178,6 +178,8 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; * @param array $entityElements the array containing entity_id and * entity_table name * + * @param null $type + * * @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 3f101c395c..f19ab824e4 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -179,11 +179,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Retrieve the value of a setting from the DB table * * @param string $group (required) The group name of the item - * @param string $name (required) The name under which this item is stored - * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param string $name (required) The name under which this item is stored + * @param int $componentID The optional component ID (so componenets can share the same name space) * @param string $defaultValue The default value to return for this setting if not present in DB - * @param int $contactID If set, this is a contactID specific setting, else its a global setting - + * @param int $contactID If set, this is a contactID specific setting, else its a global setting + * + * @param null $domainID * * @return object The data if present in the setting table, else null * @static diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index e600d22c49..7395d7366b 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -128,8 +128,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * get all the registration fields * - * @param int $action what action are we doing - * @param int $mode mode + * @param int $action what action are we doing + * @param int $mode mode + * + * @param null $ctype * * @return array the fields that are needed for registration * @static @@ -181,12 +183,15 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * get all the listing fields * - * @param int $action what action are we doing - * @param int $visibility visibility of fields we are interested in - * @param bool $considerSelector whether to consider the in_selector parameter - * @param array $ufGroupIds + * @param int $action what action are we doing + * @param int $visibility visibility of fields we are interested in + * @param bool $considerSelector whether to consider the in_selector parameter + * @param array $ufGroupIds * @param boolean $searchable * + * @param null $restrict + * @param bool $skipPermission + * @param int $permissionType * @return array the fields that are listings related * @static * @access public diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index 7f93736430..050502c14a 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -161,6 +161,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * * @return array the array of website details * @access public * @static diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index f2a71281be..bbf5ec6e52 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -185,6 +185,9 @@ class CRM_Core_Block { * @params int $id one of the class constants (ADD, SEARCH, etc.) * @params string $property the desired property * + * @param $id + * @param $property + * * @return string the value of the desired property */ static function getProperty($id, $property) { @@ -201,6 +204,9 @@ class CRM_Core_Block { * @params string $property the desired property * @params string $value the value of the desired property * + * @param $id + * @param $property + * @param $value * @return void */ static function setProperty($id, $property, $value) { diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 2d0b1b4776..4a0f209878 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -156,16 +156,22 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * All CRM single or multi page pages should inherit from this class. * - * @param string title descriptive title of the controller - * @param boolean whether controller is modal - * @param string scope name of session if we want unique scope, used only by Controller_Simple - * @param boolean addSequence should we add a unique sequence number to the end of the key - * @param boolean ignoreKey should we not set a qfKey for this controller (for standalone forms) + * @param null $title + * @param bool $modal + * @param null $mode + * @param null $scope + * @param bool $addSequence + * @param bool $ignoreKey + * + * @internal param \title $string descriptive title of the controller + * @internal param \whether $boolean controller is modal + * @internal param \scope $string name of session if we want unique scope, used only by Controller_Simple + * @internal param \addSequence $boolean should we add a unique sequence number to the end of the key + * @internal param \ignoreKey $boolean should we not set a qfKey for this controller (for standalone forms) * * @access public * - * @return void - * + * @return \CRM_Core_Controller */ function __construct( $title = NULL, diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 9d0bcc6a4e..683657a9f6 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -176,6 +176,8 @@ class CRM_Core_DAO extends DB_DataObject { /** * Factory method to instantiate a new object from a table name. * + * @param string $table + * * @return void * @access public */ diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 6bb19371ad..2e70c14678 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -197,16 +197,17 @@ Class CRM_Core_Form_Date { /** * This function is to build the date range - relative or absolute * - * @param CRM_Core_Form $form the form object that we are operating on + * @param CRM_Core_Form $form the form object that we are operating on * @param string $fieldName * @param Array $selector array of option values to add - * @param integer $count - * @param string $from - * @param stringe $to * @param string $from Label + * @param string|\stringe $to + * @param string $fromLabel * @param boolean $required * @param string $dateFormat * @param boolean $displayTime + * + * @internal param int $count * @return null */ static function addDateRangeToForm(&$form, $fieldName, $selector, $from = '_from', $to = '_to', $fromLabel = 'From:', $required = FALSE, $dateFormat = 'searchDate', $displayTime = FALSE) { diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index a4f6ea2c55..8617953a3d 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -157,6 +157,8 @@ class CRM_Core_I18n_Schema { * @param $table string the table containing the column * @param $class string schema structure class to use to recreate indices * + * @param array $triggers + * * @return void */ static function makeSinglelingualTable( diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index be06a3e487..734fbb5e1a 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -163,6 +163,7 @@ WHERE v.option_group_id = g.id * @param $condition * @param $labelColumnName * @param $onlyActive + * @param string $keyColumnName */ protected static function flushValues($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName = 'value') { $cacheKey = self::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName); @@ -189,6 +190,9 @@ WHERE v.option_group_id = g.id * @param $localize boolean if true, localize the results before returning * @param $labelColumnName string the column to use for 'label' * + * @param bool $onlyActive + * @param bool $fresh + * * @return array the values as specified by the above params * @static * @void diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index f2498e3ae7..ff29d5ae93 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -240,10 +240,11 @@ class CRM_Core_OptionValue { /** * Check if there is a record with the same name in the db * - * @param string $value the value of the field we are checking - * @param string $daoName the dao object name - * @param string $daoID the id of the object being updated. u can change your name + * @param string $value the value of the field we are checking + * @param string $daoName the dao object name + * @param string $daoID the id of the object being updated. u can change your name * as long as there is no conflict + * @param $optionGroupID * @param string $fieldName the name of the field in the DAO * * @return boolean true if object exists @@ -266,11 +267,14 @@ class CRM_Core_OptionValue { /** * Check if there is a record with the same name in the db * - * @param string $value the value of the field we are checking - * @param string $daoName the dao object name - * @param string $daoID the id of the object being updated. u can change your name + * @param string $mode + * @param string $contactType + * + * @internal param string $value the value of the field we are checking + * @internal param string $daoName the dao object name + * @internal param string $daoID the id of the object being updated. u can change your name * as long as there is no conflict - * @param string $fieldName the name of the field in the DAO + * @internal param string $fieldName the name of the field in the DAO * * @return boolean true if object exists * @access public diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index 8b1c74e525..9d7613c4f8 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -312,9 +312,10 @@ class CRM_Core_Page { /** * assign value to name in template by reference * - * @param array|string $name name of variable + * @param $var * @param mixed $value (reference) value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index d0632397c4..a43791731b 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -192,7 +192,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * browse all entities. * - * @param int $action + * @internal param int $action * * @return void * @access public @@ -284,10 +284,12 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * actions * * @param CRM_Core_DAO $object the object being considered - * @param int $action the base set of actions - * @param array $values the array of values that we send to the template - * @param array $links the array of links - * @param string $permission the permission assigned to this object + * @param int $action the base set of actions + * @param array $values the array of values that we send to the template + * @param array $links the array of links + * @param string $permission the permission assigned to this object + * + * @param bool $forceAction * * @return void * @access private diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 2595d18a9f..e2f67d2c54 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -193,6 +193,8 @@ class CRM_Core_Payment_Form { /** * create all fields needed for direct debit transaction * + * @param $form + * * @return void * @access public */ @@ -313,6 +315,8 @@ class CRM_Core_Payment_Form { /** * Function to add all the direct debit fields * + * @param $form + * @param bool $useRequired * @return void * @access public */ diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 3e1de6f7aa..cc05ff780e 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -181,7 +181,9 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * do the express checkout at paypal. Check PayPal documentation for more information * - * @param string $token the key associated with this transaction + * @param $params + * + * @internal param string $token the key associated with this transaction * * @return array the result in an nice formatted array (or an error object) * @public @@ -290,6 +292,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @param array $params assoc array of input parameters for this transaction * + * @param string $component * @return array the result in an nice formatted array (or an error object) * @public */ diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index fc40a98898..fc5245ae43 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -188,14 +188,13 @@ class CRM_Core_Permission { * Get all groups from database, filtered by permissions * for this user * - * @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, $excludeHidden = TRUE) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index a8dd2af914..2b14cb61cc 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -196,6 +196,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * Get the permissions defined in the hook_civicrm_permission implementation * of the given module. * + * @param $module + * * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ static function getModulePermissions($module) { diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 119219fe58..09c7ff4ed1 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -184,16 +184,20 @@ class CRM_Core_Selector_Controller { /** * Class constructor * - * @param CRM_Core_Selector_API $object an object that implements the selector API - * @param int $pageID default pageID - * @param int $sortID default sortID - * @param int $action the actions to potentially support - * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values - * @param int $output what do we so with the output, session/template//both - * - * @return Object - * @access public - */ function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) { + * @param CRM_Core_Selector_API $object an object that implements the selector API + * @param int $pageID default pageID + * @param int $sortID default sortID + * @param int $action the actions to potentially support + * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values + * @param int $output what do we so with the output, session/template//both + * + * @param null $prefix + * @param null $case + * + * @return \CRM_Core_Selector_Controller + @access public + */ + function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) { $this->_object = $object; $this->_pageID = $pageID ? $pageID : 1; diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index e3fbee9c53..6eee623293 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -320,6 +320,8 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 25cb835e0a..0f75239f05 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -153,8 +153,10 @@ class CRM_Event_Badge { /** * function to create labels (pdf) * - * @param array $contactRows assciated array of contact data - * @param string $format format in which labels needs to be printed + * @param $participants + * + * @internal param array $contactRows assciated array of contact data + * @internal param string $format format in which labels needs to be printed * * @return null * @access public diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 3424d9d5c8..ab4b017397 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -239,7 +239,9 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $values + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 7f8237f0c1..ef56b06b77 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -320,7 +320,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Function to build Registration Block * - * @param int $pageId + * @param $form + * + * @internal param int $pageId * @static */ function buildRegistrationBlock(&$form) { diff --git a/CRM/Event/Form/Task.php b/CRM/Event/Form/Task.php index 1e2c8eec12..f32c5091fc 100644 --- a/CRM/Event/Form/Task.php +++ b/CRM/Event/Form/Task.php @@ -156,7 +156,11 @@ class CRM_Event_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/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index c704c1519c..d627202322 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -284,6 +284,9 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { * * @param array $fields posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 10fec2fb4a..39536722ad 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -185,6 +185,9 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * @param null $cond + * * @return array - array reference of all participant roles if any * @static */ @@ -238,6 +241,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id * @return array - array reference of all event types. * @static */ @@ -284,8 +288,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param boolean $name pseudoconstant to be flushed - * + * @param bool|string $name pseudoconstant to be flushed */ public static function flush($name = 'cache') { if (isset(self::$$name)) { @@ -298,6 +301,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id * @return array - array reference of all pcp if any * @static */ diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 39b46c62d2..e3634558cc 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -151,14 +151,17 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $eventClause 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 $eventClause 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 participations do we want returned + * @param int $limit how many participations do we want returned * - * @return CRM_Contact_Selector - * @access public + * @param string $context + * @param null $compContext + * + * @return \CRM_Event_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php index 3d808e84fc..3f166c87cc 100644 --- a/CRM/Extension/Downloader.php +++ b/CRM/Extension/Downloader.php @@ -186,6 +186,9 @@ class CRM_Extension_Downloader { /** * Validate that $extractedZipPath contains valid for extension $key * + * @param $key + * @param $extractedZipPath + * * @return bool */ function validateFiles($key, $extractedZipPath) { diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index f457ae2de3..9f1b81adc7 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -176,7 +176,9 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { * Function to run hooks in the payment processor class * Load requested payment processor and call the method specified. * + * @param CRM_Extension_Info $info * @param string $method - the method to call in the payment processor class + * * @private */ private function _runPaymentHook(CRM_Extension_Info $info, $method) { diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 9d98426c40..2f2b05d514 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -160,6 +160,8 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco * * @financialTypeId int Financial Type Id * + * @param $financialTypeId + * * @return accounting code * @static */ @@ -185,7 +187,7 @@ WHERE cft.id = %1 * * @param $financialAccountTypeId financial account type id * - * @param $accountTypeCode account type code + * @param \account|string $accountTypeCode account type code * * @return integer count * @static diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index a856e1d590..2427c08aec 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -175,9 +175,11 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * retrive entity financial trxn details * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params (reference ) an assoc array of name/value pairs + * + * @param bool $maxId * - * @param boolean $maxID to retrive max id + * @internal param bool $maxID to retrive max id * * @return array * @access public diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 69bc61bb86..37c596e694 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -273,10 +273,11 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Function to retrieve payment processor id / info/ object based on component-id. * - * @param int $componentID id of a component - * @param string $component component - * @param string $type type of payment information to be retrieved + * @param $entityID + * @param string $component component + * @param string $type type of payment information to be retrieved * + * @internal param int $componentID id of a component * @return id / array / object based on type * @static * @access public diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index 0cf5152df3..a04b33276f 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -134,7 +134,11 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $values + * @param $files + * @param $self + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index 5bdef512c9..4bed5d72f6 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -293,7 +293,13 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $action + * @param $permissions + * @param $createdID + * @param $userContactID + * @param $actionName + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Financial/Page/FinancialAccount.php b/CRM/Financial/Page/FinancialAccount.php index a9973298cd..54072149a5 100644 --- a/CRM/Financial/Page/FinancialAccount.php +++ b/CRM/Financial/Page/FinancialAccount.php @@ -188,6 +188,8 @@ class CRM_Financial_Page_FinancialAccount 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 7d34c59ac8..57c94d7a3f 100644 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -205,12 +205,14 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id ID of the mailing + * @param int $job_id optional ID of the job + * @param boolean $is_distinct Group by queue id? + * @param int $offset Offset + * @param int $rowCount Number of rows + * @param array $sort sort array + * + * @param null $contact_id * * @return array Result set * @access public diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index 42fd9f1923..3cc24d70cb 100644 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -155,7 +155,9 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * CRM-12814 * Get tracked url 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 trackable url count per mailing ID * @access public diff --git a/CRM/Mailing/Form/Schedule.php b/CRM/Mailing/Form/Schedule.php index 3dcd9055b6..11a5f4658c 100644 --- a/CRM/Mailing/Form/Schedule.php +++ b/CRM/Mailing/Form/Schedule.php @@ -189,7 +189,10 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { * Warning: if you make changes here, be sure to also make them in * Retry.php * - * @param array $params The form values + * @param array $params The form values + * + * @param $files + * @param $self * * @return boolean True if either we deliver immediately, or the * date is properly set. diff --git a/CRM/Mailing/PseudoConstant.php b/CRM/Mailing/PseudoConstant.php index 63ab924815..5e92f7f639 100644 --- a/CRM/Mailing/PseudoConstant.php +++ b/CRM/Mailing/PseudoConstant.php @@ -154,6 +154,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $mode + * * @return array - array reference of all mailing templates if any * @static */ @@ -211,8 +213,7 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param boolean $name pseudoconstant to be flushed - * + * @param bool|string $name pseudoconstant to be flushed */ public static function flush($name = 'template') { if (isset(self::$$name)) { diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index 607d143025..91036a8df7 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -117,7 +117,10 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index 91a838ed65..1f6cc48540 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -142,13 +142,16 @@ class CRM_Mailing_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 $mailingClause if the caller wants to further restrict the search + * @param \const|int $action - action of search basic or advanced. + * @param string $mailingClause if the caller wants to further restrict the search * @param boolean $single are we dealing only with one contact? - * @param int $limit how many mailing do we want returned + * @param int $limit how many mailing do we want returned * - * @return CRM_Contact_Selector - * @access public + * @param string $context + * @param null $compContext + * + * @return \CRM_Mailing_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 0ba2814704..6d892109df 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -208,16 +208,17 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * Function to find the membership status based on start date, end date, join date & status date. * - * @param date $startDate start date of the member whose membership status is to be calculated. - * @param date $endDate end date of the member whose membership status is to be calculated. - * @param date $joinDate join date of the member whose membership status is to be calculated. - * @param date $statusDate status date of the member whose membership status is to be calculated. + * @param date $startDate start date of the member whose membership status is to be calculated. + * @param date $endDate end date of the member whose membership status is to be calculated. + * @param date $joinDate join date of the member whose membership status is to be calculated. + * @param \date|string $statusDate status date of the member whose membership status is to be calculated. * @param boolean $excludeIsAdmin exclude the statuses those having is_admin = 1 - * @param integer $membershipType membership type id - passed to the hook + * @param $membershipTypeID * @param array $membership membership params as available to calling function - passed to the hook * - * @return - * @static + * @internal param int $membershipType membership type id - passed to the hook + * @return array + @static */ static function getMembershipStatusByDate($startDate, $endDate, $joinDate, $statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = array() diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index 99ee45ae87..6c2b5159c6 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -275,10 +275,11 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * Function to calculate start date and end date for new membership * - * @param int $membershipTypeId membership type id + * @param int $membershipTypeId membership type id * @param date $joinDate member since ( in mysql date format ) * @param date $startDate start date ( in mysql date format ) - * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) + * @param null $endDate + * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) * * @return array associated array with start date, end date and join date for the membership * @static diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index 3448b5e098..055b2acfab 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -202,6 +202,9 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * @param null $contributionPageId + * * @return mixed true or array of errors * @access public * @static diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php index 3d221357a0..238ac0d27a 100644 --- a/CRM/Member/Form/Task.php +++ b/CRM/Member/Form/Task.php @@ -163,7 +163,11 @@ class CRM_Member_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/Member/Page/MembershipStatus.php b/CRM/Member/Page/MembershipStatus.php index 85bdb4b27f..16e9d9e74c 100644 --- a/CRM/Member/Page/MembershipStatus.php +++ b/CRM/Member/Page/MembershipStatus.php @@ -203,6 +203,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index 839bce7ebb..434923bac1 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -130,8 +130,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param boolean $name pseudoconstant to be flushed - * + * @param bool|string $name pseudoconstant to be flushed */ public static function flush($name = 'cache') { if (isset(self::$$name)) { diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index 9bfcba1ac6..0af982a889 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -186,9 +186,15 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * - View * - Edit * + * @param string $status + * @param null $isPaymentProcessor + * @param null $accessContribution + * @param null $qfKey + * @param null $context + * @param bool $isCancelSupported + * * @return array * @access public - * */ static function &links($status = 'all', @@ -271,7 +277,9 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index 228b4cae33..f0e52d80f2 100644 --- a/CRM/PCP/Form/PCP.php +++ b/CRM/PCP/Form/PCP.php @@ -194,6 +194,9 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { * * @param array $fields 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/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index dd4f470070..e012375d5f 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -161,6 +161,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { * Browse all custom data groups. * * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index a9700120e9..99e0b3f760 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -238,7 +238,10 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index baec5e9257..91379a00f5 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -157,8 +157,8 @@ WHERE ps.name = '{$entityName}' /** * Return a list of all forms which use this price set. * - * @param int $id id of price set - * @param str $simpleReturn - get raw data. Possible values: 'entity', 'table' + * @param int $id id of price set + * @param bool|\str $simpleReturn - get raw data. Possible values: 'entity', 'table' * * @return array */ diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index 8495bfa731..aa75b11bf5 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -178,7 +178,9 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { /** * Return an item that could not be processed * - * @param $dao object The item returned by claimItem + * @param The $item + * + * @internal param object $dao The item returned by claimItem * * @return bool */ diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index 50c93c594a..0b99a5ca28 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -204,6 +204,8 @@ class CRM_Report_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/SMS/Page/Provider.php b/CRM/SMS/Page/Provider.php index b6d33ea459..7491ab30fe 100644 --- a/CRM/SMS/Page/Provider.php +++ b/CRM/SMS/Page/Provider.php @@ -182,6 +182,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { -- 2.25.1