From fd31fa4c65b766d62df21f578772960955322576 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 13:32:08 +1200 Subject: [PATCH] bulk comment fix --- CRM/ACL/API.php | 6 +++++- CRM/Activity/BAO/Activity.php | 18 +++++++++-------- CRM/Activity/BAO/ActivityAssignment.php | 6 +++--- CRM/Activity/BAO/ActivityTarget.php | 14 +++++++------ CRM/Activity/BAO/ICalendar.php | 4 ++-- CRM/Activity/Form/Task.php | 6 +++++- CRM/Activity/Import/Parser.php | 2 ++ CRM/Activity/Selector/Activity.php | 2 ++ CRM/Admin/Form/PaymentProcessor.php | 2 ++ CRM/Admin/Page/Extensions.php | 2 ++ CRM/Admin/Page/LabelFormats.php | 2 ++ CRM/Admin/Page/LocationType.php | 2 ++ CRM/Admin/Page/ScheduleReminders.php | 2 ++ CRM/Admin/Page/Tag.php | 2 ++ CRM/Badge/BAO/Badge.php | 6 ++++++ CRM/Campaign/BAO/Campaign.php | 13 +++++++----- CRM/Campaign/Form/Campaign.php | 4 ++++ CRM/Case/Form/Activity/ChangeCaseStatus.php | 3 +++ CRM/Case/Form/Activity/ChangeCaseType.php | 4 ++++ CRM/Case/Form/Activity/OpenCase.php | 6 +++++- CRM/Case/Selector/Search.php | 5 ++++- CRM/Contact/BAO/Contact.php | 9 ++++++--- CRM/Contact/BAO/Contact/Permission.php | 7 +++++-- CRM/Contact/BAO/Contact/Utils.php | 11 +++++++---- CRM/Contact/BAO/ContactType.php | 9 ++++++--- CRM/Contact/BAO/GroupContact.php | 22 +++++++++++++-------- CRM/Contact/BAO/GroupNesting.php | 7 +++++-- CRM/Contact/BAO/GroupOrganization.php | 3 +-- CRM/Contact/BAO/Relationship.php | 17 +++++++++------- CRM/Contact/Form/Contact.php | 10 ++++++---- CRM/Contact/Form/Search/Builder.php | 6 +++++- CRM/Contact/Form/Task/EmailCommon.php | 2 ++ CRM/Contact/Import/Parser/Contact.php | 6 +++++- CRM/Contact/Page/View.php | 2 ++ CRM/Contribute/BAO/Contribution.php | 11 +++++++---- CRM/Contribute/BAO/ContributionRecur.php | 5 +++-- CRM/Contribute/BAO/Query.php | 2 ++ CRM/Contribute/Form/AdditionalInfo.php | 5 +++++ CRM/Contribute/PseudoConstant.php | 2 ++ CRM/Contribute/Selector/Search.php | 20 +++++++++++-------- CRM/Core/Action.php | 5 +++-- CRM/Core/BAO/Block.php | 5 ++++- CRM/Core/BAO/CMSUser.php | 4 +++- CRM/Core/BAO/CustomField.php | 9 ++++++--- CRM/Core/BAO/CustomGroup.php | 6 ++++-- CRM/Core/BAO/CustomQuery.php | 5 ++++- CRM/Core/BAO/CustomValueTable.php | 2 ++ CRM/Core/BAO/Domain.php | 2 ++ CRM/Core/BAO/Location.php | 7 +++++-- CRM/Core/BAO/Note.php | 8 ++++---- CRM/Core/BAO/PdfFormat.php | 6 ++++-- CRM/Core/BAO/Setting.php | 9 ++++++--- CRM/Core/BAO/UFGroup.php | 19 ++++++++++++------ CRM/Core/BAO/UFMatch.php | 13 +++++++----- CRM/Core/Form.php | 6 ++++-- CRM/Core/ManagedEntities.php | 2 ++ CRM/Core/OptionValue.php | 9 +++++---- CRM/Core/Page.php | 6 ++++-- CRM/Core/Page/Basic.php | 4 ++-- CRM/Core/Payment/Form.php | 3 +++ CRM/Core/Payment/GoogleIPN.php | 8 +++++--- CRM/Core/Payment/IATS.php | 2 +- CRM/Core/Payment/Realex.php | 6 +----- CRM/Core/PseudoConstant.php | 8 ++++---- CRM/Core/QuickForm/Action/Display.php | 2 +- CRM/Core/ShowHideBlocks.php | 10 ++++++---- CRM/Core/StateMachine.php | 6 +++--- CRM/Custom/Form/Option.php | 3 +++ CRM/Custom/Import/Parser/Api.php | 4 ++-- CRM/Event/PseudoConstant.php | 6 +++++- CRM/Event/Selector/Search.php | 5 ++++- CRM/Export/Form/Select.php | 3 +++ CRM/Extension/Browser.php | 2 ++ CRM/Extension/Container/Basic.php | 8 ++++++-- CRM/Extension/Downloader.php | 1 + CRM/Financial/BAO/FinancialTypeAccount.php | 5 ++++- CRM/Financial/Form/FinancialBatch.php | 6 +++++- CRM/Financial/Form/FinancialTypeAccount.php | 6 +++++- CRM/Financial/Page/FinancialType.php | 2 ++ CRM/Friend/Form.php | 4 +++- CRM/Grant/BAO/Grant.php | 2 ++ CRM/Mailing/Event/BAO/Reply.php | 8 +++++--- CRM/Mailing/Form/Task.php | 8 ++++++-- CRM/Mailing/Form/Test.php | 7 ++++--- CRM/Member/Form/Task/PDFLetterCommon.php | 4 ++++ CRM/Member/Import/Form/MapField.php | 3 +++ CRM/Member/Import/Parser.php | 2 ++ CRM/Member/Selector/Search.php | 17 +++++++++------- CRM/PCP/BAO/PCP.php | 5 ++++- CRM/PCP/Form/PCPAccount.php | 8 +++++--- CRM/Pledge/BAO/PledgePayment.php | 15 +++++++------- CRM/Pledge/Selector/Search.php | 14 +++++++------ CRM/Price/BAO/PriceSet.php | 3 +++ CRM/Queue/Queue/Sql.php | 2 +- CRM/Report/Utils/Report.php | 2 ++ CRM/SMS/Form/Schedule.php | 5 ++++- CRM/SMS/Page/Provider.php | 2 ++ CRM/Utils/Mail/EmailProcessor.php | 2 +- 98 files changed, 416 insertions(+), 187 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index 8463f8b265..5e57eb68f1 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -138,7 +138,11 @@ class CRM_ACL_API { * get all the groups the user has access to for the given operation * * @param int $type the type of permission needed - * @param int $contactID the contactID for whom the check is made + * @param int $contactID the contactID for whom the check is made + * + * @param string $tableName + * @param null $allGroups + * @param null $includedGroups * * @return array the ids of the groups for which the user has permissions * @access public diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 57be253e39..141f98940f 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -1148,18 +1148,20 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * send the message to all the contacts and also insert a * contact activity in each contacts record * - * @param array $contactDetails the array of contact details to send the email - * @param string $subject the subject of the message - * @param string $message the message contents + * @param array $contactDetails the array of contact details to send the email + * @param string $subject the subject of the message + * @param $text + * @param $html * @param string $emailAddress use this 'to' email address instead of the default Primary address - * @param int $userID use this userID if set + * @param int $userID use this userID if set * @param string $from - * @param array $attachments the array of attachments if any - * @param string $cc cc recipient - * @param string $bcc bcc recipient - * @param array $contactIds contact ids + * @param array $attachments the array of attachments if any + * @param string $cc cc recipient + * @param string $bcc bcc recipient + * @param array $contactIds contact ids * @param string $additionalDetails the additional information of CC and BCC appended to the activity Details * + * @internal param string $message the message contents * @return array ( sent, activityId) if any email is sent and activityId * @access public * @static diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index 6f4e452987..9d93c74652 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -49,12 +49,12 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta /** * Add activity assignment. * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids (reference ) the array that holds all the db ids + * @param array $params (reference ) an assoc array of name/value pairs + * + * @internal param array $ids (reference ) the array that holds all the db ids * * @return object activity type of object that is added * @access public - * */ public static function create(&$params) { $assignment = new CRM_Activity_BAO_ActivityContact(); diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index 76ae5c2f39..6ab4bdbd66 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -47,14 +47,15 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { } /** - * funtion to add activity target + * function to add activity target * - * @param array $activity_id (reference ) an assoc array of name/value pairs - * @param array $target_contact_id (reference ) the array that holds all the db ids + * @param $params + * + * @internal param array $activity_id (reference ) an assoc array of name/value pairs + * @internal param array $target_contact_id (reference ) the array that holds all the db ids * * @return object activity type of object that is added * @access public - * */ public static function create(&$params) { $target = new CRM_Activity_BAO_ActivityContact(); @@ -104,12 +105,13 @@ AND civicrm_contact.is_deleted = 0 /** * function to retrieve names of target contact by activity_id * - * @param int $id ID of the activity + * @param $activityID + * + * @internal param int $id ID of the activity * * @return array * * @access public - * */ static function getTargetNames($activityID) { $targetNames = array(); diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index 13212cc107..dc90a1c831 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -49,8 +49,8 @@ class CRM_Activity_BAO_ICalendar { * * @param object $act Reference to an activity object * - * @return void - * @access public + * @return \CRM_Activity_BAO_ICalendar + @access public */ function __construct( &$act ) { $this->activity = $act; diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index 34feb38861..f973bc43bb 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -172,7 +172,11 @@ WHERE activity_id IN ( $IDs ) AND * 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/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 555c9beeed..d4278fd640 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -325,6 +325,8 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 65785e5c63..d93eae698f 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -318,6 +318,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * * @param string $action - action being performed * + * @param null $case + * * @return int Total number of rows * @access public */ diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index a3f6670dde..fdad420b72 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -164,6 +164,8 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { /** * Function to build the form * + * @param bool $check + * * @return void * @access public */ diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php index 04e4cefa3c..26d6f441ca 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -259,6 +259,8 @@ class CRM_Admin_Page_Extensions 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/LabelFormats.php b/CRM/Admin/Page/LabelFormats.php index c2ba8a8321..5fe0483105 100644 --- a/CRM/Admin/Page/LabelFormats.php +++ b/CRM/Admin/Page/LabelFormats.php @@ -112,6 +112,8 @@ class CRM_Admin_Page_LabelFormats 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/LocationType.php b/CRM/Admin/Page/LocationType.php index 50578cfeea..85d83f8dbb 100644 --- a/CRM/Admin/Page/LocationType.php +++ b/CRM/Admin/Page/LocationType.php @@ -113,6 +113,8 @@ class CRM_Admin_Page_LocationType 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/ScheduleReminders.php b/CRM/Admin/Page/ScheduleReminders.php index 70f77583bb..4f375464d2 100644 --- a/CRM/Admin/Page/ScheduleReminders.php +++ b/CRM/Admin/Page/ScheduleReminders.php @@ -127,6 +127,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Browse all Scheduled Reminders settings. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/Tag.php b/CRM/Admin/Page/Tag.php index 654062a6df..0214b9e5c1 100644 --- a/CRM/Admin/Page/Tag.php +++ b/CRM/Admin/Page/Tag.php @@ -117,6 +117,8 @@ class CRM_Admin_Page_Tag 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 3658609603..e98fbd8cea 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -303,8 +303,14 @@ class CRM_Badge_BAO_Badge { /** * Helper function to print images + * * @param string $img image url * + * @param string $x + * @param string $y + * @param null $w + * @param null $h + * * @return void * @access public */ diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 17ff36333e..89e071e14e 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -140,12 +140,15 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { /** * Return the all eligible campaigns w/ cache. * - * @param int $includeId lets inlcude this campaign by force. - * @param int $excludeId do not include this campaign. - * @param boolean $onlyActive consider only active campaigns. + * @param int $includeId lets inlcude this campaign by force. + * @param int $excludeId do not include this campaign. + * @param boolean $onlyActive consider only active campaigns. * - * @return $campaigns a set of campaigns. - * @access public + * @param bool $onlyCurrent + * @param bool $appendDatesToTitle + * @param bool $forceAll + * + * @return mixed $campaigns a set of campaigns.@access public */ public static function getCampaigns( $includeId = NULL, diff --git a/CRM/Campaign/Form/Campaign.php b/CRM/Campaign/Form/Campaign.php index e0f7f0ad41..b46d808dc8 100644 --- a/CRM/Campaign/Form/Campaign.php +++ b/CRM/Campaign/Form/Campaign.php @@ -303,6 +303,10 @@ class CRM_Campaign_Form_Campaign 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/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index 25a971ef34..d08c1f86f3 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -114,6 +114,9 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @access public * + * @param $form + * @param $params + * * @return void */ static function beginPostProcess(&$form, &$params) { diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index 8bf57ace8e..04697789fd 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -134,6 +134,10 @@ class CRM_Case_Form_Activity_ChangeCaseType { * * @access public * + * @param $form + * @param $params + * @param $activity + * * @return void */ static function endPostProcess(&$form, &$params, $activity) { diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index 92334f738c..4a49875ac3 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -247,7 +247,11 @@ class CRM_Case_Form_Activity_OpenCase { /** * global validation rules for the form * - * @param array $values posted values of the form + * @param $fields + * @param $files + * @param $form + * + * @internal param array $values posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 3f6aca3a93..e3161961f7 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -249,7 +249,10 @@ class CRM_Case_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/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index c44d138b2d..b3762e6b55 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -919,11 +919,14 @@ WHERE id={$id}; "; /** * function to validate type of contact image * - * @param Array $param array of contact/profile field to be edited/added - * + * @param $params * @param String $imageIndex index of image field * - * @param String $statusMsg status message to be set after operation + * @param String $statusMsg status message to be set after operation + * + * @param string $opType + * + * @internal param Array $param array of contact/profile field to be edited/added * * @opType String $opType type of operation like fatal, bounce etc * diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 19fe9e5236..5a4a3c55ee 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -237,8 +237,11 @@ AND $operationClause LIMIT 1"; /** * Function to get the permission base on its relationship * - * @param int $selectedContactId contact id of selected contact - * @param int $contactId contact id of the current contact + * @param $selectedContactID + * @param null $contactID + * + * @internal param int $selectedContactId contact id of selected contact + * @internal param int $contactId contact id of the current contact * * @return booleab true if logged in user has permission to view * selected contact record else false diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 77bb995869..786d2d769f 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -141,10 +141,13 @@ WHERE id IN ( $idString ) /** * Generate a checksum for a $entityId of type $entityType * - * @param int $entityId - * @param int $ts timestamp that checksum was generated - * @param int $live life of this checksum in hours/ 'inf' for infinite - * @param string $hash contact hash, if sent, prevents a query in inner loop + * @param int $entityId + * @param int $ts timestamp that checksum was generated + * @param int $live life of this checksum in hours/ 'inf' for infinite + * @param string $hash contact hash, if sent, prevents a query in inner loop + * + * @param string $entityType + * @param null $hashSize * * @return array ( $cs, $ts, $live ) * @static diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 4f2a747e64..a76895e6d4 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -138,10 +138,13 @@ WHERE parent_id IS NULL * *function to retrieve all subtypes Information. * - *@param array $contactType. - *@return array of sub type information - *@static + * @param array $contactType . + * @param bool $all + * @param bool $ignoreCache + * @param bool $reset * + * @return array of sub type information + * @static */ static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) { static $_cache = NULL; diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 1232f65d86..ce40ccccb3 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -169,8 +169,12 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Given an array of contact ids, remove all the contacts from the group * - * @param array $contactIds (reference ) the array of contact ids to be removed - * @param int $groupId the id of the group + * @param array $contactIds (reference ) the array of contact ids to be removed + * @param int $groupId the id of the group + * + * @param string $method + * @param string $status + * @param null $tracking * * @return array (total, removed, notRemoved) count of contacts removed to group * @access public @@ -307,14 +311,16 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Function to get the list of groups for contact based on status of group membership * - * @param int $contactId contact id - * @param string $status state of membership - * @param int $numGroupContact number of groups for a contact that should be shown - * @param boolean $count true if we are interested only in the count - * @param boolean $ignorePermission true if we should ignore permissions for the current user + * @param int $contactId contact id + * @param string $status state of membership + * @param int $numGroupContact number of groups for a contact that should be shown + * @param boolean $count true if we are interested only in the count + * @param boolean $ignorePermission true if we should ignore permissions for the current user * useful in profile where permissions are limited for the user. If left * at false only groups viewable by the current user are returned - * @param boolean $onlyPublicGroups true if we want to hide system groups + * @param boolean $onlyPublicGroups true if we want to hide system groups + * + * @param bool $excludeHidden * * @return array (reference )|int $values the relevant data object values for the contact or * the total count when $count is true diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index d81842a884..47c7e8f0e5 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -243,8 +243,11 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Adds a new child group identified by $childGroupId to the group * identified by $groupId * - * @param $groupId The id of the group to add the child to - * @param $childGroupId The id of the new child group + * @param $parentID + * @param $childID + * + * @internal param \The $groupId id of the group to add the child to + * @internal param \The $childGroupId id of the new child group * * @return void * diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 9bf930eb63..93f7480645 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -142,8 +142,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio * * @param int $groupOrganizationID group organization id that needs to be deleted * - * @return $results no of deleted group organization on success, false otherwise - * @access public + * @return mixed|null $results no of deleted group organization on success, false otherwise@access public */ static function deleteGroupOrganization($groupOrganizationID) { $results = NULL; diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index ec2c1b12ea..28385c43ed 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -305,18 +305,21 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Function to get get list of relationship type based on the contact type. * - * @param int $contactId this is the contact id of the current contact. - * @param string $strContact this value is currently ignored, keeping it there for legacy reasons - * @param string $relationshipId the id of the existing relationship if any - * @param string $contactType contact type - * @param boolean $all if true returns relationship types in both the direction - * @param string $column name/label that going to retrieve from db. + * @param int $contactId this is the contact id of the current contact. + * @param null $contactSuffix + * @param string $relationshipId the id of the existing relationship if any + * @param string $contactType contact type + * @param boolean $all if true returns relationship types in both the direction + * @param string $column name/label that going to retrieve from db. * * - * @param string $contactSubType includes relationshiptypes between this subtype + * @param bool $biDirectional + * @param string $contactSubType includes relationshiptypes between this subtype * * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType * related relationshiptypes get return + * + * @internal param string $strContact this value is currently ignored, keeping it there for legacy reasons * @access public * @static * diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 4ca9547786..cd60126195 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -1120,10 +1120,12 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Function to that checks for duplicate contacts * - * @param array $fields fields array which are submitted - * @param array $error error message array - * @param int $contactID contact id - * @param string $contactType contact type + * @param array $fields fields array which are submitted + * @param $errors + * @param int $contactID contact id + * @param string $contactType contact type + * + * @internal param array $error error message array */ static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) { // if this is a forced save, ignore find duplicate rule diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index b362c0ac17..656db4ff78 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -139,7 +139,11 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * 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/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index 0d7e035fcc..b57a182449 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -330,6 +330,8 @@ class CRM_Contact_Form_Task_EmailCommon { * * @access public * + * @param $form + * * @return void */ static function postProcess(&$form) { diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index d4e915e517..e0cb7580f6 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -1120,7 +1120,11 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * function to check if an error in custom data * - * @param String $errorMessage A string containing all the error-fields. + * @param $params + * @param String $errorMessage A string containing all the error-fields. + * + * @param null $csType + * @param null $relationships * * @access public */ diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index 1e66182cd3..0a8dcaff09 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -259,6 +259,8 @@ class CRM_Contact_Page_View extends CRM_Core_Page { /** * Get meta details of the contact. * + * @param $contactId + * * @return array contact fields in fixed order * @access public */ diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 181adf5f38..b065a71f40 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -1154,11 +1154,14 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont /** * Function to create address associated with contribution record. - * @param array $params an associated array - * @param int $billingID $billingLocationTypeID * - * @return address id - * @static + * @param array $params an associated array + * @param $billingLocationTypeID + * + * @internal param int $billingID $billingLocationTypeID + * + * @return address id + * @static */ static function createAddress(&$params, $billingLocationTypeID) { $billingFields = array( diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index b8400623bd..1a255d9a43 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -54,8 +54,9 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * contribution object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params (reference ) an assoc array of name/value pairs + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Contribute_BAO_Contribution object * @access public diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index dc6006a533..922622b72e 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -900,6 +900,8 @@ class CRM_Contribute_BAO_Query { * * @access public * + * @param $form + * * @return void * @static */ diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 294264d265..317280e3dc 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -240,6 +240,11 @@ class CRM_Contribute_Form_AdditionalInfo { * * @access public * + * @param $params + * @param $contactID + * @param $contributionID + * @param null $contributionNoteID + * * @return void */ static function processNote(&$params, $contactID, $contributionID, $contributionNoteID = NULL) { diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index 5811c00277..b666ffa124 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -240,6 +240,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param string $columnName + * * @return array - array reference of all payment instruments if any * @static */ diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 4de248ae38..092e2a8611 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -215,9 +215,13 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * - View * - Edit * + * @param null $componentId + * @param null $componentAction + * @param null $key + * @param null $compContext + * * @return array * @access public - * */ static function &links($componentId = NULL, $componentAction = NULL, $key = NULL, $compContext = NULL) { $extraParams = NULL; @@ -450,9 +454,9 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C ), ); if ($this->_includeSoftCredits) { - self::$_columnHeaders = + self::$_columnHeaders = array_merge( - self::$_columnHeaders, + self::$_columnHeaders, array( array( 'name' => ts('Soft Credit Amount'), @@ -462,9 +466,9 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C ) ); } - self::$_columnHeaders = + self::$_columnHeaders = array_merge( - self::$_columnHeaders, + self::$_columnHeaders, array( array( 'name' => ts('Type'), @@ -510,9 +514,9 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C self::$_columnHeaders = array_merge($pre, self::$_columnHeaders); } if ($this->_includeSoftCredits) { - self::$_columnHeaders = + self::$_columnHeaders = array_merge( - self::$_columnHeaders, + self::$_columnHeaders, array( array( 'name' => ts('Soft Credit For'), @@ -527,7 +531,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C ) ); } - self::$_columnHeaders = + self::$_columnHeaders = array_merge( self::$_columnHeaders, array( array('desc' => ts('Actions')) diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index f619f75e03..84b307a5f7 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -114,12 +114,13 @@ class CRM_Core_Action { * * called by the request object to translate a string into a mask * - * @param string $action the action to be resolved + * @param $str + * + * @internal param string $action the action to be resolved * * @return int the action mask corresponding to the input string * @access public * @static - * */ static function resolve($str) { $action = 0; diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 3c714f8978..797b7c67af 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -170,7 +170,10 @@ class CRM_Core_BAO_Block { * Function to get all block ids for a contact * * @param string $blockName block name - * @param int $contactId contact id + * @param int $contactId contact id + * + * @param null $entityElements + * @param bool $updateBlankLocInfo * * @return array $contactBlockIds formatted array of block ids * diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index b9c11a8f12..2c7c219e91 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -253,9 +253,11 @@ class CRM_Core_BAO_CMSUser { /** * Function to create Form for CMS user using Profile * - * @param object $form + * @param object $form * @param integer $gid id of group of profile * @param bool $emailPresent true if the profile field has email(primary) + * @param const $action + * * @return FALSE|void WTF * * @access public diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 8c386f2c81..d3ff5354b6 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -1143,9 +1143,12 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * Given a custom field value, its id and the set of options * find the display value for this field * - * @param mixed $value the custom field value - * @param int $id the custom field id - * @param int $options the assoc array of option name/value pairs + * @param mixed $value the custom field value + * @param int $id the custom field id + * @param int $options the assoc array of option name/value pairs + * + * @param null $contactID + * @param null $fieldID * * @return string the display value * diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 77576d3559..6452076f71 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -1107,14 +1107,16 @@ ORDER BY civicrm_custom_group.weight, * Add the whereAdd clause for the DAO depending on the type of entity * the custom group is extending. * + * @param $customGroupDAO + * @param string $entityType - what entity are we extending here ? + * * @param object CRM_Core_DAO_CustomGroup (reference) - Custom Group DAO. - * @param string $entityType - what entity are we extending here ? + * @param bool $allSubtypes * * @return void * * @access private * @static - * */ private static function _addWhereAdd(&$customGroupDAO, $entityType, $entityID = NULL, $allSubtypes = FALSE) { $addSubtypeClause = FALSE; diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index 1665dd7bde..7306002162 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -135,7 +135,10 @@ class CRM_Core_BAO_CustomQuery { * Takes in a set of custom field ids andsets up the data structures to * generate a query * - * @param array $ids the set of custom field ids + * @param array $ids the set of custom field ids + * + * @param bool $contactSearch + * @param array $locationSpecificFields * * @access public */ diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index cd52496a93..0af5d6ce02 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -250,6 +250,8 @@ class CRM_Core_BAO_CustomValueTable { * * @param string $type the civicrm type string * + * @param int $maxLength + * * @return the mysql data store placeholder * @access public * @static diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 46930a91cc..86d0a542d9 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -169,6 +169,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * Create a new domain * + * @param $params + * * @return domain array * @access public */ diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 9b49d63ad8..0c2b899a0b 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -236,8 +236,11 @@ WHERE e.id = %1"; * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param $entityBlock + * @param bool $microformat + * + * @internal param array $params input parameters to find object + * @internal param array $values output values of the object * * @return array array of objects(CRM_Core_BAO_Location) * @access public diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 55f7d3732e..7653c60817 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -237,11 +237,11 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object - * @param array $ids the array that holds all the db ids - * @param int $numNotes the maximum number of notes to return (0 if all) + * @param array $params input parameters to find object + * @param array $values output values of the object + * @param int $numNotes the maximum number of notes to return (0 if all) * + * @internal param array $ids the array that holds all the db ids * @return object $notes Object of CRM_Core_BAO_Note * @access public * @static diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php index a4b20d838f..8b99265f6e 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -256,10 +256,12 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get PDF Page Format field from associative array * - * @param string $field name of a PDF Page Format field - * @param array (reference) $values associative array of name/value pairs containing + * @param string $field name of a PDF Page Format field + * @param array (reference) $values associative array of name/value pairs containing * PDF Page Format field selections * + * @param null $default + * * @return value * @access public * @static diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 04b1ce0ae1..3f101c395c 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -302,9 +302,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * @param object $value (required) The value that will be serialized and stored * @param string $group (required) The group name of the item - * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so componenets can share the same name space) - * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session + * @param string $name (required) The name of the setting + * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param null $contactID + * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session + * + * @param null $domainID * * @return void * @static diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 365d4f05d5..e600d22c49 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -248,14 +248,21 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * and format for use with buildProfile. This is the SQL analog of * formatUFFields(). * - * @param mix $id the id of the UF group or ids of ufgroup - * @param int $register are we interested in registration fields - * @param int $action what action are we doing - * @param int $visibility visibility of fields we are interested in + * @param mix $id the id of the UF group or ids of ufgroup + * @param bool|int $register are we interested in registration fields + * @param int $action what action are we doing + * @param int $visibility visibility of fields we are interested in * @param $searchable - * @param boolean $showall - * @param string $restrict should we restrict based on a specified profile type + * @param bool $showAll + * @param string $restrict should we restrict based on a specified profile type + * + * @param bool $skipPermission + * @param null $ctype + * @param int $permissionType + * @param string $orderBy + * @param null $orderProfiles * + * @internal param bool $showall * @return array the fields that belong to this ufgroup(s) * @static * @access public diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index fcd4c6f060..45746874b1 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -167,11 +167,14 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * Synchronize the object with the UF Match entry. Can be called stand-alone from * the drupalUsers script * - * @param Object $user the drupal user object - * @param string $userKey the id of the user from the uf object - * @param string $uniqId the OpenID of the user - * @param string $uf the name of the user framework - * @param integer $status returns the status if user created or already exits (used for CMS sync) + * @param Object $user the drupal user object + * @param string $userKey the id of the user from the uf object + * @param string $uniqId the OpenID of the user + * @param string $uf the name of the user framework + * @param integer $status returns the status if user created or already exits (used for CMS sync) + * + * @param null $ctype + * @param bool $isLogin * * @return the ufmatch object that was found or created * @access public diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 0935d33487..257230f969 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -883,9 +883,11 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * 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 $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once + * @param string $nextType + * @param string $backType + * @param bool|string $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once * + * @internal param string $type button type for the form after processing * @return void * @access public */ diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index 0b114d3281..75e0c26ec6 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -240,6 +240,8 @@ class CRM_Core_ManagedEntities { } /** + * @param $declarations + * * @return mixed string on error, or FALSE */ protected static function validate($declarations) { diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index f058303608..f2498e3ae7 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -172,11 +172,12 @@ class CRM_Core_OptionValue { /** * Function to add/edit option-value of a particular group * - * @param array $params Array containing exported values from the invoking form. - * @param array $groupParams Array containing group fields whose option-values is to retrieved/saved. - * @param string $orderBy for orderBy clause - * @param integer $optionValueID has the id of the optionValue being edited, disabled ..etc + * @param array $params Array containing exported values from the invoking form. + * @param array $groupParams Array containing group fields whose option-values is to retrieved/saved. + * @param $action + * @param integer $optionValueID has the id of the optionValue being edited, disabled ..etc * + * @internal param string $orderBy for orderBy clause * @return array of option-values * * @access public diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index a0a01e6956..8b1c74e525 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -298,9 +298,10 @@ class CRM_Core_Page { /** * assign value to name in template * - * @param array|string $name name of variable + * @param $var * @param mixed $value value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ @@ -336,7 +337,8 @@ class CRM_Core_Page { * Returns an array containing template variables * * @param string $name - * @param string $type + * + * @internal param string $type * @return array */ function get_template_vars($name=null) { diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index d49644c706..d0632397c4 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -127,9 +127,9 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * class constructor * * @param string $title title of the page - * @param int $mode mode of the page + * @param int $mode mode of the page * - * @return CRM_Core_Page + * @return \CRM_Core_Page_Basic */ function __construct($title = NULL, $mode = NULL) { parent::__construct($title, $mode); diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 02628ac23e..2595d18a9f 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -241,6 +241,9 @@ class CRM_Core_Payment_Form { /** * Function to add all the credit card fields * + * @param $form + * @param bool $useRequired + * * @return void * @access public */ diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index c87d52f02d..267f45c344 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -232,11 +232,13 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { /** * The function gets called when the state(CHARGED, CANCELLED..) changes for an order * - * @param string $status status of the transaction send by google - * @param array $privateData contains the name value pair of + * @param string $status status of the transaction send by google + * @param $dataRoot + * @param array $privateData contains the name value pair of * - * @return void + * @param $component * + * @return void */ function orderStateChange($status, $dataRoot, $privateData, $component) { $input = $objects = $ids = array(); diff --git a/CRM/Core/Payment/IATS.php b/CRM/Core/Payment/IATS.php index d4656354e5..a3417d87b6 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -309,7 +309,7 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @param string $mode the mode we are operating in (live or test) + * @internal param string $mode the mode we are operating in (live or test) * * @return string the error message if any * @public diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index fd0102c6b3..01413de977 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -261,11 +261,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param $xml * an XML string. * - * @return - * An array of the result with following keys: - * - error : false, if no error. Otherwise, it is the error message - * - return : a multi-dimension associative array represent the value - * of the XML input string. + * @return array An array of the result with following keys: */ function xml_parse_into_assoc($xml) { $input = array(); diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 971722508a..1e6b47526e 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -897,8 +897,9 @@ WHERE id = %1"; * @access public * @static * - * @return array - array reference of all country ISO codes. + * @param bool $id * + * @return array - array reference of all country ISO codes. */ public static function &countryIsoCode($id = FALSE) { if (!self::$countryIsoCode) { @@ -926,14 +927,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 &allGroup($groupType = NULL, $excludeHidden = TRUE) { $condition = CRM_Contact_BAO_Group::groupTypeCondition($groupType, $excludeHidden); diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 0501b2c19c..f7d20fcf02 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -210,7 +210,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * initialize the various templates * - * @param object $page the CRM_Core_Form page + * @internal param object $page the CRM_Core_Form page * * @return void * @access public diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index 0d432db148..c66b119ed4 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -174,10 +174,12 @@ class CRM_Core_ShowHideBlocks { /** * Create links that we can use in the form * - * @param CRM_Core_Form $form the form object - * @param string $prefix the attribute that we are referencing - * @param string $showLinkText the text to be shown for the show link - * @param string $hideLinkText the text to be shown for the hide link + * @param CRM_Core_Form $form the form object + * @param string $prefix the attribute that we are referencing + * @param string $showLinkText the text to be shown for the show link + * @param string $hideLinkText the text to be shown for the hide link + * + * @param bool $assign * * @static * diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index f5ae04d230..5c037548e9 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -255,12 +255,12 @@ class CRM_Core_StateMachine { * * @access public * - * @param array $states states is an array of arrays. Each element + * @param array $pages (reference ) the array of page objects + * + * @internal param array $states states is an array of arrays. Each element * of the top level array describes a state. Each state description * includes the name, the display name and the class name * - * @param array $pages (reference ) the array of page objects - * * @return void */ function addSequentialPages(&$pages) { diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index ea3912c14a..2e8af3d9f5 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -247,6 +247,9 @@ class CRM_Custom_Form_Option 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/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index 205e4a7c01..9eb91b2194 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -172,7 +172,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * * Although the api will accept any strtotime valid string CiviCRM accepts at least one date format * not supported by strtotime so we should run this through a conversion - * @param unknown $params + * @internal param \unknown $params */ function formatDateParams() { $session = CRM_Core_Session::singleton(); @@ -244,4 +244,4 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } return $importableFields; } -} \ No newline at end of file +} diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 1438e8f5ca..10fec2fb4a 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -134,7 +134,11 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param string - $retColumn tells populate() whether to return 'name' (default) or 'label' values + * @param null $id + * @param null $cond + * @param string $retColumn + * + * @internal param $string - $retColumn tells populate() whether to return 'name' (default) or 'label' values * * @return array - array reference of all participant statuses if any * @static diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 49b4c423fc..39b46c62d2 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -261,7 +261,10 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * 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/Export/Form/Select.php b/CRM/Export/Form/Select.php index 790c9b630a..c31b600fec 100644 --- a/CRM/Export/Form/Select.php +++ b/CRM/Export/Form/Select.php @@ -335,6 +335,9 @@ FROM {$this->_componentTable} * * @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/Extension/Browser.php b/CRM/Extension/Browser.php index 49295c940f..2bb17c2ff8 100644 --- a/CRM/Extension/Browser.php +++ b/CRM/Extension/Browser.php @@ -132,6 +132,8 @@ class CRM_Extension_Browser { /** * Get a description of a particular extension * + * @param $key + * * @return CRM_Extension_Info|NULL */ public function getExtension($key) { diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php index a469436713..a2eb7d9f08 100644 --- a/CRM/Extension/Container/Basic.php +++ b/CRM/Extension/Container/Basic.php @@ -169,8 +169,10 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface /** * Determine the relative path of an extension directory * + * @param $key + * + * @throws CRM_Extension_Exception_MissingException * @return string - * @throws CRM_Extension_Exception */ protected function getRelPath($key) { $keypaths = $this->getRelPaths(); @@ -217,8 +219,10 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface /** * Determine the relative path of an extension directory * + * @param $key + * + * @throws CRM_Extension_Exception_MissingException * @return string - * @throws CRM_Extension_Exception */ protected function getRelUrl($key) { $relUrls = $this->getRelUrls(); diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php index ad09f32f1d..3d808e84fc 100644 --- a/CRM/Extension/Downloader.php +++ b/CRM/Extension/Downloader.php @@ -45,6 +45,7 @@ class CRM_Extension_Downloader { public $tmpDir; /** + * @param CRM_Extension_Manager $manager * @param string $containerDir the place to store downloaded & extracted extensions * @param string $tmpDir */ diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 1510aef22c..b749bd9d4c 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -108,7 +108,10 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin /** * Function to delete financial Types * - * @param int $contributionTypeId + * @param $financialTypeAccountId + * @param null $accountId + * + * @internal param int $contributionTypeId * @static */ static function del($financialTypeAccountId, $accountId = null) { diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index b0cc8b6810..5bdef512c9 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -173,7 +173,11 @@ class CRM_Financial_Form_FinancialBatch 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/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index 2651e71598..00fcecc471 100644 --- a/CRM/Financial/Form/FinancialTypeAccount.php +++ b/CRM/Financial/Form/FinancialTypeAccount.php @@ -245,7 +245,11 @@ class CRM_Financial_Form_FinancialTypeAccount 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/Page/FinancialType.php b/CRM/Financial/Page/FinancialType.php index e8181e2129..317824266d 100644 --- a/CRM/Financial/Page/FinancialType.php +++ b/CRM/Financial/Page/FinancialType.php @@ -214,6 +214,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = null) { diff --git a/CRM/Friend/Form.php b/CRM/Friend/Form.php index 2158783daf..048ac060e4 100644 --- a/CRM/Friend/Form.php +++ b/CRM/Friend/Form.php @@ -231,7 +231,9 @@ class CRM_Friend_Form extends CRM_Core_Form { /** * Function for validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param $fields + * + * @internal param array $params (ref.) an assoc array of name/value pairs * * @return mixed true or array of errors * @access public diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index ff5414b878..ec11bac78c 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -115,6 +115,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @static * + * @param bool $admin + * * @return array Array of grant summary statistics */ static function getGrantStatistics($admin = FALSE) { diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index 6f80879930..f80573b1d8 100644 --- a/CRM/Mailing/Event/BAO/Reply.php +++ b/CRM/Mailing/Event/BAO/Reply.php @@ -49,9 +49,11 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** * Register a reply event. * - * @param int $job_id The job ID of the reply - * @param int $queue_id The queue event id - * @param string $hash The hash + * @param int $job_id The job ID of the reply + * @param int $queue_id The queue event id + * @param string $hash The hash + * + * @param null $replyto * * @return object|null The mailing object, or null on failure * @access public diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php index 20130811ee..1879eeef98 100644 --- a/CRM/Mailing/Form/Task.php +++ b/CRM/Mailing/Form/Task.php @@ -134,7 +134,11 @@ class CRM_Mailing_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 @@ -153,4 +157,4 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { ) ); } -} \ No newline at end of file +} diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index c3028898ad..ff9650946c 100644 --- a/CRM/Mailing/Form/Test.php +++ b/CRM/Mailing/Form/Test.php @@ -172,10 +172,11 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { /** * Form rule to send out a test mailing. * - * @param array $params Array of the form values - * @param array $files Any files posted to the form - * @param array $self an current this object + * @param $testParams + * @param array $files Any files posted to the form + * @param array $self an current this object * + * @internal param array $params Array of the form values * @return boolean true on successful SMTP handoff * @access public */ diff --git a/CRM/Member/Form/Task/PDFLetterCommon.php b/CRM/Member/Form/Task/PDFLetterCommon.php index e85cd80508..1c7be5d28a 100644 --- a/CRM/Member/Form/Task/PDFLetterCommon.php +++ b/CRM/Member/Form/Task/PDFLetterCommon.php @@ -47,11 +47,15 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLett /** * generate htmlfor pdf letters + * * @param unknown_type $membershipIDs * @param unknown_type $returnProperties * @param unknown_type $skipOnHold * @param unknown_type $skipDeceased * @param unknown_type $messageToken + * @param $html_message + * @param $categories + * * @return unknown */ static function generateHTML($membershipIDs, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $html_message, $categories) { diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index f671728b81..c884a115be 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -302,6 +302,9 @@ class CRM_Member_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/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index cf06c15946..d0a31a0073 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -331,6 +331,8 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index 56e9946ebb..9bfcba1ac6 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -137,15 +137,18 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $memberClause if the caller wants to further restrict the search (used in memberships) + * @param array $queryParams array of parameters for query + * @param \const|int $action - action of search basic or advanced. + * @param string $memberClause if the caller wants to further restrict the search (used in memberships) * @param boolean $single are we dealing only with one contact? - * @param int $limit how many memberships do we want returned + * @param int $limit how many memberships do we want returned * - * @return CRM_Contact_Selector - * @access public - */ function __construct(&$queryParams, + * @param string $context + * + * @return \CRM_Member_Selector_Search + @access public + */ + function __construct(&$queryParams, $action = CRM_Core_Action::NONE, $memberClause = NULL, $single = FALSE, diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 65986ebabc..1258616e2d 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -897,7 +897,10 @@ WHERE pcp.id = %1"; /** * Function to get supporter profile id * - * @param int $contributionPageId contribution page id + * @param $component_id + * @param string $component + * + * @internal param int $contributionPageId contribution page id * * @return int * @access public diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 613f1e779c..1f952c0d4c 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -237,9 +237,11 @@ class CRM_PCP_Form_PCPAccount 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/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index ff728e358d..ba70845266 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -322,14 +322,15 @@ WHERE pledge_id = %1 /** * update Pledge Payment Status * - * @param int $pledgeID, id of pledge - * @param array $paymentIDs, ids of pledge payment(s) to update - * @param int $paymentStatusID, payment status to set - * @param int $pledgeStatus, pledge status to change (if needed) - * @param float $actualAmount, actual amount being paid - * @param bool $adjustTotalAmount, is amount being paid different from scheduled amount? - * @param bool $isScriptUpdate, is function being called from bin script? + * @param int $pledgeID , id of pledge + * @param array $paymentIDs , ids of pledge payment(s) to update + * @param int $paymentStatusID , payment status to set + * @param null $pledgeStatusID + * @param float|int $actualAmount , actual amount being paid + * @param bool $adjustTotalAmount , is amount being paid different from scheduled amount? + * @param bool $isScriptUpdate , is function being called from bin script? * + * @internal param int $pledgeStatus , pledge status to change (if needed) * @return int $newStatus, updated status id (or 0) */ static function updatePledgePaymentStatus( diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index c189b4b8b9..a9700120e9 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -140,14 +140,16 @@ class CRM_Pledge_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 + * @param string $context + * + * @return \CRM_Pledge_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 1cf4291460..baec5e9257 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -907,6 +907,9 @@ WHERE id = %1"; /** * Function to set daefult the price set fields. * + * @param $form + * @param $defaults + * * @return array $defaults * @access public */ diff --git a/CRM/Queue/Queue/Sql.php b/CRM/Queue/Queue/Sql.php index ec42b368da..9a7b638e91 100644 --- a/CRM/Queue/Queue/Sql.php +++ b/CRM/Queue/Queue/Sql.php @@ -165,7 +165,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { /** * Get the next item, even if there's an active lease * - * @param $lease_time seconds + * @param int|\seconds $lease_time seconds * * @return object with key 'data' that matches the inputted data */ diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index 5496d1bdd8..5ff5769c59 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -301,6 +301,8 @@ WHERE inst.report_id = %1"; * * @instanceId string $str the report instance to check * + * @param $instanceId + * * @return boolean true if yes, else false * @static * @access public diff --git a/CRM/SMS/Form/Schedule.php b/CRM/SMS/Form/Schedule.php index a3ad4db0b6..299d197405 100644 --- a/CRM/SMS/Form/Schedule.php +++ b/CRM/SMS/Form/Schedule.php @@ -117,7 +117,10 @@ class CRM_SMS_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/SMS/Page/Provider.php b/CRM/SMS/Page/Provider.php index 34f60da60b..b6d33ea459 100644 --- a/CRM/SMS/Page/Provider.php +++ b/CRM/SMS/Page/Provider.php @@ -126,6 +126,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Browse all Providers. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Utils/Mail/EmailProcessor.php b/CRM/Utils/Mail/EmailProcessor.php index 6dc4ae3f1a..5d68dd3932 100644 --- a/CRM/Utils/Mail/EmailProcessor.php +++ b/CRM/Utils/Mail/EmailProcessor.php @@ -112,7 +112,7 @@ class CRM_Utils_Mail_EmailProcessor { /** * Process the mailbox for all the settings from civicrm_mail_settings * - * @param string $civiMail if true, processing is done in CiviMail context, or Activities otherwise. + * @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise. * * @return void */ -- 2.25.1