From c490a46ac4bf490d3fbb31e35d24c6b43e764f00 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Thu, 27 Nov 2014 11:53:14 -0500 Subject: [PATCH] Mass cleanup of docblocks/code/comments --- CRM/ACL/BAO/ACL.php | 18 +- CRM/ACL/BAO/EntityRole.php | 6 +- CRM/ACL/Form/ACL.php | 26 ++- CRM/ACL/Form/ACLBasic.php | 8 +- CRM/ACL/Form/EntityRole.php | 4 +- CRM/ACL/Form/WordPress/Permissions.php | 4 +- CRM/Activity/BAO/Activity.php | 84 +++---- CRM/Activity/BAO/ActivityAssignment.php | 6 +- CRM/Activity/BAO/ActivityContact.php | 13 +- CRM/Activity/BAO/ActivityTarget.php | 19 +- CRM/Activity/BAO/Query.php | 2 +- CRM/Activity/Form/Activity.php | 23 +- CRM/Activity/Form/ActivityView.php | 4 +- CRM/Activity/Form/Search.php | 12 +- CRM/Activity/Form/Task.php | 6 +- CRM/Activity/Form/Task/AddToTag.php | 5 +- CRM/Activity/Form/Task/Batch.php | 5 +- CRM/Activity/Form/Task/Delete.php | 2 +- CRM/Activity/Form/Task/Email.php | 2 +- CRM/Activity/Form/Task/FileOnCase.php | 2 +- CRM/Activity/Form/Task/PickOption.php | 2 +- CRM/Activity/Form/Task/PickProfile.php | 3 +- CRM/Activity/Form/Task/Print.php | 2 +- CRM/Activity/Form/Task/RemoveFromTag.php | 5 +- CRM/Activity/Form/Task/SMS.php | 2 +- .../Form/Task/SearchTaskHookSample.php | 2 +- CRM/Activity/Import/Form/DataSource.php | 4 +- CRM/Activity/Import/Form/MapField.php | 4 +- CRM/Activity/Import/Form/Preview.php | 2 +- CRM/Activity/Import/Form/Summary.php | 2 +- CRM/Activity/Import/Parser.php | 7 +- CRM/Activity/Page/AJAX.php | 2 +- CRM/Activity/Page/UserDashboard.php | 2 +- CRM/Activity/Selector/Activity.php | 7 +- CRM/Activity/Selector/Search.php | 9 +- CRM/Admin/Form.php | 2 +- CRM/Admin/Form/CMSUser.php | 4 +- CRM/Admin/Form/ContactType.php | 4 +- CRM/Admin/Form/Extensions.php | 8 +- CRM/Admin/Form/Job.php | 5 +- CRM/Admin/Form/LabelFormats.php | 4 +- CRM/Admin/Form/LocationType.php | 4 +- CRM/Admin/Form/MailSettings.php | 4 +- CRM/Admin/Form/Mapping.php | 4 +- CRM/Admin/Form/MessageTemplates.php | 6 +- CRM/Admin/Form/Navigation.php | 4 +- CRM/Admin/Form/OptionGroup.php | 4 +- CRM/Admin/Form/Options.php | 8 +- CRM/Admin/Form/PaymentProcessor.php | 4 +- CRM/Admin/Form/PaymentProcessorType.php | 4 +- CRM/Admin/Form/PdfFormats.php | 4 +- CRM/Admin/Form/Preferences.php | 7 +- CRM/Admin/Form/Preferences/Address.php | 5 +- CRM/Admin/Form/Preferences/Contribute.php | 6 +- CRM/Admin/Form/Preferences/Display.php | 5 +- CRM/Admin/Form/Preferences/Member.php | 2 +- CRM/Admin/Form/PreferencesDate.php | 4 +- CRM/Admin/Form/RelationshipType.php | 4 +- CRM/Admin/Form/ScheduleReminders.php | 4 +- CRM/Admin/Form/Setting.php | 8 +- CRM/Admin/Form/Setting/Component.php | 2 +- CRM/Admin/Form/Setting/Date.php | 2 +- CRM/Admin/Form/Setting/Debugging.php | 2 +- CRM/Admin/Form/Setting/Localization.php | 2 +- CRM/Admin/Form/Setting/Mail.php | 2 +- CRM/Admin/Form/Setting/Mapping.php | 2 +- CRM/Admin/Form/Setting/Miscellaneous.php | 2 +- CRM/Admin/Form/Setting/Path.php | 2 +- CRM/Admin/Form/Setting/Search.php | 2 +- CRM/Admin/Form/Setting/Smtp.php | 6 +- CRM/Admin/Form/Setting/UF.php | 2 +- .../Form/Setting/UpdateConfigBackend.php | 2 +- CRM/Admin/Form/Setting/Url.php | 2 +- CRM/Admin/Form/Tag.php | 4 +- CRM/Admin/Form/WordReplacements.php | 4 +- CRM/Admin/Page/AJAX.php | 4 +- CRM/Admin/Page/Extensions.php | 2 +- CRM/Admin/Page/MessageTemplates.php | 2 - CRM/Badge/BAO/Badge.php | 7 +- CRM/Badge/BAO/Layout.php | 10 +- CRM/Badge/Form/Layout.php | 8 +- CRM/Batch/BAO/Batch.php | 8 +- CRM/Batch/Form/Batch.php | 7 +- CRM/Batch/Form/Entry.php | 5 +- CRM/Batch/Page/Batch.php | 2 - CRM/Bridge/OG/Drupal.php | 12 +- CRM/Campaign/BAO/Campaign.php | 15 +- CRM/Campaign/BAO/Petition.php | 22 +- CRM/Campaign/BAO/Query.php | 2 +- CRM/Campaign/BAO/Survey.php | 35 ++- CRM/Campaign/Form/Campaign.php | 2 +- CRM/Campaign/Form/Gotv.php | 2 +- CRM/Campaign/Form/Petition.php | 2 +- CRM/Campaign/Form/Petition/Signature.php | 6 +- CRM/Campaign/Form/Search.php | 2 +- CRM/Campaign/Form/Search/Campaign.php | 2 +- CRM/Campaign/Form/Search/Petition.php | 2 +- CRM/Campaign/Form/Search/Survey.php | 2 +- CRM/Campaign/Form/Survey.php | 2 +- CRM/Campaign/Form/Survey/Delete.php | 4 +- CRM/Campaign/Form/Survey/Main.php | 4 +- CRM/Campaign/Form/Survey/Questions.php | 4 +- CRM/Campaign/Form/Survey/Results.php | 4 +- CRM/Campaign/Form/Survey/TabHeader.php | 6 +- CRM/Campaign/Form/SurveyType.php | 8 +- CRM/Campaign/Form/Task.php | 4 +- CRM/Campaign/Form/Task/Interview.php | 6 +- CRM/Campaign/Form/Task/Print.php | 2 +- CRM/Campaign/Form/Task/Release.php | 2 +- CRM/Campaign/Form/Task/Reserve.php | 2 +- CRM/Campaign/Form/Task/Result.php | 2 +- CRM/Campaign/Page/DashBoard.php | 9 +- CRM/Campaign/Page/SurveyType.php | 2 +- CRM/Campaign/Selector/Search.php | 6 +- CRM/Case/BAO/Case.php | 22 +- CRM/Case/BAO/CaseType.php | 21 +- CRM/Case/BAO/Query.php | 2 +- CRM/Case/Form/Activity.php | 8 +- .../Form/Activity/ChangeCaseStartDate.php | 22 +- CRM/Case/Form/Activity/ChangeCaseStatus.php | 22 +- CRM/Case/Form/Activity/ChangeCaseType.php | 22 +- CRM/Case/Form/Activity/LinkCases.php | 22 +- CRM/Case/Form/Activity/OpenCase.php | 20 +- CRM/Case/Form/ActivityChangeStatus.php | 2 +- CRM/Case/Form/ActivityToCase.php | 4 +- CRM/Case/Form/ActivityView.php | 2 +- CRM/Case/Form/Case.php | 8 +- CRM/Case/Form/CaseView.php | 14 +- CRM/Case/Form/CustomData.php | 2 +- CRM/Case/Form/EditClient.php | 4 +- CRM/Case/Form/Report.php | 4 +- CRM/Case/Form/Search.php | 4 +- CRM/Case/Form/Task.php | 6 +- CRM/Case/Form/Task/Delete.php | 2 +- CRM/Case/Form/Task/Print.php | 2 +- CRM/Case/Form/Task/Restore.php | 2 +- CRM/Case/Form/Task/Result.php | 2 +- CRM/Case/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Case/Page/AJAX.php | 2 +- CRM/Case/Selector/Search.php | 8 +- CRM/Case/XMLProcessor/Process.php | 18 +- CRM/Case/XMLProcessor/Report.php | 9 +- CRM/Contact/BAO/Contact.php | 61 ++--- CRM/Contact/BAO/Contact/Location.php | 6 +- CRM/Contact/BAO/Contact/Permission.php | 22 +- CRM/Contact/BAO/Contact/Utils.php | 20 +- CRM/Contact/BAO/ContactType.php | 60 ++--- CRM/Contact/BAO/DashboardContact.php | 1 - CRM/Contact/BAO/Group.php | 24 +- CRM/Contact/BAO/GroupContact.php | 14 +- CRM/Contact/BAO/GroupContactCache.php | 4 +- CRM/Contact/BAO/GroupNesting.php | 12 +- CRM/Contact/BAO/GroupOrganization.php | 6 +- CRM/Contact/BAO/Household.php | 2 +- CRM/Contact/BAO/Individual.php | 2 +- CRM/Contact/BAO/Query.php | 11 +- CRM/Contact/BAO/Query/Hook.php | 2 +- CRM/Contact/BAO/Query/Interface.php | 2 +- CRM/Contact/BAO/Relationship.php | 15 +- CRM/Contact/BAO/RelationshipType.php | 14 +- CRM/Contact/BAO/SavedSearch.php | 2 +- CRM/Contact/Form/Contact.php | 14 +- CRM/Contact/Form/CustomData.php | 2 +- CRM/Contact/Form/DedupeFind.php | 6 +- CRM/Contact/Form/DedupeRules.php | 8 +- CRM/Contact/Form/Domain.php | 4 +- CRM/Contact/Form/Edit/Address.php | 14 +- .../Form/Edit/CommunicationPreferences.php | 8 +- CRM/Contact/Form/Edit/CustomData.php | 8 +- CRM/Contact/Form/Edit/Demographics.php | 6 +- CRM/Contact/Form/Edit/Email.php | 2 +- CRM/Contact/Form/Edit/Household.php | 12 +- CRM/Contact/Form/Edit/IM.php | 2 +- CRM/Contact/Form/Edit/Individual.php | 2 - CRM/Contact/Form/Edit/Lock.php | 9 +- CRM/Contact/Form/Edit/OpenID.php | 2 +- CRM/Contact/Form/Edit/Organization.php | 2 +- CRM/Contact/Form/Edit/Phone.php | 2 +- CRM/Contact/Form/Edit/TagsAndGroups.php | 6 +- CRM/Contact/Form/Edit/Website.php | 2 +- CRM/Contact/Form/GroupContact.php | 4 +- CRM/Contact/Form/Inline/Address.php | 2 +- .../Form/Inline/CommunicationPreferences.php | 2 +- CRM/Contact/Form/Inline/ContactInfo.php | 2 +- CRM/Contact/Form/Inline/ContactName.php | 2 +- CRM/Contact/Form/Inline/CustomData.php | 2 +- CRM/Contact/Form/Inline/Demographics.php | 2 +- CRM/Contact/Form/Inline/Email.php | 2 +- CRM/Contact/Form/Inline/IM.php | 2 +- CRM/Contact/Form/Inline/Lock.php | 9 +- CRM/Contact/Form/Inline/OpenID.php | 2 +- CRM/Contact/Form/Inline/Phone.php | 2 +- CRM/Contact/Form/Inline/Website.php | 2 +- CRM/Contact/Form/Location.php | 8 +- CRM/Contact/Form/ProfileContact.php | 11 +- CRM/Contact/Form/RelatedContact.php | 4 +- CRM/Contact/Form/Relationship.php | 6 +- CRM/Contact/Form/Search.php | 15 +- CRM/Contact/Form/Search/Advanced.php | 2 +- CRM/Contact/Form/Search/Basic.php | 2 +- CRM/Contact/Form/Search/Builder.php | 4 +- CRM/Contact/Form/Search/Criteria.php | 6 +- .../Form/Search/Custom/ActivitySearch.php | 8 +- CRM/Contact/Form/Search/Custom/Base.php | 2 +- CRM/Contact/Form/Search/Custom/Basic.php | 2 +- .../Form/Search/Custom/ContribSYBNT.php | 2 +- .../Search/Custom/ContributionAggregate.php | 6 +- .../Form/Search/Custom/EmployerListing.php | 22 +- .../Form/Search/Custom/EventAggregate.php | 16 +- CRM/Contact/Form/Search/Custom/Group.php | 4 +- .../Form/Search/Custom/MultipleValues.php | 2 +- .../Form/Search/Custom/PostalMailing.php | 2 +- CRM/Contact/Form/Search/Custom/PriceSet.php | 2 +- .../Form/Search/Custom/RandomSegment.php | 1 - CRM/Contact/Form/Search/Custom/Sample.php | 2 +- .../Form/Search/Custom/TagContributions.php | 6 +- .../Form/Search/Custom/ZipCodeRange.php | 2 +- CRM/Contact/Form/Task.php | 14 +- CRM/Contact/Form/Task/AddToGroup.php | 7 +- CRM/Contact/Form/Task/AddToHousehold.php | 6 +- CRM/Contact/Form/Task/AddToOrganization.php | 4 +- CRM/Contact/Form/Task/AddToTag.php | 5 +- CRM/Contact/Form/Task/AlterPreferences.php | 4 +- CRM/Contact/Form/Task/Batch.php | 7 +- CRM/Contact/Form/Task/Delete.php | 3 +- CRM/Contact/Form/Task/Email.php | 2 +- CRM/Contact/Form/Task/EmailCommon.php | 7 +- CRM/Contact/Form/Task/HookSample.php | 2 +- CRM/Contact/Form/Task/Label.php | 8 +- CRM/Contact/Form/Task/LabelCommon.php | 9 +- CRM/Contact/Form/Task/Map.php | 5 +- CRM/Contact/Form/Task/PDF.php | 4 +- CRM/Contact/Form/Task/PDFLetterCommon.php | 12 +- CRM/Contact/Form/Task/PickProfile.php | 3 +- CRM/Contact/Form/Task/Print.php | 2 +- CRM/Contact/Form/Task/ProximityCommon.php | 8 +- CRM/Contact/Form/Task/RemoveFromGroup.php | 3 +- CRM/Contact/Form/Task/RemoveFromTag.php | 5 +- CRM/Contact/Form/Task/Result.php | 2 +- CRM/Contact/Form/Task/SMS.php | 2 +- CRM/Contact/Form/Task/SMSCommon.php | 8 +- CRM/Contact/Form/Task/SaveSearch.php | 2 +- CRM/Contact/Form/Task/SaveSearch/Update.php | 2 +- CRM/Contact/Form/Task/Unhold.php | 2 +- CRM/Contact/Form/Task/Useradd.php | 5 +- CRM/Contact/Import/Form/DataSource.php | 4 +- CRM/Contact/Import/Form/MapField.php | 4 +- CRM/Contact/Import/Form/Preview.php | 4 +- CRM/Contact/Import/Form/Summary.php | 2 +- CRM/Contact/Import/ImportJob.php | 4 +- CRM/Contact/Import/Page/AJAX.php | 2 +- CRM/Contact/Import/Parser.php | 10 +- CRM/Contact/Import/Parser/Contact.php | 12 +- CRM/Contact/Page/AJAX.php | 8 +- CRM/Contact/Page/View/CustomData.php | 2 - CRM/Contact/Page/View/GroupContact.php | 6 +- CRM/Contact/Page/View/UserDashBoard.php | 25 +-- .../Page/View/UserDashBoard/GroupContact.php | 4 +- CRM/Contact/Selector.php | 16 +- CRM/Contact/Selector/Custom.php | 8 +- CRM/Contribute/BAO/Contribution.php | 31 ++- CRM/Contribute/BAO/Contribution/Utils.php | 18 +- CRM/Contribute/BAO/ContributionPage.php | 14 +- CRM/Contribute/BAO/ContributionRecur.php | 22 +- CRM/Contribute/BAO/ContributionSoft.php | 22 +- CRM/Contribute/BAO/ManagePremiums.php | 12 +- CRM/Contribute/BAO/Premium.php | 24 +- CRM/Contribute/BAO/Query.php | 2 +- CRM/Contribute/Form.php | 2 +- CRM/Contribute/Form/AdditionalInfo.php | 28 +-- CRM/Contribute/Form/AdditionalPayment.php | 2 +- CRM/Contribute/Form/CancelSubscription.php | 8 +- CRM/Contribute/Form/Contribution.php | 7 +- CRM/Contribute/Form/Contribution/Confirm.php | 23 +- CRM/Contribute/Form/Contribution/Main.php | 11 +- .../Form/Contribution/OnBehalfOf.php | 11 +- CRM/Contribute/Form/Contribution/ThankYou.php | 4 +- CRM/Contribute/Form/ContributionBase.php | 6 +- CRM/Contribute/Form/ContributionCharts.php | 2 +- CRM/Contribute/Form/ContributionPage.php | 6 +- .../Form/ContributionPage/AddProduct.php | 6 +- .../Form/ContributionPage/Amount.php | 5 +- .../Form/ContributionPage/Custom.php | 4 +- .../Form/ContributionPage/Delete.php | 4 +- .../Form/ContributionPage/Premium.php | 6 +- .../Form/ContributionPage/Settings.php | 6 +- .../Form/ContributionPage/TabHeader.php | 4 +- .../Form/ContributionPage/ThankYou.php | 4 +- .../Form/ContributionPage/Widget.php | 4 +- CRM/Contribute/Form/ContributionView.php | 4 +- CRM/Contribute/Form/ManagePremiums.php | 8 +- CRM/Contribute/Form/Search.php | 2 +- CRM/Contribute/Form/SearchContribution.php | 2 +- CRM/Contribute/Form/SoftCredit.php | 4 +- CRM/Contribute/Form/Task.php | 6 +- CRM/Contribute/Form/Task/Batch.php | 5 +- CRM/Contribute/Form/Task/Delete.php | 2 +- CRM/Contribute/Form/Task/Email.php | 2 +- CRM/Contribute/Form/Task/Invoice.php | 8 +- CRM/Contribute/Form/Task/PDF.php | 4 +- CRM/Contribute/Form/Task/PDFLetter.php | 2 +- CRM/Contribute/Form/Task/PDFLetterCommon.php | 2 - CRM/Contribute/Form/Task/PickProfile.php | 3 +- CRM/Contribute/Form/Task/Print.php | 2 +- CRM/Contribute/Form/Task/Result.php | 2 +- .../Form/Task/SearchTaskHookSample.php | 2 +- CRM/Contribute/Form/Task/Status.php | 2 +- CRM/Contribute/Form/UpdateBilling.php | 5 +- CRM/Contribute/Form/UpdateSubscription.php | 4 +- CRM/Contribute/Import/Form/DataSource.php | 4 +- CRM/Contribute/Import/Form/MapField.php | 4 +- CRM/Contribute/Import/Form/Preview.php | 2 +- CRM/Contribute/Import/Form/Summary.php | 2 +- CRM/Contribute/Import/Parser.php | 36 +-- CRM/Contribute/Import/Parser/Contribution.php | 2 +- CRM/Contribute/Page/ContributionPage.php | 2 +- CRM/Contribute/Page/Premium.php | 1 - CRM/Contribute/Page/Tab.php | 2 - CRM/Contribute/Selector/Search.php | 7 +- CRM/Contribute/StateMachine/Contribution.php | 5 +- .../StateMachine/ContributionPage.php | 7 +- CRM/Core/Action.php | 13 +- CRM/Core/BAO/ActionLog.php | 2 +- CRM/Core/BAO/ActionSchedule.php | 8 +- CRM/Core/BAO/Address.php | 9 +- CRM/Core/BAO/Block.php | 16 +- CRM/Core/BAO/CMSUser.php | 30 +-- CRM/Core/BAO/ConfigSetting.php | 18 +- CRM/Core/BAO/CustomField.php | 53 ++--- CRM/Core/BAO/CustomGroup.php | 35 ++- CRM/Core/BAO/CustomOption.php | 15 +- CRM/Core/BAO/CustomValue.php | 2 +- CRM/Core/BAO/CustomValueTable.php | 12 +- CRM/Core/BAO/Dashboard.php | 12 +- CRM/Core/BAO/Discount.php | 17 +- CRM/Core/BAO/Domain.php | 32 ++- CRM/Core/BAO/Email.php | 2 +- CRM/Core/BAO/EntityTag.php | 32 ++- CRM/Core/BAO/Extension.php | 10 +- CRM/Core/BAO/File.php | 10 +- CRM/Core/BAO/FinancialTrxn.php | 47 ++-- CRM/Core/BAO/Job.php | 14 +- CRM/Core/BAO/LabelFormat.php | 6 +- CRM/Core/BAO/Location.php | 22 +- CRM/Core/BAO/LocationType.php | 14 +- CRM/Core/BAO/Log.php | 6 +- CRM/Core/BAO/MailSettings.php | 8 +- CRM/Core/BAO/Mapping.php | 101 +++------ CRM/Core/BAO/MessageTemplate.php | 14 +- CRM/Core/BAO/Navigation.php | 14 +- CRM/Core/BAO/Note.php | 16 +- CRM/Core/BAO/OptionGroup.php | 14 +- CRM/Core/BAO/OptionValue.php | 21 +- CRM/Core/BAO/PaperSize.php | 4 +- CRM/Core/BAO/PdfFormat.php | 4 +- CRM/Core/BAO/Persistent.php | 10 +- CRM/Core/BAO/Phone.php | 5 +- CRM/Core/BAO/Preferences.php | 6 +- CRM/Core/BAO/PreferencesDate.php | 10 +- CRM/Core/BAO/PrevNextCache.php | 29 ++- CRM/Core/BAO/RecurringEntity.php | 14 +- CRM/Core/BAO/SchemaHandler.php | 29 +-- CRM/Core/BAO/Setting.php | 42 +--- CRM/Core/BAO/Tag.php | 12 +- CRM/Core/BAO/UFField.php | 56 ++--- CRM/Core/BAO/UFGroup.php | 105 +++------ CRM/Core/BAO/UFJoin.php | 6 +- CRM/Core/BAO/UFMatch.php | 6 +- CRM/Core/BAO/Website.php | 4 +- CRM/Core/BAO/WordReplacement.php | 6 +- CRM/Core/Block.php | 16 +- CRM/Core/Component.php | 14 +- CRM/Core/Component/Info.php | 80 +++---- CRM/Core/Config.php | 2 +- CRM/Core/Config/Defaults.php | 4 +- CRM/Core/Controller.php | 37 ++- CRM/Core/Controller/Simple.php | 8 +- CRM/Core/DAO.php | 66 ++---- CRM/Core/Error.php | 30 +-- CRM/Core/Form.php | 32 ++- CRM/Core/Form/Date.php | 7 +- CRM/Core/Form/RecurringEntity.php | 5 +- CRM/Core/Form/Tag.php | 7 +- CRM/Core/I18n/Schema.php | 2 +- CRM/Core/IDS.php | 4 +- CRM/Core/JobManager.php | 2 +- CRM/Core/Key.php | 15 +- CRM/Core/Lock.php | 3 - CRM/Core/Menu.php | 1 - CRM/Core/OptionGroup.php | 8 +- CRM/Core/OptionValue.php | 13 +- CRM/Core/Page.php | 9 +- CRM/Core/Page/AJAX.php | 4 +- CRM/Core/Page/AJAX/Location.php | 2 +- CRM/Core/Page/Basic.php | 4 +- CRM/Core/Payment.php | 6 +- CRM/Core/Payment/AuthorizeNet.php | 11 +- CRM/Core/Payment/BaseIPN.php | 27 +-- CRM/Core/Payment/Form.php | 8 +- CRM/Core/Payment/Google.php | 5 +- CRM/Core/Payment/GoogleIPN.php | 2 - CRM/Core/Payment/PayPalIPN.php | 2 - CRM/Core/Payment/PayPalImpl.php | 14 +- CRM/Core/Payment/PayflowPro.php | 2 +- CRM/Core/Payment/PaymentExpress.php | 4 +- CRM/Core/Payment/ProcessorForm.php | 2 +- CRM/Core/Payment/Realex.php | 6 +- CRM/Core/Permission.php | 2 +- CRM/Core/PseudoConstant.php | 24 +- CRM/Core/QuickForm/Action/Back.php | 4 +- CRM/Core/QuickForm/Action/Cancel.php | 2 +- CRM/Core/QuickForm/Action/Display.php | 12 +- CRM/Core/QuickForm/Action/Done.php | 2 +- CRM/Core/QuickForm/Action/Jump.php | 2 +- CRM/Core/QuickForm/Action/Next.php | 2 +- CRM/Core/QuickForm/Action/Process.php | 2 +- CRM/Core/QuickForm/Action/Reload.php | 2 +- CRM/Core/QuickForm/Action/Submit.php | 2 +- CRM/Core/QuickForm/Action/Upload.php | 4 +- CRM/Core/ScheduledJob.php | 10 +- CRM/Core/SelectValues.php | 6 +- CRM/Core/Selector/Controller.php | 65 +++--- CRM/Core/Smarty/plugins/function.crmDBTpl.php | 2 +- .../Smarty/plugins/modifier.crmBtnType.php | 4 +- .../Smarty/plugins/modifier.crmFirstWord.php | 10 +- CRM/Core/State.php | 26 +-- CRM/Core/StateMachine.php | 2 +- CRM/Custom/Form/ChangeFieldType.php | 2 +- CRM/Custom/Form/CustomData.php | 2 +- CRM/Custom/Form/DeleteField.php | 2 +- CRM/Custom/Form/DeleteGroup.php | 2 +- CRM/Custom/Form/Field.php | 6 +- CRM/Custom/Form/Group.php | 22 +- CRM/Custom/Form/MoveField.php | 2 +- CRM/Custom/Form/Option.php | 8 +- CRM/Custom/Form/Preview.php | 2 +- CRM/Custom/Import/Form/DataSource.php | 4 +- CRM/Custom/Import/Form/MapField.php | 4 +- CRM/Custom/Import/Form/Preview.php | 2 +- CRM/Custom/Import/Form/Summary.php | 2 +- CRM/Custom/Import/Parser.php | 2 +- CRM/Custom/Import/Parser/Api.php | 1 - CRM/Dedupe/BAO/RuleGroup.php | 7 +- CRM/Dedupe/Finder.php | 3 +- CRM/Dedupe/Merger.php | 11 +- CRM/Event/BAO/Event.php | 57 ++--- CRM/Event/BAO/Participant.php | 39 +--- CRM/Event/BAO/ParticipantStatusType.php | 8 +- CRM/Event/Badge.php | 9 +- CRM/Event/Cart/BAO/Cart.php | 8 +- CRM/Event/Cart/BAO/EventInCart.php | 6 +- CRM/Event/Cart/BAO/MerParticipant.php | 2 +- CRM/Event/Cart/Form/Cart.php | 3 +- CRM/Event/Cart/Form/Checkout/Payment.php | 8 +- CRM/Event/Cart/Form/MerParticipant.php | 2 +- CRM/Event/Form/EventFees.php | 10 +- CRM/Event/Form/ManageEvent.php | 6 +- CRM/Event/Form/ManageEvent/Conference.php | 4 +- CRM/Event/Form/ManageEvent/Delete.php | 4 +- CRM/Event/Form/ManageEvent/EventInfo.php | 28 +-- CRM/Event/Form/ManageEvent/Fee.php | 6 +- CRM/Event/Form/ManageEvent/Location.php | 7 +- CRM/Event/Form/ManageEvent/Registration.php | 32 +-- CRM/Event/Form/ManageEvent/Repeat.php | 2 +- .../Form/ManageEvent/ScheduleReminders.php | 9 +- CRM/Event/Form/ManageEvent/TabHeader.php | 4 +- CRM/Event/Form/Participant.php | 23 +- CRM/Event/Form/ParticipantFeeSelection.php | 2 +- CRM/Event/Form/ParticipantView.php | 4 +- CRM/Event/Form/Registration.php | 18 +- .../Registration/AdditionalParticipant.php | 15 +- CRM/Event/Form/Registration/Confirm.php | 21 +- .../Form/Registration/ParticipantConfirm.php | 6 +- CRM/Event/Form/Registration/Register.php | 18 +- CRM/Event/Form/Registration/ThankYou.php | 7 +- CRM/Event/Form/Search.php | 2 +- CRM/Event/Form/SearchEvent.php | 2 +- CRM/Event/Form/Task.php | 4 +- CRM/Event/Form/Task/AddToGroup.php | 7 +- CRM/Event/Form/Task/Badge.php | 2 +- CRM/Event/Form/Task/Batch.php | 5 +- CRM/Event/Form/Task/Cancel.php | 7 +- CRM/Event/Form/Task/Delete.php | 2 +- CRM/Event/Form/Task/Email.php | 2 +- CRM/Event/Form/Task/PickProfile.php | 7 +- CRM/Event/Form/Task/Print.php | 2 +- CRM/Event/Form/Task/SaveSearch.php | 2 +- CRM/Event/Form/Task/SaveSearch/Update.php | 2 +- CRM/Event/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Event/Import/Form/DataSource.php | 4 +- CRM/Event/Import/Form/MapField.php | 4 +- CRM/Event/Import/Form/Preview.php | 2 +- CRM/Event/Import/Form/Summary.php | 2 +- CRM/Event/Import/Parser.php | 7 +- CRM/Event/Page/AJAX.php | 2 +- CRM/Event/Page/ManageEvent.php | 2 +- CRM/Event/Page/UserDashboard.php | 2 +- CRM/Event/PseudoConstant.php | 4 +- CRM/Event/Selector/Search.php | 12 +- CRM/Event/StateMachine/Registration.php | 1 - CRM/Export/BAO/Export.php | 6 +- CRM/Export/Form/Map.php | 2 +- CRM/Export/Form/Select.php | 6 +- CRM/Extension/Container/Basic.php | 1 - CRM/Extension/Info.php | 1 - CRM/Extension/Manager/Payment.php | 2 +- CRM/Extension/Mapper.php | 4 +- CRM/Financial/BAO/FinancialAccount.php | 12 +- CRM/Financial/BAO/FinancialItem.php | 19 +- CRM/Financial/BAO/FinancialType.php | 15 +- CRM/Financial/BAO/FinancialTypeAccount.php | 21 +- CRM/Financial/BAO/PaymentProcessor.php | 22 +- CRM/Financial/BAO/PaymentProcessorType.php | 16 +- CRM/Financial/Form/BatchTransaction.php | 2 +- CRM/Financial/Form/Export.php | 2 +- CRM/Financial/Form/FinancialAccount.php | 8 +- CRM/Financial/Form/FinancialBatch.php | 14 +- CRM/Financial/Form/FinancialType.php | 4 +- CRM/Financial/Form/FinancialTypeAccount.php | 6 +- CRM/Financial/Page/AJAX.php | 2 +- CRM/Financial/Page/Batch.php | 2 - CRM/Friend/BAO/Friend.php | 17 +- CRM/Friend/Form.php | 12 +- CRM/Friend/Form/Contribute.php | 6 +- CRM/Friend/Form/Event.php | 6 +- CRM/Grant/BAO/Grant.php | 21 +- CRM/Grant/BAO/Query.php | 2 +- CRM/Grant/Form/Grant.php | 6 +- CRM/Grant/Form/GrantView.php | 4 +- CRM/Grant/Form/Search.php | 2 +- CRM/Grant/Form/Task.php | 4 +- CRM/Grant/Form/Task/Delete.php | 2 +- CRM/Grant/Form/Task/Print.php | 2 +- CRM/Grant/Form/Task/Result.php | 2 +- CRM/Grant/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Grant/Form/Task/Update.php | 2 +- CRM/Grant/Selector/Search.php | 7 +- CRM/Group/Form/Edit.php | 53 ++--- CRM/Group/Page/Group.php | 6 +- CRM/Import/DataSource.php | 6 +- CRM/Import/DataSource/CSV.php | 6 +- CRM/Import/DataSource/SQL.php | 8 +- CRM/Import/Form/Preview.php | 2 +- CRM/Import/Form/Summary.php | 2 +- CRM/Import/StateMachine.php | 1 - CRM/Logging/Differ.php | 2 +- CRM/Mailing/BAO/Component.php | 10 +- CRM/Mailing/BAO/Mailing.php | 18 +- CRM/Mailing/BAO/MailingJob.php | 2 +- CRM/Mailing/Event/BAO/Opened.php | 2 - CRM/Mailing/Event/BAO/Queue.php | 2 +- CRM/Mailing/Event/BAO/Subscribe.php | 33 +-- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 2 - CRM/Mailing/Form/Approve.php | 6 +- CRM/Mailing/Form/Browse.php | 6 +- CRM/Mailing/Form/Component.php | 9 +- CRM/Mailing/Form/ForwardMailing.php | 2 +- CRM/Mailing/Form/Group.php | 6 +- CRM/Mailing/Form/Schedule.php | 6 +- CRM/Mailing/Form/Settings.php | 6 +- CRM/Mailing/Form/Subscribe.php | 3 +- CRM/Mailing/Form/Task.php | 3 +- CRM/Mailing/Form/Task/Print.php | 2 +- CRM/Mailing/Form/Test.php | 7 +- CRM/Mailing/Form/Upload.php | 6 +- CRM/Mailing/Page/AJAX.php | 4 +- CRM/Mailing/Page/Browse.php | 2 +- CRM/Mailing/Selector/Browse.php | 10 +- CRM/Mailing/Selector/Event.php | 7 +- CRM/Mailing/Selector/Search.php | 7 +- CRM/Mailing/StateMachine/Send.php | 3 +- CRM/Member/BAO/Membership.php | 73 ++---- CRM/Member/BAO/MembershipBlock.php | 4 +- CRM/Member/BAO/MembershipLog.php | 7 +- CRM/Member/BAO/MembershipPayment.php | 4 +- CRM/Member/BAO/MembershipStatus.php | 20 +- CRM/Member/BAO/MembershipType.php | 21 +- CRM/Member/BAO/Query.php | 2 +- CRM/Member/Form.php | 6 +- CRM/Member/Form/Membership.php | 15 +- CRM/Member/Form/MembershipBlock.php | 6 +- CRM/Member/Form/MembershipConfig.php | 4 +- CRM/Member/Form/MembershipRenewal.php | 8 +- CRM/Member/Form/MembershipStatus.php | 6 +- CRM/Member/Form/MembershipType.php | 8 +- CRM/Member/Form/MembershipView.php | 4 +- CRM/Member/Form/Search.php | 2 +- CRM/Member/Form/Task.php | 4 +- CRM/Member/Form/Task/Batch.php | 5 +- CRM/Member/Form/Task/Delete.php | 2 +- CRM/Member/Form/Task/Email.php | 2 +- CRM/Member/Form/Task/Label.php | 4 +- CRM/Member/Form/Task/PDFLetter.php | 2 +- CRM/Member/Form/Task/PDFLetterCommon.php | 3 +- CRM/Member/Form/Task/PickProfile.php | 7 +- CRM/Member/Form/Task/Print.php | 2 +- CRM/Member/Form/Task/Result.php | 2 +- CRM/Member/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Member/Import/Form/DataSource.php | 4 +- CRM/Member/Import/Form/MapField.php | 4 +- CRM/Member/Import/Form/Preview.php | 2 +- CRM/Member/Import/Form/Summary.php | 2 +- CRM/Member/Import/Parser.php | 7 +- CRM/Member/Import/Parser/Membership.php | 1 - CRM/Member/Page/AJAX.php | 2 +- CRM/Member/Page/DashBoard.php | 2 - CRM/Member/Page/Tab.php | 4 +- CRM/Member/Page/UserDashboard.php | 2 +- CRM/Member/Selector/Search.php | 8 +- CRM/Note/Form/Note.php | 5 +- CRM/PCP/BAO/PCP.php | 36 +-- CRM/PCP/Form/Campaign.php | 5 +- CRM/PCP/Form/Contribute.php | 8 +- CRM/PCP/Form/Event.php | 8 +- CRM/PCP/Form/PCP.php | 8 +- CRM/PCP/Form/PCPAccount.php | 5 +- CRM/Pledge/BAO/Pledge.php | 20 +- CRM/Pledge/BAO/PledgeBlock.php | 16 +- CRM/Pledge/BAO/PledgePayment.php | 17 +- CRM/Pledge/BAO/Query.php | 2 +- CRM/Pledge/Form/Payment.php | 8 +- CRM/Pledge/Form/Pledge.php | 9 +- CRM/Pledge/Form/PledgeView.php | 4 +- CRM/Pledge/Form/Search.php | 4 +- CRM/Pledge/Form/Task.php | 3 +- CRM/Pledge/Form/Task/Delete.php | 2 +- CRM/Pledge/Form/Task/Print.php | 2 +- CRM/Pledge/Form/Task/Result.php | 2 +- CRM/Pledge/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Pledge/Page/AJAX.php | 2 +- CRM/Pledge/Selector/Search.php | 8 +- CRM/Price/BAO/LineItem.php | 10 +- CRM/Price/BAO/PriceField.php | 16 +- CRM/Price/BAO/PriceFieldValue.php | 6 +- CRM/Price/BAO/PriceSet.php | 30 +-- CRM/Price/Form/DeleteField.php | 2 +- CRM/Price/Form/DeleteSet.php | 2 +- CRM/Price/Form/Field.php | 8 +- CRM/Price/Form/Option.php | 8 +- CRM/Price/Form/Preview.php | 2 +- CRM/Price/Form/Set.php | 6 +- CRM/Price/Page/Set.php | 7 +- CRM/Profile/Form.php | 22 +- CRM/Profile/Form/Dynamic.php | 5 +- CRM/Profile/Form/Edit.php | 4 +- CRM/Profile/Form/Search.php | 2 +- CRM/Profile/Page/Listings.php | 4 +- CRM/Profile/Selector/Listings.php | 9 +- CRM/Queue/Queue/Memory.php | 4 +- CRM/Queue/Queue/Sql.php | 4 +- CRM/Queue/Runner.php | 2 - CRM/Queue/Service.php | 3 - CRM/Queue/Task.php | 7 +- CRM/Report/BAO/ReportInstance.php | 8 +- CRM/Report/Form.php | 7 +- CRM/Report/Form/Case/Demographics.php | 1 - CRM/Report/Form/Case/TimeSpent.php | 1 - CRM/Report/Form/Extended.php | 2 +- CRM/Report/Form/Instance.php | 6 +- CRM/Report/Form/Register.php | 3 +- CRM/Report/Page/Options.php | 2 +- CRM/Report/Utils/Report.php | 10 +- CRM/SMS/Form/Group.php | 6 +- CRM/SMS/Form/Provider.php | 4 +- CRM/SMS/Form/Schedule.php | 6 +- CRM/SMS/Form/Upload.php | 6 +- CRM/SMS/Provider.php | 8 +- CRM/Tag/Form/Tag.php | 4 +- CRM/UF/Form/AbstractPreview.php | 2 +- CRM/UF/Form/AdvanceSetting.php | 4 +- CRM/UF/Form/Field.php | 5 +- CRM/UF/Form/Group.php | 6 +- CRM/UF/Form/Preview.php | 2 +- CRM/UF/Page/Field.php | 6 +- CRM/UF/Page/ProfileEditor.php | 2 - CRM/Upgrade/Form.php | 3 - CRM/Upgrade/Incremental/php/FourFive.php | 3 +- CRM/Upgrade/Incremental/php/FourFour.php | 1 - CRM/Upgrade/Incremental/php/FourOne.php | 2 +- CRM/Upgrade/Incremental/php/FourSix.php | 1 - CRM/Upgrade/Incremental/php/FourThree.php | 1 - CRM/Upgrade/Incremental/php/FourTwo.php | 3 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 32 +-- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 6 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 34 ++- CRM/Utils/API/MatchOption.php | 3 +- CRM/Utils/Address/BatchUpdate.php | 2 +- CRM/Utils/Date.php | 10 +- CRM/Utils/DeprecatedUtils.php | 12 +- CRM/Utils/File.php | 4 +- CRM/Utils/Geocode/Google.php | 4 +- CRM/Utils/Hook.php | 13 +- CRM/Utils/Hook/DrupalBase.php | 1 - CRM/Utils/HttpClient.php | 3 +- CRM/Utils/ICalendar.php | 11 +- CRM/Utils/JSON.php | 4 +- CRM/Utils/Mail.php | 1 - CRM/Utils/Mail/EmailProcessor.php | 2 +- CRM/Utils/Mail/Incoming.php | 4 +- CRM/Utils/Migrate/Export.php | 3 +- CRM/Utils/Migrate/ExportJSON.php | 4 +- CRM/Utils/Migrate/Import.php | 2 +- CRM/Utils/Migrate/ImportJSON.php | 2 +- CRM/Utils/OpenFlashChart.php | 2 +- CRM/Utils/PDF/Label.php | 6 +- CRM/Utils/PDF/Utils.php | 9 +- CRM/Utils/Pager.php | 4 +- CRM/Utils/PagerAToZ.php | 4 +- CRM/Utils/PseudoConstant.php | 3 +- CRM/Utils/REST.php | 4 +- CRM/Utils/ReCAPTCHA.php | 2 +- CRM/Utils/Recent.php | 2 - CRM/Utils/Request.php | 1 - CRM/Utils/SoapServer.php | 2 +- CRM/Utils/String.php | 4 +- CRM/Utils/System.php | 13 +- CRM/Utils/System/Drupal.php | 23 +- CRM/Utils/System/Drupal6.php | 16 +- CRM/Utils/System/Drupal8.php | 6 +- CRM/Utils/System/Joomla.php | 18 +- CRM/Utils/System/Soap.php | 2 +- CRM/Utils/System/WordPress.php | 6 +- CRM/Utils/Token.php | 19 +- CRM/Utils/Tree.php | 4 +- CRM/Utils/Weight.php | 6 +- CRM/Utils/XML.php | 3 +- Civi/API/Kernel.php | 1 - Civi/Core/Transaction/Manager.php | 1 - api/api.php | 4 +- api/class.api.php | 21 +- api/v3/Acl.php | 6 +- api/v3/AclRole.php | 6 +- api/v3/Activity.php | 4 +- api/v3/ActivityContact.php | 2 +- api/v3/ActivityType.php | 8 +- api/v3/Address.php | 8 +- api/v3/Batch.php | 6 +- api/v3/Case.php | 6 +- api/v3/CaseType.php | 8 +- api/v3/Constant.php | 2 +- api/v3/Contact.php | 10 +- api/v3/Contribution.php | 8 +- api/v3/CustomField.php | 31 +-- api/v3/CustomSearch.php | 6 +- api/v3/DashboardContact.php | 2 +- api/v3/Email.php | 2 +- api/v3/Event.php | 3 +- api/v3/Extension.php | 8 +- api/v3/File.php | 2 +- api/v3/FinancialAccount.php | 6 +- api/v3/FinancialType.php | 6 +- api/v3/Generic.php | 2 +- api/v3/Im.php | 2 +- api/v3/Job.php | 2 +- api/v3/Location.php | 4 +- api/v3/LocationType.php | 2 +- api/v3/MailingComponent.php | 6 +- api/v3/MailingGroup.php | 2 +- api/v3/MembershipStatus.php | 2 - api/v3/MessageTemplate.php | 2 +- api/v3/Note.php | 4 +- api/v3/OptionGroup.php | 2 +- api/v3/OptionValue.php | 6 +- api/v3/ParticipantPayment.php | 4 +- api/v3/PaymentProcessor.php | 2 +- api/v3/PaymentProcessorType.php | 4 +- api/v3/Phone.php | 2 +- api/v3/Pledge.php | 6 +- api/v3/PledgePayment.php | 2 +- api/v3/Premium.php | 6 +- api/v3/PrintLabel.php | 6 +- api/v3/Product.php | 6 +- api/v3/Profile.php | 6 +- api/v3/Relationship.php | 2 +- api/v3/RelationshipType.php | 4 +- api/v3/ReportInstance.php | 2 +- api/v3/ReportTemplate.php | 10 +- api/v3/SmsProvider.php | 6 +- api/v3/System.php | 4 +- api/v3/SystemLog.php | 8 +- api/v3/Tag.php | 2 +- api/v3/UFField.php | 8 +- api/v3/UFGroup.php | 5 +- api/v3/Website.php | 2 +- api/v3/utils.php | 26 +-- bin/cli.class.php | 4 +- .../main.php | 2 +- .../phpunit/CRM/Activity/BAO/ActivityTest.php | 6 +- tests/phpunit/CRM/Contact/BAO/ContactTest.php | 2 +- .../BAO/ContactType/ContactSearchTest.php | 76 +++---- .../BAO/ContactType/ContactTypeTest.php | 42 ++-- .../CRM/Contact/BAO/GroupContactCacheTest.php | 2 +- .../CRM/Core/BAO/ActionScheduleTest.php | 2 +- .../phpunit/CRM/Core/BAO/CustomFieldTest.php | 1 - .../phpunit/CRM/Core/BAO/CustomGroupTest.php | 6 +- .../Core/BAO/CustomValueTableSetGetTest.php | 15 +- .../CRM/Core/BAO/CustomValueTableTest.php | 49 ++-- .../phpunit/CRM/Core/Payment/BaseIPNTest.php | 47 ++-- tests/phpunit/CRM/Core/TransactionTest.php | 3 - .../phpunit/CRM/Member/BAO/MembershipTest.php | 64 +++--- tests/phpunit/CRM/PCP/BAO/PCPTest.php | 4 +- .../CRM/Utils/Migrate/ImportExportTest.php | 3 - tests/phpunit/CiviTest/AuthorizeNet.php | 23 +- tests/phpunit/CiviTest/CiviDBAssert.php | 2 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 45 ++-- tests/phpunit/CiviTest/CiviUnitTestCase.php | 74 +++--- tests/phpunit/CiviTest/Contact.php | 2 +- tests/phpunit/CiviTest/Custom.php | 2 +- tests/phpunit/CiviTest/Event.php | 3 +- tests/phpunit/CiviTest/Participant.php | 3 +- .../WebTest/Contact/AdvanceSearchPaneTest.php | 4 +- .../Contact/SearchbyDateFilterTest.php | 2 +- .../Contribute/OfflineContributionTest.php | 2 +- .../phpunit/WebTest/Event/AddPricesetTest.php | 2 +- .../WebTest/Event/ParticipantCountTest.php | 2 +- .../WebTest/Event/PricesetMaxCountTest.php | 2 +- .../Export/ExportCiviSeleniumTestCase.php | 27 +-- .../WebTest/Import/AddressImportTest.php | 128 +++++------ .../WebTest/Import/AddressParsingTest.php | 26 +-- .../WebTest/Import/ContactCustomDataTest.php | 5 +- .../phpunit/WebTest/Import/CustomDataTest.php | 16 +- tests/phpunit/WebTest/Import/GroupTest.php | 11 +- .../Import/ImportCiviSeleniumTestCase.php | 169 +++++--------- .../WebTest/Import/MatchExternalIdTest.php | 58 ++--- tests/phpunit/WebTest/Import/MemberTest.php | 33 ++- .../WebTest/Import/ParticipantTest.php | 48 ++-- .../WebTest/Import/SavedMappingTest.php | 11 +- tests/phpunit/WebTest/Import/TagTest.php | 11 +- tests/phpunit/api/v3/APIStandardsTest.php | 29 +-- tests/phpunit/api/v3/AddressTest.php | 21 +- tests/phpunit/api/v3/ContactTest.php | 30 +-- tests/phpunit/api/v3/ContactTypeTest.php | 42 ++-- tests/phpunit/api/v3/ContributionTest.php | 24 +- tests/phpunit/api/v3/CustomFieldTest.php | 2 +- tests/phpunit/api/v3/CustomGroupTest.php | 8 +- tests/phpunit/api/v3/EventTest.php | 40 ++-- tests/phpunit/api/v3/GroupContactTest.php | 10 +- tests/phpunit/api/v3/JobTest.php | 2 +- tests/phpunit/api/v3/MailingContactTest.php | 211 +++++++++--------- tests/phpunit/api/v3/MembershipStatusTest.php | 7 +- tests/phpunit/api/v3/OptionValueTest.php | 44 ++-- .../phpunit/api/v3/ParticipantPaymentTest.php | 2 +- tests/phpunit/api/v3/ParticipantTest.php | 39 ++-- tests/phpunit/api/v3/PledgePaymentTest.php | 38 ++-- tests/phpunit/api/v3/PledgeTest.php | 58 ++--- tests/phpunit/api/v3/ProfileTest.php | 42 ++-- tests/phpunit/api/v3/SettingTest.php | 175 +++++++-------- .../phpunit/api/v3/SyntaxConformanceTest.php | 7 +- .../api/v3/TaxContributionPageTest.php | 4 +- tests/phpunit/api/v3/UtilsTest.php | 23 +- .../api/v3/Contact/ExampleAction2.php | 2 +- .../v3/dataset/resolver/api/v3/TestEntity.php | 2 +- tools/CRM/Auction/BAO/Auction.php | 14 +- tools/CRM/Auction/BAO/Item.php | 14 +- tools/CRM/Auction/Form/Auction.php | 9 +- tools/CRM/Auction/Form/Item.php | 9 +- tools/CRM/Auction/Form/ItemAccount.php | 5 +- tools/CRM/Auction/Form/SearchAuction.php | 2 +- tools/CRM/Auction/Form/SearchItem.php | 2 +- tools/CRM/Auction/Page/Item.php | 2 +- tools/CRM/Auction/Page/Manage.php | 2 +- tools/CRM/Auction/Page/ManageItem.php | 2 +- .../api/v3/MultisiteDomain/Create.php | 2 +- .../GoogleIPN.php | 3 - .../ActivitySearch.php | 13 +- .../org.civicrm.search.basic/Basic.php | 2 +- .../MultiValue.php | 2 +- tools/scripts/solr/createSyncJSON.php | 2 +- xml/plugins/block.ts.php | 2 +- 870 files changed, 3349 insertions(+), 4888 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 62a20c4241..78c044c93e 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -92,14 +92,13 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { /** * Construct a WHERE clause to handle permissions to $object_* * - * @param $tables + * @param array $tables - Any tables that may be needed in the FROM * @param string $operation - The operation being attempted * @param string $object_table - The table of the object in question * @param int $object_id - The ID of the object in question * @param int $acl_id - If it's a grant/revoke operation, the ACL ID * @param boolean $acl_role - For grant operations, this flag determines if we're granting a single acl (false) or an entire group. * - * @internal param \ref $array $tables - Any tables that may be needed in the FROM * @return string - The WHERE clause, or 0 on failure * @access public * @static @@ -330,9 +329,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * * @param string $table - The table owning the object * @param int $id - The ID of the object - * @param $tables - * - * @internal param \ref $array $tables - Tables that will be needed in the FROM + * @param array $tables - Tables that will be needed in the FROM * * @return string|null - WHERE-style clause to filter results, * or null if $table or $id is null @@ -657,7 +654,7 @@ SELECT $acl.* } /** - * @param $params + * @param array $params * * @return CRM_ACL_DAO_ACL */ @@ -669,7 +666,7 @@ SELECT $acl.* } /** - * @param $params + * @param array $params * @param $defaults */ static function retrieve(&$params, &$defaults) { @@ -734,7 +731,6 @@ SELECT count( a.id ) */ public static function whereClause($type, &$tables, &$whereTables, $contactID = NULL) { $acls = CRM_ACL_BAO_Cache::build($contactID); - //CRM_Core_Error::debug( "a: $contactID", $acls ); $whereClause = NULL; $clauses = array(); @@ -850,7 +846,7 @@ SELECT g.* } /** - * @param $type + * @param int $type * @param null $contactID * @param string $tableName * @param null $allGroups @@ -921,7 +917,7 @@ ORDER BY a.object_id } /** - * @param $type + * @param int $type * @param $operation * * @return bool @@ -967,7 +963,7 @@ ORDER BY a.object_id } /** - * Function to delete ACL records + * delete ACL records * * @param int $aclId ID of the ACL record to be deleted. * diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index 98f6ccc25d..261c65b7dc 100644 --- a/CRM/ACL/BAO/EntityRole.php +++ b/CRM/ACL/BAO/EntityRole.php @@ -53,7 +53,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * @param $params + * @param array $params * * @return CRM_ACL_DAO_EntityRole */ @@ -65,7 +65,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * @param $params + * @param array $params * @param $defaults */ static function retrieve(&$params, &$defaults) { @@ -86,7 +86,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * Function to delete Entity Role records + * delete Entity Role records * * @param int $entityRoleId ID of the EntityRole record to be deleted. * diff --git a/CRM/ACL/Form/ACL.php b/CRM/ACL/Form/ACL.php index a787abe90c..d475bd6211 100644 --- a/CRM/ACL/Form/ACL.php +++ b/CRM/ACL/Form/ACL.php @@ -43,7 +43,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -113,7 +113,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -138,7 +138,8 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { $operations, TRUE ); - $objTypes = array('1' => ts('A group of contacts'), + $objTypes = array( + '1' => ts('A group of contacts'), '2' => ts('A profile'), '3' => ts('A set of custom data fields'), ); @@ -157,24 +158,29 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { $label = ts('Role'); - $role = array('-1' => ts('- select role -'), + $role = array( + '-1' => ts('- select role -'), '0' => ts('Everyone'), ) + CRM_Core_OptionGroup::values('acl_role'); $this->add('select', 'entity_id', $label, $role, TRUE); - $group = array('-1' => ts('- select -'), + $group = array( + '-1' => ts('- select -'), '0' => ts('All Groups'), ) + CRM_Core_PseudoConstant::group(); - $customGroup = array('-1' => ts('- select -'), + $customGroup = array( + '-1' => ts('- select -'), '0' => ts('All Custom Groups'), ) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id'); - $ufGroup = array('-1' => ts('- select -'), + $ufGroup = array( + '-1' => ts('- select -'), '0' => ts('All Profiles'), ) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id'); - $event = array('-1' => ts('- select -'), + $event = array( + '-1' => ts('- select -'), '0' => ts('All Events'), ) + CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )"); @@ -189,7 +195,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { } /** - * @param $params + * @param array $params * * @return bool */ @@ -262,7 +268,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/ACL/Form/ACLBasic.php b/CRM/ACL/Form/ACLBasic.php index 5da5e3f7ff..2963421295 100644 --- a/CRM/ACL/Form/ACLBasic.php +++ b/CRM/ACL/Form/ACLBasic.php @@ -43,7 +43,7 @@ class CRM_ACL_Form_ACLBasic extends CRM_Admin_Form { /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -75,7 +75,7 @@ SELECT object_table } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -111,7 +111,7 @@ SELECT object_table } /** - * @param $params + * @param array $params * * @return array|bool */ @@ -125,7 +125,7 @@ SELECT object_table } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/ACL/Form/EntityRole.php b/CRM/ACL/Form/EntityRole.php index 23098448c2..846edfadba 100644 --- a/CRM/ACL/Form/EntityRole.php +++ b/CRM/ACL/Form/EntityRole.php @@ -43,7 +43,7 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -72,7 +72,7 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/ACL/Form/WordPress/Permissions.php b/CRM/ACL/Form/WordPress/Permissions.php index 1f38776ffd..989134fe62 100644 --- a/CRM/ACL/Form/WordPress/Permissions.php +++ b/CRM/ACL/Form/WordPress/Permissions.php @@ -40,7 +40,7 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { /** - * Function to build the form + * Build the form object * * @access public * @return void @@ -99,7 +99,7 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @return void diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index f4863410ba..c22465c295 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -71,18 +71,12 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @internal param string $activityType activity type - * - * @return object CRM_Core_BAO_Meeting object + * @return CRM_Core_BAO_Meeting object * @access public */ public static function retrieve(&$params, &$defaults) { @@ -146,10 +140,9 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * Function to delete the activity + * delete the activity * * @param array $params associated array - * * @param bool $moveToTrash * * @return void @@ -256,11 +249,9 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * Delete activity assignment record * - * @param $activityId + * @param int $activityId * @param null $recordTypeID * - * @internal param int $id activity id - * * @return null * @access public */ @@ -274,15 +265,11 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * Function to process the activities + * process the activities * * @param array $params associated array of the submitted values * * @throws CRM_Core_Exception - * @internal param object $form form object - * @internal param array $ids array of ids - * @internal param string $activityType activity Type - * @internal param bool $record true if it is Record Activity * @access public * * @return $this|null|object @@ -656,7 +643,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * function to get the list Activities + * get the list Activities * * @param array $input array of parameters * Keys include @@ -919,7 +906,7 @@ ORDER BY fixed_sort_order * user has permission. To decide whether we are going to include * component related activities w/ core activity retrieve process. * - * return an array of component id and name. + * @return array of component id and name. * @static **/ static function activityComponents() { @@ -948,7 +935,7 @@ ORDER BY fixed_sort_order } /** - * function to get the activity Count + * get the activity Count * * @param array $input array of parameters * Keys include @@ -1180,7 +1167,6 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @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 @@ -1518,7 +1504,6 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @param $tokenText * @param $tokenHtml * @param array $smsParams the params used for sending sms - * * @param int $activityID the activity ID that tracks the message * @param null $userID * @@ -1598,12 +1583,10 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @param $html_message * @param string $emailAddress use this 'to' email address instead of the default Primary address * @param int $activityID the activity ID that tracks the message - * * @param null $attachments * @param null $cc * @param null $bcc * - * @internal param string $message the message contents * @return boolean true if successfull else false. * @access public * @static @@ -1676,8 +1659,6 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * * @param bool $status * - * @internal param $NULL - * * @return array array of importable Fields * @access public * @static @@ -1730,8 +1711,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * To get the Activities of a target contact * - * @param $contactId Integer ContactId of the contact whose activities - * need to find + * @param int $contactId Id of the contact whose activities need to find * * @return array array of activity fields * @access public @@ -1806,9 +1786,7 @@ WHERE activity.id IN ($activityIds)"; * * @param object $activity (reference) particular component object * @param string $activityType for Membership Signup or Renewal - * - * - * @param null $targetContactID + * @param int $targetContactID * * @return bool * @static @@ -1922,7 +1900,7 @@ SELECT display_name } /** - * Function to get Parent activity for currently viewed activity + * Get Parent activity for currently viewed activity * * @param int $activityId current activity id * @@ -1949,11 +1927,9 @@ SELECT display_name } /** - * Function to get total count of prior revision of currently viewd activity - * - * @param $activityID + * Get total count of prior revision of currently viewd activity * - * @internal param int $activityId current activity id + * @param $activityID current activity id * * @return int $params count of prior activities otherwise false. * @access public @@ -1988,14 +1964,11 @@ AND id < {$activityID} } /** - * Function to get all prior activities of currently viewe - * d activity + * Get all prior activities of currently viewed activity * - * @param $activityID + * @param $activityID current activity id * @param bool $onlyPriorRevisions * - * @internal param int $activityId current activity id - * * @return array $result prior activities info. * @access public */ @@ -2043,9 +2016,7 @@ AND cl.modified_id = c.id /** * Function to find the latest revision of a given activity * - * @param $activityID - * - * @internal param int $activityId prior activity id + * @param $activityID prior activity id * * @return int $params current activity id. * @access public @@ -2077,13 +2048,10 @@ AND cl.modified_id = c.id /** * Function to create a follow up a given activity * - * @activityId int activity id of parent activity - * - * @param $activityId - * @param $params + * @param $activityId int activity id of parent activity + * @param array $params * * @return $this|null|object - * @internal param array $activity details * * @access public */ @@ -2121,10 +2089,9 @@ AND cl.modified_id = c.id * Function to get Activity specific File according activity type Id. * * @param int $activityTypeId activity id - * * @param string $crmDir * - * @return if file exists returns $activityTypeFile activity filename otherwise false. + * @return string|bool if file exists returns $activityTypeFile activity filename otherwise false. * * @static */ @@ -2313,7 +2280,7 @@ AND cl.modified_id = c.id } /** - * Does user has sufficient permission for view/edit activity record. + * Does user has sufficient permission for view/edit activity record? * * @param int $activityId activity record id. * @param int $action edit/view @@ -2609,12 +2576,11 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n return $contactActivities; } - /* - * Used to copy custom fields and attachments from an existing activity to another. - * see CRM_Case_Page_AJAX::_convertToCaseActivity() for example - */ /** - * @param $params + * Used to copy custom fields and attachments from an existing activity to another. + * @see CRM_Case_Page_AJAX::_convertToCaseActivity() for example + * + * @param array $params */ static function copyExtendedActivityData($params) { // attach custom data to the new activity @@ -2688,7 +2654,7 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n } /** - * @param $params + * @param array $params */ function setApiFilter(&$params) { if (CRM_Utils_Array::value('target_contact_id', $params)) { diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index df8d5d7126..47dc534d1e 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -51,8 +51,6 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta * * @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 */ @@ -70,9 +68,7 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta /** * Retrieve assignee_id by activity_id * - * @param $activity_id - * - * @internal param int $id ID of the activity + * @param int $activity_id * * @return array * diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 0ea9940f50..95e86985bb 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -66,15 +66,12 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact } /** - * function to retrieve names of contact by activity_id + * retrieve names of contact by activity_id * - * @param $activityID - * @param $recordTypeID + * @param int $activityID + * @param int $recordTypeID * @param bool $alsoIDs * - * @internal param int $id ID of the activity - * @internal param string $type type of interaction - * * @return array * * @access public @@ -110,13 +107,11 @@ AND contact_a.is_deleted = 0 } /** - * function to retrieve id of target contact by activity_id + * retrieve id of target contact by activity_id * * @param $activityID * @param $recordTypeID * - * @internal param int $id ID of the activity - * * @return mixed * * @access public diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index 6ab4bdbd66..3b3650848c 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -47,12 +47,9 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { } /** - * function to add activity target + * add activity target * - * @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 + * @param array $params * * @return object activity type of object that is added * @access public @@ -68,11 +65,9 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { } /** - * function to retrieve id of target contact by activity_id - * - * @param $activity_id + * retrieve id of target contact by activity_id * - * @internal param int $id ID of the activity + * @param int $activity_id * * @return mixed * @@ -103,11 +98,9 @@ AND civicrm_contact.is_deleted = 0 } /** - * function to retrieve names of target contact by activity_id - * - * @param $activityID + * retrieve names of target contact by activity_id * - * @internal param int $id ID of the activity + * @param int $activityID * * @return array * diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index e378efe51d..2fde084f55 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -631,7 +631,7 @@ class CRM_Activity_BAO_Query { * @param $pseudoconstantType * @param $op * @param $grouping - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index 901d2cb162..41f524e94d 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -111,12 +111,11 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { */ protected $_crmDir = 'Activity'; - /* - * Survey activity - * - * @var boolean - */ - + /** + * Survey activity + * + * @var boolean + */ protected $_isSurveyActivity; protected $_values = array(); @@ -211,7 +210,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -510,7 +509,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -822,8 +821,6 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { * @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 * @static @@ -865,7 +862,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -1167,7 +1164,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Function to let injecting activity type file do any processing + * let injecting activity type file do any processing * needed, before the activity is added/updated * */ @@ -1179,7 +1176,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Function to let injecting activity type file do any processing + * let injecting activity type file do any processing * needed, after the activity has been added/updated * */ diff --git a/CRM/Activity/Form/ActivityView.php b/CRM/Activity/Form/ActivityView.php index aef4662d17..ccbc7f3ff3 100644 --- a/CRM/Activity/Form/ActivityView.php +++ b/CRM/Activity/Form/ActivityView.php @@ -40,7 +40,7 @@ class CRM_Activity_Form_ActivityView extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -113,7 +113,7 @@ class CRM_Activity_Form_ActivityView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Activity/Form/Search.php b/CRM/Activity/Form/Search.php index 0e4b018b35..bbbb39b903 100644 --- a/CRM/Activity/Form/Search.php +++ b/CRM/Activity/Form/Search.php @@ -90,19 +90,15 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { function preProcess() { $this->set('searchFormName', 'Search'); - /** - * set the button names - */ + // set the button names $this->_searchButtonName = $this->getButtonName('refresh'); $this->_actionButtonName = $this->getButtonName('next', 'action'); $this->_done = FALSE; $this->defaults = array(); - /* - * we allow the controller to set force/reset externally, useful when we are being - * driven by the wizard framework - */ + // we allow the controller to set force/reset externally, useful when we are being + // driven by the wizard framework $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); @@ -168,7 +164,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index 8403d1db27..8b7ac12628 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -87,7 +87,7 @@ class CRM_Activity_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -176,12 +176,10 @@ 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 $nextType + * @param string $nextType button type for the form after processing * @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/Form/Task/AddToTag.php b/CRM/Activity/Form/Task/AddToTag.php index 10cd4cfcfe..a4bf17e540 100644 --- a/CRM/Activity/Form/Task/AddToTag.php +++ b/CRM/Activity/Form/Task/AddToTag.php @@ -55,7 +55,7 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { protected $_tags; /** - * Build the form + * Build the form object * * @access public * @@ -81,7 +81,7 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { } /** - * @param $form + * @param CRM_Core_Form $form * @param $rule * * @return array @@ -156,6 +156,5 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { } } - //end of function } diff --git a/CRM/Activity/Form/Task/Batch.php b/CRM/Activity/Form/Task/Batch.php index 999ba60a33..e40ef97405 100755 --- a/CRM/Activity/Form/Task/Batch.php +++ b/CRM/Activity/Form/Task/Batch.php @@ -98,7 +98,7 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -203,7 +203,7 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -302,6 +302,5 @@ WHERE a.id = %1 "; CRM_Core_Session::setStatus("", ts("No Updates Saved"), "info"); } } - //end of function } diff --git a/CRM/Activity/Form/Task/Delete.php b/CRM/Activity/Form/Task/Delete.php index e1f9ca9969..a7f476c9f3 100755 --- a/CRM/Activity/Form/Task/Delete.php +++ b/CRM/Activity/Form/Task/Delete.php @@ -59,7 +59,7 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task/Email.php b/CRM/Activity/Form/Task/Email.php index 8d31c1f498..8a435c6185 100644 --- a/CRM/Activity/Form/Task/Email.php +++ b/CRM/Activity/Form/Task/Email.php @@ -72,7 +72,7 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task/FileOnCase.php b/CRM/Activity/Form/Task/FileOnCase.php index be99fbaf20..e0eb190220 100644 --- a/CRM/Activity/Form/Task/FileOnCase.php +++ b/CRM/Activity/Form/Task/FileOnCase.php @@ -72,7 +72,7 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index c11dffef37..ca57ef9258 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -93,7 +93,7 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index edd42eacde..45c3ac054a 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/Form/Task/PickProfile.php @@ -88,7 +88,7 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -174,6 +174,5 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { // also reset the batch page so it gets new values from the db $this->controller->resetPage('Batch'); } - //end of function } diff --git a/CRM/Activity/Form/Task/Print.php b/CRM/Activity/Form/Task/Print.php index 1a95d28926..77e241e7fd 100644 --- a/CRM/Activity/Form/Task/Print.php +++ b/CRM/Activity/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Activity/Form/Task/RemoveFromTag.php b/CRM/Activity/Form/Task/RemoveFromTag.php index 00d46cec13..8375c7213f 100644 --- a/CRM/Activity/Form/Task/RemoveFromTag.php +++ b/CRM/Activity/Form/Task/RemoveFromTag.php @@ -53,7 +53,7 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { protected $_tags; /** - * Build the form + * Build the form object * * @access public * @@ -77,7 +77,7 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { } /** - * @param $form + * @param CRM_Core_Form $form * @param $rule * * @return array @@ -144,6 +144,5 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { CRM_Core_Session::setStatus($status, ts("Removed Tag %1", array(1 => $this->_tags[$key])), 'success', array('expires' => 0)); } } - //end of function } diff --git a/CRM/Activity/Form/Task/SMS.php b/CRM/Activity/Form/Task/SMS.php index 6055f5f2ce..1d80011dbb 100644 --- a/CRM/Activity/Form/Task/SMS.php +++ b/CRM/Activity/Form/Task/SMS.php @@ -59,7 +59,7 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Activity/Form/Task/SearchTaskHookSample.php b/CRM/Activity/Form/Task/SearchTaskHookSample.php index 32be2df1af..c70a91f8a0 100644 --- a/CRM/Activity/Form/Task/SearchTaskHookSample.php +++ b/CRM/Activity/Form/Task/SearchTaskHookSample.php @@ -80,7 +80,7 @@ INNER JOIN civicrm_contact ct ON ( ac.contact_id = ct.id ) } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Activity/Import/Form/DataSource.php b/CRM/Activity/Import/Form/DataSource.php index 83bd6a9bac..6c2f658944 100644 --- a/CRM/Activity/Import/Form/DataSource.php +++ b/CRM/Activity/Import/Form/DataSource.php @@ -39,7 +39,7 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -52,7 +52,7 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index 41c00bae40..a25ce49ddc 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -78,7 +78,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Activity/Import/Form/Preview.php b/CRM/Activity/Import/Form/Preview.php index 08a3a23c66..7679e599b0 100644 --- a/CRM/Activity/Import/Form/Preview.php +++ b/CRM/Activity/Import/Form/Preview.php @@ -40,7 +40,7 @@ class CRM_Activity_Import_Form_Preview extends CRM_Import_Form_Preview { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Activity/Import/Form/Summary.php b/CRM/Activity/Import/Form/Summary.php index f6e88e6ec9..7ed863af97 100644 --- a/CRM/Activity/Import/Form/Summary.php +++ b/CRM/Activity/Import/Form/Summary.php @@ -39,7 +39,7 @@ class CRM_Activity_Import_Form_Summary extends CRM_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 7e87ff4918..5143b2fa18 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -296,7 +296,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public @@ -386,11 +386,10 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param $fileName + * @param string $fileName * @param array $header - * @param data $data + * @param array $data * - * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Activity/Page/AJAX.php b/CRM/Activity/Page/AJAX.php index 87c6a3e260..59a6918dc9 100644 --- a/CRM/Activity/Page/AJAX.php +++ b/CRM/Activity/Page/AJAX.php @@ -307,7 +307,7 @@ class CRM_Activity_Page_AJAX { } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Activity/Page/UserDashboard.php b/CRM/Activity/Page/UserDashboard.php index efc26e4898..9429313c2d 100644 --- a/CRM/Activity/Page/UserDashboard.php +++ b/CRM/Activity/Page/UserDashboard.php @@ -39,7 +39,7 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** - * Function to list participations for the UF user + * list participations for the UF user * * return null * @access public diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 1c38efc0c7..d1d85bcd59 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -99,15 +99,13 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * * - View * - * @param $activityTypeId + * @param int $activityTypeId * @param null $sourceRecordId * @param bool $accessMailingReport * @param null $activityId * @param null $key * @param null $compContext * - * @internal param string $activityType type of activity - * * @return array * @access public */ @@ -277,9 +275,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 22b240f308..a3aa100bc4 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -188,17 +188,14 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM ); $this->_query->_distinctComponentClause = '( civicrm_activity.id )'; $this->_query->_groupByComponentClause = " GROUP BY civicrm_activity.id "; - //CRM_Core_Error::debug( $this->_query ); exit(); } - //end of constructor /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -208,7 +205,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -362,7 +358,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * * @return array $qill which contains an array of strings * @access public */ @@ -443,5 +438,3 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM return ts('CiviCRM Activity Search'); } } -//end of class - diff --git a/CRM/Admin/Form.php b/CRM/Admin/Form.php index 0f6a1d407b..40bc2bbc6e 100644 --- a/CRM/Admin/Form.php +++ b/CRM/Admin/Form.php @@ -75,7 +75,7 @@ class CRM_Admin_Form extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Admin/Form/CMSUser.php b/CRM/Admin/Form/CMSUser.php index f3034d77b1..790683a0d5 100644 --- a/CRM/Admin/Form/CMSUser.php +++ b/CRM/Admin/Form/CMSUser.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_CMSUser extends CRM_Core_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -62,7 +62,7 @@ class CRM_Admin_Form_CMSUser extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/ContactType.php b/CRM/Admin/Form/ContactType.php index 74211e0ea0..3862ee0ca2 100644 --- a/CRM/Admin/Form/ContactType.php +++ b/CRM/Admin/Form/ContactType.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -118,7 +118,7 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Extensions.php b/CRM/Admin/Form/Extensions.php index 6f6fabef3e..45ef291694 100644 --- a/CRM/Admin/Form/Extensions.php +++ b/CRM/Admin/Form/Extensions.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** - * Function to for pre-processing + * for pre-processing * * @return void * @access public @@ -85,7 +85,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -98,7 +98,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -169,7 +169,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Job.php b/CRM/Admin/Form/Job.php index 5552856c31..ab83a39ed3 100644 --- a/CRM/Admin/Form/Job.php +++ b/CRM/Admin/Form/Job.php @@ -62,7 +62,7 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @param bool $check * @@ -168,7 +168,7 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -211,6 +211,5 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { } - //end of function } diff --git a/CRM/Admin/Form/LabelFormats.php b/CRM/Admin/Form/LabelFormats.php index 30809ca257..20399dd359 100644 --- a/CRM/Admin/Form/LabelFormats.php +++ b/CRM/Admin/Form/LabelFormats.php @@ -61,7 +61,7 @@ class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -180,7 +180,7 @@ class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/LocationType.php b/CRM/Admin/Form/LocationType.php index 8e8dcf64f5..bab8736bdb 100644 --- a/CRM/Admin/Form/LocationType.php +++ b/CRM/Admin/Form/LocationType.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_LocationType extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -83,7 +83,7 @@ class CRM_Admin_Form_LocationType extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/MailSettings.php b/CRM/Admin/Form/MailSettings.php index f66de121e3..2b4998eaad 100644 --- a/CRM/Admin/Form/MailSettings.php +++ b/CRM/Admin/Form/MailSettings.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -122,7 +122,7 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Mapping.php b/CRM/Admin/Form/Mapping.php index ae1806af2a..9b5cc78c8e 100644 --- a/CRM/Admin/Form/Mapping.php +++ b/CRM/Admin/Form/Mapping.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Mapping extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -89,7 +89,7 @@ class CRM_Admin_Form_Mapping extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/MessageTemplates.php b/CRM/Admin/Form/MessageTemplates.php index 537a2d99a6..455ed5c665 100644 --- a/CRM/Admin/Form/MessageTemplates.php +++ b/CRM/Admin/Form/MessageTemplates.php @@ -55,7 +55,7 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * The default values are retrieved from the database. * * @access public @@ -110,7 +110,7 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -198,7 +198,7 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Navigation.php b/CRM/Admin/Form/Navigation.php index a706e0fdec..5ff6e383ee 100644 --- a/CRM/Admin/Form/Navigation.php +++ b/CRM/Admin/Form/Navigation.php @@ -50,7 +50,7 @@ class CRM_Admin_Form_Navigation extends CRM_Admin_Form { protected $_defaults = array(); /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -143,7 +143,7 @@ class CRM_Admin_Form_Navigation extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/OptionGroup.php b/CRM/Admin/Form/OptionGroup.php index f1c0452ea6..d95d3df765 100644 --- a/CRM/Admin/Form/OptionGroup.php +++ b/CRM/Admin/Form/OptionGroup.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -99,7 +99,7 @@ class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Options.php b/CRM/Admin/Form/Options.php index 089ba4b200..55a1a57cca 100644 --- a/CRM/Admin/Form/Options.php +++ b/CRM/Admin/Form/Options.php @@ -56,7 +56,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { protected $_gLabel; /** - * Function to pre-process + * pre-process * * @return void * @access public @@ -115,7 +115,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -143,7 +143,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -368,7 +368,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index 73abfe7424..9136f1c2dc 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -162,7 +162,7 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @param bool $check * @@ -335,7 +335,7 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/PaymentProcessorType.php b/CRM/Admin/Form/PaymentProcessorType.php index 256c777dff..e0d9a83c20 100644 --- a/CRM/Admin/Form/PaymentProcessorType.php +++ b/CRM/Admin/Form/PaymentProcessorType.php @@ -146,7 +146,7 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @param bool $check * @@ -206,7 +206,7 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/PdfFormats.php b/CRM/Admin/Form/PdfFormats.php index b84da1be38..b5f272ebcb 100644 --- a/CRM/Admin/Form/PdfFormats.php +++ b/CRM/Admin/Form/PdfFormats.php @@ -46,7 +46,7 @@ class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form { protected $_id = NULL; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -106,7 +106,7 @@ class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Preferences.php b/CRM/Admin/Form/Preferences.php index 2836d064a3..1f1b4c90dd 100644 --- a/CRM/Admin/Form/Preferences.php +++ b/CRM/Admin/Form/Preferences.php @@ -139,7 +139,7 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -236,7 +236,7 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -252,10 +252,9 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { $this->postProcessCommon(); } - //end of function /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Preferences/Address.php b/CRM/Admin/Form/Preferences/Address.php index 546e5dbb36..285827eff6 100644 --- a/CRM/Admin/Form/Preferences/Address.php +++ b/CRM/Admin/Form/Preferences/Address.php @@ -138,7 +138,7 @@ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -183,7 +183,7 @@ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -219,6 +219,5 @@ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { $this->postProcessCommon(); } - //end of function } diff --git a/CRM/Admin/Form/Preferences/Contribute.php b/CRM/Admin/Form/Preferences/Contribute.php index 58c51877da..b4e119c42e 100644 --- a/CRM/Admin/Form/Preferences/Contribute.php +++ b/CRM/Admin/Form/Preferences/Contribute.php @@ -6,7 +6,7 @@ */ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { /** - * Function to process the form + * Process the form submission * * @access public * @@ -90,7 +90,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -101,7 +101,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { } /** - * This function sets the default values for the form. + * Set default values for the form. * default values are retrieved from the database * * @access public diff --git a/CRM/Admin/Form/Preferences/Display.php b/CRM/Admin/Form/Preferences/Display.php index fe201d97fe..77a354dab5 100644 --- a/CRM/Admin/Form/Preferences/Display.php +++ b/CRM/Admin/Form/Preferences/Display.php @@ -143,7 +143,7 @@ class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -207,7 +207,7 @@ class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -244,6 +244,5 @@ class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences { $this->postProcessCommon(); } - //end of function } diff --git a/CRM/Admin/Form/Preferences/Member.php b/CRM/Admin/Form/Preferences/Member.php index 74e4688e49..bb51ee6f11 100644 --- a/CRM/Admin/Form/Preferences/Member.php +++ b/CRM/Admin/Form/Preferences/Member.php @@ -57,7 +57,7 @@ class CRM_Admin_Form_Preferences_Member extends CRM_Admin_Form_Preferences { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/PreferencesDate.php b/CRM/Admin/Form/PreferencesDate.php index 16bda9e6ca..ad9d833b63 100644 --- a/CRM/Admin/Form/PreferencesDate.php +++ b/CRM/Admin/Form/PreferencesDate.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -109,7 +109,7 @@ class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/RelationshipType.php b/CRM/Admin/Form/RelationshipType.php index c03c8fc82f..321c1493bb 100644 --- a/CRM/Admin/Form/RelationshipType.php +++ b/CRM/Admin/Form/RelationshipType.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -128,7 +128,7 @@ class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php index 930c4aa206..56948182bd 100644 --- a/CRM/Admin/Form/ScheduleReminders.php +++ b/CRM/Admin/Form/ScheduleReminders.php @@ -48,7 +48,7 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { public $_freqUnits; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -345,7 +345,7 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php index 2ba35f3d64..ccbf3d4436 100644 --- a/CRM/Admin/Form/Setting.php +++ b/CRM/Admin/Form/Setting.php @@ -43,7 +43,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { protected $_settings = array(); /** - * This function sets the default values for the form. + * Set default values for the form. * default values are retrieved from the database * * @access public @@ -114,7 +114,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -167,7 +167,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -181,7 +181,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { } /** - * @param $params + * @param array $params */ public function commonProcess(&$params) { diff --git a/CRM/Admin/Form/Setting/Component.php b/CRM/Admin/Form/Setting/Component.php index 4bc635e271..557c0ffbf3 100644 --- a/CRM/Admin/Form/Setting/Component.php +++ b/CRM/Admin/Form/Setting/Component.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting { protected $_components; /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Date.php b/CRM/Admin/Form/Setting/Date.php index 718b4f2de4..d137435919 100644 --- a/CRM/Admin/Form/Setting/Date.php +++ b/CRM/Admin/Form/Setting/Date.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Setting_Date extends CRM_Admin_Form_Setting { /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Debugging.php b/CRM/Admin/Form/Setting/Debugging.php index 6d06f0bfd2..80a59f9a67 100644 --- a/CRM/Admin/Form/Setting/Debugging.php +++ b/CRM/Admin/Form/Setting/Debugging.php @@ -46,7 +46,7 @@ class CRM_Admin_Form_Setting_Debugging extends CRM_Admin_Form_Setting { 'fatalErrorHandler' => CRM_Core_BAO_Setting::DEVELOPER_PREFERENCES_NAME, ); /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Localization.php b/CRM/Admin/Form/Setting/Localization.php index b893c69418..3d1c99745b 100644 --- a/CRM/Admin/Form/Setting/Localization.php +++ b/CRM/Admin/Form/Setting/Localization.php @@ -43,7 +43,7 @@ class CRM_Admin_Form_Setting_Localization extends CRM_Admin_Form_Setting { protected $_currencySymbols; /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Mail.php b/CRM/Admin/Form/Setting/Mail.php index 1736a2b61e..952f29c870 100644 --- a/CRM/Admin/Form/Setting/Mail.php +++ b/CRM/Admin/Form/Setting/Mail.php @@ -39,7 +39,7 @@ class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting { /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Mapping.php b/CRM/Admin/Form/Setting/Mapping.php index e368e64cac..c535b7c236 100644 --- a/CRM/Admin/Form/Setting/Mapping.php +++ b/CRM/Admin/Form/Setting/Mapping.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting { /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Miscellaneous.php b/CRM/Admin/Form/Setting/Miscellaneous.php index d96f9a63cb..b122554fb3 100644 --- a/CRM/Admin/Form/Setting/Miscellaneous.php +++ b/CRM/Admin/Form/Setting/Miscellaneous.php @@ -65,7 +65,7 @@ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Path.php b/CRM/Admin/Form/Setting/Path.php index 9071efe856..4aa9c848b9 100644 --- a/CRM/Admin/Form/Setting/Path.php +++ b/CRM/Admin/Form/Setting/Path.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Setting_Path extends CRM_Admin_Form_Setting { /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Search.php b/CRM/Admin/Form/Setting/Search.php index 792845db2e..1b5fd5af32 100644 --- a/CRM/Admin/Form/Setting/Search.php +++ b/CRM/Admin/Form/Setting/Search.php @@ -45,7 +45,7 @@ class CRM_Admin_Form_Setting_Search extends CRM_Admin_Form_Setting { ); /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index cb3947617f..f91079753c 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -41,7 +41,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { protected $_testButtonName; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -75,7 +75,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -239,7 +239,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { } /** - * This function sets the default values for the form. + * Set default values for the form. * default values are retrieved from the database * * @access public diff --git a/CRM/Admin/Form/Setting/UF.php b/CRM/Admin/Form/Setting/UF.php index 11705be524..af8afd3ea5 100644 --- a/CRM/Admin/Form/Setting/UF.php +++ b/CRM/Admin/Form/Setting/UF.php @@ -44,7 +44,7 @@ class CRM_Admin_Form_Setting_UF extends CRM_Admin_Form_Setting { protected $_uf = NULL; /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/UpdateConfigBackend.php b/CRM/Admin/Form/Setting/UpdateConfigBackend.php index 92ab92ee9d..f05021a352 100644 --- a/CRM/Admin/Form/Setting/UpdateConfigBackend.php +++ b/CRM/Admin/Form/Setting/UpdateConfigBackend.php @@ -43,7 +43,7 @@ class CRM_Admin_Form_Setting_UpdateConfigBackend extends CRM_Admin_Form_Setting protected $_oldSiteName; /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Setting/Url.php b/CRM/Admin/Form/Setting/Url.php index 375354e659..9a46f9fdd3 100644 --- a/CRM/Admin/Form/Setting/Url.php +++ b/CRM/Admin/Form/Setting/Url.php @@ -43,7 +43,7 @@ class CRM_Admin_Form_Setting_Url extends CRM_Admin_Form_Setting { 'disable_core_css' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, ); /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Admin/Form/Tag.php b/CRM/Admin/Form/Tag.php index 011d926f1d..87076c91d0 100644 --- a/CRM/Admin/Form/Tag.php +++ b/CRM/Admin/Form/Tag.php @@ -41,7 +41,7 @@ class CRM_Admin_Form_Tag extends CRM_Admin_Form { protected $_isTagSet; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -121,7 +121,7 @@ class CRM_Admin_Form_Tag extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Form/WordReplacements.php b/CRM/Admin/Form/WordReplacements.php index f432dede18..b712c964cf 100644 --- a/CRM/Admin/Form/WordReplacements.php +++ b/CRM/Admin/Form/WordReplacements.php @@ -111,7 +111,7 @@ class CRM_Admin_Form_WordReplacements extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -210,7 +210,7 @@ class CRM_Admin_Form_WordReplacements extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Admin/Page/AJAX.php b/CRM/Admin/Page/AJAX.php index 49f459ed8c..df315468d1 100644 --- a/CRM/Admin/Page/AJAX.php +++ b/CRM/Admin/Page/AJAX.php @@ -62,14 +62,14 @@ class CRM_Admin_Page_AJAX { } /** - * Function to process drag/move action for menu tree + * process drag/move action for menu tree */ static function menuTree() { CRM_Core_BAO_Navigation::processNavigation($_GET); } /** - * Function to build status message while + * build status message while * enabling/ disabling various objects */ static function getStatusMsg() { diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php index e41486d0de..a0d7449810 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -268,7 +268,7 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { } /** - * function to get userContext params + * get userContext params * * @param int $mode mode that we are in * diff --git a/CRM/Admin/Page/MessageTemplates.php b/CRM/Admin/Page/MessageTemplates.php index 44d4f0b0c2..be4b80ca27 100644 --- a/CRM/Admin/Page/MessageTemplates.php +++ b/CRM/Admin/Page/MessageTemplates.php @@ -238,8 +238,6 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * browse all entities. * - * @internal param int $action - * * @return void * @access public */ diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index a86aef7c7f..a157a7623e 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -394,11 +394,10 @@ class CRM_Badge_BAO_Badge { } /** - * function to build badges parameters before actually creating badges. + * build badges parameters before actually creating badges. * * @param array $params associated array of submitted values - * @param $form - * @params object $form form/controller object + * @param CRM_Core_Form $form * * @return void * @access public @@ -408,7 +407,7 @@ class CRM_Badge_BAO_Badge { // get name badge layout info $layoutInfo = CRM_Badge_BAO_Layout::buildLayout($params); - // spit / get actual field names from tokeni and individual contact image URLs + // split/get actual field names from token and individual contact image URLs $returnProperties = array(); if (!empty($layoutInfo['data']['token'])) { foreach ($layoutInfo['data']['token'] as $index => $value) { diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index e7a698396c..96568a01cc 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -49,7 +49,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_PrintLabel object on success, null otherwise + * @return CRM_Core_DAO_PrintLabel object on success, null otherwise * @access public * @static */ @@ -79,12 +79,10 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * Function to add a name label + * add a name label * * @param array $params reference array contains the values submitted by the form * - * @internal param array $ids reference array contains the id - * * @access public * @static * @@ -123,7 +121,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * Function to delete name labels + * delete name labels * * @param int $printLabelId ID of the name label to be deleted. * @@ -173,7 +171,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * Function to decode encoded data and return as an array + * decode encoded data and return as an array * * @param json $jsonData json object * diff --git a/CRM/Badge/Form/Layout.php b/CRM/Badge/Form/Layout.php index 7acaea4783..1dbb3d043a 100644 --- a/CRM/Badge/Form/Layout.php +++ b/CRM/Badge/Form/Layout.php @@ -41,7 +41,7 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { const FIELD_ROWCOUNT = 6; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -156,7 +156,7 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -185,7 +185,7 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -223,7 +223,7 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { } /** - * @param $params + * @param array $params */ public function buildPreview(&$params) { // get a max participant id diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index a97216f6f7..fd91a72b3c 100644 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -147,7 +147,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Remove entries from entity batch * @param array $params associated array - * @return object CRM_Batch_DAO_EntityBatch + * @return CRM_Batch_DAO_EntityBatch */ static function removeBatchEntity($params) { $entityBatch = new CRM_Batch_DAO_EntityBatch(); @@ -157,7 +157,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * function to delete batch entry + * delete batch entry * * @param int $batchId batch id * @@ -410,7 +410,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * Function to define action links + * define action links * * @param null $context * @@ -490,7 +490,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * function to get batch list + * get batch list * * @return array array of all batches * excluding batches with data entry in progress diff --git a/CRM/Batch/Form/Batch.php b/CRM/Batch/Form/Batch.php index c215a7f2e4..a1351ca4d5 100644 --- a/CRM/Batch/Form/Batch.php +++ b/CRM/Batch/Form/Batch.php @@ -47,7 +47,7 @@ class CRM_Batch_Form_Batch extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -80,7 +80,7 @@ class CRM_Batch_Form_Batch extends CRM_Admin_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -100,7 +100,7 @@ class CRM_Batch_Form_Batch extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -136,6 +136,5 @@ class CRM_Batch_Form_Batch extends CRM_Admin_Form { $session->replaceUserContext(CRM_Utils_System::url('civicrm/batch/entry', "id={$batch->id}&reset=1")); } } - //end of function } diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index 02f1015ebb..fd7ce29790 100644 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -115,7 +115,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * @@ -294,7 +294,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -514,7 +514,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } return TRUE; } - //end of function /** * process membership records diff --git a/CRM/Batch/Page/Batch.php b/CRM/Batch/Page/Batch.php index 8f6a66bb03..745ee6786a 100644 --- a/CRM/Batch/Page/Batch.php +++ b/CRM/Batch/Page/Batch.php @@ -94,8 +94,6 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * browse all entities. * - * @internal param int $action - * * @return void * @access public */ diff --git a/CRM/Bridge/OG/Drupal.php b/CRM/Bridge/OG/Drupal.php index 58c4cb83c9..e93358e7f4 100644 --- a/CRM/Bridge/OG/Drupal.php +++ b/CRM/Bridge/OG/Drupal.php @@ -37,7 +37,7 @@ class CRM_Bridge_OG_Drupal { /** - * @param $params + * @param array $params * @param $op */ static function nodeapi(&$params, $op) { @@ -68,7 +68,7 @@ class CRM_Bridge_OG_Drupal { } /** - * @param $params + * @param array $params * @param $op * @param null $groupType */ @@ -115,7 +115,7 @@ class CRM_Bridge_OG_Drupal { } /** - * @param $params + * @param array $params * @param $op */ static function updateCiviACLRole(&$params, $op) { @@ -162,7 +162,7 @@ SELECT v.id } /** - * @param $params + * @param array $params * @param $op */ static function updateCiviACLEntityRole(&$params, $op) { @@ -184,7 +184,7 @@ SELECT v.id } /** - * @param $params + * @param array $params * @param $op */ static function updateCiviACL(&$params, $op) { @@ -210,7 +210,7 @@ SELECT v.id } /** - * @param $params + * @param array $params * @param $op * * @throws Exception diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index edb5b538ae..de723c7f16 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -43,7 +43,7 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Campaign_DAO_Campaign object + * @return CRM_Campaign_DAO_Campaign object * @access public * @static */ @@ -99,7 +99,7 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { } /** - * function to delete the campaign + * delete the campaign * * @param int $id id of the campaign * @@ -308,12 +308,11 @@ Order By camp.title"; } /** - * Function to retrieve campaigns for dashboard. + * retrieve campaigns for dashboard. * * @static */ - static function getCampaignSummary($params = array( - ), $onlyCount = FALSE) { + static function getCampaignSummary($params = array(), $onlyCount = FALSE) { $campaigns = array(); //build the limit and order clause. @@ -466,7 +465,7 @@ SELECT campaign.id as id, } /** - * Function to get Campaigns groups + * get Campaigns groups * * @param int $campaignId campaign id * @@ -536,7 +535,7 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) * */ /** - * @param $form + * @param CRM_Core_Form $form * @param null $connectedCampaignId */ public static function addCampaign(&$form, $connectedCampaignId = NULL) { @@ -619,7 +618,7 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) * Add campaign in compoent search. * and assign needful info to templates. * - * @param $form + * @param CRM_Core_Form $form * @param string $elementName */ public static function addCampaignInComponentSearch(&$form, $elementName = 'campaign_id') { diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 0863962d24..e39de126c7 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -43,7 +43,7 @@ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey { } /** - * Function to get Petition Details for dashboard. + * get Petition Details for dashboard. * * @static */ @@ -175,7 +175,7 @@ SELECT petition.id as id, * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Campaign_BAO_Petition + * @return CRM_Campaign_BAO_Petition * @access public * @static */ @@ -279,13 +279,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Function to get Petition Signature Total + * get Petition Signature Total * - * @param $surveyId + * @param int $surveyId * * @return array - * @internal param bool $all - * @internal param int $id * @static */ static function getPetitionSignatureTotalbyCountry($surveyId) { @@ -324,13 +322,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Function to get Petition Signature Total + * get Petition Signature Total * - * @param $surveyId + * @param int $surveyId * * @return array - * @internal param bool $all - * @internal param int $id * @static */ static function getPetitionSignatureTotal($surveyId) { @@ -389,12 +385,10 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * Function to get Petition Signature Details * - * @param $surveyId - * @param null $status_id + * @param int $surveyId + * @param int $status_id * * @return array - * @internal param bool $all - * @internal param int $id * @static */ static function getPetitionSignature($surveyId, $status_id = NULL) { diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 44563481ef..52b749221e 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -455,7 +455,7 @@ INNER JOIN civicrm_custom_group grp on fld.custom_group_id = grp.id * @static */ /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index de6f7a1b11..d02814d09d 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -53,11 +53,10 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { /** * The action links that we need to display for the browse screen * - * @param $params + * @param array $params * @param $defaults * - * @return \CRM_Campaign_DAO_Survey|null - * @internal param array $ + * @return CRM_Campaign_DAO_Survey|null */ static function retrieve(&$params, &$defaults) { $dao = new CRM_Campaign_DAO_Survey(); @@ -78,9 +77,9 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { * survey object. * * - * @param $params + * @param array $params * - * @return object CRM_Survey_DAO_Survey object + * @return CRM_Survey_DAO_Survey object * @access public * @static */ @@ -118,12 +117,11 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { } /** - * Function to retrieve surveys for dashboard. + * retrieve surveys for dashboard. * * @static */ - static function getSurveySummary($params = array( - ), $onlyCount = FALSE) { + static function getSurveySummary($params = array(), $onlyCount = FALSE) { //build the limit and order clause. $limitClause = $orderByClause = $lookupTableJoins = NULL; if (!$onlyCount) { @@ -244,7 +242,7 @@ SELECT survey.id as id, } /** - * Function to get Surveys + * get Surveys * * @param boolean $onlyActive retrieve only active surveys. * @param boolean $onlyDefault retrieve only default survey. @@ -301,7 +299,7 @@ SELECT survey.id as id, } /** - * Function to get Surveys activity types + * get Surveys activity types * * * @static @@ -343,8 +341,7 @@ SELECT survey.id as id, * @return array * @static */ - static function getSurveyCustomGroups($surveyTypes = array( - )) { + static function getSurveyCustomGroups($surveyTypes = array()) { $customGroups = array(); if (!is_array($surveyTypes)) { $surveyTypes = array($surveyTypes); @@ -415,14 +412,13 @@ SELECT survey.id as id, /** * This function retrieve contact information. * - * @param $voterIds + * @param array $voterIds * @param array $returnProperties an array of return elements. * - * @internal param array $voter an array of contact Ids. - * @return array $voterDetails array of contact info.@static + * @return array $voterDetails array of contact info. + * @static */ - static function voterDetails($voterIds, $returnProperties = array( - )) { + static function voterDetails($voterIds, $returnProperties = array()) { $voterDetails = array(); if (!is_array($voterIds) || empty($voterIds)) { return $voterDetails; @@ -725,8 +721,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * This function is to check survey activity. * * @param int $activityId activity id. - * @internal param int $activityTypeId activity type id. - * @return boolean $isSurveyActivity true/false boolean. + * @return boolean $isSurveyActivity true/false * @static */ static function isSurveyActivity($activityId) { @@ -1052,7 +1047,7 @@ INNER JOIN civicrm_survey survey ON ( activity.source_record_id = survey.id ) /** * Check and update the survey respondents. * - * @param $params + * @param array $params * * @return array success message */ diff --git a/CRM/Campaign/Form/Campaign.php b/CRM/Campaign/Form/Campaign.php index 4fbff48b15..55127b05b9 100644 --- a/CRM/Campaign/Form/Campaign.php +++ b/CRM/Campaign/Form/Campaign.php @@ -131,7 +131,7 @@ class CRM_Campaign_Form_Campaign extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Campaign/Form/Gotv.php b/CRM/Campaign/Form/Gotv.php index fbd766a359..01efe23174 100755 --- a/CRM/Campaign/Form/Gotv.php +++ b/CRM/Campaign/Form/Gotv.php @@ -97,7 +97,7 @@ class CRM_Campaign_Form_Gotv extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index 96f81f6e28..4850ae9f5e 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -121,7 +121,7 @@ class CRM_Campaign_Form_Petition extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index bc75840fa2..1a31f7993f 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -239,7 +239,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -589,7 +589,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * Function to build the petition profile form + * build the petition profile form * * @param $id * @param $name @@ -673,7 +673,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { // check if user has already signed this petition /** - * @param $params + * @param array $params */ function redirectIfSigned($params) { $signature = $this->bao->checkSignature($this->_surveyId, $this->_contactId); diff --git a/CRM/Campaign/Form/Search.php b/CRM/Campaign/Form/Search.php index 43ef56d6c7..4ad3914d63 100755 --- a/CRM/Campaign/Form/Search.php +++ b/CRM/Campaign/Form/Search.php @@ -194,7 +194,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Search/Campaign.php b/CRM/Campaign/Form/Search/Campaign.php index 4b09079b10..b667937248 100755 --- a/CRM/Campaign/Form/Search/Campaign.php +++ b/CRM/Campaign/Form/Search/Campaign.php @@ -70,7 +70,7 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Search/Petition.php b/CRM/Campaign/Form/Search/Petition.php index 90c1b36489..a9e906d6df 100755 --- a/CRM/Campaign/Form/Search/Petition.php +++ b/CRM/Campaign/Form/Search/Petition.php @@ -69,7 +69,7 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Search/Survey.php b/CRM/Campaign/Form/Search/Survey.php index 22dadd0dec..6a9e0549f5 100755 --- a/CRM/Campaign/Form/Search/Survey.php +++ b/CRM/Campaign/Form/Search/Survey.php @@ -70,7 +70,7 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Survey.php b/CRM/Campaign/Form/Survey.php index 07f7274774..f9c5b3f7ed 100644 --- a/CRM/Campaign/Form/Survey.php +++ b/CRM/Campaign/Form/Survey.php @@ -90,7 +90,7 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Campaign/Form/Survey/Delete.php b/CRM/Campaign/Form/Survey/Delete.php index fb3fa97573..308d3207b2 100644 --- a/CRM/Campaign/Form/Survey/Delete.php +++ b/CRM/Campaign/Form/Survey/Delete.php @@ -54,7 +54,7 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -73,7 +73,7 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Campaign/Form/Survey/Main.php b/CRM/Campaign/Form/Survey/Main.php index 291d69c02c..2b3b2aac13 100644 --- a/CRM/Campaign/Form/Survey/Main.php +++ b/CRM/Campaign/Form/Survey/Main.php @@ -101,7 +101,7 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -141,7 +141,7 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Campaign/Form/Survey/Questions.php b/CRM/Campaign/Form/Survey/Questions.php index 18a1cb4047..41d22f30ae 100644 --- a/CRM/Campaign/Form/Survey/Questions.php +++ b/CRM/Campaign/Form/Survey/Questions.php @@ -40,7 +40,7 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -65,7 +65,7 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index 8b0009c405..9498a2c150 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -74,7 +74,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -98,7 +98,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Campaign/Form/Survey/TabHeader.php b/CRM/Campaign/Form/Survey/TabHeader.php index 79574bcb8e..cdbbfee209 100644 --- a/CRM/Campaign/Form/Survey/TabHeader.php +++ b/CRM/Campaign/Form/Survey/TabHeader.php @@ -39,7 +39,7 @@ class CRM_Campaign_Form_Survey_TabHeader { /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ @@ -59,7 +59,7 @@ class CRM_Campaign_Form_Survey_TabHeader { } /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ @@ -120,7 +120,7 @@ class CRM_Campaign_Form_Survey_TabHeader { } /** - * @param $form + * @param CRM_Core_Form $form */ static function reset(&$form) { $tabs = self::process($form); diff --git a/CRM/Campaign/Form/SurveyType.php b/CRM/Campaign/Form/SurveyType.php index 1e86b9b346..d3f7d7fe8b 100644 --- a/CRM/Campaign/Form/SurveyType.php +++ b/CRM/Campaign/Form/SurveyType.php @@ -63,7 +63,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { protected $_action; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -96,7 +96,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database. * * @param null @@ -116,7 +116,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -149,7 +149,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index bdf9f8324a..fabfb659f0 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/Form/Task.php @@ -136,12 +136,10 @@ 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 $nextType + * @param string $nextType button type for the form after processing * @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/Interview.php b/CRM/Campaign/Form/Task/Interview.php index 61fbb2994a..cb3aab81c6 100755 --- a/CRM/Campaign/Form/Task/Interview.php +++ b/CRM/Campaign/Form/Task/Interview.php @@ -283,7 +283,7 @@ WHERE {$clause} } /** - * Build the form + * Build the form object * * @access public * @@ -383,7 +383,7 @@ WHERE {$clause} } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -470,7 +470,7 @@ WHERE {$clause} } /** - * @param $params + * @param array $params * * @return mixed */ diff --git a/CRM/Campaign/Form/Task/Print.php b/CRM/Campaign/Form/Task/Print.php index 64d037bd78..bfac70043c 100755 --- a/CRM/Campaign/Form/Task/Print.php +++ b/CRM/Campaign/Form/Task/Print.php @@ -76,7 +76,7 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Campaign/Form/Task/Release.php b/CRM/Campaign/Form/Task/Release.php index 4b93452dfa..1d946f479b 100644 --- a/CRM/Campaign/Form/Task/Release.php +++ b/CRM/Campaign/Form/Task/Release.php @@ -132,7 +132,7 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index bdee47493e..f56416c21e 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -153,7 +153,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Campaign/Form/Task/Result.php b/CRM/Campaign/Form/Task/Result.php index 35bb0346a5..9422aad75e 100755 --- a/CRM/Campaign/Form/Task/Result.php +++ b/CRM/Campaign/Form/Task/Result.php @@ -49,7 +49,7 @@ class CRM_Campaign_Form_Task_Result extends CRM_Campaign_Form_Task { function preProcess() {} /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index fc99f58f48..00f4d73a07 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -200,8 +200,7 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { * * @return array */ - public static function getCampaignSummary($params = array( - )) { + public static function getCampaignSummary($params = array()) { $campaignsData = array(); //get the campaigns. @@ -294,8 +293,7 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { * * @return array */ - function getSurveySummary($params = array( - )) { + function getSurveySummary($params = array()) { $surveysData = array(); //get the survey. @@ -395,8 +393,7 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { * * @return array */ - function getPetitionSummary($params = array( - )) { + function getPetitionSummary($params = array()) { $config = CRM_Core_Config::singleton(); $petitionsData = array(); diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index 6503d851dc..f5fdd4e218 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -207,7 +207,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * function to get userContext params + * get userContext params * * @param int $mode mode that we are in * diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 31ea9e3244..6bbab7eb3e 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -177,7 +177,6 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM TRUE ); } - //end of constructor /** * This method returns the links that are given for each search row. @@ -199,9 +198,8 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -310,7 +308,6 @@ FROM {$from} } /** - * * @return array $qill which contains an array of strings * @access public **/ @@ -381,5 +378,4 @@ FROM {$from} return ts('CiviCRM Respondent Search'); } } -//end of class diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 394dc02e10..8ffb08a019 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -63,9 +63,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * * @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_Case_BAO_Case object + * @return CRM_Case_BAO_Case object * @access public * @static */ @@ -105,9 +103,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * * @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_Case_BAO_Case object + * @return CRM_Case_BAO_Case object * @access public * @static */ @@ -251,7 +247,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * in a hierarchical manner * @param array $ids (reference) the array that holds all the db ids * - * @return object CRM_Case_BAO_Case object + * @return CRM_Case_BAO_Case object * @access public * @static */ @@ -261,7 +257,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Function to process case activity add/delete + * process case activity add/delete * takes an associative array and * * @param array $params (reference ) an assoc array of name/value pairs @@ -279,7 +275,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Function to get the case subject for Activity + * get the case subject for Activity * * @param int $activityId activity id * @@ -297,7 +293,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Function to get the case type. + * get the case type. * * @param int $caseId * @@ -446,8 +442,6 @@ WHERE civicrm_case.id = %1"; * * @param $activityId * - * @internal param $activity_id - * * @return int, case ID */ static function getCaseIdByActivityId($activityId) { @@ -515,10 +509,8 @@ WHERE civicrm_case.id = %1"; * * @param $contactID * @param boolean $includeDeleted include the deleted cases in result - * * @param null $caseType * - * @internal param int $contactId ID of the contact * @return array * * @access public @@ -1900,10 +1892,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param $caseId * @param int $relationshipId relationship id * @param int $relContactId case role assignee contactId. - * * @param null $contactId * - * @internal param int $caseID case id * @return void on success creates activity and case activity * * @static diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 4add3227cb..d5bf0e1c94 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -48,7 +48,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { static $_exportableFields = NULL; /** - * takes an associative array and creates a Case Type object + * Takes an associative array and creates a Case Type object * * the function extract all the params it needs to initialize the create a * case type object. the params array could contain additional unused name/value @@ -56,9 +56,9 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * * @param array $params (reference ) an assoc array of name/value pairs * - * @internal param array $ids the array that holds all the db ids + * @throws CRM_Core_Exception * - * @return object CRM_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType object * @access public * @static */ @@ -98,7 +98,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** - * Function to format / convert submitted array to xml for case type definition + * format / convert submitted array to xml for case type definition * * @param string $name * @param array $definition the case-type defintion expressed as an array-tree @@ -179,7 +179,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * Function to get the case definition either from db or read from xml file + * get the case definition either from db or read from xml file * * @param SimpleXmlElement $xml a single case-type record * @@ -245,8 +245,6 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * @param array $params input parameters to find object * @param array $values output values of the object * - * @internal param array $ids the array that holds all the db ids - * * @return CRM_Case_BAO_CaseType|null the found object or null * @access public * @static @@ -268,9 +266,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * * @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_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType object * @access public * @static */ @@ -313,9 +309,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * @param array $defaults (reference ) an assoc array to hold the name / value pairs * in a hierarchical manner * - * @internal param array $ids (reference) the array that holds all the db ids - * - * @return object CRM_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType object * @access public * @static */ @@ -327,6 +321,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** * @param $caseTypeId * + * @throws CRM_Core_Exception * @return mixed */ static function del($caseTypeId) { diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index bb4b7ba1f8..882121d0ba 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -700,7 +700,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void * @static diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 0a44211051..8f2a4f5006 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -68,7 +68,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { public $_relatedContacts; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -219,7 +219,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -361,8 +361,6 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { * @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 * @static @@ -377,7 +375,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index 68ad2fcd67..dcf01b33d4 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { /** - * @param $form + * @param CRM_Core_Form $form * * @throws Exception */ @@ -54,12 +54,12 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -89,7 +89,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildQuickForm(&$form) { $form->removeElement('status_id'); @@ -107,7 +107,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * @param array $values posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -118,12 +118,12 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return void */ @@ -134,12 +134,12 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $activity * * @return void diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index ae670cde6a..e82eced06e 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { /** - * @param $form + * @param CRM_Core_Form $form * * @throws Exception */ @@ -51,12 +51,12 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -69,7 +69,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildQuickForm(&$form) { $form->removeElement('status_id'); @@ -107,7 +107,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * @param array $values posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -118,12 +118,12 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return void */ @@ -132,12 +132,12 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $activity * * @return void diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index bef3ba76ad..ff41a8d343 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { /** - * @param $form + * @param CRM_Core_Form $form * * @throws Exception */ @@ -51,12 +51,12 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -73,7 +73,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildQuickForm(&$form) { $form->removeElement('status_id'); @@ -104,7 +104,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { * @param array $values posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -115,12 +115,12 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return void */ @@ -139,12 +139,12 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $activity * * @return void diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 2c4be8a264..e86c14df18 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -39,7 +39,7 @@ */ class CRM_Case_Form_Activity_LinkCases { /** - * @param $form + * @param CRM_Core_Form $form * * @throws Exception */ @@ -70,12 +70,12 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -84,7 +84,7 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildQuickForm(&$form) { $form->add('text', 'link_to_case_id', ts('Link To Case'), array('class' => 'huge'), TRUE); @@ -96,7 +96,7 @@ class CRM_Case_Form_Activity_LinkCases { * @param array $values posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -121,24 +121,24 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return void */ static function beginPostProcess(&$form, &$params) {} /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $activity * * @return void diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index eef261d881..f7347a177d 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -48,7 +48,7 @@ class CRM_Case_Form_Activity_OpenCase { public $_contactID; /** - * @param $form + * @param CRM_Core_Form $form */ static function preProcess(&$form) { //get multi client case configuration @@ -90,12 +90,12 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -210,12 +210,12 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * Function to process the form + * Process the form submission * * @access public * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return void */ @@ -255,9 +255,7 @@ class CRM_Case_Form_Activity_OpenCase { * * @param $fields * @param $files - * @param $form - * - * @internal param array $values posted values of the form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -273,12 +271,12 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * Function to process the form + * Process the form submission * * @access public * * @param $form - * @param $params + * @param array $params * * @return void */ diff --git a/CRM/Case/Form/ActivityChangeStatus.php b/CRM/Case/Form/ActivityChangeStatus.php index 6182d79ef7..d2cd184595 100644 --- a/CRM/Case/Form/ActivityChangeStatus.php +++ b/CRM/Case/Form/ActivityChangeStatus.php @@ -40,7 +40,7 @@ class CRM_Case_Form_ActivityChangeStatus extends CRM_Core_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Form/ActivityToCase.php b/CRM/Case/Form/ActivityToCase.php index 39830d00dd..66672c9da7 100644 --- a/CRM/Case/Form/ActivityToCase.php +++ b/CRM/Case/Form/ActivityToCase.php @@ -57,7 +57,7 @@ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -91,7 +91,7 @@ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Form/ActivityView.php b/CRM/Case/Form/ActivityView.php index 6321c23f73..850a055947 100644 --- a/CRM/Case/Form/ActivityView.php +++ b/CRM/Case/Form/ActivityView.php @@ -40,7 +40,7 @@ class CRM_Case_Form_ActivityView extends CRM_Core_Form { /** - * Function to process the view + * process the view * * @access public * diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index e7d3b43109..c9a8f4f9db 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -87,7 +87,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { public $_caseTypeId = NULL; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -204,7 +204,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -317,7 +317,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { * @param array $values posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -328,7 +328,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php index 4afcca68ea..187d4576cf 100644 --- a/CRM/Case/Form/CaseView.php +++ b/CRM/Case/Form/CaseView.php @@ -38,14 +38,14 @@ * */ class CRM_Case_Form_CaseView extends CRM_Core_Form { - /* - * check for merge cases. - */ - + /** + * check for merge cases. + * @var bool + */ private $_mergeCases = FALSE; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -193,7 +193,7 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -206,7 +206,7 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Form/CustomData.php b/CRM/Case/Form/CustomData.php index f0dce0724b..8187bf5b1d 100644 --- a/CRM/Case/Form/CustomData.php +++ b/CRM/Case/Form/CustomData.php @@ -111,7 +111,7 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Form/EditClient.php b/CRM/Case/Form/EditClient.php index f1663b6abc..c517a7f61a 100644 --- a/CRM/Case/Form/EditClient.php +++ b/CRM/Case/Form/EditClient.php @@ -76,7 +76,7 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -106,7 +106,7 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** * @param $vals * @param $rule - * @param $form + * @param CRM_Core_Form $form * * @return array */ diff --git a/CRM/Case/Form/Report.php b/CRM/Case/Form/Report.php index 4ee00407b0..09f518b766 100644 --- a/CRM/Case/Form/Report.php +++ b/CRM/Case/Form/Report.php @@ -57,7 +57,7 @@ class CRM_Case_Form_Report extends CRM_Core_Form { public $_report = NULL; /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -118,7 +118,7 @@ class CRM_Case_Form_Report extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index c2b74f8f1f..a19c562228 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -172,7 +172,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * @@ -334,8 +334,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { * * @param array $fields posted values of the form * - * @internal param array $errors list of errors to be posted back to the form - * * @return void * @static * @access public diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index 53c293d897..8c65d7d966 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -80,7 +80,7 @@ class CRM_Case_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -154,12 +154,10 @@ class CRM_Case_Form_Task extends CRM_Core_Form { * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $nextType + * @param string $nextType button type for the form after processing * @param string $backType * @param bool $submitOnce * - * @internal param string $type button type for the form after processing - * * @return void * @access public */ diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index 7154926611..aab4919a67 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -69,7 +69,7 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Case/Form/Task/Print.php b/CRM/Case/Form/Task/Print.php index 59459461db..dfdbfff309 100644 --- a/CRM/Case/Form/Task/Print.php +++ b/CRM/Case/Form/Task/Print.php @@ -68,7 +68,7 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index b758e4b66c..cdf161ab28 100644 --- a/CRM/Case/Form/Task/Restore.php +++ b/CRM/Case/Form/Task/Restore.php @@ -58,7 +58,7 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Case/Form/Task/Result.php b/CRM/Case/Form/Task/Result.php index 908c9d4544..aea40165a2 100644 --- a/CRM/Case/Form/Task/Result.php +++ b/CRM/Case/Form/Task/Result.php @@ -49,7 +49,7 @@ class CRM_Case_Form_Task_Result extends CRM_Case_Form_Task { function preProcess() {} /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Form/Task/SearchTaskHookSample.php b/CRM/Case/Form/Task/SearchTaskHookSample.php index 6f473ad212..5b11e1132f 100644 --- a/CRM/Case/Form/Task/SearchTaskHookSample.php +++ b/CRM/Case/Form/Task/SearchTaskHookSample.php @@ -73,7 +73,7 @@ WHERE cs.id IN ( {$caseIDs} )"; } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Case/Page/AJAX.php b/CRM/Case/Page/AJAX.php index 6b83546414..b7f3b97710 100644 --- a/CRM/Case/Page/AJAX.php +++ b/CRM/Case/Page/AJAX.php @@ -185,7 +185,7 @@ class CRM_Case_Page_AJAX { } /** - * Function to delete relationships specific to case and relationship type + * delete relationships specific to case and relationship type */ static function deleteCaseRoles() { $caseId = CRM_Utils_Type::escape($_POST['case_id'], 'Integer'); diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index cc97a36e66..724ae99f05 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -176,7 +176,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { $this->_query->_distinctComponentClause = " civicrm_case.id "; $this->_query->_groupByComponentClause = " GROUP BY civicrm_case.id "; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -246,15 +245,13 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { return $actionLinks; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -270,7 +267,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -414,7 +410,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * * @return array $qill which contains an array of strings * @access public */ @@ -514,5 +509,4 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { return ts('Case Search'); } } -//end of class diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index c7cf7b78ee..8c7b5fb10c 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -35,7 +35,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** * @param $caseType - * @param $params + * @param array $params * * @throws Exception */ @@ -89,7 +89,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** * @param $xml - * @param $params + * @param array $params * * @throws Exception */ @@ -142,7 +142,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** * @param $activitySetXML - * @param $params + * @param array $params */ function processStandardTimeline($activitySetXML, &$params) { if ('Change Case Type' == CRM_Utils_Array::value('activityTypeName', $params) @@ -160,7 +160,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** * @param $activitySetXML - * @param $params + * @param array $params */ function processActivitySet($activitySetXML, &$params) { foreach ($activitySetXML->ActivityTypes as $activityTypesXML) { @@ -203,7 +203,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** * @param $relationshipTypeName - * @param $params + * @param array $params * * @return bool * @throws Exception @@ -245,7 +245,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { } /** - * @param $params + * @param array $params * * @return bool */ @@ -355,7 +355,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { } /** - * @param $params + * @param array $params */ function deleteEmptyActivity(&$params) { $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name'); @@ -375,7 +375,7 @@ AND a.is_current_revision = 1 } /** - * @param $params + * @param array $params * * @return bool */ @@ -403,7 +403,7 @@ AND a.is_deleted = 0 /** * @param $activityTypeXML - * @param $params + * @param array $params * * @return bool * @throws CRM_Core_Exception diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 6cef74c6e0..872dbf6914 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -50,7 +50,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { * @param $clientID * @param $caseID * @param $activitySetName - * @param $params + * @param array $params * * @return mixed */ @@ -722,8 +722,7 @@ LIMIT 1 * * @return mixed */ - private function redact($string, $printReport = FALSE, $replaceString = array( - )) { + private function redact($string, $printReport = FALSE, $replaceString = array()) { if ($printReport) { return CRM_Utils_String::redaction($string, $replaceString); } @@ -738,8 +737,8 @@ LIMIT 1 * @param $clientID * @param $caseID * @param $activitySetName - * @param $params - * @param $form + * @param array $params + * @param CRM_Core_Form $form * * @return mixed */ diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 7c18d9f2d6..998a9ab1b8 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -111,7 +111,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ @@ -261,7 +261,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { } /** - * Function to create contact + * create contact * takes an associative array and creates a contact object and all the associated * derived objects (i.e. individual, location, email, phone etc) * @@ -274,7 +274,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * @param bool $skipDelete * * @throws Exception - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ @@ -551,7 +551,6 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * * Get the values for pseudoconstants for name->value and reverse. * * @param array $defaults (reference) the default values, some of which need to be resolved. @@ -682,18 +681,14 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @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 boolean $microformat for location in microformat * - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ @@ -735,7 +730,7 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * function to get the display name of a contact + * get the display name of a contact * * @param int $id id of the contact * @@ -883,7 +878,7 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * function to delete the image of a contact + * delete the image of a contact * * @param int $id id of the contact * @@ -902,12 +897,10 @@ WHERE id={$id}; "; } /** - * function to return relative path + * Return relative path * @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function * - * @param $absolutePath - * - * @internal param String $absPath absolute path + * @param string $absolutePath absolute path * * @return String $relativePath Relative url of uploaded image */ @@ -970,18 +963,12 @@ WHERE id={$id}; "; } /** - * function to validate type of contact image + * Validate type of contact image * - * @param $params + * @param array $params * @param String $imageIndex index of image field - * * @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 + * @param string $opType type of operation like fatal, bounce etc * * @return boolean true if valid image extension */ @@ -1614,7 +1601,6 @@ WHERE id={$id}; "; * @param $fields * @param int $contactId contact id * - * @internal param array $properties a flat return properties name value array * @return array a hierarchical property tree if appropriate * @access public * @static @@ -1791,21 +1777,16 @@ ORDER BY civicrm_email.is_primary DESC"; /** * function to add/edit/register contacts through profile. * - * @params array $params Array of profile fields to be edited/added. - * @params int $contactID contact_id of the contact to be edited/added. - * @params array $fields array of fields from UFGroup - * @params int $addToGroupID specifies the default group to which contact is added. - * @params int $ufGroupId uf group id (profile id) - * @param $params - * @param $fields - * @param null $contactID - * @param null $addToGroupID - * @param null $ufGroupId - * @param string $ctype contact type - * @param boolean $visibility basically lets us know where this request is coming from + * @param array $params Array of profile fields to be edited/added. + * @param array $fields Array of fields from UFGroup + * @param int $contactID id of the contact to be edited/added. + * @param int $addToGroupID specifies the default group to which contact is added. + * @param int $ufGroupId uf group id (profile id) + * @param ctype + * @param boolean $visibility basically lets us know where this request is coming from * if via a profile from web, we restrict what groups are changed * - * @return int contact id created/edited + * @return int contact id created/edited * @static * @access public */ @@ -1901,7 +1882,7 @@ ORDER BY civicrm_email.is_primary DESC"; } /** - * @param $params + * @param array $params * @param $fields * @param null $contactID * @param null $ufGroupId diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 72fcf7b451..e7e6d38bff 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_Contact_Location { /** - * function to get the display name, primary email, location type and location id of a contact + * get the display name, primary email, location type and location id of a contact * * @param int $id id of the contact * @@ -76,7 +76,7 @@ WHERE civicrm_contact.id = %1"; } /** - * function to get the sms number and display name of a contact + * get the sms number and display name of a contact * * @param int $id id of the contact * @@ -114,7 +114,7 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id ) } /** - * function to get the information to map a contact + * get the information to map a contact * * @param array $ids the list of ids for which we want map info * $param int $locationTypeID diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index d93dea976a..fa36c3fe7a 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -83,11 +83,10 @@ WHERE contact_a.id = %1 AND $permission"; /** * fill the acl contact cache for this contact id if empty * - * @param $userID + * @param int $userID * @param int|string $type the type of operation (view|edit) * @param boolean $force should we force a recompute * - * @internal param int $id contact id * @return void * @access public * @static @@ -150,7 +149,7 @@ ON DUPLICATE KEY UPDATE } /** - * Function to check if there are any contacts in cache table + * check if there are any contacts in cache table * * @param int|string $type the type of operation (view|edit) * @param int $contactID contact id @@ -241,16 +240,13 @@ AND $operationClause LIMIT 1"; } /** - * Function to get the permission base on its relationship + * get the permission base on its relationship * - * @param $selectedContactID - * @param null $contactID - * - * @internal param int $selectedContactId contact id of selected contact - * @internal param int $contactId contact id of the current contact + * @param int $selectedContactID contact id of selected contact + * @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 + * @return bool true if logged in user has permission to view + * selected contact record else false * @static */ static function relationship($selectedContactID, $contactID = NULL) { @@ -336,7 +332,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR /** * @param $contactID - * @param $form + * @param CRM_Core_Form $form * @param bool $redirect * * @return bool @@ -390,7 +386,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR /** * @param $contactID - * @param $form + * @param CRM_Core_Form $form * @param bool $redirect * * @return bool diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 7a51fba6c3..13c649ff48 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -246,7 +246,7 @@ WHERE id IN ( $idString ) } /** - * Function to get the count of contact loctions + * get the count of contact loctions * * @param int $contactId contact id * @@ -277,9 +277,8 @@ UNION * * @param int $contactID contact id of the individual * @param $organization (id or name) - * @param null $previousEmployerID - * - * @internal param string $organization it can be name or id of organization + * @param int $previousEmployerID + * @param bool $newContact * * @access public * @static @@ -391,7 +390,7 @@ UNION } /** - * Function to set current employer id and organization name + * set current employer id and organization name * * @param array $currentEmployerParams associated array of contact id and its employer id * @@ -409,7 +408,7 @@ WHERE contact_a.id ={$contactId} AND contact_b.id={$orgId}; "; } /** - * Function to update cached current employer name + * update cached current employer name * * @param int $organizationId current employer id * @@ -471,14 +470,12 @@ WHERE id={$contactId}; "; /** * Function to build form for related contacts / on behalf of organization. * - * @param $form object invoking Object + * @param CRM_Core_Form $form * @param $contactType string contact type * @param $countryID * @param $stateID * @param $title string fieldset title * - * @internal param int $maxLocationBlocks number of location blocks - * * @static */ static function buildOnBehalfForm(&$form, $contactType, $countryID, $stateID, $title) { @@ -677,8 +674,7 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) * * @return array $contactDetails array of contact info.@static */ - static function contactDetails($componentIds, $componentName, $returnProperties = array( - )) { + static function contactDetails($componentIds, $componentName, $returnProperties = array()) { $contactDetails = array(); if (empty($componentIds) || !in_array($componentName, array('CiviContribute', 'CiviMember', 'CiviEvent', 'Activity')) @@ -907,7 +903,7 @@ Group By componentId"; } /** - * @param $params + * @param array $params * * @throws Exception */ diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 77657dd27c..124fa0b65e 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -35,16 +35,12 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contact_BAO_ContactType object on success, null otherwise + * @return CRM_Contact_BAO_ContactType object on success, null otherwise * @access public * @static */ @@ -70,8 +66,7 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { } /** - * - *function to retrieve basic contact type information. + * Retrieve basic contact type information. * * @param bool $all * @@ -117,8 +112,7 @@ WHERE parent_id IS NULL } /** - * - *function to retrieve all basic contact types. + * Retrieve all basic contact types. * * @param bool $all * @@ -147,8 +141,7 @@ WHERE parent_id IS NULL } /** - * - *function to retrieve all subtypes Information. + * Retrieve all subtypes Information. * * @param array $contactType . * @param bool $all @@ -216,7 +209,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} /** * - *function to retrieve all subtypes + * retrieve all subtypes * * @param array $contactType . * @param bool $all @@ -238,7 +231,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} /** * - *function to retrieve subtype pairs with name as 'subtype-name' and 'label' as value + * retrieve subtype pairs with name as 'subtype-name' and 'label' as value * * @param array $contactType . * @param bool $all @@ -260,7 +253,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} /** * - *function to retrieve list of all types i.e basic + subtypes. + * retrieve list of all types i.e basic + subtypes. * * @param bool $all * @@ -273,7 +266,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} /** * - *function to retrieve info array about all types i.e basic + subtypes. + * retrieve info array about all types i.e basic + subtypes. * * @param bool $all * @param bool $reset @@ -332,15 +325,13 @@ WHERE type.name IS NOT NULL } /** - * - *function to retrieve basic type pairs with name as 'built-in name' and 'label' as value + * Retrieve basic type pairs with name as 'built-in name' and 'label' as value * * @param bool $all * @param null $typeName * @param null $delimiter * - * @internal param array $contactType . - * @return list of basictypes with name as 'built-in name' and 'label' as value + * @return array of basictypes with name as 'built-in name' and 'label' as value * @static */ static function contactTypePairs($all = FALSE, $typeName = NULL, $delimiter = NULL) { @@ -449,7 +440,7 @@ AND ( p.is_active = 1 OR p.id IS NULL ) } /** - * function to check if a given type is a subtype + * check if a given type is a subtype * * @param string $subType contact subType. * @param bool $ignoreCache @@ -462,8 +453,7 @@ AND ( p.is_active = 1 OR p.id IS NULL ) } /** - *function to retrieve the basic contact type associated with - *given subType. + * retrieve the basic contact type associated with given subType. * *@param array/string $subType contact subType. *@return array/string of basicTypes. @@ -504,14 +494,12 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** + * Suppress all subtypes present in given array. * - *function to suppress all subtypes present in given array. - * - * @param $subTypes + * @param array $subTypes contact subTypes * @param bool $ignoreCache * - * @internal param array $subType contact subType. - * @return array of suppresssubTypes . + * @return array of suppressed subTypes. * @static */ static function suppressSubTypes(&$subTypes, $ignoreCache = FALSE) { @@ -520,8 +508,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * - *function to verify if a given subtype is associated with a given basic contact type. + * verify if a given subtype is associated with a given basic contact type. * * @param string $subType contact subType * @param string $contactType contact Type @@ -541,12 +528,10 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** + * create shortcuts menu for contactTypes * - *function to create shortcuts menu for contactTypes - * - *@return array of contactTypes - *@static - * + * @return array of contactTypes + * @static */ static function getCreateNewList() { $shortCuts = array(); @@ -580,7 +565,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * Function to delete Contact SubTypes + * delete Contact SubTypes * * @param int $contactTypeId ID of the Contact Subtype to be deleted. * @@ -843,8 +828,7 @@ LIMIT 1"; * * @return array */ - static function getSubtypeCustomPair($contactType, $subtypeSet = array( - )) { + static function getSubtypeCustomPair($contactType, $subtypeSet = array()) { if (empty($subtypeSet)) { return $subtypeSet; } diff --git a/CRM/Contact/BAO/DashboardContact.php b/CRM/Contact/BAO/DashboardContact.php index 06d3420854..34a8b6eb5b 100644 --- a/CRM/Contact/BAO/DashboardContact.php +++ b/CRM/Contact/BAO/DashboardContact.php @@ -26,7 +26,6 @@ */ /** - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index c33a9319a2..3207a65153 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -51,7 +51,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contact_BAO_Group object + * @return CRM_Contact_BAO_Group object * @access public * @static */ @@ -67,7 +67,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Function to delete the group and all the object that connect to + * delete the group and all the object that connect to * this group. Incredibly destructive * * @param int $id group id @@ -204,9 +204,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param $groupID * @param bool $useCache * - * @internal param int $lngGroupId this is group id - * - * @return array $aMembers this arrray contains the list of members for this group id + * @return array $aMembers this array contains the list of members for this group id * @access public * @static */ @@ -226,7 +224,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Returns array of group object(s) matching a set of one or Group properties. * - * @param null $params + * @param array $params Limits the set of groups returned. * @param array $returnProperties Which properties should be included in the returned group objects. * (member_count should be last element.) * @@ -234,9 +232,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param null $offset * @param null $rowCount * - * @internal param array $param Array of one or more valid property_name=>value pairs. - * Limits the set of groups returned. - * @return An array of group objects. + * @return array of group objects. * * @access public * @@ -611,10 +607,6 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * get permission relevant clauses * CRM-12209 * - * @internal param $existingClauses - * - * @internal param $clauses - * * @param bool $force * * @return array @@ -1123,7 +1115,7 @@ WHERE id IN $groupIdString } /** - * @param $params + * @param array $params * * @return null|string */ @@ -1143,7 +1135,7 @@ WHERE {$whereClause}"; /** * Generate permissioned where clause for group search - * @param $params + * @param array $params * @param bool $sortBy * @param bool $excludeHidden * @@ -1234,7 +1226,7 @@ WHERE {$whereClause}"; } /** - * Function to define action links + * define action links * * @return array $links array of action links * @access public diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 28aefe2244..bcfdb2d8d6 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -50,7 +50,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Contact_BAO_Group object + * @return CRM_Contact_BAO_Group object * @access public * @static */ @@ -93,8 +93,6 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param array $params input parameters to find object * @param array $values output values of the object * - * @internal param array $ids the array that holds all the db ids - * * @return array (reference) the values that could be potentially assigned to smarty * @access public * @static @@ -268,7 +266,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { } /** - * Function to get list of all the groups and groups for a contact + * get list of all the groups and groups for a contact * * @param int $contactId contact id * @@ -311,7 +309,7 @@ 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 + * get the list of groups for contact based on status of group membership * * @param int $contactId contact id * @param string $status state of membership @@ -694,13 +692,11 @@ AND group_id IN ( $groupIDString ) /** * Given an array of contact ids, add all the contacts to the group * - * @param $contactIDs - * @param $groupID + * @param array $contactIDs the array of contact ids to be added + * @param int $groupID the id of the group * @param string $method * @param string $status * @param null $tracking - * @internal param array $contactIds (reference ) the array of contact ids to be added - * @internal param int $groupId the id of the group * * @return array (total, added, notAdded) count of contacts added to group * @access public diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index a88d317325..4205fcddee 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -40,9 +40,7 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * Check to see if we have cache entries for this group * if not, regenerate, else return * - * @param $groupIDs - * - * @internal param int $groupID groupID of group that we are checking against + * @param $groupIDs of group that we are checking against * * @return boolean true if we did not regenerate, false if we did */ diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index dc656cd9d7..6842abe134 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -277,14 +277,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 $parentID - * @param $childID + * @param int $parentID id of the group to add the child to + * @param int $childID id of the new child group * - * @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 * + * @return void * @access public */ static function add($parentID, $childID) { @@ -317,9 +314,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * identified by $groupId; does not delete child group, just the * association between the two * - * @param $childID The id of the child group being removed + * @param int $childID The id of the child group being removed * - * @internal param \The $parentID id of the group to remove the child from * @return void * * @access public diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 0240fdfcd5..4f02128b04 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -123,9 +123,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Method to check group organization relationship exist * - * @param $contactID - * - * @internal param int $contactId + * @param int $contactID * * @return boolean * @access public @@ -142,7 +140,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * Function to delete Group Organization + * delete Group Organization * * @param int $groupOrganizationID group organization id that needs to be deleted * diff --git a/CRM/Contact/BAO/Household.php b/CRM/Contact/BAO/Household.php index 591b6cab48..3fac04ba15 100644 --- a/CRM/Contact/BAO/Household.php +++ b/CRM/Contact/BAO/Household.php @@ -42,7 +42,7 @@ class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact { } /** - * function to update the household with primary contact id + * update the household with primary contact id * * @param integer $primaryContactId null if deleting primary contact * @param integer $contactId contact id diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 851bfc1845..341781d20b 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -49,7 +49,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { * @param array $params (reference ) an assoc array of name/value pairs * @param array $contact contact object * - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 82b0ba67e2..118d36d88a 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -2263,7 +2263,7 @@ class CRM_Contact_BAO_Query { /** * Given a result dao, extract the values and return that array * - * @param Object $dao + * @param CRM_Core_DAO $dao * * @return array values for this query */ @@ -4366,11 +4366,10 @@ civicrm_relationship.is_permission_a_b = 0 * @param string $sort * @param int $offset * @param int $row_count - * @param bool $smartGroupCache + * @param bool $smartGroupCache ?? update smart group cache? * @param bool $count return count obnly * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied * - * @params bool $smartGroupCache ?? update smart group cache? * * @return array * @access public @@ -5388,14 +5387,12 @@ AND displayRelType.is_active = 1 * @param $op string the sql operator, this function should handle ALL SQL operators * @param $value string|integer|array depends on the operator and who's calling the query builder * @param $grouping int the index where to place the where clause - * @param $selectValues + * @param $selectValues the key value pairs for this element. This allows us to use this function for things besides option-value pairs * @param $field array an array that contains various properties of the field identified by $name * @param $label string The label for this field element * @param $dataType string The data type for this element - * * @param bool $useIDsOnly * - * @internal param array $selectValue the key value pairs for this element. This allows us to use this function for things besides option-value pairs * @return void adds the where clause and qill to the query object */ function optionValueQuery( @@ -5466,7 +5463,7 @@ AND displayRelType.is_active = 1 } /** - * function to check and explode a user defined numeric string into an array + * check and explode a user defined numeric string into an array * this was the protocol used by search builder in the old old days before we had * super nice js widgets to do the hard work * diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index 234d584fe6..33d9b0eacd 100644 --- a/CRM/Contact/BAO/Query/Hook.php +++ b/CRM/Contact/BAO/Query/Hook.php @@ -146,7 +146,7 @@ class CRM_Contact_BAO_Query_Hook { } /** - * @param $form + * @param CRM_Core_Form $form * @param $type */ public function buildAdvancedSearchPaneForm(&$form, $type) { diff --git a/CRM/Contact/BAO/Query/Interface.php b/CRM/Contact/BAO/Query/Interface.php index 26e6303e2b..36a072fb35 100644 --- a/CRM/Contact/BAO/Query/Interface.php +++ b/CRM/Contact/BAO/Query/Interface.php @@ -86,7 +86,7 @@ abstract class CRM_Contact_BAO_Query_Interface { } /** - * @param $form + * @param CRM_Core_Form $form * @param $type * * @return null diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index d5f0a02e03..839941d17c 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -50,7 +50,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer * "we are moving away from the $ids param " * - * @return object CRM_Contact_BAO_Relationship object + * @return CRM_Contact_BAO_Relationship object * @access public * @static */ @@ -194,7 +194,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * @param integer $contactId this is contact id for adding relationship * @param array $ids the array that holds all the db ids * - * @return object CRM_Contact_BAO_Relationship + * @return CRM_Contact_BAO_Relationship * @access public * @static */ @@ -303,7 +303,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Function to get get list of relationship type based on the contact type. + * get get list of relationship type based on the contact type. * * @param int $contactId this is the contact id of the current contact. * @param null $contactSuffix @@ -311,15 +311,11 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * @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 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 * @@ -455,7 +451,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Function to delete the relationship + * delete the relationship * * @param int $id relationship id * @@ -504,7 +500,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Function to disable/enable the relationship + * disable/enable the relationship * * @param int $id relationship id * @@ -774,7 +770,6 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * * @param array $params input parameters to find object * @param array $values output values of the object - * @internal param array $ids the array that holds all the db ids * * @return array (reference) the values that could be potentially assigned to smarty * @access public diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index b41a21afda..f20b58f1cb 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -42,16 +42,12 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contact_BAO_RelationshipType object + * @return CRM_Contact_BAO_RelationshipType object * @access public * @static */ @@ -80,12 +76,12 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * Function to add the relationship type in the db + * add the relationship type in the db * * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids the array that holds all the db ids * - * @return object CRM_Contact_DAO_RelationshipType + * @return CRM_Contact_DAO_RelationshipType * @access public * @static * @@ -135,7 +131,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * Function to delete Relationship Types + * delete Relationship Types * * @param int $relationshipTypeId * diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index b13a2f35fd..29ce54c14b 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -73,7 +73,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contact_BAO_SavedSearch + * @return CRM_Contact_BAO_SavedSearch * @access public * @static */ diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 056d50ff05..0f05b38960 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -385,7 +385,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -715,7 +715,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -1104,14 +1104,13 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Function to that checks for duplicate contacts + * that checks for duplicate contacts * * @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 @@ -1179,9 +1178,6 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @return string * @access public */ - /** - * @return string - */ function getTemplateFileName() { if ($this->_contactSubType) { $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl"; @@ -1199,9 +1195,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * This function either parse street address in to child * elements or build street address from child elements. * - * @params $params an array of key value consist of address blocks. - * - * @param $params + * @param $params array of key value consist of address blocks. * * @return array $parseSuccess as array of sucess/fails for each address block@static */ diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php index 1a5f9893a8..9e9a6425aa 100644 --- a/CRM/Contact/Form/CustomData.php +++ b/CRM/Contact/Form/CustomData.php @@ -175,7 +175,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Form/DedupeFind.php b/CRM/Contact/Form/DedupeFind.php index bd654dd4bb..5fcb98e83b 100644 --- a/CRM/Contact/Form/DedupeFind.php +++ b/CRM/Contact/Form/DedupeFind.php @@ -46,7 +46,7 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { public $_defaults; /** - * Function to pre processing + * pre processing * * @return void * @access public @@ -56,7 +56,7 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -86,7 +86,7 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index faa8c5bc93..2b125e8f58 100644 --- a/CRM/Contact/Form/DedupeRules.php +++ b/CRM/Contact/Form/DedupeRules.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { protected $_rgid; /** - * Function to pre processing + * pre processing * * @return void * @access public @@ -95,7 +95,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -175,7 +175,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -190,7 +190,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 801c555d85..2ae812ce7c 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -91,7 +91,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /* - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -150,7 +150,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index 676c4282e5..654ec493b7 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Edit_Address { /** * build form for address input fields * - * @param object $form - CRM_Core_Form (or subclass) + * @param CRM_Core_Form $form * @param int $addressBlockCount - the index of the address array (if multiple addresses on a page) * @param boolean $sharing - false, if we want to skip the address sharing features * @param boolean $inlineEdit true when edit used in inline edit @@ -259,11 +259,7 @@ class CRM_Contact_Form_Edit_Address { * @param $files * @param $self * - * @internal param \reference $array $fields - submitted form values. - * @internal param \reference $array $errors - if any errors found add to this array. please. - * - * @return true if no errors - * array of errors if any present. + * @return array|bool if no errors * * @access public * @static @@ -316,10 +312,10 @@ class CRM_Contact_Form_Edit_Address { } /** - * function to set default values for address block + * set default values for address block * * @param array $defaults defaults associated array - * @param object $form form object + * @param CRM_Core_Form $form form object * * @static * @access public @@ -419,7 +415,7 @@ class CRM_Contact_Form_Edit_Address { /** - * @param $form + * @param CRM_Core_Form $form * @param $groupTree */ static function storeRequiredCustomDataInfo(&$form, $groupTree) { diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 1c0fa4b091..1261ab57fb 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -46,7 +46,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { static $greetings = array(); /** - * build the form elements for Communication Preferences object + * Build the form object elements for Communication Preferences object * * @param CRM_Core_Form $form reference to the form object * @@ -137,8 +137,6 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { * @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 * @static @@ -159,12 +157,12 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return void diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index b1c3ceb801..a1a8e69417 100644 --- a/CRM/Contact/Form/Edit/CustomData.php +++ b/CRM/Contact/Form/Edit/CustomData.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Edit_CustomData { /** * build all the data structures needed to build the form * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -67,7 +67,7 @@ class CRM_Contact_Form_Edit_CustomData { } /** - * build the form elements for CustomData object + * Build the form object elements for CustomData object * * @param CRM_Core_Form $form reference to the form object * @@ -102,12 +102,12 @@ class CRM_Contact_Form_Edit_CustomData { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return void diff --git a/CRM/Contact/Form/Edit/Demographics.php b/CRM/Contact/Form/Edit/Demographics.php index 11c06dff6f..eb1a3d3004 100644 --- a/CRM/Contact/Form/Edit/Demographics.php +++ b/CRM/Contact/Form/Edit/Demographics.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_Demographics { /** - * build the form elements for Demographics object + * Build the form object elements for Demographics object * * @param CRM_Core_Form $form reference to the form object * @@ -66,12 +66,12 @@ class CRM_Contact_Form_Edit_Demographics { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return void diff --git a/CRM/Contact/Form/Edit/Email.php b/CRM/Contact/Form/Edit/Email.php index 5ab3c3d75a..f79fdda662 100644 --- a/CRM/Contact/Form/Edit/Email.php +++ b/CRM/Contact/Form/Edit/Email.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_Email { /** - * build the form elements for an email object + * Build the form object elements for an email object * * @param CRM_Core_Form $form reference to the form object * @param int $blockCount block number to build diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 41af922c22..94395a252b 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -40,11 +40,11 @@ */ class CRM_Contact_Form_Edit_Household { - /** + /** * This function provides the HTML form elements that are specific * to the Household Contact Type * - * @param object $form form object + * @param CRM_Core_Form $form form object * @param int $inlineEditMode ( 1 for contact summary * top bar form and 2 for display name edit ) * @@ -80,11 +80,9 @@ class CRM_Contact_Form_Edit_Household { /** * add rule for household * - * @params array $fields array of form values - * - * @param $fields - * @param $files - * @param null $contactID + * @param array $fields array of form values + * @param array $files - unused + * @param int $contactID * * @return array|bool $error@static * @public diff --git a/CRM/Contact/Form/Edit/IM.php b/CRM/Contact/Form/Edit/IM.php index 12446a2924..b92a248fc6 100644 --- a/CRM/Contact/Form/Edit/IM.php +++ b/CRM/Contact/Form/Edit/IM.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_IM { /** - * build the form elements for an IM object + * Build the form object elements for an IM object * * @param CRM_Core_Form $form reference to the form object * @param int $blockCount block number to build diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index f8a2f2d7ba..aeb44b4c98 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.php @@ -149,8 +149,6 @@ class CRM_Contact_Form_Edit_Individual { * @param array $files the uploaded files if any * @param null $contactID * - * @internal param array $options additional user data - * * @return true if no errors, else array of errors * @access public * @static diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index ff43ac489a..83dfa86763 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -40,12 +40,9 @@ class CRM_Contact_Form_Edit_Lock { /** - * This function provides the HTML form elements + * Build the form object * - * @param object $form form object - * - * @internal param int $inlineEditMode ( 1 for contact summary - * top bar form and 2 for display name edit ) + * @param CRM_Core_Form $form form object * * @access public * @return void @@ -61,8 +58,6 @@ class CRM_Contact_Form_Edit_Lock { * @param array $files the uploaded files if any * @param null $contactID * - * @internal param array $options additional user data - * * @return true if no errors, else array of errors * @access public * @static diff --git a/CRM/Contact/Form/Edit/OpenID.php b/CRM/Contact/Form/Edit/OpenID.php index 361fb95925..5573261a7d 100644 --- a/CRM/Contact/Form/Edit/OpenID.php +++ b/CRM/Contact/Form/Edit/OpenID.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_OpenID { /** - * build the form elements for an open id object + * Build the form object elements for an open id object * * @param CRM_Core_Form $form reference to the form object * @param int $blockCount block number to build diff --git a/CRM/Contact/Form/Edit/Organization.php b/CRM/Contact/Form/Edit/Organization.php index 58e4be19d7..21fb3759d3 100644 --- a/CRM/Contact/Form/Edit/Organization.php +++ b/CRM/Contact/Form/Edit/Organization.php @@ -44,7 +44,7 @@ class CRM_Contact_Form_Edit_Organization { * This function provides the HTML form elements that are specific * to the Organization Contact Type * - * @param object $form form object + * @param CRM_Core_Form $form form object * @param int $inlineEditMode ( 1 for contact summary * top bar form and 2 for display name edit ) * diff --git a/CRM/Contact/Form/Edit/Phone.php b/CRM/Contact/Form/Edit/Phone.php index 740a6f7b0d..c0b834afaf 100644 --- a/CRM/Contact/Form/Edit/Phone.php +++ b/CRM/Contact/Form/Edit/Phone.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_Phone { /** - * build the form elements for a phone object + * Build the form object elements for a phone object * * @param CRM_Core_Form $form reference to the form object * @param int $addressBlockCount block number to build diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 539f7206cb..4745134eea 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * This function is to build form elements * params object $form object of the form * - * @param Object $form the form object that we are operating on + * @param CRM_Core_Form $form the form object that we are operating on * @param int $contactId contact id * @param int $type what components are we interested in * @param boolean $visibility visibility of the field @@ -245,12 +245,12 @@ class CRM_Contact_Form_Edit_TagsAndGroups { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return void diff --git a/CRM/Contact/Form/Edit/Website.php b/CRM/Contact/Form/Edit/Website.php index b516e4f05a..e692df1359 100644 --- a/CRM/Contact/Form/Edit/Website.php +++ b/CRM/Contact/Form/Edit/Website.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_Website { /** - * build the form elements for an Website object + * Build the form object elements for an Website object * * @param CRM_Core_Form $form reference to the form object * @param int $blockCount block number to build diff --git a/CRM/Contact/Form/GroupContact.php b/CRM/Contact/Form/GroupContact.php index a6ad2c36c2..dabc858053 100644 --- a/CRM/Contact/Form/GroupContact.php +++ b/CRM/Contact/Form/GroupContact.php @@ -60,7 +60,7 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -116,7 +116,6 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { } /** - * * @access public * * @return void @@ -139,6 +138,5 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { CRM_Core_Session::setStatus(ts("Contact has been added to '%1'.", array(1 => $groups[$groupId])), ts('Added to Group'), 'success'); } } - //end of function } diff --git a/CRM/Contact/Form/Inline/Address.php b/CRM/Contact/Form/Inline/Address.php index cf7abf5302..cc1a1b9109 100644 --- a/CRM/Contact/Form/Inline/Address.php +++ b/CRM/Contact/Form/Inline/Address.php @@ -120,7 +120,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * build the form elements for an address object + * Build the form object elements for an address object * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/CommunicationPreferences.php b/CRM/Contact/Form/Inline/CommunicationPreferences.php index 3ea9588d9d..5008ab2e66 100644 --- a/CRM/Contact/Form/Inline/CommunicationPreferences.php +++ b/CRM/Contact/Form/Inline/CommunicationPreferences.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_Inline { /** - * build the form elements for communication preferences + * Build the form object elements for communication preferences * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/ContactInfo.php b/CRM/Contact/Form/Inline/ContactInfo.php index fd54e84871..f2a25ad640 100644 --- a/CRM/Contact/Form/Inline/ContactInfo.php +++ b/CRM/Contact/Form/Inline/ContactInfo.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { /** - * build the form elements + * Build the form object elements * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/ContactName.php b/CRM/Contact/Form/Inline/ContactName.php index ca01fbe72d..19f493f314 100644 --- a/CRM/Contact/Form/Inline/ContactName.php +++ b/CRM/Contact/Form/Inline/ContactName.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline { /** - * build the form elements + * Build the form object elements * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php index 523bf593b7..02e57e1698 100644 --- a/CRM/Contact/Form/Inline/CustomData.php +++ b/CRM/Contact/Form/Inline/CustomData.php @@ -69,7 +69,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * build the form elements for custom data + * Build the form object elements for custom data * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Demographics.php b/CRM/Contact/Form/Inline/Demographics.php index 464cc252c3..8a7495caf6 100644 --- a/CRM/Contact/Form/Inline/Demographics.php +++ b/CRM/Contact/Form/Inline/Demographics.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline { /** - * build the form elements + * Build the form object elements * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 57ea2b1cad..4e2ea860aa 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * build the form elements for an email object + * Build the form object elements for an email object * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index 40d7315a7e..101ca7208f 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * build the form elements for im object + * Build the form object elements for im object * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 1dcc5e2bb7..6587732a15 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -42,11 +42,8 @@ class CRM_Contact_Form_Inline_Lock { /** * This function provides the HTML form elements * - * @param object $form form object - * @param $contactID - * - * @internal param int $inlineEditMode ( 1 for contact summary - * top bar form and 2 for display name edit ) + * @param CRM_Core_Form $form form object + * @param int $contactID * * @access public * @return void @@ -72,8 +69,6 @@ class CRM_Contact_Form_Inline_Lock { * @param array $files the uploaded files if any * @param null $contactID * - * @internal param array $options additional user data - * * @return true if no errors, else array of errors * @access public * @static diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index f2053cf16f..49920d8cca 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * build the form elements for openID object + * Build the form object elements for openID object * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 31c97b7718..42e0ae27a3 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * build the form elements for phone object + * Build the form object elements for phone object * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Website.php b/CRM/Contact/Form/Inline/Website.php index 674866bbfc..af51305a69 100644 --- a/CRM/Contact/Form/Inline/Website.php +++ b/CRM/Contact/Form/Inline/Website.php @@ -61,7 +61,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * build the form elements for website object + * Build the form object elements for website object * * @return void * @access public diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index 2dac108a67..5e49549418 100644 --- a/CRM/Contact/Form/Location.php +++ b/CRM/Contact/Form/Location.php @@ -35,9 +35,9 @@ class CRM_Contact_Form_Location { /** - * Function to set variables up before form is built + * set variables up before form is built * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -74,9 +74,9 @@ class CRM_Contact_Form_Location { } /** - * Function to build the form + * Build the form object * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public diff --git a/CRM/Contact/Form/ProfileContact.php b/CRM/Contact/Form/ProfileContact.php index b6f12cbf57..e8276c8fff 100644 --- a/CRM/Contact/Form/ProfileContact.php +++ b/CRM/Contact/Form/ProfileContact.php @@ -37,9 +37,9 @@ class CRM_Contact_Form_ProfileContact { protected $_mode; /** - * Function to set variables up before form is built + * set variables up before form is built * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -75,12 +75,9 @@ class CRM_Contact_Form_ProfileContact { } /** - * Function to build form for honoree contact / on behalf of organization. - * - * @param $form object invoking Object + * build form for honoree contact / on behalf of organization. * - * @internal param string $contactType contact type - * @internal param string $title fieldset title + * @param CRM_Core_Form $form * * @static */ diff --git a/CRM/Contact/Form/RelatedContact.php b/CRM/Contact/Form/RelatedContact.php index 4fba5517f8..e950ed69c3 100644 --- a/CRM/Contact/Form/RelatedContact.php +++ b/CRM/Contact/Form/RelatedContact.php @@ -104,7 +104,7 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -116,7 +116,7 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php index 396ff14bd3..d35d643c6f 100644 --- a/CRM/Contact/Form/Relationship.php +++ b/CRM/Contact/Form/Relationship.php @@ -211,7 +211,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * This function sets the default values for the form. Relationship that in edit/view mode + * Set default values for the form. Relationship that in edit/view mode * the default values are retrieved from the database * * @access public @@ -293,7 +293,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -541,7 +541,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * function for date validation + * date validation * * @param array $params (reference ) an assoc array of name/value pairs * diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php index f9d1d17178..077acf7c8a 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -143,14 +143,13 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { */ protected $_ufGroupID; - /* - * csv - common search values - * - * @var array - * @access protected - * @static - */ - + /** + * csv - common search values + * + * @var array + * @access protected + * @static + */ static $csv = array('contact_type', 'group', 'tag'); /** diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 2444d58c3a..77e9d5389e 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index cbeca69e38..0ed93d3016 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -53,7 +53,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { static $csv = array('contact_type', 'group', 'tag'); /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index 3b0a639d31..53c2146bf1 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -55,7 +55,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { public $_blockCount; /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -143,8 +143,6 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { * @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 * @access public diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php index 7b11d0c028..fa16c44afa 100644 --- a/CRM/Contact/Form/Search/Criteria.php +++ b/CRM/Contact/Form/Search/Criteria.php @@ -386,7 +386,7 @@ class CRM_Contact_Form_Search_Criteria { } /** - * @param $form + * @param CRM_Core_Form $form */ static function activity(&$form) { $form->add('hidden', 'hidden_activity', 1); @@ -394,7 +394,7 @@ class CRM_Contact_Form_Search_Criteria { } /** - * @param $form + * @param CRM_Core_Form $form */ static function changeLog(&$form) { $form->add('hidden', 'hidden_changeLog', 1); @@ -409,7 +409,7 @@ class CRM_Contact_Form_Search_Criteria { } /** - * @param $form + * @param CRM_Core_Form $form */ static function task(&$form) { $form->add('hidden', 'hidden_task', 1); diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php index 8b774ad1dd..92f9c60992 100644 --- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php +++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php @@ -90,7 +90,7 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_ } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -277,11 +277,9 @@ ORDER BY contact_a.sort_name'; ON assignment.contact_id = contact_c.id "; } - /* - * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values - * - */ /** + * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values + * * @param bool $includeContactIDs * * @return string diff --git a/CRM/Contact/Form/Search/Custom/Base.php b/CRM/Contact/Form/Search/Custom/Base.php index 5ef3c868e1..3dfe6c5010 100644 --- a/CRM/Contact/Form/Search/Custom/Base.php +++ b/CRM/Contact/Form/Search/Custom/Base.php @@ -213,7 +213,7 @@ class CRM_Contact_Form_Search_Custom_Base { /** * @param $where - * @param $params + * @param array $params * * @return string */ diff --git a/CRM/Contact/Form/Search/Custom/Basic.php b/CRM/Contact/Form/Search/Custom/Basic.php index 2261ce29e6..7c8ec8dd49 100644 --- a/CRM/Contact/Form/Search/Custom/Basic.php +++ b/CRM/Contact/Form/Search/Custom/Basic.php @@ -111,7 +111,7 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { //@todo FIXME - using the CRM_Core_DAO::VALUE_SEPARATOR creates invalid html - if you can find the form diff --git a/CRM/Contact/Form/Search/Custom/ContribSYBNT.php b/CRM/Contact/Form/Search/Custom/ContribSYBNT.php index f52948f565..ee28b56035 100644 --- a/CRM/Contact/Form/Search/Custom/ContribSYBNT.php +++ b/CRM/Contact/Form/Search/Custom/ContribSYBNT.php @@ -85,7 +85,7 @@ class CRM_Contact_Form_Search_Custom_ContribSYBNT implements CRM_Contact_Form_Se } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { diff --git a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php index 14ca2a2bc0..077bce28bd 100644 --- a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php +++ b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -246,8 +246,8 @@ civicrm_contact AS contact_a } /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ function count() { $sql = $this->all(); diff --git a/CRM/Contact/Form/Search/Custom/EmployerListing.php b/CRM/Contact/Form/Search/Custom/EmployerListing.php index 79b5a77b4e..374b5003b4 100644 --- a/CRM/Contact/Form/Search/Custom/EmployerListing.php +++ b/CRM/Contact/Form/Search/Custom/EmployerListing.php @@ -55,7 +55,7 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -82,10 +82,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form $form->assign('elements', array('sort_name', 'state_province_id')); } - /* - * Set search form field defaults here. - */ /** + * Set search form field defaults here. + * * @return array */ function setDefaultValues() { @@ -154,11 +153,6 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form $sql .= "ORDER BY sort_name asc"; } - /* Uncomment the next 2 lines to see the exact query you're generating */ - - // CRM_Core_Error::debug('sql',$sql); - // exit(); - return $sql; } @@ -179,11 +173,9 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form "; } - /* - * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values - * - */ /** + * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values + * * @param bool $includeContactIDs * * @return string @@ -246,8 +238,8 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form } /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ function count() { $sql = $this->all(); diff --git a/CRM/Contact/Form/Search/Custom/EventAggregate.php b/CRM/Contact/Form/Search/Custom/EventAggregate.php index f250e223dc..4d57db07a6 100644 --- a/CRM/Contact/Form/Search/Custom/EventAggregate.php +++ b/CRM/Contact/Form/Search/Custom/EventAggregate.php @@ -59,7 +59,7 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -171,9 +171,6 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea $rowcount = CRM_Utils_Type::escape($rowcount, 'Int'); $sql .= " LIMIT $offset, $rowcount "; } - - // Uncomment the next line to see the actual SQL generated: - //CRM_Core_Error::debug('sql',$sql); exit(); return $sql; } @@ -196,11 +193,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea ( civicrm_option_value.value = civicrm_event.event_type_id AND civicrm_option_value.option_group_id = 14)"; } - /* - * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values - * - */ /** + * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values + * * @param bool $includeContactIDs * * @return string @@ -285,7 +280,6 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea WHERE $where "; - //CRM_Core_Error::debug('sql',$sql); $dao = CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray ); @@ -300,8 +294,8 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea } /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ function count() { $sql = $this->all(); diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php index ae65bd3015..7aadc0aae4 100644 --- a/CRM/Contact/Form/Search/Custom/Group.php +++ b/CRM/Contact/Form/Search/Custom/Group.php @@ -593,8 +593,8 @@ WHERE gcc.group_id = {$ssGroup->id} } /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ /** * @return mixed */ diff --git a/CRM/Contact/Form/Search/Custom/MultipleValues.php b/CRM/Contact/Form/Search/Custom/MultipleValues.php index 02a3d29852..0c8b93486c 100644 --- a/CRM/Contact/Form/Search/Custom/MultipleValues.php +++ b/CRM/Contact/Form/Search/Custom/MultipleValues.php @@ -92,7 +92,7 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { diff --git a/CRM/Contact/Form/Search/Custom/PostalMailing.php b/CRM/Contact/Form/Search/Custom/PostalMailing.php index 066a5d4a9e..60807bfaa0 100644 --- a/CRM/Contact/Form/Search/Custom/PostalMailing.php +++ b/CRM/Contact/Form/Search/Custom/PostalMailing.php @@ -49,7 +49,7 @@ class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Sear } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { $groups = array('' => ts('- select group -')) + CRM_Core_PseudoConstant::nestedGroup(FALSE); diff --git a/CRM/Contact/Form/Search/Custom/PriceSet.php b/CRM/Contact/Form/Search/Custom/PriceSet.php index 90b4ad68d0..9f361bd464 100644 --- a/CRM/Contact/Form/Search/Custom/PriceSet.php +++ b/CRM/Contact/Form/Search/Custom/PriceSet.php @@ -186,7 +186,7 @@ AND p.entity_id = e.id } /** - * @param $form + * @param CRM_Core_Form $form * * @throws Exception */ diff --git a/CRM/Contact/Form/Search/Custom/RandomSegment.php b/CRM/Contact/Form/Search/Custom/RandomSegment.php index 6c01285304..60012234e8 100644 --- a/CRM/Contact/Form/Search/Custom/RandomSegment.php +++ b/CRM/Contact/Form/Search/Custom/RandomSegment.php @@ -311,7 +311,6 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear $totalSize = $dao->N; $multiplier = substr($this->_segmentSize, 0, strlen($this->_segmentSize) - 1); $multiplier /= 100; - //CRM_Core_Error::debug( "Total size: $totalSize
Multiplier: $multiplier
"); $this->_segmentSize = round($totalSize * $multiplier); } diff --git a/CRM/Contact/Form/Search/Custom/Sample.php b/CRM/Contact/Form/Search/Custom/Sample.php index cbe50a0085..eaf2b1525c 100644 --- a/CRM/Contact/Form/Search/Custom/Sample.php +++ b/CRM/Contact/Form/Search/Custom/Sample.php @@ -57,7 +57,7 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { diff --git a/CRM/Contact/Form/Search/Custom/TagContributions.php b/CRM/Contact/Form/Search/Custom/TagContributions.php index 91e09f1355..26f4e565bb 100644 --- a/CRM/Contact/Form/Search/Custom/TagContributions.php +++ b/CRM/Contact/Form/Search/Custom/TagContributions.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Custom_TagContributions implements CRM_Contact_For } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -207,8 +207,8 @@ WHERE $where /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ /** * @return mixed */ diff --git a/CRM/Contact/Form/Search/Custom/ZipCodeRange.php b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php index b5d580f7e7..45400757f6 100644 --- a/CRM/Contact/Form/Search/Custom/ZipCodeRange.php +++ b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php @@ -48,7 +48,7 @@ class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Searc } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { $form->add('text', diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php index b783d0230d..9101fdd608 100644 --- a/CRM/Contact/Form/Task.php +++ b/CRM/Contact/Form/Task.php @@ -99,7 +99,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -278,7 +278,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { } /** - * Function to get the contact id for custom search + * get the contact id for custom search * we are not using prev/next table incase of custom search */ public function getContactIds() { @@ -327,7 +327,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { /** - * This function sets the default values for the form. Relationship that in edit/view action + * Set default values for the form. Relationship that in edit/view action * the default values are retrieved from the database * * @access public @@ -349,7 +349,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -368,19 +368,15 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { public function postProcess() { } - //end of function - /** * simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $nextType + * @param string $nextType button type for the form after processing * @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/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index cb2aca15c8..310d8a3e10 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -78,7 +78,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -182,9 +182,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * global validation rules for the form * - * @param $params - * - * @internal param array $fields posted values of the form + * @param array $params * * @return array list of errors to be posted back to the form * @static @@ -251,6 +249,5 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url('civicrm/group/search', "reset=1&force=1&context=smog&gid=$groupID")); } } - //end of function } diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index f571246fda..75589dab4b 100644 --- a/CRM/Contact/Form/Task/AddToHousehold.php +++ b/CRM/Contact/Form/Task/AddToHousehold.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { /** - * Build the form + * Build the form object * * @access public * @@ -54,7 +54,7 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { } /** - * Function to build the form + * Build the form object * * @access public * @@ -178,7 +178,7 @@ 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 $form + * @param CRM_Core_Form $form * @param array $params This contains elements for search criteria * * @access public diff --git a/CRM/Contact/Form/Task/AddToOrganization.php b/CRM/Contact/Form/Task/AddToOrganization.php index 0456157f81..8248d00e42 100644 --- a/CRM/Contact/Form/Task/AddToOrganization.php +++ b/CRM/Contact/Form/Task/AddToOrganization.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task { /** - * Build the form + * Build the form object * * @access public * @@ -51,7 +51,7 @@ class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task { } /** - * Function to build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Task/AddToTag.php b/CRM/Contact/Form/Task/AddToTag.php index ec56edf08b..4b756b9d85 100644 --- a/CRM/Contact/Form/Task/AddToTag.php +++ b/CRM/Contact/Form/Task/AddToTag.php @@ -55,7 +55,7 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { protected $_tags; /** - * Build the form + * Build the form object * * @access public * @@ -80,7 +80,7 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { } /** - * @param $form + * @param CRM_Core_Form $form * @param $rule * * @return array @@ -155,6 +155,5 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { } } - //end of function } diff --git a/CRM/Contact/Form/Task/AlterPreferences.php b/CRM/Contact/Form/Task/AlterPreferences.php index 41eee10aa2..3801062236 100644 --- a/CRM/Contact/Form/Task/AlterPreferences.php +++ b/CRM/Contact/Form/Task/AlterPreferences.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { /** - * Build the form + * Build the form object * * @access public * @@ -81,7 +81,7 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { } /** - * @param $form + * @param CRM_Core_Form $form * @param $rule * * @return array diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index 32ba02d7dd..465a6708bf 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -82,7 +82,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -166,7 +166,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -264,12 +264,11 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { CRM_Core_Session::setStatus(ts('Contact Subtype field of 1 contact has not been updated.', array('plural' => 'Contact Subtype field of %count contacts has not been updated.', 'count' => $inValidSubtypeCnt)), ts('Invalid Subtype')); } } - //end of function /** * parse street address * @param array $contactValues contact values - * @param object $form form object + * @param CRM_Core_Form $form form object */ public static function parseStreetAddress(&$contactValues, &$form) { if (!is_array($contactValues) || !is_array($form->_fields)) { diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index 37e71d8d4f..661650b28f 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -141,7 +141,7 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -287,6 +287,5 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { $session->replaceUserContext(CRM_Utils_System::url($urlString, $urlParams)); } } - //end of function } diff --git a/CRM/Contact/Form/Task/Email.php b/CRM/Contact/Form/Task/Email.php index f37949250c..21baaadbeb 100644 --- a/CRM/Contact/Form/Task/Email.php +++ b/CRM/Contact/Form/Task/Email.php @@ -149,7 +149,7 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index 91d71388e8..24585fea95 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -130,11 +130,11 @@ class CRM_Contact_Form_Task_EmailCommon { } /** - * Build the form + * Build the form object * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -350,7 +350,7 @@ class CRM_Contact_Form_Task_EmailCommon { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -511,5 +511,4 @@ class CRM_Contact_Form_Task_EmailCommon { } } } - //end of function } diff --git a/CRM/Contact/Form/Task/HookSample.php b/CRM/Contact/Form/Task/HookSample.php index 966de09c6a..aefca7fc7e 100644 --- a/CRM/Contact/Form/Task/HookSample.php +++ b/CRM/Contact/Form/Task/HookSample.php @@ -74,7 +74,7 @@ AND c.id IN ( $contactIDs )"; } /** - * Build the form - it consists of + * Build the form object - it consists of * * @access public * diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index c920aa6bda..ccbe82505a 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -51,7 +51,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -92,7 +92,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @param null * @@ -374,7 +374,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { return FALSE; } /** - * function to create labels (pdf) + * create labels (pdf) * * @param array $contactRows assciated array of contact data * @param string $format format in which labels needs to be printed @@ -402,7 +402,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * function to create the array of returnProperties + * create the array of returnProperties * * @param string $format format for which return properties build * diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 24a8ff0e3d..8af30fb3d3 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Task_LabelCommon { return FALSE; } /** - * function to create labels (pdf) + * create labels (pdf) * * @param array $contactRows assciated array of contact data * @param string $format format in which labels needs to be printed @@ -87,15 +87,14 @@ class CRM_Contact_Form_Task_LabelCommon { /** - * function to get the rows for the labels + * get the rows for the labels * * @param $contactIDs * @param integer $locationTypeID * @param boolean $respectDoNotMail * @param $mergeSameAddress - * @param $mergeSameHousehold + * @param bool $mergeSameHousehold UNUSED * - * @internal param array $contactIds Contact IDS to do labels for * @return array of rows for labels * @access public */ @@ -259,7 +258,7 @@ class CRM_Contact_Form_Task_LabelCommon { } /** - * function to extract the return properties from the mailing format + * extract the return properties from the mailing format * @todo I'm placing bets this is a duplicate of code elsewhere - find & merge * @param unknown_type $format * @return multitype:number diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 270074618e..1041628172 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -115,7 +115,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -140,19 +140,16 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { * @return void */ public function postProcess() {} - //end of function /** * assign smarty variables to the template that will be used by google api to plot the contacts * * @param $ids * @param int $locationId location_id - * * @param $page * @param $addBreadCrumb * @param string $type * - * @internal param array $contactIds list of contact ids that we need to plot * @return string the location of the file we have created * @access protected */ diff --git a/CRM/Contact/Form/Task/PDF.php b/CRM/Contact/Form/Task/PDF.php index 9686b0ced6..f2e52cdad0 100644 --- a/CRM/Contact/Form/Task/PDF.php +++ b/CRM/Contact/Form/Task/PDF.php @@ -88,7 +88,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. Relationship that in edit/view action + * Set default values for the form. Relationship that in edit/view action * the default values are retrieved from the database * * @access public @@ -110,7 +110,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index a3f091244e..e42cb9edcd 100644 --- a/CRM/Contact/Form/Task/PDFLetterCommon.php +++ b/CRM/Contact/Form/Task/PDFLetterCommon.php @@ -42,7 +42,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { /** * build all the data structures needed to build the form * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -64,7 +64,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * @param $form + * @param CRM_Core_Form $form * @param $cid */ static function preProcessSingle(&$form, $cid) { @@ -74,7 +74,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Build the form + * Build the form object * * @var CRM_Core_Form $form * @@ -240,7 +240,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { * * @access protected * - * @param $form + * @param CRM_Core_Form $form * * @return array( $categories, $html_message, $messageToken, $returnProperties ) */ @@ -315,7 +315,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -364,7 +364,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * @param $form + * @param CRM_Core_Form $form * @param $html_message * @param $contactIds * diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index 8714544bfd..aa2fb1f060 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -97,7 +97,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -172,6 +172,5 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { // also reset the batch page so it gets new values from the db $this->controller->resetPage('Batch'); } - //end of function } diff --git a/CRM/Contact/Form/Task/Print.php b/CRM/Contact/Form/Task/Print.php index 22857ee32a..fc798c302e 100644 --- a/CRM/Contact/Form/Task/Print.php +++ b/CRM/Contact/Form/Task/Print.php @@ -105,7 +105,7 @@ class CRM_Contact_Form_Task_Print extends CRM_Contact_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 58ad97352d..43a08a867c 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -73,7 +73,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -112,9 +112,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param $form - * - * @internal param array $options additional user data + * @param CRM_Core_Form $form * * @return true if no errors, else array of errors * @access public @@ -142,7 +140,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * * @access protected * - * @param $form + * @param CRM_Core_Form $form * * @return array the default array reference */ diff --git a/CRM/Contact/Form/Task/RemoveFromGroup.php b/CRM/Contact/Form/Task/RemoveFromGroup.php index 152b5a59a7..696b19f611 100644 --- a/CRM/Contact/Form/Task/RemoveFromGroup.php +++ b/CRM/Contact/Form/Task/RemoveFromGroup.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task { /** - * Build the form + * Build the form object * * @access public * @@ -92,6 +92,5 @@ class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task { $status = ''; CRM_Core_Session::setStatus($status, ts("Removed Contact From Group", array('plural' => "Removed Contacts From Group", 'count' => $removed)), 'success', array('expires' => 0)); } - //end of function } diff --git a/CRM/Contact/Form/Task/RemoveFromTag.php b/CRM/Contact/Form/Task/RemoveFromTag.php index 6c4f506018..1ba3101701 100644 --- a/CRM/Contact/Form/Task/RemoveFromTag.php +++ b/CRM/Contact/Form/Task/RemoveFromTag.php @@ -53,7 +53,7 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task { protected $_tags; /** - * Build the form + * Build the form object * * @access public * @@ -77,7 +77,7 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task { } /** - * @param $form + * @param CRM_Core_Form $form * @param $rule * * @return array @@ -144,6 +144,5 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task { CRM_Core_Session::setStatus($status, ts("Removed Tag %1", array(1 => $this->_tags[$key])), 'success', array('expires' => 0)); } } - //end of function } diff --git a/CRM/Contact/Form/Task/Result.php b/CRM/Contact/Form/Task/Result.php index 69c680ffd0..4fb1b0e645 100644 --- a/CRM/Contact/Form/Task/Result.php +++ b/CRM/Contact/Form/Task/Result.php @@ -97,7 +97,7 @@ class CRM_Contact_Form_Task_Result extends CRM_Contact_Form_Task { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Form/Task/SMS.php b/CRM/Contact/Form/Task/SMS.php index 5eb487817e..d2f826a351 100644 --- a/CRM/Contact/Form/Task/SMS.php +++ b/CRM/Contact/Form/Task/SMS.php @@ -73,7 +73,7 @@ class CRM_Contact_Form_Task_SMS extends CRM_Contact_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index b04ec2d58e..8ca6676f50 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -48,7 +48,7 @@ class CRM_Contact_Form_Task_SMSCommon { /** - * @param $form + * @param CRM_Core_Form $form */ static function preProcessProvider(&$form) { $form->_single = FALSE; @@ -83,11 +83,11 @@ class CRM_Contact_Form_Task_SMSCommon { } /** - * Build the form + * Build the form object * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -341,7 +341,7 @@ class CRM_Contact_Form_Task_SMSCommon { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ diff --git a/CRM/Contact/Form/Task/SaveSearch.php b/CRM/Contact/Form/Task/SaveSearch.php index b13b33f0b7..bedb416948 100644 --- a/CRM/Contact/Form/Task/SaveSearch.php +++ b/CRM/Contact/Form/Task/SaveSearch.php @@ -75,7 +75,7 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Contact/Form/Task/SaveSearch/Update.php b/CRM/Contact/Form/Task/SaveSearch/Update.php index fb26d9dc18..2e1624a681 100644 --- a/CRM/Contact/Form/Task/SaveSearch/Update.php +++ b/CRM/Contact/Form/Task/SaveSearch/Update.php @@ -59,7 +59,7 @@ class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_Save } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public diff --git a/CRM/Contact/Form/Task/Unhold.php b/CRM/Contact/Form/Task/Unhold.php index cc98b573af..fafecf278d 100644 --- a/CRM/Contact/Form/Task/Unhold.php +++ b/CRM/Contact/Form/Task/Unhold.php @@ -6,7 +6,7 @@ class CRM_Contact_Form_Task_Unhold extends CRM_Contact_Form_Task { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Contact/Form/Task/Useradd.php b/CRM/Contact/Form/Task/Useradd.php index 6d14f5b6e3..018e1c86d4 100755 --- a/CRM/Contact/Form/Task/Useradd.php +++ b/CRM/Contact/Form/Task/Useradd.php @@ -66,7 +66,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -85,7 +85,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -122,7 +122,6 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { } /** - * * @access public * * @return void diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php index ba0cc1d1f2..90cc1ac0cd 100644 --- a/CRM/Contact/Import/Form/DataSource.php +++ b/CRM/Contact/Import/Form/DataSource.php @@ -48,7 +48,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { private $_dataSourceClass; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -125,7 +125,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index a97805064b..3694f77c59 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -93,7 +93,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -199,7 +199,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index 1dd11b5c98..d8f3fd5a14 100644 --- a/CRM/Contact/Import/Form/Preview.php +++ b/CRM/Contact/Import/Form/Preview.php @@ -40,7 +40,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -127,7 +127,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contact/Import/Form/Summary.php b/CRM/Contact/Import/Form/Summary.php index 2f84f72877..9084ba82e2 100644 --- a/CRM/Contact/Import/Form/Summary.php +++ b/CRM/Contact/Import/Form/Summary.php @@ -39,7 +39,7 @@ class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Contact/Import/ImportJob.php b/CRM/Contact/Import/ImportJob.php index 3d45cacd2c..797c6d23f6 100644 --- a/CRM/Contact/Import/ImportJob.php +++ b/CRM/Contact/Import/ImportJob.php @@ -152,7 +152,7 @@ class CRM_Contact_Import_ImportJob { } /** - * @param $params + * @param array $params */ public function setJobParams(&$params) { foreach ($params as $param => $value) { @@ -162,7 +162,7 @@ class CRM_Contact_Import_ImportJob { } /** - * @param $form + * @param CRM_Core_Form $form * @param int $timeout */ public function runImport(&$form, $timeout = 55) { diff --git a/CRM/Contact/Import/Page/AJAX.php b/CRM/Contact/Import/Page/AJAX.php index f6473fa5cd..b40fd776b0 100644 --- a/CRM/Contact/Import/Page/AJAX.php +++ b/CRM/Contact/Import/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Contact_Import_Page_AJAX { /** - * Function to show import status + * show import status */ static function status() { // make sure we get an id diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index f648b11e08..9d400fab96 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -451,7 +451,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * Function to set IM Service Provider type fields + * set IM Service Provider type fields * * @param array $elements IM service provider type ids * @@ -519,7 +519,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * Function to set IM Service Provider type fields for related contacts + * set IM Service Provider type fields for related contacts * * @param array $elements IM service provider type ids of related contact * @@ -533,7 +533,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public @@ -541,7 +541,6 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { function &getActiveFieldParams() { $params = array(); - //CRM_Core_Error::debug( 'Count', $this->_activeFieldCount ); for ($i = 0; $i < $this->_activeFieldCount; $i++) { if ($this->_activeFields[$i]->_name == 'do_not_import') { continue; @@ -732,9 +731,8 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * * @param $fileName * @param array $header - * @param data $data + * @param array $data * - * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 328195ddaa..2b47f9dea0 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -1096,9 +1096,9 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { function fini() {} /** - * function to check if an error in custom data + * check if an error in custom data * - * @param $params + * @param array $params * @param String $errorMessage A string containing all the error-fields. * * @param null $csType @@ -1317,9 +1317,9 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * function to check if an error in Core( non-custom fields ) field + * check if an error in Core( non-custom fields ) field * - * @param $params + * @param array $params * @param String $errorMessage A string containing all the error-fields. * * @access public @@ -1588,7 +1588,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * function to ckeck a value present or not in a array + * ckeck a value present or not in a array * * @param $value * @param $valueArray @@ -2068,7 +2068,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * @param $relKey - * @param $params + * @param array $params * * @return bool */ diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php index f551ae486a..73c242f11d 100644 --- a/CRM/Contact/Page/AJAX.php +++ b/CRM/Contact/Page/AJAX.php @@ -196,7 +196,7 @@ class CRM_Contact_Page_AJAX { } /** - * Function to fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title + * fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title */ static function getPCPList() { $name = CRM_Utils_Array::value('s', $_GET); @@ -317,7 +317,7 @@ class CRM_Contact_Page_AJAX { } /** - * Function to fetch the custom field help + * fetch the custom field help */ static function customField() { $fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer'); @@ -518,7 +518,7 @@ ORDER BY sort_name "; } /** - * Function to delete custom value + * delete custom value * */ static function deleteCustomValue() { @@ -581,7 +581,7 @@ ORDER BY sort_name "; } /** - *Function to check the CMS username + * check the CMS username * */ static public function checkUserName() { diff --git a/CRM/Contact/Page/View/CustomData.php b/CRM/Contact/Page/View/CustomData.php index 07a89e8277..5b32014e8c 100644 --- a/CRM/Contact/Page/View/CustomData.php +++ b/CRM/Contact/Page/View/CustomData.php @@ -89,8 +89,6 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { * * @access public * - * @internal param object $page - the view page which created this one - * * @return void * @static */ diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index 32ae9d45e5..a085c3e8b0 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -73,9 +73,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** * This function is called when action is update * - * @param null $groupId - * - * @internal param int $groupID group id + * @param int $groupId * * return null * @access public @@ -148,7 +146,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { } /** - * function to remove/ rejoin the group + * remove/ rejoin the group * * @param int $groupContactId id of crm_group_contact * @param string $status this is the status that should be updated. diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php index 6bf40e25fa..f1a07abcb5 100644 --- a/CRM/Contact/Page/View/UserDashBoard.php +++ b/CRM/Contact/Page/View/UserDashBoard.php @@ -41,10 +41,10 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { public $_contactId = NULL; - /* - * always show public groups - */ - + /** + * always show public groups + * @var bool + */ public $_onlyPublicGroups = TRUE; public $_edit = TRUE; @@ -87,14 +87,13 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } } - /* - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. - * - * @return void - * @access public - * - */ + /** + * Heart of the viewing process. The runner gets all the meta data for + * the contact and calls the appropriate type of page to view. + * + * @return void + * @access public + */ function preProcess() { if (!$this->_contactId) { CRM_Core_Error::fatal(ts('You must be logged in to view this page.')); @@ -111,7 +110,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * Function to build user dashboard + * build user dashboard * * @return void * @access public diff --git a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php index cfedeb4d9e..6453a1c813 100644 --- a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php +++ b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php @@ -78,9 +78,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ /** * This function is called when action is update * - * @param null $groupId - * - * @internal param int $groupID group id + * @param int $groupId * * return null * @access public diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 8a6ac5b197..5c0a67de3b 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -220,7 +220,6 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se $this->_options = &$this->_query->_options; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -299,15 +298,13 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -318,7 +315,6 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * @param null $action @@ -825,7 +821,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } /** - * @param $sort + * @param CRM_Utils_Sort $sort * * @return string */ @@ -989,7 +985,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } /** - * @param object $sort + * @param CRM_Utils_Sort $sort * @param string $cacheKey * @param int $start * @param int $end @@ -1051,10 +1047,9 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * * @param int $start start for limit clause * @param int $end end for limit clause - * @param $sort + * @param CRM_Utils_Sort $sort * @param string $cacheKey cache key * - * @internal param $object $sort sort object * @return void */ function rebuildPreNextCache($start, $end, $sort, $cacheKey) { @@ -1185,7 +1180,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont } /** - * @param $params + * @param array $params * @param $action * @param $sortID * @param null $displayRelationshipType @@ -1260,5 +1255,4 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont return $properties; } } -//end of class diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index bb28ea8f78..bd4118d53f 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -157,7 +157,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { $this->_search = new $className($formValues); } } - //end of constructor /** * This method returns the links that are given for each search row. @@ -206,15 +205,13 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -225,7 +222,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * returns the column headers as an array of tuples: @@ -416,7 +412,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } /** - * @param $params + * @param array $params * @param $action * @param $sortID * @param null $displayRelationshipType diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 57a7fa967e..41e51d2768 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -92,7 +92,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids the array that holds all the db ids * - * @return object CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution object * @access public * @static */ @@ -247,7 +247,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * @param $params + * @param array $params * * @return mixed */ @@ -294,7 +294,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids the array that holds all the db ids * - * @return object CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution object * @access public * @static */ @@ -534,7 +534,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * in a hierarchical manner * @param array $ids (reference) the array that holds all the db ids * - * @return object CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution object * @access public * @static */ @@ -834,12 +834,11 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta /** * Check if there is a contribution with the same trxn_id or invoice_id * - * @param $input + * @param array $input an assoc array of name/value pairs * @param array $duplicates (reference ) store ids of duplicate contribs * * @param null $id * - * @internal param array $params (reference ) an assoc array of name/value pairs * @return boolean true if duplicate, false otherwise * @access public * static @@ -893,7 +892,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Contribute_BAO_ContributionProduct object + * @return CRM_Contribute_BAO_ContributionProduct object * @access public * @static */ @@ -904,7 +903,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * Function to get list of contribution fields for profile + * get list of contribution fields for profile * For now we only allow custom contribution fields to be in * profile * @@ -939,7 +938,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * Function to add extra fields specific to contribtion + * add extra fields specific to contribtion * * @static */ @@ -1003,7 +1002,7 @@ GROUP BY p.id } /** - * Function to get list of contribution In Honor of contact Ids + * get list of contribution In Honor of contact Ids * * @param int $honorId In Honor of Contact ID * @@ -1235,12 +1234,10 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont } /** - * Function to create address associated with contribution record. + * Create address associated with contribution record. * * @param array $params an associated array - * @param $billingLocationTypeID - * - * @internal param int $billingID $billingLocationTypeID + * @param int $billingLocationTypeID * * @return address id * @static @@ -1276,11 +1273,9 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont /** * Delete billing address record related contribution * - * @param null $contributionId - * @param null $contactId + * @param int $contributionId + * @param int $contactId * - * @internal param int $contact_id contact id - * @internal param int $contribution_id contributionId * @access public * @static */ diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index 8b3c1af9ca..5da726f46e 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -35,9 +35,9 @@ class CRM_Contribute_BAO_Contribution_Utils { /** - * Function to process payment after confirmation + * process payment after confirmation * - * @param object $form form object + * @param CRM_Core_Form $form form object * @param array $paymentParams array with payment related key * value pairs * @param array $premiumParams array with premium related key @@ -45,9 +45,7 @@ class CRM_Contribute_BAO_Contribution_Utils { * @param int $contactID contact id * @param int $contributionTypeId financial type id * @param int|string $component component id - * * @param array $fieldTypes presumably relates to custom field types - used when building data for sendMail - * * @param $isTest * @param $isPayLater * @@ -359,7 +357,7 @@ class CRM_Contribute_BAO_Contribution_Utils { * Is a payment being made. * Note that setting is_monetary on the form is somewhat legacy and the behaviour around this setting is confusing. It would be preferable * to look for the amount only (assuming this cannot refer to payment in goats or other non-monetary currency - * @param $form + * @param CRM_Core_Form $form * * @return bool */ @@ -371,7 +369,7 @@ class CRM_Contribute_BAO_Contribution_Utils { } /** - * Function to get the contribution details by month + * get the contribution details by month * of the year * * @param int $param year @@ -415,7 +413,7 @@ INNER JOIN civicrm_contact AS contact ON ( contact.id = contrib.contact_id ) } /** - * Function to get the contribution details by year + * get the contribution details by year * * @return array associated array * @@ -458,7 +456,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) } /** - * @param $params + * @param array $params * @param $contactID * @param $mail */ @@ -480,7 +478,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) } /** - * @param $params + * @param array $params * @param string $type * * @return bool @@ -751,7 +749,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) } /** - * @param $params + * @param array $params * * @return bool */ diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index d175b4db92..4218045fb7 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -43,7 +43,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Contribute_DAO_ContributionPage object + * @return CRM_Contribute_DAO_ContributionPage object * @access public * @static */ @@ -106,7 +106,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Function to send the emails + * send the emails * * @param int $contactID contact id * @param array $values associated array of fields @@ -423,11 +423,9 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } } - /* - * Construct the message to be sent by the send function - * - */ /** + * Construct the message to be sent by the send function + * * @param $tplParams * @param $contactID * @param $isTest @@ -455,7 +453,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Function to send the emails for Recurring Contribution Notication + * send the emails for Recurring Contribution Notication * * @param string $type txnType * @param int $contactID contact id for contributor @@ -553,7 +551,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Function to add the custom fields for contribution page (ie profile) + * add the custom fields for contribution page (ie profile) * * @param int $gid uf group id * @param string $name diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index c9a1feca18..1eeb9553f5 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -35,7 +35,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur { /** - * function to create recurring contribution + * create recurring contribution * * @param array $params (reference ) an assoc array of name/value pairs * @@ -48,7 +48,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi } /** - * takes an associative array and creates a contribution object + * Takes an associative array and creates a contribution object * * the function extract all the params it needs to initialize the create a * contribution object. the params array could contain additional unused name/value @@ -56,9 +56,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * * @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 + * @return CRM_Contribute_BAO_Contribution object * @access public * @static * @todo move hook calls / extended logic to create - requires changing calls to call create not add @@ -178,7 +176,7 @@ SELECT r.payment_processor_id } /** - * Function to get the number of installment done/completed for each recurring contribution + * get the number of installment done/completed for each recurring contribution * * @param array $ids (reference ) an array of recurring contribution ids * @@ -325,7 +323,7 @@ SELECT r.payment_processor_id } /** - * Function to get list of recurring contribution of contact Ids + * get list of recurring contribution of contact Ids * * @param int $contactId Contact ID * @@ -420,11 +418,11 @@ INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id ) // handle context redirection for subscription url $session = CRM_Core_Session::singleton(); if ($session->get('userID')) { - $url = FALSE; - $cid = CRM_Utils_Request::retrieve('cid', 'Integer', $this, FALSE); - $mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE); - $qfkey = CRM_Utils_Request::retrieve('key', 'String', $this, FALSE); - $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE); + $url = FALSE; + $cid = CRM_Utils_Request::retrieve('cid', 'Integer'); + $mid = CRM_Utils_Request::retrieve('mid', 'Integer'); + $qfkey = CRM_Utils_Request::retrieve('key', 'String'); + $context = CRM_Utils_Request::retrieve('context', 'String'); if ($cid) { switch ($context) { case 'contribution': diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index 4aa0fe76a9..d47d492721 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -42,7 +42,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * function to add contribution soft credit record + * add contribution soft credit record * * @param array $params (reference ) an assoc array of name/value pairs * @@ -63,16 +63,12 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_ContributionSoft object + * @return CRM_Contribute_BAO_ContributionSoft object * @access public * @static */ @@ -87,11 +83,10 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * Function to delete soft credits + * delete soft credits * - * @param $params + * @param array $params * - * @internal param int $contributionTypeId * @static */ static function del($params) { @@ -145,12 +140,11 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * Function to retrieve soft contributions for contribution record. + * retrieve soft contributions for contribution record. * * @param $contributionID * @param boolean $all include PCP data * - * @internal param array $params an associated array * @return array of soft contribution ids, amounts, and associated contact ids * @static */ @@ -319,8 +313,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio */ /** - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $honoreeprofileId * @param null $honorId */ diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 4408c2824d..3a565a5e31 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -47,16 +47,12 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_ManagePremium object + * @return CRM_Contribute_BAO_ManagePremium object * @access public * @static */ @@ -90,7 +86,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * function to add the financial types + * add the financial types * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -131,7 +127,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * Function to delete premium Types + * delete premium Types * * @param int $productID * @static diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 3fd5384172..cc530da0db 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -49,16 +49,12 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_ManagePremium object + * @return CRM_Contribute_BAO_ManagePremium object * @access public * @static */ @@ -86,11 +82,10 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Function to delete financial Types + * delete financial Types * * @param $premiumID * - * @internal param int $contributionTypeId * @static */ static function del($premiumID) { @@ -103,7 +98,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Function to build Premium Block im Contribution Pages + * build Premium Block im Contribution Pages * * @param $form CRM_Core_Form * @param $pageID @@ -111,7 +106,6 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { * @param null $selectedProductID * @param null $selectedOption * - * @internal param int $pageId * @static */ static function buildPremiumBlock(&$form, $pageID, $formItems = FALSE, $selectedProductID = NULL, $selectedOption = NULL) { @@ -173,13 +167,12 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Function to build Premium B im Contribution Pages + * build Premium B im Contribution Pages * - * @param $form CRM_Core_Form - * @param $productID - * @param null $premiumProductID + * @param CRM_Core_Form $form + * @param int $productID + * @param int $premiumProductID * - * @internal param int $pageId * @static */ function buildPremiumPreviewBlock($form, $productID, $premiumProductID = NULL) { @@ -219,7 +212,6 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { * * @param $contributionPageID * - * @internal param int $contribution page id * @static */ static function deletePremium($contributionPageID) { diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index f3c533946b..ac55537303 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -958,7 +958,7 @@ class CRM_Contribute_BAO_Query { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void * @static diff --git a/CRM/Contribute/Form.php b/CRM/Contribute/Form.php index d0c1767333..cd51b67eab 100644 --- a/CRM/Contribute/Form.php +++ b/CRM/Contribute/Form.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form extends CRM_Admin_Form { /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index dddd95b464..0965885c78 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -35,11 +35,11 @@ class CRM_Contribute_Form_AdditionalInfo { /** - * Function to build the form for Premium Information. + * Build the form object for Premium Information. * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -86,11 +86,11 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Function to build the form for Additional Details. + * Build the form object for Additional Details. * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -174,11 +174,11 @@ class CRM_Contribute_Form_AdditionalInfo { /** * This function is used by CRM/Pledge/Form/Pledge.php * - * Function to build the form for PaymentReminders Information. + * Build the form object for PaymentReminders Information. * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -194,11 +194,11 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Function to process the Premium Information + * process the Premium Information * * @access public * - * @param $params + * @param array $params * @param $contributionID * @param null $premiumID * @param null $options @@ -254,11 +254,11 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Function to process the Note + * process the Note * * @access public * - * @param $params + * @param array $params * @param $contactID * @param $contributionID * @param null $contributionNoteID @@ -282,13 +282,13 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Function to process the Common data + * process the Common data * * @access public * - * @param $params + * @param array $params * @param $formatted - * @param $form + * @param CRM_Core_Form $form * @return void */ static function postProcessCommon(&$params, &$formatted, &$form) { @@ -338,7 +338,7 @@ class CRM_Contribute_Form_AdditionalInfo { * * @form object of Contribution form. * - * @param $form + * @param CRM_Core_Form $form * @param array $params (reference ) an assoc array of name/value pairs. * @$ccContribution boolen, is it credit card contribution. * @param bool $ccContribution diff --git a/CRM/Contribute/Form/AdditionalPayment.php b/CRM/Contribute/Form/AdditionalPayment.php index b0bd6d7036..664118c447 100644 --- a/CRM/Contribute/Form/AdditionalPayment.php +++ b/CRM/Contribute/Form/AdditionalPayment.php @@ -628,7 +628,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract } /** - * @param $params + * @param array $params * * @return mixed */ diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php index 53395ffe4a..3927f0294b 100644 --- a/CRM/Contribute/Form/CancelSubscription.php +++ b/CRM/Contribute/Form/CancelSubscription.php @@ -53,7 +53,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { protected $_selfService = FALSE; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -132,7 +132,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -185,7 +185,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -199,7 +199,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 0d8e00cd5b..793b755cb1 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -232,7 +232,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP */ public $userDisplayName; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -490,7 +490,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -942,7 +942,6 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP * @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 @@ -1002,7 +1001,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index 6bada2f209..7978e02a0d 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -65,23 +65,16 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * @param $contributionPageId * @param $nonDeductibleAmount * @param $campaignId - * * @param $isMonetary - * * @param $pending * @param $paymentProcessorOutcome * @param $receiptDate - * * @param $recurringContributionID * @param $isTest - * * @param $addressID - * * @param $softCreditToID - * * @param $lineItems * - * @internal param $financialType * @return array */ public static function getContributionParams($params, $contactID, $financialTypeID, $online, $contributionPageId, $nonDeductibleAmount, $campaignId, $isMonetary, $pending, @@ -166,7 +159,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -445,7 +438,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -657,7 +650,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -1196,7 +1189,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * Process the contribution * - * @param $form + * @param CRM_Core_Form $form * @param array $params * @param array $result * @param integer $contactID @@ -1607,14 +1600,14 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Function to add on behalf of organization and it's location + * add on behalf of organization and it's location * * @param $behalfOrganization array array of organization info * @param $contactID int individual contact id. One * who is doing the process of signup / contribution. * * @param $values array form values array - * @param $params + * @param array $params * @param null $fields * * @return void @@ -1753,7 +1746,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * Function used to se pcp related defaults / params * This is used by contribution and also event pcps * - * @param object $page form object + * @param CRM_Core_Form $page form object * @param array $params associated array * * @return array @@ -1858,8 +1851,6 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * * @param $priceSetID * - * @internal param $isQuickConfig - * @internal param $priceField */ public function setFormAmountFields($priceSetID) { $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config'); diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index 0f0aaa0d1e..077b592f47 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -66,7 +66,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu protected $_snippet; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -374,7 +374,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -729,7 +729,6 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu * @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 @@ -1092,8 +1091,8 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * @param $params - * @param $form + * @param array $params + * @param CRM_Core_Form $form * * @return int|mixed|null|string */ @@ -1128,7 +1127,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index e2c62f1b67..057ed671c6 100644 --- a/CRM/Contribute/Form/Contribution/OnBehalfOf.php +++ b/CRM/Contribute/Form/Contribution/OnBehalfOf.php @@ -35,9 +35,9 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { /** - * Function to set variables up before form is built + * set variables up before form is built * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -123,12 +123,9 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { } /** - * Function to build form for related contacts / on behalf of organization. + * build form for related contacts / on behalf of organization. * - * @param $form object invoking Object - * - * @internal param string $contactType contact type - * @internal param string $title fieldset title + * @param CRM_Core_Form $form * * @static */ diff --git a/CRM/Contribute/Form/Contribution/ThankYou.php b/CRM/Contribute/Form/Contribution/ThankYou.php index 0d8fa84bc1..8386c5749e 100644 --- a/CRM/Contribute/Form/Contribution/ThankYou.php +++ b/CRM/Contribute/Form/Contribution/ThankYou.php @@ -45,7 +45,7 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont public $_useForMember; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -91,7 +91,7 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index 4ef097c60f..2863ddce4a 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -214,7 +214,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_isBillingAddressRequiredForPayLater; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -674,7 +674,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Function to add the custom fields + * add the custom fields * * @param $id * @param $name @@ -840,7 +840,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Function to authenticate pledge user during online payment. + * authenticate pledge user during online payment. * * @access public * diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php index 3d40231bce..7b99768c08 100644 --- a/CRM/Contribute/Form/ContributionCharts.php +++ b/CRM/Contribute/Form/ContributionCharts.php @@ -62,7 +62,7 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index ee47a51890..f8de7b74f4 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -81,7 +81,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_values; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -142,7 +142,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -240,7 +240,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Contribute/Form/ContributionPage/AddProduct.php b/CRM/Contribute/Form/ContributionPage/AddProduct.php index a0249e6db1..23cb274571 100644 --- a/CRM/Contribute/Form/ContributionPage/AddProduct.php +++ b/CRM/Contribute/Form/ContributionPage/AddProduct.php @@ -43,7 +43,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For protected $_pid; /** - * Function to pre process the form + * pre process the form * * @access public * @@ -69,7 +69,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -112,7 +112,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index 7c8ff97c4b..f5a31d90c3 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -52,7 +52,7 @@ class CRM_Contribute_Form_ContributionPage_Amount extends CRM_Contribute_Form_Co CONST NUM_OPTION = 11; /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -185,7 +185,7 @@ SELECT id } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -278,7 +278,6 @@ SELECT id * @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/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 8cbf5bb72f..d4badeb181 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_ContributionPage { /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -77,7 +77,7 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Delete.php b/CRM/Contribute/Form/ContributionPage/Delete.php index 45accd9a0f..af5f825153 100644 --- a/CRM/Contribute/Form/ContributionPage/Delete.php +++ b/CRM/Contribute/Form/ContributionPage/Delete.php @@ -53,7 +53,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co protected $_relatedContributions; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -78,7 +78,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index 18c5e9bbcd..1292ad13a6 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_ContributionPage { /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -61,7 +61,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -111,7 +111,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index 3046183d00..23b64eb604 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -35,7 +35,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ContributionPage { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -45,7 +45,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -113,7 +113,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionPage/TabHeader.php b/CRM/Contribute/Form/ContributionPage/TabHeader.php index 5c6924a569..3f108b12dc 100644 --- a/CRM/Contribute/Form/ContributionPage/TabHeader.php +++ b/CRM/Contribute/Form/ContributionPage/TabHeader.php @@ -38,7 +38,7 @@ */ class CRM_Contribute_Form_ContributionPage_TabHeader { /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ @@ -58,7 +58,7 @@ class CRM_Contribute_Form_ContributionPage_TabHeader { } /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index d809ed7ff2..6cb44fb5ca 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ContributionPage { /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -53,7 +53,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index 887858a754..0eeba213a2 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -129,7 +129,7 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -206,7 +206,7 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Contribute/Form/ContributionView.php b/CRM/Contribute/Form/ContributionView.php index b370521f49..c1dd5d4e71 100644 --- a/CRM/Contribute/Form/ContributionView.php +++ b/CRM/Contribute/Form/ContributionView.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -200,7 +200,7 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index e324ccd2ae..3d91599933 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { /** - * Function to pre process the form + * pre process the form * * @access public * @@ -51,7 +51,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * This function sets the default values for the form. Manage Premiums that in edit/view mode + * Set default values for the form. Manage Premiums that in edit/view mode * the default values are retrieved from the database * * @access public @@ -87,7 +87,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -272,7 +272,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Contribute/Form/Search.php b/CRM/Contribute/Form/Search.php index ab349f2a9f..f51c6426d0 100644 --- a/CRM/Contribute/Form/Search.php +++ b/CRM/Contribute/Form/Search.php @@ -174,7 +174,7 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/SearchContribution.php b/CRM/Contribute/Form/SearchContribution.php index e7341b5f04..9e36a86859 100644 --- a/CRM/Contribute/Form/SearchContribution.php +++ b/CRM/Contribute/Form/SearchContribution.php @@ -35,7 +35,7 @@ class CRM_Contribute_Form_SearchContribution extends CRM_Core_Form { /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 962f613e24..17d480cd9f 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -39,9 +39,9 @@ class CRM_Contribute_Form_SoftCredit { /** - * Function to set variables up before form is built + * set variables up before form is built * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access static diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index 431552df05..c40165afd6 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -101,7 +101,7 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -201,12 +201,10 @@ 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 $nextType + * @param string $nextType button type for the form after processing * @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/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index ddf3079311..0157e18127 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -86,7 +86,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -191,7 +191,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -270,6 +270,5 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { CRM_Core_Session::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert'); } } - //end of function } diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index 2fd4425187..553b778bc1 100644 --- a/CRM/Contribute/Form/Task/Delete.php +++ b/CRM/Contribute/Form/Task/Delete.php @@ -62,7 +62,7 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index d4cfc6ba38..971d634b6d 100644 --- a/CRM/Contribute/Form/Task/Email.php +++ b/CRM/Contribute/Form/Task/Email.php @@ -72,7 +72,7 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 43cbaa9f28..2e47f00053 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -145,7 +145,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -229,9 +229,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { /** * global validation rules for the form * - * @param $values - * - * @internal param array $fields posted values of the form + * @param array $values * * @return array list of errors to be posted back to the form * @static @@ -267,7 +265,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * @param array $contribIDs Contribution Id * @param array $params associated array of submitted values * @param array $contactIds Contact Id - * @param object $form form object + * @param CRM_Core_Form $form form object * @static * */ diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index e3cd688a7d..13e42ab522 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -100,7 +100,7 @@ AND {$this->_componentClause}"; } /** - * Build the form + * Build the form object * * @access public * @@ -191,8 +191,6 @@ AND {$this->_componentClause}"; // CRM_Contribute_BAO_Contribution::composeMessageArray expects mysql formatted date $objects['contribution']->receive_date = CRM_Utils_Date::isoToMysql($objects['contribution']->receive_date); - // CRM_Core_Error::debug('input',$input); - $values = array(); $mail = $elements['baseIPN']->sendMail($input, $ids, $objects, $values, FALSE, $elements['createPdf']); diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index 86ace17144..cbd70b25f0 100644 --- a/CRM/Contribute/Form/Task/PDFLetter.php +++ b/CRM/Contribute/Form/Task/PDFLetter.php @@ -105,7 +105,7 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index 4b5ff64432..04550ae7cd 100644 --- a/CRM/Contribute/Form/Task/PDFLetterCommon.php +++ b/CRM/Contribute/Form/Task/PDFLetterCommon.php @@ -161,8 +161,6 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF * @param $entity * @param $textToSearch * - * @internal param $html - * * @return bool */ static function isHtmlTokenInTableCell($token, $entity, $textToSearch) { diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 54f79554c7..4663fb2f38 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -87,7 +87,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -149,6 +149,5 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { // also reset the batch page so it gets new values from the db $this->controller->resetPage('Batch'); } - //end of function } diff --git a/CRM/Contribute/Form/Task/Print.php b/CRM/Contribute/Form/Task/Print.php index 668f49f184..31f058faf0 100644 --- a/CRM/Contribute/Form/Task/Print.php +++ b/CRM/Contribute/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Contribute/Form/Task/Result.php b/CRM/Contribute/Form/Task/Result.php index ba9cccc9e5..52e85e5f11 100644 --- a/CRM/Contribute/Form/Task/Result.php +++ b/CRM/Contribute/Form/Task/Result.php @@ -49,7 +49,7 @@ class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task { function preProcess() {} /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/Task/SearchTaskHookSample.php b/CRM/Contribute/Form/Task/SearchTaskHookSample.php index 3f1f6f968b..6f046054cd 100644 --- a/CRM/Contribute/Form/Task/SearchTaskHookSample.php +++ b/CRM/Contribute/Form/Task/SearchTaskHookSample.php @@ -75,7 +75,7 @@ INNER JOIN civicrm_contact ct ON ( co.contact_id = ct.id ) } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index 152564908c..f31c046b77 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -88,7 +88,7 @@ AND {$this->_componentClause}"; } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index ea233ce446..96c0f0aa42 100644 --- a/CRM/Contribute/Form/UpdateBilling.php +++ b/CRM/Contribute/Form/UpdateBilling.php @@ -56,7 +56,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { public $_paymentProcessorObj = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -185,7 +185,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -220,7 +220,6 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { * @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/Form/UpdateSubscription.php b/CRM/Contribute/Form/UpdateSubscription.php index dc4e6dbca9..d257c3df13 100644 --- a/CRM/Contribute/Form/UpdateSubscription.php +++ b/CRM/Contribute/Form/UpdateSubscription.php @@ -125,7 +125,7 @@ class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -143,7 +143,7 @@ class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form { } /** - * Function to actually build the components of the form + * actually build the components of the form * * @return void * @access public diff --git a/CRM/Contribute/Import/Form/DataSource.php b/CRM/Contribute/Import/Form/DataSource.php index 0603011d22..fa7b216b0c 100644 --- a/CRM/Contribute/Import/Form/DataSource.php +++ b/CRM/Contribute/Import/Form/DataSource.php @@ -39,7 +39,7 @@ class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -52,7 +52,7 @@ class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index fbf8c3d9b2..603ced032e 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -100,7 +100,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Contribute/Import/Form/Preview.php b/CRM/Contribute/Import/Form/Preview.php index 5703012fbe..c039280087 100644 --- a/CRM/Contribute/Import/Form/Preview.php +++ b/CRM/Contribute/Import/Form/Preview.php @@ -40,7 +40,7 @@ class CRM_Contribute_Import_Form_Preview extends CRM_Import_Form_Preview { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Contribute/Import/Form/Summary.php b/CRM/Contribute/Import/Form/Summary.php index e3bbaf5396..dc12f89929 100644 --- a/CRM/Contribute/Import/Form/Summary.php +++ b/CRM/Contribute/Import/Form/Summary.php @@ -39,7 +39,7 @@ class CRM_Contribute_Import_Form_Summary extends CRM_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index a0ede60f23..309fad1fd3 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -33,7 +33,6 @@ * */ - abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { /** @@ -44,11 +43,6 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { protected $_fileName; - /**#@+ - * @access protected - * @var integer - */ - /** * imported file size */ @@ -401,7 +395,6 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates); } } - //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; return $this->fini(); } @@ -411,7 +404,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { * * @param array mapped array of values * -pppp * @return void + * @return void * @access public */ function setActiveFields($fieldKeys) { @@ -427,7 +420,7 @@ pppp * @return void } /** - * @param $elements + * @param array $elements */ function setActiveFieldSoftCredit($elements) { for ($i = 0; $i < count($elements); $i++) { @@ -436,15 +429,16 @@ pppp * @return void } /** - * @param $elements + * @param array $elements */ function setActiveFieldSoftCreditType($elements) { for ($i = 0; $i < count($elements); $i++) { $this->_activeFields[$i]->_softCreditType = $elements[$i]; } } + /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public @@ -564,17 +558,15 @@ pppp * @return void $store->set('duplicatesFileName', $this->_duplicateFileName); } } - //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; } /** * Export data to a CSV file * - * @param $fileName + * @param string $fileName * @param array $header - * @param data $data + * @param array $data * - * @internal param string $filename * @return void * @access public */ @@ -611,12 +603,7 @@ pppp * @return void /** * Determines the file extension based on error code * - * @var $type error code constant - * @return string - * @static - */ - /** - * @param error $type + * @param int $type error code constant * * @return string */ @@ -649,12 +636,7 @@ pppp * @return void /** * Determines the file name based on error code * - * @var $type error code constant - * @return string - * @static - */ - /** - * @param error $type + * @param int $type error code constant * * @return string */ diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php index 2d8daaeaad..ad579f29e2 100644 --- a/CRM/Contribute/Import/Parser/Contribution.php +++ b/CRM/Contribute/Import/Parser/Contribution.php @@ -565,7 +565,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * Function to process pledge payments + * process pledge payments */ function processPledgePayments(&$formatted) { if (!empty($formatted['pledge_payment_id']) && !empty($formatted['pledge_id'])) { diff --git a/CRM/Contribute/Page/ContributionPage.php b/CRM/Contribute/Page/ContributionPage.php index f0c2417699..c958e280b7 100644 --- a/CRM/Contribute/Page/ContributionPage.php +++ b/CRM/Contribute/Page/ContributionPage.php @@ -555,7 +555,7 @@ ORDER BY title asc } /** - * @param $params + * @param array $params * @param bool $sortBy * * @return int|string diff --git a/CRM/Contribute/Page/Premium.php b/CRM/Contribute/Page/Premium.php index c816e7caed..bc4c33f8e0 100644 --- a/CRM/Contribute/Page/Premium.php +++ b/CRM/Contribute/Page/Premium.php @@ -127,7 +127,6 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { } /** - * * @return void * @access public * @static diff --git a/CRM/Contribute/Page/Tab.php b/CRM/Contribute/Page/Tab.php index 17cf83a976..8dbc16a80a 100644 --- a/CRM/Contribute/Page/Tab.php +++ b/CRM/Contribute/Page/Tab.php @@ -46,8 +46,6 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { public $_contactId = NULL; public $_crid = NULL; - //end of function - /** * This method returns the links that are given for recur search row. * currently the links added for each row are: diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 6c96eba78e..91307e36e0 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -209,7 +209,6 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C $this->_query->_groupByComponentClause = " GROUP BY civicrm_contribution.id "; } } - //end of constructor /** * This method returns the links that are given for each search row. @@ -262,14 +261,12 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params - * @internal param $ + * @param array $params * @access public */ function getPagerParams($action, &$params) { @@ -285,7 +282,6 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -429,7 +425,6 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * * @return array $qill which contains an array of strings * @access public */ diff --git a/CRM/Contribute/StateMachine/Contribution.php b/CRM/Contribute/StateMachine/Contribution.php index f32a199d72..f2ebf58390 100644 --- a/CRM/Contribute/StateMachine/Contribution.php +++ b/CRM/Contribute/StateMachine/Contribution.php @@ -42,11 +42,10 @@ class CRM_Contribute_StateMachine_Contribution extends CRM_Core_StateMachine { /** * class constructor * - * @param object $controller + * @param CRM_Contact_Import_Controller $controller * @param \const|int $action * - * @internal param \CRM_Contact_Import_Controller $object - * @return \CRM_Contribute_StateMachine_Contribution CRM_Contact_Import_StateMachine + * @return CRM_Contribute_StateMachine_Contribution */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Contribute/StateMachine/ContributionPage.php b/CRM/Contribute/StateMachine/ContributionPage.php index cad1d182b8..a80348b113 100644 --- a/CRM/Contribute/StateMachine/ContributionPage.php +++ b/CRM/Contribute/StateMachine/ContributionPage.php @@ -42,11 +42,10 @@ class CRM_Contribute_StateMachine_ContributionPage extends CRM_Core_StateMachine /** * class constructor * - * @param object $controller - * @param \const|int $action + * @param CRM_Contribute_Controller_ContributionPage $controller + * @param const|int $action * - * @internal param \CRM_Contribute_Controller_ContributionPage $object - * @return \CRM_Contribute_StateMachine_ContributionPage CRM_Contribute_StateMachine_ContributionPage + * @return CRM_Contribute_StateMachine_ContributionPage */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index e1de9c1f27..dbda3a7860 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -76,7 +76,7 @@ class CRM_Core_Action { * bit manipulation operations so we can perform multiple * actions on the same object if needed * - * @var array _names tupe of variable name to action constant + * @var array $_names type of variable name to action constant * * @access private * @static @@ -111,12 +111,9 @@ class CRM_Core_Action { static $_description; /** - * * called by the request object to translate a string into a mask * - * @param $str - * - * @internal param string $action the action to be resolved + * @param string $str the action to be resolved * * @return int the action mask corresponding to the input string * @access public @@ -135,7 +132,7 @@ class CRM_Core_Action { * Given a string or an array of strings, determine the bitmask * for this set of actions * - * @param mixed either a single string or an array of strings + * @param mixed $item either a single string or an array of strings * * @return int the action mask corresponding to the input args * @access public @@ -159,7 +156,7 @@ class CRM_Core_Action { /** * Given a string determine the bitmask for this specific string * - * @param string the input action to process + * @param string $item the input action to process * * @return int the action mask corresponding to the input string * @access public @@ -175,7 +172,7 @@ class CRM_Core_Action { * * Given an action mask, find the corresponding description * - * @param int the action mask + * @param int $mask the action mask * * @return string the corresponding action description * @access public diff --git a/CRM/Core/BAO/ActionLog.php b/CRM/Core/BAO/ActionLog.php index d57a53da1f..c945ee4db6 100644 --- a/CRM/Core/BAO/ActionLog.php +++ b/CRM/Core/BAO/ActionLog.php @@ -42,7 +42,7 @@ class CRM_Core_BAO_ActionLog extends CRM_Core_DAO_ActionLog { /** * Create or update an action log entry * - * @param $params + * @param array $params * * @return actionLog array * @access public diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 926585c8c5..0e6340ad49 100755 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -579,12 +579,12 @@ AND cas.entity_value = $id AND } /** - * Function to add the schedules reminders in the db + * add the schedules reminders in the db * * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids the array that holds all the db ids * - * @return object CRM_Core_DAO_ActionSchedule + * @return CRM_Core_DAO_ActionSchedule * @access public * @static * @@ -604,7 +604,7 @@ AND cas.entity_value = $id AND * @param array $params (reference ) an assoc array of name/value pairs * @param array $values (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_ActionSchedule object on success, null otherwise + * @return CRM_Core_DAO_ActionSchedule object on success, null otherwise * @access public * @static */ @@ -627,7 +627,7 @@ AND cas.entity_value = $id AND } /** - * Function to delete a Reminder + * delete a Reminder * * @param int $id ID of the Reminder to be deleted. * diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 1c1ebf7604..799b60c123 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -545,10 +545,7 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * * @param bool $microformat * - * @internal param $NULL - * * @return void - * * @access public */ function addDisplay($microformat = FALSE) { @@ -656,7 +653,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * Function to get address sequence + * get address sequence * * @return array of address sequence. */ @@ -875,7 +872,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * Function to check if current address fields are shared with any other address + * check if current address fields are shared with any other address * * @param array $fields address fields in profile * @param int $contactId contact id @@ -946,7 +943,7 @@ SELECT is_primary, } /** - * Function to update the shared addresses if master address is modified + * update the shared addresses if master address is modified * * @param int $addressId address id * @param array $params associated array of address params diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index f14d4f981e..c05cdd204f 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -54,9 +54,6 @@ class CRM_Core_BAO_Block { * @param string $blockName name of the above object * @param array $params input parameters to find object * - * @internal param Object $block typically a Phone|Email|IM|OpenID object - * @internal param array $values output values of the object - * * @return array of $block objects. * @access public * @static @@ -102,8 +99,6 @@ class CRM_Core_BAO_Block { * @param Object $block typically a Phone|Email|IM|OpenID object * @param string $blockName name of the above object * - * @internal param array $values output values of the object - * * @return array of $block objects. * @access public * @static @@ -167,7 +162,7 @@ class CRM_Core_BAO_Block { } /** - * Function to get all block ids for a contact + * get all block ids for a contact * * @param string $blockName block name * @param int $contactId contact id @@ -217,8 +212,6 @@ class CRM_Core_BAO_Block { * @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 * @static @@ -393,7 +386,7 @@ class CRM_Core_BAO_Block { } /** - * Function to delete block + * delete block * * @param string $blockName block name * @param int $params associates array @@ -509,9 +502,8 @@ class CRM_Core_BAO_Block { /** * Sort location array so primary element is first * - * @param $locations + * @param array $locations * - * @internal param Array $location */ static function sortPrimaryFirst(&$locations){ uasort($locations, 'self::primaryComparison'); @@ -521,7 +513,7 @@ class CRM_Core_BAO_Block { * compare 2 locations to see which should go first based on is_primary * (sort function for sortPrimaryFirst) * @param array $location1 - * @param array_type $location2 + * @param array $location2 * @return number */ static function primaryComparison($location1, $location2){ diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index 4c08c1fbf1..72c6152b00 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -45,7 +45,7 @@ require_once 'DB.php'; class CRM_Core_BAO_CMSUser { /** - * Function for synchronizing cms users with CiviCRM contacts + * synchronizing cms users with CiviCRM contacts * * @param bool $is_interactive whether to show statuses & perform redirects * This behavior is misplaced in the BAO layer, but we'll preserve it to avoid @@ -221,7 +221,7 @@ class CRM_Core_BAO_CMSUser { } /** - * Function to create CMS user using Profile + * create CMS user using Profile * * @param array $params associated array * @param string $mail email id for cms user @@ -255,9 +255,9 @@ class CRM_Core_BAO_CMSUser { } /** - * Function to create Form for CMS user using Profile + * create Form for CMS user using Profile * - * @param object $form + * @param CRM_Core_Form $form * @param integer $gid id of group of profile * @param bool $emailPresent true if the profile field has email(primary) * @param \const|int $action @@ -339,23 +339,17 @@ class CRM_Core_BAO_CMSUser { $form->assign('showCMS', $showCMS); } - /* + /** * Checks that there is a valid username & email - * optionally checks password is present & matches DB & gets the CMS to validate - * - * @params array $fields Posted values of form - * @param array $files uploaded files if any - * @param array $self reference to form object + * optionally checks password is present & matches DB & gets the CMS to validate * - */ - /** - * @param $fields - * @param $files - * @param $self + * @param array $fields Posted values of form + * @param array $files uploaded files if any + * @param CRM_Core_Form $form * * @return array|bool */ - static function formRule($fields, $files, $self) { + static function formRule($fields, $files, $form) { if (empty($fields['cms_create_account'])) { return TRUE; } @@ -369,9 +363,9 @@ class CRM_Core_BAO_CMSUser { $errors = array(); if ($isDrupal || $isJoomla || $isWordPress) { $emailName = NULL; - if (!empty($self->_bltID) && array_key_exists("email-{$self->_bltID}", $fields)) { + if (!empty($form->_bltID) && array_key_exists("email-{$form->_bltID}", $fields)) { // this is a transaction related page - $emailName = 'email-' . $self->_bltID; + $emailName = 'email-' . $form->_bltID; } else { // find the email field in a profile page foreach ($fields as $name => $dontCare) { diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 1e9658270e..279a2fb860 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -41,12 +41,10 @@ class CRM_Core_BAO_ConfigSetting { /** - * Function to create civicrm settings. This is the same as add but it clears the cache and + * create civicrm settings. This is the same as add but it clears the cache and * reloads the config object * - * @params array $params associated array of civicrm variables - * - * @param $params + * @param array $params associated array of civicrm variables * * @return null * @static @@ -60,11 +58,9 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Function to add civicrm settings - * - * @params array $params associated array of civicrm variables + * add civicrm settings * - * @param $params + * @param array $params associated array of civicrm variables * * @return null * @static @@ -143,11 +139,9 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Function to fix civicrm setting variables - * - * @params array $params associated array of civicrm variables + * fix civicrm setting variables * - * @param $params + * @param array $params associated array of civicrm variables * * @return null * @static diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 9c7762842d..f541e52388 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -313,16 +313,12 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_CustomField object + * @return CRM_Core_DAO_CustomField object * @access public * @static */ @@ -724,11 +720,10 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param string $elementName name of the custom field * @param $fieldId * @param boolean $inactiveNeeded -deprecated - * @param bool $useRequired + * @param bool $useRequired true if required else false * @param boolean $search true if used for search else false * @param string $label label for custom field * - * @internal param bool $userRequired true if required else false * @access public * @static */ @@ -1315,16 +1310,12 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Function to set default values for custom data used in profile - * - * @params int $customFieldId custom field id - * @params string $elementName custom field name - * @params array $defaults associated array of fields - * @params int $contactId contact id - * @param $customFieldId - * @param $elementName - * @param $defaults - * @param null $contactId + * set default values for custom data used in profile + * + * @param int $customFieldId custom field id + * @param string $elementName custom field name + * @param array $defaults associated array of fields + * @param int $contactId contact id * @param int $mode profile mode * @param mixed $value if passed - dont fetch value from db, * just format the given value @@ -1765,7 +1756,7 @@ SELECT $columnName } /** - * @param $params + * @param array $params * * @return array */ @@ -2035,9 +2026,9 @@ AND cf.id = %1"; } /** - * Function to get custom option groups + * get custom option groups * - * @params array $includeFieldIds ids of custom fields for which + * @param array $includeFieldIds ids of custom fields for which * option groups must be included. * * Currently this is required in the cases where option groups are to be included @@ -2045,8 +2036,6 @@ AND cf.id = %1"; * * @access public * - * @param null $includeFieldIds - * * @return mixed $customOptionGroup@static */ public static function &customOptionGroup($includeFieldIds = NULL) { @@ -2084,16 +2073,12 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) } /** - * Function to fix orphan groups + * fix orphan groups * - * @params int $customFieldId custom field id - * @params int $optionGroupId option group id + * @param int $customFieldId custom field id + * @param int $optionGroupId option group id * * @access public - * - * @param $customFieldId - * @param $optionGroupId - * * @return void * @static */ @@ -2118,12 +2103,10 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) * Function to check if option group is related to more than one * custom field * - * @params int $optionGroupId option group id - * - * @param $optionGroupId + * @param int $optionGroupId option group id * * @return void - @static + * @static */ static function checkOptionGroup($optionGroupId) { $query = " @@ -2187,7 +2170,7 @@ ORDER BY html_type"; } /** - * @param $params + * @param array $params * @param $customFields * @param $entityID * @param $customFieldExtends diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 3ebde84aff..72bd04a613 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -53,7 +53,7 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Core_DAO_CustomGroup object + * @return CRM_Core_DAO_CustomGroup object * @access public * @static */ @@ -212,16 +212,12 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_CustomGroup object + * @return CRM_Core_DAO_CustomGroup object * @access public * @static */ @@ -301,19 +297,14 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * An array containing all custom groups and their custom fields is returned. * * @param string $entityType - of the contact whose contact type is needed - * @param object $form - not used but required - * @param null $entityID - * @param null $groupID + * @param CRM_Core_Form $form - not used but required + * @param int $entityID + * @param int $groupID * @param string $subType * @param string $subName - * @param boolean $fromCache + * @param bool $fromCache + * @param bool $onlySubType * - * @param null $onlySubType - * - * @internal param int $entityId - optional - id of entity if we need to populate the tree with custom values. - * @internal param int $groupId - optional group id (if we need it for a single group only) - * - if groupId is 0 it gets for inline groups only - * - if groupId is -1 we get for all groups * @return array $groupTree - array The returned array is keyed by group id and has the custom group table fields * and a subkey 'fields' holding the specific custom fields. * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data @@ -1373,7 +1364,7 @@ ORDER BY civicrm_custom_group.weight, /** * @param $groupTree - * @param $params + * @param array $params * @param bool $skipFile */ static function postProcess(&$groupTree, &$params, $skipFile = FALSE) { @@ -1491,7 +1482,7 @@ ORDER BY civicrm_custom_group.weight, /** * generic function to build all the form elements for a specific group tree * - * @param object $form the form object + * @param CRM_Core_Form $form the form object * @param array $groupTree the group tree object * @param boolean $inactiveNeeded return inactive custom groups * @param string $prefix prefix for custom grouptree assigned to template @@ -1525,7 +1516,7 @@ ORDER BY civicrm_custom_group.weight, } /** - * Function to extract the get params from the url, validate + * extract the get params from the url, validate * and store it in session * * @param CRM_Core_Form $form the form object @@ -1620,7 +1611,7 @@ ORDER BY civicrm_custom_group.weight, } /** - * Function to check the type of custom field type (eg: Used for Individual, Contribution, etc) + * check the type of custom field type (eg: Used for Individual, Contribution, etc) * this function is used to get the custom fields of a type (eg: Used for Individual, Contribution, etc ) * * @param int $customFieldId custom field id @@ -1800,7 +1791,7 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Build custom data view * - * @param object $form page object + * @param CRM_Core_Form $form page object * @param array $groupTree associated array * @param boolean $returnCount true if customValue count needs to be returned * @param null $gID diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index bf2cb527d9..0c7c0fb29b 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -40,16 +40,12 @@ class CRM_Core_BAO_CustomOption { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_CustomOption object + * @return CRM_Core_BAO_CustomOption object * @access public * @static */ @@ -66,10 +62,9 @@ class CRM_Core_BAO_CustomOption { /** * Returns all active options ordered by weight for a given field * - * @param $fieldID + * @param int $fieldID field whose options are needed * @param boolean $inactiveNeeded do we need inactive options ? * - * @internal param int $fieldId field whose options are needed * @return array $customOption all active options for fieldId * @static */ @@ -166,7 +161,7 @@ WHERE id = %1 } /** - * Function to delete Option + * delete Option * * param $optionId integer option id * @@ -213,7 +208,7 @@ WHERE id = %1"; } /** - * @param $params + * @param array $params * * @throws Exception */ diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index bc4e0ccc47..597d0056a0 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -190,7 +190,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { } /** - * Function to delet option value give an option value and custom group id + * delet option value give an option value and custom group id * * @param int $customValueID custom value ID * @param int $customGroupID custom group ID diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index 2cb38118fd..f836c13f09 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -306,7 +306,7 @@ class CRM_Core_BAO_CustomValueTable { } /** - * @param $params + * @param array $params * @param $entityTable * @param $entityID */ @@ -352,7 +352,7 @@ class CRM_Core_BAO_CustomValueTable { } /** - * @param $params + * @param array $params * @param $customFields * @param $entityTable * @param $entityID @@ -484,13 +484,13 @@ AND $cond } /** - * Function to take in an array of entityID, custom_XXX => value + * take in an array of entityID, custom_XXX => value * and set the value in the appropriate table. Should also be able * to set the value to null. Follows api parameter/return conventions * * @array $params * - * @param $params + * @param array $params * * @throws Exception * @return array @@ -623,7 +623,7 @@ AND cf.id IN ( $fieldIDList ) } /** - * Function to take in an array of entityID, custom_ID + * take in an array of entityID, custom_ID * and gets the value from the appropriate table. * * To get the values of custom fields with IDs 13 and 43 for contact ID 1327, use: @@ -635,7 +635,7 @@ AND cf.id IN ( $fieldIDList ) * * @array $params * - * @param $params + * @param array $params * * @throws Exception * @return array diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index fdf9df8365..f00a8421ab 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -38,7 +38,7 @@ */ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** - * function to add Dashboard + * add Dashboard * * @param array $params values * @@ -186,12 +186,10 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** - * Function to check dashlet permission for current user + * check dashlet permission for current user * - * @param $permission - * @param $operator - * - * @internal param \permission $string string + * @param string $permission comma separated list + * @param string $operator * * @return boolean true if use has permission else false */ @@ -262,7 +260,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Function to get details of each dashlets + * get details of each dashlets * * @param int $dashletID widget ID * diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index 1644cee4e3..c7da07bfb9 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -42,12 +42,10 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { } /** - * Function to delete the discount + * delete the discount * - * @param $entityId - * @param $entityTable - * - * @internal param int $id discount id + * @param int $entityId + * @param string $entityTable * * @return boolean * @access public @@ -108,17 +106,14 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { /** * Determine in which discount set the registration date falls * - * @param $entityID - * @param string $entityTable entity table to be searched + * @param int $entityID entity id to be searched + * @param string $entityTable entity table to be searched * - * @internal param int $entityId entity id to be searched * @return integer $dao->id discount id of the set which matches * the date criteria */ static function findSet($entityID, $entityTable) { - if (empty($entityID) || - empty($entityTable) - ) { + if (empty($entityID) || empty($entityTable)) { // adding this here, to trap errors if values are not sent CRM_Core_Error::fatal(); return NULL; diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 5b4a6a8198..72bf9c1573 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -49,16 +49,12 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { private $_location = NULL; /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_Domain object + * @return CRM_Core_DAO_Domain object * @access public * @static */ @@ -100,7 +96,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * @deprecated * @see http://issues.civicrm.org/jira/browse/CRM-11204 */ - static function setDomain($domainID){ + static function setDomain($domainID) { CRM_Core_Config::domainID($domainID); self::getDomain($domainID); CRM_Core_Config::singleton(TRUE, TRUE); @@ -110,11 +106,10 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * Reset domain to default (ie. as loaded from settings). This is the * counterpart to CRM_Core_BAO_Domain::setDomain. * - * @internal param int $domainID id for domain you want to set as current * @deprecated * @see CRM_Core_BAO_Domain::setDomain */ - static function resetDomain(){ + static function resetDomain() { CRM_Core_Config::domainID(null, true); self::getDomain(null, true); CRM_Core_Config::singleton(TRUE, TRUE); @@ -125,12 +120,12 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * * @return null|string */ - static function version( $skipUsingCache = false ) { + static function version($skipUsingCache = false) { return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', CRM_Core_Config::domainID(), - 'version', - 'id', - $skipUsingCache + 'version', + 'id', + $skipUsingCache ); } @@ -160,10 +155,10 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * Save the values of a domain * - * @param $params + * @param array $params * @param $id * - * @return domain array + * @return array domain * @access public */ static function edit(&$params, &$id) { @@ -177,9 +172,9 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * Create a new domain * - * @param $params + * @param array $params * - * @return domain array + * @return array domain * @access public */ static function create($params) { @@ -315,8 +310,9 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { return $childGrps; } - // function to retrieve a list of contact-ids that belongs to current domain/site. /** + * retrieve a list of contact-ids that belongs to current domain/site. + * * @return array */ static function getContactList() { diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index 61a9370068..bd64e5f67d 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -232,7 +232,7 @@ ORDER BY e.is_primary DESC, email_id ASC "; } /** - * Function to set / reset hold status for an email + * set / reset hold status for an email * * @param object $email email object * diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 0b242ff87a..5c955b696c 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -72,7 +72,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Core_BAO_EntityTag object + * @return CRM_Core_BAO_EntityTag object * @access public * @static */ @@ -101,24 +101,22 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Check if there is data to create the object * - * @params array $params (reference ) an assoc array of name/value pairs - * - * @param $params + * @param array $params an assoc array of name/value pairs * * @return boolean * @access public * @static */ - static function dataExists(&$params) { - return ($params['tag_id'] == 0) ? FALSE : TRUE; + static function dataExists($params) { + return !($params['tag_id'] == 0); } /** - * Function to delete the tag for a contact + * delete the tag for a contact * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Core_BAO_EntityTag object + * @return CRM_Core_BAO_EntityTag object * @access public * @static * @@ -138,10 +136,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @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 + * @param string $entityTable name of entity table default:civicrm_contact * - * @return array (total, added, notAdded) count of enities added to tag + * @return array (total, added, notAdded) count of enities added to tag * @access public * @static */ @@ -182,10 +179,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @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 + * @param string $entityTable name of entity table default:civicrm_contact * - * @return array (total, removed, notRemoved) count of entities removed from tags + * @return array (total, removed, notRemoved) count of entities removed from tags * @access public * @static */ @@ -224,12 +220,10 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * takes an associative array and creates tag entity record for all tag entities * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params (reference) an assoc array of name/value pairs * @param $entityTable * @param $entityID * - * @internal param array $contactId contact id - * * @return void * @access public * @static @@ -288,7 +282,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Function to get contact tags + * get contact tags */ static function getContactTags($contactID, $count = FALSE) { $contactTags = array(); @@ -321,7 +315,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Function to get child contact tags given parentId + * get child contact tags given parentId */ static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') { $entityTags = array(); diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index 81d902a627..61bd52f8ba 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -40,16 +40,12 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_LocationType object on success, null otherwise + * @return CRM_Core_BAO_LocationType object on success, null otherwise * @access public * @static */ @@ -64,7 +60,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { } /** - * Function to delete an extension + * delete an extension * * @param int $id Id of the extension to be deleted. * diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index 8bb38e85a8..1178630047 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -457,7 +457,7 @@ AND CEF.entity_id = %2"; } /** - * Function to return a clean url string and the number of attachment for a + * return a clean url string and the number of attachment for a * given entityTable, entityID * * @param $entityTable string The entityTable to which the file is attached @@ -485,7 +485,7 @@ AND CEF.entity_id = %2"; /** * @param $formValues - * @param $params + * @param array $params * @param $entityTable * @param null $entityID */ @@ -538,7 +538,7 @@ AND CEF.entity_id = %2"; } /** - * @param $params + * @param array $params * @param $entityTable * @param $entityID */ @@ -580,7 +580,7 @@ AND CEF.entity_id = %2"; } /* - * Function to copy/attach an existing file to a different entity + * copy/attach an existing file to a different entity * table and id. */ /** @@ -622,7 +622,7 @@ AND CEF.entity_id = %2"; } /** - * function to delete a file attachment from an entity table / entity ID + * delete a file attachment from an entity table / entity ID * * @static * @access public diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index c6afcd61b6..c6daefa77e 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -54,7 +54,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * * @param string $trxnEntityTable entity_table * - * @return object CRM_Core_BAO_FinancialTrxn object + * @return CRM_Core_BAO_FinancialTrxn object * @access public * @static */ @@ -120,16 +120,12 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType object * @access public * @static */ @@ -144,18 +140,14 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { } /** - * * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param $entity_id + * @param $entity_id id of the entity usually the contactID. * @param string $orderBy to get single trxn id for a entity table i.e last or first. - * * @param bool $newTrxn * - * @internal param string $entityTable name of the entity table usually 'civicrm_contact' - * @internal param int $entityID id of the entity usually the contactID. - * @return array( ) reference $tag array of category id's the contact belongs to. + * @return array $tag array of category id's the contact belongs to. * * @access public * @static @@ -194,14 +186,11 @@ 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 $entity_id + * @todo This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @internal param string $entityTable name of the entity table usually 'civicrm_contact' - * @internal param int $entityID id of the entity usually the contactID. + * @param int $entity_id id of the entity usually the contactID. * - * @return array( ) reference $tag array of catagory id's the contact belongs to. + * @return array $tag array of catagory id's the contact belongs to. * * @access public * @static @@ -221,11 +210,10 @@ WHERE ft.entity_table = 'civicrm_contribution' AND ft.entity_id = %1 /** * Given an financial_trxn_id check for previous entity_financial_trxn. * - * @param $financial_trxn_id + * @param $financial_trxn_id id of the latest payment. * - * @internal param int $financialTrxn_id id of the latest payment. * - * @return array( ) $payment array of previous payments + * @return array $payment array of previous payments * * @access public * @static @@ -274,13 +262,10 @@ WHERE ef2.financial_trxn_id =%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 $entity_id - * @param string $entity_table - * - * @internal param string $entityTable name of the entity table usually 'civicrm_contact' - * @internal param int $entityID id of the entity usually the contactID. + * @param $entity_id id of the entity usually the contactID. + * @param string $entity_table name of the entity table usually 'civicrm_contact' * - * @return array( ) reference $tag array of catagory id's the contact belongs to. + * @return array $tag array of catagory id's the contact belongs to. * * @access public * @static @@ -372,15 +357,15 @@ WHERE ceft.entity_id = %1"; CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($params); } } + /** * create financial trxn and items when fee is charged * - * @params params to create trxn entries + * @param array $params to create trxn entries * * @access public * @static */ - static function recordFees($params) { $expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Expense Account is' ")); $domainId = CRM_Core_Config::domainID(); @@ -431,7 +416,7 @@ WHERE ceft.entity_id = %1"; } /* - * function to get partial payment amount and type of it + * get partial payment amount and type of it * return @array : payment type => amount * payment type : 'amount_owed' or 'refund_due' */ diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index ada78e8c1c..928d090f52 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -46,13 +46,11 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Function to add the payment-processor type in the db + * add the payment-processor type in the db * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params an assoc array of name/value pairs * - * @internal param array $ids the array that holds all the db ids - * - * @return object CRM_Financial_DAO_PaymentProcessorType + * @return CRM_Financial_DAO_PaymentProcessorType * @access public * @static */ @@ -70,7 +68,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_Job object on success, null otherwise + * @return CRM_Core_DAO_Job object on success, null otherwise * @access public * @static */ @@ -102,9 +100,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** * Function to delete scheduled job * - * @param $jobID - * - * @internal param int $jobId ID of the job to be deleted. + * @param $jobID ID of the job to be deleted. * * @return bool|null * @access public diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index 162c48d60c..ce43759aa6 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -259,8 +259,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param string $name * - * @internal param $void - * * @return int Group ID (null if Group ID doesn't exist) * @access private */ @@ -431,7 +429,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param string $groupName * - * @return object CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue object * @access public * @static */ @@ -541,7 +539,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Function to delete a Label Format + * delete a Label Format * * @param int $id ID of the label format to be deleted. * @param string $groupName group name diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 2c054aed64..caf11dc2c1 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { static $blocks = array('phone', 'email', 'im', 'openid', 'address'); /** - * Function to create various elements of location block + * create various elements of location block * * @param array $params (reference ) an assoc array of name/value pairs * @param boolean $fixAddress true if you need to fix (format) address values @@ -168,7 +168,7 @@ WHERE e.id = %1"; } /** - * This function deletes the Location Block + * Delete the Location Block * * @param int $locBlockId id of the Location Block * @@ -233,15 +233,9 @@ 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 $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 * @static @@ -265,7 +259,7 @@ WHERE e.id = %1"; $name = ucfirst($block); } $baoString = 'CRM_Core_BAO_' . $name; - $blocks[$block] = $baoString::getValues( $entityBlock, $microformat ); + $blocks[$block] = $baoString::getValues($entityBlock, $microformat); } return $blocks; } @@ -304,17 +298,13 @@ WHERE e.id = %1"; } } - /* Function to copy or update location block. + /** + * Copy or update location block. * * @param int $locBlockId location block id. * @param int $updateLocBlockId update location block id - * @return int newly created/updated location block id. - */ - /** - * @param $locBlockId - * @param null $updateLocBlockId * - * @return mixed + * @return int newly created/updated location block id. */ static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) { //get the location info. diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index de7d95ad1e..687c6844ca 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -48,16 +48,12 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_LocaationType object on success, null otherwise + * @return CRM_Core_BAO_LocaationType object on success, null otherwise * @access public * @static */ @@ -121,12 +117,10 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Function to add a Location Type + * add a Location Type * * @param array $params reference array contains the values submitted by the form * - * @internal param array $ids reference array contains the id - * * @access public * @static * @@ -151,7 +145,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Function to delete location Types + * delete location Types * * @param int $locationTypeId ID of the location type to be deleted. * diff --git a/CRM/Core/BAO/Log.php b/CRM/Core/BAO/Log.php index c11f565fe0..54ca8a133e 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -151,11 +151,9 @@ UPDATE civicrm_log } /** - * Function to get log record count for a Contact + * get log record count for a Contact * - * @param $contactID - * - * @internal param int $contactId Contact ID + * @param int $contactID * * @return int count of log records * @access public diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index c5699495a9..1e373c9d4c 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -111,7 +111,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_MailSettings object + * @return CRM_Core_BAO_MailSettings object * @access public * @static */ @@ -129,7 +129,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * function to add new mail Settings. + * add new mail Settings. * * @param array $params reference array contains the values submitted by the form * @@ -168,7 +168,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Core_BAO_MailSettings object + * @return CRM_Core_BAO_MailSettings object * @access public * @static */ @@ -187,7 +187,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Function to delete the mail settings. + * delete the mail settings. * * @param int $id mail settings id * diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 4735d777aa..af69c07c08 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -42,11 +42,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values @@ -66,7 +62,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Function to delete the mapping + * delete the mapping * * @param int $id mapping id * @@ -115,11 +111,9 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * function to get the list of mappings + * get the list of mappings * - * @params string $mappingTypeId mapping type id - * - * @param $mappingTypeId + * @param string $mappingTypeId mapping type id * * @return array $mapping array of mapping name * @access public @@ -139,11 +133,9 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * function to get the mapping fields - * - * @params int $mappingId mapping id + * get the mapping fields * - * @param $mappingId + * @param int $mappingId mapping id * * @return array $mappingFields array of mapping fields * @access public @@ -199,14 +191,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - *function to check Duplicate Mapping Name - * - * @params $nameField string mapping Name + * Check Duplicate Mapping Name * - * @params $mapTypeId string mapping Type - * - * @param $nameField - * @param $mapTypeId + * @param $nameField string mapping Name + * @param $mapTypeId string mapping Type * * @return boolean */ @@ -214,20 +202,13 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { $mapping = new CRM_Core_DAO_Mapping(); $mapping->name = $nameField; $mapping->mapping_type_id = $mapTypeId; - if ($mapping->find(TRUE)) { - return TRUE; - } - else { - return FALSE; - } + return (bool) $mapping->find(TRUE); } /** * Function returns associated array of elements, that will be passed for search * - * @params int $smartGroupId smart group id - * - * @param $smartGroupId + * @param int $smartGroupId smart group id * * @return array $returnFields associated array of elements@static * @public @@ -257,17 +238,11 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function to build the mapping form * - * @params object $form form object - * @params string $mappingType mapping type (Export/Import/Search Builder) - * @params int $mappingId mapping id - * @params mixed $columnCount column count is int for and array for search builder - * @params int $blockCount block count (no of blocks shown) - * - * @param $form - * @param string $mappingType - * @param null $mappingId - * @param $columnNo - * @param int $blockCount + * @param CRM_Core_Form $form + * @param string $mappingType (Export/Import/Search Builder) + * @param int $mappingId + * @param int $columnNo + * @param int $blockCount (no of blocks shown) * @param null $exportMode * * @return void @@ -546,20 +521,16 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); - /* FIXME: dirty hack to make the default option show up first. This - * avoids a mozilla browser bug with defaults on dynamically constructed - * selector widgets. */ - - + // FIXME: dirty hack to make the default option show up first. This + // avoids a mozilla browser bug with defaults on dynamically constructed + // selector widgets. if ($defaultLocationType) { $defaultLocation = $locationTypes[$defaultLocationType->id]; unset($locationTypes[$defaultLocationType->id]); - $locationTypes = array( - $defaultLocationType->id => $defaultLocation) + $locationTypes; + $locationTypes = array($defaultLocationType->id => $defaultLocation) + $locationTypes; } - $locationTypes = array( - ' ' => ts('Primary')) + $locationTypes; + $locationTypes = array(' ' => ts('Primary')) + $locationTypes; // since we need a hierarchical list to display contact types & subtypes, // this is what we going to display in first selector @@ -568,8 +539,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { $contactTypes = array('Contact' => ts('Contacts')) + $contactTypes; } - $sel1 = - array('' => ts('- select record type -')) + $contactTypes + $compArray; + $sel1 = array('' => ts('- select record type -')) + $contactTypes + $compArray; foreach ($sel1 as $key => $sel) { if ($key) { @@ -612,8 +582,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } } - //Array for core fields and relationship custom data - + // Array for core fields and relationship custom data $relationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE); if ($mappingType == 'Export') { @@ -648,7 +617,6 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } //Location Type for relationship fields - foreach ($sel5 as $k => $v) { if ($v) { foreach ($v as $rel => $fields) { @@ -937,15 +905,13 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { $form->setDefaultAction('refresh'); } - /* Function returns all custom fields with group title and - * field label - * @relationshipTypeId related relationship type id - * @return $groupTitle all custom field titles - */ /** - * @param $relationshipTypeId + * Function returns all custom fields with group title and + * field label * - * @return array + * @param int $relationshipTypeId related relationship type id + * + * @return array all custom field titles */ function getRelationTypeCustomGroupData($relationshipTypeId) { @@ -961,9 +927,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns all Custom group Names * - * @param related $customfieldId + * @param int $customfieldId related file id * - * @internal param \related $customfieldId custom field id * @return null|string $customGroupName all custom group names@static */ static function getCustomGroupName($customfieldId) { @@ -982,11 +947,9 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns associated array of elements, that will be passed for search * - * @params array $params associated array of submitted values - * @params boolean $row row no of the fields + * @param array $params associated array of submitted values + * @param bool $row row no of the fields * - * @param $params - * @param bool $row * * @return array $returnFields formatted associated array of elements@static * @public @@ -1120,7 +1083,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 7d937735f0..d788f2c833 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -41,16 +41,12 @@ require_once 'Mail/mime.php'; class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_MessageTemplate object + * @return CRM_Core_BAO_MessageTemplate object * @access public * @static */ @@ -78,7 +74,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * function to add the Message Templates + * add the Message Templates * * @param array $params reference array contains the values submitted by the form * @@ -100,7 +96,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * function to delete the Message Templates + * delete the Message Templates * * @access public * @static @@ -130,7 +126,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * function to get the Message Templates + * get the Message Templates * * @access public * @static diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 2c3eb663d7..66c874ad99 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -60,7 +60,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Function to get existing / build navigation for CiviCRM Admin Menu + * get existing / build navigation for CiviCRM Admin Menu * * @static * @return array associated array @@ -81,7 +81,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Function to add/update navigation record + * add/update navigation record * * @param array associated array of submitted values * @@ -122,16 +122,12 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_Navigation object on success, null otherwise + * @return CRM_Core_BAO_Navigation object on success, null otherwise * @access public * @static */ @@ -257,7 +253,7 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare } /** - * Function to build navigation tree + * build navigation tree * * @param array $navigationTree nested array of menus * @param int $parentID parent id diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 2e27bdacc2..be5af9e245 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -241,7 +241,6 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @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 @@ -280,7 +279,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * Function to delete the notes + * delete the notes * * @param int $id note id * @param boolean $showStatus do we need to set status or not @@ -386,11 +385,9 @@ ORDER BY modified_date desc"; } /** - * Function to get log record count for a Contact + * get log record count for a Contact * - * @param $contactID - * - * @internal param int $contactId Contact ID + * @param int $contactID * * @return int $count count of log records * @@ -412,7 +409,7 @@ ORDER BY modified_date desc"; } /** - * Function to get all descendent notes of the note with given ID + * get all descendent notes of the note with given ID * * @param int $parentId ID of the note to start from * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents. @@ -524,8 +521,7 @@ ORDER BY modified_date desc"; * * @return array $ids One-dimensional array containing ids of all desendent notes */ - public static function getDescendentIds($parentId, &$ids = array( - )) { + public static function getDescendentIds($parentId, &$ids = array()) { // get direct children of given parentId note $note = new CRM_Core_DAO_Note(); $note->entity_table = 'civicrm_note'; @@ -544,8 +540,6 @@ ORDER BY modified_date desc"; * * @param int $contactID contact id whose notes to be deleted * - * @internal param array $deleteNoteID to store all deleted note ids - * * @return void * @static */ diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index 09592e0cfd..e3faeb246d 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -42,16 +42,12 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_OptionGroup object + * @return CRM_Core_BAO_OptionGroup object * @access public * @static */ @@ -79,7 +75,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * function to add the Option Group + * add the Option Group * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -111,7 +107,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Function to delete Option Group + * delete Option Group * * @param int $optionGroupId Id of the Option Group to be deleted. * @@ -132,7 +128,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Function to get title of the option group + * get title of the option group * * @param int $optionGroupId Id of the Option Group. * diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 99d99531bd..96c529a9b5 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -122,16 +122,12 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { return $bao->nextvalue; } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_OptionValue object + * @return CRM_Core_BAO_OptionValue object * @access public * @static */ @@ -159,7 +155,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Function to add an Option Value + * add an Option Value * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -226,11 +222,9 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Function to delete Option Value + * delete Option Value * - * @param $optionValueId - * - * @internal param int $optionGroupId Id of the Option Group to be deleted. + * @param int $optionValueId * * @return boolean * @@ -248,7 +242,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Function to retrieve activity type label and description + * retrieve activity type label and description * * @param int $activityTypeId activity type id * @@ -417,10 +411,9 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * updates options values weights. * - * @param $opGroupId + * @param int $opGroupId * @param array $opWeights options value , weight pair * - * @internal param int $opGroupIde option group id. * @return void * @access public * @static diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index d6811981af..9b61c28581 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -236,7 +236,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param array $params (reference ) an assoc array of name/value pairs * @param array $values (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue object * @access public * @static */ @@ -327,7 +327,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Function to delete a Paper Size + * delete a Paper Size * * @param int $id ID of the Paper Size to be deleted. * diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php index 96a0f3ae21..d6e0c436c2 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -298,7 +298,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param array $params (reference ) an assoc array of name/value pairs * @param array $values (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue object * @access public * @static */ @@ -385,7 +385,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Function to delete a PDF Page Format + * delete a PDF Page Format * * @param int $id ID of the PDF Page Format to be deleted. * diff --git a/CRM/Core/BAO/Persistent.php b/CRM/Core/BAO/Persistent.php index aabbdf5ba0..c1972f08b9 100644 --- a/CRM/Core/BAO/Persistent.php +++ b/CRM/Core/BAO/Persistent.php @@ -35,16 +35,12 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_Persistent object + * @return CRM_Core_BAO_Persistent object * @access public * @static */ @@ -63,7 +59,7 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { } /** - * function to add the Persistent Record + * add the Persistent Record * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 36c3c1f346..7f26b7307a 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -45,7 +45,7 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * @param array $params input parameters */ /** - * @param $params + * @param array $params * * @return object * @throws API_Exception @@ -117,8 +117,7 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * @access public * @static */ - static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array( - )) { + static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array()) { if (!$id) { return NULL; } diff --git a/CRM/Core/BAO/Preferences.php b/CRM/Core/BAO/Preferences.php index 919cb970e9..8c238944ff 100644 --- a/CRM/Core/BAO/Preferences.php +++ b/CRM/Core/BAO/Preferences.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Preferences { /** - * @param $params + * @param array $params */ static function fixAndStoreDirAndURL(&$params) { $sql = " @@ -78,7 +78,7 @@ AND v.is_active = 1 } /** - * @param $params + * @param array $params * @param string $type */ static function storeDirectoryOrURLPreferences(&$params, $type = 'directory') { @@ -111,7 +111,7 @@ AND v.name = %3 } /** - * @param $params + * @param array $params * @param bool $setInConfig */ static function retrieveDirectoryAndURLPreferences(&$params, $setInConfig = FALSE) { diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index 7ed77b106b..eae4fd7f59 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -47,16 +47,12 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_PreferencesDate object on success, null otherwise + * @return CRM_Core_BAO_PreferencesDate object on success, null otherwise * @access public * @static */ @@ -86,7 +82,7 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { } /** - * Function to delete preference dates + * delete preference dates * * @param int $id * diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php index fd0fcd9511..f27dad252d 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -340,15 +340,12 @@ AND c.created_date < date_sub( NOW( ), INTERVAL %2 day ) CRM_Core_DAO::executeQuery($sql, $params); } - - /* function for saving the checkbox selections - * $action select - select a particular contact - * unselect - unselect a particular contact - */ /** + * Save checkbox selections + * * @param $cacheKey * @param string $action - * @param null $cIds + * @param array $cIds * @param string $entity_table */ static function markSelection($cacheKey, $action = 'unselect', $cIds = NULL, $entity_table = 'civicrm_contact') { @@ -398,7 +395,7 @@ WHERE cacheKey LIKE %1 AND is_selected = 1 } /** - * function to get the selections + * get the selections * * @param string $cacheKey cache key * @param string $action action @@ -462,23 +459,23 @@ WHERE cacheKey LIKE %1 } /** - * @param $obj - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return mixed */ - static function buildSelectedContactPager( &$obj, &$params) { + static function buildSelectedContactPager(&$form, &$params) { $params['status'] = ts('Contacts %%StatusMessage%%'); $params['csvString'] = NULL; $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; - $params['rowCount'] = $obj->get(CRM_Utils_Pager::PAGE_ROWCOUNT); + $params['rowCount'] = $form->get(CRM_Utils_Pager::PAGE_ROWCOUNT); if (!$params['rowCount']) { $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT; } - $qfKey = CRM_Utils_Request::retrieve('qfKey','String', $this); + $qfKey = CRM_Utils_Request::retrieve('qfKey','String', $form); $cacheKey = "civicrm search {$qfKey}"; $query = " @@ -490,11 +487,11 @@ WHERE cacheKey LIKE %1 "; $params1[1] = array("{$cacheKey}%", 'String'); $params1[2] = array("{$cacheKey}_alphabet%", 'String'); - $paramsTotal = CRM_Core_DAO::singleValueQuery($query, $params1); + $paramsTotal = CRM_Core_DAO::singleValueQuery($query, $params1); $params['total'] = $paramsTotal; - $obj->_pager = new CRM_Utils_Pager($params); - $obj->assign_by_ref('pager', $obj->_pager); - list($offset, $rowCount) = $obj->_pager->getOffsetAndRowCount(); + $form->_pager = new CRM_Utils_Pager($params); + $form->assign_by_ref('pager', $form->_pager); + list($offset, $rowCount) = $form->_pager->getOffsetAndRowCount(); $params['offset'] = $offset; $params['rowCount1'] = $rowCount; return $params; diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 01491656ba..b5b145488c 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -133,7 +133,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { self::$status = $status; } /** - * Function to save records in civicrm_recujrring_entity table + * save records in civicrm_recujrring_entity table * * @param array $params reference array contains the values submitted by the form * @@ -1081,12 +1081,12 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * Update mode column in civicrm_recurring_entity table for event related tabs - * - * @params int $entityId event id - * @params string $linkedEntityTable Linked entity table name for this event - * @return array - */ + * Update mode column in civicrm_recurring_entity table for event related tabs + * + * @param int $entityId event id + * @param string $linkedEntityTable Linked entity table name for this event + * @return array + */ public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) { $result = array(); if ( $entityId && $linkedEntityTable && $mainEntityTable ) { diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 1853aa61d1..3ec0ff6efc 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -62,12 +62,9 @@ class CRM_Core_BAO_SchemaHandler { /** - * Function for creating a civiCRM-table + * Create a CiviCRM-table * - * @param $params - * - * @internal param String $tableName name of the table to be created. - * @internal param Array $tableAttributes array containing atrributes for the table that needs to be created + * @param array $params * * @return true if successfully created, false otherwise * @@ -94,7 +91,7 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $params + * @param array $params * * @return string */ @@ -129,7 +126,7 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $params + * @param array $params * @param $separator * @param $prefix * @@ -164,7 +161,7 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $params + * @param array $params * @param $separator * @param $prefix * @@ -182,7 +179,7 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $params + * @param array $params * @param $separator * @param $prefix * @param bool $indexExist @@ -215,7 +212,7 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $params + * @param array $params * @param $separator * @param $prefix * @@ -276,7 +273,7 @@ ALTER TABLE {$tableName} } /** - * @param $params + * @param array $params * @param $separator * @param $prefix * @param $tableName @@ -301,7 +298,7 @@ ALTER TABLE {$tableName} } /** - * @param $params + * @param array $params * @param bool $indexExist * @param bool $triggerRebuild * @@ -365,7 +362,7 @@ ALTER TABLE {$tableName} } /** - * Function to delete a civiCRM-table + * delete a civiCRM-table * * @param String $tableName name of the table to be created. * @@ -411,11 +408,9 @@ ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )"; * @param string $createIndexPrefix * @param array $substrLenghts */ - static function createIndexes(&$tables, $createIndexPrefix = 'index', $substrLenghts = array( - )) { + static function createIndexes(&$tables, $createIndexPrefix = 'index', $substrLenghts = array()) { $queries = array(); - - require_once 'CRM/Core/DAO/Domain.php'; + require_once 'CRM/Core/DAO/Domain.php'; $domain = new CRM_Core_DAO_Domain; $domain->find(TRUE); $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales); diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index dd8fac1069..2b1202c490 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -598,35 +598,6 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { return TRUE; } - /** - * Delete some or all of the items in the settings table - * - * @param string $group The group name of the entries to be deleted - * @param string $name The name of the setting to be deleted - * @param int $componentID The optional component ID (so componenets can share the same name space) - * - * @return void - * @static - * @access public - * - static function deleteItem($group, $name = NULL, $componentID = NULL, $contactID = NULL) { - $dao = self::dao($group, $name, $componentID, $contactID); - $dao->delete(); - - // also reset memory cache if any - CRM_Utils_System::flushCache(); - - $cacheKey = self::inCache($group, $name, $componentID, $contactID, FALSE); - if ($cacheKey) { - if ($name) { - unset(self::$_cache[$cacheKey][$name]); - } - else { - unset(self::$_cache[$cacheKey]); - } - } - }*/ - /** * This provides information about the setting - similar to the fields concept for DAO information. * As the setting is serialized code creating validation setting input needs to know the data type @@ -641,12 +612,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * The following params will filter the result. If none are passed all settings will be returns * - * @params string $name Name of specific setting e.g customCSSURL - * @params integer $componentID id of relevant component. - * - * @param null $componentID + * @param int $componentID id of relevant component * @param array $filters - * @param null $domainID + * @param int $domainID * @param null $profile * * @return array $result - the following information as appropriate for each setting @@ -936,7 +904,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * @param $params + * @param array $params * @param null $domainID */ static function fixAndStoreDirAndURL(&$params, $domainID = NULL) { @@ -1011,7 +979,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * @param $params + * @param array $params * @param $group */ static function storeDirectoryOrURLPreferences(&$params, $group) { @@ -1024,7 +992,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * @param $params + * @param array $params * @param bool $setInConfig */ static function retrieveDirectoryAndURLPreferences(&$params, $setInConfig = FALSE) { diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index b4779ba9cf..df2980d473 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -42,11 +42,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values @@ -267,7 +263,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Function to delete the tag + * delete the tag * * @param int $id tag id * @@ -375,7 +371,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Function to get the tag sets for a entity object + * get the tag sets for a entity object * * @param string $entityTable entity_table * @@ -396,7 +392,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Function to get the tags that are not children of a tagset. + * get the tags that are not children of a tagset. * * @return array $tags associated array of tag name and id@access public * @static diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 25f556d070..40cd04f808 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -47,16 +47,12 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_UFField object + * @return CRM_Core_BAO_UFField object * @access public * @static */ @@ -124,7 +120,7 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { } /** - * Function to check duplicate for duplicate field in a group + * check duplicate for duplicate field in a group * * @param array $params an associative array with field and values * @param $ids @@ -198,12 +194,12 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * function to add the UF Field + * add the UF Field * * @param array $params (reference) array containing the values submitted by the form * @param array $ids array containing the id * - * @return object CRM_Core_BAO_UFField object + * @return CRM_Core_BAO_UFField object * * @access public * @static @@ -272,7 +268,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to enable/disable profile field given a custom field id + * enable/disable profile field given a custom field id * * @param int $customFieldId custom field id * @param boolean $is_active set the is_active field @@ -366,9 +362,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Function to check the status of custom field used in uf fields * - * @params int $UFFieldId uf field id - * - * @param $UFFieldId + * @param int $UFFieldId * * @return boolean false if custom field are disabled else true * @static @@ -501,16 +495,12 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * function to check for mix profile fields (eg: individual + other contact types) - * - * @params int $ufGroupId uf group id - * @params boolean $check this is to check mix profile (if true it will check if profile is - * pure ie. it contains only one contact type) + * Check for mix profile fields (eg: individual + other contact types) * - * @param $ufGroupId + * @param int $ufGroupId * * @return true for mix profile else false - * @acess public + * @access public * @static */ static function checkProfileType($ufGroupId) { @@ -577,8 +567,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param bool $skipComponentType * - * @return profile group_type - * @acess public + * @return string profile group_type + * @access public * @static * * TODO Why is this function in this class? It seems to be about the UFGroup. @@ -595,15 +585,13 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * function to get the profile type (eg: individual/organization/household) * - * @param $ufGroupType + * @param string $ufGroupType * @param boolean $returnMixType this is true, then field type of mix profile field is returned * @param boolean $onlyPure true if only pure profiles are required - * * @param bool $skipComponentType * - * @internal param int $ufGroupId uf group id - * @return profile group_type - * @acess public + * @return string profile group_type + * @access public * @static * * TODO Why is this function in this class? It seems to be about the UFGroup. @@ -707,7 +695,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * @param $ctype * * @return true for mix profile group else false - * @acess public + * @access public * @static */ static function checkProfileGroupType($ctype) { @@ -738,11 +726,9 @@ SELECT ufg.id as id } /** - * check for searchable or in selector field for given profile. + * Check for searchable or in selector field for given profile. * - * @params int $profileID profile id. - * - * @param $profileID + * @param int $profileID * * @return boolean $result true/false. */ @@ -768,11 +754,9 @@ SELECT id } /** - *Reset In selector and is seachable values for given $profileID. - * - * @params int $profileID profile id. + * Reset In selector and is searchable values for given $profileID. * - * @param $profileID + * @param int $profileID * * @return void. */ diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index e0aff15c55..6446d1d575 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -49,11 +49,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { static $_matchFields = NULL; /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference) an assoc array of name/value pairs * @param array $defaults (reference) an assoc array to hold the flattened values @@ -260,14 +256,12 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param $searchable * @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 @@ -368,9 +362,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param null $ctype * @param int $permissionType * - * @internal param bool $showall * @return array - * @see getFields + * @see self::getFields */ public static function formatUFFields( $groupArr, @@ -889,9 +882,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param int $id the current contact id (hence excluded from matching) * @param string $contactType * - * @internal param bool $flatten should we flatten the input params - * - * @return contact_id if found, null otherwise + * @return int|null contact_id if found, null otherwise * @access public * @static */ @@ -917,10 +908,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param boolean $searchable searchable or not * @param array $componentWhere component condition * @param boolean $absolute return urls in absolute form (useful when sending an email) - * * @param null $additionalWhereClause * - * @internal param int $id the contact id * @return void * @access public * @static @@ -1386,7 +1375,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * function to add the UF Group + * add the UF Group * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -1429,7 +1418,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Function to make uf join entries for an uf group + * make uf join entries for an uf group * * @param array $params (reference) an assoc array of name/value pairs * @param int $ufGroupId ufgroup id @@ -1499,15 +1488,11 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to get the UF Join records for an ufgroup id - * - * @params int $ufGroupId uf group id - * @params int $displayName if set return display name in array - * @params int $status if set return module other than default modules (User Account/User registration/Profile) + * get the UF Join records for an ufgroup id * - * @param null $ufGroupId - * @param null $displayName - * @param null $status + * @param int $ufGroupId uf group id + * @param int $displayName if set return display name in array + * @param int $status if set return module other than default modules (User Account/User registration/Profile) * * @return array $ufGroupJoinRecords * @@ -1555,7 +1540,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Core_BAO_UFJoin object + * @return CRM_Core_BAO_UFJoin object * @access public * @static */ @@ -1620,7 +1605,6 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $op - which operation (view, edit, create, etc) to check permission for * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default * - * @internal param bool $skipPermision - whether to add permission clause * @return array $ufGroups array of ufgroups for a module * @access public * @static @@ -1691,10 +1675,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Function to filter ufgroups based on logged in user contact type * - * @params int $ufGroupId uf group id (profile id) - * - * @param $ufGroupId - * @param null $contactID + * @param int $ufGroupId uf group id (profile id) + * @param int $contactID * * @return boolean true or false * @static @@ -2240,18 +2222,12 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Function to set profile defaults * - * @params int $contactId contact id - * @params array $fields associative array of fields - * @params array $defaults defaults array - * @params boolean $singleProfile true for single profile else false(batch update) - * @params int $componentId id for specific components like contribute, event etc - * - * @param $contactId - * @param $fields - * @param $defaults - * @param bool $singleProfile - * @param null $componentId - * @param null $component + * @param int $contactId contact id + * @param array $fields associative array of fields + * @param array $defaults defaults array + * @param boolean $singleProfile true for single profile else false(batch update) + * @param int $componentId id for specific components like contribute, event etc + * @param null $component * * @return null * @static @@ -2686,11 +2662,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Process that send notification e-mails * - * @params int $contactId contact id - * @params array $values associative array of name/value pair - * - * @param $contactID - * @param $values + * @param int $contactID contact id + * @param array $values associative array of name/value pair * * @return void * @access public @@ -2748,13 +2721,9 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * for this group and notify email only if group's notify field is * set and field values are not empty * - * @params $gid group id - * @params $cid contact id - * @params $params associative array - * - * @param $gid - * @param $cid - * @param $params + * @param int $gid group id + * @param int $cid contact id + * @param array $params * @param bool $skipCheck * * @return array @@ -2787,12 +2756,9 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Function to assign uf fields to template * - * @params int $gid group id - * @params array $values associative array of fields - * - * @param $gid - * @param $values - * @param $template + * @param int $gid group id + * @param array $values + * @param CRM_Core_Smarty $template * * @return void * @access public @@ -2943,11 +2909,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * calculate the profile type 'group_type' as per profile fields. * - * @param $gId + * @param int $gId profile id * @param bool $includeTypeValues * @param int $ignoreFieldId ignore particular profile field * - * @internal param int $gid profile id * @return array list of calculated group type */ static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { @@ -2963,7 +2928,6 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param bool $includeTypeValues * @param int $ignoreFieldId ignore perticular profile field * - * @internal param int $gid profile id * @return array list of calculated group type */ static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { @@ -3029,14 +2993,12 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28 * - * @param $gId - * @param Array $groupTypes With key having group type names + * @param int $gId + * @param array $groupTypes With key having group type names * - * @internal param int $gid profile id * @return Boolean */ - static function updateGroupTypes($gId, $groupTypes = array( - )) { + static function updateGroupTypes($gId, $groupTypes = array()) { if (!is_array($groupTypes) || !$gId) { return FALSE; } @@ -3473,11 +3435,8 @@ SELECT group_id /** * function to get group type values of the profile * - * @params Integer $profileId Profile Id - * @params String $groupType Group Type - * - * @param $profileId - * @param null $groupType + * @param int $profileId + * @param string $groupType * * @return Array group type values * @static diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index da894ee1c5..93df59978f 100644 --- a/CRM/Core/BAO/UFJoin.php +++ b/CRM/Core/BAO/UFJoin.php @@ -43,7 +43,7 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Core_DAO_UFJoin object + * @return CRM_Core_DAO_UFJoin object * @access public * @static */ @@ -67,7 +67,7 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { } /** - * @param $params + * @param array $params */ public static function deleteAll(&$params) { $module = CRM_Utils_Array::value('module', $params); @@ -149,7 +149,7 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index 1630ece952..8210c208fb 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -45,7 +45,7 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * @param array $params input parameters */ /** - * @param $params + * @param array $params * * @return CRM_Core_DAO_UFMatch */ @@ -414,9 +414,7 @@ AND domain_id = %4 * Update the email value for the contact and user profile * * @param $contactId Int Contact ID of the user - * @param $emailAddress - * - * @internal param String $email email to be modified for the user + * @param $emailAddress email to be modified for the user * * @return void * @access public diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index 050502c14a..f30131bf1a 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -129,11 +129,9 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param $params + * @param array $params * @param $values * - * @internal param \entityBlock $array input parameters to find object - * * @return boolean * @access public * @static diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index 10eb8d4b56..d2543260ba 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -57,7 +57,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_DAO_WordRepalcement object + * @return CRM_Core_DAO_WordRepalcement object * @access public * @static */ @@ -91,7 +91,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Save the values of a WordReplacement * - * @param $params + * @param array $params * @param $id * * @return WordReplacement array @@ -111,7 +111,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Create a new WordReplacement * - * @param $params + * @param array $params * * @return WordReplacement array * @access public diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index b191735ea7..92c81a3288 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -182,11 +182,8 @@ class CRM_Core_Block { /** * returns the desired property from the $_properties array * - * @params int $id one of the class constants (ADD, SEARCH, etc.) - * @params string $property the desired property - * - * @param $id - * @param $property + * @param int $id one of the class constants (ADD, SEARCH, etc.) + * @param string $property the desired property * * @return string the value of the desired property */ @@ -200,13 +197,10 @@ class CRM_Core_Block { /** * sets the desired property in the $_properties array * - * @params int $id one of the class constants (ADD, SEARCH, etc.) - * @params string $property the desired property - * @params string $value the value of the desired property + * @param int $id one of the class constants (ADD, SEARCH, etc.) + * @param string $property the desired property + * @param 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/Component.php b/CRM/Core/Component.php index 62f484dcac..f643e847bb 100644 --- a/CRM/Core/Component.php +++ b/CRM/Core/Component.php @@ -36,10 +36,10 @@ */ class CRM_Core_Component { - /* - * End part (filename) of the component information class'es name - * that needs to be present in components main directory. - */ + /** + * End part (filename) of the component information class'es name + * that needs to be present in components main directory. + */ CONST COMPONENT_INFO_CLASS = 'Info'; private static $_info = NULL; @@ -346,7 +346,7 @@ class CRM_Core_Component { } /** - * @param $form + * @param CRM_Core_Form $form */ static function &buildSearchForm(&$form) { $info = self::_info(); @@ -417,7 +417,7 @@ class CRM_Core_Component { } /** - * Function to handle table dependencies of components + * handle table dependencies of components * * @param array $tables array of tables * @@ -437,7 +437,7 @@ class CRM_Core_Component { } /** - * Function to get components info from info file + * get components info from info file * */ static function getComponentsFromFile($crmFolderDir) { diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index c9433c5c34..63f5089c03 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -37,55 +37,55 @@ abstract class CRM_Core_Component_Info { - /* - * Name of the class (minus component namespace path) - * of the component invocation class'es name. - */ + /** + * Name of the class (minus component namespace path) + * of the component invocation class'es name. + */ CONST COMPONENT_INVOKE_CLASS = 'Invoke'; - /* - * Name of the class (minus component namespace path) - * of the component configuration class'es name. - */ + /** + * Name of the class (minus component namespace path) + * of the component configuration class'es name. + */ CONST COMPONENT_CONFIG_CLASS = 'Config'; - /* - * Name of the class (minus component namespace path) - * of the component BAO Query class'es name. - */ + /** + * Name of the class (minus component namespace path) + * of the component BAO Query class'es name. + */ CONST COMPONENT_BAO_QUERY_CLASS = 'BAO_Query'; - /* - * Name of the class (minus component namespace path) - * of the component user dashboard plugin. - */ + /** + * Name of the class (minus component namespace path) + * of the component user dashboard plugin. + */ CONST COMPONENT_USERDASHBOARD_CLASS = 'Page_UserDashboard'; - /* - * Name of the class (minus component namespace path) - * of the component tab offered to contact record view. - */ + /** + * Name of the class (minus component namespace path) + * of the component tab offered to contact record view. + */ CONST COMPONENT_TAB_CLASS = 'Page_Tab'; - /* - * Name of the class (minus component namespace path) - * of the component tab offered to contact record view. - */ + /** + * Name of the class (minus component namespace path) + * of the component tab offered to contact record view. + */ CONST COMPONENT_ADVSEARCHPANE_CLASS = 'Form_Search_AdvancedSearchPane'; - /* - * Name of the directory (assumed in component directory) - * where xml resources used by this component live. - */ + /** + * Name of the directory (assumed in component directory) + * where xml resources used by this component live. + */ CONST COMPONENT_XML_RESOURCES = 'xml'; - /* - * Name of the directory (assumed in xml resources path) - * containing component menu definition XML file names. - */ + /** + * Name of the directory (assumed in xml resources path) + * containing component menu definition XML file names. + */ CONST COMPONENT_MENU_XML = 'Menu'; - /* + /** * Stores component information. * @var array component settings as key/value pairs */ @@ -97,20 +97,10 @@ abstract class CRM_Core_Component_Info { */ protected $keyword; - /* - * Class constructor, sets name and namespace (those are stored - * in the component registry (database) and no need to duplicate - * them here, as well as populates the info variable. - * + /** * @param string $name name of the component * @param string $namespace namespace prefix for component's files - * @access public - * - */ - /** - * @param $name - * @param $namespace - * @param $componentID + * @param int $componentID */ public function __construct($name, $namespace, $componentID) { $this->name = $name; diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index 8a4ed0df0e..d4505be760 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -827,7 +827,7 @@ AND } /** - * function to check if running in upgrade mode + * check if running in upgrade mode */ static function isUpgradeMode($path = NULL) { if (defined('CIVICRM_UPGRADE_ACTIVE')) { diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php index b942b907a6..c690bcc82b 100644 --- a/CRM/Core/Config/Defaults.php +++ b/CRM/Core/Config/Defaults.php @@ -75,7 +75,7 @@ class CRM_Core_Config_Defaults { } /** - * Function to format size + * format size * * @access public * @static @@ -106,7 +106,7 @@ class CRM_Core_Config_Defaults { } /** - * Function to set the default values + * set the default values * * @param array $defaults associated array of form elements * @param bool|\boolena $formMode this funtion is called to set default diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 96dd5b5716..ddf95f60e7 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -159,22 +159,16 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * All CRM single or multi page pages should inherit from this class. * - * @param null $title - * @param bool $modal + * @param string $title descriptive title of the controller + * @param bool $modal whether controller is 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) + * @param string $scope name of session if we want unique scope, used only by Controller_Simple + * @param bool $addSequence should we add a unique sequence number to the end of the key + * @param bool $ignoreKey should we not set a qfKey for this controller (for standalone forms) * * @access public * - * @return \CRM_Core_Controller + * @return CRM_Core_Controller */ function __construct( $title = NULL, @@ -415,7 +409,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * getter method for stateMachine * - * @return object + * @return CRM_Core_StateMachine * @access public */ function getStateMachine() { @@ -425,7 +419,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * setter method for stateMachine * - * @param object a stateMachineObject + * @param CRM_Core_StateMachine $stateMachine * * @return void * @access public @@ -438,7 +432,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * add pages to the controller. Note that the controller does not really care * the order in which the pages are added * - * @param object $stateMachine the state machine object + * @param CRM_Core_StateMachine $stateMachine * @param \const|int $action the mode in which the state machine is operating * typicaly this will be add/view/edit * @@ -500,7 +494,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * function to destroy all the session state of the controller. + * destroy all the session state of the controller. * * @access public * @@ -541,7 +535,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Get the variable from the form scope * - * @param string name : name of the variable + * @param string $name : name of the variable * * @access public @@ -595,7 +589,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * @param $wizard + * @param array $wizard */ function addWizardStyle(&$wizard) { $wizard['style'] = array( @@ -613,10 +607,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * assign value to name in template * - * @param $var + * @param string $var * @param mixed $value value of varaible * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -627,10 +620,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * assign value to name in template by reference * - * @param $var + * @param string $var * @param mixed $value (reference) value of varaible * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -654,7 +646,6 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * * @param string $name * - * @internal param string $type * @return array */ function get_template_vars($name=null) { diff --git a/CRM/Core/Controller/Simple.php b/CRM/Core/Controller/Simple.php index 7dafbf7f64..2536aa324f 100644 --- a/CRM/Core/Controller/Simple.php +++ b/CRM/Core/Controller/Simple.php @@ -45,15 +45,13 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller { * @param bool $title * @param string path the class Path of the form being implemented * @param bool $imageUpload - * @param bool $addSequence - * @param bool $ignoreKey + * @param bool $addSequence should we add a unique sequence number to the end of the key + * @param bool $ignoreKey should we not set a qfKey for this controller (for standalone forms) * @param bool $attachUpload * - * @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) * * @return \CRM_Core_Controller_Simple - @access public + * @access public */ function __construct( $path, diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 3a10574a3d..d413b5fa4f 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -114,7 +114,7 @@ class CRM_Core_DAO extends DB_DataObject { /** * @param $fieldName * @param $fieldDef - * @param $params + * @param array $params * */ protected function assignTestFK($fieldName, $fieldDef, $params) { @@ -808,7 +808,6 @@ LIKE %1 * @param array $tables * * @throws Exception - * @internal param string $tableName * * @return boolean true if CONSTRAINT keyword exists, false otherwise */ @@ -828,10 +827,10 @@ LIKE %1 } $result = preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]) ? TRUE : FALSE; - if($result == TRUE){ + if ($result == TRUE){ continue; } - else{ + else { return FALSE; } } @@ -1039,11 +1038,7 @@ FROM civicrm_domain } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param string $daoName name of the dao object * @param array $params (reference ) an assoc array of name/value pairs @@ -1101,7 +1096,7 @@ FROM civicrm_domain * @param bool $i18nRewrite * @param bool $trapException * - * @return Object CRM_Core_DAO object that holds the results of the query + * @return CRM_Core_DAO object that holds the results of the query * @static * @access public */ @@ -1115,7 +1110,6 @@ FROM civicrm_domain $trapException = FALSE ) { $queryStr = self::composeQuery($query, $params, $abort); - //CRM_Core_Error::debug( 'q', $queryStr ); if (!$daoName) { $dao = new CRM_Core_DAO(); @@ -1185,7 +1179,7 @@ FROM civicrm_domain /** * @param $query - * @param $params + * @param array $params * @param bool $abort * * @return string @@ -1241,15 +1235,6 @@ FROM civicrm_domain static function freeResult($ids = NULL) { global $_DB_DATAOBJECT; - /*** - $q = array( ); - foreach ( array_keys( $_DB_DATAOBJECT['RESULTS'] ) as $id ) { - $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query; - } - CRM_Core_Error::debug( 'k', $q ); - return; - ***/ - if (!$ids) { if (!$_DB_DATAOBJECT || !isset($_DB_DATAOBJECT['RESULTS']) @@ -1429,11 +1414,7 @@ SELECT contact_id } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param string $daoName name of the dao object * @param string $fieldIdName @@ -1441,8 +1422,6 @@ SELECT contact_id * @param $details * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') * - * @internal param array $params (reference ) an assoc array of name/value pairs - * @internal param array $defaults (reference ) an assoc array to hold the flattened values * @return object an object of type referenced by daoName * @access public * @static @@ -1546,7 +1525,7 @@ SELECT contact_id * createOnly: only create in database, do not store or return the objects (useful for perf testing) * ONLY USE FOR TESTING * - * @param $daoName + * @param string $daoName * @param array $params * @param int $numObjects * @param bool $createOnly @@ -1624,11 +1603,10 @@ SELECT contact_id * deletes the this object plus any dependent objects that are associated with it * ONLY USE FOR TESTING * - * @param $daoName + * @param string $daoName * @param array $params */ - static function deleteTestObjects($daoName, $params = array( - )) { + static function deleteTestObjects($daoName, $params = array()) { //this is a test function also backtrace is set for the test suite it sometimes unsets itself // so we re-set here in case $config = CRM_Core_Config::singleton(); @@ -1670,7 +1648,7 @@ SELECT contact_id * Set defaults when creating new entity * (don't call this set defaults as already in use with different signature in some places) * - * @param $params + * @param array $params * @param $defaults */ static function setCreateDefaults(&$params, $defaults) { @@ -2153,7 +2131,7 @@ SELECT contact_id * $field => array('LIKE' => array('%me%)) * etc * - * @param $fieldName + * @param string $fieldName name of fields * @param $filter array filter to be applied indexed by operator * @param $type String type of field (not actually used - nor in api @todo ) * @param $alias String alternative field name ('as') @todo- not actually used @@ -2161,7 +2139,7 @@ SELECT contact_id * this is primarily so we can add filters @ the api level to the Query object based fields * * @throws Exception - * @internal param string $fieldname name of fields + * * @todo a better solution would be for the query object to apply these filters based on the * api supported format (but we don't want to risk breakage in alpha stage & query class is scary * @todo @time of writing only IN & NOT IN are supported for the array style syntax (as test is @@ -2181,10 +2159,10 @@ SELECT contact_id // unary operators case 'IS NULL': case 'IS NOT NULL': - if(!$returnSanitisedArray) { + if (!$returnSanitisedArray) { return (sprintf('%s %s', $fieldName, $operator)); } - else{ + else { return (sprintf('%s %s ', $fieldName, $operator)); } break; @@ -2195,10 +2173,10 @@ SELECT contact_id if (empty($criteria[0]) || empty($criteria[1])) { throw new Exception("invalid criteria for $operator"); } - if(!$returnSanitisedArray) { + if (!$returnSanitisedArray) { return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1]))); } - else{ + else { return NULL; // not yet implemented (tests required to implement) } break; @@ -2213,7 +2191,7 @@ SELECT contact_id 'CRM_Core_DAO', 'escapeString' ), $criteria); - if(!$returnSanitisedArray) { + if (!$returnSanitisedArray) { return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria))); } return $escapedCriteria; @@ -2222,10 +2200,10 @@ SELECT contact_id // binary operators default: - if(!$returnSanitisedArray) { + if (!$returnSanitisedArray) { return(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria))); } - else{ + else { return NULL; // not yet implemented (tests required to implement) } } @@ -2264,7 +2242,7 @@ SELECT contact_id } // easy return for calls that dont need a randomized uniq string - if (! $makeRandom) { + if (!$makeRandom) { return substr($string, 0, $length); } @@ -2277,7 +2255,7 @@ SELECT contact_id } /** - * @param $params + * @param array $params */ function setApiFilter(&$params) {} diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index e3cb5a4d7b..a5e1481533 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -61,9 +61,6 @@ class CRM_Exception extends PEAR_Exception { * @param string exception message * @param int $code * @param Exception $previous - * - * @internal param array|\Exception|int|null|\PEAR_Error $exception cause - * @internal param int|null $exception code or null */ public function __construct($message = NULL, $code = 0, Exception$previous = NULL) { parent::__construct($message, $code, $previous); @@ -303,18 +300,15 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * display an error page with an error message describing what happened * - * @param null $message - * @param null $code - * @param null $email + * @param string $message the error message + * @param string $code the error code if any + * @param string $email the email address to notify of this situation * * @throws Exception - * @internal param \message $string the error message - * @internal param \code $string the error code if any - * @internal param \email $string the email address to notify of this situation * * @return void * @static - * @acess public + * @access public */ static function fatal($message = NULL, $code = NULL, $email = NULL) { $vars = array( @@ -401,7 +395,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { * * @return void * @static - * @acess public + * @access public */ static function handleUnhandledException($exception) { $config = CRM_Core_Config::singleton(); @@ -516,16 +510,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Similar to the function debug. Only difference is * in the formatting of the output. * - * @param $variable_name - * @param $variable - * @param bool $print - * @param bool $log + * @param string $variable_name + * @param mixed $variable + * @param bool $print should we use print_r ? (else we use var_dump) + * @param bool $log should we log or return the output * @param string $comp variable name * - * @internal param \reference $mixed to variables that we need a trace of - * @internal param \should $bool we use print_r ? (else we use var_dump) - * @internal param \should $bool we log or return the output - * * @return string the generated output * * @access public @@ -845,7 +835,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Function to reset the error stack + * reset the error stack * * @access public * @static diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index f824ae18ef..d2944122eb 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -802,10 +802,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * assign value to name in template * - * @param $var - * @param mixed $value value of varaible + * @param string $var name of variable + * @param mixed $value value of variable * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -816,10 +815,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * assign value to name in template by reference * - * @param $var + * @param string $var name of variable * @param mixed $value value of varaible * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -843,7 +841,6 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * * @param string $name * - * @internal param string $type * @return array */ function get_template_vars($name=null) { @@ -964,11 +961,10 @@ 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 $nextType + * @param string $nextType button type for the form after processing * @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 */ @@ -1254,16 +1250,17 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Function to add date - * @param string $name name of the element - * @param string $label label of the element - * @param array $attributes key / value pair + * Add date + * @param string $name name of the element + * @param string $label label of the element + * @param array $attributes key / value pair * - // if you need time - * $attributes = array ( 'addTime' => true, - * 'formatType' => 'relative' or 'birth' etc check advanced date settings - * ); - * @param boolean $required true if required + * // if you need time + * $attributes = array( + * 'addTime' => true, + * 'formatType' => 'relative' or 'birth' etc check advanced date settings + * ); + * @param boolean $required true if required * */ function addDate($name, $label, $required = FALSE, $attributes = NULL) { @@ -1609,7 +1606,6 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * @param array $profiles ids of profiles that are on the form (to be autofilled) * @param array $autoCompleteField * - * @internal param array $field metadata of field to use as selector including * - name_field * - id_field * - url (for ajax lookup) diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 8ec898fe4e..58da214144 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -42,7 +42,7 @@ Class CRM_Core_Form_Date { /** * This function is to build the date-format form * - * @param Object $form the form object that we are operating on + * @param CRM_Core_Form $form the form object that we are operating on * * @static * @access public @@ -74,7 +74,7 @@ Class CRM_Core_Form_Date { * This function is to retrieve the date range - relative or absolute * and assign it to the form * - * @param object $form - the form the dates should be added to + * @param CRM_Core_Form $form - the form the dates should be added to * @param string $fieldName * @param integer $count * @param string $from @@ -114,7 +114,7 @@ Class CRM_Core_Form_Date { * This function is to build the date range array that will provide the form option values * It can be - relative or absolute * - * @param Object $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 integer $count * @param String $from @@ -236,7 +236,6 @@ Class CRM_Core_Form_Date { * @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/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 193027768d..896ac6fdb7 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -105,7 +105,7 @@ class CRM_Core_Form_RecurringEntity { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -311,7 +311,7 @@ class CRM_Core_Form_RecurringEntity { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -473,7 +473,6 @@ class CRM_Core_Form_RecurringEntity { } } } - //end of function /** * Return a descriptive name for the page, used in wizard header diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index 597c3beae0..bcb1dab5b5 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -41,7 +41,7 @@ class CRM_Core_Form_Tag { public $_entityTagValues; /** - * Function to build tag widget if correct parent is passed + * build tag widget if correct parent is passed * * @param CRM_Core_Form $form form object * @param string $parentNames parent name ( tag name) @@ -51,7 +51,6 @@ class CRM_Core_Form_Tag { * @param boolean $skipEntityAction true if need to add entry in entry table via ajax * @param string $tagsetElementName if you need to create tagsetlist with specific name * - * @internal param bool $searchMode true if widget is used in search eg: advanced search * @return void * @access public * @static @@ -117,12 +116,12 @@ class CRM_Core_Form_Tag { } /** - * Function to save entity tags when it is not save used AJAX + * save entity tags when it is not save used AJAX * * @param array $params associated array * @param int $entityId entity id, eg: contact id, activity id, case id, file id * @param string $entityTable entity table - * @param object $form form object + * @param CRM_Core_Form $form form object * * @return void * @access public diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index 685ca6d9bb..f825ab8541 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -467,7 +467,7 @@ class CRM_Core_I18n_Schema { * * @param $locale string locale of the view * @param $table string table of the view - * @param $dao object a DAO object to run DESCRIBE queries + * @param CRM_Core_DAO $dao a DAO object to run DESCRIBE queries * @param $class string schema structure class to use * * @return array array of CREATE INDEX queries diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index c6055cf9d8..89095af0a7 100644 --- a/CRM/Core/IDS.php +++ b/CRM/Core/IDS.php @@ -205,11 +205,9 @@ class CRM_Core_IDS { * This function writes an entry about the intrusion * to the intrusion database * - * @param $result + * @param array $result * @param int $reaction * - * @internal param array $results - * * @return boolean */ private function log($result, $reaction = 0) { diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index d41b66cf57..c1473b41da 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -212,7 +212,7 @@ class CRM_Core_JobManager { /** * @param $entity * @param $job - * @param $params + * @param array $params * @param null $source */ public function setSingleRunParams($entity, $job, $params, $source = NULL) { diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php index 351743480e..8e430822e2 100644 --- a/CRM/Core/Key.php +++ b/CRM/Core/Key.php @@ -75,15 +75,12 @@ class CRM_Core_Key { * Generate a form key based on form name, the current user session * and a private key. Modelled after drupal's form API * - * @param $name - * @param bool $addSequence - * - * @internal param string $value name of the form - * @paeam boolean $addSequence should we add a unique sequence number to the end of the key + * @param string $name + * @param bool $addSequence should we add a unique sequence number to the end of the key * * @return string valid formID * @static - * @acess public + * @access public */ static function get($name, $addSequence = FALSE) { $privateKey = self::privateKey(); @@ -101,15 +98,13 @@ class CRM_Core_Key { /** * Validate a form key based on the form name * - * @param $key + * @param string $key * @param string $name - * * @param bool $addSequence * - * @internal param string $formKey * @return string $formKey if valid, else null * @static - * @acess public + * @access public */ static function validate($key, $name, $addSequence = FALSE) { if (!is_string($key)) { diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php index 862d2da5d4..87c267b01d 100644 --- a/CRM/Core/Lock.php +++ b/CRM/Core/Lock.php @@ -75,9 +75,6 @@ class CRM_Core_Lock { if (stristr($name, 'civimail.job.')) { $jobLog = $this->_name; } - //if (defined('CIVICRM_LOCK_DEBUG')) { - //CRM_Core_Error::debug_var('backtrace', debug_backtrace()); - //} $this->_timeout = $timeout !== NULL ? $timeout : self::TIMEOUT; $this->acquire(); diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index e5efcec174..38cc1042d1 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -723,7 +723,6 @@ UNION ( $args = array(); $elements = explode(',', $pathArgs); - //CRM_Core_Error::debug( 'e', $elements ); foreach ($elements as $keyVal) { list($key, $val) = explode('=', $keyVal, 2); $arr[$key] = $val; diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index b9560ea7e7..424885b90d 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -47,7 +47,7 @@ class CRM_Core_OptionGroup { ); /** - * @param $dao + * @param CRM_Core_DAO $dao * @param bool $flip * @param bool $grouping * @param bool $localize @@ -242,7 +242,7 @@ WHERE v.option_group_id = g.id } /** - * Function to lookup titles OR ids for a set of option_value populated fields. The retrieved value + * lookup titles OR ids for a set of option_value populated fields. The retrieved value * is assigned a new fieldname by id or id's by title * (each within a specificied option_group) * @@ -443,9 +443,7 @@ WHERE v.option_group_id = g.id * bool 'is_default' (optional) - is this the default one to display when rendered in form * bool 'is_active' (optional) - should this element be rendered * @param int $defaultID (reference) - the option value ID of the default element (if set) is returned else 'null' - * @param null $groupTitle - * - * @internal param string $groupLabel - the optional label of the option group else set to group name + * @param null $groupTitle the optional label of the option group else set to group name * * @access public * @static diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index 1d7cf7fda1..a93862915a 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -59,7 +59,7 @@ class CRM_Core_OptionValue { static $_fields = NULL; /** - * Function to return option-values of a particular group + * return option-values of a particular group * * @param array $groupParams Array containing group fields whose option-values is to retrieved. * @param string $orderBy for orderBy clause @@ -170,14 +170,13 @@ class CRM_Core_OptionValue { } /** - * Function to add/edit option-value of a particular group + * 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 $action * @param integer $optionValueID has the id of the optionValue being edited, disabled ..etc * - * @internal param string $orderBy for orderBy clause * @return CRM_Core_DAO_OptionValue * * @access public @@ -270,12 +269,6 @@ class CRM_Core_OptionValue { * @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 - * @internal param string $fieldName the name of the field in the DAO - * * @return boolean true if object exists * @access public * @static @@ -372,7 +365,7 @@ class CRM_Core_OptionValue { } /** - * Function to return option-values of a particular group + * return option-values of a particular group * * @param array $groupParams Array containing group fields * whose option-values is to retrieved. diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index 5b93c196c3..6e1da70b00 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -279,10 +279,9 @@ class CRM_Core_Page { /** * assign value to name in template * - * @param $var + * @param string $var * @param mixed $value value of varaible * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -293,10 +292,9 @@ class CRM_Core_Page { /** * assign value to name in template by reference * - * @param $var + * @param string $var * @param mixed $value (reference) value of varaible * - * @internal param array|string $name name of variable * @return void * @access public */ @@ -320,7 +318,6 @@ class CRM_Core_Page { * * @param string $name * - * @internal param string $type * @return array */ function get_template_vars($name=null) { @@ -328,7 +325,7 @@ class CRM_Core_Page { } /** - * function to destroy all the session state of this page. + * destroy all the session state of this page. * * @access public * diff --git a/CRM/Core/Page/AJAX.php b/CRM/Core/Page/AJAX.php index 0b5f72fae6..aab1f2fed1 100644 --- a/CRM/Core/Page/AJAX.php +++ b/CRM/Core/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Core_Page_AJAX { /** - * function to call generic ajax forms + * call generic ajax forms * * @static * @access public @@ -90,7 +90,7 @@ class CRM_Core_Page_AJAX { } /** - * function to change is_quick_config priceSet to complex + * change is_quick_config priceSet to complex * * @static * @access public diff --git a/CRM/Core/Page/AJAX/Location.php b/CRM/Core/Page/AJAX/Location.php index a5b4002caf..b98d5bf30f 100644 --- a/CRM/Core/Page/AJAX/Location.php +++ b/CRM/Core/Page/AJAX/Location.php @@ -41,7 +41,7 @@ class CRM_Core_Page_AJAX_Location { * FIXME: we should make this method like getLocBlock() OR use the same method and * remove this one. * - * Function to obtain the location of given contact-id. + * obtain the location of given contact-id. * This method is used by on-behalf-of form to dynamically generate poulate the * location field values for selected permissioned contact. */ diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index 7ca6a073a8..f495abdbfb 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -88,7 +88,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function userContext($mode = NULL); /** - * function to get userContext params + * get userContext params * * @param int $mode mode that we are in * @@ -195,8 +195,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * browse all entities. * - * @internal param int $action - * * @return void * @access public */ diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index a343fafdd7..7e8a91ea3d 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -132,7 +132,7 @@ abstract class CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @return mixed */ @@ -451,8 +451,6 @@ abstract class CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @internal param string $mode the mode we are operating in (live or test) - * * @return string the error message if any * @public */ @@ -596,7 +594,7 @@ abstract class CRM_Core_Payment { } /** - * Function to check whether a method is present ( & supported ) by the payment processor object. + * check whether a method is present ( & supported ) by the payment processor object. * * @param string $method method to check for. * diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 42d4f30e28..38dc70043a 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -68,7 +68,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * @param object $paymentProcessor the details of the payment processor being invoked - * @param object $paymentForm reference to the form object if available + * @param CRM_Core_Form $paymentForm reference to the form object if available * @param boolean $force should we force a reload of this payment object * * @return object @@ -648,8 +648,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @return bool|object */ - function cancelSubscription(&$message = '', $params = array( - )) { + function cancelSubscription(&$message = '', $params = array()) { $template = CRM_Core_Smarty::singleton(); $template->assign('subscriptionType', 'cancel'); @@ -696,8 +695,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @return bool|object */ - function updateSubscriptionBillingInfo(&$message = '', $params = array( - )) { + function updateSubscriptionBillingInfo(&$message = '', $params = array()) { $template = CRM_Core_Smarty::singleton(); $template->assign('subscriptionType', 'updateBilling'); @@ -756,8 +754,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @return bool|object */ - function changeSubscriptionAmount(&$message = '', $params = array( - )) { + function changeSubscriptionAmount(&$message = '', $params = array()) { $template = CRM_Core_Smarty::singleton(); $template->assign('subscriptionType', 'update'); diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 26cf90cebd..746bc2dc40 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -688,26 +688,19 @@ LIMIT 1;"; return TRUE; } - /* + /** * Send receipt from contribution. Note that the compose message part has been moved to contribution * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it * - * @params array $input Incoming data from Payment processor - * @params array $ids Related object IDs - * @params array $values values related to objects that have already been loaded - * @params bool $recur is it part of a recurring contribution - * @params bool $returnMessageText Should text be returned instead of sent. This - * is because the function is also used to generate pdfs - */ - /** - * @param $input - * @param $ids + * @param array $input Incoming data from Payment processor + * @param array $ids Related object IDs * @param $objects - * @param $values - * @param bool $recur - * @param bool $returnMessageText + * @param array $values values related to objects that have already been loaded + * @param bool $recur is it part of a recurring contribution + * @param bool $returnMessageText Should text be returned instead of sent. This + * is because the function is also used to generate pdfs * - * @return mixed + * @return array */ function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) { $contribution = &$objects['contribution']; @@ -936,11 +929,9 @@ LIMIT 1;"; } /** - * @param $recurId + * @param int $recurId * @param $contribution * - * @internal param $contributionId - * * @return array */ function addRecurLineItems($recurId, $contribution) { diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 38feff59f1..144910ebf8 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -82,7 +82,7 @@ class CRM_Core_Payment_Form { * add general billing fields * @todo set these like processor fields & let payment processors alter them * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access protected @@ -353,7 +353,7 @@ class CRM_Core_Payment_Form { } /** - * function to map address fields + * map address fields * * @param $id * @param $src @@ -395,7 +395,7 @@ class CRM_Core_Payment_Form { } /** - * function to get the credit card expiration month + * get the credit card expiration month * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011) * See CRM-9017 * @@ -413,7 +413,7 @@ class CRM_Core_Payment_Form { } /** - * function to get the credit card expiration year + * get the credit card expiration year * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011) * This function exists only to make it consistent with getCreditCardExpirationMonth * diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index 17708bb0af..a542e12145 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -166,7 +166,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * @param $component */ function doRecurCheckout(&$params, $component) { @@ -435,8 +435,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { * * @return bool|object */ - function cancelSubscription(&$message = '', $params = array( - )) { + function cancelSubscription(&$message = '', $params = array()) { $orderNo = CRM_Utils_Array::value('subscriptionId', $params); $merchant_id = $this->_paymentProcessor['user_name']; diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index 4dd6ed4241..276c302b2c 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -234,7 +234,6 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { } } - // CRM_Core_Error::debug_var( 'c', $contribution ); $contribution->save(); $transaction->commit(); @@ -317,7 +316,6 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { $transaction = new CRM_Core_Transaction(); - // CRM_Core_Error::debug_var( 'c', $contribution ); if ($status == 'PAYMENT_DECLINED' || $status == 'CANCELLED_BY_GOOGLE' || $status == 'CANCELLED' diff --git a/CRM/Core/Payment/PayPalIPN.php b/CRM/Core/Payment/PayPalIPN.php index 694f30374b..a4035e789e 100644 --- a/CRM/Core/Payment/PayPalIPN.php +++ b/CRM/Core/Payment/PayPalIPN.php @@ -286,8 +286,6 @@ class CRM_Core_Payment_PayPalIPN extends CRM_Core_Payment_BaseIPN { } function main() { - // CRM_Core_Error::debug_var( 'GET' , $_GET , true, true ); - // CRM_Core_Error::debug_var( 'POST', $_POST, true, true ); //@todo - this could be refactored like PayPalProIPN & a test could be added $objects = $ids = $input = array(); diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index f3c6cf5e68..3c6ca69b5f 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -192,7 +192,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * do the express checkout at paypal. Check PayPal documentation for more information * - * @param $params + * @param array $params * * @internal param string $token the key associated with this transaction * @@ -237,7 +237,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { //LCD add new function for handling recurring payments for PayPal Express /** - * @param $params + * @param array $params * * @return mixed */ @@ -437,7 +437,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * Function to check whether a method is present ( & supported ) by the payment processor object. + * check whether a method is present ( & supported ) by the payment processor object. * * @param string $method method to check for. * @@ -459,8 +459,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @return array|bool|object */ - function cancelSubscription(&$message = '', $params = array( - )) { + function cancelSubscription(&$message = '', $params = array()) { if ($this->_paymentProcessor['payment_processor_type'] == 'PayPal') { $args = array(); $this->initialize($args, 'ManageRecurringPaymentsProfileStatus'); @@ -485,8 +484,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @return array|bool|object */ - function updateSubscriptionBillingInfo(&$message = '', $params = array( - )) { + function updateSubscriptionBillingInfo(&$message = '', $params = array()) { if ($this->_paymentProcessor['payment_processor_type'] == 'PayPal') { $config = CRM_Core_Config::singleton(); $args = array(); @@ -547,7 +545,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * @param string $component * * @throws Exception diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index 181871d023..ca1d5f4cab 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -405,7 +405,7 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * NOTE: 'doTransferCheckout' not implemented */ /** - * @param $params + * @param array $params * @param $component * * @throws Exception diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index 4e1a006ea2..fe3f5d5f35 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -116,7 +116,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @throws Exception */ @@ -134,7 +134,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @throws Exception */ diff --git a/CRM/Core/Payment/ProcessorForm.php b/CRM/Core/Payment/ProcessorForm.php index 50bfabbdbc..7b3d5cfb4d 100644 --- a/CRM/Core/Payment/ProcessorForm.php +++ b/CRM/Core/Payment/ProcessorForm.php @@ -39,7 +39,7 @@ class CRM_Core_Payment_ProcessorForm { /** - * @param $form + * @param CRM_Core_Form $form * @param null $type * @param null $mode * diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index 0d63fd12f7..caef3e21eb 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -96,7 +96,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @throws Exception */ @@ -114,7 +114,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @throws Exception */ @@ -123,7 +123,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * @param $params + * @param array $params * * @throws Exception */ diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index c6ff25a6ee..42f6c2cba1 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -701,7 +701,7 @@ class CRM_Core_Permission { } /** - * Function to get component name from given permission. + * get component name from given permission. * * @param string $permission * diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 69e4be356d..d590618895 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -57,7 +57,7 @@ class CRM_Core_PseudoConstant { private static $cache; /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * activity type * @var array @@ -101,7 +101,7 @@ class CRM_Core_PseudoConstant { private static $countryIsoCode; /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * group * @var array @@ -159,7 +159,7 @@ class CRM_Core_PseudoConstant { private static $worldRegions; /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * activity status * @var array @@ -531,7 +531,7 @@ class CRM_Core_PseudoConstant { /** * DEPRECATED generic populate method - * All pseudoconstant functions that use this method are also deprecated. + * All pseudoconstant functions that use this method are also @deprecated * * The static array $var is populated from the db * using the $name DAO. @@ -618,14 +618,12 @@ class CRM_Core_PseudoConstant { } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * Get all Activty types. * * The static array activityType is returned * - * @internal param bool $all - get All Activity types - default is to get only active ones. - * * @access public * @static * @@ -926,7 +924,7 @@ WHERE id = %1"; } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * Get all groups from database * @@ -937,7 +935,7 @@ WHERE id = %1"; * Note: any database errors will be trapped by the DAO. * * @param string $groupType type of group(Access/Mailing) - * @param bool|\boolen $excludeHidden exclude hidden groups. + * @param bool $excludeHidden exclude hidden groups. * * @access public * @static @@ -1425,7 +1423,7 @@ WHERE id = %1"; } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * Get all active payment processors * * The static array paymentProcessor is returned @@ -1461,7 +1459,7 @@ WHERE id = %1"; } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * The static array paymentProcessorType is returned * @@ -1514,7 +1512,7 @@ WHERE id = %1"; } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * Get all Activity Statuses. * @@ -1541,7 +1539,7 @@ WHERE id = %1"; } /** - * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object. + * @deprecated Please use the buildOptions() method in the appropriate BAO object. * * Get all Visibility levels. * diff --git a/CRM/Core/QuickForm/Action/Back.php b/CRM/Core/QuickForm/Action/Back.php index 42d50002fe..669c42c8a2 100644 --- a/CRM/Core/QuickForm/Action/Back.php +++ b/CRM/Core/QuickForm/Action/Back.php @@ -41,7 +41,7 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { * @param object $stateMachine reference to state machine object * * @return \CRM_Core_QuickForm_Action_Back - @access public + * @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 0351cf91c4..5724aceddb 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index d785e34c63..28b8446d5c 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -62,7 +62,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void @@ -101,12 +101,10 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * render the page using a custom templating - * system + * Render the page using a custom templating system * - * @param object $page the CRM_Core_Form page + * @param CRM_Core_Form $page the CRM_Core_Form page * - * @internal param bool $ret should we echo or return output * * @return void * @access public @@ -190,7 +188,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * set the various rendering templates * - * @param object $page the CRM_Core_Form page + * @param CRM_Core_Form $page the CRM_Core_Form page * * @return void * @access public @@ -209,8 +207,6 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * initialize the various templates * - * @internal param object $page the CRM_Core_Form page - * * @return void * @access public */ diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index ba098a6c61..34682b818b 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -53,7 +53,7 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { * and if success, call post process * when done processing pop to user context * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index 73276c14e2..15791a97b9 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index 4ebdf964d2..876d71e161 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index 8be24345ec..f25469065a 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 352621eb90..22296f70fd 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -53,7 +53,7 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index 69505b96b1..8e97f1fe81 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -50,7 +50,7 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 37555dd664..1ac79b2858 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -67,7 +67,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * upload and move the file if valid to the uploaded directory * - * @param object $page the CRM_Core_Form object + * @param CRM_Core_Form $page the CRM_Core_Form object * @param object $data the QFC data container * @param string $pageName the name of the page which index the data container with * @param string $uploadName the name of the uploaded file @@ -111,7 +111,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page CRM_Core_Form the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * * @return void diff --git a/CRM/Core/ScheduledJob.php b/CRM/Core/ScheduledJob.php index 80f8ecc999..742772bd67 100644 --- a/CRM/Core/ScheduledJob.php +++ b/CRM/Core/ScheduledJob.php @@ -44,16 +44,8 @@ class CRM_Core_ScheduledJob { var $remarks = array(); - /* - * Class constructor - * - * @param string $namespace namespace prefix for component's files - * @access public - * - */ - /** - * @param $params + * @param array $params */ public function __construct($params) { foreach ($params as $name => $param) { diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php index b7bc42a672..5592c5151e 100644 --- a/CRM/Core/SelectValues.php +++ b/CRM/Core/SelectValues.php @@ -355,7 +355,7 @@ class CRM_Core_SelectValues { } /** - * Function to get hours + * get hours * * * @static @@ -369,7 +369,7 @@ class CRM_Core_SelectValues { } /** - * Function to get minutes + * get minutes * * * @static @@ -383,7 +383,7 @@ class CRM_Core_SelectValues { } /** - * Function to get the Map Provider + * get the Map Provider * * @return array $map array of map providers * @static diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 0e1bbaa2ac..5737af8791 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -56,46 +56,38 @@ class CRM_Core_Selector_Controller { */ protected $_object; - /* - * the CRM_Utils_Sort object - * @var object - */ - + /** + * @var CRM_Utils_Sort + */ protected $_sort; - /* - * the current column to sort on - * @var int - */ - + /** + * the current column to sort on + * @var int + */ protected $_sortID; - /* - * the sortOrder array - * @var array - */ - + /** + * the sortOrder array + * @var array + */ protected $_sortOrder; - /* - * the CRM_Utils_Pager object - * @var object - */ - + /** + * @var CRM_Utils_Pager + */ protected $_pager; - /* - * the pageID - * @var int - */ - + /** + * the pageID + * @var int + */ protected $_pageID; - /* - * offset - * @var int - */ - + /** + * offset + * @var int + */ protected $_pagerOffset; /** @@ -110,8 +102,9 @@ class CRM_Core_Selector_Controller { */ protected $_total; - /* the objectAction for the WebObject */ - + /** + * the objectAction for the WebObject + */ protected $_action; /** @@ -390,9 +383,9 @@ class CRM_Core_Selector_Controller { } /** - * function to retrieve rows. + * retrieve rows. * - * @param $form + * @param CRM_Core_Form $form * * @return array of rows * @access public @@ -430,7 +423,7 @@ class CRM_Core_Selector_Controller { /** * getter for pager * - * @return object CRM_Utils_Pager + * @return CRM_Utils_Pager * @access public */ function getPager() { @@ -440,7 +433,7 @@ class CRM_Core_Selector_Controller { /** * getter for sort * - * @return object CRM_Utils_Sort + * @return CRM_Utils_Sort * @access public */ function getSort() { diff --git a/CRM/Core/Smarty/plugins/function.crmDBTpl.php b/CRM/Core/Smarty/plugins/function.crmDBTpl.php index c8ba08c94d..255b2dc0fe 100644 --- a/CRM/Core/Smarty/plugins/function.crmDBTpl.php +++ b/CRM/Core/Smarty/plugins/function.crmDBTpl.php @@ -34,7 +34,7 @@ */ /** - * Function to load a context. If name is asked for only name data is returned. + * load a context. If name is asked for only name data is returned. * And if name is not provided whole context is returned. * */ diff --git a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php index cb71859c9d..2b7f542896 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php +++ b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php @@ -36,9 +36,7 @@ /** * Grab the button type from a passed button element 'name' by checking for reserved QF button type strings * - * @param $btnName - * - * @internal param string $btnId + * @param string $btnName * * @return string button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh' * 'submit', 'done', 'display', 'jump' 'process' diff --git a/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php b/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php index 404cb7a814..f459c3df5f 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php +++ b/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php @@ -34,17 +34,11 @@ */ /** - * Replace the value of an attribute in the input string. Assume - * the the attribute is well formed, of the type name="value". If - * no replacement is mentioned the value is inserted at the end of - * the form element + * Replace a string with the first word in the string * * @param string $string the html to be tweaked with * - * @internal param string $attribute the attribute to modify - * @internal param string $value the new attribute value - * - * @return string the new modified html string + * @return string * @access public */ function smarty_modifier_crmFirstWord($string) { diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 48d67bbb9c..30a1373f50 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -52,19 +52,19 @@ class CRM_Core_State { /** * the state that precedes this state - * @var object + * @var CRM_Core_State */ protected $_back; /** * the state that succeeds this state - * @var object + * @var CRM_Core_State */ protected $_next; /** * The state machine that this state is part of - * @var object + * @var CRM_Core_StateMachine */ protected $_stateMachine; @@ -79,20 +79,14 @@ class CRM_Core_State { /** * constructor * - * @param $name - * @param $type - * @param $back - * @param $next - * @param $stateMachine + * @param string $name internal name of the state + * @param int $type state type + * @param CRM_Core_State $back state that precedes this state + * @param CRM_Core_State $next state that follows this state + * @param CRM_Core_StateMachine $stateMachine statemachine that this states belongs to * - * @internal param \the $string internal name of the state - * @internal param \the $int state type - * @internal param \the $object state that precedes this state - * @internal param \the $object state that follows this state - * @internal param \the $object statemachine that this states belongs to - * - * @return \CRM_Core_State - @access public + * @return CRM_Core_State + * @access public */ function __construct($name, $type, $back, $next, &$stateMachine) { $this->_name = $name; diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index b1cd60f620..1a8dd26b65 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -126,7 +126,7 @@ class CRM_Core_StateMachine { * Next and Back. The other actions (Cancel, Done, Submit etc) do * not need the state machine to figure out where to go * - * @param object $page CRM_Core_Form the current form-page + * @param CRM_Core_Form $page the current form-page * @param string $actionName Current action name, as one Action object can serve multiple actions * @param string $type The type of transition being requested (Next or Back) * diff --git a/CRM/Custom/Form/ChangeFieldType.php b/CRM/Custom/Form/ChangeFieldType.php index bc57ce0c79..67d2530cb8 100644 --- a/CRM/Custom/Form/ChangeFieldType.php +++ b/CRM/Custom/Form/ChangeFieldType.php @@ -91,7 +91,7 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Custom/Form/CustomData.php b/CRM/Custom/Form/CustomData.php index 84caed3467..6a8892d4ee 100644 --- a/CRM/Custom/Form/CustomData.php +++ b/CRM/Custom/Form/CustomData.php @@ -146,7 +146,7 @@ class CRM_Custom_Form_CustomData { } /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ diff --git a/CRM/Custom/Form/DeleteField.php b/CRM/Custom/Form/DeleteField.php index cd7c6dc75d..34597d1a56 100644 --- a/CRM/Custom/Form/DeleteField.php +++ b/CRM/Custom/Form/DeleteField.php @@ -74,7 +74,7 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Custom/Form/DeleteGroup.php b/CRM/Custom/Form/DeleteGroup.php index 34beaeefb8..3664193a97 100644 --- a/CRM/Custom/Form/DeleteGroup.php +++ b/CRM/Custom/Form/DeleteGroup.php @@ -82,7 +82,7 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index aba9fa9a00..1c7981cd9b 100644 --- a/CRM/Custom/Form/Field.php +++ b/CRM/Custom/Form/Field.php @@ -86,7 +86,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { private static $_dataToLabels = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -163,7 +163,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -270,7 +270,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 2e497f2445..3874fc606d 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -71,7 +71,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { protected $_defaults = array(); /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -116,7 +116,6 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { * @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 @@ -189,7 +188,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -405,7 +404,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -444,9 +443,6 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { $defaults['extends'][1] = array(0 => ''); } - - $subName = CRM_Utils_Array::value('extends_entity_column_id', $defaults); - if ($extends == 'Relationship' && !empty($this->_subtypes)) { $relationshipDefaults = array(); foreach ($defaults['extends'][1] as $donCare => $rel_type_id) { @@ -532,16 +528,12 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } } - /* - * Function to return a formatted list of relationship name. - * @param $list array array of relationship name. - * @static - * return array array of relationship name. - */ /** - * @param $list + * Return a formatted list of relationship name. + * + * @param array $list array of relationship name. * - * @return array + * @return array of relationship name. */ static function getFormattedList(&$list) { $relName = array(); diff --git a/CRM/Custom/Form/MoveField.php b/CRM/Custom/Form/MoveField.php index 325bdc3529..644bb7b30a 100644 --- a/CRM/Custom/Form/MoveField.php +++ b/CRM/Custom/Form/MoveField.php @@ -103,7 +103,7 @@ class CRM_Custom_Form_MoveField extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index a375a8b164..7a30143be1 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -68,7 +68,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { protected $_id; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -104,7 +104,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -153,7 +153,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -248,7 +248,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { * @param array $fields posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Custom/Form/Preview.php b/CRM/Custom/Form/Preview.php index 673b2c9ea1..37f7262c61 100644 --- a/CRM/Custom/Form/Preview.php +++ b/CRM/Custom/Form/Preview.php @@ -109,7 +109,7 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Custom/Import/Form/DataSource.php b/CRM/Custom/Import/Form/DataSource.php index 80f2d1b98a..fe2ed4b38c 100644 --- a/CRM/Custom/Import/Form/DataSource.php +++ b/CRM/Custom/Import/Form/DataSource.php @@ -39,7 +39,7 @@ class CRM_Custom_Import_Form_DataSource extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -79,7 +79,7 @@ class CRM_Custom_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Custom/Import/Form/MapField.php b/CRM/Custom/Import/Form/MapField.php index d7796703a0..81e69fc8d6 100644 --- a/CRM/Custom/Import/Form/MapField.php +++ b/CRM/Custom/Import/Form/MapField.php @@ -13,7 +13,7 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { */ protected $_entity; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -46,7 +46,7 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Custom/Import/Form/Preview.php b/CRM/Custom/Import/Form/Preview.php index 27dba3aeb0..3087863b91 100644 --- a/CRM/Custom/Import/Form/Preview.php +++ b/CRM/Custom/Import/Form/Preview.php @@ -7,7 +7,7 @@ class CRM_Custom_Import_Form_Preview extends CRM_Import_Form_Preview { public $_parser = 'CRM_Custom_Import_Parser_Api'; protected $_importParserUrl = '&parser=CRM_Custom_Import_Parser'; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Custom/Import/Form/Summary.php b/CRM/Custom/Import/Form/Summary.php index 87cb95166a..30ce83b653 100644 --- a/CRM/Custom/Import/Form/Summary.php +++ b/CRM/Custom/Import/Form/Summary.php @@ -5,7 +5,7 @@ */ class CRM_Custom_Import_Form_Summary extends CRM_Contact_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index 1a1b1dbbc3..5aad0cf638 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -309,7 +309,7 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { } /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index b6d4ae53ec..12d64530a1 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -176,7 +176,6 @@ 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 - * @internal param \unknown $params */ function formatDateParams() { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 9e5076d4d6..2adab49e4f 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -274,8 +274,7 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * * @return array */ - static function isQuerySetInclusive($tableQueries, $threshold, $exclWeightSum = array( - )) { + static function isQuerySetInclusive($tableQueries, $threshold, $exclWeightSum = array()) { $input = array(); foreach ($tableQueries as $key => $query) { $input[] = substr($key, strrpos($key, '.') + 1); @@ -378,9 +377,7 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { /** * To find fields related to a rule group. * - * @param $params - * - * @internal param \contains $array the rule group property to identify rule group + * @param array $params * * @return array (rule field => weight) array and threshold associated to rule group@access public */ diff --git a/CRM/Dedupe/Finder.php b/CRM/Dedupe/Finder.php index 58b8a83af8..1b4d915d6c 100644 --- a/CRM/Dedupe/Finder.php +++ b/CRM/Dedupe/Finder.php @@ -48,8 +48,7 @@ class CRM_Dedupe_Finder { * * @return array array of (cid1, cid2, weight) dupe triples */ - static function dupes($rgid, $cids = array( - )) { + static function dupes($rgid, $cids = array()) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); $rgBao->id = $rgid; $rgBao->contactIds = $cids; diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 7057ad3555..d8dd6421ec 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -537,7 +537,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m } /** - * Function to batch merge a set of contacts based on rule-group and group. + * batch merge a set of contacts based on rule-group and group. * * @param int $rgid rule group id * @param int $gid group id @@ -545,13 +545,9 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise. * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. - * - * * @param bool $redirectForPerformance * * @return array|bool - * @internal param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. - * Generally used with batch-merge. * @static * @access public */ @@ -583,7 +579,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m } /** - * Function to merge given set of contacts. Performs core operation. + * merge given set of contacts. Performs core operation. * * @param array $dupePairs set of pair of contacts for whom merge is to be done. * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. @@ -600,8 +596,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * @static * @access public */ - static function merge($dupePairs = array( - ), $cacheParams = array(), $mode = 'safe', + static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe', $autoFlip = TRUE, $redirectForPerformance = FALSE ) { $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams); diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index f73f6ece15..87f890f26c 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -42,16 +42,12 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Event_BAO_ManageEvent object + * @return CRM_Event_BAO_ManageEvent object * @access public * @static */ @@ -79,7 +75,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * function to add the event + * add the event * * @param array $params reference array contains the values submitted by the form * @@ -119,7 +115,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * function to create the event + * create the event * * @param array $params reference array contains the values submitted by the form * @@ -178,7 +174,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Function to delete the event + * delete the event * * @param int $id event id * @@ -231,11 +227,8 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * Function to delete the location block associated with an event, * if not being used by any other event. * - * @param $locBlockId - * @param null $eventId - * - * @internal param int $loc_block_id location block id to be deleted - * @internal param int $eventid event id with which loc block is associated + * @param $locBlockId location block id to be deleted + * @param int $eventId event with which loc block is associated * * @access public * @static @@ -589,9 +582,6 @@ $event_summary_limit * @param boolean $considerRole consider role for participant count. * @param boolean $role consider counted( is filter role) participant. * - * @internal param array $eventIds consider participants from given events. - * @internal param bool $countWithStatus retrieve participant count w/ each participant status. - * * @access public * * @return array array with count of participants for each event based on status/role @@ -647,9 +637,7 @@ $event_summary_limit /** * function to get the information to map a event * - * @param $id - * - * @internal param array $ids the list of ids for which we want map info + * @param int $id for which we want map info * * @return null|string title of the event * @static @@ -1937,7 +1925,7 @@ WHERE ce.loc_block_id = $locBlockId"; * @access public */ /** - * @param $params + * @param array $params * * @return bool */ @@ -1965,12 +1953,9 @@ WHERE ce.loc_block_id = $locBlockId"; /** * make sure that the user has permission to access this event * - * @param null $eventId + * @param int $eventId * @param int $type * - * @internal param int $id the id of the event - * @internal param int $name the name or title of the event - * * @return string the permission that the user has (or null) * @access public * @static @@ -2109,18 +2094,13 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field return (int)CRM_Core_DAO::singleValueQuery($query, array(1 => array($eventId, 'Positive'))); } - /* + /** * Retrieve event template default values to be set * as default values for current new event. * - * @params int $templateId event template id. + * @param int $templateId event template id. * - * @return $defaults an array of custom data defaults. - */ - /** - * @param $templateId - * - * @return array + * @return array of custom data defaults. */ static function getTemplateDefaultValues($templateId) { $defaults = array(); @@ -2154,16 +2134,11 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field return CRM_Event_BAO_Event::retrieve($params, $defaults); } - /* + /** * Update the Campaign Id of all the participants of the given event * - * @params int $eventID event id. - * @params int $eventCampaignID campaign id of that event - * - */ - /** - * @param $eventID - * @param $eventCampaignID + * @param int $eventID event id. + * @param int $eventCampaignID campaign id of that event */ static function updateParticipantCampaignID($eventID, $eventCampaignID) { $params = array(); diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 393485d78f..c52c4ff33f 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -83,9 +83,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * * @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_Event_BAO_Participant object + * @return CRM_Event_BAO_Participant object * @access public * @static */ @@ -190,9 +188,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * * @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_Event_BAO_Participant object + * @return CRM_Event_BAO_Participant object * @access public * @static */ @@ -487,14 +483,11 @@ SELECT event.event_full_text, * with total participant count that field going to carry. * * @param int $eventId event id. - * @param array $skipParticipantIds + * @param array $skipParticipantIds an array of participant ids those we should skip. * @param bool $considerCounted * @param bool $considerWaiting * @param bool $considerTestParticipants * - * @internal param array $skipParticipants an array of participant ids those we should skip. - * @internal param int $isTest would you like to consider test participants. - * * @return array $optionsCount an array of each option id and total count * @static * @access public @@ -783,7 +776,7 @@ GROUP BY participant.event_id } /** - * function to get the event name/sort name for a particular participation / participant + * get the event name/sort name for a particular participation / participant * * @param int $participantId id of the participant @@ -925,7 +918,7 @@ WHERE civicrm_participant.id = {$participantId} * @param array $input an assosiative array of name /value pairs * from other function * - * @return object CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution object * @access public * @static */ @@ -1140,10 +1133,7 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * @param null $newStatusID * @param bool $updatePrimaryStatus * - * @internal param int $statusId status id for participant - * return void - * - * @return bool + * @return bool|void * @access public * @static */ @@ -1177,9 +1167,8 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * @param int $participantIds array of participant ids * @param int $statusId status id for participant * @param bool $updateRegisterDate - * @params boolean $updateRegisterDate way to track when status changed. * - * return void + * @return void * * @access public * @static @@ -1440,7 +1429,7 @@ UPDATE civicrm_participant } /** - * Function to send mail and create activity + * send mail and create activity * when participant status changed. * * @param int $participantId participant id. @@ -1698,11 +1687,9 @@ UPDATE civicrm_participant } /** - * Function to get participant record count for a Contact + * get participant record count for a Contact * - * @param $contactID - * - * @internal param int $contactId Contact ID + * @param int $contactID * * @return int count of participant records * @access public @@ -1751,9 +1738,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND /** * Function to get additional Participant edit & view url . * - * @param $participantIds - * - * @internal param array $paticipantIds an array of additional participant ids. + * @param array $participantIds an array of additional participant ids. * * @return array of Urls. * @access public @@ -1832,7 +1817,7 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2"; } /** - * @param $params + * @param array $params * @param $participantId * @param $contributionId * @param $feeBlock diff --git a/CRM/Event/BAO/ParticipantStatusType.php b/CRM/Event/BAO/ParticipantStatusType.php index 930bfd1e62..344eadbf93 100644 --- a/CRM/Event/BAO/ParticipantStatusType.php +++ b/CRM/Event/BAO/ParticipantStatusType.php @@ -34,7 +34,7 @@ */ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatusType { /** - * @param $params + * @param array $params * * @return $this|null */ @@ -48,7 +48,7 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * @param $params + * @param array $params * * @return $this|null */ @@ -86,7 +86,7 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * @param $params + * @param array $params * @param $defaults * * @return CRM_Event_DAO_ParticipantStatusType|null @@ -115,7 +115,7 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 104bcff174..84e929a2bb 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -70,7 +70,7 @@ class CRM_Event_Badge { } /** - * function to create the labels (pdf) + * create the labels (pdf) * It assumes the participants are from the same event * * @param array $participants @@ -171,12 +171,9 @@ class CRM_Event_Badge { function pdfExtraFormat() {} /** - * function to create labels (pdf) + * create labels (pdf) * - * @param $participants - * - * @internal param array $contactRows assciated array of contact data - * @internal param string $format format in which labels needs to be printed + * @param array $participants * * @return null * @access public diff --git a/CRM/Event/Cart/BAO/Cart.php b/CRM/Event/Cart/BAO/Cart.php index 6241ee2a8d..1fb5a076c7 100644 --- a/CRM/Event/Cart/BAO/Cart.php +++ b/CRM/Event/Cart/BAO/Cart.php @@ -10,7 +10,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { ); /** - * @param $params + * @param array $params * * @return $this */ @@ -56,7 +56,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $params + * @param array $params * * @return $this * @throws Exception @@ -86,7 +86,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $params + * @param array $params * * @return bool|CRM_Event_Cart_BAO_Cart */ @@ -313,7 +313,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $params + * @param array $params * @param $values * * @return mixed diff --git a/CRM/Event/Cart/BAO/EventInCart.php b/CRM/Event/Cart/BAO/EventInCart.php index 4b047aa59c..b14baf50cd 100644 --- a/CRM/Event/Cart/BAO/EventInCart.php +++ b/CRM/Event/Cart/BAO/EventInCart.php @@ -26,7 +26,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $params + * @param array $params * * @return $this|CRM_Event_Cart_BAO_EventInCart * @throws Exception @@ -79,7 +79,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $params + * @param array $params * * @return array */ @@ -105,7 +105,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $params + * @param array $params * * @return bool|CRM_Event_Cart_BAO_EventInCart */ diff --git a/CRM/Event/Cart/BAO/MerParticipant.php b/CRM/Event/Cart/BAO/MerParticipant.php index 3e4c3bdbb8..f042668c61 100644 --- a/CRM/Event/Cart/BAO/MerParticipant.php +++ b/CRM/Event/Cart/BAO/MerParticipant.php @@ -119,7 +119,7 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant { } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Event/Cart/Form/Cart.php b/CRM/Event/Cart/Form/Cart.php index 04a17a9959..e45e136843 100644 --- a/CRM/Event/Cart/Form/Cart.php +++ b/CRM/Event/Cart/Form/Cart.php @@ -145,8 +145,7 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form { * * @return int|mixed|null */ - static function find_or_create_contact($registeringContactID = NULL, $fields = array( - )) { + static function find_or_create_contact($registeringContactID = NULL, $fields = array()) { $contact_id = self::find_contact($fields); if ($contact_id) { diff --git a/CRM/Event/Cart/Form/Checkout/Payment.php b/CRM/Event/Cart/Form/Checkout/Payment.php index e145f6a604..6767bce06b 100644 --- a/CRM/Event/Cart/Form/Checkout/Payment.php +++ b/CRM/Event/Cart/Form/Checkout/Payment.php @@ -18,7 +18,7 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart { public $pay_later_receipt; /** - * @param $params + * @param array $params * @param $participant * @param $event * @@ -313,7 +313,7 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart { /** * @param $events_in_cart - * @param $params + * @param array $params */ function emailReceipt($events_in_cart, $params) { $contact_details = CRM_Contact_BAO_Contact::getContactDetails($this->payer_contact_id); @@ -560,7 +560,7 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart { } /** - * @param $params + * @param array $params * * @return array * @throws Exception @@ -601,7 +601,7 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart { /** * @param $mer_participant - * @param $params + * @param array $params * @param $event * * @return object diff --git a/CRM/Event/Cart/Form/MerParticipant.php b/CRM/Event/Cart/Form/MerParticipant.php index ea26611a3d..cf66852784 100644 --- a/CRM/Event/Cart/Form/MerParticipant.php +++ b/CRM/Event/Cart/Form/MerParticipant.php @@ -16,7 +16,7 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form */ function appendQuickForm(&$form) { $textarea_size = array('size' => 30, 'maxlength' => 60); diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index 81b88772bb..4a12c47e5e 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -40,9 +40,9 @@ class CRM_Event_Form_EventFees { /** - * Function to set variables up before form is built + * set variables up before form is built * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -73,7 +73,7 @@ class CRM_Event_Form_EventFees { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ @@ -339,9 +339,9 @@ SELECT id, html_type } /** - * Function to build the form + * Build the form object * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent.php b/CRM/Event/Form/ManageEvent.php index 039bd755ec..eb40f4f14b 100644 --- a/CRM/Event/Form/ManageEvent.php +++ b/CRM/Event/Form/ManageEvent.php @@ -91,7 +91,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { protected $_isRepeatingEvent; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -225,7 +225,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -256,7 +256,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/Conference.php b/CRM/Event/Form/ManageEvent/Conference.php index ebf4d311e9..d47a342569 100644 --- a/CRM/Event/Form/ManageEvent/Conference.php +++ b/CRM/Event/Form/ManageEvent/Conference.php @@ -45,7 +45,7 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { public $_action; /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -71,7 +71,7 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/Delete.php b/CRM/Event/Form/ManageEvent/Delete.php index 3167d5964e..2333050ed2 100644 --- a/CRM/Event/Form/ManageEvent/Delete.php +++ b/CRM/Event/Form/ManageEvent/Delete.php @@ -47,7 +47,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { protected $_title; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -68,7 +68,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index b9f3ff99ca..2a74a81ce1 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -46,7 +46,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { protected $_eventType = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -86,7 +86,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -150,7 +150,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -241,9 +241,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { /** * global validation rules for the form * - * @param $values - * - * @internal param array $fields posted values of the form + * @param array $values * * @return array list of errors to be posted back to the form * @static @@ -274,7 +272,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -339,7 +337,6 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { parent::endPostProcess(); } - //end of function /** * Return a descriptive name for the page, used in wizard header @@ -351,18 +348,13 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { return ts('Event Information and Settings'); } - /* Retrieve event template custom data values - * and set as default values for current new event. - * - * @params int $tempId event template id. - * - * @return $defaults an array of custom data defaults. - */ - /** - * @param $templateId + * Retrieve event template custom data values + * and set as default values for current new event. + * + * @param int $templateId event template id. * - * @return array + * @return array of custom data defaults. */ public function templateCustomDataValues($templateId) { $defaults = array(); diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php index c3710506ce..e4891bedba 100644 --- a/CRM/Event/Form/ManageEvent/Fee.php +++ b/CRM/Event/Form/ManageEvent/Fee.php @@ -60,7 +60,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { private $_inDate; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -70,7 +70,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -249,7 +249,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/Location.php b/CRM/Event/Form/ManageEvent/Location.php index c5cc678f44..96e2ed05cf 100644 --- a/CRM/Event/Form/ManageEvent/Location.php +++ b/CRM/Event/Form/ManageEvent/Location.php @@ -69,7 +69,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { public $_values = array(); /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -97,7 +97,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -218,7 +218,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -286,7 +286,6 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { $this->ajaxResponse['tabValid'] = TRUE; parent::endPostProcess(); } - //end of function /** * Return a descriptive name for the page, used in wizard header diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 4b18d3099a..8276aaed8e 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -51,7 +51,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent protected $_profilePostMultipleAdd = array(); /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -90,7 +90,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -208,8 +208,6 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent * * @param array $defaults the array of default values * - * @internal param bool $force should we set show hide based on input defaults - * * @return void */ function setShowHide($defaults) { @@ -230,7 +228,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -318,11 +316,10 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * Function to build Registration Block + * build Registration Block * - * @param $form + * @param CRM_Core_Form $form * - * @internal param int $pageId * @static */ function buildRegistrationBlock(&$form) { @@ -394,11 +391,10 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * Function to build Confirmation Block + * build Confirmation Block * - * @param $form + * @param CRM_Core_Form $form * - * @internal param int $pageId * @static */ function buildConfirmationBlock(&$form) { @@ -425,9 +421,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Function to build Email Block * - * @param $form + * @param CRM_Core_Form $form * - * @internal param int $pageId * @static */ function buildMailBlock(&$form) { @@ -445,7 +440,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * @param $form + * @param CRM_Core_Form $form */ function buildThankYouBlock(&$form) { $attributes = CRM_Core_DAO::getAttribute('CRM_Event_DAO_Event'); @@ -479,11 +474,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * global validation rules for the form * - * @param $values + * @param array $values * @param $files - * @param $form - * - * @internal param array $fields posted values of the form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static @@ -820,7 +813,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * Function to process the form + * Process the form submission * * @access public * @@ -1015,7 +1008,6 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent parent::endPostProcess(); } - //end of function /** * Return a descriptive name for the page, used in wizard header diff --git a/CRM/Event/Form/ManageEvent/Repeat.php b/CRM/Event/Form/ManageEvent/Repeat.php index df460f6643..65652320d2 100644 --- a/CRM/Event/Form/ManageEvent/Repeat.php +++ b/CRM/Event/Form/ManageEvent/Repeat.php @@ -73,7 +73,7 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/Event/Form/ManageEvent/ScheduleReminders.php b/CRM/Event/Form/ManageEvent/ScheduleReminders.php index 2fc095c3fd..3097025aa8 100755 --- a/CRM/Event/Form/ManageEvent/ScheduleReminders.php +++ b/CRM/Event/Form/ManageEvent/ScheduleReminders.php @@ -41,7 +41,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_ManageEvent { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -96,7 +96,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -111,7 +111,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -245,7 +245,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage } /** - * Function to process the form + * Process the form submission * * @access public * @@ -394,7 +394,6 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage parent::endPostProcess(); } - //end of function /** * Return a descriptive name for the page, used in wizard header diff --git a/CRM/Event/Form/ManageEvent/TabHeader.php b/CRM/Event/Form/ManageEvent/TabHeader.php index ea008c60e1..893df6fce6 100644 --- a/CRM/Event/Form/ManageEvent/TabHeader.php +++ b/CRM/Event/Form/ManageEvent/TabHeader.php @@ -39,7 +39,7 @@ class CRM_Event_Form_ManageEvent_TabHeader { /** - * @param $form + * @param CRM_Core_Form $form * * @return array */ @@ -60,7 +60,7 @@ class CRM_Event_Form_ManageEvent_TabHeader { } /** - * @param $form + * @param CRM_Core_Form $form * * @return array * @throws Exception diff --git a/CRM/Event/Form/Participant.php b/CRM/Event/Form/Participant.php index 417dcb0d9a..e5029dba47 100644 --- a/CRM/Event/Form/Participant.php +++ b/CRM/Event/Form/Participant.php @@ -154,15 +154,14 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment */ public $_eID = NULL; - /* - *Line Item for Price Set - */ - + /** + * Line Item for Price Set + */ public $_lineItem = NULL; - /* - *Contribution mode for event registration for offline mode - */ + /* + * Contribution mode for event registration for offline mode + */ public $_contributeMode = 'direct'; public $_online; @@ -199,7 +198,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_onlinePendingContributionId = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -592,7 +591,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -799,12 +798,10 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment /** * global validation rules for the form * - * @param $values + * @param array $values posted values of the form * @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 * @access public @@ -875,7 +872,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment } /** - * Function to process the form + * Process the form submission * * @access public */ diff --git a/CRM/Event/Form/ParticipantFeeSelection.php b/CRM/Event/Form/ParticipantFeeSelection.php index 7ff20fb1ac..577f6ec445 100644 --- a/CRM/Event/Form/ParticipantFeeSelection.php +++ b/CRM/Event/Form/ParticipantFeeSelection.php @@ -264,7 +264,7 @@ class CRM_Event_Form_ParticipantFeeSelection extends CRM_Core_Form { } /** - * @param $params + * @param array $params * * @return mixed */ diff --git a/CRM/Event/Form/ParticipantView.php b/CRM/Event/Form/ParticipantView.php index 1429ce2119..c9e4ecfb9b 100644 --- a/CRM/Event/Form/ParticipantView.php +++ b/CRM/Event/Form/ParticipantView.php @@ -42,7 +42,7 @@ class CRM_Event_Form_ParticipantView extends CRM_Core_Form { public $useLivePageJS = TRUE; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -220,7 +220,7 @@ class CRM_Event_Form_ParticipantView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 19237c3cfb..4dc2c87b66 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -190,7 +190,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_isBillingAddressRequiredForPayLater; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -571,7 +571,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * Function to add the custom fields + * add the custom fields * * @param $id * @param $name @@ -675,7 +675,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param $eventID * * @throws Exception @@ -733,7 +733,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * Function to handle process after the confirmation of payment by User + * handle process after the confirmation of payment by User * * @param null $contactID * @param null $contribution @@ -838,7 +838,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * Process the participant * - * @param $params + * @param array $params * @param $contactID * * @return void @@ -950,8 +950,8 @@ WHERE v.option_group_id = g.id * @access public */ /** - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param bool $skipCurrent * * @return int|string @@ -1049,8 +1049,8 @@ WHERE v.option_group_id = g.id * @access public */ /** - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * * @return mixed */ diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index 1b34e18648..fc324c0988 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -53,7 +53,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R public $additionalParticipantId = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -89,7 +89,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * * @access public @@ -165,7 +165,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -370,7 +370,6 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R * @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 @@ -570,7 +569,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * Function to process the form + * Process the form submission * * @access public * @@ -766,8 +765,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R * Reset values for all options those are full. * **/ - function resetElementValue($optionFullIds = array( - )) { + function resetElementValue($optionFullIds = array()) { if (!is_array($optionFullIds) || empty($optionFullIds) || !$this->isSubmitted() @@ -826,8 +824,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R * @param $elementName * @param array $optionIds */ - function resetSubmittedValue($elementName, $optionIds = array( - )) { + function resetSubmittedValue($elementName, $optionIds = array()) { if (empty($elementName) || !$this->elementExists($elementName) || !$this->getSubmitValue($elementName) diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php index 824e54da6c..97d65e52c7 100644 --- a/CRM/Event/Form/Registration/Confirm.php +++ b/CRM/Event/Form/Registration/Confirm.php @@ -57,7 +57,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { public $_totalAmount; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -219,7 +219,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -391,7 +391,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -861,13 +861,12 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } } } - //end of function /** * Process the contribution * - * @param $form - * @param $params + * @param CRM_Core_Form $form + * @param array $params * @param $result * @param $contactID * @param bool $pending @@ -987,9 +986,9 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { /** * Fix the Location Fields * - * @param $params + * @param array $params * @param $fields - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -1033,12 +1032,12 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * function to update contact fields + * update contact fields * * @param $contactID - * @param $params + * @param array $params * @param $fields - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public diff --git a/CRM/Event/Form/Registration/ParticipantConfirm.php b/CRM/Event/Form/Registration/ParticipantConfirm.php index de9337ca67..588168a1c0 100644 --- a/CRM/Event/Form/Registration/ParticipantConfirm.php +++ b/CRM/Event/Form/Registration/ParticipantConfirm.php @@ -44,7 +44,7 @@ class CRM_Event_Form_Registration_ParticipantConfirm extends CRM_Event_Form_Regi protected $_cc = NULL; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -91,7 +91,7 @@ class CRM_Event_Form_Registration_ParticipantConfirm extends CRM_Event_Form_Regi } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -164,7 +164,7 @@ class CRM_Event_Form_Registration_ParticipantConfirm extends CRM_Event_Form_Regi } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 9cd8a852ac..9c1b581ddb 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -83,7 +83,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { public $_paymentFields = array(); /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -130,7 +130,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * This function sets the default values for the form. For edit/view mode + * Set default values for the form. For edit/view mode * the default values are retrieved from the database * Adding discussion from CRM-11915 as code comments * When multiple payment processors are configured for a event and user does any selection changes for them on online event registeration page : @@ -312,7 +312,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -545,7 +545,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * build the radio/text form elements for the amount field * - * @param object $form form object + * @param CRM_Core_Form $form form object * @param boolean $required true if you want to add formRule * @param int $discountId discount id for the event * @@ -691,7 +691,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * @param $form + * @param CRM_Core_Form $form */ public static function formatFieldsForOptionFull(&$form) { $priceSet = $form->get('priceSet'); @@ -806,7 +806,6 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * @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 @@ -969,7 +968,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -1208,10 +1207,9 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success'); } } - //end of function /* - * Function to process Registration of free event + * process Registration of free event * * @param array $param Form valuess * @param int contactID @@ -1221,7 +1219,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * */ /** - * @param $params + * @param array $params * @param null $contactID */ public function processRegistration($params, $contactID = NULL) { diff --git a/CRM/Event/Form/Registration/ThankYou.php b/CRM/Event/Form/Registration/ThankYou.php index 66e71e73c3..f49560493e 100644 --- a/CRM/Event/Form/Registration/ThankYou.php +++ b/CRM/Event/Form/Registration/ThankYou.php @@ -41,7 +41,7 @@ class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -84,7 +84,7 @@ class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -239,14 +239,13 @@ class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration { } /** - * Function to process the form + * Process the form submission * * @access public * * @return void */ public function postProcess() {} - //end of function /** * Return a descriptive name for the page, used in wizard header diff --git a/CRM/Event/Form/Search.php b/CRM/Event/Form/Search.php index f69f4d63b9..a29a67b697 100644 --- a/CRM/Event/Form/Search.php +++ b/CRM/Event/Form/Search.php @@ -169,7 +169,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Event/Form/SearchEvent.php b/CRM/Event/Form/SearchEvent.php index af55dc0f18..488067ed2e 100644 --- a/CRM/Event/Form/SearchEvent.php +++ b/CRM/Event/Form/SearchEvent.php @@ -51,7 +51,7 @@ class CRM_Event_Form_SearchEvent extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Event/Form/Task.php b/CRM/Event/Form/Task.php index efde2567ba..572bc45ad4 100644 --- a/CRM/Event/Form/Task.php +++ b/CRM/Event/Form/Task.php @@ -80,7 +80,7 @@ class CRM_Event_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -164,8 +164,6 @@ class CRM_Event_Form_Task extends CRM_Core_Form { * @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/Form/Task/AddToGroup.php b/CRM/Event/Form/Task/AddToGroup.php index 2594f2d507..4519c6a796 100644 --- a/CRM/Event/Form/Task/AddToGroup.php +++ b/CRM/Event/Form/Task/AddToGroup.php @@ -68,9 +68,7 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { * @access public */ function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); parent::setContactIDs(); @@ -79,7 +77,7 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -246,6 +244,5 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { $status = ''; CRM_Core_Session::setStatus($status, ts('Added Contact to %1', array(1 => $groupName, 'count' => $added, 'plural' => 'Added Contacts to %1')), 'success', array('expires' => 0)); } - //end of function } diff --git a/CRM/Event/Form/Task/Badge.php b/CRM/Event/Form/Task/Badge.php index ebe40e374b..2da878a54d 100644 --- a/CRM/Event/Form/Task/Badge.php +++ b/CRM/Event/Form/Task/Badge.php @@ -83,7 +83,7 @@ class CRM_Event_Form_Task_Badge extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Event/Form/Task/Batch.php b/CRM/Event/Form/Task/Batch.php index 480f90926f..62651c003c 100644 --- a/CRM/Event/Form/Task/Batch.php +++ b/CRM/Event/Form/Task/Batch.php @@ -92,7 +92,7 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -234,7 +234,7 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -348,7 +348,6 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { CRM_Core_Session::setStatus(ts('No updates have been saved.'), ts('Not Saved'), 'alert'); } } - //end of function /** * @param $participantId diff --git a/CRM/Event/Form/Task/Cancel.php b/CRM/Event/Form/Task/Cancel.php index f4785c775e..88f9a173e7 100644 --- a/CRM/Event/Form/Task/Cancel.php +++ b/CRM/Event/Form/Task/Cancel.php @@ -51,9 +51,7 @@ class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task { * @access public */ function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $session = CRM_Core_Session::singleton(); @@ -61,7 +59,7 @@ class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -92,6 +90,5 @@ class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task { CRM_Event_BAO_Participant::create($value); } } - //end of function } diff --git a/CRM/Event/Form/Task/Delete.php b/CRM/Event/Form/Task/Delete.php index 9735f7ee87..5a32958873 100644 --- a/CRM/Event/Form/Task/Delete.php +++ b/CRM/Event/Form/Task/Delete.php @@ -69,7 +69,7 @@ class CRM_Event_Form_Task_Delete extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Event/Form/Task/Email.php b/CRM/Event/Form/Task/Email.php index 8dbc780a84..9fff4804c9 100644 --- a/CRM/Event/Form/Task/Email.php +++ b/CRM/Event/Form/Task/Email.php @@ -78,7 +78,7 @@ class CRM_Event_Form_Task_Email extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Event/Form/Task/PickProfile.php b/CRM/Event/Form/Task/PickProfile.php index 5a7848c88e..45c9e4d719 100644 --- a/CRM/Event/Form/Task/PickProfile.php +++ b/CRM/Event/Form/Task/PickProfile.php @@ -64,9 +64,7 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { * @access public */ function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $session = CRM_Core_Session::singleton(); @@ -88,7 +86,7 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -149,6 +147,5 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { // also reset the batch page so it gets new values from the db $this->controller->resetPage('Batch'); } - //end of function } diff --git a/CRM/Event/Form/Task/Print.php b/CRM/Event/Form/Task/Print.php index 8e45c6c4a2..0d97db74eb 100644 --- a/CRM/Event/Form/Task/Print.php +++ b/CRM/Event/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Event_Form_Task_Print extends CRM_Event_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Event/Form/Task/SaveSearch.php b/CRM/Event/Form/Task/SaveSearch.php index aae1fcaa61..3577815cc4 100644 --- a/CRM/Event/Form/Task/SaveSearch.php +++ b/CRM/Event/Form/Task/SaveSearch.php @@ -58,7 +58,7 @@ class CRM_Event_Form_Task_SaveSearch extends CRM_Event_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Event/Form/Task/SaveSearch/Update.php b/CRM/Event/Form/Task/SaveSearch/Update.php index 3e7eaba8d3..fe3352c979 100644 --- a/CRM/Event/Form/Task/SaveSearch/Update.php +++ b/CRM/Event/Form/Task/SaveSearch/Update.php @@ -57,7 +57,7 @@ class CRM_Event_Form_Task_SaveSearch_Update extends CRM_Event_Form_Task_SaveSear } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public diff --git a/CRM/Event/Form/Task/SearchTaskHookSample.php b/CRM/Event/Form/Task/SearchTaskHookSample.php index 77b9ee09a6..d9e7ecc09a 100644 --- a/CRM/Event/Form/Task/SearchTaskHookSample.php +++ b/CRM/Event/Form/Task/SearchTaskHookSample.php @@ -72,7 +72,7 @@ class CRM_Event_Form_Task_SearchTaskHookSample extends CRM_Event_Form_Task { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Import/Form/DataSource.php b/CRM/Event/Import/Form/DataSource.php index 56482e8de4..0237558720 100644 --- a/CRM/Event/Import/Form/DataSource.php +++ b/CRM/Event/Import/Form/DataSource.php @@ -39,7 +39,7 @@ class CRM_Event_Import_Form_DataSource extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -52,7 +52,7 @@ class CRM_Event_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index 57ed04e49f..5f9546143f 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -92,7 +92,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Event/Import/Form/Preview.php b/CRM/Event/Import/Form/Preview.php index 22cdfb2024..e535257fa5 100644 --- a/CRM/Event/Import/Form/Preview.php +++ b/CRM/Event/Import/Form/Preview.php @@ -40,7 +40,7 @@ class CRM_Event_Import_Form_Preview extends CRM_Import_Form_Preview { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Event/Import/Form/Summary.php b/CRM/Event/Import/Form/Summary.php index 5dca5581c1..209af3ad5d 100644 --- a/CRM/Event/Import/Form/Summary.php +++ b/CRM/Event/Import/Form/Summary.php @@ -39,7 +39,7 @@ class CRM_Event_Import_Form_Summary extends CRM_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index 24c9629add..87a227ff40 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -310,7 +310,7 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { } /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public @@ -415,11 +415,10 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param $fileName + * @param string $fileName * @param array $header - * @param data $data + * @param array $data * - * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Event/Page/AJAX.php b/CRM/Event/Page/AJAX.php index 24d05da96a..c3217c6a42 100644 --- a/CRM/Event/Page/AJAX.php +++ b/CRM/Event/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Event_Page_AJAX { /** - * Function for building EventFee combo box + * building EventFee combo box * FIXME: This ajax callback could be eliminated in favor of an entityRef field but the priceFieldValue api doesn't currently support filtering on entity_table */ function eventFee() { diff --git a/CRM/Event/Page/ManageEvent.php b/CRM/Event/Page/ManageEvent.php index d72947a04b..e218713a3c 100644 --- a/CRM/Event/Page/ManageEvent.php +++ b/CRM/Event/Page/ManageEvent.php @@ -434,7 +434,7 @@ ORDER BY start_date desc } /** - * @param $params + * @param array $params * @param bool $sortBy * @param $force * diff --git a/CRM/Event/Page/UserDashboard.php b/CRM/Event/Page/UserDashboard.php index 395c969765..fef1afdda9 100644 --- a/CRM/Event/Page/UserDashboard.php +++ b/CRM/Event/Page/UserDashboard.php @@ -39,7 +39,7 @@ class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** - * Function to list participations for the UF user + * list participations for the UF user * * return null * @access public diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 39536722ad..dc1472b762 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -136,9 +136,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @param null $id * @param null $cond - * @param string $retColumn - * - * @internal param $string - $retColumn tells populate() whether to return 'name' (default) or 'label' values + * @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 c3709486e7..33cd754015 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -194,7 +194,6 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co $this->_query->_distinctComponentClause = " civicrm_participant.id"; $this->_query->_groupByComponentClause = " GROUP BY civicrm_participant.id "; } - //end of constructor /** * Can be used to alter the number of participation returned from a buildForm hook @@ -259,15 +258,13 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -283,7 +280,6 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -434,13 +430,12 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** + * FIXME: the current internationalisation is bad, but should more or less work + * on most of "European" languages * * @return array $qill which contains an array of strings * @access public */ - - // the current internationalisation is bad, but should more or less work - // for most of "European" languages public function getQILL() { return $this->_query->qill(); } @@ -535,5 +530,4 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co return ts('CiviCRM Event Search'); } } -//end of class diff --git a/CRM/Event/StateMachine/Registration.php b/CRM/Event/StateMachine/Registration.php index 85f58ced2b..afb17dd8fe 100644 --- a/CRM/Event/StateMachine/Registration.php +++ b/CRM/Event/StateMachine/Registration.php @@ -45,7 +45,6 @@ class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine { * @param object $controller * @param \const|int $action * - * @internal param \CRM_Event_Controller $object * @return \CRM_Event_StateMachine_Registration CRM_Event_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index 5dcd74d3e0..54060a5657 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -44,7 +44,7 @@ class CRM_Export_BAO_Export { CONST EXPORT_ROW_COUNT = 10000; /** - * Function to get the list the export fields + * get the list the export fields * * @param int $selectAll user preference while export * @param array $ids contact ids @@ -1207,7 +1207,7 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c } /** - * Function to handle import error file creation. + * handle import error file creation. * */ static function invoke() { @@ -1789,7 +1789,7 @@ WHERE id IN ( $deleteIDString ) } /** - * Function to merge household record into the individual record + * merge household record into the individual record * if exists * * @param string $exportTempTable temporary temp table that stores the records diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index 4fc943f9c9..261b547869 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -63,7 +63,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { protected $_mappingId; /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Export/Form/Select.php b/CRM/Export/Form/Select.php index e5a88fe3ba..e8e8e97bed 100644 --- a/CRM/Export/Form/Select.php +++ b/CRM/Export/Form/Select.php @@ -237,7 +237,7 @@ FROM {$this->_componentTable} } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -332,7 +332,7 @@ FROM {$this->_componentTable} } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -445,7 +445,7 @@ FROM {$this->_componentTable} } /** - * Function to build mapping form element + * build mapping form element * */ function buildMapping() { diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php index a2eb7d9f08..739ae69182 100644 --- a/CRM/Extension/Container/Basic.php +++ b/CRM/Extension/Container/Basic.php @@ -235,7 +235,6 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface /** * Scan $basedir for a list of extension-keys * - * @internal param string $dirSep the local system's directory separator * @return array($key => $relUrl) */ protected function getRelUrls() { diff --git a/CRM/Extension/Info.php b/CRM/Extension/Info.php index ef30b76dc5..2c69775f6d 100644 --- a/CRM/Extension/Info.php +++ b/CRM/Extension/Info.php @@ -47,7 +47,6 @@ class CRM_Extension_Info { * @param $file * * @throws CRM_Extension_Exception_ParseException - * @internal param string $string XML content * @return CRM_Extension_Info */ public static function loadFromFile($file) { diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index 1e0b2ac09c..a56a24db32 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -176,7 +176,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * Function to run hooks in the payment processor class + * run hooks in the payment processor class * Load requested payment processor and call the method specified. * * @param CRM_Extension_Info $info diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php index e393d8ee78..8c26443cd0 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -129,8 +129,6 @@ class CRM_Extension_Mapper { * * @param $clazz * - * @internal param string $key extension key - * * @return string full path the extension .php file */ public function classToPath($clazz) { @@ -176,7 +174,7 @@ class CRM_Extension_Mapper { * * @throws CRM_Extension_Exception * @throws Exception - * @return object CRM_Extension_Info + * @return CRM_Extension_Info */ public function keyToInfo($key, $fresh = FALSE) { if ($fresh || !array_key_exists($key, $this->infos)) { diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 2f2b05d514..85f29a15d5 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -49,16 +49,12 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_FinancialAccount object + * @return CRM_Contribute_BAO_FinancialAccount object * @access public * @static */ @@ -86,7 +82,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * function to add the financial types + * add the financial types * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -120,7 +116,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Function to delete financial Types + * delete financial Types * * @param int $financialAccountId * @static diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index e3c6170454..e3d6c5684f 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -43,16 +43,12 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_FinancialItem object + * @return CRM_Contribute_BAO_FinancialItem object * @access public * @static */ @@ -67,7 +63,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * function to add the financial items and financial trxn + * add the financial items and financial trxn * * @param object $lineItem line item object * @param object $contribution contribution object @@ -131,7 +127,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * function to create the financial Items and financial enity trxn + * create the financial Items and financial enity trxn * * @param array $params associated array to create financial items * @param array $ids financial item ids @@ -172,7 +168,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Core_BAO_FinancialTrxn object + * @return CRM_Core_BAO_FinancialTrxn object * @access public * @static */ @@ -187,10 +183,7 @@ 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 bool $maxId - * - * @internal param bool $maxID to retrive max id + * @param bool $maxId to retrive max id * * @return array * @access public diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index 7559b1f23f..9b99f007ec 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -49,16 +49,12 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType object * @access public * @static */ @@ -86,7 +82,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * function to add the financial types + * add the financial types * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -118,12 +114,11 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * Function to delete financial Types + * delete financial Types * - * @param $financialTypeId + * @param int $financialTypeId * * @return array|bool - * @internal param int $contributionTypeId * @static */ static function del($financialTypeId) { diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 5d3fe3a97c..2bb670fcec 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -50,18 +50,14 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin private static $financialAccount; /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * * @param array $allValues * - * @return object CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType object * @access public * @static */ @@ -77,7 +73,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * function to add the financial types + * add the financial types * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -106,12 +102,11 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * Function to delete financial Types + * delete financial Types * - * @param $financialTypeAccountId - * @param null $accountId + * @param int $financialTypeAccountId + * @param int $accountId * - * @internal param int $contributionTypeId * @static */ static function del($financialTypeAccountId, $accountId = null) { @@ -163,7 +158,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * Function to get Financial Account Name + * get Financial Account Name * * @param int $entityId * @@ -230,8 +225,6 @@ WHERE cog.name = 'payment_instrument' "; * @param $financialType * * @return array - * @internal param int $financialTypeId financial type id - * * @static */ static function createDefaultFinancialAccounts($financialType) { diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index c15b9e0594..017c373ac4 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -43,13 +43,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces */ static $_defaultPaymentProcessor = NULL; - /* + /** * Create Payment Processor * - * @params array parameters for Processor entity - */ - /** - * @param $params + * @param array $params parameters for Processor entity * * @return CRM_Financial_DAO_PaymentProcessor * @throws Exception @@ -102,7 +99,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Financial_DAO_PaymentProcessor object on success, null otherwise + * @return CRM_Financial_DAO_PaymentProcessor object on success, null otherwise * @access public * @static */ @@ -153,11 +150,9 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Function to delete payment processor * - * @param $paymentProcessorID + * @param int $paymentProcessorID * * @return null - * @internal param int $paymentProcessorId ID of the processor to be deleted. - * * @access public * @static */ @@ -181,7 +176,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Function to get the payment processor details + * get the payment processor details * * @param int $paymentProcessorID payment processor id * @param string $mode payment mode ie test or live @@ -256,7 +251,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Function to build payment processor details + * build payment processor details * * @param object $dao payment processor object * @param string $mode payment mode ie test or live @@ -364,14 +359,13 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Function to retrieve payment processor id / info/ object based on component-id. + * retrieve payment processor id / info/ object based on component-id. * * @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 + * @return int / array / object based on type * @static * @access public */ diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 055b5f248b..52d371e7ec 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -47,16 +47,12 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_LocaationType object on success, null otherwise + * @return CRM_Core_BAO_LocaationType object on success, null otherwise * @access public * @static */ @@ -105,14 +101,12 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * Function to add the payment-processor type in the db + * add the payment-processor type in the db * * @param array $params (reference ) an assoc array of name/value pairs * * @throws Exception - * @internal param array $ids the array that holds all the db ids - * - * @return object CRM_Financial_DAO_PaymentProcessorType + * @return CRM_Financial_DAO_PaymentProcessorType * @access public * @static */ @@ -176,7 +170,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * Function to delete payment processor + * delete payment processor * * @param int $paymentProcessorTypeId ID of the processor to be deleted. * diff --git a/CRM/Financial/Form/BatchTransaction.php b/CRM/Financial/Form/BatchTransaction.php index 71cd443bcc..40dc4525cc 100644 --- a/CRM/Financial/Form/BatchTransaction.php +++ b/CRM/Financial/Form/BatchTransaction.php @@ -73,7 +73,7 @@ class CRM_Financial_Form_BatchTransaction extends CRM_Contribute_Form { } } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Financial/Form/Export.php b/CRM/Financial/Form/Export.php index 7140992008..e40815db29 100644 --- a/CRM/Financial/Form/Export.php +++ b/CRM/Financial/Form/Export.php @@ -113,7 +113,7 @@ class CRM_Financial_Form_Export extends CRM_Core_Form { } /** - * Build the form + * Build the form object * * @access public * @return void diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index 938107994d..628bee7ae5 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -48,7 +48,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -75,7 +75,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -173,7 +173,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -189,7 +189,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @return void diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index 4b4846c033..f153c5fdcf 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -48,7 +48,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { protected $_id; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -83,7 +83,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -150,7 +150,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -175,12 +175,10 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { /** * global validation rules for the form * - * @param $values + * @param array $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 * @access public @@ -207,7 +205,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @return void @@ -301,8 +299,6 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { * @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 * @access public diff --git a/CRM/Financial/Form/FinancialType.php b/CRM/Financial/Form/FinancialType.php index 2259a7a6cd..d84e369ebe 100644 --- a/CRM/Financial/Form/FinancialType.php +++ b/CRM/Financial/Form/FinancialType.php @@ -41,7 +41,7 @@ class CRM_Financial_Form_FinancialType extends CRM_Contribute_Form { /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -78,7 +78,7 @@ class CRM_Financial_Form_FinancialType extends CRM_Contribute_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @return void diff --git a/CRM/Financial/Form/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index 3caa7da428..ef0545b45e 100644 --- a/CRM/Financial/Form/FinancialTypeAccount.php +++ b/CRM/Financial/Form/FinancialTypeAccount.php @@ -70,7 +70,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { protected $_isARFlag = FALSE; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -121,7 +121,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -305,7 +305,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @return void diff --git a/CRM/Financial/Page/AJAX.php b/CRM/Financial/Page/AJAX.php index 1dc6a32043..7a7399889a 100644 --- a/CRM/Financial/Page/AJAX.php +++ b/CRM/Financial/Page/AJAX.php @@ -39,7 +39,7 @@ */ class CRM_Financial_Page_AJAX { /* - * Function to get financial accounts of required account relationship + * get financial accounts of required account relationship * $financialAccountType array with key account relationship and value financial account type option groups * */ diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index 17e242eba5..26cfe7195a 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -94,8 +94,6 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * browse all entities. * - * @internal param int $action - * * @return void * @access public */ diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 8c0285b542..058ae754b7 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -54,7 +54,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Friend_BAO_Friend object + * @return CRM_Friend_BAO_Friend object * @access public * @static */ @@ -91,7 +91,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ @@ -236,9 +236,9 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Function to build the form + * Build the form object * - * @param object $form form object + * @param CRM_Core_Form $form form object * * @return void * @access public @@ -288,11 +288,8 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { /** * Process that send tell a friend e-mails * - * @params int $contactId contact id - * @params array $values associative array of name/value pair - * - * @param $contactID - * @param $values + * @param int $contactID + * @param array $values * * @return void * @access public @@ -344,7 +341,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Friend_BAO_Friend object + * @return CRM_Friend_BAO_Friend object * @access public * @static */ diff --git a/CRM/Friend/Form.php b/CRM/Friend/Form.php index a465fe6cc0..22d6b6947f 100644 --- a/CRM/Friend/Form.php +++ b/CRM/Friend/Form.php @@ -146,7 +146,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -175,7 +175,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -229,11 +229,9 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Function for validation + * validation * - * @param $fields - * - * @internal param array $params (ref.) an assoc array of name/value pairs + * @param array $fields * * @return mixed true or array of errors * @access public @@ -270,7 +268,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Friend/Form/Contribute.php b/CRM/Friend/Form/Contribute.php index 1dc150ae97..2257127b12 100644 --- a/CRM/Friend/Form/Contribute.php +++ b/CRM/Friend/Form/Contribute.php @@ -51,7 +51,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -87,7 +87,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -105,7 +105,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Friend/Form/Event.php b/CRM/Friend/Form/Event.php index c350050c3c..1ec298b995 100644 --- a/CRM/Friend/Form/Event.php +++ b/CRM/Friend/Form/Event.php @@ -51,7 +51,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -89,7 +89,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -107,7 +107,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index 11d673128c..17e5362bf5 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -49,7 +49,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to get events Summary + * get events Summary * * @static * @@ -89,7 +89,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to get events Summary + * get events Summary * * @static * @@ -111,7 +111,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to retrieve statistics for grants. + * retrieve statistics for grants. * * @static * @@ -124,16 +124,12 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Grant_BAO_ManageGrant object + * @return CRM_Grant_BAO_ManageGrant object * @access public * @static */ @@ -314,10 +310,9 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Function to delete the Contact * - * @param $id + * @param int $id contact id * * @return bool - * @internal param int $cid contact id * * @access public * @static @@ -420,9 +415,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Function to get grant record count for a Contact * - * @param $contactID - * - * @internal param int $contactId Contact ID + * @param int $contactID * * @return int count of grant records * @access public diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index 7a9aa36d12..9c960b2ed1 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -357,7 +357,7 @@ class CRM_Grant_BAO_Query { * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void * @static diff --git a/CRM/Grant/Form/Grant.php b/CRM/Grant/Form/Grant.php index 8c6e9c0bab..a32dbadfe5 100644 --- a/CRM/Grant/Form/Grant.php +++ b/CRM/Grant/Form/Grant.php @@ -58,7 +58,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { protected $_context; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -170,7 +170,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -259,7 +259,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Grant/Form/GrantView.php b/CRM/Grant/Form/GrantView.php index 1b0fc3b797..83264294d1 100644 --- a/CRM/Grant/Form/GrantView.php +++ b/CRM/Grant/Form/GrantView.php @@ -40,7 +40,7 @@ class CRM_Grant_Form_GrantView extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -122,7 +122,7 @@ class CRM_Grant_Form_GrantView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Grant/Form/Search.php b/CRM/Grant/Form/Search.php index 9be73990f1..916d558171 100644 --- a/CRM/Grant/Form/Search.php +++ b/CRM/Grant/Form/Search.php @@ -161,7 +161,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php index cf89402c08..9d05b50835 100644 --- a/CRM/Grant/Form/Task.php +++ b/CRM/Grant/Form/Task.php @@ -79,7 +79,7 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -152,8 +152,6 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { * @param string $nextType * @param string $backType * - * @internal param string $type button type for the form after processing - * * @return void * @access public */ diff --git a/CRM/Grant/Form/Task/Delete.php b/CRM/Grant/Form/Task/Delete.php index 61152876a4..d3a4ad78d5 100644 --- a/CRM/Grant/Form/Task/Delete.php +++ b/CRM/Grant/Form/Task/Delete.php @@ -63,7 +63,7 @@ class CRM_Grant_Form_Task_Delete extends CRM_Grant_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Grant/Form/Task/Print.php b/CRM/Grant/Form/Task/Print.php index 231ea12a7d..75783e00db 100644 --- a/CRM/Grant/Form/Task/Print.php +++ b/CRM/Grant/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Grant_Form_Task_Print extends CRM_Grant_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Grant/Form/Task/Result.php b/CRM/Grant/Form/Task/Result.php index 140aedc2d2..b9b331e6f3 100644 --- a/CRM/Grant/Form/Task/Result.php +++ b/CRM/Grant/Form/Task/Result.php @@ -66,7 +66,7 @@ class CRM_Grant_Form_Task_Result extends CRM_Grant_Form_Task { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Grant/Form/Task/SearchTaskHookSample.php b/CRM/Grant/Form/Task/SearchTaskHookSample.php index 6b9501b133..556fd2da3e 100644 --- a/CRM/Grant/Form/Task/SearchTaskHookSample.php +++ b/CRM/Grant/Form/Task/SearchTaskHookSample.php @@ -73,7 +73,7 @@ INNER JOIN civicrm_contact ct ON ( grt.contact_id = ct.id ) } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Grant/Form/Task/Update.php b/CRM/Grant/Form/Task/Update.php index 394d0f328f..1bc0ccaa6d 100644 --- a/CRM/Grant/Form/Task/Update.php +++ b/CRM/Grant/Form/Task/Update.php @@ -56,7 +56,7 @@ class CRM_Grant_Form_Task_Update extends CRM_Grant_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index d481ac9483..9b9e678e16 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -174,7 +174,6 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co $this->_query->_distinctComponentClause = " civicrm_grant.id"; $this->_query->_groupByComponentClause = " GROUP BY civicrm_grant.id "; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -226,9 +225,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -244,7 +242,6 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -333,7 +330,6 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * * @return array $qill which contains an array of strings * @access public */ @@ -427,5 +423,4 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co return ts('CiviCRM Grant Search'); } } -//end of class diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php index 32b3dd1284..43a8069947 100644 --- a/CRM/Group/Form/Edit.php +++ b/CRM/Group/Form/Edit.php @@ -158,14 +158,11 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, 1, 'Group', $this->_id); } - /* - * This function sets the default values for the form. LocationType that in edit/view mode + /** + * Set default values for the form. LocationType that in edit/view mode * the default values are retrieved from the database * * @access public - * @return void - */ - /** * @return array */ function setDefaultValues() { @@ -212,7 +209,7 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -314,7 +311,6 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { * global validation rules for the form * * @param array $fields posted values of the form - * * @param $fileParams * @param $options * @@ -412,10 +408,7 @@ WHERE title = %1 $group = CRM_Contact_BAO_Group::create($params); - /* - * Remove any parent groups requested to be removed - */ - + //Remove any parent groups requested to be removed if (!empty($this->_groupValues['parents'])) { $parentGroupIds = explode(',', $this->_groupValues['parents']); foreach ($parentGroupIds as $parentGroupId) { @@ -428,10 +421,7 @@ WHERE title = %1 CRM_Core_Session::setStatus(ts('The Group \'%1\' has been saved.', array(1 => $group->title)), ts('Group Saved'), 'success'); - /* - * Add context to the session, in case we are adding members to the group - */ - + // Add context to the session, in case we are adding members to the group if ($this->_action & CRM_Core_Action::ADD) { $this->set('context', 'amtg'); $this->set('amtgID', $group->id); @@ -447,43 +437,34 @@ WHERE title = %1 } } - /* + /** * Build parent groups form elements * - * @obj form object passed by reference + * @param CRM_Core_Form $form * - * @return parent groups array + * @return array parent groups * @static * @access public */ - /** - * @param $obj - * - * @return array - */ - static function buildParentGroups( &$obj ) { + static function buildParentGroups(&$form) { $groupNames = CRM_Core_PseudoConstant::group(); $parentGroups = $parentGroupElements = array(); - if (isset($obj->_id) && - CRM_Utils_Array::value('parents', $obj->_groupValues) - ) { - $parentGroupIds = explode(',', $obj->_groupValues['parents']); + if (isset($form->_id) && !empty($form->_groupValues['parents'])) { + $parentGroupIds = explode(',', $form->_groupValues['parents']); foreach ($parentGroupIds as $parentGroupId) { $parentGroups[$parentGroupId] = $groupNames[$parentGroupId]; if (array_key_exists($parentGroupId, $groupNames)) { $parentGroupElements[$parentGroupId] = $groupNames[$parentGroupId]; - $obj->addElement('checkbox', "remove_parent_group_$parentGroupId", + $form->addElement('checkbox', "remove_parent_group_$parentGroupId", $groupNames[$parentGroupId] ); } } } - $obj->assign_by_ref('parent_groups', $parentGroupElements); + $form->assign_by_ref('parent_groups', $parentGroupElements); - if (isset($obj->_id)) { - $potentialParentGroupIds = CRM_Contact_BAO_GroupNestingCache::getPotentialCandidates($obj->_id, - $groupNames - ); + if (isset($form->_id)) { + $potentialParentGroupIds = CRM_Contact_BAO_GroupNestingCache::getPotentialCandidates($form->_id, $groupNames); } else { $potentialParentGroupIds = array_keys($groupNames); @@ -498,12 +479,12 @@ WHERE title = %1 if (count($parentGroupSelectValues) > 1) { if (CRM_Core_Permission::isMultisiteEnabled()) { - $required = !isset($obj->_id) || ($obj->_id && CRM_Core_BAO_Domain::isDomainGroup($obj->_id)) ? FALSE : empty($parentGroups); + $required = !isset($form->_id) || ($form->_id && CRM_Core_BAO_Domain::isDomainGroup($form->_id)) ? FALSE : empty($parentGroups); } else { $required = FALSE; } - $obj->add('select', 'parents', ts('Add Parent'), $parentGroupSelectValues, $required, array('class' => 'crm-select2')); + $form->add('select', 'parents', ts('Add Parent'), $parentGroupSelectValues, $required, array('class' => 'crm-select2')); } return $parentGroups; diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index c0d6ef5ae7..dd491577ab 100644 --- a/CRM/Group/Page/Group.php +++ b/CRM/Group/Page/Group.php @@ -43,7 +43,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Function to define action links + * define action links * * @return array self::$_links array of action links * @access public @@ -108,9 +108,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { * make sure that the user has permission to access this group * * @param int $id the id of the object - * @param int $title - * - * @internal param int $name the name or title of the object + * @param int $title name or title of the object * * @return string the permission that the user has (or null) * @access public diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 14cdb9f890..2722a11307 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -50,7 +50,7 @@ abstract class CRM_Import_DataSource { abstract public function getInfo(); /** - * Function to set variables up before form is built + * set variables up before form is built * * @access public */ @@ -61,7 +61,7 @@ abstract class CRM_Import_DataSource { * form snippet. It should add all fields necesarry to get the data * uploaded to the temporary table in the DB. * - * @param $form + * @param CRM_Core_Form $form * * @return void (operates directly on form argument) * @access public @@ -69,7 +69,7 @@ abstract class CRM_Import_DataSource { abstract public function buildQuickForm(&$form); /** - * Function to process the form + * Process the form submission * * @access public */ diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 60e90b77d9..0670fc8b67 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -49,7 +49,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * Function to set variables up before form is built + * set variables up before form is built * * @access public */ @@ -60,7 +60,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { * form snippet. It should add all fields necesarry to get the data * uploaded to the temporary table in the DB. * - * @param $form + * @param CRM_Core_Form $form * * @return void (operates directly on form argument) * @access public @@ -83,7 +83,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * Function to process the form + * Process the form submission * * @access public */ diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php index 435a2c1384..1f17917189 100644 --- a/CRM/Import/DataSource/SQL.php +++ b/CRM/Import/DataSource/SQL.php @@ -47,7 +47,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { } /** - * Function to set variables up before form is built + * set variables up before form is built * * @access public */ @@ -58,7 +58,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { * form snippet. It should add all fields necesarry to get the data * uploaded to the temporary table in the DB. * - * @param $form + * @param CRM_Core_Form $form * * @return void (operates directly on form argument) * @access public @@ -72,7 +72,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { /** * @param $fields * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array|bool */ @@ -91,7 +91,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { } /** - * Function to process the form + * Process the form submission * * @access public */ diff --git a/CRM/Import/Form/Preview.php b/CRM/Import/Form/Preview.php index 0802a3f776..69a1fb4d58 100644 --- a/CRM/Import/Form/Preview.php +++ b/CRM/Import/Form/Preview.php @@ -50,7 +50,7 @@ abstract class CRM_Import_Form_Preview extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Import/Form/Summary.php b/CRM/Import/Form/Summary.php index bab196d210..19c14466a8 100644 --- a/CRM/Import/Form/Summary.php +++ b/CRM/Import/Form/Summary.php @@ -41,7 +41,7 @@ abstract class CRM_Import_Form_Summary extends CRM_Core_Form { /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Import/StateMachine.php b/CRM/Import/StateMachine.php index df539b4e78..95ed72a0c0 100644 --- a/CRM/Import/StateMachine.php +++ b/CRM/Import/StateMachine.php @@ -44,7 +44,6 @@ class CRM_Import_StateMachine extends CRM_Core_StateMachine { * @param object $controller * @param \const|int $action * - * @internal param \CRM_ $object *_Import_Controller */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Logging/Differ.php b/CRM/Logging/Differ.php index 7578821d2c..ced2440823 100644 --- a/CRM/Logging/Differ.php +++ b/CRM/Logging/Differ.php @@ -323,7 +323,7 @@ WHERE lt.log_conn_id = %1 AND /** * @param $sql - * @param $params + * @param array $params * * @return mixed */ diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index 55dd8b35fb..ca4f1019e8 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -42,16 +42,12 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_LocaationType object + * @return CRM_Core_BAO_LocaationType object * @access public * @static */ @@ -84,7 +80,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids (deprecated) the array that holds all the db ids * - * @return object CRM_Mailing_BAO_Component object + * @return CRM_Mailing_BAO_Component object * * @access public * @static diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 595f52967d..8fb997358a 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -915,9 +915,7 @@ ORDER BY i.contact_id, i.{$tempColumn} /** * Generate an event queue for a test job * - * @params array $params contains form values - * - * @param $testParams + * @param array $testParams contains form values * * @return void * @access public @@ -1507,7 +1505,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * function to add the mailings + * add the mailings * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -1557,7 +1555,7 @@ ORDER BY civicrm_email.is_bulkmail DESC * * @params array $params Form values * - * @param $params + * @param array $params * @param array $ids * * @return object $mailing The new mailing object @@ -2400,7 +2398,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Function to show detail Mailing report + * show detail Mailing report * * @param int $id * @@ -2498,9 +2496,9 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Function to build the compose mail form + * build the compose mail form * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -2593,7 +2591,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id /** * Function to build the compose PDF letter form * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -2759,7 +2757,6 @@ WHERE civicrm_mailing_job.id = %1 */ static function processQueue($mode = NULL) { $config = &CRM_Core_Config::singleton(); - // CRM_Core_Error::debug_log_message("Beginning processQueue run: {$config->mailerJobsMax}, {$config->mailerJobSize}"); if ($mode == NULL && CRM_Core_BAO_MailSettings::defaultDomain() == "EXAMPLE.ORG") { throw new CRM_Core_Exception(ts('The default mailbox has not been configured. You will find more info in the online user and administrator guide', array(1 => CRM_Utils_System::url('civicrm/admin/mailSettings', 'reset=1'), 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/"))); @@ -2806,7 +2803,6 @@ WHERE civicrm_mailing_job.id = %1 $cronLock->release(); } - // CRM_Core_Error::debug_log_message('Ending processQueue run'); return TRUE; } diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 22524f7152..8d04107830 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -49,7 +49,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } /** - * @param $params + * @param array $params * * @return CRM_Mailing_BAO_MailingJob */ diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 57c94d7a3f..97ea5004b3 100644 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -126,8 +126,6 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * * @param $mailingIDs * - * @internal param int $contactID ID of the mailing - * * @return array Opened count per mailing ID * @access public * @static diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index ccc2083452..7e9f98f0b5 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -299,7 +299,7 @@ SELECT DISTINCT(civicrm_mailing_event_queue.contact_id) as contact_id, } /** - * @param $params + * @param array $params * @param null $now */ static function bulkCreate($params, $now = NULL) { diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index 1f71d0a858..ff95059a92 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -54,11 +54,10 @@ class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe { * * @param int $group_id The group id to subscribe to * @param string $email The email address of the (new) contact - * @param null $contactId - * @param null $context - * @params int $contactId Currently used during event registration/contribution. - * Specifically to avoid linking group to wrong duplicate contact - * during event registration. + * @param int $contactId Currently used during event registration/contribution. + * Specifically to avoid linking group to wrong duplicate contact + * during event registration. + * @param string $context * * @return int|null $se_id The id of the subscription event, null on failure * @access public @@ -360,20 +359,14 @@ SELECT civicrm_email.id as email_id } /** - * Function to send subscribe mail + * send subscribe mail * - * @params array $groups the list of group ids for subscribe - * @params array $params the list of email - * @params int $contactId Currently used during event registration/contribution. - * Specifically to avoid linking group to wrong duplicate contact - * during event registration. - * - * @public - * - * @param $groups - * @param $params - * @param null $contactId - * @param null $context + * @param array $groups the list of group ids for subscribe + * @param array $params the list of email + * @param int $contactId Currently used during event registration/contribution. + * Specifically to avoid linking group to wrong duplicate contact + * during event registration. + * @param string $context * * @return void * @static @@ -401,8 +394,7 @@ SELECT civicrm_email.id as email_id $success = TRUE; $groupAdded[] = $title; - /* Ask the contact for confirmation */ - + // Ask the contact for confirmation $se->send_confirm_request($params['email']); } else { @@ -419,6 +411,5 @@ SELECT civicrm_email.id as email_id CRM_Utils_System::setUFMessage(ts('We had a problem processing your subscription request for %1. You have tried to subscribe to a private group and/or we encountered a database error. Please contact the site administrator.', array(1 => $groupTitle))); } } - //end of function } diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index 3cc24d70cb..774defeb8a 100644 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -157,8 +157,6 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * * @param $mailingIDs * - * @internal param int $contactID ID of the mailing - * * @return array trackable url count per mailing ID * @access public * @static diff --git a/CRM/Mailing/Form/Approve.php b/CRM/Mailing/Form/Approve.php index 0ffb8bc041..c47560999b 100644 --- a/CRM/Mailing/Form/Approve.php +++ b/CRM/Mailing/Form/Approve.php @@ -44,7 +44,7 @@ class CRM_Mailing_Form_Approve extends CRM_Core_Form { } /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -82,7 +82,7 @@ class CRM_Mailing_Form_Approve extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -99,7 +99,7 @@ class CRM_Mailing_Form_Approve extends CRM_Core_Form { } /** - * Build the form for the approval/rejection mailing + * Build the form object for the approval/rejection mailing * * @param * diff --git a/CRM/Mailing/Form/Browse.php b/CRM/Mailing/Form/Browse.php index fe2e552070..0cb9ebc80e 100644 --- a/CRM/Mailing/Form/Browse.php +++ b/CRM/Mailing/Form/Browse.php @@ -35,7 +35,7 @@ */ /** - * Build the form for disable mail feature + * Build the form object for disable mail feature * * @param * @@ -71,7 +71,7 @@ class CRM_Mailing_Form_Browse extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -93,7 +93,6 @@ class CRM_Mailing_Form_Browse extends CRM_Core_Form { } /** - * * @access public * * @return void @@ -110,6 +109,5 @@ class CRM_Mailing_Form_Browse extends CRM_Core_Form { CRM_Core_DAO::setFieldValue('CRM_Mailing_DAO_Mailing', $this->_mailingId, 'is_archived', TRUE); } } - //end of function } diff --git a/CRM/Mailing/Form/Component.php b/CRM/Mailing/Form/Component.php index f6ca5a05cc..2ed18fe415 100644 --- a/CRM/Mailing/Form/Component.php +++ b/CRM/Mailing/Form/Component.php @@ -59,7 +59,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -106,7 +106,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -127,7 +127,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * @@ -148,10 +148,9 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { ), ts('Saved'), 'success'); } - //end of function /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Mailing/Form/ForwardMailing.php b/CRM/Mailing/Form/ForwardMailing.php index 7d9f372348..6d52351413 100644 --- a/CRM/Mailing/Form/ForwardMailing.php +++ b/CRM/Mailing/Form/ForwardMailing.php @@ -71,7 +71,7 @@ class CRM_Mailing_Form_ForwardMailing extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Mailing/Form/Group.php b/CRM/Mailing/Form/Group.php index 2d22e0d848..415c73f19f 100644 --- a/CRM/Mailing/Form/Group.php +++ b/CRM/Mailing/Form/Group.php @@ -47,7 +47,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { protected $_mailingID; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -89,7 +89,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -182,7 +182,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Mailing/Form/Schedule.php b/CRM/Mailing/Form/Schedule.php index 11a5f4658c..e70dca722e 100644 --- a/CRM/Mailing/Form/Schedule.php +++ b/CRM/Mailing/Form/Schedule.php @@ -39,7 +39,7 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -69,7 +69,7 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { } } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -89,7 +89,7 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { } /** - * Build the form for the last step of the mailing wizard + * Build the form object for the last step of the mailing wizard * * @param * diff --git a/CRM/Mailing/Form/Settings.php b/CRM/Mailing/Form/Settings.php index 6bb0250959..82b5bd73bb 100644 --- a/CRM/Mailing/Form/Settings.php +++ b/CRM/Mailing/Form/Settings.php @@ -39,7 +39,7 @@ class CRM_Mailing_Form_Settings extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -57,7 +57,7 @@ class CRM_Mailing_Form_Settings extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -101,7 +101,7 @@ class CRM_Mailing_Form_Settings extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Mailing/Form/Subscribe.php b/CRM/Mailing/Form/Subscribe.php index 41fa7436ee..2f662050ea 100644 --- a/CRM/Mailing/Form/Subscribe.php +++ b/CRM/Mailing/Form/Subscribe.php @@ -78,7 +78,7 @@ SELECT title, description } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -188,7 +188,6 @@ ORDER BY title"; } /** - * * @access public * * @return void diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php index 2b45794272..f63ac9dcfe 100644 --- a/CRM/Mailing/Form/Task.php +++ b/CRM/Mailing/Form/Task.php @@ -73,7 +73,7 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -142,7 +142,6 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { * @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/Mailing/Form/Task/Print.php b/CRM/Mailing/Form/Task/Print.php index 6d513629c5..8a7ddfaaf2 100644 --- a/CRM/Mailing/Form/Task/Print.php +++ b/CRM/Mailing/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Mailing_Form_Task_Print extends CRM_Mailing_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index 8ef9fcbf71..944d6057fa 100644 --- a/CRM/Mailing/Form/Test.php +++ b/CRM/Mailing/Form/Test.php @@ -39,7 +39,7 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -57,7 +57,7 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -172,11 +172,10 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { /** * Form rule to send out a test mailing. * - * @param $testParams + * @param aray $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/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index 6e780c1b14..8f03b9c0d4 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -57,7 +57,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -201,7 +201,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -501,7 +501,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Mailing/Page/AJAX.php b/CRM/Mailing/Page/AJAX.php index 44b45a30dd..e4416dbeae 100644 --- a/CRM/Mailing/Page/AJAX.php +++ b/CRM/Mailing/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Mailing_Page_AJAX { /** - * Function to fetch the template text/html messages + * fetch the template text/html messages */ public static function template() { $templateId = CRM_Utils_Type::escape($_POST['tid'], 'Integer'); @@ -60,7 +60,7 @@ class CRM_Mailing_Page_AJAX { } /** - * Function to retrieve contact mailings + * retrieve contact mailings */ public static function getContactMailings() { $contactID = CRM_Utils_Type::escape($_GET['contact_id'], 'Integer'); diff --git a/CRM/Mailing/Page/Browse.php b/CRM/Mailing/Page/Browse.php index 1ab348fe38..0c6d2f908f 100644 --- a/CRM/Mailing/Page/Browse.php +++ b/CRM/Mailing/Page/Browse.php @@ -312,7 +312,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { } /** - * @param $params + * @param array $params * @param bool $sortBy * * @return string diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index bf9225cab0..a55777fd6d 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -59,14 +59,12 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ /** * Class constructor * - * @internal param $ * * @return \CRM_Mailing_Selector_Browse @access public */ function __construct() { } - //end of constructor /** * This method returns the links that are given for each search row. @@ -78,15 +76,13 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ static function &links() { return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -96,7 +92,6 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * returns the column headers as an array of tuples: @@ -438,7 +433,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } /** - * @param $params + * @param array $params * @param bool $sortBy * * @return int|string @@ -605,5 +600,4 @@ ORDER BY LEFT(name, 1) $this->_parent->assign('aToZ', $aToZBar); } } -//end of class diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index 91036a8df7..f4f94b65d0 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -100,7 +100,6 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C $this->_job_id = $job; $this->_url_id = $url; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -112,15 +111,13 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C static function &links() { return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -130,7 +127,6 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * returns the column headers as an array of tuples: @@ -458,5 +454,4 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C return $this->eventToTitle(); } } -//end of class diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index a3e9049640..5c3354e3f7 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -183,7 +183,6 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ $this->_query->_distinctComponentClause = " civicrm_mailing_recipients.id "; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -225,15 +224,13 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -249,7 +246,6 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -332,7 +328,6 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * * @return array $qill which contains an array of strings * @access public */ diff --git a/CRM/Mailing/StateMachine/Send.php b/CRM/Mailing/StateMachine/Send.php index ad400433de..84f42f2e76 100644 --- a/CRM/Mailing/StateMachine/Send.php +++ b/CRM/Mailing/StateMachine/Send.php @@ -42,10 +42,9 @@ class CRM_Mailing_StateMachine_Send extends CRM_Core_StateMachine { /** * class constructor * - * @param object $controller + * @param CRM_Mailing_Controller $controller * @param \const|int $action * - * @internal param \CRM_Mailing_Controller $object * @return \CRM_Mailing_StateMachine_Send CRM_Mailing_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index a82d962bef..4ec103ed98 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -69,7 +69,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * @param array $params (reference ) an assoc array of name/value pairs * @param array $ids the array that holds all the db ids * - * @return object CRM_Member_BAO_Membership object + * @return CRM_Member_BAO_Membership object * @access public * @static */ @@ -230,7 +230,6 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * @param string $activityType * * @throws CRM_Core_Exception - * @internal param bool $callFromAPI Is this function called from API? * * @return CRM_Member_BAO_Membership object * @access public @@ -431,7 +430,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { } /** - * Function to check the membership extended through relationship + * check the membership extended through relationship * * @param int $membershipId membership id * @param int $contactId contact id @@ -504,9 +503,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * @param array $defaults (reference ) an assoc array to hold the name / value pairs * in a hierarchical manner * - * @internal param array $ids (reference) the array that holds all the db ids - * - * @return object CRM_Member_BAO_Membership object + * @return CRM_Member_BAO_Membership object * @access public * @static */ @@ -538,7 +535,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { /** * - * Function to get membership status and membership type values + * get membership status and membership type values * * @param int $membershipId membership id of values to return * @@ -574,7 +571,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to delete membership. + * delete membership. * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent. * * @param int $membershipId membership id that needs to be deleted @@ -591,7 +588,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to delete membership. + * delete membership. * * @param int $membershipId membership id that needs to be deleted * @@ -717,18 +714,15 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Function to build Membership Block in Contribution Pages * - * @param object $form form object - * @param $pageID - * @param $cid + * @param CRM_Core_Form $form form object + * @param int $pageID - unused? + * @param int $cid - contact checked for having a current membership for a particular membership * @param boolean $formItems * @param int $selectedMembershipTypeID selected membership id * @param boolean $thankPage thank you page * @param null $isTest * * @return bool Is this a separate membership payment - * @internal param int $pageId contribution page id - * @internal param bool $memContactId contact who is to be - * checked for having a current membership for a particular membership * * @static */ @@ -919,10 +913,9 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Function to return Membership Block info in Contribution Pages * - * @param $pageID + * @param int $pageID contribution page id * * @return array|null - * @internal param int $pageId contribution page id * * @static */ @@ -957,16 +950,15 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Function to return a current membership of given contact - * NB: if more than one membership meets criteria, a randomly selected one is returned. + * NB: if more than one membership meets criteria, a randomly selected one is returned. * * @param int $contactID contact id * @param int $memType membership type, null to retrieve all types * @param int $isTest - * @param null $membershipId + * @param int $membershipId if provided, then determine if it is current * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise * * @return array|bool - * @internal param int $membershipID if provided, then determine if it is current * @static */ static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) { @@ -1473,17 +1465,14 @@ AND civicrm_membership.is_test = %2"; * @param int $contactID id of the contact * @param int $membershipTypeID id of the new membership type * @param boolean $is_test if this is test contribution or live contribution - * @param object $form form object + * @param CRM_Core_Form $form form object * @param null $changeToday * @param int $modifiedID individual contact id in case of On Behalf signup (CRM-4027 ) * @param null $customFieldsFormatted * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) - * * @param integer $membershipID Membership ID, this should always be passed in & optionality should be removed * * @throws CRM_Core_Exception - * @internal param array $ipnParams array of name value pairs, to be used (for e.g source) when $form not present - * @return CRM_Member_DAO_Membership $membership object of membership * * @static * @access public @@ -1717,12 +1706,10 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id * function to create memberships for related contacts * takes into account the maximum related memberships * - * @param array $params array of key - value pairs - * @param $dao - * - * @internal param object $membership membership object + * @param array $params array of key - value pairs + * @param CRM_Core_DAO $dao membership object * - * @return null|relatedMembership array of memberships if created + * @return null|array array of memberships if created * @static * @access public */ @@ -1907,7 +1894,7 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id } /** - * @param $form + * @param CRM_Core_Form $form * @param null $membershipTypeID * * @return array @@ -1962,11 +1949,10 @@ FROM civicrm_membership_type /** * Function to get membership record count for a Contact * - * @param $contactID + * @param int $contactID * @param boolean $activeOnly * - * @internal param int $contactId Contact ID - * @return int count of membership records + * @return null|string * @access public * @static */ @@ -2144,14 +2130,12 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * @param CRM_Contribute_Form_Contribution_Confirm $form * @param $tempParams * @param $isTest - * * @param $lineItems * @param $minimumFee * @param $financialTypeID * * @throws CRM_Core_Exception * @throws Exception - * @internal param $membershipDetails * @return CRM_Contribute_BAO_Contribution */ public static function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee, $financialTypeID) { @@ -2239,9 +2223,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * @param $isTest * @param $numTerms * @param $membershipContribution - * @param $form - * - * @internal param $createdMemberships + * @param CRM_Core_Form $form * * @return array */ @@ -2267,7 +2249,6 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * * @param array $errors * - * @internal param $message * * @return string */ @@ -2283,7 +2264,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND /** * Extract relevant values from the form so we can separate form logic from BAO logcis - * @param $form + * @param CRM_Core_Form $form * @param $changeToday * @param $membershipTypeDetails * @@ -2799,7 +2780,6 @@ WHERE civicrm_membership.is_test = 0"; $updateCount++; } } - // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) ); } $result['is_error'] = 0; $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(1 => $processCount, 2 => $updateCount)); @@ -2815,9 +2795,7 @@ WHERE civicrm_membership.is_test = 0"; * @param bool $onlyLifeTime * * @return array - * @internal param array $contactMembershipType array of allMembershipTypes Key - value pairs */ - static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) { $contactMembershipType = array(); if (!$contactID) { @@ -2927,13 +2905,10 @@ WHERE civicrm_membership.is_test = 0"; /** * Function to record line items for default membership * - * @param $qf object - * - * @param $membershipType array with membership type and organization - * - * @param $priceSetId + * @param CRM_Core_Form $qf + * @param array $membershipType array with membership type and organization + * @param int $priceSetId * - * @internal param $ $ priceSetId priceset id * @access public * @static */ diff --git a/CRM/Member/BAO/MembershipBlock.php b/CRM/Member/BAO/MembershipBlock.php index 3e4dfaed44..70a584a239 100644 --- a/CRM/Member/BAO/MembershipBlock.php +++ b/CRM/Member/BAO/MembershipBlock.php @@ -40,7 +40,7 @@ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { parent::__construct(); } /** - * function to add the membership Blocks + * add the membership Blocks * * @param array $params reference array contains the values submitted by the form * @@ -61,7 +61,7 @@ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { } /** - * Function to delete membership Blocks + * delete membership Blocks * * @param int $id * diff --git a/CRM/Member/BAO/MembershipLog.php b/CRM/Member/BAO/MembershipLog.php index 1502c065c1..1ec59f9baa 100644 --- a/CRM/Member/BAO/MembershipLog.php +++ b/CRM/Member/BAO/MembershipLog.php @@ -35,7 +35,7 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { /** - * function to add the membership log record + * add the membership log record * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -56,12 +56,11 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { } /** - * Function to delete membership log record + * delete membership log record * - * @param $membershipID + * @param int $membershipID * * @return mixed - * @internal param int $membershipTypeId * @static */ diff --git a/CRM/Member/BAO/MembershipPayment.php b/CRM/Member/BAO/MembershipPayment.php index 373db3e2cd..0f0766ca0e 100644 --- a/CRM/Member/BAO/MembershipPayment.php +++ b/CRM/Member/BAO/MembershipPayment.php @@ -42,7 +42,7 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment parent::__construct(); } /** - * function to add the membership Payments + * add the membership Payments * * @param array $params reference array contains the values submitted by the form * @@ -78,7 +78,7 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment } /** - * Function to delete membership Payments + * delete membership Payments * * @param int $id * diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index e0f424299b..4c02bdcb63 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -47,16 +47,12 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Member_BAO_MembershipStatus object + * @return CRM_Member_BAO_MembershipStatus object * @access public * @static */ @@ -90,7 +86,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * @param array $params (reference ) an assoc array of name/value pairs * * @throws Exception - * @return object CRM_Member_BAO_MembershipStatus object + * @return CRM_Member_BAO_MembershipStatus object * @access public * @static */ @@ -111,7 +107,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { return $membershipStatusBAO; } /** - * function to add the membership types + * add the membership types * * @param array $params reference array contains the values submitted by the form * @param array $ids array contains the id - this param is deprecated @@ -169,7 +165,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Function to get membership status + * get membership status * * @param int $membershipStatusId * @@ -187,12 +183,11 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Function to delete membership Types + * delete membership Types * * @param int $membershipStatusId * * @throws CRM_Core_Exception - * @internal param $ * @static */ static function del($membershipStatusId) { @@ -225,10 +220,9 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * @param string $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 $membershipTypeID + * @param int $membershipTypeID * @param array $membership membership params as available to calling function - passed to the hook * - * @internal param int $membershipType membership type id - passed to the hook * @return array @static */ diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index ef448155c3..e3c492cb9b 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -49,16 +49,12 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Member_BAO_MembershipType object + * @return CRM_Member_BAO_MembershipType object * @access public * @static */ @@ -86,7 +82,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * function to add the membership types + * add the membership types * * @param array $params reference array contains the values submitted by the form * @param array $ids array contains the id (deprecated) @@ -135,7 +131,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to delete membership Types + * delete membership Types * * @param int $membershipTypeId * @@ -192,7 +188,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to convert membership Type's 'start day' & 'rollover day' to human readable formats. + * convert membership Type's 'start day' & 'rollover day' to human readable formats. * * @param array $membershipType an array of membershipType-details. * @static @@ -238,7 +234,6 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * @param bool $public * * @return array - * @internal param int $membershipTypeId * @static */ static function getMembershipTypes($public = TRUE) { @@ -613,11 +608,9 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * The function returns all the Organization for all membershiptypes . * - * @param null $membershipTypeId + * @param int $membershipTypeId * * @return array - * @internal param array $allmembershipTypes array of allMembershipTypes - * with organization id Key - value pairs. */ static function getMembershipTypeOrganization($membershipTypeId = NULL) { $allmembershipTypes = array(); @@ -664,7 +657,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** - * @param $params + * @param array $params * @param $previousID * @param $membershipTypeId */ diff --git a/CRM/Member/BAO/Query.php b/CRM/Member/BAO/Query.php index b15aec999a..52689ebe2e 100644 --- a/CRM/Member/BAO/Query.php +++ b/CRM/Member/BAO/Query.php @@ -433,7 +433,7 @@ class CRM_Member_BAO_Query { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildSearchForm(&$form) { foreach (CRM_Member_PseudoConstant::membershipType() as $id => $Name) { diff --git a/CRM/Member/Form.php b/CRM/Member/Form.php index 6233cf049d..dbcb6f3290 100644 --- a/CRM/Member/Form.php +++ b/CRM/Member/Form.php @@ -81,7 +81,7 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -118,7 +118,7 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -182,7 +182,7 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { } /** - * Function to extract values from the contact create boxes on the form and assign appropriately to + * extract values from the contact create boxes on the form and assign appropriately to * * - $this->_contributorEmail, * - $this->_memberEmail & diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index f52a15dcc5..f7b7d150c6 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -207,7 +207,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -362,7 +362,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -732,7 +732,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -973,7 +973,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Function to process the form + * Process the form submission * * @access public * @@ -1693,13 +1693,12 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Function to send email receipt + * send email receipt * - * @param object $form form object - * @param $formValues + * @param CRM_Core_Form $form form object + * @param array $formValues * @param object $membership object * - * @internal param array $values submitted values * @return boolean true if mail was sent successfully * @static */ diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index 71b0e4982a..a4119601a5 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -44,7 +44,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa protected $_memPriceSetId = NULL; /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -105,7 +105,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -210,7 +210,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Member/Form/MembershipConfig.php b/CRM/Member/Form/MembershipConfig.php index 3f5f107561..278068c878 100644 --- a/CRM/Member/Form/MembershipConfig.php +++ b/CRM/Member/Form/MembershipConfig.php @@ -59,7 +59,7 @@ class CRM_Member_Form_MembershipConfig extends CRM_Core_Form { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -98,7 +98,7 @@ class CRM_Member_Form_MembershipConfig extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php index 48e96187a2..dc71acaf50 100644 --- a/CRM/Member/Form/MembershipRenewal.php +++ b/CRM/Member/Form/MembershipRenewal.php @@ -134,7 +134,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -244,7 +244,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -452,7 +452,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -486,7 +486,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Function to process the renewal form + * process the renewal form * * @access public * diff --git a/CRM/Member/Form/MembershipStatus.php b/CRM/Member/Form/MembershipStatus.php index 56ef913072..e63ece269a 100644 --- a/CRM/Member/Form/MembershipStatus.php +++ b/CRM/Member/Form/MembershipStatus.php @@ -40,7 +40,7 @@ class CRM_Member_Form_MembershipStatus extends CRM_Member_Form_MembershipConfig { /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -58,7 +58,7 @@ class CRM_Member_Form_MembershipStatus extends CRM_Member_Form_MembershipConfig } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -107,7 +107,7 @@ class CRM_Member_Form_MembershipStatus extends CRM_Member_Form_MembershipConfig } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php index 7380b15d2d..b9f2f1ea1e 100644 --- a/CRM/Member/Form/MembershipType.php +++ b/CRM/Member/Form/MembershipType.php @@ -58,7 +58,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * This function sets the default values for the form. MobileProvider that in edit/view mode + * Set default values for the form. MobileProvider that in edit/view mode * the default values are retrieved from the database * * @access public @@ -108,7 +108,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -212,7 +212,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -289,7 +289,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index 38aa3b744f..971a870b0b 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -139,7 +139,7 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { } /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -390,7 +390,7 @@ SELECT r.id, c.id as cid, c.display_name as name, c.job_title as comment, } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Form/Search.php b/CRM/Member/Form/Search.php index e7ad0667bc..94d0bc118b 100644 --- a/CRM/Member/Form/Search.php +++ b/CRM/Member/Form/Search.php @@ -158,7 +158,7 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php index b447dc8cf6..f4eae47d7c 100644 --- a/CRM/Member/Form/Task.php +++ b/CRM/Member/Form/Task.php @@ -87,7 +87,7 @@ class CRM_Member_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -171,8 +171,6 @@ class CRM_Member_Form_Task extends CRM_Core_Form { * @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/Form/Task/Batch.php b/CRM/Member/Form/Task/Batch.php index 349400c242..63d359a9b9 100644 --- a/CRM/Member/Form/Task/Batch.php +++ b/CRM/Member/Form/Task/Batch.php @@ -86,7 +86,7 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -190,7 +190,7 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -285,6 +285,5 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { CRM_Core_Session::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert'); } } - //end of function } diff --git a/CRM/Member/Form/Task/Delete.php b/CRM/Member/Form/Task/Delete.php index 455d9fd503..2c6efa9b52 100644 --- a/CRM/Member/Form/Task/Delete.php +++ b/CRM/Member/Form/Task/Delete.php @@ -63,7 +63,7 @@ class CRM_Member_Form_Task_Delete extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Member/Form/Task/Email.php b/CRM/Member/Form/Task/Email.php index aa0bbc6859..83d2f66736 100644 --- a/CRM/Member/Form/Task/Email.php +++ b/CRM/Member/Form/Task/Email.php @@ -79,7 +79,7 @@ class CRM_Member_Form_Task_Email extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Member/Form/Task/Label.php b/CRM/Member/Form/Task/Label.php index 56da51f926..80a06c4ba3 100644 --- a/CRM/Member/Form/Task/Label.php +++ b/CRM/Member/Form/Task/Label.php @@ -52,7 +52,7 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -64,7 +64,7 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @param null * diff --git a/CRM/Member/Form/Task/PDFLetter.php b/CRM/Member/Form/Task/PDFLetter.php index 2460de89a7..c72d203368 100644 --- a/CRM/Member/Form/Task/PDFLetter.php +++ b/CRM/Member/Form/Task/PDFLetter.php @@ -73,7 +73,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Member/Form/Task/PDFLetterCommon.php b/CRM/Member/Form/Task/PDFLetterCommon.php index 010651fdc5..0307350921 100644 --- a/CRM/Member/Form/Task/PDFLetterCommon.php +++ b/CRM/Member/Form/Task/PDFLetterCommon.php @@ -12,7 +12,7 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLett * in fixing the existing pdfLetter classes to be suitably generic * @access public * - * @param $form + * @param CRM_Core_Form $form * @param $membershipIDs * @param $skipOnHold * @param $skipDeceased @@ -43,7 +43,6 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLett CRM_Utils_System::civiExit(1); } - //end of function /** * generate htmlfor pdf letters diff --git a/CRM/Member/Form/Task/PickProfile.php b/CRM/Member/Form/Task/PickProfile.php index 383a4b6626..0784859cea 100644 --- a/CRM/Member/Form/Task/PickProfile.php +++ b/CRM/Member/Form/Task/PickProfile.php @@ -64,9 +64,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { * @access public */ function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $session = CRM_Core_Session::singleton(); $this->_userContext = $session->readUserContext(); @@ -87,7 +85,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { } /** - * Build the form + * Build the form object * * @access public * @@ -148,6 +146,5 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { // also reset the batch page so it gets new values from the db $this->controller->resetPage('Batch'); } - //end of function } diff --git a/CRM/Member/Form/Task/Print.php b/CRM/Member/Form/Task/Print.php index 36e80c4830..90fbf78da1 100644 --- a/CRM/Member/Form/Task/Print.php +++ b/CRM/Member/Form/Task/Print.php @@ -67,7 +67,7 @@ class CRM_Member_Form_Task_Print extends CRM_Member_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Member/Form/Task/Result.php b/CRM/Member/Form/Task/Result.php index 25316ffd80..142eb242c3 100644 --- a/CRM/Member/Form/Task/Result.php +++ b/CRM/Member/Form/Task/Result.php @@ -49,7 +49,7 @@ class CRM_Member_Form_Task_Result extends CRM_Member_Form_Task { function preProcess() {} /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Form/Task/SearchTaskHookSample.php b/CRM/Member/Form/Task/SearchTaskHookSample.php index 7a04e86055..b67d1aaef5 100644 --- a/CRM/Member/Form/Task/SearchTaskHookSample.php +++ b/CRM/Member/Form/Task/SearchTaskHookSample.php @@ -72,7 +72,7 @@ WHERE mem.id IN ( $memberIDs )"; } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Import/Form/DataSource.php b/CRM/Member/Import/Form/DataSource.php index 85a80d05eb..8c7d383f89 100644 --- a/CRM/Member/Import/Form/DataSource.php +++ b/CRM/Member/Import/Form/DataSource.php @@ -39,7 +39,7 @@ class CRM_Member_Import_Form_DataSource extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -52,7 +52,7 @@ class CRM_Member_Import_Form_DataSource extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index c884a115be..49d0705ae7 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -50,7 +50,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -108,7 +108,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Member/Import/Form/Preview.php b/CRM/Member/Import/Form/Preview.php index 3766212dbc..33597f8c49 100644 --- a/CRM/Member/Import/Form/Preview.php +++ b/CRM/Member/Import/Form/Preview.php @@ -40,7 +40,7 @@ class CRM_Member_Import_Form_Preview extends CRM_Import_Form_Preview { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Member/Import/Form/Summary.php b/CRM/Member/Import/Form/Summary.php index 6575b6c3f1..5ce1208605 100644 --- a/CRM/Member/Import/Form/Summary.php +++ b/CRM/Member/Import/Form/Summary.php @@ -39,7 +39,7 @@ class CRM_Member_Import_Form_Summary extends CRM_Import_Form_Summary { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index 9c862f42ce..e61e56d79d 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -300,7 +300,7 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { } /** - * function to format the field values for input to the api + * format the field values for input to the api * * @return array (reference ) associative array of name/value pairs * @access public @@ -405,11 +405,10 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param $fileName + * @param string $fileName * @param array $header - * @param data $data + * @param array $data * - * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 7c3da7b96e..c0811d1ac7 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -165,7 +165,6 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { $errorMessage = 'Membership Start Date is required to create a memberships.'; CRM_Contact_Import_Parser_Contact::addToErrorMsg('Start Date', $errorMessage); } - //end //for date-Formats $session = CRM_Core_Session::singleton(); diff --git a/CRM/Member/Page/AJAX.php b/CRM/Member/Page/AJAX.php index 460081eb2d..fa1493732a 100644 --- a/CRM/Member/Page/AJAX.php +++ b/CRM/Member/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Member_Page_AJAX { /** - * Function to setDefaults according to membership type + * setDefaults according to membership type */ static function getMemberTypeDefaults() { if (!$_POST['mtype']) { diff --git a/CRM/Member/Page/DashBoard.php b/CRM/Member/Page/DashBoard.php index ab55f088a0..05c888d9e4 100644 --- a/CRM/Member/Page/DashBoard.php +++ b/CRM/Member/Page/DashBoard.php @@ -169,8 +169,6 @@ class CRM_Member_Page_DashBoard extends CRM_Core_Page { //LCD end } - // LCD debug - //CRM_Core_Error::debug($membershipSummary); $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusCurrent(); $status = implode(',', $status); diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index 89b8442a12..e0c67e237f 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -368,7 +368,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * @param $form + * @param CRM_Core_Form $form * @param null $contactId */ public static function setContext(&$form, $contactId = NULL) { @@ -552,7 +552,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * Function to define action links for membership types of related organization + * define action links for membership types of related organization * * @return array self::$_membershipTypesLinks array of action links * @access public diff --git a/CRM/Member/Page/UserDashboard.php b/CRM/Member/Page/UserDashboard.php index 3057216d74..85862cb293 100644 --- a/CRM/Member/Page/UserDashboard.php +++ b/CRM/Member/Page/UserDashboard.php @@ -39,7 +39,7 @@ class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** - * Function to list memberships for the UF user + * list memberships for the UF user * * return null * @access public diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index 9e21b4cb4d..f1b1f3349f 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -177,7 +177,6 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C $this->_query->_distinctComponentClause = " civicrm_membership.id"; $this->_query->_groupByComponentClause = " GROUP BY civicrm_membership.id "; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -272,14 +271,12 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C return self::$_links[$status]; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params - * @internal param $ + * @param array $params * @access public */ function getPagerParams($action, &$params) { @@ -295,7 +292,6 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -451,7 +447,6 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * * @return array $qill which contains an array of strings * @access public */ @@ -550,5 +545,4 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C return ts('CiviCRM Member Search'); } } -//end of class diff --git a/CRM/Note/Form/Note.php b/CRM/Note/Form/Note.php index 79f23507ad..9f89503328 100644 --- a/CRM/Note/Form/Note.php +++ b/CRM/Note/Form/Note.php @@ -87,7 +87,7 @@ class CRM_Note_Form_Note extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -114,7 +114,7 @@ class CRM_Note_Form_Note extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -160,7 +160,6 @@ class CRM_Note_Form_Note extends CRM_Core_Form { } /** - * * @access public * * @return void diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 27fd350273..90a9e410ba 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -50,7 +50,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { } /** - * function to add or update either a Personal Campaign Page OR a PCP Block + * add or update either a Personal Campaign Page OR a PCP Block * * @param array $params reference array contains the values submitted by the form * @param bool $pcpBlock if true, create or update PCPBlock, else PCP @@ -89,7 +89,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { } /** - * function to get the Display name of a contact for a PCP + * get the Display name of a contact for a PCP * * @param int $id id for the PCP * @@ -110,7 +110,7 @@ WHERE civicrm_pcp.contact_id = civicrm_contact.id } /** - * Function to return PCP Block info for dashboard + * return PCP Block info for dashboard * * @param $contactId * @@ -373,9 +373,9 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to build the form + * Build the form object * - * @param object $form form object + * @param CRM_Core_Form $form form object * * @return void * @access public @@ -740,9 +740,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get pcp block is active * - * @param $pcpId + * @param int $pcpId * @param $component - * @internal param int $id campaign page id * * @return int * @access public @@ -765,11 +764,10 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get pcp block is enabled for component page * - * @param $pageId + * @param int $pageId * @param $component - * @internal param int $id contribution page id * - * @return String + * @return string * @access public * @static */ @@ -811,9 +809,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get email is enabled for supporter's profile * - * @param $profileId - * - * @internal param int $id supporter's profile id + * @param int $profileId supporter's profile id * * @return boolean * @access public @@ -836,11 +832,9 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; /** * Function to obtain the title of page associated with a pcp * - * @param $pcpId + * @param int $pcpId * @param $component * - * @internal param int $id campaign page id - * * @return int * @access public * @static @@ -868,11 +862,9 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; /** * Function to get pcp block & entity id given pcp id * - * @param $pcpId + * @param int $pcpId * @param $component * - * @internal param int $id campaign page id - * * @return String * @access public * @static @@ -900,8 +892,6 @@ WHERE pcp.id = %1"; * * @param $component * - * @internal param int $id campaign page id - * * @return String * @access public * @static @@ -919,11 +909,9 @@ WHERE pcp.id = %1"; /** * Function to get supporter profile id * - * @param $component_id + * @param int $component_id * @param string $component * - * @internal param int $contributionPageId contribution page id - * * @return int * @access public * @static diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 81fb98a54e..2c95477bf8 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -95,7 +95,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -153,7 +153,6 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { * @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 @@ -171,7 +170,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index 882b2c07a0..afa98322df 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -52,7 +52,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -85,7 +85,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -100,7 +100,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -142,7 +142,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index fee8dd964a..f7c816b51b 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -53,7 +53,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -90,7 +90,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -131,7 +131,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -173,7 +173,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index 0b76055680..a5a2a7197b 100644 --- a/CRM/PCP/Form/PCP.php +++ b/CRM/PCP/Form/PCP.php @@ -41,7 +41,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { public $_context; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -121,7 +121,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -139,7 +139,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -195,7 +195,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { * @param array $fields posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 08a9ed75d3..5b0f7c6d66 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -142,7 +142,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -229,7 +229,6 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { * @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 @@ -249,7 +248,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 5d18a9734d..73cf278062 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -59,7 +59,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Pledge_BAO_Pledge object + * @return CRM_Pledge_BAO_Pledge object * @access public * @static */ @@ -74,7 +74,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * function to add pledge + * add pledge * * @param array $params reference array contains the values submitted by the form * @@ -143,7 +143,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Pledge_BAO_Pledge object + * @return CRM_Pledge_BAO_Pledge object * @access public * @static */ @@ -253,7 +253,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * Function to delete the pledge + * delete the pledge * * @param int $id pledge id * @@ -299,7 +299,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * function to get the amount details date wise. + * get the amount details date wise. * * @param string $status * @param string $startDate @@ -417,7 +417,6 @@ GROUP BY currency GROUP BY cp.currency "; if ($select) { - // CRM_Core_Error::debug($status . ' start:' . $startDate . '- end:' . $endDate, $query); $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); $amount = array(); $count = 0; @@ -490,8 +489,8 @@ GROUP BY currency /** * Function to send Acknowledgment and create activity. * - * @param object $form form object. - * @param array $params (reference ) an assoc array of name/value pairs. + * @param CRM_Core_Form $form form object. + * @param array $params an assoc array of name/value pairs. * @access public * * @return void. @@ -534,7 +533,6 @@ GROUP BY currency } } } - //end //assign pledge fields value to template. $pledgeFields = array( @@ -795,8 +793,6 @@ GROUP BY currency * * @param $contactID * - * @internal param int $contactId Contact ID - * * @return int count of pledge records * @access public * @static @@ -807,7 +803,7 @@ GROUP BY currency } /** - * @param $params + * @param array $params * * @return array */ diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 4deb2714af..0596b91db8 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -51,7 +51,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Pledge_BAO_PledgeBlock object + * @return CRM_Pledge_BAO_PledgeBlock object * @access public * @static */ @@ -70,7 +70,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Pledge_BAO_PledgeBlock object + * @return CRM_Pledge_BAO_PledgeBlock object * @access public * @static */ @@ -91,7 +91,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * function to add pledgeBlock + * add pledgeBlock * * @param array $params reference array contains the values submitted by the form * @@ -147,7 +147,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Function to delete the pledgeBlock + * delete the pledgeBlock * * @param int $id pledgeBlock id * @@ -174,13 +174,11 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Function to return Pledge Block info in Contribution Pages + * return Pledge Block info in Contribution Pages * - * @param $pageID + * @param int $pageID contribution page id * * @return array - * @internal param int $pageId contribution page id - * * @static */ static function getPledgeBlock($pageID) { @@ -199,7 +197,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Function to build Pledge Block in Contribution Pages * - * @param obj $form + * @param CRM_Core_Form $form * @static */ static function buildPledgeBlock($form) { diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 53a8064313..9b8b9e8f1e 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -42,7 +42,7 @@ class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment { } /** - * Function to get pledge payment details + * get pledge payment details * * @param int $pledgeId pledge id * @@ -93,7 +93,7 @@ WHERE pledge_id = %1 } /** - * @param $params + * @param array $params * * @return pledge */ @@ -208,7 +208,7 @@ WHERE pledge_id = %1 * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Pledge_BAO_PledgePayment object + * @return CRM_Pledge_BAO_PledgePayment object * @access public * @static */ @@ -227,9 +227,7 @@ WHERE pledge_id = %1 * * @param $id * - * @internal param array $params associate array of field - * - * @return pledge payment id + * @return int pledge payment id * @static */ static function del($id) { @@ -252,7 +250,7 @@ WHERE pledge_id = %1 } /** - * Function to delete all pledge payments + * delete all pledge payments * * @param int $id pledge id * @@ -330,12 +328,11 @@ WHERE pledge_id = %1 * @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 int $pledgeStatusID pledge status to change (if needed) * @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( @@ -611,7 +608,7 @@ WHERE civicrm_pledge.id = %2 } /** - * Function to update pledge payment table + * update pledge payment table * * @param int $pledgeId pledge id * @param int $paymentStatusId payment status id to set diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 1b08edb121..9fd9f2be7c 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -537,7 +537,7 @@ class CRM_Pledge_BAO_Query { } /** - * @param $form + * @param CRM_Core_Form $form */ static function buildSearchForm(&$form) { // pledge related dates diff --git a/CRM/Pledge/Form/Payment.php b/CRM/Pledge/Form/Payment.php index 1f733f6199..5eda5b0bdc 100644 --- a/CRM/Pledge/Form/Payment.php +++ b/CRM/Pledge/Form/Payment.php @@ -48,7 +48,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { public $_id; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -65,7 +65,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -89,7 +89,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -136,7 +136,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index 248cd4008a..12715b7522 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -75,7 +75,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { public $_isPending = FALSE; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -132,7 +132,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -219,7 +219,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -452,7 +452,6 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { * @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 @@ -482,7 +481,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Pledge/Form/PledgeView.php b/CRM/Pledge/Form/PledgeView.php index 1f5c78f30e..5cdd45a33e 100644 --- a/CRM/Pledge/Form/PledgeView.php +++ b/CRM/Pledge/Form/PledgeView.php @@ -40,7 +40,7 @@ class CRM_Pledge_Form_PledgeView extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -132,7 +132,7 @@ class CRM_Pledge_Form_PledgeView extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index fbb67488c2..f859aa950a 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -157,7 +157,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form + * Build the form object * * @access public * @@ -304,8 +304,6 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { * * @param array $fields posted values of the form * - * @internal param array $errors list of errors to be posted back to the form - * * @return void * @static * @access public diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 92b618690e..2d01f0934e 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -80,7 +80,7 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $useTable */ static function preProcessCommon(&$form, $useTable = FALSE) { @@ -155,7 +155,6 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { * @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/Pledge/Form/Task/Delete.php b/CRM/Pledge/Form/Task/Delete.php index 7784eff168..5eb69746ec 100644 --- a/CRM/Pledge/Form/Task/Delete.php +++ b/CRM/Pledge/Form/Task/Delete.php @@ -62,7 +62,7 @@ class CRM_Pledge_Form_Task_Delete extends CRM_Pledge_Form_Task { } /** - * Build the form + * Build the form object * * @access public * diff --git a/CRM/Pledge/Form/Task/Print.php b/CRM/Pledge/Form/Task/Print.php index 8f12a429bb..d431a5a3cb 100644 --- a/CRM/Pledge/Form/Task/Print.php +++ b/CRM/Pledge/Form/Task/Print.php @@ -68,7 +68,7 @@ class CRM_Pledge_Form_Task_Print extends CRM_Pledge_Form_Task { } /** - * Build the form - it consists of + * Build the form object - it consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search * diff --git a/CRM/Pledge/Form/Task/Result.php b/CRM/Pledge/Form/Task/Result.php index cf3c622019..d80e14ac07 100644 --- a/CRM/Pledge/Form/Task/Result.php +++ b/CRM/Pledge/Form/Task/Result.php @@ -49,7 +49,7 @@ class CRM_Pledge_Form_Task_Result extends CRM_Pledge_Form_Task { function preProcess() {} /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Pledge/Form/Task/SearchTaskHookSample.php b/CRM/Pledge/Form/Task/SearchTaskHookSample.php index d495868ca9..b6568966c2 100644 --- a/CRM/Pledge/Form/Task/SearchTaskHookSample.php +++ b/CRM/Pledge/Form/Task/SearchTaskHookSample.php @@ -70,7 +70,7 @@ INNER JOIN civicrm_contact ct ON ( plg.contact_id = ct.id ) } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Pledge/Page/AJAX.php b/CRM/Pledge/Page/AJAX.php index f242f79dd3..b912e35b68 100644 --- a/CRM/Pledge/Page/AJAX.php +++ b/CRM/Pledge/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Pledge_Page_AJAX { /** - * Function for building Pledge Name combo box + * building Pledge Name combo box */ static function pledgeName() { diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index 1c1aaf0327..e6755b2afe 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -177,7 +177,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { $this->_query->_distinctComponentClause = "civicrm_pledge.id"; $this->_query->_groupByComponentClause = " GROUP BY civicrm_pledge.id "; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -233,15 +232,13 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -257,7 +254,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * Returns total number of rows for the query. @@ -371,7 +367,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { } /** - * * @return array $qill which contains an array of strings * @access public */ @@ -470,5 +465,4 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { return ts('Pledge Search'); } } -//end of class diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index 333685d632..79e2a3a9f1 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -50,7 +50,7 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Price_DAO_LineItem object + * @return CRM_Price_DAO_LineItem object * @access public * @static */ @@ -93,7 +93,7 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Price_BAO_LineItem object + * @return CRM_Price_BAO_LineItem object * @access public * @static */ @@ -350,7 +350,7 @@ AND li.entity_id = {$entityId} } /** - * Function to process price set and line items. + * process price set and line items. * * @param $entityId * @param array $lineItem line item array @@ -359,8 +359,6 @@ AND li.entity_id = {$entityId} * * @param bool $update * - * @internal param int $contributionId contribution id - * @internal param \decimal $initAmount amount * @access public * @return void * @static @@ -463,7 +461,7 @@ AND li.entity_id = {$entityId} } /** - * Function to build line items array. + * build line items array. * @param array $params form values * * @param string $entityId entity id diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index ce8d7b0f67..57c8d52c21 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -48,11 +48,9 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * price field object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs - * - * @internal param array $ids the array that holds all the db ids + * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Price_BAO_PriceField object + * @return CRM_Price_BAO_PriceField object * @access public * @static */ @@ -76,7 +74,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Price_DAO_PriceField object + * @return CRM_Price_DAO_PriceField object * @access public * @static */ @@ -170,16 +168,12 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Price_DAO_PriceField object + * @return CRM_Price_DAO_PriceField object * @access public * @static */ diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 73a22e9406..3a4ccc7c7f 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -46,7 +46,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param $ids * - * @return object CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue object * @access public * @static */ @@ -75,7 +75,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param $ids * - * @return object CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue object * @access public * @static */ @@ -129,7 +129,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param array $params (reference ) an assoc array * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue object * @access public * @static */ diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index a071a7925b..1a98ae5568 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -59,7 +59,7 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Price_DAO_PriceSet object + * @return CRM_Price_DAO_PriceSet object * @access public * @static */ @@ -76,16 +76,12 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Price_DAO_PriceSet object + * @return CRM_Price_DAO_PriceSet object * @access public * @static */ @@ -710,7 +706,7 @@ WHERE id = %1"; /** * @param $fields - * @param $params + * @param array $params * @param $lineItem * @param string $component */ @@ -886,7 +882,7 @@ WHERE id = %1"; } /** - * Function to build the price set form. + * build the price set form. * * @param CRM_Core_Form $form * @@ -973,7 +969,7 @@ WHERE id = %1"; } /** - * Function to check the current Membership + * check the current Membership * having end date null. */ static function checkCurrentMembership(&$options, $userid) { @@ -1003,9 +999,9 @@ WHERE id = %1"; } /** - * Function to set daefult the price set fields. + * set daefult the price set fields. * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return array $defaults @@ -1357,13 +1353,9 @@ WHERE ps.id = %1 /** * Copy priceSet when event/contibution page is copied * - * @params string $baoName BAO name - * @params int $id old event/contribution page id - * @params int $newId newly created event/contribution page id - * - * @param string $baoName - * @param integer $id - * @param integer $newId + * @param string $baoName BAO name + * @param int $id old event/contribution page id + * @param int $newId newly created event/contribution page id */ static function copyPriceSet($baoName, $id, $newId) { $priceSetId = CRM_Price_BAO_PriceSet::getFor($baoName, $id); diff --git a/CRM/Price/Form/DeleteField.php b/CRM/Price/Form/DeleteField.php index 999320f084..89413a46cc 100644 --- a/CRM/Price/Form/DeleteField.php +++ b/CRM/Price/Form/DeleteField.php @@ -73,7 +73,7 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Price/Form/DeleteSet.php b/CRM/Price/Form/DeleteSet.php index 829861bfe2..a55bd08361 100644 --- a/CRM/Price/Form/DeleteSet.php +++ b/CRM/Price/Form/DeleteSet.php @@ -66,7 +66,7 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Price/Form/Field.php b/CRM/Price/Form/Field.php index a8beb48ec8..2be5586f0a 100644 --- a/CRM/Price/Form/Field.php +++ b/CRM/Price/Form/Field.php @@ -74,7 +74,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { protected $_useForMember; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -100,7 +100,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -170,7 +170,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -394,7 +394,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { * @param array $fields posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array if errors then list of errors to be posted back to the form, * true otherwise diff --git a/CRM/Price/Form/Option.php b/CRM/Price/Form/Option.php index 0289259616..4f65a42eea 100644 --- a/CRM/Price/Form/Option.php +++ b/CRM/Price/Form/Option.php @@ -55,7 +55,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { protected $_oid; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -73,7 +73,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null @@ -116,7 +116,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -274,7 +274,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { * @param array $fields posted values of the form * * @param $files - * @param $form + * @param CRM_Core_Form $form * * @return array if errors then list of errors to be posted back to the form, * true otherwise diff --git a/CRM/Price/Form/Preview.php b/CRM/Price/Form/Preview.php index 1718b647dc..21bba9e89f 100644 --- a/CRM/Price/Form/Preview.php +++ b/CRM/Price/Form/Preview.php @@ -116,7 +116,7 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index 1aadbe2b05..cf65892768 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -47,7 +47,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { protected $_sid; /** - * Function to set variables up before form is built + * set variables up before form is built * * @param null * @@ -109,7 +109,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @param null * @@ -231,7 +231,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @param null diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index 199b9db755..889060ef04 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -201,10 +201,9 @@ class CRM_Price_Page_Set extends CRM_Core_Page { /** * edit price set * - * @param $sid + * @param int $sid price set id * @param string $action the action to be invoked * - * @internal param int $id price set id * @return void * @access public */ @@ -224,9 +223,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { /** * Preview price set * - * @param $sid - * - * @internal param int $id price set id + * @param int $sid price set id * * @return void * @access public diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php index 4d28d2e044..3c98c3b2e6 100644 --- a/CRM/Profile/Form.php +++ b/CRM/Profile/Form.php @@ -406,7 +406,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public @@ -579,7 +579,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -826,18 +826,12 @@ class CRM_Profile_Form extends CRM_Core_Form { } } - /* - * Function to validate profile and provided activity Id - * - * @params Integer $activityId Activity Id - * @params Integer $gid Profile Id - * - * @return Array $errors Errors ( if any ). - */ /** - * @param $activityId - * @param $contactId - * @param $gid + * Validate profile and provided activity Id + * + * @param int $activityId + * @param int $contactId + * @param int $gid * * @return array */ @@ -877,7 +871,7 @@ class CRM_Profile_Form extends CRM_Core_Form { * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param object $form the form object + * @param CRM_Core_Form $form the form object * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index 19edf78cd9..bb26b21bd1 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -72,7 +72,7 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -99,9 +99,8 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param object $form + * @param CRM_Core_Form $form * - * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Profile/Form/Edit.php b/CRM/Profile/Form/Edit.php index 7531c36b98..72aca4c486 100644 --- a/CRM/Profile/Form/Edit.php +++ b/CRM/Profile/Form/Edit.php @@ -141,7 +141,7 @@ SELECT module,is_reserved } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -307,7 +307,7 @@ SELECT module,is_reserved } /** - * Function to intercept QF validation and do our own redirection + * intercept QF validation and do our own redirection * * We use this to send control back to the user for a user formatted page * This allows the user to maintain the same state and display the error messages diff --git a/CRM/Profile/Form/Search.php b/CRM/Profile/Form/Search.php index e73cf35191..79126f0e11 100644 --- a/CRM/Profile/Form/Search.php +++ b/CRM/Profile/Form/Search.php @@ -101,7 +101,7 @@ class CRM_Profile_Form_Search extends CRM_Profile_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/Profile/Page/Listings.php b/CRM/Profile/Page/Listings.php index 1cdfb5fae8..22e527943d 100644 --- a/CRM/Profile/Page/Listings.php +++ b/CRM/Profile/Page/Listings.php @@ -398,13 +398,11 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { } /** - * Function to get the list of contacts for a profile + * get the list of contacts for a profile * * @param $gid * * @return array - * @internal param object $form - * * @access public */ function getProfileContact($gid) { diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index 493925d3f0..afc0564b19 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -136,7 +136,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * Class constructor * - * @param $params + * @param array $params * @param $customFields * @param string params the params for the where clause * @@ -209,7 +209,6 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR $this->_options = &$this->_query->_options; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -276,15 +275,13 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } return self::$_links; } - //end of function /** * getter for array of the parameters required for creating pager. * * @param $action - * @param $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -297,7 +294,6 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR $params['buttonTop'] = 'PagerTopButton'; $params['buttonBottom'] = 'PagerBottomButton'; } - //end of function /** * returns the column headers as an array of tuples: @@ -792,5 +788,4 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } } //func close } -//end of class diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index aa75b11bf5..b682ea6e4e 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -178,9 +178,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { /** * Return an item that could not be processed * - * @param The $item - * - * @internal param object $dao The item returned by claimItem + * @param CRM_Core_DAO $item The item returned by claimItem * * @return bool */ diff --git a/CRM/Queue/Queue/Sql.php b/CRM/Queue/Queue/Sql.php index 9a7b638e91..245b2fbade 100644 --- a/CRM/Queue/Queue/Sql.php +++ b/CRM/Queue/Queue/Sql.php @@ -199,7 +199,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { /** * Remove an item from the queue * - * @param $dao object The item returned by claimItem + * @param CRM_Core_DAO $dao The item returned by claimItem */ function deleteItem($dao) { $dao->delete(); @@ -209,7 +209,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { /** * Return an item that could not be processed * - * @param $dao object The item returned by claimItem + * @param CRM_Core_DAO $dao The item returned by claimItem * * @return bool */ diff --git a/CRM/Queue/Runner.php b/CRM/Queue/Runner.php index 0f069b2681..75c9c22e23 100644 --- a/CRM/Queue/Runner.php +++ b/CRM/Queue/Runner.php @@ -251,7 +251,6 @@ class CRM_Queue_Runner { } /** - * * @return array(is_error => bool, is_continue => bool, numberOfItems => int, redirect_url => string) */ public function handleEnd() { @@ -275,7 +274,6 @@ class CRM_Queue_Runner { } /** - * * @param $isOK * @param null $exception * diff --git a/CRM/Queue/Service.php b/CRM/Queue/Service.php index 2c3daa283e..7617bb48d0 100644 --- a/CRM/Queue/Service.php +++ b/CRM/Queue/Service.php @@ -81,7 +81,6 @@ class CRM_Queue_Service { } /** - * * @param $queueSpec, array with keys: * - type: string, required, e.g. "interactive", "immediate", "stomp", "beanstalk" * - name: string, required, e.g. "upgrade-tasks" @@ -112,7 +111,6 @@ class CRM_Queue_Service { } /** - * * @param $queueSpec, array with keys: * - type: string, required, e.g. "interactive", "immediate", "stomp", "beanstalk" * - name: string, required, e.g. "upgrade-tasks" @@ -149,7 +147,6 @@ class CRM_Queue_Service { } /** - * * @param $queueSpec array, see create() * * @return CRM_Queue_Queue diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php index d5d76c5efa..f196a89ed5 100644 --- a/CRM/Queue/Task.php +++ b/CRM/Queue/Task.php @@ -52,7 +52,6 @@ class CRM_Queue_Task { var $title; /** - * * @param $callback mixed, serializable, a callable PHP item; must accept at least one argument (CRM_Queue_TaskContext) * @param $arguments array, serializable, extra arguments to pass to the callback (in order) * @param $title string, a printable string which describes this task @@ -66,12 +65,10 @@ class CRM_Queue_Task { /** * Perform the task * - * @param $taskCtx - * - * @throws Exception - * @internal param array $taskContext with keys: + * @param $taskCtx array with keys: * - log: object 'Log' * + * @throws Exception * @return bool, TRUE if task completes successfully */ function run($taskCtx) { diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index eb6f3dcc0b..92f40dd059 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -44,7 +44,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Report_DAO_ReportInstance object + * @return CRM_Report_DAO_ReportInstance object * @access public * @static */ @@ -118,14 +118,14 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { } /** - * Function to create instance + * create instance * takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc. * * This function is invoked from within the web form layer and also from the api layer * * @param array $params (reference ) an assoc array of name/value pairs * - * @return object CRM_Report_BAO_ReportInstance object + * @return CRM_Report_BAO_ReportInstance object * @access public * @static */ @@ -238,7 +238,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { } /** - * @param $params + * @param array $params * @param $defaults * * @return CRM_Report_DAO_ReportInstance|null diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 84efb835cd..cec9d6c217 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -799,8 +799,6 @@ class CRM_Report_Form extends CRM_Core_Form { * Setter for $_id * * @param $instanceid - * - * @internal param int $id */ function setID($instanceid) { $this->_id = $instanceid; @@ -808,8 +806,7 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Setter for $_force - * @param $isForce - * @internal param bool $force + * @param bool $isForce */ function setForce($isForce) { $this->_force = $isForce; @@ -3439,7 +3436,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * @deprecated - use getAddressColumns which is a more accurate description * and also accepts an array of options rather than a long list * - * function for adding address fields to construct function in reports + * adding address fields to construct function in reports * * @param bool $groupBy Add GroupBy? Not appropriate for detail report * @param bool $orderBy Add GroupBy? Not appropriate for detail report diff --git a/CRM/Report/Form/Case/Demographics.php b/CRM/Report/Form/Case/Demographics.php index 0582097eea..3994e417d2 100644 --- a/CRM/Report/Form/Case/Demographics.php +++ b/CRM/Report/Form/Case/Demographics.php @@ -373,7 +373,6 @@ where (cg.extends='Contact' OR cg.extends='Individual' OR cg.extends_entity_colu $this->beginPostProcess(); $sql = $this->buildQuery(TRUE); - //CRM_Core_Error::debug('sql', $sql); $rows = $graphRows = array(); $this->buildRows($sql, $rows); diff --git a/CRM/Report/Form/Case/TimeSpent.php b/CRM/Report/Form/Case/TimeSpent.php index af5e2bc840..328f1cac07 100644 --- a/CRM/Report/Form/Case/TimeSpent.php +++ b/CRM/Report/Form/Case/TimeSpent.php @@ -324,7 +324,6 @@ GROUP BY {$this->_aliases['civicrm_contact']}.id, ) { $errors['fields'] = ts('To view totals please select all of activity id, date and duration.'); } - // CRM_Core_Error::debug('xx', print_r($fields, true)); return $errors; } diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index e6b93e18c0..27f553b442 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -711,7 +711,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /* - * function for adding address fields to construct function in reports + * adding address fields to construct function in reports * @param array $options Options for the report * - prefix prefix to add (e.g. 'honor' when getting address details for honor contact * - prefix_label optional prefix lable eg. "Honoree " for front end diff --git a/CRM/Report/Form/Instance.php b/CRM/Report/Form/Instance.php index 10569ee773..2146df2b05 100644 --- a/CRM/Report/Form/Instance.php +++ b/CRM/Report/Form/Instance.php @@ -35,7 +35,7 @@ class CRM_Report_Form_Instance { /** - * @param $form + * @param CRM_Core_Form $form */ static function buildForm(&$form) { // we should not build form elements in dashlet mode @@ -198,7 +198,7 @@ class CRM_Report_Form_Instance { } /** - * @param $form + * @param CRM_Core_Form $form * @param $defaults */ static function setDefaultValues(&$form, &$defaults) { @@ -264,7 +264,7 @@ class CRM_Report_Form_Instance { } /** - * @param $form + * @param CRM_Core_Form $form * @param bool $redirect */ static function postProcess(&$form, $redirect = TRUE) { diff --git a/CRM/Report/Form/Register.php b/CRM/Report/Form/Register.php index 116863a73c..0b94d6bbd7 100644 --- a/CRM/Report/Form/Register.php +++ b/CRM/Report/Form/Register.php @@ -47,7 +47,6 @@ class CRM_Report_Form_Register extends CRM_Core_Form { return; } - // crm_core_error::debug("$this->_actions", $this->_action); $this->_opID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name' ); @@ -175,7 +174,7 @@ class CRM_Report_Form_Register extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index 0b99a5ca28..e769e1fc4a 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -213,7 +213,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * function to get userContext params + * get userContext params * * @param int $mode mode that we are in * diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index d2685183c1..b69e75df69 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -180,8 +180,7 @@ WHERE inst.report_id = %1"; * * @return bool */ - static function mailReport($fileContent, $instanceID = NULL, $outputMode = 'html', $attachments = array( - )) { + static function mailReport($fileContent, $instanceID = NULL, $outputMode = 'html', $attachments = array()) { if (!$instanceID) { return FALSE; } @@ -216,7 +215,7 @@ WHERE inst.report_id = %1"; } /** - * @param $form + * @param CRM_Core_Form $form * @param $rows */ static function export2csv(&$form, &$rows) { @@ -390,7 +389,7 @@ WHERE inst.report_id = %1"; } /** - * @param $params + * @param array $params * * @return array */ @@ -463,8 +462,7 @@ WHERE inst.report_id = %1"; * * @return string URL query string */ - static function getPreviewCriteriaQueryParams($defaults = array( - ), $params = array()) { + static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) { static $query_string; if (!isset($query_string)) { if (!empty($params)) { diff --git a/CRM/SMS/Form/Group.php b/CRM/SMS/Form/Group.php index ca4ac6d06c..4e2fd845e1 100644 --- a/CRM/SMS/Form/Group.php +++ b/CRM/SMS/Form/Group.php @@ -40,7 +40,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -55,7 +55,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -103,7 +103,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/SMS/Form/Provider.php b/CRM/SMS/Form/Provider.php index 753039b159..3f7d478560 100644 --- a/CRM/SMS/Form/Provider.php +++ b/CRM/SMS/Form/Provider.php @@ -62,7 +62,7 @@ class CRM_SMS_Form_Provider extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -164,7 +164,7 @@ class CRM_SMS_Form_Provider extends CRM_Core_Form { } /** - * Function to process the form + * Process the form submission * * @access public * diff --git a/CRM/SMS/Form/Schedule.php b/CRM/SMS/Form/Schedule.php index 299d197405..c7ff282234 100644 --- a/CRM/SMS/Form/Schedule.php +++ b/CRM/SMS/Form/Schedule.php @@ -39,7 +39,7 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -54,7 +54,7 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * * @access public * @@ -71,7 +71,7 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { } /** - * Build the form for the last step of the sms wizard + * Build the form object for the last step of the sms wizard * * @param * diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index f6048f2e07..5e97c12b04 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -47,7 +47,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * This function sets the default values for the form. + * Set default values for the form. * the default values are retrieved from the database * * @access public @@ -120,7 +120,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -290,7 +290,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * Function for validation + * validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index 5431f32a61..8420a3d09a 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -54,8 +54,7 @@ abstract class CRM_SMS_Provider { * @return object * @static */ - static function &singleton($providerParams = array( - ), $force = FALSE) { + static function &singleton($providerParams = array(), $force = FALSE) { $mailingID = CRM_Utils_Array::value('mailing_id', $providerParams); $providerID = CRM_Utils_Array::value('provider_id', $providerParams); $providerName = CRM_Utils_Array::value('provider', $providerParams); @@ -97,7 +96,7 @@ abstract class CRM_SMS_Provider { abstract function send($recipients, $header, $message, $dncID = NULL); /** - * Function to return message text. Child class could override this function to have better control over the message being sent. + * return message text. Child class could override this function to have better control over the message being sent. * * @access public */ @@ -130,8 +129,7 @@ abstract class CRM_SMS_Provider { * @return $this|null|object * @throws CRM_Core_Exception */ - function createActivity($apiMsgID, $message, $headers = array( - ), $jobID = NULL, $userID = NULL) { + function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) { if ($jobID) { $sql = " SELECT scheduled_id FROM civicrm_mailing m diff --git a/CRM/Tag/Form/Tag.php b/CRM/Tag/Form/Tag.php index afb3b784b9..2e65e28a8f 100644 --- a/CRM/Tag/Form/Tag.php +++ b/CRM/Tag/Form/Tag.php @@ -66,7 +66,7 @@ class CRM_Tag_Form_Tag extends CRM_Core_Form { } /** - * Function to build the form + * Build the form object * * @return void * @access public @@ -113,7 +113,6 @@ class CRM_Tag_Form_Tag extends CRM_Core_Form { } /** - * * @access public * * @return void @@ -130,6 +129,5 @@ class CRM_Tag_Form_Tag extends CRM_Core_Form { CRM_Core_Session::setStatus(ts('Your update(s) have been saved.'), ts('Saved'), 'success'); } - //end of function } diff --git a/CRM/UF/Form/AbstractPreview.php b/CRM/UF/Form/AbstractPreview.php index 2a201a8b78..8372987b62 100644 --- a/CRM/UF/Form/AbstractPreview.php +++ b/CRM/UF/Form/AbstractPreview.php @@ -93,7 +93,7 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/UF/Form/AdvanceSetting.php b/CRM/UF/Form/AdvanceSetting.php index 3ae4863f7c..f44740bc41 100644 --- a/CRM/UF/Form/AdvanceSetting.php +++ b/CRM/UF/Form/AdvanceSetting.php @@ -35,11 +35,11 @@ class CRM_UF_Form_AdvanceSetting extends CRM_UF_Form_Group { /** - * Function to build the form for Advance Settings. + * Build the form object for Advance Settings. * * @access public * - * @param $form + * @param CRM_Core_Form $form * * @return void */ diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index 97a936c763..b3d2d96701 100644 --- a/CRM/UF/Form/Field.php +++ b/CRM/UF/Form/Field.php @@ -96,7 +96,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { protected $_hasSearchableORInSelector; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -183,7 +183,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -420,7 +420,6 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } } - // CRM_Core_Error::debug(array($sel1, $sel2, $sel3, $sel4)); $sel->setOptions(array($sel1, $sel2, $sel3, $sel4)); // proper interpretation of spec in CRM-8732 diff --git a/CRM/UF/Form/Group.php b/CRM/UF/Form/Group.php index 112c1d0a49..ae301b49f3 100644 --- a/CRM/UF/Form/Group.php +++ b/CRM/UF/Form/Group.php @@ -58,7 +58,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { protected $_allPanes; /** - * Function to set variables up before form is built + * set variables up before form is built * * @return void * @access public @@ -109,7 +109,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public @@ -208,7 +208,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * This function sets the default values for the form. Note that in edit/view mode + * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database * * @access public diff --git a/CRM/UF/Form/Preview.php b/CRM/UF/Form/Preview.php index 1b0ef967df..6d813e3d2e 100644 --- a/CRM/UF/Form/Preview.php +++ b/CRM/UF/Form/Preview.php @@ -126,7 +126,7 @@ class CRM_UF_Form_Preview extends CRM_UF_Form_AbstractPreview { } /** - * Function to actually build the form + * Build the form object * * @return void * @access public diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php index 4fcdf874f9..a684abbcbf 100644 --- a/CRM/UF/Page/Field.php +++ b/CRM/UF/Page/Field.php @@ -283,10 +283,8 @@ class CRM_UF_Page_Field extends CRM_Core_Page { /** * Preview custom field * - * @param $fieldId - * @param $groupId - * - * @internal param int $id custom field id + * @param int $fieldId custom field id + * @param int $groupId * * @return void * @access public diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php index 0991bd7894..3a4708a696 100644 --- a/CRM/UF/Page/ProfileEditor.php +++ b/CRM/UF/Page/ProfileEditor.php @@ -67,8 +67,6 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page { * @param array $entityTypes strings, e.g. "IndividualModel", "ActivityModel" */ static function registerSchemas($entityTypes) { - /* CRM_Core_Error::backtrace(); */ - /* CRM_Core_Error::debug( '$entityTypes', $entityTypes ); */ // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient CRM_Core_Resources::singleton()->addSettingsFactory(function () use ($entityTypes) { return array( diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index b0386d1650..b8571df122 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -618,9 +618,6 @@ SET version = '$version' * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1' * * @return bool - * @internal param string $currentVer , the original revision - * @internal param string $latestVer , the target (final) revision - * @internal param string $postUpgradeMessageFile , path of a modifiable file which lists the post-upgrade messages */ static function doIncrementalUpgradeStart(CRM_Queue_TaskContext $ctx, $rev) { $upgrade = new CRM_Upgrade_Form(); diff --git a/CRM/Upgrade/Incremental/php/FourFive.php b/CRM/Upgrade/Incremental/php/FourFive.php index db9e389184..b3f68e96c2 100644 --- a/CRM/Upgrade/Incremental/php/FourFive.php +++ b/CRM/Upgrade/Incremental/php/FourFive.php @@ -53,7 +53,6 @@ class CRM_Upgrade_Incremental_php_FourFive { * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0' * @param null $currentVer * - * @internal param string $postUpgradeMessage , alterable * @return void */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { @@ -147,7 +146,7 @@ DROP KEY `{$dao->CONSTRAINT_NAME}`"; /** * (Queue Task Callback) * - * Function to update the line items + * update the line items * * * @param CRM_Queue_TaskContext $ctx diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index af2a61d3a0..1ec5761816 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -55,7 +55,6 @@ class CRM_Upgrade_Incremental_php_FourFour { * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0' * @param null $currentVer * - * @internal param string $postUpgradeMessage , alterable * @return void */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { diff --git a/CRM/Upgrade/Incremental/php/FourOne.php b/CRM/Upgrade/Incremental/php/FourOne.php index b25de5da6a..7a8e95e3da 100644 --- a/CRM/Upgrade/Incremental/php/FourOne.php +++ b/CRM/Upgrade/Incremental/php/FourOne.php @@ -280,7 +280,7 @@ VALUES } /** - * @param $params + * @param array $params */ static function retrieveDirectoryAndURLPaths(&$params) { diff --git a/CRM/Upgrade/Incremental/php/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php index 1da76993f6..d9a76bef15 100644 --- a/CRM/Upgrade/Incremental/php/FourSix.php +++ b/CRM/Upgrade/Incremental/php/FourSix.php @@ -53,7 +53,6 @@ class CRM_Upgrade_Incremental_php_FourSix { * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0' * @param null $currentVer * - * @internal param string $postUpgradeMessage , alterable * @return void */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index fe76aee539..45fa0073d0 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -54,7 +54,6 @@ class CRM_Upgrade_Incremental_php_FourThree { * @param $rev string, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0' * @param null $currentVer * - * @internal param string $postUpgradeMessage , alterable * @return void|bool */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { diff --git a/CRM/Upgrade/Incremental/php/FourTwo.php b/CRM/Upgrade/Incremental/php/FourTwo.php index b85943a4b1..e52ca01da2 100644 --- a/CRM/Upgrade/Incremental/php/FourTwo.php +++ b/CRM/Upgrade/Incremental/php/FourTwo.php @@ -56,7 +56,6 @@ class CRM_Upgrade_Incremental_php_FourTwo { * @param $rev string, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0' * @param null $currentVer * - * @internal param string $postUpgradeMessage , alterable * @return void */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { @@ -453,7 +452,7 @@ WHERE cpse.price_set_id IS NULL"; /** * - * Function to create price sets + * create price sets */ static function createPriceSet($daoName, $addTo, $options = array()) { $query = "SELECT title FROM {$addTo[0]} where id =%1"; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 3ff95f126d..572c6f98b8 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -50,9 +50,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * * @param array $params (reference ) an assoc array of name/value pairs * - * @internal param array $ids the array that holds all the db ids - * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object * @access public * @static */ @@ -76,7 +74,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object * @access public * @static */ @@ -156,16 +154,12 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object * @access public * @static */ @@ -206,18 +200,16 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p /** * This function for building custom fields * - * @param object $qf form object (reference) + * @param CRM_Core_Form $qf form object (reference) * @param string $elementName name of the custom field * @param $fieldId * @param boolean $inactiveNeeded * @param boolean $useRequired true if required else false * @param string $label label for custom field - * * @param null $fieldOptions - * @param array $feezeOptions + * @param array $freezeOptions * * @return null - * @internal param bool $search true if used for search else false * @access public * @static */ @@ -228,7 +220,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p $useRequired = TRUE, $label = NULL, $fieldOptions = NULL, - $feezeOptions = array() + $freezeOptions = array() ) { $field = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field(); @@ -301,7 +293,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p ); // CRM-6902 - if (in_array($optionKey, $feezeOptions)) { + if (in_array($optionKey, $freezeOptions)) { $element->freeze(); } @@ -347,7 +339,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra); // CRM-6902 - if (in_array($opId, $feezeOptions)) { + if (in_array($opId, $freezeOptions)) { $choice[$opId]->freeze(); } } @@ -401,7 +393,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } $selectOption[$opt['id']] = $opt['label']; - if (!in_array($opt['id'], $feezeOptions)) { + if (!in_array($opt['id'], $freezeOptions)) { $allowedOptions[] = $opt['id']; } } @@ -414,7 +406,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p // CRM-6902 $button = substr($qf->controller->getButtonName(), -4); - if (!empty($feezeOptions) && $button != 'skip') { + if (!empty($freezeOptions) && $button != 'skip') { $qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/"); } break; @@ -439,7 +431,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p ); // CRM-6902 - if (in_array($opId, $feezeOptions)) { + if (in_array($opId, $freezeOptions)) { $check[$opId]->freeze(); } } diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index 5b0c6ef6f0..48ba55bd00 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -46,7 +46,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param $ids * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object * @access public * @static */ @@ -75,7 +75,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param $ids * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object * @access public * @static */ @@ -116,7 +116,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param array $params (reference ) an assoc array * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object * @access public * @static */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index 10accd252c..34139a6d1b 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -50,7 +50,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object * @access public * @static */ @@ -78,7 +78,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object + * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object * @access public * @static */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 3020ab2469..0315dacffb 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -51,7 +51,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ * * @param array $params (reference) an assoc array of name/value pairs * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object * @access public * @static */ @@ -65,16 +65,12 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * contact_id. We'll tweak this function to be more 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 + * Fetch object based on array of properties * * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object * @access public * @static */ @@ -85,10 +81,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ /** * update the is_active flag in the db * - * @param int $id id of the database record - * @param $isActive - * - * @internal param bool $is_active value we want to set the is_active field + * @param int $id id of the database record + * @param bool $isActive value we want to set the is_active field * * @return Object DAO object on sucess, null otherwise * @static @@ -457,12 +451,10 @@ WHERE ct.id = cp.contribution_type_id AND * * An array containing price set details (including price fields) is returned * - * @param $setID + * @param int $setID price set id whose details are needed * @param bool $required * @param bool $validOnly * - * @internal param int $setId - price set id whose details are needed - * * @return array $setTree - array consisting of field details */ public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) { @@ -554,7 +546,7 @@ WHERE id = %1"; } /** - * @param $form + * @param CRM_Core_Form $form * @param $id * @param string $entityTable * @param bool $validOnly @@ -656,7 +648,7 @@ WHERE id = %1"; /** * @param $fields - * @param $params + * @param array $params * @param $lineItem */ static function processAmount(&$fields, &$params, &$lineItem) { @@ -764,9 +756,9 @@ WHERE id = %1"; } /** - * Function to build the price set form. + * build the price set form. * - * @param $form + * @param CRM_Core_Form $form * * @return void * @access public @@ -843,7 +835,7 @@ $options } /** - * Function to check the current Membership + * check the current Membership * having end date null. */ static function checkCurrentMembership(&$options, $userid) { @@ -873,9 +865,9 @@ return FALSE; } /** - * Function to set daefult the price set fields. + * set daefult the price set fields. * - * @param $form + * @param CRM_Core_Form $form * @param $defaults * * @return array $defaults diff --git a/CRM/Utils/API/MatchOption.php b/CRM/Utils/API/MatchOption.php index a8068c8771..6e2d54d3bd 100644 --- a/CRM/Utils/API/MatchOption.php +++ b/CRM/Utils/API/MatchOption.php @@ -169,10 +169,9 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { /** * Create APIv3 "get" parameters to lookup an existing record using $keys * - * @param $origParams + * @param array $origParams api request * @param array $keys list of keys to match against * - * @internal param array $apiRequest * @return array APIv3 $params */ function createGetParams($origParams, $keys) { diff --git a/CRM/Utils/Address/BatchUpdate.php b/CRM/Utils/Address/BatchUpdate.php index adde5a61bb..a047bcd76f 100644 --- a/CRM/Utils/Address/BatchUpdate.php +++ b/CRM/Utils/Address/BatchUpdate.php @@ -44,7 +44,7 @@ class CRM_Utils_Address_BatchUpdate { var $returnError = 0; /** - * @param $params + * @param array $params */ public function __construct($params) { diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index 55cbbe9340..34e5569969 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -288,13 +288,11 @@ class CRM_Utils_Date { * %P - uppercase ante/post meridiem ('AM', 'PM') * %Y - year as a decimal number including the century ('2005') * - * @param string $dateString + * @param string $dateString date and time in 'YYYY-MM-DD hh:mm:ss' format * @param string $format the output format * @param array $dateParts an array with the desired date parts * - * @internal param string $date date and time in 'YYYY-MM-DD hh:mm:ss' format * @return string the $format-formatted $date - * * @static */ static function customFormat($dateString, $format = NULL, $dateParts = NULL) { @@ -704,7 +702,7 @@ class CRM_Utils_Date { } /** - * Function to get customized today + * get customized today * * This function is used for getting customized today. To get * actuall today pass 'dayParams' as null. or else pass the day, @@ -737,7 +735,7 @@ class CRM_Utils_Date { } /** - * Function to find whether today's date lies in + * find whether today's date lies in * the given range * * @param date $startDate start date for the range @@ -765,7 +763,7 @@ class CRM_Utils_Date { } /** - * Function to get start date and end from + * get start date and end from * the given relative term and unit * * @param date $relative eg: term.unit diff --git a/CRM/Utils/DeprecatedUtils.php b/CRM/Utils/DeprecatedUtils.php index 3d2a4ded39..85effe9287 100644 --- a/CRM/Utils/DeprecatedUtils.php +++ b/CRM/Utils/DeprecatedUtils.php @@ -596,7 +596,7 @@ function _civicrm_api3_deprecated_formatted_param($params, &$values, $create = F } /** - * Function to check duplicate contacts based on de-deupe parameters + * check duplicate contacts based on de-deupe parameters */ function _civicrm_api3_deprecated_check_contact_dedupe($params) { static $cIndieFields = NULL; @@ -1212,12 +1212,9 @@ function _civicrm_api3_deprecated_validate_formatted_contact(&$params) { /** * @deprecated - this is part of the import parser not the API & needs to be moved on out * - * @param $params + * @param array $params * @param $onDuplicate * - * @internal param $ $params - * @internal param $ $onDuplicate - * * @return array|bool */ function _civicrm_api3_deprecated_create_participant_formatted($params, $onDuplicate) { @@ -1330,7 +1327,7 @@ function _civicrm_api3_deprecated_contact_check_custom_params($params, $csType = } /** - * @param $params + * @param array $params * @param bool $dupeCheck * @param bool $dupeErrorArray * @param bool $requiredCheck @@ -1470,9 +1467,6 @@ function _civicrm_api3_deprecated_contact_check_params( * @param $result * @param $activityTypeID * - * @internal param $ $result - * @internal param $ $activityTypeID - * * @return array $params */ function _civicrm_api3_deprecated_activity_buildmailparams($result, $activityTypeID) { diff --git a/CRM/Utils/File.php b/CRM/Utils/File.php index 42ef38472b..f169fb0273 100644 --- a/CRM/Utils/File.php +++ b/CRM/Utils/File.php @@ -129,13 +129,11 @@ class CRM_Utils_File { * delete a directory given a path name, delete children directories * and files if needed * - * @param $target + * @param string $target the path name * @param bool $rmdir * @param bool $verbose * * @throws Exception - * @internal param string $path the path name - * * @return void * @access public * @static diff --git a/CRM/Utils/Geocode/Google.php b/CRM/Utils/Geocode/Google.php index 4db6f2e31d..5034d9b96c 100644 --- a/CRM/Utils/Geocode/Google.php +++ b/CRM/Utils/Geocode/Google.php @@ -59,11 +59,9 @@ class CRM_Utils_Geocode_Google { * address. Note that at a later stage, we could make this function also clean up * the address into a more valid format * - * @param $values + * @param array $values * @param bool $stateName * - * @internal param object $address - * * @return boolean true if we modified the address, false otherwise * @static */ diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index f900114539..21406e6f24 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -306,7 +306,7 @@ abstract class CRM_Utils_Hook { * This hook is invoked during the CiviCRM form preProcess phase. * * @param string $formName the name of the form - * @param object $form reference to the form object + * @param CRM_Core_Form $form reference to the form object * * @return null the return value is ignored */ @@ -319,7 +319,7 @@ abstract class CRM_Utils_Hook { * be used to set the default values of a form element * * @param string $formName the name of the form - * @param object $form reference to the form object + * @param CRM_Core_Form $form reference to the form object * * @return null the return value is ignored */ @@ -332,7 +332,7 @@ abstract class CRM_Utils_Hook { * any form elements, this hook should save the values in the database * * @param string $formName the name of the form - * @param object $form reference to the form object + * @param CRM_Core_Form $form reference to the form object * * @return null the return value is ignored */ @@ -512,7 +512,7 @@ abstract class CRM_Utils_Hook { * This hook is called when building the amount structure for a Contribution or Event Page * * @param int $pageType - is this a contribution or event page - * @param object $form - reference to the form object + * @param CRM_Core_Form $form - reference to the form object * @param array $amount - the amount structure to be displayed * * @return null @@ -1077,10 +1077,9 @@ abstract class CRM_Utils_Hook { * @param string $entity the API entity (like contact) * @param string $action the API action (like get) * @param array &$params the API parameters - * @param $permissions + * @param array &$permissions the associative permissions array (probably to be altered by this hook) * * @return mixed - * @internal param array $permisisons the associative permissions array (probably to be altered by this hook) */ static function alterAPIPermissions($entity, $action, &$params, &$permissions) { return self::singleton()->invoke(4, $entity, $action, $params, $permissions, @@ -1090,7 +1089,7 @@ abstract class CRM_Utils_Hook { } /** - * @param $dao + * @param CRM_Core_DAO $dao * * @return mixed */ diff --git a/CRM/Utils/Hook/DrupalBase.php b/CRM/Utils/Hook/DrupalBase.php index 4103689263..f63a3f2586 100644 --- a/CRM/Utils/Hook/DrupalBase.php +++ b/CRM/Utils/Hook/DrupalBase.php @@ -55,7 +55,6 @@ class CRM_Utils_Hook_DrupalBase extends CRM_Utils_Hook { private $drupalModules = NULL; /** - * * @see CRM_Utils_Hook::invoke() * * @param integer $numParams Number of parameters to pass to the hook diff --git a/CRM/Utils/HttpClient.php b/CRM/Utils/HttpClient.php index dc88f47559..e9abf8e7e5 100644 --- a/CRM/Utils/HttpClient.php +++ b/CRM/Utils/HttpClient.php @@ -151,9 +151,8 @@ class CRM_Utils_HttpClient { * Send an HTTP POST for a remote resource * * @param string $remoteFile URL of a .zip file - * @param $params + * @param array $params * - * @internal param string $localFile path at which to store the .zip file * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) */ public function post($remoteFile, $params) { diff --git a/CRM/Utils/ICalendar.php b/CRM/Utils/ICalendar.php index 3bef59fdb4..b65cf36aa2 100644 --- a/CRM/Utils/ICalendar.php +++ b/CRM/Utils/ICalendar.php @@ -85,7 +85,6 @@ class CRM_Utils_ICalendar { } /** - * * Send the ICalendar to the browser with the specified content type * - 'text/calendar' : used for downloaded ics file * - 'text/plain' : used for iCal formatted feed @@ -94,17 +93,11 @@ class CRM_Utils_ICalendar { * @access public * * @param string $calendar The calendar data to be published. - * * @param string $content_type - * - * @param string $charset The character set to use, defaults to - * 'us-ascii'. - * - * @param null $fileName + * @param string $charset The character set to use, defaults to 'us-ascii'. + * @param string $fileName The file name (for downloads) * @param string $disposition How the file should be sent ('attachment' for downloads) * - * @internal param string $filename The file name (for downloads) - * * @return void */ static function send($calendar, $content_type = 'text/calendar', $charset = 'us-ascii', $fileName = NULL, $disposition = NULL) { diff --git a/CRM/Utils/JSON.php b/CRM/Utils/JSON.php index 00287a5eaa..0a3d9f50f6 100644 --- a/CRM/Utils/JSON.php +++ b/CRM/Utils/JSON.php @@ -49,7 +49,7 @@ class CRM_Utils_JSON { } /** - * Function to create JSON object + * create JSON object * @deprecated * * @param array $params associated array, that needs to be @@ -72,7 +72,7 @@ class CRM_Utils_JSON { } /** - * Function to encode json format for flexigrid, NOTE: "id" should be present in $params for each row + * encode json format for flexigrid, NOTE: "id" should be present in $params for each row * * @param array $params associated array of values rows * @param int $page page no for selector diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php index 82b89406f0..9a80593b2d 100644 --- a/CRM/Utils/Mail.php +++ b/CRM/Utils/Mail.php @@ -389,7 +389,6 @@ class CRM_Utils_Mail { } /** - * * @param string $fileName * @param string $html * @param string $format diff --git a/CRM/Utils/Mail/EmailProcessor.php b/CRM/Utils/Mail/EmailProcessor.php index 1c5eb1b659..6cf4622acc 100644 --- a/CRM/Utils/Mail/EmailProcessor.php +++ b/CRM/Utils/Mail/EmailProcessor.php @@ -132,7 +132,7 @@ class CRM_Utils_Mail_EmailProcessor { /** * @param $civiMail - * @param $dao + * @param CRM_Core_DAO $dao * * @throws Exception */ diff --git a/CRM/Utils/Mail/Incoming.php b/CRM/Utils/Mail/Incoming.php index 0ae2469783..d8bae19d90 100644 --- a/CRM/Utils/Mail/Incoming.php +++ b/CRM/Utils/Mail/Incoming.php @@ -370,7 +370,7 @@ class CRM_Utils_Mail_Incoming { /** * @param $address - * @param $params + * @param array $params * @param $subParam * @param $mail */ @@ -395,7 +395,7 @@ class CRM_Utils_Mail_Incoming { /** * @param $addresses * @param $token - * @param $params + * @param array $params * @param $mail */ public static function parseAddresses(&$addresses, $token, &$params, &$mail) { diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index 1a611f9602..de8ace27af 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -397,7 +397,7 @@ class CRM_Utils_Migrate_Export { /** * @param $groupName - * @param $daoName + * @param string $daoName * @param null $sql */ function fetch($groupName, $daoName, $sql = NULL) { @@ -536,7 +536,6 @@ class CRM_Utils_Migrate_Export { * @param string $tagName * @param array $keyValues * @throws Exception - * @internal param string $additional XML * @return string XML */ public function renderKeyValueXML($tagName, $keyValues) { diff --git a/CRM/Utils/Migrate/ExportJSON.php b/CRM/Utils/Migrate/ExportJSON.php index fbcc348786..adeff2efb3 100644 --- a/CRM/Utils/Migrate/ExportJSON.php +++ b/CRM/Utils/Migrate/ExportJSON.php @@ -50,7 +50,7 @@ class CRM_Utils_Migrate_ExportJSON { protected $_sitePrefix = 'Site 1'; /** - * @param $params + * @param array $params */ function __construct(&$params) { foreach ($params as $name => $value) { @@ -512,7 +512,7 @@ WHERE ac.contact_id IN ( $ids ) } /** - * @param $daoName + * @param string $daoName * @param bool $onlyKeys * * @return array diff --git a/CRM/Utils/Migrate/Import.php b/CRM/Utils/Migrate/Import.php index 124a58c536..2a3605c0d9 100644 --- a/CRM/Utils/Migrate/Import.php +++ b/CRM/Utils/Migrate/Import.php @@ -93,7 +93,7 @@ class CRM_Utils_Migrate_Import { } /** - * @param $dao + * @param CRM_Core_DAO $dao * @param $xml * @param bool $save * @param null $keyName diff --git a/CRM/Utils/Migrate/ImportJSON.php b/CRM/Utils/Migrate/ImportJSON.php index fb16cc3958..071d8cc7e1 100644 --- a/CRM/Utils/Migrate/ImportJSON.php +++ b/CRM/Utils/Migrate/ImportJSON.php @@ -204,7 +204,7 @@ class CRM_Utils_Migrate_ImportJSON { /** * @param $chunk - * @param $daoName + * @param string $daoName * @param null $lookUpMapping * @param null $dateFields */ diff --git a/CRM/Utils/OpenFlashChart.php b/CRM/Utils/OpenFlashChart.php index fe7285869b..b96562b581 100644 --- a/CRM/Utils/OpenFlashChart.php +++ b/CRM/Utils/OpenFlashChart.php @@ -509,7 +509,7 @@ class CRM_Utils_OpenFlashChart { } /** - * @param $params + * @param array $params * @param $chart * * @return array diff --git a/CRM/Utils/PDF/Label.php b/CRM/Utils/PDF/Label.php index e5a8326248..4884a3542d 100644 --- a/CRM/Utils/PDF/Label.php +++ b/CRM/Utils/PDF/Label.php @@ -151,7 +151,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /* - * Function to initialize label format settings + * initialize label format settings */ /** * @param $format @@ -184,7 +184,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /* - * function to Generate the pdf of one label (can be modified using SetGenerator) + * Generate the pdf of one label (can be modified using SetGenerator) */ /** * @param $text @@ -231,7 +231,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /* - * function to Print a label + * Print a label */ /** * @param $texte diff --git a/CRM/Utils/PDF/Utils.php b/CRM/Utils/PDF/Utils.php index 5bfad58723..0bfed717b2 100644 --- a/CRM/Utils/PDF/Utils.php +++ b/CRM/Utils/PDF/Utils.php @@ -225,7 +225,7 @@ class CRM_Utils_PDF_Utils { } /* - * function to convert value from one metric to another + * convert value from one metric to another */ /** * @param $value @@ -373,13 +373,6 @@ class CRM_Utils_PDF_Utils { 'embedding encoding=winansi' ); - /** - if ( $res == 0 ) { - CRM_Core_Error::debug( "$key, $value: $res", $pdf->get_errmsg( ) ); - } else { - CRM_Core_Error::debug( "SUCCESS: $key, $value", null ); - } - **/ } $pdf->end_page_ext(''); diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 9615cccdcc..3632fedb77 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -68,7 +68,7 @@ class CRM_Utils_Pager extends Pager_Sliding { * We have embedded some html in this class. Need to figure out how to export this * to the top level at some point in time * - * @param $params + * @param array $params * * @internal param \total $int the total count of items to be displayed * @internal param \currentPage $int the page currently being displayed @@ -192,7 +192,7 @@ class CRM_Utils_Pager extends Pager_Sliding { * * @param int $defaultPageId defaultPageId current pageId * - * @param $params + * @param array $params * * @return int new pageId to display to the user * @access public diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php index 60d8116428..e957a7246d 100644 --- a/CRM/Utils/PagerAToZ.php +++ b/CRM/Utils/PagerAToZ.php @@ -57,7 +57,7 @@ class CRM_Utils_PagerAToZ { } /** - * Function to return the all the static characters + * return the all the static characters * * @return array $staticAlphabets is a array of static characters * @access private @@ -69,7 +69,7 @@ class CRM_Utils_PagerAToZ { } /** - * Function to return the all the dynamic characters + * return the all the dynamic characters * * @param $query * @param $isDAO diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index 6c2dc9e883..12be37fbc1 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -97,9 +97,8 @@ class CRM_Utils_PseudoConstant { * If there's a full, preloaded map, use it. Otherwise, use search * class space. * - * @param $constant + * @param string $constant constant-name * - * @internal param string $name constant-name * @return string|NULL class-name */ public static function findConstantClass($constant) { diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php index 010cfe8156..859e32d113 100644 --- a/CRM/Utils/REST.php +++ b/CRM/Utils/REST.php @@ -89,7 +89,7 @@ class CRM_Utils_REST { // Generates values needed for non-error responses. /** - * @param $params + * @param array $params * * @return array */ @@ -340,7 +340,7 @@ class CRM_Utils_REST { /** * @param $args - * @param $params + * @param array $params * * @return array|int */ diff --git a/CRM/Utils/ReCAPTCHA.php b/CRM/Utils/ReCAPTCHA.php index 6b07762614..1465efc3f4 100644 --- a/CRM/Utils/ReCAPTCHA.php +++ b/CRM/Utils/ReCAPTCHA.php @@ -116,7 +116,7 @@ class CRM_Utils_ReCAPTCHA { /** * @param $value - * @param $form + * @param CRM_Core_Form $form * * @return mixed */ diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php index 504ad85826..7663474420 100644 --- a/CRM/Utils/Recent.php +++ b/CRM/Utils/Recent.php @@ -89,13 +89,11 @@ class CRM_Utils_Recent { * @param string $title the title to display * @param string $url the link for the above title * @param string $id object id - * * @param $type * @param $contactId * @param $contactName * @param array $others * - * @internal param string $icon a link to a graphical image * @return void * @access public * @static diff --git a/CRM/Utils/Request.php b/CRM/Utils/Request.php index 216cf9c324..a3021c2f11 100644 --- a/CRM/Utils/Request.php +++ b/CRM/Utils/Request.php @@ -125,7 +125,6 @@ class CRM_Utils_Request { * This is a replacement for $_REQUEST which includes $_GET/$_POST * but excludes $_COOKIE / $_ENV / $_SERVER. * - * @internal param string $method * @return array */ static function exportValues() { diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php index 7d29014052..3f3248bd71 100644 --- a/CRM/Utils/SoapServer.php +++ b/CRM/Utils/SoapServer.php @@ -321,7 +321,7 @@ class CRM_Utils_SoapServer { /** * @param $key - * @param $params + * @param array $params * * @return array|int * @throws SoapFault diff --git a/CRM/Utils/String.php b/CRM/Utils/String.php index 79f4f7af05..d5fbb23a8b 100644 --- a/CRM/Utils/String.php +++ b/CRM/Utils/String.php @@ -358,7 +358,7 @@ class CRM_Utils_String { } /** - * Function to extract variable values + * extract variable values * * @param mix $query this is basically url * @@ -447,7 +447,7 @@ class CRM_Utils_String { /** * @param $string - * @param $params + * @param array $params */ static function extractName($string, &$params) { $name = trim($string); diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 2aef7f3725..91fc83dd25 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -1519,8 +1519,7 @@ class CRM_Utils_System { * @param bool $throwError * @param $realPath */ - static function loadBootStrap($params = array( - ), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) { + static function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) { if (!is_array($params)) { $params = array(); } @@ -1622,7 +1621,6 @@ class CRM_Utils_System { * @param string $url * @param bool $removeLanguagePart * - * @internal param bool $remoteLanguagePart * @return string */ static function absoluteURL($url, $removeLanguagePart = FALSE) { @@ -1644,7 +1642,7 @@ class CRM_Utils_System { } /** - * Function to clean url, replaces first '&' with '?' + * clean url, replaces first '&' with '?' * * @param string $url * @@ -1766,10 +1764,9 @@ class CRM_Utils_System { * each element. * @access public */ - static function getPluginList($relpath, $fext = '.php', $skipList = array( - )) { - $fext_len = strlen($fext); - $plugins = array(); + static function getPluginList($relpath, $fext = '.php', $skipList = array()) { + $fext_len = strlen($fext); + $plugins = array(); $inc_files = CRM_Utils_System::listIncludeFiles($relpath); foreach ($inc_files as $inc_file) { if (substr($inc_file, 0 - $fext_len) == $fext) { diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 8c3421eb99..309274672c 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { /** - * Function to create a user in Drupal. + * create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -76,7 +76,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * if we want to submit this form more than once in a process (e.g. create more than one user) * we must force it to validate each time for this form. Otherwise it will not validate * subsequent submissions and the manner in which the password is passed in will be invalid - * */ + */ $form_state['must_validate'] = TRUE; $config = CRM_Core_Config::singleton(); @@ -122,13 +122,9 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { /** * Check if username and email exists in the drupal db * - * @params $params array array of name and mail values - * @params $errors array array of errors - * @params $emailName string field label for the 'email' - * - * @param $params - * @param $errors - * @param string $emailName + * @param array $params array of name and mail values + * @param array $errors array of errors + * @param string $emailName field label for the 'email' * * @return void */ @@ -179,15 +175,15 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { } /* - * Function to get the drupal destination string. When this is passed in the + * Get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * - * @param object $form Form object representing the 'current' form - to which the user will be returned + * @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned * @return string $destination destination value for URL * */ /** - * @param $form + * @param CRM_Core_Form $form * * @return null|string */ @@ -259,8 +255,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { /** * Append an additional breadcrumb tag to the existing breadcrumb * - * @param $breadCrumbs - * + * @param array $breadCrumbs * @internal param string $title * @internal param string $url * diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index bb1a79fde9..f269514fa9 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -73,7 +73,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Function to create a user in Drupal. + * create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -142,13 +142,9 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Check if username and email exists in the drupal db * - * @params $params array array of name and mail values - * @params $errors array array of errors - * @params $emailName string field label for the 'email' - * - * @param $params - * @param $errors - * @param string $emailName + * @param array $params array of name and mail values + * @param array $errors array of errors + * @param string $emailName field label for the 'email' * * @return void */ @@ -215,10 +211,10 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Function to get the drupal destination string. When this is passed in the + * get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * - * @param object $form Form object representing the 'current' form - to which the user will be returned + * @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned * @return string $destination destination value for URL * */ diff --git a/CRM/Utils/System/Drupal8.php b/CRM/Utils/System/Drupal8.php index 5f9a2ab8e8..454a61c7b1 100644 --- a/CRM/Utils/System/Drupal8.php +++ b/CRM/Utils/System/Drupal8.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { /** - * Function to create a user in Drupal. + * create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -173,10 +173,10 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * Function to get the drupal destination string. When this is passed in the + * get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * - * @param object $form Form object representing the 'current' form - to which the user will be returned + * @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned * @return string $destination destination value for URL * */ diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index a3400b0c22..f8fc2190af 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -51,7 +51,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Function to create a user of Joomla. + * create a user of Joomla. * * @param array $params associated array * @param string $mail email id for cms user @@ -120,15 +120,11 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Check if username and email exists in the Joomla! db + * Check if username and email exists in the drupal db * - * @params $params array array of name and mail values - * @params $errors array array of errors - * @params $emailName string field label for the 'email' - * - * @param $params - * @param $errors - * @param string $emailName + * @param array $params array of name and mail values + * @param array $errors array of errors + * @param string $emailName field label for the 'email' * * @return void */ @@ -444,7 +440,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Function to set the email address of the user + * set the email address of the user * * @param object $user handle to the user object * @@ -779,7 +775,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * @param $form + * @param CRM_Core_Form $form */ public function getLoginDestination(&$form) { $args = NULL; diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php index ecf3e6ae39..5a0ef48d36 100644 --- a/CRM/Utils/System/Soap.php +++ b/CRM/Utils/System/Soap.php @@ -135,7 +135,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { } /** - * Function to set the email address of the user + * set the email address of the user * * @param object $user handle to the user object * diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index 0c14597d9a..dbe0356b1b 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -571,7 +571,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * @param $params + * @param array $params * @param $mail * * @return mixed @@ -629,7 +629,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * @param $params + * @param array $params * @param $errors * @param string $emailName */ @@ -742,7 +742,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * @param $form + * @param CRM_Core_Form $form */ public function getLoginDestination(&$form) { return; diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index dd81e28872..290e68c86d 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -187,9 +187,7 @@ class CRM_Utils_Token { /** * get< the regex for token replacement * - * @param $token_type - * - * @internal param string $key a string indicating the the type of token to be used in the expression + * @param string $token_type a string indicating the the type of token to be used in the expression * * @return string regular expression sutiable for using in preg_replace * @access private @@ -1093,7 +1091,6 @@ class CRM_Utils_Token { * @param null $className * @param int $jobID the mailing list jobID - this is a legacy param * - * @internal param array $contactIds of contacts * @return array * @access public * @static @@ -1246,16 +1243,12 @@ class CRM_Utils_Token { * gives required details of contribuion in an indexed array format so we * can iterate in a nice loop and do token evaluation * - * @param $contributionIDs - * @param array $returnProperties of required properties - * @param array $extraParams extra params - * @param array $tokens the list of tokens we've extracted from the content - * - * @param null $className + * @param array $contributionIDs + * @param array $returnProperties of required properties + * @param array $extraParams extra params + * @param array $tokens the list of tokens we've extracted from the content + * @param string $className * - * @internal param array $contributionId one contribution id - * @internal param bool $skipOnHold don't return on_hold contact info. - * @internal param bool $skipDeceased don't return deceased contact info. * @return array * @access public * @static diff --git a/CRM/Utils/Tree.php b/CRM/Utils/Tree.php index d60f73e3bf..eaae076c00 100644 --- a/CRM/Utils/Tree.php +++ b/CRM/Utils/Tree.php @@ -90,7 +90,7 @@ class CRM_Utils_Tree { * * @param $nodeName * - * @internal param string $root + * @internal param string $rootNode * * @return CRM_Utils_Tree * @access public @@ -145,7 +145,7 @@ class CRM_Utils_Tree { } /** - * Function to check if node is a leaf node. + * check if node is a leaf node. * Currently leaf nodes are strings and non-leaf nodes are arrays * * @param array( diff --git a/CRM/Utils/Weight.php b/CRM/Utils/Weight.php index 28822142d0..a5d0dc994f 100644 --- a/CRM/Utils/Weight.php +++ b/CRM/Utils/Weight.php @@ -39,7 +39,7 @@ class CRM_Utils_Weight { static $SIGNABLE_FIELDS = array('reset', 'dao', 'idName', 'url', 'filter'); // 'id','src','dst','dir' /** - * Function to correct duplicate weight entries by putting them (duplicate weights) in sequence. + * correct duplicate weight entries by putting them (duplicate weights) in sequence. * * @param string $daoName full name of the DAO * @param array $fieldValues field => value to be used in the WHERE @@ -265,7 +265,7 @@ class CRM_Utils_Weight { * * @param null $groupBy * - * @return Object CRM_Core_DAO objet that holds the results of the query + * @return CRM_Core_DAO objet that holds the results of the query */ static function &query($queryType, $daoName, @@ -338,7 +338,7 @@ class CRM_Utils_Weight { /** * @param $rows - * @param $daoName + * @param string $daoName * @param $idName * @param $returnURL * @param null $filter diff --git a/CRM/Utils/XML.php b/CRM/Utils/XML.php index ab3338b72d..420efb3bb0 100644 --- a/CRM/Utils/XML.php +++ b/CRM/Utils/XML.php @@ -119,8 +119,7 @@ class CRM_Utils_XML { /** * Convert an XML element to an array * - * @pararm $obj SimpleXMLElement - * @param $obj + * @param $obj SimpleXMLElement * * @return array */ diff --git a/Civi/API/Kernel.php b/Civi/API/Kernel.php index 59f5e6c597..eb17709aaf 100644 --- a/Civi/API/Kernel.php +++ b/Civi/API/Kernel.php @@ -271,7 +271,6 @@ class Kernel { } /** - * * @param string $msg * @param array $data * @param array $apiRequest diff --git a/Civi/Core/Transaction/Manager.php b/Civi/Core/Transaction/Manager.php index 06dbf8af56..bfc350633d 100644 --- a/Civi/Core/Transaction/Manager.php +++ b/Civi/Core/Transaction/Manager.php @@ -47,7 +47,6 @@ class Manager { private $frames = array(); /** - * * @var int */ private $savePointCount = 0; diff --git a/api/api.php b/api/api.php index 8882e8df90..79f3f5c381 100644 --- a/api/api.php +++ b/api/api.php @@ -45,7 +45,7 @@ function civicrm_api3($entity, $action, $params = array()) { } /** - * Function to call getfields from api wrapper. This function ensures that settings that could alter + * call getfields from api wrapper. This function ensures that settings that could alter * getfields output (e.g. action for all api & profile_id for profile api ) are consistently passed in. * * We check whether the api call is 'getfields' because if getfields is being called we return an empty array @@ -83,8 +83,6 @@ function _civicrm_api3_api_getfields(&$apiRequest) { * * @param $result * - * @internal param array $params (reference ) input parameters - * * @return boolean true if error, false otherwise * @static void * @access public diff --git a/api/class.api.php b/api/class.api.php index 93dda31ec1..1a59ce43db 100644 --- a/api/class.api.php +++ b/api/class.api.php @@ -126,14 +126,14 @@ class civicrm_api3 { } /** - * + * @return string */ public function __toString() { return json_encode($this->lastResult); } /** - * + * Perform action */ public function __call($action, $params) { // @TODO Check if it's a valid action. @@ -154,7 +154,8 @@ class civicrm_api3 { } /** - * + * Call via rest + * @return stdClass */ function remoteCall($entity, $action, $params = array()) { $fields = "key={$this->key}&api_key={$this->api_key}"; @@ -253,20 +254,21 @@ class civicrm_api3 { /** * Return the last error message. + * @return string */ function errorMsg() { return $this->lastResult->error_message; } /** - * + * Initialize */ function init() { CRM_Core_DAO::init($this->cfg->dsn); } /** - * + * @return $this */ public function attr($name, $value = NULL) { if ($value === NULL) { @@ -281,21 +283,22 @@ class civicrm_api3 { } /** - * + * @return bool */ public function is_error() { return (property_exists($this->lastResult, 'is_error') && $this->lastResult->is_error); } /** - * + * @param $name + * @return bool */ public function is_set($name) { return (isset($this->lastResult->$name)); } /** - * + * @return $this */ public function __get($name) { // @TODO Test if valid entity. @@ -320,6 +323,7 @@ class civicrm_api3 { /** * Or use $api->value. + * @return array */ public function values() { if (is_array($this->lastResult)) { @@ -332,6 +336,7 @@ class civicrm_api3 { /** * Or use $api->result. + * @return array */ public function result() { return $this->lastResult; diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 2ad97bc28c..d051346013 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -41,7 +41,7 @@ * {@getfields acl_create} * @example aclCreate.php * - * @param $params + * @param array $params * * @return array of newly created acl property values. * @access public @@ -57,7 +57,7 @@ function civicrm_api3_acl_create($params) { * {@getfields acl_get} * @example aclCreate.php * - * @param $params + * @param array $params * * @return array of retrieved acl property values. * @access public @@ -73,7 +73,7 @@ function civicrm_api3_acl_get($params) { * {@getfields acl_delete} * @example aclCreate.php * - * @param $params + * @param array $params * * @return array of deleted values. * @access public diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index 05a3712028..0e1b9f7d40 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -41,7 +41,7 @@ * {@getfields acl_role_create} * @example acl_roleCreate.php * - * @param $params + * @param array $params * * @return array of newly created acl_role property values. * @access public @@ -57,7 +57,7 @@ function civicrm_api3_acl_role_create($params) { * {@getfields acl_role_get} * @example acl_roleCreate.php * - * @param $params + * @param array $params * * @return array of retrieved acl_role property values. * @access public @@ -73,7 +73,7 @@ function civicrm_api3_acl_role_get($params) { * {@getfields acl_role_delete} * @example acl_roleCreate.php * - * @param $params + * @param array $params * * @return array of deleted values. * @access public diff --git a/api/v3/Activity.php b/api/v3/Activity.php index 4e46c49e2f..951ee68e17 100644 --- a/api/v3/Activity.php +++ b/api/v3/Activity.php @@ -326,14 +326,12 @@ function civicrm_api3_activity_delete($params) { } /** - * Function to check for required params + * Check for required params * * @param array $params associated array of fields * * @throws API_Exception * @throws Exception - * @internal param bool $addMode true for add mode - * * @return array $error array with errors */ function _civicrm_api3_activity_check_params(&$params) { diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index c180ae9e64..765f524381 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -43,7 +43,7 @@ * * @example ActivityContact.php * - * @param $params + * @param array $params * * @return array of newly created activity contact records. * @access public diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php index 2805c9b65d..7abaa22ca6 100644 --- a/api/v3/ActivityType.php +++ b/api/v3/ActivityType.php @@ -45,9 +45,9 @@ function _civicrm_api3_activity_type_deprecation() { } /** - * Function to retrieve activity types + * retrieve activity types * - * @param $params + * @param array $params * * @return array $activityTypes activity types keyed by id * @access public @@ -62,7 +62,7 @@ function civicrm_api3_activity_type_get($params) { } /** - * Function to create activity type ( + * create activity type ( * * @param array $params associated array of fields * $params['option_value_id'] is required for updation of activity type @@ -102,7 +102,7 @@ function _civicrm_api3_activity_type_create_spec(&$params) { } /** - * Function to delete activity type + * delete activity type * * @param array $params array including id of activity_type to delete diff --git a/api/v3/Address.php b/api/v3/Address.php index 346e2ee50a..3e11a82041 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -43,7 +43,7 @@ * {@getfields address_create} * {@example AddressCreate.php} * - * @param $params + * @param array $params * * @return array of newly created tag property values. * @access public @@ -78,9 +78,9 @@ function civicrm_api3_address_create(&$params) { } /** - * create array for BAO (expects address params in as an - * element in array 'address' - */ + * Create array for BAO (expects address params in as an + * element in array 'address' + */ $addressBAO = CRM_Core_BAO_Address::add($params, TRUE); if (empty($addressBAO)) { return civicrm_api3_create_error("Address is not created or updated "); diff --git a/api/v3/Batch.php b/api/v3/Batch.php index a04c2a2f8b..3f08aa9624 100644 --- a/api/v3/Batch.php +++ b/api/v3/Batch.php @@ -41,7 +41,7 @@ * {@getfields batch_create} * @example BatchCreate.php * - * @param $params + * @param array $params * * @return array of newly created batch property values. * @access public @@ -76,7 +76,7 @@ function _civicrm_api3_batch_create_spec(&$params) { * {@getfields batch_get} * @example BatchCreate.php * - * @param $params + * @param array $params * * @return array of retrieved batch property values. * @access public @@ -92,7 +92,7 @@ function civicrm_api3_batch_get($params) { * {@getfields batch_delete} * @example BatchCreate.php * - * @param $params + * @param array $params * * @return array of deleted values. * @access public diff --git a/api/v3/Case.php b/api/v3/Case.php index bd30bd7331..40411b1376 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -396,11 +396,7 @@ function civicrm_api3_case_delete($params) { * * @param $options * - * @internal param $params - * - * @internal param $options - * - * @return array (reference) case object + * @return array case object */ function _civicrm_api3_case_read($caseId, $options) { $return = CRM_Utils_Array::value('return', $options, array()); diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index 521b0d6472..e0ec5eda0f 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -36,7 +36,7 @@ */ /** - * Function to create or update case type + * create or update case type * * @param array $params input parameters * @@ -68,9 +68,9 @@ function civicrm_api3_case_type_create($params) { } /** - * Function to retrieve case types + * retrieve case types * - * @param $params + * @param array $params * * @return array $caseTypes case types keyed by id * @access public @@ -85,7 +85,7 @@ function civicrm_api3_case_type_get($params) { } /** - * Function to format definition + * format definition * * @param $caseTypes * @return mixed diff --git a/api/v3/Constant.php b/api/v3/Constant.php index f242307ebc..9b4d1c225a 100644 --- a/api/v3/Constant.php +++ b/api/v3/Constant.php @@ -137,7 +137,7 @@ function civicrm_api3_constant_get($params) { } /** - * @param $params + * @param array $params */ function _civicrm_api3_constant_get_spec(&$params) { $options = array( diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 3db94b1622..36c02f416d 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -155,7 +155,7 @@ function civicrm_api3_contact_get($params) { } /** - * @param $params + * @param array $params * * @return int */ @@ -292,7 +292,7 @@ function civicrm_api3_contact_delete($params) { /** - * @param $params + * @param array $params * @param bool $dupeCheck * @param bool $dupeErrorArray * @param bool $obsoletevalue @@ -396,7 +396,7 @@ function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeE * @param array $params (reference ) an assoc array of name/value pairs * @param int $contactID if present the contact with that ID is updated * - * @return object CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact object * @access public * @static */ @@ -881,7 +881,7 @@ function civicrm_api3_contact_merge($params) { } /** - * @param $params + * @param array $params */ function _civicrm_api3_contact_proximity_spec(&$params) { $params['latitude']['api.required'] = 1; @@ -893,7 +893,7 @@ function _civicrm_api3_contact_proximity_spec(&$params) { } /** - * @param $params + * @param array $params * * @return array * @throws Exception diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 878deb7d41..eaae6f06d0 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -202,11 +202,7 @@ function _civicrm_api3_contribution_delete_spec(&$params) { * * @param array $params (reference ) input parameters * - * @internal param array $returnProperties Which properties should be included in the - * returned Contribution object. If NULL, the default - * set of properties will be included. - * - * @return array (reference ) array of contributions, if error an array with an error id and error message + * @return array of contributions, if error an array with an error id and error message * @static void * @access public * {@getfields Contribution_get} @@ -446,7 +442,7 @@ function civicrm_api3_contribution_completetransaction(&$params) { /** * provide function metadata - * @param $params + * @param array $params */ function _civicrm_api3_contribution_completetransaction_spec(&$params) { $params['id'] = array( diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index adc3f3b4a5..cd1574e742 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -143,37 +143,20 @@ function civicrm_api3_custom_field_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } -/* - * Helper function to validate custom field values - * - * @params Array $params Custom fields with values - * @params Array $errors Reference fields to be check with - * @params Boolean $checkForDisallowed Check for disallowed elements - * in params - * @params Boolean $checkForRequired Check for non present required elements - * in params - * @return Array Validation errors - */ - /** * Helper function to validate custom field value + * @deprecated * - * @params String $fieldName Custom field name (eg: custom_8 ) - * @params Mixed $value Field value to be validate - * @params Array $fieldDetails Field Details - * @params Array $errors Collect validation errors - * - * @param $fieldName - * @param $value - * @param $fieldDetails - * @param array $errors + * @param String $fieldName Custom field name (eg: custom_8 ) + * @param Mixed $value Field value to be validate + * @param Array $fieldDetails Field Details + * @param Array $errors Collect validation errors * - * @return Array Validation errors + * @return array Validation errors * @todo remove this function - not in use but need to review functionality before * removing as it might be useful in wrapper layer */ -function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = array( - )) { +function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = array()) { return; //see comment block if (!$value) { diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index 5dd797e05d..c47b80aa7e 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -5,9 +5,7 @@ * * FIXME This is a bare-minimum placeholder * - * @param $params - * - * @internal param $array $ params input parameters + * @param array $params * * {@example OptionValueGet.php 0} * @example OptionValueGet.php @@ -31,7 +29,7 @@ function civicrm_api3_custom_search_get($params) { * * {@example OptionValueCreate.php} * - * @param $params + * @param array $params * * @return array of newly created option_value property values. * {@getfields OptionValue_create} diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php index 4df7815f4b..b982e58d9d 100644 --- a/api/v3/DashboardContact.php +++ b/api/v3/DashboardContact.php @@ -84,7 +84,7 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) { } /** - * @param $params + * @param array $params * * @return array|null */ diff --git a/api/v3/Email.php b/api/v3/Email.php index fce0646ca8..aaf6e91cf9 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -43,7 +43,7 @@ * * @example EmailCreate.php Standard Create Example * - * @param $params + * @param array $params * * @return array API result array * {@getfields email_create} diff --git a/api/v3/Event.php b/api/v3/Event.php index 5bf0981b3b..322a516e4a 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -151,7 +151,6 @@ function civicrm_api3_event_get($params) { $event[$eventDAO->id]['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $eventDAO->id); } } - //end of the loop return civicrm_api3_create_success($event, $params, 'event', 'get', $eventDAO); } @@ -200,7 +199,7 @@ function civicrm_api3_event_delete($params) { /* /** - * Function to add 'is_full' & 'available_seats' to the return array. (this might be better in the BAO) + * add 'is_full' & 'available_seats' to the return array. (this might be better in the BAO) * Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form * * @param array $event return array of the event diff --git a/api/v3/Extension.php b/api/v3/Extension.php index 8ea07d1a6d..5fdefe2a5e 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -1,7 +1,4 @@ _entity, 'Create', $params); @@ -456,7 +456,7 @@ class civicrm_cli_csv_importer extends civicrm_cli_csv_file { class civicrm_cli_csv_deleter extends civicrm_cli_csv_file { /** - * @param $params + * @param array $params */ function processline($params) { $result = civicrm_api($this->_entity, 'Delete', $params); diff --git a/tests/extensions/test.extension.manager.paymenttest/main.php b/tests/extensions/test.extension.manager.paymenttest/main.php index fb683c3af9..b280aa471b 100644 --- a/tests/extensions/test.extension.manager.paymenttest/main.php +++ b/tests/extensions/test.extension.manager.paymenttest/main.php @@ -11,7 +11,7 @@ class test_extension_manager_paymenttest extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * @param array $paymentProcessor the details of the payment processor being invoked - * @param object $paymentForm reference to the form object if available + * @param CRM_Core_Form $paymentForm reference to the form object if available * @param boolean $force should we force a reload of this payment object * * @return object diff --git a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php index 98886b59e1..74a91049ca 100644 --- a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php +++ b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php @@ -280,7 +280,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivitiesCount BAO method + * test getActivitiesCount BAO method */ function testGetActivitiesCountforAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -309,7 +309,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivitiesCount BAO method + * test getActivitiesCount BAO method */ function testGetActivitiesCountforNonAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -339,7 +339,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivitiesCount BAO method + * test getActivitiesCount BAO method */ function testGetActivitiesCountforContactSummary() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); diff --git a/tests/phpunit/CRM/Contact/BAO/ContactTest.php b/tests/phpunit/CRM/Contact/BAO/ContactTest.php index 184744c7c2..1acfb30530 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactTest.php @@ -1338,7 +1338,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { // } /** - * function to build common params + * build common params * */ private function contactParams() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php index 1bc3dca770..7180400384 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php @@ -96,17 +96,13 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->household = Contact::create($this->householdParams); } - /* - * search with only type - * success expected. - */ + /** + * search with only type + * success expected. + */ function testSearchWithType() { - /* - * for type:Individual - */ - - $defaults = array(); + // for type:Individual $params = array('contact_type' => 'Individual', 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -132,10 +128,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertEquals($indiviParent['contact_type'], $this->indiviParentParams['contact_type'], 'In line ' . __LINE__); $this->assertEquals(end($indiviParent['contact_sub_type']), $this->indiviParentParams['contact_sub_type'], 'In line ' . __LINE__); - /* - * for type:Organization - */ - + // for type:Organization $params = array('contact_type' => 'Organization', 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -154,10 +147,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertEquals($orgSponsor['contact_type'], $this->orgSponsorParams['contact_type'], 'In line ' . __LINE__); $this->assertEquals(end($orgSponsor['contact_sub_type']), $this->orgSponsorParams['contact_sub_type'], 'In line ' . __LINE__); - /* - * for type:Household - */ - + // for type:Household $params = array('contact_type' => 'Household', 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -170,17 +160,13 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertNotContains('contact_sub_type', $household); } - /* - * search with only subtype - * success expected. - */ + /** + * search with only subtype + * success expected. + */ function testSearchWithSubype() { - /* - * for subtype:Student - */ - - $defaults = array(); + // for subtype:Student $params = array('contact_sub_type' => $this->student, 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -200,10 +186,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertNotContains($this->orgSponsor, $result['values']); $this->assertNotContains($this->household, $result['values']); - /* - * for subtype:Sponsor - */ - + // for subtype:Sponsor $params = array('contact_sub_type' => $this->sponsor, 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -224,17 +207,13 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertNotContains($this->household, $result['values']); } - /* - * search with type as well as subtype - * success expected. - */ + /** + * search with type as well as subtype + * success expected. + */ function testSearchWithTypeSubype() { - /* - * for type:individual subtype:Student - */ - - $defaults = array(); + // for type:individual subtype:Student $params = array('contact_sub_type' => $this->student, 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -254,10 +233,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertNotContains($this->orgSponsor, $result['values']); $this->assertNotContains($this->household, $result['values']); - /* - * for type:Organization subtype:Sponsor - */ - + // for type:Organization subtype:Sponsor $params = array('contact_sub_type' => $this->sponsor, 'version' => 3); $result = civicrm_api('contact', 'get', $params); @@ -278,13 +254,11 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertNotContains($this->household, $result['values']); } - /* - * search with invalid type or subtype - */ + /** + * search with invalid type or subtype + */ function testSearchWithInvalidData() { - // for invalid type - $defaults = array(); $params = array('contact_type' => 'Invalid' . CRM_Core_DAO::VALUE_SEPARATOR . 'Invalid', 'version' => 3); $result = civicrm_api('contact', 'get', $params); $this->assertEquals(empty($result['values']), TRUE, 'In line ' . __LINE__); @@ -314,9 +288,9 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { $this->assertEquals(empty($result['values']), TRUE, 'In line ' . __LINE__); } - /* search with wrong type or subtype - * - */ + /** + * search with wrong type or subtype + */ function testSearchWithWrongdData() { // for type:Individual subtype:Sponsor diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php index f05951b651..35e8258c40 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php @@ -63,10 +63,10 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { $this->subTypesHousehold[] = $params['name']; } - /* - * test contactTypes() and subTypes() methods with valid data - * success expected - */ + /** + * test contactTypes() and subTypes() methods with valid data + * success expected + */ function testGetMethods() { // check all contact types @@ -122,9 +122,9 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } } - /* - * test subTypes() methods with invalid data - */ + /** + * test subTypes() methods with invalid data + */ function testGetMethodsInvalid() { $params = 'invalid'; @@ -136,10 +136,10 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { $this->assertEquals(empty($result), TRUE, 'In line ' . __LINE__); } - /* - * test add() methods with valid data - * success expected - */ + /** + * test add() methods with valid data + * success expected + */ function testAdd() { $params = array( @@ -169,9 +169,9 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { CRM_Contact_BAO_ContactType::del($result->id); } - /* - * test add() with invalid data - */ + /** + * test add() with invalid data + */ function testAddInvalid1() { // parent id does not exist in db @@ -209,10 +209,10 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { $this->assertEquals($result, NULL, 'In line' . __LINE__); } - /* - * test del() with valid data - * success expected - */ + /** + * test del() with valid data + * success expected + */ function testDel() { $params = array( @@ -229,9 +229,9 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { $this->assertEquals(in_array($subtype->name, $result), TRUE, 'In line ' . __LINE__); } - /* - * test del() with invalid data - */ + /** + * test del() with invalid data + */ function testDelInvalid() { $del = CRM_Contact_BAO_ContactType::del(NULL); diff --git a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php index a2a22f6f56..7ad12dcd77 100644 --- a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php +++ b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php @@ -228,7 +228,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase { } /** - * @param $objects array(object) DAO or BAO objects + * @param $objects array DAO or BAO objects */ function registerTestObjects($objects) { //if (is_object($objects)) { diff --git a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php index f205eef9e2..d48561acef 100644 --- a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php +++ b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php @@ -898,7 +898,7 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase { } /** - * @param $objects array(object) DAO or BAO objects + * @param $objects array DAO or BAO objects */ function registerTestObjects($objects) { //if (is_object($objects)) { diff --git a/tests/phpunit/CRM/Core/BAO/CustomFieldTest.php b/tests/phpunit/CRM/Core/BAO/CustomFieldTest.php index 46f19e44a8..2cb6768f20 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomFieldTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomFieldTest.php @@ -122,7 +122,6 @@ class CRM_Core_BAO_CustomFieldTest extends CiviUnitTestCase { ); $getCustomFields = array(); $getCustomFields = CRM_Core_BAO_CustomField::getFields('Individual', TRUE, TRUE); - //CRM_Core_Error::debug('fdf',$getCustomFields); //$this->assertEquals( 'testFld1', $getCustomFields[$customFieldID1][0], 'Confirm First Custom field label' ); //$this->assertEquals( 'testFld2', $getCustomFields[$customFieldID2][0], 'Confirm Second Custom field label' ); diff --git a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php index 6f2461902e..c4534cc4e3 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php @@ -51,7 +51,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getTree() + * test getTree() */ function testGetTree() { $params = array(); @@ -91,7 +91,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test retrieve() with Empty Params + * test retrieve() with Empty Params */ function testRetrieveEmptyParams() { $params = array(); @@ -100,7 +100,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test retrieve() with Inalid Params + * test retrieve() with Inalid Params */ function testRetrieveInvalidParams() { $params = array('id' => 99); diff --git a/tests/phpunit/CRM/Core/BAO/CustomValueTableSetGetTest.php b/tests/phpunit/CRM/Core/BAO/CustomValueTableSetGetTest.php index 9543bee8b8..f07569b3d4 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomValueTableSetGetTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomValueTableSetGetTest.php @@ -22,10 +22,9 @@ class CRM_Core_BAO_CustomValueTableSetGetTest extends CiviUnitTestCase { parent::setUp(); } - /* - * Test setValues() and GetValues() methods with custom Date field - * - */ + /** + * Test setValues() and GetValues() methods with custom Date field + */ function testSetGetValuesDate() { $params = array(); $contactID = Contact::createIndividual(); @@ -121,10 +120,10 @@ class CRM_Core_BAO_CustomValueTableSetGetTest extends CiviUnitTestCase { Contact::delete($contactID); } - /* - * Test setValues() and getValues() methods with custom field YesNo(Boolean) Radio - * - */ + /** + * Test setValues() and getValues() methods with custom field YesNo(Boolean) Radio + * + */ function testSetGetValuesYesNoRadio() { $params = array(); $contactID = Contact::createIndividual(); diff --git a/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php b/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php index d93b649fa1..c7e6f5566e 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php @@ -23,10 +23,10 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { } - /* - * function to test store function for country - * - */ + /** + * test store function for country + * + */ function testStoreCountry() { $params = array(); $contactID = Contact::createIndividual(); @@ -58,10 +58,10 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { Contact::delete($contactID); } - /* - * function to test store function for file - * - */ + /** + * test store function for file + * + */ function atestStoreFile() { $params = array(); $contactID = Contact::createIndividual(); @@ -93,10 +93,10 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { Contact::delete($contactID); } - /* - * function to test store function for state province - * - */ + /** + * test store function for state province + * + */ function testStoreStateProvince() { $params = array(); $contactID = Contact::createIndividual(); @@ -121,17 +121,16 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { )); CRM_Core_BAO_CustomValueTable::store($params, 'civicrm_contact', $contactID); - // $this->assertDBCompareValue('CRM_Custom_DAO_CustomValue', ) Custom::deleteField($customField); Custom::deleteGroup($customGroup); Contact::delete($contactID); } - /* - * function to test store function for date - * - */ + /** + * test store function for date + * + */ function testStoreDate() { $params = array(); $contactID = Contact::createIndividual(); @@ -163,10 +162,10 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { Contact::delete($contactID); } - /* - * function to test store function for rich text editor - * - */ + /** + * Test store function for rich text editor + * + */ function testStoreRichTextEditor() { $params = array(); $contactID = Contact::createIndividual(); @@ -198,10 +197,10 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { Contact::delete($contactID); } - /* - * function to test getEntityValues function for stored value - * - */ + /** + * test getEntityValues function for stored value + * + */ function testgetEntityValues() { $params = array(); diff --git a/tests/phpunit/CRM/Core/Payment/BaseIPNTest.php b/tests/phpunit/CRM/Core/Payment/BaseIPNTest.php index 1cc81efbd6..1669d3d64d 100644 --- a/tests/phpunit/CRM/Core/Payment/BaseIPNTest.php +++ b/tests/phpunit/CRM/Core/Payment/BaseIPNTest.php @@ -183,9 +183,10 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { $this->assertContains('

Please print this confirmation for your records.

', $msg['html']); $this->assertContains('Membership Type: General', $msg['body']); } - /* - * Test that loadObjects works with participant values - */ + + /** + * Test that loadObjects works with participant values + */ function testLoadParticipantObjects() { $this->_setUpParticipantObjects(); $this->IPN->loadObjects($this->input, $this->ids, $this->objects, FALSE, $this->_processorId); @@ -200,7 +201,6 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { /** * Test the LoadObjects function with a participant - * */ function testComposeMailParticipant() { $this->_setUpParticipantObjects(); @@ -213,7 +213,6 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { } /** - * * */ function testComposeMailParticipantObjects() { @@ -228,7 +227,6 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { /** * Test the LoadObjects function with recurring membership data - * */ function testsendMailParticipantObjectsCheckLog() { $this->_setUpParticipantObjects(); @@ -244,9 +242,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { ); $mut->stop(); } + /** * Test the LoadObjects function with recurring membership data - * */ function testsendMailParticipantObjectsNoMail() { $this->_setUpParticipantObjects(); @@ -267,9 +265,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { $mut->stop(); } - /* - * Test that loadObjects works with participant values - */ + /** + * Test that loadObjects works with participant values + */ function testLoadPledgeObjects() { $this->_setUpPledgeObjects(); $this->IPN->loadObjects($this->input, $this->ids, $this->objects, FALSE, $this->_processorId); @@ -285,9 +283,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { $this->assertEquals($this->_pledgeId, $this->objects['pledge_payment'][0]->pledge_id); } - /* - * Test that loadObjects works with participant values - */ + /** + * Test that loadObjects works with participant values + */ function testLoadPledgeObjectsInvalidPledgeID() { $this->_setUpPledgeObjects(); $this->ids['pledge_payment'][0] = 0; @@ -448,10 +446,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { } } - /* - * Prepare for contribution Test - involving only contribution objects - */ /** + * Prepare for contribution Test - involving only contribution objects + * * @param bool $contributionPage */ function _setUpContributionObjects($contributionPage = FALSE) { @@ -486,9 +483,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { ); } - /* - * Prepare for membership test - */ + /** + * Prepare for membership test + */ function _setUpMembershipObjects() { try { $this->_membershipTypeID = $this->membershipTypeCreate(); @@ -561,9 +558,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { $this->ids['contributionRecur'] = $this->_recurId; } - /* - * Set up participant requirements for test - */ + /** + * Set up participant requirements for test + */ function _setUpParticipantObjects() { $event = $this->eventCreate(array('is_email_confirm' => 1)); $this->assertAPISuccess($event, 'line ' . __LINE__ . ' set-up of event'); @@ -596,9 +593,9 @@ class CRM_Core_Payment_BaseIPNTest extends CiviUnitTestCase { $this->ids['event'] = $this->_eventId; } - /* - * Set up participant requirements for test - */ + /** + * Set up participant requirements for test + */ function _setUpPledgeObjects() { $this->_pledgeId = $this->pledgeCreate($this->_contactId); //we'll create membership payment here because to make setup more re-usable diff --git a/tests/phpunit/CRM/Core/TransactionTest.php b/tests/phpunit/CRM/Core/TransactionTest.php index 0c58d73a8a..e154457348 100644 --- a/tests/phpunit/CRM/Core/TransactionTest.php +++ b/tests/phpunit/CRM/Core/TransactionTest.php @@ -223,7 +223,6 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase { } /** - * * @param string $createStyle 'sql-insert'|'bao-create' * @param string $commitStyle 'implicit-commit'|'explicit-commit' * @dataProvider dataCreateAndCommitStyles @@ -238,7 +237,6 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase { } /** - * * @param string $createStyle 'sql-insert'|'bao-create' * @param string $commitStyle 'implicit-commit'|'explicit-commit' * @dataProvider dataCreateAndCommitStyles @@ -277,7 +275,6 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase { } /** - * * @param array $existsByOffset array(int $cidOffset => bool $expectExists) * @param int $generalOffset */ diff --git a/tests/phpunit/CRM/Member/BAO/MembershipTest.php b/tests/phpunit/CRM/Member/BAO/MembershipTest.php index 93623c243e..9b48291b64 100644 --- a/tests/phpunit/CRM/Member/BAO/MembershipTest.php +++ b/tests/phpunit/CRM/Member/BAO/MembershipTest.php @@ -337,10 +337,10 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { } - /* - * Function to get the contribution - * page id from the membership record - */ + /** + * get the contribution + * page id from the membership record + */ function testgetContributionPageId() { $contactId = Contact::createIndividual(); @@ -366,12 +366,12 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { $this->membershipDelete($membershipId); Contact::delete($contactId); } - /* - * Function to get membership joins/renewals - * for a specified membership - * type. - * - */ + /** + * Get membership joins/renewals + * for a specified membership + * type. + * + */ function testgetMembershipStarts() { $contactId = Contact::createIndividual(); @@ -399,11 +399,11 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { Contact::delete($contactId); } - /* - * Function to get a count of membership for a specified membership type, - * optionally for a specified date. - * - */ + /** + * Get a count of membership for a specified membership type, + * optionally for a specified date. + * + */ function testGetMembershipCount() { $contactId = Contact::createIndividual(); @@ -432,11 +432,11 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { } - /* - * Function take sort name of contact during - * batch update member via profile - * - */ + /** + * Take sort name of contact during + * batch update member via profile + * + */ function testsortName() { $contactId = Contact::createIndividual(); @@ -468,10 +468,10 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { Contact::delete($contactId); } - /* - * Function to delete related memberships - * - */ + /** + * Delete related memberships + * + */ function testdeleteRelatedMemberships() { $contactId = Contact::createIndividual(); @@ -499,10 +499,10 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { Contact::delete($contactId); } - /* - * Function to renew membership with change in membership type - * - */ + /** + * Renew membership with change in membership type + * + */ function testRenewMembership() { $contactId = Contact::createIndividual(); $joinDate = $startDate = date("Ymd", strtotime(date("Ymd") . " -6 month")); @@ -562,10 +562,10 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { Contact::delete($contactId); } - /* - * Function to renew stale membership - * - */ + /** + * Renew stale membership + * + */ function testStaleMembership() { $statusId = 3; $contactId = Contact::createIndividual(); diff --git a/tests/phpunit/CRM/PCP/BAO/PCPTest.php b/tests/phpunit/CRM/PCP/BAO/PCPTest.php index 40a6a70682..7747581889 100644 --- a/tests/phpunit/CRM/PCP/BAO/PCPTest.php +++ b/tests/phpunit/CRM/PCP/BAO/PCPTest.php @@ -141,7 +141,7 @@ class CRM_PCP_BAO_PCPTest extends CiviUnitTestCase { } /** - * function to build params + * build params * */ private function pcpBlockParams() { @@ -166,7 +166,7 @@ class CRM_PCP_BAO_PCPTest extends CiviUnitTestCase { } /** - * function to build params + * build params * */ private function pcpParams() { diff --git a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php index 2501fe603f..6a52816b5b 100644 --- a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php +++ b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php @@ -181,9 +181,6 @@ class CRM_Utils_Migrate_ImportExportTest extends CiviUnitTestCase { * @param $inputXmlFilePath * * @throws CRM_Core_Exception - * @internal param $customGroupParams - * @internal param $fieldParams - * @internal param $expectedXmlFilePath * @dataProvider basicXmlTestCases */ function testBasicXMLImports($expectCustomGroup, $expectCustomField, $inputXmlFilePath) { diff --git a/tests/phpunit/CiviTest/AuthorizeNet.php b/tests/phpunit/CiviTest/AuthorizeNet.php index f39e0027d4..ada476fee0 100644 --- a/tests/phpunit/CiviTest/AuthorizeNet.php +++ b/tests/phpunit/CiviTest/AuthorizeNet.php @@ -4,13 +4,9 @@ * Class AuthorizeNet */ class AuthorizeNet extends PHPUnit_Framework_Testcase { - /* - * Helper function to create - * a payment processor of type Authorize.net - * - * @return $paymentProcessor id of created payment processor - */ /** + * Helper function to create + * a payment processor of type Authorize.net * @return CRM_Financial_DAO_PaymentProcessor */ function create() { @@ -35,18 +31,13 @@ class AuthorizeNet extends PHPUnit_Framework_Testcase { return $paymentProcessor; } - /* - * Helper function to delete a PayPal Pro - * payment processor - * @param int $id - id of the PayPal Pro payment processor - * to be deleted - * @return boolean true if payment processor deleted, false otherwise - * - */ /** - * @param $id + * Helper function to delete a PayPal Pro + * payment processor + * @param int $id - id of the PayPal Pro payment processor + * to be deleted + * @return boolean true if payment processor deleted, false otherwise * - * @return mixed */ function delete($id) { $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor(); diff --git a/tests/phpunit/CiviTest/CiviDBAssert.php b/tests/phpunit/CiviTest/CiviDBAssert.php index bddce13efb..0d3b9b806d 100644 --- a/tests/phpunit/CiviTest/CiviDBAssert.php +++ b/tests/phpunit/CiviTest/CiviDBAssert.php @@ -121,7 +121,7 @@ class CiviDBAssert { * Compare a single column value in a retrieved DB record to an expected value * * @param $testCase - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index aa429cf37d..f05698cdec 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -505,19 +505,17 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { //$this->assertContains($sortName, $this->getValue('contact_1'), "autocomplete expected $sortName but didn’t find it in " . $this->getValue('contact_1')); } - /* - * 1. By default, when no strtotime arg is specified, sets date to "now + 1 month" - * 2. Does not set time. For setting both date and time use webtestFillDateTime() method. - * 3. Examples of $strToTime arguments - - * webtestFillDate('start_date',"now") - * webtestFillDate('start_date',"10 September 2000") - * webtestFillDate('start_date',"+1 day") - * webtestFillDate('start_date',"+1 week") - * webtestFillDate('start_date',"+1 week 2 days 4 hours 2 seconds") - * webtestFillDate('start_date',"next Thursday") - * webtestFillDate('start_date',"last Monday") - */ /** + * 1. By default, when no strtotime arg is specified, sets date to "now + 1 month" + * 2. Does not set time. For setting both date and time use webtestFillDateTime() method. + * 3. Examples of $strToTime arguments - + * webtestFillDate('start_date',"now") + * webtestFillDate('start_date',"10 September 2000") + * webtestFillDate('start_date',"+1 day") + * webtestFillDate('start_date',"+1 week") + * webtestFillDate('start_date',"+1 week 2 days 4 hours 2 seconds") + * webtestFillDate('start_date',"next Thursday") + * webtestFillDate('start_date',"last Monday") * @param $dateElement * @param null $strToTimeArgs */ @@ -536,8 +534,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { $this->click("link=$day"); } - // 1. set both date and time. /** + * 1. set both date and time. * @param $dateElement * @param null $strToTimeArgs */ @@ -1333,12 +1331,11 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * Function to update default strict rule. + * update default strict rule. * - * @params string $contactType Contact type * @param string $contactType - * @param array $fields Fields to be set for strict rule - * @param Integer $threshold Rule's threshold value + * @param array $fields Fields to be set for strict rule + * @param int $threshold Rule's threshold value */ function webtestStrictDedupeRuleDefault($contactType = 'Individual', $fields = array(), $threshold = 10) { // set default strict rule. @@ -1608,7 +1605,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Request a record from the DB by seachColumn+searchValue. Success if a record is found. /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -1626,7 +1623,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -1642,7 +1639,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Request a record from the DB by id. Success if row not found. /** - * @param $daoName + * @param string $daoName * @param $id * @param $message */ @@ -1656,7 +1653,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Compare a single column value in a retrieved DB record to an expected value /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -1677,7 +1674,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Compare all values in a single retrieved DB record to an array of expected values /** - * @param $daoName + * @param string $daoName * @param $searchParams * @param $expectedValues */ @@ -2199,7 +2196,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * function to type and select first occurance of autocomplete + * type and select first occurance of autocomplete */ function select2($fieldName,$label, $multiple = FALSE, $xpath=FALSE) { // In the case of chainSelect, wait for options to load @@ -2231,7 +2228,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * function to select multiple options + * select multiple options */ function multiselect2($fieldid, $params) { // In the case of chainSelect, wait for options to load diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index ae0ab826ff..3eea6f067f 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -538,7 +538,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by seachColumn+searchValue. Success if a record is found. /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -559,7 +559,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -572,7 +572,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by id. Success if row not found. /** - * @param $daoName + * @param string $daoName * @param $id * @param null $message */ @@ -584,7 +584,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by id. Success if row not found. /** - * @param $daoName + * @param string $daoName * @param $id * @param null $message */ @@ -596,7 +596,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Compare a single column value in a retrieved DB record to an expected value /** - * @param $daoName + * @param string $daoName * @param $searchValue * @param $returnColumn * @param $searchColumn @@ -612,7 +612,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Compare all values in a single retrieved DB record to an array of expected values /** - * @param $daoName + * @param string $daoName * @param $searchParams * @param $expectedValues */ @@ -781,11 +781,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * check that api returned 'is_error' => 1 * else provide full message - * @param $result + * @param array $result * @param $expected * @param array $valuesToExclude * @param string $prefix extra test to add to message - * @internal param array $apiResult api result */ function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') { $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential')); @@ -805,7 +804,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param $entity * @param $action - * @param $params + * @param array $params * @return array|int */ function civicrm_api($entity, $action, $params) { @@ -1082,10 +1081,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Private helper function for calling civicrm_contact_add * - * @param $params + * @param array $params for civicrm_contact_add api function call * * @throws Exception - * @internal param \parameters $array for civicrm_contact_add api function call * * @return int id of Household created */ @@ -1163,7 +1161,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param $params + * @param array $params * * @return mixed */ @@ -1186,10 +1184,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete Membership Type + * delete Membership Type * - * @param $params - * @internal param int $membershipTypeID + * @param array $params */ function membershipTypeDelete($params) { $this->callAPISuccess('MembershipType', 'Delete', $params); @@ -1256,7 +1253,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete Relatinship Type + * delete Relatinship Type * * @param int $relationshipTypeID */ @@ -1290,7 +1287,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create Participant + * create Participant * * @param array $params array of contact id and event id values * @@ -1342,7 +1339,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create contribution page * - * @param $params + * @param array $params * @return object of contribution page */ function contributionPageCreate($params) { @@ -1409,8 +1406,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param int $cID contact_id * - * @internal param int $cTypeID id of financial type - * * @return int id of created contribution */ function pledgeCreate($cID) { @@ -1436,8 +1431,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete contribution * - * @param $pledgeId - * @internal param int $contributionId + * @param int $pledgeId */ function pledgeDelete($pledgeId) { $params = array( @@ -1486,7 +1480,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create online contribution * - * @param $params + * @param array $params * @param int $financialType id of financial type * * @param int $invoiceID @@ -1656,10 +1650,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete Locations of contact * - * @params array $pamars parameters + * @param array $params parameters */ function locationDelete($params) { - $result = $this->callAPISuccess('Location', 'delete', $params); + $this->callAPISuccess('Location', 'delete', $params); } /** @@ -1701,8 +1695,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to add a Group * - * @params array to add group - * * @param array $params * @return int groupId of created group */ @@ -1727,8 +1719,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete a Group * - * @param $gid - * @internal param int $id + * @param int $gid */ function groupDelete($gid) { @@ -1817,7 +1808,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Function to delete Group for a contact * * @param $contactId - * @internal param array $params */ function contactGroupDelete($contactId) { $params = array( @@ -1830,9 +1820,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create Activity * - * @param null $params + * @param array $params * @return array|int - * @internal param int $contactId */ function activityCreate($params = NULL) { @@ -1874,7 +1863,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create an activity type * - * @params array $params parameters + * @param array $params parameters */ function activityTypeCreate($params) { $result = $this->callAPISuccess('ActivityType', 'create', $params); @@ -1884,7 +1873,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete activity type * - * @params Integer $activityTypeId id of the activity type + * @param int $activityTypeId id of the activity type */ function activityTypeDelete($activityTypeId) { $params['activity_type_id'] = $activityTypeId; @@ -1897,8 +1886,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param array $params * @return array|int - * @internal param string $className - * @internal param string $title name of custom group */ function customGroupCreate($params = array()) { $defaults = array( @@ -1976,8 +1963,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * participant:testCreateWithCustom for how to use this * * @param string $function __FUNCTION__ - * @param $filename - * @internal param string $file __FILE__ + * @param $filename string $file __FILE__ * * @return array $ids ids of created objects */ @@ -2009,8 +1995,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param array $params (custom_group_id) is required * @return array|int - * @internal param string $name name of custom field - * @internal param int $apiversion API version to use */ function customFieldCreate($params) { $params = array_merge(array( @@ -2048,8 +2032,6 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create note * - * @params array $params name-value pair for an event - * * @param $cId * @return array $note */ @@ -2198,9 +2180,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Tidy up examples array so that fields that change often ..don't * and debug related fields are unset * - * @param $result + * @param array $result * - * @internal param array $params */ function tidyExampleResult(&$result){ if(!is_array($result)) { @@ -2276,8 +2257,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete note * - * @params int $noteID + * @param array $params * + * @return array|int */ function noteDelete($params) { return $this->callAPISuccess('Note', 'delete', $params); @@ -2424,7 +2406,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) * */ /** - * @param $params + * @param array $params * @param $id * @param $entity * @param int $delete diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php index b5aa0dfc87..c0ded3fa4c 100644 --- a/tests/phpunit/CiviTest/Contact.php +++ b/tests/phpunit/CiviTest/Contact.php @@ -8,7 +8,7 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact * - * @param $params + * @param array $params * * @return int $contactID id of created contact */ diff --git a/tests/phpunit/CiviTest/Custom.php b/tests/phpunit/CiviTest/Custom.php index fe871a49f0..0310b92e88 100644 --- a/tests/phpunit/CiviTest/Custom.php +++ b/tests/phpunit/CiviTest/Custom.php @@ -61,7 +61,7 @@ class Custom extends CiviUnitTestCase { /** * Helper function to create Custom Field * @deprecated use parent object create fn - * @param $params + * @param array $params * @param null $fields * @return object of created field */ diff --git a/tests/phpunit/CiviTest/Event.php b/tests/phpunit/CiviTest/Event.php index 705a66cef6..8483460f20 100644 --- a/tests/phpunit/CiviTest/Event.php +++ b/tests/phpunit/CiviTest/Event.php @@ -36,8 +36,7 @@ class Event extends PHPUnit_Framework_Testcase { /** * Helper function to delete an Event * - * @param $eventId - * @internal param int $eventID id of the event to delete + * @param int $eventId * @return boolean true if event deleted, false otherwise */ static function delete($eventId) { diff --git a/tests/phpunit/CiviTest/Participant.php b/tests/phpunit/CiviTest/Participant.php index cdd40bd875..031ce481ee 100644 --- a/tests/phpunit/CiviTest/Participant.php +++ b/tests/phpunit/CiviTest/Participant.php @@ -33,8 +33,7 @@ class Participant extends PHPUnit_Framework_Testcase { /** * Helper function to delete a participant * - * @param $participantId - * @internal param int $participantID id of the participant to delete + * @param int $participantId * @return boolean true if participant deleted, false otherwise */ static function delete($participantId) { diff --git a/tests/phpunit/WebTest/Contact/AdvanceSearchPaneTest.php b/tests/phpunit/WebTest/Contact/AdvanceSearchPaneTest.php index 29c68b58d2..83e2d0bbee 100644 --- a/tests/phpunit/WebTest/Contact/AdvanceSearchPaneTest.php +++ b/tests/phpunit/WebTest/Contact/AdvanceSearchPaneTest.php @@ -36,7 +36,7 @@ class WebTest_Contact_AdvanceSearchPaneTest extends CiviSeleniumTestCase { } /* - * Function to test individual pane seperatly. + * test individual pane seperatly. */ function testIndividualPanes() { $this->webtestLogin(); @@ -62,7 +62,7 @@ class WebTest_Contact_AdvanceSearchPaneTest extends CiviSeleniumTestCase { } /* - * Function to test by selecting all panes at a time. + * test by selecting all panes at a time. */ function testAllPanes() { $this->webtestLogin(); diff --git a/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php b/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php index 92861a07d8..0f58868dc2 100644 --- a/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php +++ b/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php @@ -36,7 +36,7 @@ class WebTest_Contact_SearchbyDateFilterTest extends CiviSeleniumTestCase { } /* - * Function to test individual pane seperatly. + * test individual pane seperatly. */ function testAdvancedSearch() { $this->webtestLogin(); diff --git a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php index b8ade41317..10c7e46240 100644 --- a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php @@ -312,7 +312,7 @@ class WebTest_Contribute_OfflineContributionTest extends CiviSeleniumTestCase { //common function for doing offline contribution /** - * @param $params + * @param array $params * @param $firstName * @param $lastName * @param $processorName diff --git a/tests/phpunit/WebTest/Event/AddPricesetTest.php b/tests/phpunit/WebTest/Event/AddPricesetTest.php index c958539a75..e7bdbe2ae1 100644 --- a/tests/phpunit/WebTest/Event/AddPricesetTest.php +++ b/tests/phpunit/WebTest/Event/AddPricesetTest.php @@ -498,7 +498,7 @@ class WebTest_Event_AddPricesetTest extends CiviSeleniumTestCase { } /** - * Function to test to regiter participant for event with + * test to regiter participant for event with * multiple price fields in price-set * CRM-11986 diff --git a/tests/phpunit/WebTest/Event/ParticipantCountTest.php b/tests/phpunit/WebTest/Event/ParticipantCountTest.php index 0993e50767..93bd04debe 100644 --- a/tests/phpunit/WebTest/Event/ParticipantCountTest.php +++ b/tests/phpunit/WebTest/Event/ParticipantCountTest.php @@ -331,7 +331,7 @@ class WebTest_Event_ParticipantCountTest extends CiviSeleniumTestCase { } /** - * @param $params + * @param array $params * * @return string */ diff --git a/tests/phpunit/WebTest/Event/PricesetMaxCountTest.php b/tests/phpunit/WebTest/Event/PricesetMaxCountTest.php index 02e8afe874..7064cc4442 100644 --- a/tests/phpunit/WebTest/Event/PricesetMaxCountTest.php +++ b/tests/phpunit/WebTest/Event/PricesetMaxCountTest.php @@ -1117,7 +1117,7 @@ class WebTest_Event_PricesetMaxCountTest extends CiviSeleniumTestCase { } /** - * @param $params + * @param array $params * * @return string */ diff --git a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php index 45519dc919..4f54b5da1d 100644 --- a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php @@ -32,15 +32,11 @@ require_once 'CiviTest/CiviSeleniumTestCase.php'; class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { /** - * Function to download CSV file. + * download CSV file. * - * @params string $selector element selector(download button in most of the cases). - * @params sting $fileName file name to be download. - * @params string $downloadDir download dir. - * - * @param $selector - * @param string $fileName - * @param string $downloadDir + * @param string $selector element selector(download button in most of the cases). + * @param string $fileName file name to be download. + * @param string $downloadDir download dir. * * @return string downloaded file path. */ @@ -67,12 +63,12 @@ class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { } /** - * Function to read CSV file and fire provided assertions. + * read CSV file and fire provided assertions. * - * @params string $file file path of CSV file. - * @params array $checkHeaders check first row of csv + * @param string $file file path of CSV file. + * @param array $checkColumns check first row of csv * independent of index. - * @params array $checkRows array of header and rows according to row index + * @param array $checkRows array of header and rows according to row index * eg: array( * 1 => array( // Row index 1 @@ -86,11 +82,10 @@ class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { * 'Last Name' => 'mayekar' * ), * ); - * @params int $rowCount count rows (excluding header row). - * @params array $settings used for override settings. + * @param int $rowCount count rows (excluding header row). + * @param array $settings used for override settings. */ - function reviewCSV($file, $checkColumns = array( - ), $checkRows = array(), $rowCount = 0, $settings = array()) { + function reviewCSV($file, $checkColumns = array(), $checkRows = array(), $rowCount = 0, $settings = array()) { // Check file exists before proceed. $this->assertTrue(($file && file_exists($file)), "Not able to locate {$file}."); diff --git a/tests/phpunit/WebTest/Import/AddressImportTest.php b/tests/phpunit/WebTest/Import/AddressImportTest.php index 0f76fb87eb..8ec32e417a 100644 --- a/tests/phpunit/WebTest/Import/AddressImportTest.php +++ b/tests/phpunit/WebTest/Import/AddressImportTest.php @@ -65,10 +65,9 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { } } - /* - * Helper function to provide data for custom data import. - */ /** + * Helper function to provide data for custom data import. + * * @param $customDataParams * @param $firstName1 * @@ -77,30 +76,30 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { function _individualCustomCSVData($customDataParams, $firstName1) { $headers = array( - 'first_name' => 'First Name', - 'last_name' => 'Last Name', - 'address_1' => 'Additional Address 1', - 'address_2' => 'Additional Address 2', - 'city' => 'City', - 'state' => 'State', - 'country' => 'Country', - ); + 'first_name' => 'First Name', + 'last_name' => 'Last Name', + 'address_1' => 'Additional Address 1', + 'address_2' => 'Additional Address 2', + 'city' => 'City', + 'state' => 'State', + 'country' => 'Country', + ); foreach( $customDataParams['headers'] as $key =>$value){ $headers[$key] = $value; } $rows = array( 0 => - array( - 'first_name' => $firstName1, - 'last_name' => 'Anderson', - 'address_1' => 'Add 1', - 'address_2' => 'Add 2', - 'city' => 'Watson', - 'state' => 'NY', - 'country' => 'United States', - ), - ); + array( + 'first_name' => $firstName1, + 'last_name' => 'Anderson', + 'address_1' => 'Add 1', + 'address_2' => 'Add 2', + 'city' => 'Watson', + 'state' => 'NY', + 'country' => 'United States', + ), + ); foreach ($customDataParams['rows'][0] as $key => $values) { $rows[0][$key] = $values; } @@ -200,7 +199,7 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { $customField6 = 'Customfield_alp_multiselect' . substr(sha1(rand()), 0, 4); $customFieldId6 = $this->_createMultipleValueCustomField($customField6,'Multi-Select'); - // create custom field - "alphanumeric advmultiselect" + // create custom field - "alphanumeric advmultiselect" $this->click("newCustomField"); $this->waitForElementPresent('_qf_Field_done-bottom'); $customField7 = 'Customfield_alp_advmultiselect' . substr(sha1(rand()), 0, 4); @@ -243,48 +242,49 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { $customFieldId10 = explode('&id=', $this->getAttribute("xpath=//div[@id='field_page']//table/tbody//tr/td/span[text()='$customField10']/../../td[8]/span/a@href")); $customFieldId10 = $customFieldId10[1]; - return array('headers' => - - array("custom_{$customFieldId}" => "$customField :: $customGroupTitle", - "custom_{$customFieldId3}" => "$customField3 :: $customGroupTitle", - "custom_{$customFieldId4}" => "$customField4 :: $customGroupTitle", - "custom_{$customFieldId5}" => "$customField5 :: $customGroupTitle", - "custom_{$customFieldId6}" => "$customField6 :: $customGroupTitle", - "custom_{$customFieldId7}" => "$customField7 :: $customGroupTitle", - "custom_{$customFieldId8}" => "$customField8 :: $customGroupTitle", - "custom_{$customFieldId1}" => "$customField1 :: $customGroupTitle", - "custom_{$customFieldId2}" => "$customField2 :: $customGroupTitle", - "custom_{$customFieldId9}" => "$customField9 :: $customGroupTitle", - "custom_{$customFieldId10}" => "$customField10 :: $customGroupTitle", - ), - 'rows' => - array( 0 => array("custom_{$customFieldId}" => "This is a test field", - "custom_{$customFieldId3}" => "label1", - "custom_{$customFieldId4}" => "label1", - "custom_{$customFieldId5}" => "label1", - "custom_{$customFieldId6}" => "label1", - "custom_{$customFieldId7}" => "label1", - "custom_{$customFieldId8}" => "label1", - "custom_{$customFieldId1}" => 1, - "custom_{$customFieldId2}" => 12345, - "custom_{$customFieldId9}" => 123456, - "custom_{$customFieldId10}" => "2009-12-31", - ), - ), - 'customFields' => array( - $customField => 'This is a test field', - $customField3 => 'label1', - $customField4 => 'label1', - $customField5 => 'label1', - $customField6 => 'label1', - $customField7 => 'label1', - $customField8 => 'label1', - $customField1 => '1', - $customField2 => '12345', - $customField9 => '123,456.00', - $customField10 => 'December 31st, 2009', - ), - ); + return array( + 'headers' => array( + "custom_{$customFieldId}" => "$customField :: $customGroupTitle", + "custom_{$customFieldId3}" => "$customField3 :: $customGroupTitle", + "custom_{$customFieldId4}" => "$customField4 :: $customGroupTitle", + "custom_{$customFieldId5}" => "$customField5 :: $customGroupTitle", + "custom_{$customFieldId6}" => "$customField6 :: $customGroupTitle", + "custom_{$customFieldId7}" => "$customField7 :: $customGroupTitle", + "custom_{$customFieldId8}" => "$customField8 :: $customGroupTitle", + "custom_{$customFieldId1}" => "$customField1 :: $customGroupTitle", + "custom_{$customFieldId2}" => "$customField2 :: $customGroupTitle", + "custom_{$customFieldId9}" => "$customField9 :: $customGroupTitle", + "custom_{$customFieldId10}" => "$customField10 :: $customGroupTitle", + ), + 'rows' => array( + 0 => array( + "custom_{$customFieldId}" => "This is a test field", + "custom_{$customFieldId3}" => "label1", + "custom_{$customFieldId4}" => "label1", + "custom_{$customFieldId5}" => "label1", + "custom_{$customFieldId6}" => "label1", + "custom_{$customFieldId7}" => "label1", + "custom_{$customFieldId8}" => "label1", + "custom_{$customFieldId1}" => 1, + "custom_{$customFieldId2}" => 12345, + "custom_{$customFieldId9}" => 123456, + "custom_{$customFieldId10}" => "2009-12-31", + ), + ), + 'customFields' => array( + $customField => 'This is a test field', + $customField3 => 'label1', + $customField4 => 'label1', + $customField5 => 'label1', + $customField6 => 'label1', + $customField7 => 'label1', + $customField8 => 'label1', + $customField1 => '1', + $customField2 => '12345', + $customField9 => '123,456.00', + $customField10 => 'December 31st, 2009', + ), + ); } /** diff --git a/tests/phpunit/WebTest/Import/AddressParsingTest.php b/tests/phpunit/WebTest/Import/AddressParsingTest.php index ff9ba23324..98a8e4565e 100644 --- a/tests/phpunit/WebTest/Import/AddressParsingTest.php +++ b/tests/phpunit/WebTest/Import/AddressParsingTest.php @@ -36,7 +36,7 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { } /** - * Function to check for Valid Street Address + * check for Valid Street Address */ function testValidStreetAddressParsing() { $this->webtestLogin(); @@ -90,9 +90,9 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { $this->waitForPageToLoad($this->getTimeoutMsec()); } - /* - * Function to check for Invalid Street Address - */ + /** + * check for Invalid Street Address + */ function testInvalidStreetAddressParsing() { $this->webtestLogin(); @@ -147,7 +147,7 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { } /** - * Function to check Street Address when Address Parsing is Disabled + * Check Street Address when Address Parsing is Disabled */ function testStreetAddress() { $this->webtestLogin(); @@ -182,10 +182,9 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { $this->assertEquals('22 Adams Avenue Unit 3c', $actualvalue); } - /* - * Helper function to provide csv data with Valid Street Address. - */ /** + * Helper function to provide csv data with Valid Street Address. + * * @return array */ function _validStreetAddressCSVData() { @@ -233,10 +232,9 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { return array($headers, $rows); } - /* - * Helper function to provide csv data with Invalid Street Address. - */ /** + * Helper function to provide csv data with Invalid Street Address. + * * @return array */ function _invalidStreetAddressCSVData() { @@ -255,7 +253,8 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { ); $rows = array( - array('first_name' => 'A' . substr(sha1(rand()), 0, 7), + array( + 'first_name' => 'A' . substr(sha1(rand()), 0, 7), 'middle_name' => substr(sha1(rand()), 0, 7), 'last_name' => substr(sha1(rand()), 0, 7) . 'and', 'email' => substr(sha1(rand()), 0, 7) . '@example.com', @@ -267,7 +266,8 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { 'state' => 'NY', 'country' => 'United States', ), - array('first_name' => 'S' . substr(sha1(rand()), 0, 7), + array( + 'first_name' => 'S' . substr(sha1(rand()), 0, 7), 'middle_name' => substr(sha1(rand()), 0, 7), 'last_name' => substr(sha1(rand()), 0, 7) . 'sum', 'email' => substr(sha1(rand()), 0, 7) . '@example.com', diff --git a/tests/phpunit/WebTest/Import/ContactCustomDataTest.php b/tests/phpunit/WebTest/Import/ContactCustomDataTest.php index 7f9c2e7e0d..520f049f13 100644 --- a/tests/phpunit/WebTest/Import/ContactCustomDataTest.php +++ b/tests/phpunit/WebTest/Import/ContactCustomDataTest.php @@ -105,10 +105,9 @@ class WebTest_Import_ContactCustomDataTest extends ImportCiviSeleniumTestCase { $this->assertTrue($this->isTextPresent('This is a test field')); } - /* - * Helper function to provide data for custom data import. - */ /** + * Helper function to provide data for custom data import. + * * @param $customDataParams * @param $firstName1 * diff --git a/tests/phpunit/WebTest/Import/CustomDataTest.php b/tests/phpunit/WebTest/Import/CustomDataTest.php index cd603ba4b2..68ddefc624 100644 --- a/tests/phpunit/WebTest/Import/CustomDataTest.php +++ b/tests/phpunit/WebTest/Import/CustomDataTest.php @@ -102,10 +102,9 @@ class WebTest_Import_CustomDataTest extends ImportCiviSeleniumTestCase { } } - /* - * Helper function to provide data for custom data import. - */ /** + * Helper function to provide data for custom data import. + * * @param $customGroupTitle * @param $firstName1 * @param $firstName2 @@ -323,20 +322,21 @@ class WebTest_Import_CustomDataTest extends ImportCiviSeleniumTestCase { $contactReferenceFieldId = $contactReferenceFieldId[1]; $customDataParams = array( - 'headers' => - array( + 'headers' => array( "custom_{$dateFieldId}" => "$dateFieldLabel :: $customGroupTitle", "custom_{$radioFieldId}" => "$radioFieldLabel :: $customGroupTitle", "custom_{$multiSelectFieldId}" => "$multiSelectLabel :: $customGroupTitle", "custom_{$contactReferenceFieldId}" => "$contactReferenceLabel :: $customGroupTitle", ), - 'rows' => - array(0 => array("custom_{$dateFieldId}" => date('Y-m-d'), + 'rows' => array( + 0 => array( + "custom_{$dateFieldId}" => date('Y-m-d'), "custom_{$radioFieldId}" => '2', "custom_{$multiSelectFieldId}" => '3', "custom_{$contactReferenceFieldId}" => $id1, ), - 1 => array("custom_{$dateFieldId}" => date('Y-m-d', mktime(0, 0, 0, 4, 5, date('Y'))), + 1 => array( + "custom_{$dateFieldId}" => date('Y-m-d', mktime(0, 0, 0, 4, 5, date('Y'))), "custom_{$radioFieldId}" => '1', "custom_{$multiSelectFieldId}" => '2', "custom_{$contactReferenceFieldId}" => $id2, diff --git a/tests/phpunit/WebTest/Import/GroupTest.php b/tests/phpunit/WebTest/Import/GroupTest.php index 65e27e8f43..182c62f5d2 100644 --- a/tests/phpunit/WebTest/Import/GroupTest.php +++ b/tests/phpunit/WebTest/Import/GroupTest.php @@ -35,9 +35,9 @@ class WebTest_Import_GroupTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Test contact import for Individuals. - */ + /** + * Test contact import for Individuals. + */ function testIndividualImportWithGroup() { $this->webtestLogin(); @@ -91,10 +91,9 @@ class WebTest_Import_GroupTest extends ImportCiviSeleniumTestCase { $this->assertTrue($this->isTextPresent("{$count} Contacts"), "Contacts Not Found"); } - /* - * Helper function to provide data for contact import for Individuals. - */ /** + * Helper function to provide data for contact import for Individuals. + * * @return array */ function _individualGroupCSVData() { diff --git a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php index 1390995bfb..bec67830bb 100644 --- a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php @@ -32,32 +32,23 @@ require_once 'CRM/Utils/Array.php'; */ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { - /* - * Function to test csv import for each component. - * - * @params string $component component name ( Event, Contribution, Membership, Activity etc) - * @params array $headers csv data headers - * @params array $rows csv data rows - * @params string $contactType contact type - * @params string $mode import mode - * @params array $fieldMapper select mapper fields while import - * @params array $other other parameters - * useMappingName : to reuse mapping - - * dateFormat : date format of data - * checkMapperHeaders : to override default check mapper headers - * saveMapping : save current mapping? - * saveMappingName : to override mapping name - * - */ /** - * @param $component - * @param $headers - * @param $rows - * @param string $contactType - * @param string $mode - * @param array $fieldMapper - * @param array $other + * test csv import for each component. + * + * @param string $component component name ( Event, Contribution, Membership, Activity etc) + * @param array $headers csv data headers + * @param array $rows csv data rows + * @param string $contactType contact type + * @param string $mode import mode + * @param array $fieldMapper select mapper fields while import + * @param array $other other parameters + * useMappingName : to reuse mapping + + * dateFormat : date format of data + * checkMapperHeaders : to override default check mapper headers + * saveMapping : save current mapping? + * saveMappingName : to override mapping name + * */ function importCSVComponent($component, $headers, @@ -167,42 +158,32 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { } } - /* - * Function to test contact import. - * - * @params array $headers csv data headers - * @params array $rows csv data rows - * @params string $contactType contact type - * @params string $mode import mode - * @params array $fieldMapper select mapper fields while import - * @params array $other other parameters - * contactSubtype : import for selected Contact Subtype - - * useMappingName : to reuse mapping - * dateFormat : date format of data - * checkMapperHeaders : to override default check mapper headers - * saveMapping : save current mapping? - * saveMappingName : to override mapping name - * createGroup : create new group? - * createGroupName : to override new Group name - * createTag : create new tag? - * createTagName : to override new Tag name - * selectGroup : select existing group for contacts - * selectTag : select existing tag for contacts - * callbackImportSummary : function to override default import summary assertions - * - * @params string $type import type (csv/sql) - * @todo:currently only supports csv, need to work on sql import - - */ /** - * @param $headers - * @param $rows - * @param string $contactType - * @param string $mode - * @param array $fieldMapper - * @param array $other - * @param string $type + * test contact import. + * + * @param array $headers csv data headers + * @param array $rows csv data rows + * @param string $contactType contact type + * @param string $mode import mode + * @param array $fieldMapper select mapper fields while import + * @param array $other other parameters + * contactSubtype : import for selected Contact Subtype + + * useMappingName : to reuse mapping + * dateFormat : date format of data + * checkMapperHeaders : to override default check mapper headers + * saveMapping : save current mapping? + * saveMappingName : to override mapping name + * createGroup : create new group? + * createGroupName : to override new Group name + * createTag : create new tag? + * createTagName : to override new Tag name + * selectGroup : select existing group for contacts + * selectTag : select existing tag for contacts + * callbackImportSummary : function to override default import summary assertions + * + * @param string $type import type (csv/sql) + * @todo:currently only supports csv, need to work on sql import */ function importContacts($headers, $rows, $contactType = 'Individual', $mode = 'Skip', $fieldMapper = array(), $other = array(), $type = 'csv') { @@ -434,18 +415,11 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { } } - /* - * Helper function to get the import url of the component. - * - * @params string $component component name - * - * @return string import url - - */ /** - * @param $component + * Helper function to get the import url of the component. + * @param string $component component name * - * @return mixed + * @return string import url */ private function _getImportComponentUrl($component) { $importComponentUrl = array( @@ -458,23 +432,16 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { return $importComponentUrl[$component]; } - /* - * Helper function to get the import url of the component. - * - * @params string $component component name - * - * @return string import url - - */ /** * @param $component * @param $contactType * - * @return mixed + * @return string */ function _getImportComponentContactType($component, $contactType) { $importComponentMode = array( - 'Event' => array('Individual' => 'CIVICRM_QFID_1_8', + 'Event' => array( + 'Individual' => 'CIVICRM_QFID_1_8', 'Household' => 'CIVICRM_QFID_2_10', 'Organization' => 'CIVICRM_QFID_4_12', ), @@ -493,22 +460,15 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { return $importComponentMode[$component][$contactType]; } - /* - * Helper function to check import mapping fields. - * - * @params array $headers field headers - * @params array $rows field rows - * @params array $checkMapperHeaders override default mapper headers - */ /** - * @param $headers - * @param $rows + * Helper function to check import mapping fields. + * @param array $headers + * @param array $rows * @param null $existingMapping * @param array $checkMapperHeaders * @param string $headerSelector */ - function _checkImportMapperData($headers, $rows, $existingMapping = NULL, $checkMapperHeaders = array( - ), $headerSelector = 'th') { + function _checkImportMapperData($headers, $rows, $existingMapping = NULL, $checkMapperHeaders = array(), $headerSelector = 'th') { if (empty($checkMapperHeaders)) { $checkMapperHeaders = array( @@ -541,20 +501,13 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { } } - /* - * Helper function to get imported contact ids. - * - * @params array $rows fields rows - * @params string $contactType contact type - - * - * @return array $contactIds imported contact ids - */ /** - * @param $rows + * Helper function to get imported contact ids. + * + * @param array $rows * @param string $contactType * - * @return array + * @return array $contactIds imported contact ids */ function _getImportedContactIds($rows, $contactType = 'Individual') { $contactIds = array(); @@ -594,15 +547,11 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { return $contactIds; } - /* - * Helper function to format headers and rows for contact relationship data. - * - * @params array $headers data headers - * @params string $rows data rows - */ /** - * @param $headers - * @param $rows + * Helper function to format headers and rows for contact relationship data. + * + * @param array $headers + * @param array $rows */ function _formatContactCSVdata(&$headers, &$rows) { if (!isset($headers['contact_relationships'])) { diff --git a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php index e8a1df5f26..38216dfe72 100644 --- a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php +++ b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php @@ -35,9 +35,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Test participant import for Individuals matching on external identifier. - */ + /** + * Test participant import for Individuals matching on external identifier. + */ function testContributionImport() { $this->webtestLogin(); @@ -48,9 +48,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Contribution', $headers, $rows, 'Individual', 'Insert new contributions', $fieldMapper); } - /* - * Test membership import for Individuals matching on external identifier. - */ + /** + * Test membership import for Individuals matching on external identifier. + */ function testMemberImportIndividual() { $this->webtestLogin(); @@ -61,9 +61,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Membership', $headers, $rows, 'Individual', 'Skip', $fieldMapper); } - /* - * Test participant import for Individuals matching on external identifier. - */ + /** + * Test participant import for Individuals matching on external identifier. + */ function testParticipantImportIndividual() { // Log in using webtestLogin() method $this->webtestLogin(); @@ -75,10 +75,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Event', $headers, $rows, 'Individual', 'Skip', $fieldMapper); } - /* - * Helper function to provide data for contribution import for Individual. - */ /** + * Helper function to provide data for contribution import for Individual. + * * @return array */ function _contributionIndividualCSVData() { @@ -126,10 +125,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { return array($headers, $rows, $fieldMapper); } - /* - * Helper function to provide data for membership import for Individual. - */ /** + * Helper function to provide data for membership import for Individual. + * * @return array */ function _memberIndividualCSVData() { @@ -176,10 +174,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { return array($headers, $rows, $fieldMapper); } - /* - * Helper function to provide data for participant import for Individual. - */ /** + * Helper function to provide data for participant import for Individual. + * * @return array */ function _participantIndividualCSVData() { @@ -235,19 +232,14 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { return array($headers, $rows, $fieldMapper); } - /* - * Helper function to add new contact - * - * @params $firstName, $lastName, $externalId - * - * @return int external id - */ /** + * Helper function to add new contact + * * @param $firstName * @param $lastName * @param $externalId * - * @return mixed + * @return int external id */ function _addContact($firstName, $lastName, $externalId) { $this->openCiviPage('contact/add', 'reset=1&ct=Individual'); @@ -269,20 +261,14 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { return $externalId; } - /* - * Helper function to add new event - * - * @params array $params parameters to create an event - * - * @return array $params event details of newly created event - */ /** + * Helper function to add new event + * * @param array $params * - * @return array + * @return array event details of newly created event */ - function _addNewEvent($params = array( - )) { + function _addNewEvent($params = array()) { if (empty($params)) { // Use default payment processor diff --git a/tests/phpunit/WebTest/Import/MemberTest.php b/tests/phpunit/WebTest/Import/MemberTest.php index 25d85a262f..b06d929495 100644 --- a/tests/phpunit/WebTest/Import/MemberTest.php +++ b/tests/phpunit/WebTest/Import/MemberTest.php @@ -35,9 +35,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Test participant import for Individuals. - */ + /** + * Test participant import for Individuals. + */ function testMemberImportIndividual() { $this->webtestLogin(); @@ -49,9 +49,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Membership', $headers, $rows, 'Individual', 'Skip', $fieldMapper); } - /* - * Test participant import for Households. - */ + /** + * Test participant import for Households. + */ function testMemberImportHousehold() { $this->webtestLogin(); @@ -63,9 +63,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Membership', $headers, $rows, 'Household', 'Skip', $fieldMapper); } - /* - * Test participant import for Organizations. - */ + /** + * Test participant import for Organizations. + */ function testMemberImportOrganization() { $this->webtestLogin(); @@ -77,10 +77,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Membership', $headers, $rows, 'Organization', 'Skip', $fieldMapper); } - /* - * Helper function to provide data for Membeship import for Individuals. - */ /** + * Helper function to provide data for Membeship import for Individuals. + * * @return array */ function _memberIndividualCSVData() { @@ -124,10 +123,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { return array($headers, $rows, $fieldMapper); } - /* - * Helper function to provide data for Membeship import for Households. - */ /** + * Helper function to provide data for Membeship import for Households. + * * @return array */ function _memberHouseholdCSVData() { @@ -169,10 +167,9 @@ class WebTest_Import_MemberTest extends ImportCiviSeleniumTestCase { return array($headers, $rows, $fieldMapper); } - /* - * Helper function to provide data for Membeship import for Organizations. - */ /** + * Helper function to provide data for Membeship import for Organizations. + * * @return array */ function _memberOrganizationCSVData() { diff --git a/tests/phpunit/WebTest/Import/ParticipantTest.php b/tests/phpunit/WebTest/Import/ParticipantTest.php index 09ee62f1da..c3155f2ece 100644 --- a/tests/phpunit/WebTest/Import/ParticipantTest.php +++ b/tests/phpunit/WebTest/Import/ParticipantTest.php @@ -35,9 +35,9 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Test participant import for Individuals. - */ + /** + * Test participant import for Individuals. + */ function testParticipantImportIndividual() { // Log in using webtestLogin() method $this->webtestLogin(); @@ -56,9 +56,9 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Event', $headers, $rows, 'Individual', 'Skip', $fieldMapper); } - /* - * Test participant import for Organizations. - */ + /** + * Test participant import for Organizations. + */ function testParticipantImportOrganization() { // Log in using webtestLogin() method $this->webtestLogin(); @@ -77,9 +77,9 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Event', $headers, $rows, 'Organization', 'Skip', $fieldMapper); } - /* - * Test participant import for Households. - */ + /** + * Test participant import for Households. + */ function testParticipantImportHousehold() { // Log in using webtestLogin() method $this->webtestLogin(); @@ -98,10 +98,9 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { $this->importCSVComponent('Event', $headers, $rows, 'Household', 'Skip', $fieldMapper); } - /* - * Helper function to provide data for participant import for Individuals. - */ /** + * Helper function to provide data for participant import for Individuals. + * * @return array */ function _participantIndividualCSVData() { @@ -146,10 +145,9 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { return array($headers, $rows); } - /* - * Helper function to provide data for participant import for Household. - */ /** + * Helper function to provide data for participant import for Household. + * * @return array */ function _participantHouseholdCSVData() { @@ -192,10 +190,8 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { return array($headers, $rows); } - /* - * Helper function to provide data for participant import for Organization. - */ /** + * Helper function to provide data for participant import for Organization. * @return array */ function _participantOrganizationCSVData() { @@ -238,20 +234,14 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { return array($headers, $rows); } - /* - * Helper function to add new event - * - * @params array $params parameters to create an event - * - * @return array $params event details of newly created event - */ /** - * @param array $params + * Helper function to add new event * - * @return array + * @param array $params parameters to create an event + * + * @return array $params event details of newly created event */ - function _addNewEvent($params = array( - )) { + function _addNewEvent($params = array()) { if (empty($params)) { diff --git a/tests/phpunit/WebTest/Import/SavedMappingTest.php b/tests/phpunit/WebTest/Import/SavedMappingTest.php index 314f96825d..9a8ee93435 100644 --- a/tests/phpunit/WebTest/Import/SavedMappingTest.php +++ b/tests/phpunit/WebTest/Import/SavedMappingTest.php @@ -35,9 +35,9 @@ class WebTest_Import_SavedMappingTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Function to test Saved Import Mapping for Individuals. - */ + /** + * test Saved Import Mapping for Individuals. + */ function testSaveIndividualMapping() { // Logging in. @@ -82,10 +82,9 @@ class WebTest_Import_SavedMappingTest extends ImportCiviSeleniumTestCase { $this->importContacts($headers, $rows, 'Individual', 'Skip', array(), $other); } - /* - * Helper function to provide csv data for Individuals contact import. - */ /** + * Helper function to provide csv data for Individuals contact import. + * * @return array */ function _individualCSVData() { diff --git a/tests/phpunit/WebTest/Import/TagTest.php b/tests/phpunit/WebTest/Import/TagTest.php index e2de4f97e4..64c1463ced 100644 --- a/tests/phpunit/WebTest/Import/TagTest.php +++ b/tests/phpunit/WebTest/Import/TagTest.php @@ -88,10 +88,9 @@ class WebTest_Import_TagTest extends ImportCiviSeleniumTestCase { $this->assertTrue($this->isTextPresent("{$countContacts} Contacts")); } - /* - * Helper function to provide data for contact import for sample. - */ /** + * Helper function to provide data for contact import for sample. + * * @return array */ function _contactTagCSVData() { @@ -109,7 +108,8 @@ class WebTest_Import_TagTest extends ImportCiviSeleniumTestCase { ); $rows = array( - array('first_name' => substr(sha1(rand()), 0, 7), + array( + 'first_name' => substr(sha1(rand()), 0, 7), 'middle_name' => substr(sha1(rand()), 0, 7), 'last_name' => 'Anderson', 'email' => substr(sha1(rand()), 0, 7) . '@example.com', @@ -120,7 +120,8 @@ class WebTest_Import_TagTest extends ImportCiviSeleniumTestCase { 'state' => 'NY', 'country' => 'United States', ), - array('first_name' => substr(sha1(rand()), 0, 7), + array( + 'first_name' => substr(sha1(rand()), 0, 7), 'middle_name' => substr(sha1(rand()), 0, 7), 'last_name' => 'Summerson', 'email' => substr(sha1(rand()), 0, 7) . '@example.com', diff --git a/tests/phpunit/api/v3/APIStandardsTest.php b/tests/phpunit/api/v3/APIStandardsTest.php index 822658ebd3..c41d265278 100644 --- a/tests/phpunit/api/v3/APIStandardsTest.php +++ b/tests/phpunit/api/v3/APIStandardsTest.php @@ -93,10 +93,10 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { ); } - /* - * test checks that all v3 API return a standardised error message when - * the $params passed in is not an array. - */ + /** + * test checks that all v3 API return a standardised error message when + * the $params passed in is not an array. + */ function testParamsNotArray() { /*I have commented this out as the check for is_array has been moved to civicrm_api. But keeping in place as * this test, in contrast to the standards test, tests all existing API rather than just CRUD ones @@ -120,12 +120,9 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { }*/ } - /* - * Get all the files in the API directory for the relevant version which contain API functions - * @return array $files array of php files in the directory excluding helper files - */ /** - * @return array + * Get all the files in the API directory for the relevant version which contain API functions + * @return array $files array of php files in the directory excluding helper files */ function getAllFilesinAPIDir() { $files = array(); @@ -145,12 +142,9 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { return $files; } - /* - * Require once Files - * @files array list of files to load - */ /** - * @param $files + * Require once Files + * @param $files array list of files to load */ function requireOnceFilesArray($files) { foreach ($files as $key => $file) { @@ -158,12 +152,9 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { } } - /* - * Get all api exposed functions that are expected to conform to standards - * @return array $functionlist - */ /** - * @return array + * Get all api exposed functions that are expected to conform to standards + * @return array $functionlist */ function getAllAPIStdFunctions() { $functionlist = get_defined_functions(); diff --git a/tests/phpunit/api/v3/AddressTest.php b/tests/phpunit/api/v3/AddressTest.php index e64c633afa..4f6079f9cf 100644 --- a/tests/phpunit/api/v3/AddressTest.php +++ b/tests/phpunit/api/v3/AddressTest.php @@ -96,12 +96,9 @@ class api_v3_AddressTest extends CiviUnitTestCase { } - /* - * is_primary should be set as a default - */ - - - + /** + * is_primary should be set as a default + */ public function testCreateAddressTestDefaults() { $params = $this->_params; unset($params['is_primary']); @@ -116,14 +113,12 @@ class api_v3_AddressTest extends CiviUnitTestCase { $params['street_number_suffix'] = 'really long string'; $result = $this->callAPIFailure('address', 'create', $params); } - /* - * is_primary shoule be set as a default. ie. create the address, unset the params & recreate. - * is_primary should be 0 before & after the update. ie - having no other address - * is_primary is invalid - */ - - + /** + * is_primary shoule be set as a default. ie. create the address, unset the params & recreate. + * is_primary should be 0 before & after the update. ie - having no other address + * is_primary is invalid + */ public function testCreateAddressTestDefaultWithID() { $params = $this->_params; $params['is_primary'] = 0; diff --git a/tests/phpunit/api/v3/ContactTest.php b/tests/phpunit/api/v3/ContactTest.php index c6cd376d2c..3f72b8e705 100644 --- a/tests/phpunit/api/v3/ContactTest.php +++ b/tests/phpunit/api/v3/ContactTest.php @@ -419,7 +419,6 @@ class api_v3_ContactTest extends CiviUnitTestCase { /** * Check deceased contacts are not retrieved * Note at time of writing the default is to return default. This should possibly be changed & test added - * */ function testGetDeceasedRetrieved() { $this->callAPISuccess($this->_entity, 'create', $this->_params); @@ -428,9 +427,9 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertFalse(array_key_exists($c2['id'], $result['values'])); } - /* - * Test that sort works - old syntax - */ + /** + * Test that sort works - old syntax + */ function testGetSort() { $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); $c2 = $this->callAPISuccess($this->_entity, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual')); @@ -496,9 +495,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertEquals(1, $countDeleted, 'in line ' . __LINE__); $this->assertEquals(1, $countDefault, 'Only active by default in line ' . __LINE__); } - /* - * Test that sort works - new syntax - */ + + /** + * Test that sort works - new syntax + */ function testGetSortNewSYntax() { $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); $c2 = $this->callAPISuccess($this->_entity, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual')); @@ -523,7 +523,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess($this->_entity, 'delete', array('id' => $c1['id'])); $this->callAPISuccess($this->_entity, 'delete', array('id' => $c2['id'])); } - /* + + /** * Test apostrophe works in get & create */ function testGetApostropheCRM10857() { @@ -559,12 +560,13 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->customFieldDelete($ids['custom_field_id']); $this->customGroupDelete($ids['custom_group_id']); } - /* - * check with complete array + custom field - * Note that the test is written on purpose without any - * variables specific to participant so it can be replicated into other entities - * and / or moved to the automated test suite - */ + + /** + * check with complete array + custom field + * Note that the test is written on purpose without any + * variables specific to participant so it can be replicated into other entities + * and / or moved to the automated test suite + */ function testGetWithCustomReturnSyntax() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); diff --git a/tests/phpunit/api/v3/ContactTypeTest.php b/tests/phpunit/api/v3/ContactTypeTest.php index 44f4357153..0f98ed7c28 100644 --- a/tests/phpunit/api/v3/ContactTypeTest.php +++ b/tests/phpunit/api/v3/ContactTypeTest.php @@ -90,10 +90,10 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } } - /* - * test add methods with valid data - * success expected - */ + /** + * test add methods with valid data + * success expected + */ function testContactCreate() { // check for Type:Individual Subtype:sub_individual @@ -134,9 +134,9 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } - /* - * test add with invalid data - */ + /** + * test add with invalid data + */ function testContactAddInvalidData() { // check for Type:Individual Subtype:sub_household @@ -158,10 +158,10 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } - /* - * test update with no subtype to valid subtype - * success expected - */ + /** + * test update with no subtype to valid subtype + * success expected + */ function testContactUpdateNoSubtypeValid() { // check for Type:Individual @@ -224,9 +224,9 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } - /* - * test update with no subtype to invalid subtype - */ + /** + * test update with no subtype to invalid subtype + */ function testContactUpdateNoSubtypeInvalid() { // check for Type:Individual @@ -271,10 +271,10 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { $this->callAPISuccess('contact', 'delete', $params); } - /* - * test update with no subtype to valid subtype - * success expected - */ + /** + * test update with no subtype to valid subtype + * success expected + */ function testContactUpdateSubtypeValid() { $params = array( @@ -361,9 +361,9 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { $this->callAPISuccess('contact', 'delete', $params); } - /* - * test update with no subtype to invalid subtype - */ + /** + * test update with no subtype to invalid subtype + */ function testContactUpdateSubtypeInvalid() { // check for Type:Individual subtype:sub_individual diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index 8f3d201f4f..d8ed23fabb 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -476,9 +476,9 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->assertEquals(1,$contribution['count']); } - /* - * Create test with unique field name on source - */ + /** + * Create test with unique field name on source + */ function testCreateContributionSource() { $params = array( @@ -514,9 +514,9 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date']))); } - /* - * Create test with unique field name on source - */ + /** + * Create test with unique field name on source + */ function testCreateContributionSourceInvalidContac() { $params = array( @@ -607,11 +607,11 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->assertEquals('my contribution note', $result['values'][0]['note']); $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id'])); } - /* - * This is the test for creating soft credits - however a 'get' is not yet possible via API - * as the current BAO functions are contact-centric (from what I can find) - * - */ + + /** + * This is the test for creating soft credits - however a 'get' is not yet possible via API + * as the current BAO functions are contact-centric (from what I can find) + */ function testCreateContributionWithSoftCredt() { $description = "Demonstrates creating contribution with SoftCredit"; $subfile = "ContributionCreateWithSoftCredit"; @@ -1763,7 +1763,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * @param $params + * @param array $params * @param $context */ function _checkFinancialRecords($params,$context) { diff --git a/tests/phpunit/api/v3/CustomFieldTest.php b/tests/phpunit/api/v3/CustomFieldTest.php index 293988a78d..b186fcc3c8 100644 --- a/tests/phpunit/api/v3/CustomFieldTest.php +++ b/tests/phpunit/api/v3/CustomFieldTest.php @@ -162,7 +162,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { * Can't figure out the point of this? */ /** - * @param $params + * @param array $params */ function _loopingCustomFieldCreateTest($params) { $customField = $this->callAPISuccess('custom_field', 'create', $params); diff --git a/tests/phpunit/api/v3/CustomGroupTest.php b/tests/phpunit/api/v3/CustomGroupTest.php index ae0d5d7eff..e4c9bad764 100644 --- a/tests/phpunit/api/v3/CustomGroupTest.php +++ b/tests/phpunit/api/v3/CustomGroupTest.php @@ -368,12 +368,10 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { $result = $this->callAPIAndDocument('custom_group', 'delete', $params, __FUNCTION__, __FILE__); $this->assertAPISuccess($result, 'In line ' . __LINE__); } - /* - * main success get function - */ - - + /** + * main success get function + */ public function testGetCustomGroupSuccess() { $this->callAPISuccess($this->_entity, 'create', $this->_params); diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index 554574ad4b..56df71d35f 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -188,9 +188,9 @@ class api_v3_EventTest extends CiviUnitTestCase { */ - /* - * Test 'is.Current' option. Existing event is 'old' so only current should be returned - */ + /** + * Test 'is.Current' option. Existing event is 'old' so only current should be returned + */ function testGetIsCurrent() { $params = array( 'isCurrent' => 1, @@ -209,9 +209,10 @@ class api_v3_EventTest extends CiviUnitTestCase { $this->assertEquals(3, $allEvents['count'], 'confirm three events exist (ie. two not found) ' . __LINE__); $this->assertEquals($currentEvent['id'], $result['id'], ''); } -/* - * There has been a schema change & the api needs to buffer developers from it - */ + + /** + * There has been a schema change & the api needs to buffer developers from it + */ function testGetPaymentProcessorId() { $params = $this->_params[0]; $params['payment_processor_id'] = 1; @@ -230,9 +231,9 @@ class api_v3_EventTest extends CiviUnitTestCase { } - /* - * Test 'is.Current' option. Existing event is 'old' so only current should be returned - */ + /** + * Test 'is.Current' option. Existing event is 'old' so only current should be returned + */ function testGetSingleReturnIsFull() { $contactID = $this->individualCreate(); $params = array( @@ -343,9 +344,10 @@ class api_v3_EventTest extends CiviUnitTestCase { $this->assertEquals('2008-06-01 00:00:00', $result['values'][$result['id']]['registration_start_date'], 'start date is not set in line ' . __LINE__); $this->assertEquals('2008-10-15 00:00:00', $result['values'][$result['id']]['registration_end_date'], 'end date is not set in line ' . __LINE__); } - /* - * Test that passing in Unique field names works - */ + + /** + * Test that passing in Unique field names works + */ function testCreateEventSuccessUniqueFieldNames() { $this->_params[0]['event_start_date'] = $this->_params[0]['start_date']; unset($this->_params[1]['start_date']); @@ -398,9 +400,10 @@ class api_v3_EventTest extends CiviUnitTestCase { $result = $this->callAPISuccess('Event', 'Delete', $params); $this->assertAPISuccess($result, 'in line ' . __LINE__); } - /* - * Trying to delete an event with participants should return error - */ + + /** + * Trying to delete an event with participants should return error + */ function testDeleteWithExistingParticipant() { $contactID = $this->individualCreate(); $participantID = $this->participantCreate( @@ -505,9 +508,10 @@ class api_v3_EventTest extends CiviUnitTestCase { $result = $this->callAPISuccess('event', 'getfields', $params); $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__); } - /* - * test api_action param also works - */ + + /** + * test api_action param also works + */ function testgetfieldsRest() { $description = "demonstrate use of getfields to interrogate api"; $params = array('api_action' => 'create'); diff --git a/tests/phpunit/api/v3/GroupContactTest.php b/tests/phpunit/api/v3/GroupContactTest.php index 9f931f3ab0..78be1bf83a 100644 --- a/tests/phpunit/api/v3/GroupContactTest.php +++ b/tests/phpunit/api/v3/GroupContactTest.php @@ -50,11 +50,11 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { ); } - /* - * Set up for group contact tests - * - * @todo set up calls function that doesn't work @ the moment - */ + /** + * Set up for group contact tests + * + * @todo set up calls function that doesn't work @ the moment + */ function setUp() { parent::setUp(); diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php index 4fe5db3b66..c201df4b3a 100644 --- a/tests/phpunit/api/v3/JobTest.php +++ b/tests/phpunit/api/v3/JobTest.php @@ -287,7 +287,7 @@ class api_v3_JobTest extends CiviUnitTestCase { * @param $op * @param $objectName * @param $id - * @param $params + * @param array $params */ function hookPreRelationship($op, $objectName, $id, &$params ) { if($op == 'delete') { diff --git a/tests/phpunit/api/v3/MailingContactTest.php b/tests/phpunit/api/v3/MailingContactTest.php index 47f038e90d..87a622a11d 100644 --- a/tests/phpunit/api/v3/MailingContactTest.php +++ b/tests/phpunit/api/v3/MailingContactTest.php @@ -59,24 +59,24 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { parent::tearDown(); } - /* + /** * Test that the api responds correctly to null params * Note to copy & pasters - tests like this that test the wrapper belong in the SyntaxConformance class * (which already has a 'not array test) * I have left this here in case 'null' isn't covered in that class * but don't copy it only any other classes */ - public function testMailingNullParams() { - $result = $this->callAPIFailure('MailingContact', 'get', null); - } - - public function testMailingContactGetFields() { - $result = $this->callAPISuccess('MailingContact', 'getfields', array( - 'action' => 'get', - ) - ); - $this->assertEquals('Delivered', $result['values']['type']['api.default']); - } + public function testMailingNullParams() { + $result = $this->callAPIFailure('MailingContact', 'get', null); + } + + public function testMailingContactGetFields() { + $result = $this->callAPISuccess('MailingContact', 'getfields', array( + 'action' => 'get', + ) + ); + $this->assertEquals('Delivered', $result['values']['type']['api.default']); + } /** * Test that the api will return the proper error when you do not @@ -84,7 +84,6 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { * Note to copy & pasters - test is of marginal if any value & testing of wrapper level functionaliy * belongs in the SyntaxConformance class */ - public function testMailingNoContactID() { $params = array( 'something' => 'This is not a real field', @@ -97,99 +96,99 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { * Note to copy & pasters - test is of marginal if any value & testing of wrapper level functionaliy * belongs in the SyntaxConformance class */ - public function testMailingContactInvalidContactID() { - $params = array('contact_id' => 'This is not a number',); - $result = $this->callAPIFailure('MailingContact', 'get', $params); - } - - /** - * Test that invalid types are returned with appropriate errors - */ - public function testMailingContactInvalidType() { - $params = array( - 'contact_id' => 23, - 'type' => 'invalid', - ); - $result = $this->callAPIFailure('MailingContact', 'get', $params); - } - - /** - * Test that the API returns properly when there are no mailings - * for a the given contact - */ - public function testMailingContactNoMailings() { - $params = array( - 'contact_id' => $this->_contact['id'], - ); - $result = $this->callAPISuccess('MailingContact', 'get', $params); - $this->assertEquals($result['count'], 0, "In line " . __LINE__); - $this->assertTrue(empty($result['values']), "In line " . __LINE__); - } - - /* + public function testMailingContactInvalidContactID() { + $params = array('contact_id' => 'This is not a number',); + $result = $this->callAPIFailure('MailingContact', 'get', $params); + } + + /** + * Test that invalid types are returned with appropriate errors + */ + public function testMailingContactInvalidType() { + $params = array( + 'contact_id' => 23, + 'type' => 'invalid', + ); + $result = $this->callAPIFailure('MailingContact', 'get', $params); + } + + /** + * Test that the API returns properly when there are no mailings + * for a the given contact + */ + public function testMailingContactNoMailings() { + $params = array( + 'contact_id' => $this->_contact['id'], + ); + $result = $this->callAPISuccess('MailingContact', 'get', $params); + $this->assertEquals($result['count'], 0, "In line " . __LINE__); + $this->assertTrue(empty($result['values']), "In line " . __LINE__); + } + + /** * Test that the API returns a mailing properly when there is only one */ - public function testMailingContactDelivered() { - $op = new PHPUnit_Extensions_Database_Operation_Insert(); - //Create the User - $op->execute($this->_dbconn, - $this->createXMLDataSet( - dirname(__FILE__) . '/dataset/mailing_contact.xml' - ) - ); - //~ Create the Mailing and connections to the user - $op->execute($this->_dbconn, - $this->createXMLDataSet( - dirname(__FILE__) . '/dataset/mailing_delivered.xml' - ) - ); - - $params = array( - 'contact_id' => 23, - 'type' => 'Delivered', - ); - - $result = $this->callAPISuccess('MailingContact', 'get', $params); - $count = $this->callAPISuccess('MailingContact', 'getcount', $params); - $this->assertEquals($result['count'], 1, "In line " . __LINE__); - $this->assertEquals($count, 1, "In line " . __LINE__); - $this->assertFalse(empty($result['values']), "In line " . __LINE__); - $this->assertEquals($result['values'][1]['mailing_id'], 1, "In line " . __LINE__); - $this->assertEquals($result['values'][1]['subject'], "Some Subject", "In line " . __LINE__); - $this->assertEquals($result['values'][1]['creator_id'], 1, "In line " . __LINE__); - $this->assertEquals($result['values'][1]['creator_name'], "xyz1, abc1", "In line " . __LINE__); - } - - - /* - * Test that the API returns only the "Bounced" mailings when instructed to do so - */ - function testMailingContactBounced( ) { - $op = new PHPUnit_Extensions_Database_Operation_Insert(); - //Create the User - $op->execute($this->_dbconn, - $this->createXMLDataSet( - dirname(__FILE__) . '/dataset/mailing_contact.xml' - ) - ); - //~ Create the Mailing and connections to the user - $op->execute($this->_dbconn, - $this->createXMLDataSet( - dirname(__FILE__) . '/dataset/mailing_bounced.xml' - ) - ); - - $params = array( - 'contact_id' => 23, - 'type' => 'Bounced', - ); - - $result = $this->callAPISuccess('MailingContact', 'get', $params); - $this->assertEquals($result['count'], 1, "In line " . __LINE__); - $this->assertFalse(empty($result['values']), "In line " . __LINE__); - $this->assertEquals($result['values'][2]['mailing_id'], 2, "In line " . __LINE__); - $this->assertEquals($result['values'][2]['subject'], "Some Subject", "In line " . __LINE__); - $this->assertEquals($result['values'][2]['creator_id'], 1, "In line " . __LINE__); - $this->assertEquals($result['values'][2]['creator_name'], "xyz1, abc1", "In line " . __LINE__); - } + public function testMailingContactDelivered() { + $op = new PHPUnit_Extensions_Database_Operation_Insert(); + //Create the User + $op->execute($this->_dbconn, + $this->createXMLDataSet( + dirname(__FILE__) . '/dataset/mailing_contact.xml' + ) + ); + //~ Create the Mailing and connections to the user + $op->execute($this->_dbconn, + $this->createXMLDataSet( + dirname(__FILE__) . '/dataset/mailing_delivered.xml' + ) + ); + + $params = array( + 'contact_id' => 23, + 'type' => 'Delivered', + ); + + $result = $this->callAPISuccess('MailingContact', 'get', $params); + $count = $this->callAPISuccess('MailingContact', 'getcount', $params); + $this->assertEquals($result['count'], 1, "In line " . __LINE__); + $this->assertEquals($count, 1, "In line " . __LINE__); + $this->assertFalse(empty($result['values']), "In line " . __LINE__); + $this->assertEquals($result['values'][1]['mailing_id'], 1, "In line " . __LINE__); + $this->assertEquals($result['values'][1]['subject'], "Some Subject", "In line " . __LINE__); + $this->assertEquals($result['values'][1]['creator_id'], 1, "In line " . __LINE__); + $this->assertEquals($result['values'][1]['creator_name'], "xyz1, abc1", "In line " . __LINE__); + } + + + /** + * Test that the API returns only the "Bounced" mailings when instructed to do so + */ + function testMailingContactBounced( ) { + $op = new PHPUnit_Extensions_Database_Operation_Insert(); + //Create the User + $op->execute($this->_dbconn, + $this->createXMLDataSet( + dirname(__FILE__) . '/dataset/mailing_contact.xml' + ) + ); + //~ Create the Mailing and connections to the user + $op->execute($this->_dbconn, + $this->createXMLDataSet( + dirname(__FILE__) . '/dataset/mailing_bounced.xml' + ) + ); + + $params = array( + 'contact_id' => 23, + 'type' => 'Bounced', + ); + + $result = $this->callAPISuccess('MailingContact', 'get', $params); + $this->assertEquals($result['count'], 1, "In line " . __LINE__); + $this->assertFalse(empty($result['values']), "In line " . __LINE__); + $this->assertEquals($result['values'][2]['mailing_id'], 2, "In line " . __LINE__); + $this->assertEquals($result['values'][2]['subject'], "Some Subject", "In line " . __LINE__); + $this->assertEquals($result['values'][2]['creator_id'], 1, "In line " . __LINE__); + $this->assertEquals($result['values'][2]['creator_name'], "xyz1, abc1", "In line " . __LINE__); + } } diff --git a/tests/phpunit/api/v3/MembershipStatusTest.php b/tests/phpunit/api/v3/MembershipStatusTest.php index 9343bb4b9e..ff2c6a681b 100644 --- a/tests/phpunit/api/v3/MembershipStatusTest.php +++ b/tests/phpunit/api/v3/MembershipStatusTest.php @@ -158,9 +158,10 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { ); $result = $this->callAPISuccess('membership_status', 'delete', $params); } - /* - * Test that trying to delete membership status while membership still exists creates error - */ + + /** + * Test that trying to delete membership status while membership still exists creates error + */ function testDeleteWithMembershipError() { $membershipStatusID = $this->membershipStatusCreate(); $this->_contactID = $this->individualCreate(); diff --git a/tests/phpunit/api/v3/OptionValueTest.php b/tests/phpunit/api/v3/OptionValueTest.php index 42382265f3..a1073b3f43 100644 --- a/tests/phpunit/api/v3/OptionValueTest.php +++ b/tests/phpunit/api/v3/OptionValueTest.php @@ -132,12 +132,10 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { $result = $this->callAPIAndDocument('option_value', 'get', $params, __FUNCTION__, __FILE__); $this->assertGreaterThan(1, $result['count'], 'In line ' . __LINE__); } - /* - * test that using option_group_name returns more than 1 & less than all - */ - - + /** + * test that using option_group_name returns more than 1 & less than all + */ public function testGetOptionGroupByName() { $activityTypesParams = array('option_group_name' => 'activity_type', 'option.limit' => 100); $params = array('option.limit' => 100); @@ -146,13 +144,15 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { $this->assertGreaterThan(1, $activityTypes['count'], 'In line ' . __LINE__); $this->assertGreaterThan($activityTypes['count'], $result['count'], 'In line ' . __LINE__); } + public function testGetOptionDoesNotExist() { $result = $this->callAPISuccess('option_value', 'get', array('label' => 'FSIGUBSFGOMUUBSFGMOOUUBSFGMOOBUFSGMOOIIB')); $this->assertEquals(0, $result['count'], 'In line ' . __LINE__); } -/* - * Check that domain_id is honoured - */ + + /** + * Check that domain_id is honoured + */ public function testCreateOptionSpecifyDomain() { $result = $this->callAPISuccess('option_group', 'get', array( 'name' => 'from_email_address', @@ -167,9 +167,10 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { )); $this->assertEquals(2, $domain_id); } - /* + + /** * Check that component_id is honoured - */ + */ public function testCreateOptionSpecifyComponentID() { $result = $this->callAPISuccess('option_group', 'get', array( 'name' => 'from_email_address', @@ -182,9 +183,10 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { )); $this->assertEquals(2, $component_id); } - /* + + /** * Check that component continues to be honoured - */ + */ public function testCreateOptionSpecifyComponent() { $result = $this->callAPISuccess('option_group', 'get', array( 'name' => 'from_email_address', @@ -201,9 +203,10 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { )); $this->assertEquals(2, $component_id); } - /* + + /** * Check that component string is honoured - */ + */ public function testCreateOptionSpecifyComponentString() { $result = $this->callAPISuccess('option_group', 'get', array( 'name' => 'from_email_address', @@ -219,9 +222,10 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { )); $this->assertEquals(2, $component_id); } - /* + + /** * Check that domain_id is honoured - */ + */ public function testCRM12133CreateOptionWeightNoValue() { $optionGroup = $this->callAPISuccess( 'option_group', 'get', array( @@ -245,9 +249,9 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { $this->callAPISuccess('option_value', 'delete', array('id' => $optionValue2['id'])); } - /* + /** * Check that domain_id is honoured - */ + */ public function testCreateOptionNoName() { $optionGroup = $this->callAPISuccess('option_group', 'get', array( 'name' => 'gender', @@ -283,7 +287,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } - /* + /** * update option value with 'id' paramter and the value to update * and not passing option group id */ @@ -302,7 +306,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { $this->assertEquals($val, 0, "update with no group id is not proper" . __LINE__); } - /* + /** * update option value with 'id' paramter and the value to update * and as well as option group id */ diff --git a/tests/phpunit/api/v3/ParticipantPaymentTest.php b/tests/phpunit/api/v3/ParticipantPaymentTest.php index 21ee98b342..540501b460 100644 --- a/tests/phpunit/api/v3/ParticipantPaymentTest.php +++ b/tests/phpunit/api/v3/ParticipantPaymentTest.php @@ -346,7 +346,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * @param $params + * @param array $params * @param $context */ function _checkFinancialRecords($params, $context) { diff --git a/tests/phpunit/api/v3/ParticipantTest.php b/tests/phpunit/api/v3/ParticipantTest.php index 85ffd721f4..380720264a 100644 --- a/tests/phpunit/api/v3/ParticipantTest.php +++ b/tests/phpunit/api/v3/ParticipantTest.php @@ -202,9 +202,10 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon'); $this->assertEquals($this->_eventID, $result['values'][$this->_participantID]['api.event.get']['id']); } - /* - * Check Participant Get respects return properties - */ + + /** + * Check Participant Get respects return properties + */ function testGetWithReturnProperties() { $params = array( 'contact_id' => $this->_contactID, 'return.status_id' => 1, @@ -391,9 +392,10 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { // assertDBState compares expected values in $match to actual values in the DB $this->assertDBState('CRM_Event_DAO_Participant', $participant['id'], $params); } - /* - * Test to check if receive date is being changed per CRM-9763 - */ + + /** + * Test to check if receive date is being changed per CRM-9763 + */ function testCreateUpdateReceiveDate() { $participant = $this->callAPISuccess('participant', 'create', $this->_params); $update = array( @@ -403,9 +405,10 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { $this->callAPISuccess('participant', 'create', $update); $this->getAndCheck(array_merge($this->_params, $update), $participant['id'], 'participant'); } - /* - * Test to check if participant fee level is being changed per CRM-9781 - */ + + /** + * Test to check if participant fee level is being changed per CRM-9781 + */ function testCreateUpdateParticipantFeeLevel() { $myParams = $this->_params + array('participant_fee_level' => CRM_Core_DAO::VALUE_SEPARATOR . "fee" . CRM_Core_DAO::VALUE_SEPARATOR); $participant = $this->callAPISuccess('participant', 'create', $myParams); @@ -423,8 +426,8 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Test the line items for participant fee with multiple price field values. - */ + * Test the line items for participant fee with multiple price field values. + */ function testCreateParticipantLineItems() { // Create a price set for this event. @@ -669,9 +672,10 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { $participant = $this->callAPIFailure('participant', 'delete', $params); $this->assertNotNull($participant['error_message']); } - /* - * delete with a get - a 'criteria delete' - */ + + /** + * delete with a get - a 'criteria delete' + */ function testNestedDelete() { $description = "Criteria delete by nesting a GET & a DELETE"; $subfile = "NestedDelete"; @@ -682,9 +686,10 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { $check = $this->callAPISuccess('participant', 'getcount', array()); $this->assertEquals(1, $check,"only one participant should be left. line " . __LINE__); } - /* - * Test creation of a participant with an associated contribution - */ + + /** + * Test creation of a participant with an associated contribution + */ function testCreateParticipantWithPayment() { $description = "single function to create contact w partipation & contribution. Note that in the case of 'contribution' the 'create' is implied (api.contribution.create)"; diff --git a/tests/phpunit/api/v3/PledgePaymentTest.php b/tests/phpunit/api/v3/PledgePaymentTest.php index 8ca9c27345..962e79146c 100644 --- a/tests/phpunit/api/v3/PledgePaymentTest.php +++ b/tests/phpunit/api/v3/PledgePaymentTest.php @@ -71,12 +71,10 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { $this->assertEquals(5, $result['count'], " in line " . __LINE__); } - /* - * Test that passing in a single variable works - */ + /** + * Test that passing in a single variable works + */ function testGetSinglePledgePayment() { - - $createparams = array( 'contact_id' => $this->_individualId, 'pledge_id' => $this->_pledgeID, @@ -91,12 +89,10 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { $this->assertEquals(1, $result['count'], " in line " . __LINE__); } - /* - * Test that passing in a single variable works:: status_id - */ + /** + * Test that passing in a single variable works:: status_id + */ function testGetSinglePledgePaymentByStatusID() { - - $createparams = array( 'contact_id' => $this->_individualId, 'pledge_id' => $this->_pledgeID, @@ -112,9 +108,9 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { $this->assertEquals(1, $result['count'], " in line " . __LINE__); } - /* - * Test that creating a payment will add the contribution ID - */ + /** + * Test that creating a payment will add the contribution ID + */ function testCreatePledgePayment() { //check that 5 pledge payments exist at the start $beforeAdd = $this->callAPISuccess('pledge_payment', 'get', array()); @@ -158,9 +154,9 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { $this->assertEquals($this->_contributionID, $getIndPaymentAgain['values'][$result['id']]['contribution_id'], " in line " . __LINE__); } - /* - * test checks behaviour when more payments are created than should be possible - */ + /** + * test checks behaviour when more payments are created than should be possible + */ function testCreatePledgePaymentAllCreated() { $params = array( 'pledge_id' => $this->_pledgeID, @@ -199,12 +195,12 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { $this->assertEquals(6, $result['count']); } - /* - * Test that creating a payment will add the contribution ID where only one pledge payment - * in schedule - */ - function testCreatePledgePaymentWhereOnlyOnePayment() { + /** + * Test that creating a payment will add the contribution ID where only one pledge payment + * in schedule + */ + function testCreatePledgePaymentWhereOnlyOnePayment() { $pledgeParams = array( 'contact_id' => $this->_individualId, 'pledge_create_date' => date('Ymd'), diff --git a/tests/phpunit/api/v3/PledgeTest.php b/tests/phpunit/api/v3/PledgeTest.php index b3a4e4b257..f0c4974c37 100644 --- a/tests/phpunit/api/v3/PledgeTest.php +++ b/tests/phpunit/api/v3/PledgeTest.php @@ -291,13 +291,13 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } - /* - * Test creation of pledge with only one payment. - * - * Pledge status id left empty as it is not a required field - * http://issues.civicrm.org/jira/browse/CRM-8551 - * - */ + /** + * Test creation of pledge with only one payment. + * + * Pledge status id left empty as it is not a required field + * http://issues.civicrm.org/jira/browse/CRM-8551 + * + */ function testCreatePledgeSinglePayment() { $params = array( 'scheduled_date' => '20110510', @@ -354,9 +354,9 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); } - /* - * test that status is set to pending - */ + /** + * test that status is set to pending + */ function testCreatePledgeNoStatus() { $params = $this->_params; @@ -369,9 +369,10 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); } - //To Update Pledge + /** + * To Update Pledge + */ function testCreateUpdatePledge() { - // we test 'sequential' param here too $pledgeID = $this->pledgeCreate($this->_individualId); $old_params = array( @@ -410,11 +411,11 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__); $pledge = $this->callAPISuccess('pledge', 'delete', $new_params); } -/** - * Here we ensure we are maintaining our 'contract' & supporting previously working syntax - * ie contribution_type_id - * - */ + + /** + * Here we ensure we are maintaining our 'contract' & supporting previously working syntax + * ie contribution_type_id + */ function testCreateUpdatePledgeLegacy() { // we test 'sequential' param here too @@ -470,9 +471,9 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id'); } - /* - * legacy support for pledge_id - */ + /** + * legacy support for pledge_id + */ function testDeletePledge() { $pledgeID = $this->pledgeCreate($this->_individualId); @@ -482,9 +483,9 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__); } - /* - * std is to accept id - */ + /** + * std is to accept id + */ function testDeletePledgeUseID() { $pledgeID = $this->pledgeCreate($this->_individualId); @@ -493,11 +494,12 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ); $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__); } - /* - * test to make sure empty get returns nothing - * Note that the function gives incorrect results if no pledges exist as it does a - * contact search instead - test only checks that the get finds the one existing - */ + + /** + * test to make sure empty get returns nothing + * Note that the function gives incorrect results if no pledges exist as it does a + * contact search instead - test only checks that the get finds the one existing + */ function testGetEmpty() { $result = $this->callAPISuccess('pledge', 'create', $this->_params); $result = $this->callAPISuccess('pledge', 'get', array()); diff --git a/tests/phpunit/api/v3/ProfileTest.php b/tests/phpunit/api/v3/ProfileTest.php index b73cbc570c..4499acaa73 100644 --- a/tests/phpunit/api/v3/ProfileTest.php +++ b/tests/phpunit/api/v3/ProfileTest.php @@ -256,9 +256,9 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'Invalid Activity Id (aid).'); } - /* - * check contact activity profile with wrong activity type - */ + /** + * check contact activity profile with wrong activity type + */ function testContactActivityGetWrongActivityType() { //flush cache by calling with reset $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name', TRUE); @@ -289,9 +289,9 @@ class api_v3_ProfileTest extends CiviUnitTestCase { ); } - /* - * check contact activity profile with success - */ + /** + * check contact activity profile with success + */ function testContactActivityGetSuccess() { list($params, $expected) = $this->_createContactWithActivity(); @@ -318,6 +318,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $this->assertEquals('defaultValue', $result['values']['custom_1']['default_value']); $this->assertFalse(array_key_exists('participant_status', $result['values'])); } + /** * Check getfields works & gives us our fields - partipant profile */ @@ -535,9 +536,10 @@ class api_v3_ProfileTest extends CiviUnitTestCase { ); } } - /* - * check contact activity profile without activity id - */ + + /** + * check contact activity profile without activity id + */ function testContactActivitySubmitWithoutActivityId() { list($params, $expected) = $this->_createContactWithActivity(); @@ -547,9 +549,9 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: activity_id'); } - /* - * check contact activity profile wrong activity id - */ + /** + * check contact activity profile wrong activity id + */ function testContactActivitySubmitWrongActivityId() { list($params, $expected) = $this->_createContactWithActivity(); $params = array_merge($params, $expected); @@ -558,9 +560,9 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $this->assertEquals($result['error_message'], 'Invalid Activity Id (aid).'); } - /* - * check contact activity profile with wrong activity type - */ + /** + * check contact activity profile with wrong activity type + */ function testContactActivitySubmitWrongActivityType() { //flush cache by calling with reset $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name', TRUE); @@ -591,9 +593,9 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'This activity cannot be edited or viewed via this profile.'); } - /* - * check contact activity profile with success - */ + /** + * check contact activity profile with success + */ function testContactActivitySubmitSuccess() { list($params, $expected) = $this->_createContactWithActivity(); @@ -701,10 +703,8 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } } - /* - * Helper function to create an Individual with address/email/phone info. Import UF Group and UF Fields - */ /** + * Helper function to create an Individual with address/email/phone info. Import UF Group and UF Fields * @param array $params * * @return mixed diff --git a/tests/phpunit/api/v3/SettingTest.php b/tests/phpunit/api/v3/SettingTest.php index 261676a7e9..ac51335d55 100644 --- a/tests/phpunit/api/v3/SettingTest.php +++ b/tests/phpunit/api/v3/SettingTest.php @@ -71,7 +71,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { parent::setUp(); $params = array( 'name' => 'Default Domain Name', - ); + ); $result = $this->callAPISuccess( 'domain','get',$params); if(empty($result['id'])){ $result = $this->callAPISuccess( 'domain','create',$params ); @@ -234,8 +234,8 @@ class api_v3_SettingTest extends CiviUnitTestCase { $description = "shows setting a variable for a given domain - if no domain is set current is assumed"; $params = array( - 'domain_id' => $this->_domainID2, - 'uniq_email_per_site' => 1, + 'domain_id' => $this->_domainID2, + 'uniq_email_per_site' => 1, ); $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__); @@ -249,68 +249,62 @@ class api_v3_SettingTest extends CiviUnitTestCase { * check getfields works */ function testCreateInvalidSettings() { + $params = array( + 'domain_id' => $this->_domainID2, + 'invalid_key' => 1, + ); + $result = $this->callAPIFailure('setting', 'create', $params); + } + /** + * check invalid settings rejected - + */ + function testCreateInvalidURLSettings() { $params = array( - 'domain_id' => $this->_domainID2, - 'invalid_key' => 1, + 'domain_id' => $this->_domainID2, + 'userFrameworkResourceURL' => 'dfhkdhfd', ); $result = $this->callAPIFailure('setting', 'create', $params); - } - - /** - * check invalid settings rejected - - */ - - function testCreateInvalidURLSettings() { - - $params = array( - 'domain_id' => $this->_domainID2, - 'userFrameworkResourceURL' => 'dfhkdhfd', - ); - $result = $this->callAPIFailure('setting', 'create', $params); - $params = array( - 'domain_id' => $this->_domainID2, - 'userFrameworkResourceURL' => 'http://blah.com', - ); - $result = $this->callAPISuccess('setting', 'create', $params); - } - - /** - * check getfields works - */ - function testCreateInvalidBooleanSettings() { - - $params = array( - 'domain_id' => $this->_domainID2, - 'track_civimail_replies' => 'dfhkdhfd', - ); - $result = $this->callAPIFailure('setting', 'create', $params); - - $params = array('track_civimail_replies' => '0',); - $result = $this->callAPISuccess('setting', 'create', $params); - $getResult = $this->callAPISuccess('setting','get',$params); - $this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']); - - $getResult = $this->callAPISuccess('setting','get',$params); - $this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']); - $params = array( 'domain_id' => $this->_domainID2, - 'track_civimail_replies' => '1', - ); - $result = $this->callAPISuccess('setting', 'create', $params); - $getResult = $this->callAPISuccess('setting','get',$params); - $this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies']); - - $params = array( - 'domain_id' => $this->_domainID2, - 'track_civimail_replies' => 'TRUE', - ); - $result = $this->callAPISuccess('setting', 'create', $params); - $getResult = $this->callAPISuccess('setting','get',$params); - - $this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies'], "check TRUE is converted to 1"); - - - } + $params = array( + 'domain_id' => $this->_domainID2, + 'userFrameworkResourceURL' => 'http://blah.com', + ); + $result = $this->callAPISuccess('setting', 'create', $params); + } + + /** + * check getfields works + */ + function testCreateInvalidBooleanSettings() { + $params = array( + 'domain_id' => $this->_domainID2, + 'track_civimail_replies' => 'dfhkdhfd', + ); + $result = $this->callAPIFailure('setting', 'create', $params); + + $params = array('track_civimail_replies' => '0',); + $result = $this->callAPISuccess('setting', 'create', $params); + $getResult = $this->callAPISuccess('setting','get',$params); + $this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']); + + $getResult = $this->callAPISuccess('setting','get',$params); + $this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']); + $params = array( 'domain_id' => $this->_domainID2, + 'track_civimail_replies' => '1', + ); + $result = $this->callAPISuccess('setting', 'create', $params); + $getResult = $this->callAPISuccess('setting','get',$params); + $this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies']); + + $params = array( + 'domain_id' => $this->_domainID2, + 'track_civimail_replies' => 'TRUE', + ); + $result = $this->callAPISuccess('setting', 'create', $params); + $getResult = $this->callAPISuccess('setting','get',$params); + + $this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies'], "check TRUE is converted to 1"); + } /** * check getfields works @@ -319,8 +313,8 @@ class api_v3_SettingTest extends CiviUnitTestCase { $description = "shows setting a variable for all domains"; $params = array( - 'domain_id' => 'all', - 'uniq_email_per_site' => 1, + 'domain_id' => 'all', + 'uniq_email_per_site' => 1, ); $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__,$description, 'CreateAllDomains'); @@ -330,8 +324,8 @@ class api_v3_SettingTest extends CiviUnitTestCase { $this->assertEquals(1, $result['values'][3]['uniq_email_per_site'], 'failed to set setting for domain 3.'); $params = array( - 'domain_id' => 'all', - 'return' => 'uniq_email_per_site' + 'domain_id' => 'all', + 'return' => 'uniq_email_per_site' ); // we'll check it with a 'get' $description = "shows getting a variable for all domains"; @@ -342,8 +336,8 @@ class api_v3_SettingTest extends CiviUnitTestCase { $this->assertEquals(1, $result['values'][3]['uniq_email_per_site']); $params = array( - 'domain_id' => array(1,3), - 'uniq_email_per_site' => 0, + 'domain_id' => array(1,3), + 'uniq_email_per_site' => 0, ); $description = "shows setting a variable for specified domains"; $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__,$description, 'CreateSpecifiedDomains'); @@ -351,8 +345,8 @@ class api_v3_SettingTest extends CiviUnitTestCase { $this->assertEquals(0, $result['values'][3]['uniq_email_per_site']); $this->assertEquals(0, $result['values'][1]['uniq_email_per_site']); $params = array( - 'domain_id' => array(1,2), - 'return' => array('uniq_email_per_site'), + 'domain_id' => array(1,2), + 'return' => array('uniq_email_per_site'), ); $description = "shows getting a variable for specified domains"; $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__,$description, 'GetSpecifiedDomains', 'Get'); @@ -362,7 +356,6 @@ class api_v3_SettingTest extends CiviUnitTestCase { } function testGetSetting() { - $params = array( 'domain_id' => $this->_domainID2, 'return' => 'uniq_email_per_site', @@ -394,9 +387,10 @@ class api_v3_SettingTest extends CiviUnitTestCase { $result = $this->callAPISuccess('setting', 'getvalue', array('name' => 'test_key', 'group' => 'Test Settings')); $this->assertEquals('keyset', $result); } -/** - * setting api should set & fetch settings stored in config as well as those in settings table - */ + + /** + * setting api should set & fetch settings stored in config as well as those in settings table + */ function testSetConfigSetting() { $config = CRM_Core_Config::singleton(); $this->assertFalse($config->debug == 1); @@ -415,12 +409,13 @@ class api_v3_SettingTest extends CiviUnitTestCase { $dao->fetch(); $this->assertEquals($dao->c, 0); } + /** * setting api should set & fetch settings stored in config as well as those in settings table */ function testGetConfigSetting() { $settings = $this->callAPISuccess('setting', 'get', array( - 'name' => 'defaultCurrency', 'sequential' => 1,) + 'name' => 'defaultCurrency', 'sequential' => 1,) ); $this->assertEquals('USD', $settings['values'][0]['defaultCurrency']); } @@ -430,13 +425,13 @@ class api_v3_SettingTest extends CiviUnitTestCase { */ function testGetSetConfigSettingMultipleDomains() { $settings = $this->callAPISuccess('setting', 'create', array( - 'defaultCurrency' => 'USD', 'domain_id' => $this->_currentDomain) + 'defaultCurrency' => 'USD', 'domain_id' => $this->_currentDomain) ); $settings = $this->callAPISuccess('setting', 'create', array( - 'defaultCurrency' => 'CAD', 'domain_id' => $this->_domainID2) + 'defaultCurrency' => 'CAD', 'domain_id' => $this->_domainID2) ); $settings = $this->callAPISuccess('setting', 'get', array( - 'return' => 'defaultCurrency', 'domain_id' => 'all', + 'return' => 'defaultCurrency', 'domain_id' => 'all', ) ); $this->assertEquals('USD', $settings['values'][$this->_currentDomain]['defaultCurrency']); @@ -445,9 +440,9 @@ class api_v3_SettingTest extends CiviUnitTestCase { } -/* - * Use getValue against a config setting - */ + /** + * Use getValue against a config setting + */ function testGetValueConfigSetting() { $params = array( 'name' => 'monetaryThousandSeparator', 'group' => 'Localization Setting', @@ -479,11 +474,11 @@ class api_v3_SettingTest extends CiviUnitTestCase { $this->assertEquals("{contact.addressee}\n{contact.street_address}\n{contact.supplemental_address_1}\n{contact.supplemental_address_2}\n{contact.city}{, }{contact.state_province}{ }{contact.postal_code}\n{contact.country}", $result['values'][CRM_Core_Config::domainID()]['mailing_format']); $this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']); } - /* + + /** * Function tests reverting a specific parameter */ function testRevert() { - $params = array( 'address_format' => 'xyz', 'mailing_format' => 'bcs', ); @@ -505,13 +500,13 @@ class api_v3_SettingTest extends CiviUnitTestCase { //make sure it's unchanged $this->assertEquals('bcs', $result['values'][CRM_Core_Config::domainID()]['mailing_format']); } - /* + + /** * Tests reverting ALL parameters (specific domain) */ function testRevertAll() { - $params = array( 'address_format' => 'xyz', - 'mailing_format' => 'bcs', + 'mailing_format' => 'bcs', ); $result = $this->callAPISuccess('setting', 'create', $params); $revertParams = array( ); @@ -526,20 +521,20 @@ class api_v3_SettingTest extends CiviUnitTestCase { $this->assertEquals("{contact.addressee}\n{contact.street_address}\n{contact.supplemental_address_1}\n{contact.supplemental_address_2}\n{contact.city}{, }{contact.state_province}{ }{contact.postal_code}\n{contact.country}", $result['values'][CRM_Core_Config::domainID()]['mailing_format']); } - /* + /** * Tests filling missing params - */ + */ function testFill() { $domparams = array( 'name' => 'B Team Domain', - ); + ); $dom = $this->callAPISuccess('domain', 'create', $domparams); $params = array( 'domain_id' => 'all', ); $result = $this->callAPISuccess('setting', 'get', $params); $params = array( 'address_format' => 'xyz', - 'mailing_format' => 'bcs', - 'domain_id' => $this->_domainID2, + 'mailing_format' => 'bcs', + 'domain_id' => $this->_domainID2, ); $result = $this->callAPISuccess('setting', 'create', $params); $params = array( 'domain_id' => $dom['id'], diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index 0b9cb64b4b..541d54ef97 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -679,9 +679,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { * * @dataProvider entities_getlimit * - * @param $entityName + * @param string $entityName * - * @internal param string $entity */ function testLimit($entityName) { $cases = array(); // each case is array(0 => $inputtedApiOptions, 1 => $expectedResultCount) @@ -746,9 +745,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { * * @dataProvider entities_getSqlOperators * - * @param $entityName + * @param string $entityName * - * @internal param string $entity */ function testSqlOperators($entityName) { $baoString = _civicrm_api3_get_BAO($entityName); @@ -1252,7 +1250,6 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { * @param $entityName * @param int $count * - * @internal param $entityName * * @return array */ diff --git a/tests/phpunit/api/v3/TaxContributionPageTest.php b/tests/phpunit/api/v3/TaxContributionPageTest.php index 599a12ae2a..dca090139f 100644 --- a/tests/phpunit/api/v3/TaxContributionPageTest.php +++ b/tests/phpunit/api/v3/TaxContributionPageTest.php @@ -440,7 +440,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { } /** - * @param $params + * @param array $params * @param $context */ function _checkFinancialRecords($params, $context) { @@ -503,7 +503,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { } /** - * @param $params + * @param array $params * @param $financialTypeId */ function _getFinancialAccountId($financialTypeId) { diff --git a/tests/phpunit/api/v3/UtilsTest.php b/tests/phpunit/api/v3/UtilsTest.php index f0637e76ac..e1de92143b 100644 --- a/tests/phpunit/api/v3/UtilsTest.php +++ b/tests/phpunit/api/v3/UtilsTest.php @@ -134,9 +134,9 @@ class api_v3_UtilsTest extends CiviUnitTestCase { } } - /* - * Test verify mandatory - includes DAO & passed as well as empty & NULL fields - */ + /** + * Test verify mandatory - includes DAO & passed as well as empty & NULL fields + */ function testVerifyMandatory() { _civicrm_api3_initialize(TRUE); $params = array( @@ -158,9 +158,9 @@ class api_v3_UtilsTest extends CiviUnitTestCase { $this->fail('An expected exception has not been raised.'); } - /* - * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields - */ + /** + * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields + */ function testVerifyOneMandatory() { _civicrm_api3_initialize(TRUE); $params = array( @@ -183,9 +183,9 @@ class api_v3_UtilsTest extends CiviUnitTestCase { $this->fail('An expected exception has not been raised.'); } - /* - * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields - */ + /** + * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields + */ function testVerifyOneMandatoryOneSet() { _civicrm_api3_initialize(TRUE); $params = array('version' => 3, 'entity_table' => 'civicrm_contact', 'note' => 'note', 'contact_id' => $this->_contactID, 'modified_date' => '2011-01-31', 'subject' => NULL); @@ -199,7 +199,7 @@ class api_v3_UtilsTest extends CiviUnitTestCase { } - /* + /** * Test GET DAO function returns DAO */ function testGetDAO() { @@ -218,7 +218,8 @@ class api_v3_UtilsTest extends CiviUnitTestCase { $this->assertEquals($expected, $result); } } - /* + + /** * Test GET BAO function returns BAO when it exists */ function testGetBAO() { diff --git a/tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php b/tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php index debc7885a4..eb2939e629 100644 --- a/tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php +++ b/tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php @@ -1,7 +1,7 @@ save(); $transaction->commit(); return TRUE; @@ -205,7 +204,6 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base $input['component'] = strtolower($component); - // CRM_Core_Error::debug_var( "$status, $component", $dataRoot ); $orderNo = $dataRoot['google-order-number']['VALUE']; require_once 'CRM/Contribute/DAO/Contribution.php'; @@ -253,7 +251,6 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base require_once 'CRM/Core/Transaction.php'; $transaction = new CRM_Core_Transaction(); - // CRM_Core_Error::debug_var( 'c', $contribution ); if ($status == 'PAYMENT_DECLINED' || $status == 'CANCELLED_BY_GOOGLE' || $status == 'CANCELLED' diff --git a/tools/extensions/org.civicrm.search.activity/ActivitySearch.php b/tools/extensions/org.civicrm.search.activity/ActivitySearch.php index 336aa10801..64f69b97b3 100644 --- a/tools/extensions/org.civicrm.search.activity/ActivitySearch.php +++ b/tools/extensions/org.civicrm.search.activity/ActivitySearch.php @@ -94,7 +94,7 @@ class org_civicrm_search_activityimplementsCRM_Contact_Form_Search_Interface { } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { @@ -263,11 +263,9 @@ class org_civicrm_search_activityimplementsCRM_Contact_Form_Search_Interface { ON assignment.assignee_contact_id = contact_c.id "; } - /* - * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values - * - */ /** + * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values + * * @param bool $includeContactIDs * * @return string @@ -343,8 +341,9 @@ class org_civicrm_search_activityimplementsCRM_Contact_Form_Search_Interface { } /* - * Functions below generally don't need to be modified - */ + * Functions below generally don't need to be modified + */ + /** * @return mixed */ diff --git a/tools/extensions/org.civicrm.search.basic/Basic.php b/tools/extensions/org.civicrm.search.basic/Basic.php index 7e2a635f60..2d6493bb73 100644 --- a/tools/extensions/org.civicrm.search.basic/Basic.php +++ b/tools/extensions/org.civicrm.search.basic/Basic.php @@ -103,7 +103,7 @@ class org_civicrm_search_basic extends CRM_Contact_Form_Search_Custom_Baseimplem } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { diff --git a/tools/extensions/org.civicrm.search.multivalue/MultiValue.php b/tools/extensions/org.civicrm.search.multivalue/MultiValue.php index 8b0d1b07b7..6486ff0673 100644 --- a/tools/extensions/org.civicrm.search.multivalue/MultiValue.php +++ b/tools/extensions/org.civicrm.search.multivalue/MultiValue.php @@ -94,7 +94,7 @@ class org_civicrm_search_multivalue extends CRM_Contact_Form_Search_Custom_Basei } /** - * @param $form + * @param CRM_Core_Form $form */ function buildForm(&$form) { diff --git a/tools/scripts/solr/createSyncJSON.php b/tools/scripts/solr/createSyncJSON.php index b8041af900..77bbfd06d1 100644 --- a/tools/scripts/solr/createSyncJSON.php +++ b/tools/scripts/solr/createSyncJSON.php @@ -454,7 +454,7 @@ function appendValue(&$values, $id, $name, $value, $ignored = FALSE) { } /** - * @param $daoName + * @param string $daoName * * @return mixed */ diff --git a/xml/plugins/block.ts.php b/xml/plugins/block.ts.php index b34371b034..56fbe713ba 100644 --- a/xml/plugins/block.ts.php +++ b/xml/plugins/block.ts.php @@ -1,6 +1,6 @@