From fe482240fb0d8a15a50325a36b2854ffbafeffab Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Feb 2015 18:02:22 +1300 Subject: [PATCH] INFRA-132 comments to end with full stops --- CRM/ACL/BAO/ACL.php | 2 +- CRM/ACL/BAO/EntityRole.php | 2 +- CRM/Activity/BAO/Activity.php | 4 +- CRM/Activity/BAO/ActivityAssignment.php | 6 +- CRM/Activity/BAO/ActivityContact.php | 6 +- CRM/Activity/BAO/ActivityTarget.php | 8 +- CRM/Activity/BAO/ICalendar.php | 6 +- CRM/Activity/BAO/Query.php | 8 +- CRM/Activity/Controller/Search.php | 12 +- CRM/Activity/Form/Activity.php | 24 +-- CRM/Activity/Form/ActivityView.php | 4 +- CRM/Activity/Form/Search.php | 14 +- CRM/Activity/Form/Task.php | 12 +- CRM/Activity/Form/Task/AddToTag.php | 8 +- CRM/Activity/Form/Task/Batch.php | 10 +- CRM/Activity/Form/Task/Delete.php | 6 +- CRM/Activity/Form/Task/Email.php | 8 +- CRM/Activity/Form/Task/FileOnCase.php | 14 +- CRM/Activity/Form/Task/PickOption.php | 18 +- CRM/Activity/Form/Task/PickProfile.php | 16 +- CRM/Activity/Form/Task/Print.php | 2 +- CRM/Activity/Form/Task/RemoveFromTag.php | 2 +- CRM/Activity/Form/Task/SMS.php | 8 +- .../Form/Task/SearchTaskHookSample.php | 4 +- CRM/Activity/Import/Form/DataSource.php | 6 +- CRM/Activity/Import/Form/MapField.php | 8 +- CRM/Activity/Import/Form/Preview.php | 4 +- CRM/Activity/Import/Form/Summary.php | 2 +- CRM/Activity/Import/Parser.php | 12 +- CRM/Activity/Import/Parser/Activity.php | 10 +- CRM/Activity/Page/Tab.php | 2 +- CRM/Activity/Page/UserDashboard.php | 2 +- CRM/Activity/Selector/Activity.php | 6 +- CRM/Activity/Selector/Search.php | 18 +- CRM/Activity/StateMachine/Search.php | 6 +- CRM/Activity/Task.php | 12 +- CRM/Badge/BAO/Layout.php | 8 +- CRM/Batch/Form/Entry.php | 2 +- CRM/Bridge/OG/Utils.php | 2 +- CRM/Campaign/BAO/Campaign.php | 14 +- CRM/Campaign/BAO/Petition.php | 14 +- CRM/Campaign/BAO/Query.php | 2 +- CRM/Campaign/BAO/Survey.php | 33 ++- CRM/Campaign/Controller/Search.php | 2 +- CRM/Campaign/Form/Petition.php | 2 +- CRM/Campaign/Form/Petition/Signature.php | 6 +- CRM/Campaign/Form/Search.php | 12 +- CRM/Campaign/Form/Search/Campaign.php | 6 +- CRM/Campaign/Form/Search/Petition.php | 6 +- CRM/Campaign/Form/Search/Survey.php | 6 +- CRM/Campaign/Form/Survey.php | 8 +- CRM/Campaign/Form/Survey/Delete.php | 6 +- CRM/Campaign/Form/Survey/Main.php | 6 +- CRM/Campaign/Form/Survey/Questions.php | 4 +- CRM/Campaign/Form/Survey/Results.php | 6 +- CRM/Campaign/Form/SurveyType.php | 6 +- CRM/Campaign/Form/Task.php | 4 +- CRM/Campaign/Form/Task/Interview.php | 6 +- CRM/Campaign/Form/Task/Print.php | 4 +- CRM/Campaign/Form/Task/Release.php | 4 +- CRM/Campaign/Form/Task/Reserve.php | 8 +- CRM/Campaign/Form/Task/Result.php | 4 +- CRM/Campaign/Info.php | 2 +- CRM/Campaign/Page/Campaign.php | 2 +- CRM/Campaign/Page/DashBoard.php | 2 +- CRM/Campaign/Page/Petition/Confirm.php | 2 +- CRM/Campaign/Page/SurveyType.php | 18 +- CRM/Campaign/Selector/Search.php | 10 +- CRM/Campaign/StateMachine/Search.php | 6 +- CRM/Case/BAO/Case.php | 9 +- CRM/Case/BAO/CaseType.php | 7 +- CRM/Case/BAO/Query.php | 10 +- CRM/Case/Controller/Search.php | 2 +- CRM/Case/Form/Activity/LinkCases.php | 6 +- CRM/Case/Form/Activity/OpenCase.php | 8 +- CRM/Case/Form/ActivityToCase.php | 2 +- CRM/Case/Form/ActivityView.php | 2 +- CRM/Case/Form/Case.php | 8 +- CRM/Case/Form/CaseView.php | 6 +- CRM/Case/Form/CustomData.php | 6 +- CRM/Case/Form/EditClient.php | 6 +- CRM/Case/Form/Report.php | 4 +- CRM/Case/Form/Search.php | 8 +- CRM/Case/Form/Task.php | 2 +- CRM/Case/Form/Task/Delete.php | 4 +- CRM/Case/Form/Task/Print.php | 4 +- CRM/Case/Form/Task/Restore.php | 6 +- CRM/Case/Form/Task/Result.php | 4 +- CRM/Case/Form/Task/SearchTaskHookSample.php | 4 +- CRM/Case/Info.php | 2 +- CRM/Case/Page/AJAX.php | 2 +- CRM/Case/Page/Tab.php | 10 +- CRM/Case/PseudoConstant.php | 10 +- CRM/Case/Selector/Search.php | 4 +- CRM/Case/StateMachine/Search.php | 6 +- CRM/Case/Task.php | 8 +- CRM/Case/XMLProcessor/Process.php | 4 +- CRM/Case/XMLProcessor/Report.php | 2 +- CRM/Contact/BAO/Contact.php | 8 +- CRM/Contact/BAO/Contact/Location.php | 4 +- CRM/Contact/BAO/Contact/Permission.php | 8 +- CRM/Contact/BAO/Contact/Utils.php | 22 +- CRM/Contact/BAO/ContactType.php | 16 +- CRM/Contact/BAO/Group.php | 30 ++- CRM/Contact/BAO/GroupContact.php | 16 +- CRM/Contact/BAO/GroupContactCache.php | 10 +- CRM/Contact/BAO/GroupNesting.php | 2 +- CRM/Contact/BAO/GroupOrganization.php | 12 +- CRM/Contact/BAO/Household.php | 2 +- CRM/Contact/BAO/Individual.php | 6 +- CRM/Contact/BAO/Query.php | 62 +++--- CRM/Contact/BAO/Query/Hook.php | 2 +- CRM/Contact/BAO/Relationship.php | 38 ++-- CRM/Contact/BAO/RelationshipType.php | 10 +- CRM/Contact/BAO/SavedSearch.php | 9 +- CRM/Contact/BAO/SubscriptionHistory.php | 4 +- CRM/Contact/Form/Contact.php | 28 +-- CRM/Contact/Form/CustomData.php | 4 +- CRM/Contact/Form/DedupeFind.php | 8 +- CRM/Contact/Form/DedupeRules.php | 8 +- CRM/Contact/Form/Domain.php | 14 +- CRM/Contact/Form/Edit/Address.php | 4 +- .../Form/Edit/CommunicationPreferences.php | 6 +- CRM/Contact/Form/Edit/CustomData.php | 4 +- CRM/Contact/Form/Edit/Demographics.php | 2 +- CRM/Contact/Form/Edit/Email.php | 2 +- CRM/Contact/Form/Edit/Household.php | 4 +- CRM/Contact/Form/Edit/IM.php | 2 +- CRM/Contact/Form/Edit/Individual.php | 2 +- CRM/Contact/Form/Edit/Lock.php | 2 +- CRM/Contact/Form/Edit/Notes.php | 2 +- CRM/Contact/Form/Edit/OpenID.php | 2 +- CRM/Contact/Form/Edit/TagsAndGroups.php | 6 +- CRM/Contact/Form/Edit/Website.php | 2 +- CRM/Contact/Form/GroupContact.php | 2 +- CRM/Contact/Form/Inline.php | 17 +- CRM/Contact/Form/Inline/Address.php | 8 +- .../Form/Inline/CommunicationPreferences.php | 6 +- CRM/Contact/Form/Inline/ContactInfo.php | 6 +- CRM/Contact/Form/Inline/ContactName.php | 4 +- CRM/Contact/Form/Inline/CustomData.php | 12 +- CRM/Contact/Form/Inline/Demographics.php | 4 +- CRM/Contact/Form/Inline/Email.php | 14 +- CRM/Contact/Form/Inline/IM.php | 14 +- CRM/Contact/Form/Inline/Lock.php | 2 +- CRM/Contact/Form/Inline/OpenID.php | 14 +- CRM/Contact/Form/Inline/Phone.php | 10 +- CRM/Contact/Form/Inline/Website.php | 12 +- CRM/Contact/Form/Location.php | 4 +- CRM/Contact/Form/ProfileContact.php | 2 +- CRM/Contact/Form/RelatedContact.php | 4 +- CRM/Contact/Form/Relationship.php | 6 +- CRM/Contact/Form/Search.php | 32 +-- CRM/Contact/Form/Search/Advanced.php | 10 +- CRM/Contact/Form/Search/Basic.php | 10 +- CRM/Contact/Form/Search/Builder.php | 12 +- CRM/Contact/Form/Search/Custom.php | 2 +- .../Form/Search/Custom/ActivitySearch.php | 4 +- .../Search/Custom/ContributionAggregate.php | 4 +- .../Form/Search/Custom/EmployerListing.php | 4 +- .../Form/Search/Custom/EventAggregate.php | 4 +- .../Custom/FullText/AbstractPartialQuery.php | 2 +- .../Form/Search/Custom/TagContributions.php | 2 +- CRM/Contact/Form/Task/AddToGroup.php | 12 +- CRM/Contact/Form/Task/AddToHousehold.php | 6 +- CRM/Contact/Form/Task/AddToOrganization.php | 6 +- CRM/Contact/Form/Task/AddToTag.php | 8 +- CRM/Contact/Form/Task/AlterPreferences.php | 6 +- CRM/Contact/Form/Task/Batch.php | 20 +- CRM/Contact/Form/Task/Delete.php | 8 +- CRM/Contact/Form/Task/Email.php | 16 +- CRM/Contact/Form/Task/EmailCommon.php | 6 +- CRM/Contact/Form/Task/HookSample.php | 4 +- CRM/Contact/Form/Task/Label.php | 8 +- CRM/Contact/Form/Task/LabelCommon.php | 4 +- CRM/Contact/Form/Task/Map.php | 8 +- CRM/Contact/Form/Task/Map/Event.php | 4 +- CRM/Contact/Form/Task/Merge.php | 2 +- CRM/Contact/Form/Task/PDF.php | 8 +- CRM/Contact/Form/Task/PDFLetterCommon.php | 12 +- CRM/Contact/Form/Task/PickProfile.php | 10 +- CRM/Contact/Form/Task/Print.php | 4 +- CRM/Contact/Form/Task/ProximityCommon.php | 14 +- CRM/Contact/Form/Task/RemoveFromGroup.php | 6 +- CRM/Contact/Form/Task/RemoveFromTag.php | 8 +- CRM/Contact/Form/Task/Result.php | 4 +- CRM/Contact/Form/Task/SMS.php | 6 +- CRM/Contact/Form/Task/SMSCommon.php | 6 +- CRM/Contact/Form/Task/SaveSearch.php | 6 +- CRM/Contact/Form/Task/SaveSearch/Update.php | 2 +- CRM/Contact/Form/Task/Unhold.php | 2 +- CRM/Contact/Form/Task/Useradd.php | 6 +- CRM/Contact/Import/Controller.php | 2 +- CRM/Contact/Import/Form/DataSource.php | 6 +- CRM/Contact/Import/Form/MapField.php | 10 +- CRM/Contact/Import/Form/Preview.php | 6 +- CRM/Contact/Import/Form/Summary.php | 4 +- CRM/Contact/Import/Page/AJAX.php | 2 +- CRM/Contact/Import/Parser.php | 12 +- CRM/Contact/Import/Parser/Contact.php | 24 +-- CRM/Contact/Page/AJAX.php | 20 +- CRM/Contact/Page/CustomSearch.php | 2 +- CRM/Contact/Page/DashBoard.php | 2 +- CRM/Contact/Page/Dashlet.php | 2 +- CRM/Contact/Page/DedupeFind.php | 14 +- CRM/Contact/Page/DedupeRules.php | 16 +- CRM/Contact/Page/SavedSearch.php | 4 +- CRM/Contact/Page/Task.php | 2 +- CRM/Contact/Page/View.php | 2 +- CRM/Contact/Page/View/ContactSmartGroup.php | 2 +- CRM/Contact/Page/View/CustomData.php | 4 +- CRM/Contact/Page/View/GroupContact.php | 4 +- CRM/Contact/Page/View/Log.php | 2 +- CRM/Contact/Page/View/Note.php | 12 +- CRM/Contact/Page/View/Print.php | 2 +- CRM/Contact/Page/View/Relationship.php | 14 +- CRM/Contact/Page/View/Summary.php | 4 +- CRM/Contact/Page/View/Sunlight.php | 2 +- CRM/Contact/Page/View/Tag.php | 2 +- CRM/Contact/Page/View/UserDashBoard.php | 10 +- .../Page/View/UserDashBoard/GroupContact.php | 4 +- CRM/Contact/Selector.php | 6 +- CRM/Contact/StateMachine/Search.php | 4 +- CRM/Contact/Task.php | 2 +- CRM/Contribute/BAO/Contribution.php | 53 +++-- CRM/Contribute/BAO/Contribution/Utils.php | 4 +- CRM/Contribute/BAO/ContributionPage.php | 12 +- CRM/Contribute/BAO/ContributionRecur.php | 8 +- CRM/Contribute/BAO/ContributionSoft.php | 8 +- CRM/Contribute/BAO/ManagePremiums.php | 12 +- CRM/Contribute/BAO/Premium.php | 16 +- CRM/Contribute/BAO/Query.php | 4 +- CRM/Contribute/Form/AbstractEditPayment.php | 6 +- CRM/Contribute/Form/AdditionalInfo.php | 6 +- CRM/Contribute/Form/CancelSubscription.php | 6 +- CRM/Contribute/Form/Contribution.php | 22 +- CRM/Contribute/Form/Contribution/Confirm.php | 12 +- CRM/Contribute/Form/Contribution/Main.php | 14 +- .../Form/Contribution/OnBehalfOf.php | 2 +- CRM/Contribute/Form/Contribution/ThankYou.php | 6 +- CRM/Contribute/Form/ContributionBase.php | 12 +- CRM/Contribute/Form/ContributionCharts.php | 8 +- CRM/Contribute/Form/ContributionPage.php | 12 +- .../Form/ContributionPage/AddProduct.php | 6 +- .../Form/ContributionPage/Amount.php | 6 +- .../Form/ContributionPage/Custom.php | 6 +- .../Form/ContributionPage/Delete.php | 10 +- .../Form/ContributionPage/Premium.php | 6 +- .../Form/ContributionPage/Settings.php | 8 +- .../Form/ContributionPage/ThankYou.php | 6 +- .../Form/ContributionPage/Widget.php | 2 +- CRM/Contribute/Form/ContributionView.php | 4 +- CRM/Contribute/Form/ManagePremiums.php | 10 +- CRM/Contribute/Form/Search.php | 12 +- CRM/Contribute/Form/SearchContribution.php | 2 +- CRM/Contribute/Form/SoftCredit.php | 8 +- CRM/Contribute/Form/Task.php | 16 +- CRM/Contribute/Form/Task/Batch.php | 6 +- CRM/Contribute/Form/Task/Delete.php | 6 +- CRM/Contribute/Form/Task/Email.php | 8 +- CRM/Contribute/Form/Task/Invoice.php | 22 +- CRM/Contribute/Form/Task/PDF.php | 10 +- CRM/Contribute/Form/Task/PDFLetter.php | 8 +- CRM/Contribute/Form/Task/PDFLetterCommon.php | 4 +- CRM/Contribute/Form/Task/PickProfile.php | 10 +- CRM/Contribute/Form/Task/Print.php | 4 +- CRM/Contribute/Form/Task/Result.php | 4 +- .../Form/Task/SearchTaskHookSample.php | 4 +- CRM/Contribute/Form/Task/Status.php | 8 +- CRM/Contribute/Form/UpdateBilling.php | 8 +- CRM/Contribute/Form/UpdateSubscription.php | 6 +- CRM/Contribute/Import/Controller.php | 2 +- CRM/Contribute/Import/Form/DataSource.php | 6 +- CRM/Contribute/Import/Form/MapField.php | 6 +- CRM/Contribute/Import/Form/Preview.php | 2 +- CRM/Contribute/Import/Form/Summary.php | 2 +- CRM/Contribute/Import/Parser.php | 10 +- CRM/Contribute/Import/Parser/Contribution.php | 8 +- CRM/Contribute/Info.php | 4 +- CRM/Contribute/Page/ContributionPage.php | 4 +- CRM/Contribute/Page/ContributionRecur.php | 2 +- CRM/Contribute/Page/ManagePremiums.php | 10 +- CRM/Contribute/Page/Premium.php | 10 +- CRM/Contribute/Page/Tab.php | 8 +- CRM/Contribute/Page/UserDashboard.php | 2 +- CRM/Contribute/PseudoConstant.php | 10 +- CRM/Contribute/Selector/Search.php | 4 +- CRM/Contribute/StateMachine/Contribution.php | 2 +- .../StateMachine/ContributionPage.php | 2 +- CRM/Contribute/StateMachine/Search.php | 4 +- CRM/Core/BAO/ActionLog.php | 2 +- CRM/Core/BAO/ActionSchedule.php | 16 +- CRM/Core/BAO/Address.php | 24 +-- CRM/Core/BAO/Block.php | 14 +- CRM/Core/BAO/CMSUser.php | 6 +- CRM/Core/BAO/Cache.php | 6 +- CRM/Core/BAO/ConfigSetting.php | 12 +- CRM/Core/BAO/CustomField.php | 26 +-- CRM/Core/BAO/CustomGroup.php | 12 +- CRM/Core/BAO/CustomOption.php | 6 +- CRM/Core/BAO/CustomValue.php | 4 +- CRM/Core/BAO/CustomValueTable.php | 11 +- CRM/Core/BAO/Dashboard.php | 20 +- CRM/Core/BAO/Discount.php | 6 +- CRM/Core/BAO/Domain.php | 12 +- CRM/Core/BAO/Email.php | 4 +- CRM/Core/BAO/EntityTag.php | 14 +- CRM/Core/BAO/Extension.php | 8 +- CRM/Core/BAO/FinancialTrxn.php | 14 +- CRM/Core/BAO/IM.php | 4 +- CRM/Core/BAO/Job.php | 14 +- CRM/Core/BAO/LabelFormat.php | 28 +-- CRM/Core/BAO/Location.php | 16 +- CRM/Core/BAO/LocationType.php | 16 +- CRM/Core/BAO/Log.php | 6 +- CRM/Core/BAO/MailSettings.php | 17 +- CRM/Core/BAO/Mapping.php | 18 +- CRM/Core/BAO/MessageTemplate.php | 12 +- CRM/Core/BAO/Navigation.php | 34 +-- CRM/Core/BAO/Note.php | 18 +- CRM/Core/BAO/OpenID.php | 6 +- CRM/Core/BAO/OptionGroup.php | 12 +- CRM/Core/BAO/OptionValue.php | 16 +- CRM/Core/BAO/PaperSize.php | 26 +-- CRM/Core/BAO/PdfFormat.php | 26 +-- CRM/Core/BAO/Persistent.php | 2 +- CRM/Core/BAO/Phone.php | 4 +- CRM/Core/BAO/PreferencesDate.php | 10 +- CRM/Core/BAO/PrevNextCache.php | 4 +- CRM/Core/BAO/RecurringEntity.php | 22 +- CRM/Core/BAO/Setting.php | 14 +- CRM/Core/BAO/Tag.php | 14 +- CRM/Core/BAO/UFField.php | 22 +- CRM/Core/BAO/UFGroup.php | 58 +++--- CRM/Core/BAO/UFJoin.php | 2 +- CRM/Core/BAO/UFMatch.php | 12 +- CRM/Core/BAO/Website.php | 8 +- CRM/Core/BAO/WordReplacement.php | 5 +- CRM/Core/Base.php | 2 +- CRM/Core/Block.php | 18 +- CRM/Core/CodeGen/Main.php | 2 +- CRM/Core/CodeGen/Specification.php | 2 +- CRM/Core/CodeGen/Util/File.php | 6 +- CRM/Core/Component/Info.php | 10 +- CRM/Core/Config/Defaults.php | 4 +- CRM/Core/Config/Variables.php | 18 +- CRM/Core/DAO.php | 42 ++-- CRM/Core/Form.php | 64 +++--- CRM/Core/Form/Date.php | 4 +- CRM/Core/Form/RecurringEntity.php | 4 +- CRM/Core/Form/Renderer.php | 8 +- CRM/Core/Form/Tag.php | 2 +- CRM/Core/I18n/Schema.php | 4 +- CRM/Core/IDS.php | 4 +- CRM/Core/Key.php | 4 +- CRM/Core/Menu.php | 12 +- CRM/Core/OptionGroup.php | 2 +- CRM/Core/Page.php | 26 +-- CRM/Core/Page/AJAX.php | 6 +- CRM/Core/Page/Basic.php | 18 +- CRM/Core/Page/QUnit.php | 2 +- CRM/Core/Payment/AuthorizeNet.php | 18 +- CRM/Core/Payment/AuthorizeNetIPN.php | 2 +- CRM/Core/Payment/BaseIPN.php | 18 +- CRM/Core/Payment/Dummy.php | 6 +- CRM/Core/Payment/Elavon.php | 8 +- CRM/Core/Payment/FirstData.php | 8 +- CRM/Core/Payment/Form.php | 10 +- CRM/Core/Payment/Google.php | 8 +- CRM/Core/Payment/GoogleIPN.php | 2 +- CRM/Core/Payment/IATS.php | 4 +- CRM/Core/Payment/Moneris.php | 4 +- CRM/Core/Payment/PayJunction.php | 8 +- CRM/Core/Payment/PayPalIPN.php | 2 +- CRM/Core/Payment/PayPalImpl.php | 4 +- CRM/Core/Payment/PayPalProIPN.php | 14 +- CRM/Core/Payment/PayflowPro.php | 2 +- CRM/Core/Payment/PaymentExpress.php | 6 +- CRM/Core/Payment/PaymentExpressIPN.php | 2 +- CRM/Core/Payment/Realex.php | 10 +- CRM/Core/Payment/eWAY.php | 2 +- CRM/Core/QuickForm/Action/Display.php | 2 +- CRM/Core/Report/Excel.php | 2 +- CRM/Core/Resources.php | 2 +- CRM/Core/Selector/API.php | 8 +- CRM/Core/Selector/Base.php | 6 +- CRM/Core/Selector/Controller.php | 18 +- CRM/Custom/Form/ChangeFieldType.php | 6 +- CRM/Custom/Form/DeleteField.php | 10 +- CRM/Custom/Form/DeleteGroup.php | 10 +- CRM/Custom/Form/Field.php | 12 +- CRM/Custom/Form/Group.php | 16 +- CRM/Custom/Form/MoveField.php | 16 +- CRM/Custom/Form/Option.php | 8 +- CRM/Custom/Form/Preview.php | 6 +- CRM/Custom/Import/Form/DataSource.php | 6 +- CRM/Custom/Import/Form/MapField.php | 10 +- CRM/Custom/Import/Form/Preview.php | 4 +- CRM/Custom/Import/Form/Summary.php | 2 +- CRM/Custom/Import/Parser.php | 4 +- CRM/Custom/Import/Parser/Api.php | 12 +- CRM/Custom/Page/Field.php | 6 +- CRM/Custom/Page/Group.php | 4 +- CRM/Dashlet/Page/Activity.php | 2 +- CRM/Dashlet/Page/AllCases.php | 2 +- CRM/Dashlet/Page/Blog.php | 6 +- CRM/Dashlet/Page/CaseDashboard.php | 2 +- CRM/Dashlet/Page/MyCases.php | 2 +- CRM/Dedupe/BAO/RuleGroup.php | 6 +- CRM/Dedupe/Merger.php | 4 +- CRM/Event/BAO/Event.php | 2 +- CRM/Event/Badge.php | 2 +- CRM/Event/Controller/Search.php | 2 +- CRM/Event/Form/ParticipantView.php | 4 +- CRM/Event/Import/Controller.php | 2 +- CRM/Event/Import/Form/DataSource.php | 6 +- CRM/Event/Import/Form/MapField.php | 6 +- CRM/Event/Import/Form/Preview.php | 2 +- CRM/Event/Import/Form/Summary.php | 2 +- CRM/Event/Import/Parser.php | 6 +- CRM/Event/Import/Parser/Participant.php | 12 +- CRM/Event/Info.php | 2 +- CRM/Event/Page/AJAX.php | 2 +- CRM/Event/Page/ManageEvent.php | 8 +- CRM/Event/Page/Tab.php | 6 +- CRM/Event/Page/UserDashboard.php | 2 +- CRM/Event/PseudoConstant.php | 10 +- CRM/Event/Selector/Search.php | 12 +- CRM/Event/StateMachine/Registration.php | 2 +- CRM/Event/StateMachine/Search.php | 6 +- CRM/Event/Task.php | 2 +- CRM/Export/BAO/Export.php | 6 +- CRM/Export/Form/Map.php | 6 +- CRM/Export/Form/Select.php | 16 +- CRM/Extension/Browser.php | 10 +- CRM/Extension/Container/Basic.php | 4 +- CRM/Extension/Container/Collection.php | 2 +- CRM/Extension/Container/Interface.php | 4 +- CRM/Extension/Downloader.php | 6 +- CRM/Extension/Info.php | 6 +- CRM/Extension/Manager.php | 10 +- CRM/Extension/Manager/Payment.php | 2 +- CRM/Extension/Mapper.php | 6 +- CRM/Extension/System.php | 12 +- CRM/Extension/Upgrades.php | 4 +- CRM/Financial/BAO/ExportFormat.php | 10 +- CRM/Financial/BAO/ExportFormat/CSV.php | 6 +- CRM/Financial/BAO/ExportFormat/IIF.php | 2 +- CRM/Financial/BAO/FinancialAccount.php | 16 +- CRM/Financial/BAO/FinancialItem.php | 14 +- CRM/Financial/BAO/FinancialType.php | 14 +- CRM/Financial/BAO/FinancialTypeAccount.php | 14 +- CRM/Financial/BAO/PaymentProcessor.php | 22 +- CRM/Financial/BAO/PaymentProcessorType.php | 12 +- CRM/Financial/Form/BatchTransaction.php | 4 +- CRM/Financial/Form/Export.php | 12 +- CRM/Financial/Form/FinancialAccount.php | 10 +- CRM/Financial/Form/FinancialBatch.php | 10 +- CRM/Financial/Form/FinancialType.php | 4 +- CRM/Financial/Form/FinancialTypeAccount.php | 14 +- CRM/Financial/Page/AJAX.php | 2 +- CRM/Financial/Page/Batch.php | 8 +- CRM/Financial/Page/BatchTransaction.php | 12 +- CRM/Financial/Page/FinancialAccount.php | 10 +- CRM/Financial/Page/FinancialBatch.php | 10 +- CRM/Financial/Page/FinancialType.php | 12 +- CRM/Financial/Page/FinancialTypeAccount.php | 10 +- CRM/Friend/BAO/Friend.php | 8 +- CRM/Friend/Form.php | 14 +- CRM/Friend/Form/Contribute.php | 6 +- CRM/Friend/Form/Event.php | 6 +- CRM/Grant/BAO/Grant.php | 22 +- CRM/Grant/BAO/Query.php | 8 +- CRM/Grant/Controller/Search.php | 2 +- CRM/Grant/Form/Grant.php | 10 +- CRM/Grant/Form/GrantView.php | 4 +- CRM/Grant/Form/Search.php | 14 +- CRM/Grant/Form/Task.php | 12 +- CRM/Grant/Form/Task/Delete.php | 6 +- CRM/Grant/Form/Task/Print.php | 4 +- CRM/Grant/Form/Task/Result.php | 4 +- CRM/Grant/Form/Task/SearchTaskHookSample.php | 4 +- CRM/Grant/Form/Task/Update.php | 6 +- CRM/Grant/Info.php | 2 +- CRM/Grant/Page/Tab.php | 10 +- CRM/Grant/Selector/Search.php | 16 +- CRM/Grant/StateMachine/Search.php | 6 +- CRM/Group/Controller.php | 2 +- CRM/Group/Form/Edit.php | 10 +- CRM/Group/Page/Group.php | 14 +- CRM/Import/DataSource.php | 6 +- CRM/Import/DataSource/CSV.php | 6 +- CRM/Import/DataSource/SQL.php | 6 +- CRM/Import/Form/MapField.php | 4 +- CRM/Import/Form/Preview.php | 2 +- CRM/Import/Form/Summary.php | 2 +- CRM/Import/Parser.php | 12 +- CRM/Import/StateMachine.php | 2 +- CRM/Mailing/BAO/BouncePattern.php | 4 +- CRM/Mailing/BAO/Component.php | 8 +- CRM/Mailing/BAO/Mailing.php | 32 +-- CRM/Mailing/BAO/MailingAB.php | 8 +- CRM/Mailing/BAO/MailingJob.php | 12 +- CRM/Mailing/BAO/Query.php | 2 +- CRM/Mailing/BAO/Recipients.php | 2 +- CRM/Mailing/BAO/Spool.php | 2 +- CRM/Mailing/BAO/TrackableURL.php | 2 +- CRM/Mailing/Config.php | 2 +- CRM/Mailing/Controller/Send.php | 2 +- CRM/Mailing/Event/BAO/Bounce.php | 6 +- CRM/Mailing/Event/BAO/Confirm.php | 4 +- CRM/Mailing/Event/BAO/Delivered.php | 8 +- CRM/Mailing/Event/BAO/Forward.php | 6 +- CRM/Mailing/Event/BAO/Opened.php | 10 +- CRM/Mailing/Event/BAO/Queue.php | 10 +- CRM/Mailing/Event/BAO/Reply.php | 10 +- CRM/Mailing/Event/BAO/Subscribe.php | 10 +- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 8 +- CRM/Mailing/Event/BAO/Unsubscribe.php | 12 +- CRM/Mailing/Form/Approve.php | 4 +- CRM/Mailing/Form/Browse.php | 2 +- CRM/Mailing/Form/Component.php | 8 +- CRM/Mailing/Form/ForwardMailing.php | 2 +- CRM/Mailing/Form/Group.php | 10 +- CRM/Mailing/Form/Schedule.php | 6 +- CRM/Mailing/Form/Settings.php | 6 +- CRM/Mailing/Form/Subscribe.php | 2 +- CRM/Mailing/Form/Task.php | 8 +- CRM/Mailing/Form/Task/Print.php | 4 +- CRM/Mailing/Form/Test.php | 4 +- CRM/Mailing/Form/Upload.php | 6 +- CRM/Mailing/Info.php | 2 +- CRM/Mailing/MailStore.php | 4 +- CRM/Mailing/MailStore/Imap.php | 6 +- CRM/Mailing/MailStore/Localdir.php | 8 +- CRM/Mailing/MailStore/Maildir.php | 8 +- CRM/Mailing/MailStore/Mbox.php | 6 +- CRM/Mailing/MailStore/Pop3.php | 4 +- CRM/Mailing/Page/AJAX.php | 2 +- CRM/Mailing/Page/Browse.php | 4 +- CRM/Mailing/Page/Component.php | 10 +- CRM/Mailing/Page/Event.php | 2 +- CRM/Mailing/Page/Report.php | 2 +- CRM/Mailing/Page/Tab.php | 2 +- CRM/Mailing/Page/View.php | 2 +- CRM/Mailing/PseudoConstant.php | 8 +- CRM/Mailing/Selector/Browse.php | 4 +- CRM/Mailing/Selector/Event.php | 4 +- CRM/Mailing/Selector/Search.php | 10 +- CRM/Mailing/StateMachine/Send.php | 2 +- CRM/Mailing/Task.php | 2 +- CRM/Member/BAO/Membership.php | 63 +++--- CRM/Member/BAO/MembershipBlock.php | 6 +- CRM/Member/BAO/MembershipLog.php | 4 +- CRM/Member/BAO/MembershipPayment.php | 6 +- CRM/Member/BAO/MembershipStatus.php | 20 +- CRM/Member/BAO/MembershipType.php | 8 +- CRM/Member/Controller/Search.php | 2 +- CRM/Member/Form.php | 2 +- CRM/Member/Form/Membership.php | 14 +- CRM/Member/Form/MembershipBlock.php | 6 +- CRM/Member/Form/MembershipConfig.php | 4 +- CRM/Member/Form/MembershipRenewal.php | 10 +- CRM/Member/Form/MembershipStatus.php | 4 +- CRM/Member/Form/MembershipType.php | 6 +- CRM/Member/Form/MembershipView.php | 12 +- CRM/Member/Form/Search.php | 12 +- CRM/Member/Form/Task.php | 14 +- CRM/Member/Form/Task/Batch.php | 12 +- CRM/Member/Form/Task/Delete.php | 6 +- CRM/Member/Form/Task/Email.php | 8 +- CRM/Member/Form/Task/Label.php | 6 +- CRM/Member/Form/Task/PDFLetter.php | 10 +- CRM/Member/Form/Task/PDFLetterCommon.php | 4 +- CRM/Member/Form/Task/PickProfile.php | 10 +- CRM/Member/Form/Task/Print.php | 4 +- CRM/Member/Form/Task/Result.php | 4 +- CRM/Member/Form/Task/SearchTaskHookSample.php | 4 +- CRM/Member/Import/Form/DataSource.php | 6 +- CRM/Member/Import/Form/MapField.php | 8 +- CRM/Member/Import/Form/Preview.php | 2 +- CRM/Member/Import/Form/Summary.php | 2 +- CRM/Member/Import/Parser.php | 6 +- CRM/Member/Import/Parser/Membership.php | 10 +- CRM/Member/Info.php | 2 +- CRM/Member/Page/AJAX.php | 2 +- CRM/Member/Page/MembershipStatus.php | 10 +- CRM/Member/Page/MembershipType.php | 4 +- CRM/Member/Page/Tab.php | 16 +- CRM/Member/Page/UserDashboard.php | 2 +- CRM/Member/PseudoConstant.php | 8 +- CRM/Member/Selector/Search.php | 10 +- CRM/Member/StateMachine/Search.php | 2 +- CRM/PCP/Form/Campaign.php | 6 +- CRM/PCP/Form/Contribute.php | 6 +- CRM/PCP/Form/Event.php | 6 +- CRM/PCP/Form/PCP.php | 8 +- CRM/PCP/Form/PCPAccount.php | 10 +- CRM/PCP/Page/PCP.php | 10 +- CRM/PCP/StateMachine/PCP.php | 2 +- CRM/Pledge/BAO/Pledge.php | 30 ++- CRM/Pledge/BAO/PledgeBlock.php | 20 +- CRM/Pledge/BAO/PledgePayment.php | 28 ++- CRM/Pledge/BAO/Query.php | 8 +- CRM/Pledge/Controller/Search.php | 2 +- CRM/Pledge/Form/Payment.php | 8 +- CRM/Pledge/Form/Pledge.php | 16 +- CRM/Pledge/Form/PledgeView.php | 4 +- CRM/Pledge/Form/Search.php | 16 +- CRM/Pledge/Form/Task.php | 10 +- CRM/Pledge/Form/Task/Delete.php | 6 +- CRM/Pledge/Form/Task/Print.php | 4 +- CRM/Pledge/Form/Task/Result.php | 4 +- CRM/Pledge/Form/Task/SearchTaskHookSample.php | 4 +- CRM/Pledge/Info.php | 2 +- CRM/Pledge/Page/AJAX.php | 2 +- CRM/Pledge/Page/Payment.php | 2 +- CRM/Pledge/Page/Tab.php | 6 +- CRM/Pledge/Page/UserDashboard.php | 2 +- CRM/Pledge/StateMachine/Search.php | 2 +- CRM/Pledge/Task.php | 4 +- CRM/Price/BAO/LineItem.php | 11 +- CRM/Price/BAO/PriceField.php | 14 +- CRM/Price/BAO/PriceFieldValue.php | 13 +- CRM/Price/BAO/PriceSet.php | 34 +-- CRM/Price/Form/DeleteField.php | 10 +- CRM/Price/Form/DeleteSet.php | 10 +- CRM/Price/Form/Field.php | 14 +- CRM/Price/Form/Option.php | 10 +- CRM/Price/Form/Preview.php | 6 +- CRM/Price/Form/Set.php | 10 +- CRM/Price/Page/Field.php | 8 +- CRM/Price/Page/Option.php | 8 +- CRM/Price/Page/Set.php | 8 +- CRM/Profile/Form.php | 28 +-- CRM/Profile/Form/Dynamic.php | 4 +- CRM/Profile/Form/Edit.php | 4 +- CRM/Profile/Form/Search.php | 4 +- CRM/Profile/Page/Dynamic.php | 14 +- CRM/Profile/Page/Listings.php | 4 +- .../Page/MultipleRecordFieldsListing.php | 16 +- CRM/Profile/Page/View.php | 6 +- CRM/Profile/Selector/Listings.php | 26 +-- CRM/Queue/BAO/QueueItem.php | 2 +- CRM/Queue/ErrorPolicy.php | 4 +- CRM/Queue/Page/AJAX.php | 6 +- CRM/Queue/Queue.php | 14 +- CRM/Queue/Queue/Memory.php | 14 +- CRM/Queue/Queue/Sql.php | 12 +- CRM/Queue/Service.php | 2 +- CRM/Queue/Task.php | 6 +- CRM/Report/BAO/Hook.php | 2 +- CRM/Report/BAO/ReportInstance.php | 6 +- CRM/Report/Form.php | 22 +- .../Form/Contribute/HouseholdSummary.php | 2 +- .../Form/Contribute/OrganizationSummary.php | 2 +- .../Form/Event/ParticipantListCount.php | 2 +- CRM/Report/Form/Event/Summary.php | 2 +- CRM/Report/Form/Extended.php | 18 +- CRM/Report/Form/Mailing/Summary.php | 2 +- CRM/Report/Form/Pledge/Detail.php | 2 +- CRM/Report/Form/Register.php | 4 +- CRM/Report/Info.php | 2 +- CRM/Report/Interface.php | 12 +- CRM/Report/Page/InstanceList.php | 10 +- CRM/Report/Page/Options.php | 18 +- CRM/Report/Utils/Get.php | 2 +- CRM/Report/Utils/Report.php | 2 +- CRM/SMS/BAO/Provider.php | 4 +- CRM/SMS/Controller/Send.php | 2 +- CRM/SMS/Form/Group.php | 8 +- CRM/SMS/Form/Schedule.php | 6 +- CRM/SMS/Form/Upload.php | 6 +- CRM/SMS/Page/Provider.php | 10 +- CRM/SMS/Provider.php | 4 +- CRM/SMS/StateMachine/Send.php | 2 +- CRM/Tag/Form/Tag.php | 2 +- CRM/UF/Form/AbstractPreview.php | 8 +- CRM/UF/Form/Field.php | 12 +- CRM/UF/Form/Group.php | 12 +- CRM/UF/Form/Preview.php | 2 +- CRM/UF/Page/AJAX.php | 2 +- CRM/UF/Page/Field.php | 6 +- CRM/UF/Page/Group.php | 6 +- CRM/UF/Page/ProfileEditor.php | 2 +- CRM/Upgrade/Controller.php | 2 +- CRM/Upgrade/Form.php | 20 +- CRM/Upgrade/Incremental/Legacy.php | 32 +-- CRM/Upgrade/Incremental/php/FourFive.php | 4 +- CRM/Upgrade/Incremental/php/FourFour.php | 4 +- CRM/Upgrade/Incremental/php/FourOne.php | 2 +- CRM/Upgrade/Incremental/php/FourSix.php | 2 +- CRM/Upgrade/Incremental/php/FourThree.php | 14 +- CRM/Upgrade/Incremental/php/FourTwo.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 14 +- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 11 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 9 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 34 +-- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 16 +- .../Snapshot/V4p2/Price/DAO/FieldValue.php | 14 +- .../Snapshot/V4p2/Price/DAO/LineItem.php | 14 +- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php | 14 +- .../Snapshot/V4p2/Price/DAO/SetEntity.php | 14 +- CRM/Upgrade/StateMachine.php | 2 +- CRM/Utils/API/ReloadOption.php | 2 +- CRM/Utils/Address.php | 2 +- CRM/Utils/Array.php | 4 +- CRM/Utils/Cache.php | 6 +- CRM/Utils/Cache/APCcache.php | 4 +- CRM/Utils/Cache/ArrayCache.php | 2 +- CRM/Utils/Cache/Interface.php | 8 +- CRM/Utils/Cache/Memcache.php | 10 +- CRM/Utils/Cache/Memcached.php | 4 +- CRM/Utils/Cache/NoCache.php | 2 +- CRM/Utils/Cache/SerializeCache.php | 2 +- CRM/Utils/Cache/SqlGroup.php | 4 +- CRM/Utils/Check.php | 4 +- CRM/Utils/Date.php | 22 +- CRM/Utils/File.php | 8 +- CRM/Utils/Geocode/Google.php | 2 +- CRM/Utils/Geocode/Yahoo.php | 2 +- CRM/Utils/GlobalStack.php | 2 +- CRM/Utils/Hook.php | 46 ++--- CRM/Utils/Hook/Joomla.php | 2 +- CRM/Utils/Hook/Soap.php | 2 +- CRM/Utils/Hook/UnitTests.php | 4 +- CRM/Utils/Hook/WordPress.php | 2 +- CRM/Utils/HttpClient.php | 4 +- CRM/Utils/ICalendar.php | 4 +- CRM/Utils/JS.php | 2 +- CRM/Utils/JSON.php | 6 +- CRM/Utils/Mail.php | 2 +- CRM/Utils/Mail/EmailProcessor.php | 2 +- CRM/Utils/Mail/Incoming.php | 2 +- CRM/Utils/Migrate/ExportJSON.php | 4 +- CRM/Utils/Money.php | 2 +- CRM/Utils/Number.php | 2 +- CRM/Utils/OptionBag.php | 2 +- CRM/Utils/PDF/Label.php | 6 +- CRM/Utils/PDF/Utils.php | 2 +- CRM/Utils/Pager.php | 6 +- CRM/Utils/PagerAToZ.php | 8 +- CRM/Utils/PseudoConstant.php | 8 +- CRM/Utils/REST.php | 2 +- CRM/Utils/ReCAPTCHA.php | 4 +- CRM/Utils/Recent.php | 14 +- CRM/Utils/Rule.php | 2 +- CRM/Utils/SQL/Insert.php | 6 +- CRM/Utils/SQL/Select.php | 12 +- CRM/Utils/SoapServer.php | 6 +- CRM/Utils/Sort.php | 12 +- CRM/Utils/String.php | 36 ++-- CRM/Utils/System.php | 8 +- CRM/Utils/System/Base.php | 52 ++--- CRM/Utils/System/Drupal.php | 12 +- CRM/Utils/System/Drupal6.php | 14 +- CRM/Utils/System/Drupal8.php | 8 +- CRM/Utils/System/DrupalBase.php | 4 +- CRM/Utils/System/Joomla.php | 12 +- CRM/Utils/System/Soap.php | 6 +- CRM/Utils/System/WordPress.php | 4 +- CRM/Utils/Time.php | 8 +- CRM/Utils/Token.php | 24 +-- CRM/Utils/Tree.php | 14 +- CRM/Utils/Type.php | 2 +- CRM/Utils/Verp.php | 2 +- CRM/Utils/VersionCheck.php | 16 +- CRM/Utils/Wrapper.php | 2 +- CRM/Utils/XML.php | 2 +- CRM/Utils/Zip.php | 2 +- Civi/API/Events.php | 2 +- Civi/API/Provider/MagicFunctionProvider.php | 2 +- Civi/API/Subscriber/ChainSubscriber.php | 2 +- Civi/API/Subscriber/TransactionSubscriber.php | 6 +- Civi/Angular/Manager.php | 2 +- Civi/Angular/Page/Main.php | 2 +- Civi/CCase/Analyzer.php | 6 +- Civi/CCase/Events.php | 2 +- Civi/Core/Transaction/Frame.php | 2 +- Civi/Install/Requirements.php | 4 +- install/index.php | 4 +- .../main.php | 1 + .../CRM/Activity/BAO/ActivityTargetTest.php | 4 +- .../phpunit/CRM/Activity/BAO/ActivityTest.php | 22 +- tests/phpunit/CRM/Batch/Form/EntryTest.php | 12 +- .../BAO/ContactType/ContactSearchTest.php | 9 +- .../Contact/BAO/ContactType/ContactTest.php | 8 +- .../Contribute/BAO/ContributionRecurTest.php | 10 +- .../CRM/Contribute/BAO/ContributionTest.php | 2 +- .../phpunit/CRM/Core/BAO/CustomGroupTest.php | 2 +- tests/phpunit/CRM/Queue/QueueTest.php | 1 + tests/phpunit/CRM/Queue/RunnerTest.php | 7 +- tests/phpunit/CRM/Utils/Cache/AllTests.php | 19 +- .../phpunit/CRM/Utils/DeprecatedUtilsTest.php | 6 +- tests/phpunit/CRM/Utils/ZipTest.php | 4 +- tests/phpunit/CiviTest/CiviUnitTestCase.php | 2 +- tests/phpunit/api/v3/ActivityTest.php | 5 +- tests/phpunit/api/v3/AddressTest.php | 8 +- tests/phpunit/api/v3/AttachmentTest.php | 2 +- tests/phpunit/api/v3/BatchTest.php | 1 + tests/phpunit/api/v3/CRM11793Test.php | 2 +- tests/phpunit/api/v3/CaseTest.php | 29 +-- tests/phpunit/api/v3/ContactTest.php | 107 +++++----- tests/phpunit/api/v3/ContributionSoftTest.php | 6 +- tests/phpunit/api/v3/ContributionTest.php | 2 +- tests/phpunit/api/v3/DomainTest.php | 10 +- tests/phpunit/api/v3/EmailTest.php | 2 +- tests/phpunit/api/v3/EntityTagTest.php | 6 +- tests/phpunit/api/v3/EventTest.php | 30 ++- tests/phpunit/api/v3/GrantTest.php | 2 + tests/phpunit/api/v3/JobTest.php | 8 +- tests/phpunit/api/v3/MailingABTest.php | 4 +- tests/phpunit/api/v3/MailingTest.php | 4 +- tests/phpunit/api/v3/MembershipStatusTest.php | 2 +- tests/phpunit/api/v3/MembershipTest.php | 6 +- tests/phpunit/api/v3/MessageTemplateTest.php | 9 +- tests/phpunit/api/v3/OptionValueTest.php | 11 +- .../phpunit/api/v3/ParticipantPaymentTest.php | 24 +-- tests/phpunit/api/v3/ParticipantTest.php | 38 ++-- tests/phpunit/api/v3/PhoneTest.php | 2 +- tests/phpunit/api/v3/PledgePaymentTest.php | 5 +- tests/phpunit/api/v3/PledgeTest.php | 194 ++++++++++-------- tests/phpunit/api/v3/PriceSetTest.php | 9 +- tests/phpunit/api/v3/RelationshipTest.php | 4 +- tests/phpunit/api/v3/ReportTemplateTest.php | 15 +- tests/phpunit/api/v3/SurveyTest.php | 10 +- .../phpunit/api/v3/SyntaxConformanceTest.php | 2 +- tests/phpunit/api/v3/SystemTest.php | 3 +- tests/phpunit/api/v3/TagTest.php | 7 +- tests/phpunit/api/v3/UtilsTest.php | 1 + tests/qunit/crm-backbone/test.js | 2 +- 831 files changed, 3509 insertions(+), 3462 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 2aacb1886c..0fa785df24 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -671,7 +671,7 @@ SELECT $acl.* } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index 0cc6e08d1e..c167b978da 100644 --- a/CRM/ACL/BAO/EntityRole.php +++ b/CRM/ACL/BAO/EntityRole.php @@ -73,7 +73,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 1d5ecd066e..9d514c4de7 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -38,14 +38,14 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** - * Static field for all the activity information that we can potentially export + * Static field for all the activity information that we can potentially export. * * @var array */ static $_exportableFields = NULL; /** - * Static field for all the activity information that we can potentially import + * Static field for all the activity information that we can potentially import. * * @var array */ diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index c739d0729c..b9761979cd 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -40,7 +40,7 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -67,7 +67,7 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta } /** - * Retrieve assignee_id by activity_id + * Retrieve assignee_id by activity_id. * * @param int $activity_id * @@ -99,7 +99,7 @@ AND civicrm_contact.is_deleted = 0 } /** - * Retrieve assignee names by activity_id + * Retrieve assignee names by activity_id. * * @param array $activityIDs * IDs of the activities. diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 20aae7cab8..279b646a0c 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -40,7 +40,7 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -66,7 +66,7 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact } /** - * Retrieve names of contact by activity_id + * Retrieve names of contact by activity_id. * * @param int $activityID * @param int $recordTypeID @@ -105,7 +105,7 @@ AND contact_a.is_deleted = 0 } /** - * Retrieve id of target contact by activity_id + * Retrieve id of target contact by activity_id. * * @param int $activityID * @param int $recordTypeID diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index cbc4e8ddb4..df4bb19707 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -40,14 +40,14 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Add activity target + * Add activity target. * * @param array $params * @@ -65,7 +65,7 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { } /** - * Retrieve id of target contact by activity_id + * Retrieve id of target contact by activity_id. * * @param int $activity_id * @@ -96,7 +96,7 @@ AND civicrm_contact.is_deleted = 0 } /** - * Retrieve names of target contact by activity_id + * Retrieve names of target contact by activity_id. * * @param int $activityID * diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index ee518610e6..3d868d9e58 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -45,7 +45,7 @@ class CRM_Activity_BAO_ICalendar { protected $activity; /** - * Constructor + * Constructor. * * @param object $act * Reference to an activity object. @@ -57,7 +57,7 @@ class CRM_Activity_BAO_ICalendar { } /** - * Add an ics attachment to the input array + * Add an ics attachment to the input array. * * @param array $attachments * Reference to array in same format returned from CRM_Core_BAO_File::getEntityFile(). @@ -105,7 +105,7 @@ class CRM_Activity_BAO_ICalendar { } /** - * Remove temp file + * Remove temp file. */ public function cleanup() { if (!empty ($this->icsfile)) { diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index 0dd18450e6..b12278bb79 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -156,7 +156,7 @@ class CRM_Activity_BAO_Query { } /** - * Given a list of conditions in query generate the required + * Given a list of conditions in query generate the required. * where clause * * @param $query @@ -176,7 +176,7 @@ class CRM_Activity_BAO_Query { } /** - * Where clause for a single field + * Where clause for a single field. * * @param $values * @param $query @@ -402,7 +402,7 @@ class CRM_Activity_BAO_Query { } /** - * Getter for the qill object + * Getter for the qill object. * * @return string */ @@ -411,7 +411,7 @@ class CRM_Activity_BAO_Query { } /** - * Add all the elements shared between case activity search and advanced search + * Add all the elements shared between case activity search and advanced search. * * * @param CRM_Core_Form $form diff --git a/CRM/Activity/Controller/Search.php b/CRM/Activity/Controller/Search.php index 085e3119c5..7ef8e42d25 100644 --- a/CRM/Activity/Controller/Search.php +++ b/CRM/Activity/Controller/Search.php @@ -29,7 +29,6 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ /** @@ -40,13 +39,14 @@ * * Typically the first form will display the search criteria and it's results * - * The second form is used to process search results with the asscociated actions + * The second form is used to process search results with the associated actions * */ class CRM_Activity_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. + * * @param null $title * @param bool $modal * @param int|mixed|null $action @@ -57,14 +57,16 @@ class CRM_Activity_Controller_Search extends CRM_Core_Controller { $this->_stateMachine = new CRM_Activity_StateMachine_Search($this, $action); - // create and instantiate the pages + // Create and instantiate the pages. $this->addPages($this->_stateMachine, $action); - // add all the actions + // Add all the actions. $this->addActions(); } /** + * Getter for selectorName. + * * @return mixed */ public function selectorName() { diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index d806d7722f..e382c65c7b 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -47,35 +47,35 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { public $_activityId; /** - * Store activity ids when multiple activities are created + * Store activity ids when multiple activities are created. * * @var int */ public $_activityIds = array(); /** - * The id of activity type + * The id of activity type. * * @var int */ public $_activityTypeId; /** - * The name of activity type + * The name of activity type. * * @var string */ public $_activityTypeName; /** - * The id of currently viewed contact + * The id of currently viewed contact. * * @var int */ public $_currentlyViewedContactId; /** - * The id of source contact and target contact + * The id of source contact and target contact. * * @var int */ @@ -98,7 +98,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { public $_currentUserId; /** - * The array of form field attributes + * The array of form field attributes. * * @var array */ @@ -112,7 +112,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { protected $_crmDir = 'Activity'; /** - * Survey activity + * Survey activity. * * @var boolean */ @@ -214,7 +214,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -819,7 +819,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -867,7 +867,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Process the form submission + * Process the form submission. * * * @param array $params @@ -1005,7 +1005,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Process activity creation + * Process activity creation. * * @param array $params * Associated array of submitted values. @@ -1174,7 +1174,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * Let injecting activity type file do any processing + * Let injecting activity type file do any processing. * needed, before the activity is added/updated * * @param array $params diff --git a/CRM/Activity/Form/ActivityView.php b/CRM/Activity/Form/ActivityView.php index 2a633ba1f3..27e75234fe 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -116,7 +116,7 @@ class CRM_Activity_Form_ActivityView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Activity/Form/Search.php b/CRM/Activity/Form/Search.php index 3f08965337..c81f6692d3 100644 --- a/CRM/Activity/Form/Search.php +++ b/CRM/Activity/Form/Search.php @@ -42,42 +42,42 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_limit = NULL; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "activity_"; protected $_defaults; /** - * The saved search ID retrieved from the GET vars + * The saved search ID retrieved from the GET vars. * * @var int */ protected $_ssID; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -158,7 +158,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index ef159a2004..a0447e1fc8 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -40,42 +40,42 @@ class CRM_Activity_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * The array that holds all the contact ids + * The array that holds all the contact ids. * * @var array */ public $_contactIds; /** - * The array that holds all the member ids + * The array that holds all the member ids. * * @var array */ public $_activityHolderIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * diff --git a/CRM/Activity/Form/Task/AddToTag.php b/CRM/Activity/Form/Task/AddToTag.php index 4eefe64ce8..175a784aa1 100644 --- a/CRM/Activity/Form/Task/AddToTag.php +++ b/CRM/Activity/Form/Task/AddToTag.php @@ -41,21 +41,21 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { /** - * Name of the tag + * Name of the tag. * * @var string */ protected $_name; /** - * All the tags in the system + * All the tags in the system. * * @var array */ protected $_tags; /** - * Build the form object + * Build the form object. * * * @return void @@ -94,7 +94,7 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/Batch.php b/CRM/Activity/Form/Task/Batch.php index 518f69e473..c9d2523d4a 100755 --- a/CRM/Activity/Form/Task/Batch.php +++ b/CRM/Activity/Form/Task/Batch.php @@ -39,24 +39,24 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Maximum profile fields that will be displayed + * Maximum profile fields that will be displayed. */ protected $_maxFields = 9; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -212,7 +212,7 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Activity/Form/Task/Delete.php b/CRM/Activity/Form/Task/Delete.php index 1a29df0441..1a899e003b 100755 --- a/CRM/Activity/Form/Task/Delete.php +++ b/CRM/Activity/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -58,7 +58,7 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -68,7 +68,7 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/Email.php b/CRM/Activity/Form/Task/Email.php index 1f8756bfc1..5553943e0a 100644 --- a/CRM/Activity/Form/Task/Email.php +++ b/CRM/Activity/Form/Task/Email.php @@ -50,14 +50,14 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { public $_noEmails = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ public $_templates = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -72,7 +72,7 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -85,7 +85,7 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/FileOnCase.php b/CRM/Activity/Form/Task/FileOnCase.php index 408f1ac59d..c5cb731df0 100644 --- a/CRM/Activity/Form/Task/FileOnCase.php +++ b/CRM/Activity/Form/Task/FileOnCase.php @@ -39,24 +39,24 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * Variable to store contact Ids + * Variable to store contact Ids. */ public $_contacts; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -69,7 +69,7 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -80,7 +80,7 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -89,7 +89,7 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index f7bbc3457d..ebf23770a7 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -39,29 +39,29 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Maximum Activities that should be allowed to update + * Maximum Activities that should be allowed to update. */ protected $_maxActivities = 100; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * Variable to store contact Ids + * Variable to store contact Ids. */ public $_contacts; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -92,7 +92,7 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -106,7 +106,7 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -116,7 +116,7 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -135,7 +135,7 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index 29b751aea2..c54f444ed3 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/Form/Task/PickProfile.php @@ -39,24 +39,24 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Maximum Activities that should be allowed to update + * Maximum Activities that should be allowed to update. */ protected $_maxActivities = 100; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -88,7 +88,7 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -136,7 +136,7 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -146,7 +146,7 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -159,7 +159,7 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/Print.php b/CRM/Activity/Form/Task/Print.php index 9897bcd62a..529c920927 100644 --- a/CRM/Activity/Form/Task/Print.php +++ b/CRM/Activity/Form/Task/Print.php @@ -93,7 +93,7 @@ class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/RemoveFromTag.php b/CRM/Activity/Form/Task/RemoveFromTag.php index 53f3919adc..26c0e26d3d 100644 --- a/CRM/Activity/Form/Task/RemoveFromTag.php +++ b/CRM/Activity/Form/Task/RemoveFromTag.php @@ -90,7 +90,7 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/SMS.php b/CRM/Activity/Form/Task/SMS.php index 3b59e8da86..8e19aaba59 100644 --- a/CRM/Activity/Form/Task/SMS.php +++ b/CRM/Activity/Form/Task/SMS.php @@ -40,14 +40,14 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { public $_single = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ public $_templates = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -58,7 +58,7 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -70,7 +70,7 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Activity/Form/Task/SearchTaskHookSample.php b/CRM/Activity/Form/Task/SearchTaskHookSample.php index b344287d42..f7b97946c0 100644 --- a/CRM/Activity/Form/Task/SearchTaskHookSample.php +++ b/CRM/Activity/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Activity_Form_Task_SearchTaskHookSample extends CRM_Activity_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -79,7 +79,7 @@ INNER JOIN civicrm_contact ct ON ( ac.contact_id = ct.id ) } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Activity/Import/Form/DataSource.php b/CRM/Activity/Import/Form/DataSource.php index 0e1ee35c0c..a5501d11f1 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -51,7 +51,7 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -125,7 +125,7 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index 4b18667a78..a6bd477b98 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -40,7 +40,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -81,7 +81,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -268,7 +268,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -370,7 +370,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Process the mapped fields and map it into the uploaded file + * Process the mapped fields and map it into the uploaded file. * preview the file and extract some summary statistics * * @return void diff --git a/CRM/Activity/Import/Form/Preview.php b/CRM/Activity/Import/Form/Preview.php index 7a127e6300..62e34c0266 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -106,7 +106,7 @@ class CRM_Activity_Import_Form_Preview extends CRM_Import_Form_Preview { } /** - * Process the mapped fields and map it into the uploaded file + * Process the mapped fields and map it into the uploaded file. * preview the file and extract some summary statistics * * @return void diff --git a/CRM/Activity/Import/Form/Summary.php b/CRM/Activity/Import/Form/Summary.php index 0d3c8c3f7b..5b7d519a18 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index ee2659d490..f2170f48c9 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -41,7 +41,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { */ /** - * Imported file size + * Imported file size. */ protected $_fileSize; @@ -51,12 +51,12 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { protected $_seperator; /** - * Total number of lines in file + * Total number of lines in file. */ protected $_lineCount; /** - * Whether the file has a column header or not + * Whether the file has a column header or not. * * @var boolean */ @@ -295,7 +295,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * 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 @@ -338,7 +338,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * @@ -382,7 +382,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * Export data to a CSV file + * Export data to a CSV file. * * @param string $fileName * @param array $header diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php index e6b5f44b1b..793e090c6e 100644 --- a/CRM/Activity/Import/Parser/Activity.php +++ b/CRM/Activity/Import/Parser/Activity.php @@ -55,7 +55,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { protected $_newActivity; /** - * Class constructor + * Class constructor. * @param $mapperKeys * @param null $mapperLocType * @param null $mapperPhoneType @@ -130,7 +130,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -142,7 +142,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -155,7 +155,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * Handle the values in summary mode + * Handle the values in summary mode. * * @param array $values * The array of values belonging to this line. @@ -238,7 +238,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. diff --git a/CRM/Activity/Page/Tab.php b/CRM/Activity/Page/Tab.php index 194ec60390..2150089455 100644 --- a/CRM/Activity/Page/Tab.php +++ b/CRM/Activity/Page/Tab.php @@ -40,7 +40,7 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page { /** - * Browse all activities for a particular contact + * Browse all activities for a particular contact. * * @return void */ diff --git a/CRM/Activity/Page/UserDashboard.php b/CRM/Activity/Page/UserDashboard.php index 49d0a95071..0f386e02eb 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 { /** - * List participations for the UF user + * List participations for the UF user. * * @return bool */ diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 5d299ed3f1..86789d6755 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -62,7 +62,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C protected $_viewOptions; /** - * Class constructor + * Class constructor. * * @param int $contactId * Contact whose activities we want to display. @@ -359,7 +359,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. @@ -504,7 +504,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C } /** - * Get colunmn headers for search selector + * Get colunmn headers for search selector. * * * @return array diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index f86cabccc1..258c2c8983 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -79,35 +79,35 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM ); /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_limit = NULL; /** - * What context are we being invoked from + * What context are we being invoked from. * * @var string */ protected $_context = NULL; /** - * What component context are we being invoked from + * What component context are we being invoked from. * * @var string */ protected $_compContext = NULL; /** - * QueryParams is the array returned by exportValues called on + * QueryParams is the array returned by exportValues called on. * the HTML_QuickForm_Controller for that page. * * @var array @@ -115,28 +115,28 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_activityClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index 345f04bc13..77f1a8af34 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -34,7 +34,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ @@ -91,7 +91,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ @@ -100,7 +100,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Should the controller reset the session + * Should the controller reset the session. * In some cases, specifically search we want to remember * state across various actions and want to go back to the * beginning from the final state, but retain the same session diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php index 9f6c5aeb62..7c8acaac41 100644 --- a/CRM/Activity/Task.php +++ b/CRM/Activity/Task.php @@ -45,21 +45,21 @@ class CRM_Activity_Task { EMAIL_SMS = 6; /** - * The task array + * The task array. * * @var array */ static $_tasks = NULL; /** - * The optional task array + * The optional task array. * * @var array */ static $_optionalTasks = NULL; /** - * These tasks are the core set of tasks that the user can perform + * These tasks are the core set of tasks that the user can perform. * on a contact / group of contacts * * @return array @@ -143,7 +143,7 @@ class CRM_Activity_Task { } /** - * These tasks are the core set of task titles + * These tasks are the core set of task titles. * on activity * * @return array @@ -159,7 +159,7 @@ class CRM_Activity_Task { } /** - * Show tasks selectively based on the permission level + * Show tasks selectively based on the permission level. * of the user * * @param int $permission @@ -186,7 +186,7 @@ class CRM_Activity_Task { } /** - * These tasks are the core set of tasks that the user can perform + * These tasks are the core set of tasks that the user can perform. * on activity * * @param int $value diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 5557a6bd23..7840e5d10e 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -42,9 +42,9 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * Takes a bunch of params that are needed to match certain criteria and. - * retrieves the relevant objects. It also stores all the retrieved - * values in the default array + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -65,7 +65,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index b6c9741477..e058d7fdba 100755 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -66,7 +66,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { public $_membershipId = NULL; /** - * When not to reset sort_name + * When not to reset sort_name. */ protected $_preserveDefault = TRUE; diff --git a/CRM/Bridge/OG/Utils.php b/CRM/Bridge/OG/Utils.php index 886587187f..810984efa4 100644 --- a/CRM/Bridge/OG/Utils.php +++ b/CRM/Bridge/OG/Utils.php @@ -43,7 +43,7 @@ class CRM_Bridge_OG_Utils { } /** - * Switch to stop synchronization from CiviCRM + * Switch to stop synchronization from CiviCRM. * This was always false before, and is always true * now. Most likely, this needs to be a setting. */ diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 8909fcb7f4..2261f3a15b 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -35,7 +35,7 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { /** - * Takes an associative array and creates a campaign object + * Takes an associative array and creates a campaign object. * * the function extract all the params it needs to initialize the create a * contact object. the params array could contain additional unused name/value @@ -98,7 +98,7 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { } /** - * Delete the campaign + * Delete the campaign. * * @param int $id * Id of the campaign. @@ -115,9 +115,9 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * campaign_id. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -489,7 +489,7 @@ SELECT campaign.id as id, } /** - * Get Campaigns groups + * Get Campaigns groups. * * @param int $campaignId * Campaign id. @@ -523,7 +523,7 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index a3fd7919b1..470e18a16d 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -172,7 +172,7 @@ SELECT petition.id as id, } /** - * Takes an associative array and creates a petition signature activity + * Takes an associative array and creates a petition signature activity. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -279,7 +279,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Get Petition Signature Total + * Get Petition Signature Total. * * @param int $surveyId * @@ -321,7 +321,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Get Petition Signature Total + * Get Petition Signature Total. * * @param int $surveyId * @@ -381,7 +381,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Get Petition Signature Details + * Get Petition Signature Details. * * @param int $surveyId * @param int $status_id @@ -458,7 +458,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * This function returns all entities assigned to a specific tag + * This function returns all entities assigned to a specific tag. * * @param object $tag * An object of a tag. @@ -479,7 +479,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Check if contact has signed this petition + * Check if contact has signed this petition. * * @param int $surveyId * @param int $contactId @@ -531,7 +531,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Takes an associative array and sends a thank you or email verification email + * Takes an associative array and sends a thank you or email verification email. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 3124b1d241..53f80a74e0 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -40,7 +40,7 @@ class CRM_Campaign_BAO_Query { CIVICRM_ACTIVITY_ASSIGNMENT = 'civicrm_survey_activity_assignment'; /** - * Static field for all the campaign fields + * Static field for all the campaign fields. * * @var array */ diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 9e24638011..8f8b5c5490 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -40,21 +40,14 @@ require_once 'CRM/Campaign/DAO/Survey.php'; class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * campaign_id. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. * @param array $defaults * (reference ) an assoc array to hold the flattened values. - */ - - /** - * The action links that we need to display for the browse screen - * - * @param array $params - * @param $defaults * * @return CRM_Campaign_DAO_Survey|null */ @@ -71,7 +64,7 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { } /** - * Takes an associative array and creates a Survey object + * Takes an associative array and creates a Survey object. * * the function extract all the params it needs to initialize the create a * survey object. @@ -246,7 +239,7 @@ SELECT survey.id as id, } /** - * Get Surveys + * Get Surveys. * * @param bool $onlyActive * Retrieve only active surveys. @@ -336,7 +329,7 @@ SELECT survey.id as id, } /** - * Get Surveys custom groups + * Get Surveys custom groups. * * @param array $surveyTypes * an array of survey type id. @@ -376,7 +369,7 @@ SELECT survey.id as id, } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -391,7 +384,7 @@ SELECT survey.id as id, } /** - * Delete the survey + * Delete the survey. * * @param int $id * Survey id. @@ -711,7 +704,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * This function retrieve all option groups which are created as a result set + * This function retrieve all option groups which are created as a result set. * * @param string $valueColumnName * @return array @@ -759,7 +752,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * This function retrive all response options of survey + * This function retrive all response options of survey. * * @param int $surveyId * Survey id. @@ -781,7 +774,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * This function return all voter links with respecting permissions + * This function return all voter links with respecting permissions. * * @param int $surveyId * @param bool $enclosedInUL @@ -933,7 +926,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * Get survey supportable profile types + * Get survey supportable profile types. */ public static function surveyProfileTypes() { static $profileTypes; @@ -947,7 +940,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * Get the valid survey response fields those + * Get the valid survey response fields those. * are configured with profile and custom fields. * * @param int $surveyId diff --git a/CRM/Campaign/Controller/Search.php b/CRM/Campaign/Controller/Search.php index 73c21972a8..dce86880f5 100755 --- a/CRM/Campaign/Controller/Search.php +++ b/CRM/Campaign/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Campaign_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index 1a77939d4c..551d5daaf7 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -250,7 +250,7 @@ class CRM_Campaign_Form_Petition extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * @param $fields * @param $files * @param $form diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index 5e70c6d336..cdae4bc21f 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -332,7 +332,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * Form submission of petition signature + * Form submission of petition signature. * * * @return void @@ -575,7 +575,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * Build the petition profile form + * Build the petition profile form. * * @param int $id * @param string $name @@ -648,7 +648,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * check if user has already signed this petition + * check if user has already signed this petition. * @param array $params */ public function redirectIfSigned($params) { diff --git a/CRM/Campaign/Form/Search.php b/CRM/Campaign/Form/Search.php index 165ca403b6..66e15ecf29 100755 --- a/CRM/Campaign/Form/Search.php +++ b/CRM/Campaign/Form/Search.php @@ -39,21 +39,21 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ @@ -62,7 +62,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "survey_"; @@ -70,7 +70,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { private $_operation = 'reserve'; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -194,7 +194,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Campaign/Form/Search/Campaign.php b/CRM/Campaign/Form/Search/Campaign.php index f604c97fd2..f5bc5430a2 100755 --- a/CRM/Campaign/Form/Search/Campaign.php +++ b/CRM/Campaign/Form/Search/Campaign.php @@ -39,14 +39,14 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { /** - * Are we forced to run a search + * Are we forced to run a search. * * @var int */ protected $_force; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -69,7 +69,7 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Campaign/Form/Search/Petition.php b/CRM/Campaign/Form/Search/Petition.php index 79e8c65c02..c4bffcb6a2 100755 --- a/CRM/Campaign/Form/Search/Petition.php +++ b/CRM/Campaign/Form/Search/Petition.php @@ -39,14 +39,14 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { /** - * Are we forced to run a search + * Are we forced to run a search. * * @var int */ protected $_force; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -68,7 +68,7 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Campaign/Form/Search/Survey.php b/CRM/Campaign/Form/Search/Survey.php index 7de20bf3db..a0593d2997 100755 --- a/CRM/Campaign/Form/Search/Survey.php +++ b/CRM/Campaign/Form/Search/Survey.php @@ -39,14 +39,14 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { /** - * Are we forced to run a search + * Are we forced to run a search. * * @var int */ protected $_force; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -69,7 +69,7 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Campaign/Form/Survey.php b/CRM/Campaign/Form/Survey.php index 23c370de99..d22d152734 100644 --- a/CRM/Campaign/Form/Survey.php +++ b/CRM/Campaign/Form/Survey.php @@ -40,21 +40,21 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { /** - * The id of the object being edited + * The id of the object being edited. * * @var int */ protected $_surveyId; /** - * Action + * Action. * * @var int */ protected $_action; /** - * SurveyTitle + * SurveyTitle. * * @var string */ @@ -90,7 +90,7 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Campaign/Form/Survey/Delete.php b/CRM/Campaign/Form/Survey/Delete.php index 73ebf36d1e..d06ced1330 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -72,7 +72,7 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -92,7 +92,7 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Campaign/Form/Survey/Main.php b/CRM/Campaign/Form/Survey/Main.php index 5b3dd92cc7..f17334b590 100644 --- a/CRM/Campaign/Form/Survey/Main.php +++ b/CRM/Campaign/Form/Survey/Main.php @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { public $_values; /** - * Context + * Context. * * @var string */ @@ -139,7 +139,7 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -184,7 +184,7 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Campaign/Form/Survey/Questions.php b/CRM/Campaign/Form/Survey/Questions.php index a603c0f915..8b8c5c8b06 100644 --- a/CRM/Campaign/Form/Survey/Questions.php +++ b/CRM/Campaign/Form/Survey/Questions.php @@ -63,7 +63,7 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -101,7 +101,7 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index 5d5f4a92ec..a09fad8def 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -96,7 +96,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -203,7 +203,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * Global validation rules for the form + * Global validation rules for the form. */ public static function formRule($fields, $files, $form) { $errors = array(); @@ -338,7 +338,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Campaign/Form/SurveyType.php b/CRM/Campaign/Form/SurveyType.php index 20f4bcab4c..fe427586d0 100644 --- a/CRM/Campaign/Form/SurveyType.php +++ b/CRM/Campaign/Form/SurveyType.php @@ -62,7 +62,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { protected $_action; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -111,7 +111,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -142,7 +142,7 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index e65f6657cf..461d18069e 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/Form/Task.php @@ -75,7 +75,7 @@ class CRM_Campaign_Form_Task extends CRM_Core_Form { protected $_voterIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * @@ -132,7 +132,7 @@ class CRM_Campaign_Form_Task extends CRM_Core_Form { } /** - * Simple shell that derived classes can call to add buttons to + * Simple shell that derived classes can call to add buttons to. * the form with a customized title for the main Submit * * @param string $title diff --git a/CRM/Campaign/Form/Task/Interview.php b/CRM/Campaign/Form/Task/Interview.php index 9ff89df846..649a423335 100755 --- a/CRM/Campaign/Form/Task/Interview.php +++ b/CRM/Campaign/Form/Task/Interview.php @@ -69,7 +69,7 @@ class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_Form_Task { private $_allowAjaxReleaseButton; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -280,7 +280,7 @@ WHERE {$clause} } /** - * Build the form object + * Build the form object. * * * @return void @@ -441,7 +441,7 @@ WHERE {$clause} } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Campaign/Form/Task/Print.php b/CRM/Campaign/Form/Task/Print.php index a3dcc5f959..360eaeb168 100755 --- a/CRM/Campaign/Form/Task/Print.php +++ b/CRM/Campaign/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -102,7 +102,7 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Campaign/Form/Task/Release.php b/CRM/Campaign/Form/Task/Release.php index 770aaca721..2fe884cb81 100644 --- a/CRM/Campaign/Form/Task/Release.php +++ b/CRM/Campaign/Form/Task/Release.php @@ -63,7 +63,7 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { protected $_surveyActivities; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -136,7 +136,7 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index c56c525397..852a3466d2 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -68,7 +68,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { protected $_numVoters; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -151,7 +151,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -200,7 +200,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -233,7 +233,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Campaign/Form/Task/Result.php b/CRM/Campaign/Form/Task/Result.php index 52de2850b8..23b3c2e72b 100755 --- a/CRM/Campaign/Form/Task/Result.php +++ b/CRM/Campaign/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Campaign_Form_Task_Result extends CRM_Campaign_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Campaign_Form_Task_Result extends CRM_Campaign_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index f1a3a04ba6..db2fdbb538 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -119,7 +119,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Campaign/Page/Campaign.php b/CRM/Campaign/Page/Campaign.php index be0ada5b98..08f970fc30 100644 --- a/CRM/Campaign/Page/Campaign.php +++ b/CRM/Campaign/Page/Campaign.php @@ -41,7 +41,7 @@ class CRM_Campaign_Page_Campaign extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index 9e5fc6a941..73a7c852f5 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -39,7 +39,7 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index a30a7ce582..7c6bce2269 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -91,7 +91,7 @@ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { } /** - * Confirm email verification + * Confirm email verification. * * @param int $contact_id * The id of the contact. diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index dc5678ba9e..cda7b602d2 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -41,14 +41,14 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * The option group name + * The option group name. * * @var array */ @@ -62,7 +62,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { protected $_GName; /** - * The option group id + * The option group id. * * @var array */ @@ -89,7 +89,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -99,7 +99,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -145,7 +145,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * Browse all options + * Browse all options. * * * @return void @@ -172,7 +172,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -182,7 +182,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. @@ -204,7 +204,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * 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 38e9471f41..4b2010d264 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -108,28 +108,28 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_surveyClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -220,7 +220,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index 6084477bce..1eabf92b7f 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -35,14 +35,14 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -95,7 +95,7 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index c15991849c..0baa5daf8d 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -249,10 +249,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -420,7 +419,7 @@ WHERE civicrm_case.id = %1"; } /** - * Retrieve contact_id by case_id + * Retrieve contact_id by case_id. * * @param int $caseId * ID of the case. diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index e6c9e67537..b25fd0ae1f 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -309,10 +309,9 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index 1e7aef5d9e..cd17bb116e 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -52,7 +52,7 @@ class CRM_Case_BAO_Query { } /** - * Build select for Case + * Build select for Case. * * @param $query * @@ -242,7 +242,7 @@ class CRM_Case_BAO_Query { } /** - * Where clause for a single field + * Where clause for a single field. * * @param $values * @param $query @@ -601,7 +601,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; } /** - * Getter for the qill object + * Getter for the qill object. * * @return string */ @@ -658,7 +658,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; } /** - * This includes any extra fields that might need for export etc + * This includes any extra fields that might need for export etc. */ public static function extraReturnProperties($mode) { $properties = NULL; @@ -693,7 +693,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; } /** - * Add all the elements shared between case search and advanaced search + * Add all the elements shared between case search and advanaced search. * * * @param CRM_Core_Form $form diff --git a/CRM/Case/Controller/Search.php b/CRM/Case/Controller/Search.php index f503023cd2..c9dda84e6f 100644 --- a/CRM/Case/Controller/Search.php +++ b/CRM/Case/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Case_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index c2736f3597..990aec8f9e 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -90,7 +90,7 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -120,7 +120,7 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form @@ -132,7 +132,7 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index f3ed3af0c1..721942c4bb 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Activity_OpenCase { /** - * The id of the client associated with this case + * The id of the client associated with this case. * * @var int */ @@ -211,7 +211,7 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form @@ -251,7 +251,7 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param $fields * @param $files @@ -270,7 +270,7 @@ class CRM_Case_Form_Activity_OpenCase { } /** - * Process the form submission + * Process the form submission. * * * @param $form diff --git a/CRM/Case/Form/ActivityToCase.php b/CRM/Case/Form/ActivityToCase.php index ec58fa525d..d4056f643c 100644 --- a/CRM/Case/Form/ActivityToCase.php +++ b/CRM/Case/Form/ActivityToCase.php @@ -89,7 +89,7 @@ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Case/Form/ActivityView.php b/CRM/Case/Form/ActivityView.php index cb1ff8bbdd..2c6a0ecec7 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 { /** - * Process the view + * Process the view. * * * @return void diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index 1e7994db3b..c81821fd95 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; /** - * Build the form object + * Build the form object. * * @return void */ @@ -296,7 +296,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -311,7 +311,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -327,7 +327,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php index 4962fa7c3c..6eb78841c1 100644 --- a/CRM/Case/Form/CaseView.php +++ b/CRM/Case/Form/CaseView.php @@ -45,7 +45,7 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { private $_mergeCases = FALSE; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -206,7 +206,7 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -443,7 +443,7 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Case/Form/CustomData.php b/CRM/Case/Form/CustomData.php index 629199c870..35ce539d52 100644 --- a/CRM/Case/Form/CustomData.php +++ b/CRM/Case/Form/CustomData.php @@ -51,14 +51,14 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { protected $_entityID; /** - * The custom data type + * The custom data type. * * @var int */ protected $_cdType; /** - * Entity sub type of the table id + * Entity sub type of the table id. * * @var string */ @@ -107,7 +107,7 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Case/Form/EditClient.php b/CRM/Case/Form/EditClient.php index c115e549ec..04b788d65c 100644 --- a/CRM/Case/Form/EditClient.php +++ b/CRM/Case/Form/EditClient.php @@ -40,7 +40,7 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -77,7 +77,7 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -119,7 +119,7 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Case/Form/Report.php b/CRM/Case/Form/Report.php index 0499dd51ab..8c2179e9cf 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; /** - * Build the form object + * Build the form object. * * @return void */ @@ -119,7 +119,7 @@ class CRM_Case_Form_Report extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 47a37ccfce..2ac1b5c001 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -67,7 +67,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -166,7 +166,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void @@ -321,7 +321,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -339,7 +339,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { } /** - * Set the default form values + * Set the default form values. * * * @return array diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index eeb8797ed4..165d9b81da 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -68,7 +68,7 @@ class CRM_Case_Form_Task extends CRM_Core_Form { protected $_caseIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index 6021879485..0579065f90 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { protected $_single = FALSE; /** - * Are we moving case to Trash + * Are we moving case to Trash. * * @var boolean */ @@ -66,7 +66,7 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Case/Form/Task/Print.php b/CRM/Case/Form/Task/Print.php index 82ce616914..ef4e3291f2 100644 --- a/CRM/Case/Form/Task/Print.php +++ b/CRM/Case/Form/Task/Print.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -94,7 +94,7 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index 35c170c208..dfbfa985b1 100644 --- a/CRM/Case/Form/Task/Restore.php +++ b/CRM/Case/Form/Task/Restore.php @@ -49,7 +49,7 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -58,7 +58,7 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -68,7 +68,7 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Case/Form/Task/Result.php b/CRM/Case/Form/Task/Result.php index c1428c17fa..1e502c9bc7 100644 --- a/CRM/Case/Form/Task/Result.php +++ b/CRM/Case/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Case_Form_Task_Result extends CRM_Case_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Case_Form_Task_Result extends CRM_Case_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Case/Form/Task/SearchTaskHookSample.php b/CRM/Case/Form/Task/SearchTaskHookSample.php index 7667941c54..33a52e4e9d 100644 --- a/CRM/Case/Form/Task/SearchTaskHookSample.php +++ b/CRM/Case/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Case_Form_Task_SearchTaskHookSample extends CRM_Case_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -72,7 +72,7 @@ WHERE cs.id IN ( {$caseIDs} )"; } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index b2c9208ee8..40e78a8607 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -182,7 +182,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Case/Page/AJAX.php b/CRM/Case/Page/AJAX.php index 0ba389e2a4..3ade1de6fd 100644 --- a/CRM/Case/Page/AJAX.php +++ b/CRM/Case/Page/AJAX.php @@ -198,7 +198,7 @@ class CRM_Case_Page_AJAX { } /** - * Delete relationships specific to case and relationship type + * Delete relationships specific to case and relationship type. */ public static function deleteCaseRoles() { $caseId = CRM_Utils_Type::escape($_POST['case_id'], 'Positive'); diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php index a4736c624b..79a6f1c7c8 100644 --- a/CRM/Case/Page/Tab.php +++ b/CRM/Case/Page/Tab.php @@ -40,7 +40,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -96,7 +96,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { } /** - * View details of a case + * View details of a case. * * @return void */ @@ -137,7 +137,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { } /** - * called when action is browse + * called when action is browse. * * @return void */ @@ -160,7 +160,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ @@ -219,7 +219,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { } /** - * Get action links + * Get action links. * * @return array * (reference) of action links diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 1d28f25ce7..b53491f63c 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -70,7 +70,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { static $activityTypeList = array(); /** - * Get all the case statues + * Get all the case statues. * * * @param string $column @@ -98,7 +98,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the redaction rules + * Get all the redaction rules. * * * @param null $filter @@ -126,7 +126,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the case type + * Get all the case type. * * * @param string $column @@ -159,7 +159,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the Encounter Medium + * Get all the Encounter Medium. * * * @param string $column @@ -181,7 +181,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all Activity types for the CiviCase component + * Get all Activity types for the CiviCase component. * * The static array activityType is returned * diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 0a1e1ae651..dd7430ea63 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -125,7 +125,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -278,7 +278,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 12e3edc7d5..3f1fbaeeaa 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -35,14 +35,14 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -97,7 +97,7 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Case/Task.php b/CRM/Case/Task.php index a9492915e0..33b4e02706 100644 --- a/CRM/Case/Task.php +++ b/CRM/Case/Task.php @@ -101,7 +101,7 @@ class CRM_Case_Task { } /** - * These tasks are the core set of task titles + * These tasks are the core set of task titles. * * @return array * the set of task titles @@ -116,7 +116,7 @@ class CRM_Case_Task { } /** - * These tasks get added based on the context the user is in + * These tasks get added based on the context the user is in. * * @return array * the set of optional tasks for a group of contacts @@ -127,7 +127,7 @@ class CRM_Case_Task { } /** - * Show tasks selectively based on the permission level + * Show tasks selectively based on the permission level. * of the user * * @param int $permission @@ -156,7 +156,7 @@ class CRM_Case_Task { } /** - * These tasks are the core set of tasks + * These tasks are the core set of tasks. * * @param int $value * diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index fa575b80e0..d17e049fff 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -647,7 +647,7 @@ AND a.is_deleted = 0 } /** - * Retrieves AllowMultipleCaseClients setting + * Retrieves AllowMultipleCaseClients setting. * * @return string * 1 if allowed, 0 if not @@ -661,7 +661,7 @@ AND a.is_deleted = 0 } /** - * Retrieves NaturalActivityTypeSort setting + * Retrieves NaturalActivityTypeSort setting. * * @return string * 1 if natural, 0 if alphabetic diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 26be8e7848..4ad1e9e58d 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -35,7 +35,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { /** - * The default variable defined + * The default variable defined. * * @var boolean */ diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 9915717882..26cef83f16 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -59,7 +59,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { END"; /** - * The types of communication preferences + * The types of communication preferences. * * @var array */ @@ -72,7 +72,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { ); /** - * Types of greetings + * Types of greetings. * * @var array */ @@ -83,14 +83,14 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { ); /** - * Static field for all the contact information that we can potentially import + * Static field for all the contact information that we can potentially import. * * @var array */ static $_importableFields = array(); /** - * Static field for all the contact information that we can potentially export + * Static field for all the contact information that we can potentially export. * * @var array */ diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index e26cfabd8a..22c6fe122f 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -75,7 +75,7 @@ WHERE civicrm_contact.id = %1"; } /** - * 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. @@ -112,7 +112,7 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id ) } /** - * 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. diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index a81ee42acd..63f994ef9a 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_Contact_Permission { /** - * Check if the logged in user has permissions for the operation type + * Check if the logged in user has permissions for the operation type. * * @param int $id * Contact id. @@ -81,7 +81,7 @@ WHERE contact_a.id = %1 AND $permission"; } /** - * Fill the acl contact cache for this contact id if empty + * Fill the acl contact cache for this contact id if empty. * * @param int $userID * @param int|string $type the type of operation (view|edit) @@ -146,7 +146,7 @@ ON DUPLICATE KEY UPDATE } /** - * 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 @@ -237,7 +237,7 @@ AND $operationClause LIMIT 1"; } /** - * Get the permission base on its relationship + * Get the permission base on its relationship. * * @param int $selectedContactID * Contact id of selected contact. diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index f72865f0c6..29183ea58f 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -216,7 +216,7 @@ WHERE id IN ( $idString ) } /** - * Make sure the checksum is valid for the passed in contactID + * Make sure the checksum is valid for the passed in contactID. * * @param int $contactID * @param string $inputCheck @@ -250,7 +250,7 @@ WHERE id IN ( $idString ) } /** - * Get the count of contact loctions + * Get the count of contact loctions. * * @param int $contactId * Contact id. @@ -277,7 +277,7 @@ UNION } /** - * Create Current employer relationship for a individual + * Create Current employer relationship for a individual. * * @param int $contactID * Contact id of the individual. @@ -352,7 +352,7 @@ UNION } /** - * Create related memberships for current employer + * Create related memberships for current employer. * * @param int $contactID * Contact id of the individual. @@ -394,7 +394,7 @@ UNION } /** - * 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. @@ -412,7 +412,7 @@ WHERE contact_a.id ={$contactId} AND contact_b.id={$orgId}; "; } /** - * Update cached current employer name + * Update cached current employer name. * * @param int $organizationId * Current employer id. @@ -426,7 +426,7 @@ WHERE contact_a.employer_id=contact_b.id AND contact_b.id={$organizationId}; "; } /** - * Clear cached current employer name + * Clear cached current employer name. * * @param int $contactId * Contact id ( mostly individual contact id). @@ -565,7 +565,7 @@ UPDATE civicrm_contact } /** - * Given an array of contact ids this function will return array with links to view contact page + * Given an array of contact ids this function will return array with links to view contact page. * * @param array $contactIDs * Associated contact id's. @@ -804,7 +804,7 @@ Group By componentId"; } /** - * Function handles shared contact address processing + * Function handles shared contact address processing. * In this function we just modify submitted values so that new address created for the user * has same address as shared contact address. We copy the address so that search etc will be * much efficient. @@ -858,7 +858,7 @@ Group By componentId"; } /** - * Get the list of contact name give address associated array + * Get the list of contact name give address associated array. * * @param array $addresses * Associated array of. @@ -1070,7 +1070,7 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; } /** - * Fetch the default greeting for a given contact type + * Fetch the default greeting for a given contact type. * * @param string $contactType * Contact type. diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 2a9394ab7e..24b44f9093 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -362,7 +362,7 @@ WHERE type.name IS NOT NULL } /** - * Get a list of elements for select box + * Get a list of elements for select box. * Note that this used to default to using the hex(01) character - which results in an invalid character being used in form fields * which was not handled well be anything that loaded & resaved the html (outside core) * The use of this separator is now explicit in the calling functions as a step towards it's removal @@ -444,7 +444,7 @@ AND ( p.is_active = 1 OR p.id IS NULL ) } /** - * Check if a given type is a subtype + * Check if a given type is a subtype. * * @param string $subType * Contact subType. @@ -534,7 +534,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * Create shortcuts menu for contactTypes + * Create shortcuts menu for contactTypes. * * @return array * of contactTypes @@ -571,7 +571,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * Delete Contact SubTypes + * Delete Contact SubTypes. * * @param int $contactTypeId * ID of the Contact Subtype to be deleted. @@ -623,7 +623,7 @@ WHERE name = %1"; } /** - * Add or update Contact SubTypes + * Add or update Contact SubTypes. * * @param array $params * An assoc array of name/value pairs. @@ -688,7 +688,7 @@ WHERE name = %1"; } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -857,7 +857,7 @@ WHERE extends = %1 AND " . implode(" OR ", $subTypeClause); } /** - * Function that does something + * Function that does something. * @todo what does this function do? * * @param int $contactID diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index e645f4c096..77bd1cc587 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -42,11 +42,9 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * group_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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -148,7 +146,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Get the count of a members in a group with the specific status + * Get the count of a members in a group with the specific status. * * @param int $id * Group id. @@ -196,7 +194,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Get the list of member for a group id + * Get the list of member for a group id. * * @param int $groupID * @param bool $useCache @@ -300,7 +298,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Make sure that the user has permission to access this group + * Make sure that the user has permission to access this group. * * @param int $id * The id of the object. @@ -339,7 +337,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Create a new group + * Create a new group. * * @param array $params * @@ -518,7 +516,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Defines a new smart group + * Defines a new smart group. * * @param array $params * Associative array of parameters. @@ -546,7 +544,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -600,7 +598,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Get permission relevant clauses + * Get permission relevant clauses. * CRM-12209 * * @param bool $force @@ -704,7 +702,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * wrapper for ajax group selector + * wrapper for ajax group selector. * * @param array $params * Associated array for params record id. @@ -774,7 +772,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * This function to get list of groups + * This function to get list of groups. * * @param array $params * Associated array for params. @@ -1133,7 +1131,7 @@ WHERE {$whereClause}"; } /** - * Generate permissioned where clause for group search + * Generate permissioned where clause for group search. * @param array $params * @param bool $sortBy * @param bool $excludeHidden @@ -1224,7 +1222,7 @@ WHERE {$whereClause}"; } /** - * Define action links + * Define action links. * * @return array * array of action links diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 8616165c39..8738547076 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -35,14 +35,14 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes an associative array and creates a groupContact object + * Takes an associative array and creates a groupContact object. * * the function extract all the params it needs to initialize the create a * group object. the params array could contain additional unused name/value @@ -68,7 +68,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -260,7 +260,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { } /** - * 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. @@ -303,7 +303,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { } /** - * 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. @@ -439,7 +439,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { } /** - * Returns membership details of a contact for a group + * Returns membership details of a contact for a group. * * @param int $contactId * Id of the contact. @@ -483,7 +483,7 @@ SELECT * } /** - * Method to get Group Id + * Method to get Group Id. * * @param int $groupContactID * Id of a perticuler group. @@ -587,7 +587,7 @@ SELECT * } /** - * Function merges the groups from otherContactID to mainContactID + * Function merges the groups from otherContactID to mainContactID. * along with subscription history * * @param int $mainContactId diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 081aa5dcb5..cb9e118042 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -244,7 +244,7 @@ AND g.refresh_date IS NULL } /** - * Change the cache_date + * Change the cache_date. * * @param array $groupID * @param bool $processed @@ -273,7 +273,7 @@ WHERE id IN ( $groupIDs ) } /** - * Removes all the cache entries pertaining to a specific group + * Removes all the cache entries pertaining to a specific group. * If no groupID is passed in, removes cache entries for all groups * Has an optimization to bypass repeated invocations of this function. * Note that this function is an advisory, i.e. the removal respects the @@ -394,7 +394,7 @@ WHERE id = %1 } /** - * Removes one or more contacts from the smart group cache + * Removes one or more contacts from the smart group cache. * @param int|array $cid * @param int $groupId * @return bool @@ -419,7 +419,7 @@ WHERE id = %1 } /** - * Load the smart group cache for a saved search + * Load the smart group cache for a saved search. * * @param object $group * The smart group that needs to be loaded. @@ -600,7 +600,7 @@ AND civicrm_group_contact.group_id = $groupID "; } /** - * Get all the smart groups that this contact belongs to + * Get all the smart groups that this contact belongs to. * Note that this could potentially be a super slow function since * it ensure that all contact groups are loaded in the cache * diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 732e9d35e5..3d834d197f 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -50,7 +50,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen private $_alreadyStyled = FALSE; /** - * Class constructor + * Class constructor. */ public function __construct($styleLabels = FALSE, $styleIndent = " -- ") { parent::__construct(); diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 848157d026..bdb7291212 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -35,14 +35,14 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes an associative array and creates a groupOrganization object + * Takes an associative array and creates a groupOrganization object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -66,7 +66,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * Format the params + * Format the params. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -90,7 +90,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -119,7 +119,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * Method to check group organization relationship exist + * Method to check group organization relationship exist. * * @param int $contactID * @@ -136,7 +136,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * 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 5e26ae1208..2725559426 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 { } /** - * Update the household with primary contact id + * Update the household with primary contact id. * * @param int $primaryContactId * Null if deleting primary contact. diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 9627e8faa3..d6dbf22c64 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -45,7 +45,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * Function is used to format the individual contact values + * Function is used to format the individual contact values. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -393,7 +393,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * Creates display name + * Creates display name. * * @return string * the constructed display name @@ -405,7 +405,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 5fbd3cc374..3976e62e01 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -39,7 +39,7 @@ class CRM_Contact_BAO_Query { /** - * The various search modes + * The various search modes. * * @var int */ @@ -58,21 +58,21 @@ class CRM_Contact_BAO_Query { MODE_MAILING = 16384; /** - * The default set of return properties + * The default set of return properties. * * @var array */ static $_defaultReturnProperties = NULL; /** - * The default set of hier return properties + * The default set of hier return properties. * * @var array */ static $_defaultHierReturnProperties; /** - * The set of input params + * The set of input params. * * @var array */ @@ -185,28 +185,28 @@ class CRM_Contact_BAO_Query { public $_fields; /** - * The cache to translate the option values into labels + * The cache to translate the option values into labels. * * @var array */ public $_options; /** - * Are we in search mode + * Are we in search mode. * * @var boolean */ public $_search = TRUE; /** - * Should we skip permission checking + * Should we skip permission checking. * * @var boolean */ public $_skipPermission = FALSE; /** - * Should we skip adding of delete clause + * Should we skip adding of delete clause. * * @var boolean */ @@ -220,7 +220,7 @@ class CRM_Contact_BAO_Query { public $_strict = FALSE; /** - * What operator to use to group the clauses + * What operator to use to group the clauses. * * @var string */ @@ -229,35 +229,35 @@ class CRM_Contact_BAO_Query { public $_mode = 1; /** - * Should we only search on primary location + * Should we only search on primary location. * * @var boolean */ public $_primaryLocation = TRUE; /** - * Are contact ids part of the query + * Are contact ids part of the query. * * @var boolean */ public $_includeContactIds = FALSE; /** - * Should we use the smart group cache + * Should we use the smart group cache. * * @var boolean */ public $_smartGroupCache = TRUE; /** - * Should we display contacts with a specific relationship type + * Should we display contacts with a specific relationship type. * * @var string */ public $_displayRelationshipType = NULL; /** - * Reference to the query object for custom values + * Reference to the query object for custom values. * * @var Object */ @@ -349,7 +349,7 @@ class CRM_Contact_BAO_Query { ); /** - * List of location specific fields + * List of location specific fields. */ static $_locationSpecificFields = array( 'street_address', @@ -392,7 +392,7 @@ class CRM_Contact_BAO_Query { public $_pseudoConstantsSelect = array(); /** - * Class constructor which also does all the work + * Class constructor which also does all the work. * * @param array $params * @param array $returnProperties @@ -462,7 +462,7 @@ class CRM_Contact_BAO_Query { } /** - * Function which actually does all the work for the constructor + * Function which actually does all the work for the constructor. * * @return void */ @@ -1284,7 +1284,7 @@ class CRM_Contact_BAO_Query { } /** - * Generate the query based on what type of query we need + * Generate the query based on what type of query we need. * * @param bool $count * @param bool $sortByChar @@ -1843,7 +1843,7 @@ class CRM_Contact_BAO_Query { } /** - * Given a list of conditions in params generate the required + * Given a list of conditions in params generate the required. * where clause * * @return string @@ -2360,7 +2360,7 @@ class CRM_Contact_BAO_Query { } /** - * Getter for tables array + * Getter for tables array. * * @return array */ @@ -2401,7 +2401,7 @@ class CRM_Contact_BAO_Query { } /** - * Create the from clause + * Create the from clause. * * @param array $tables * Tables that need to be included in this from clause. @@ -2883,7 +2883,7 @@ class CRM_Contact_BAO_Query { } /** - * Function translates selection of group type into a list of groups + * Function translates selection of group type into a list of groups. * @param $value * * @return array @@ -2986,7 +2986,7 @@ WHERE id IN ( $groupIDs ) } /** - * All tag search specific + * All tag search specific. * * @param $values * @@ -4213,7 +4213,7 @@ civicrm_relationship.is_permission_a_b = 0 } /** - * Default set of return properties + * Default set of return properties. * * @param int $mode * @@ -4295,7 +4295,7 @@ civicrm_relationship.is_permission_a_b = 0 } /** - * Get primary condition for a sql clause + * Get primary condition for a sql clause. * * @param int $value * @@ -4310,7 +4310,7 @@ civicrm_relationship.is_permission_a_b = 0 } /** - * Wrapper for a simple search query + * Wrapper for a simple search query. * * @param array $params * @param array $returnProperties @@ -4428,7 +4428,7 @@ civicrm_relationship.is_permission_a_b = 0 } /** - * Create and query the db for an contact search + * Create and query the db for an contact search. * * @param int $offset * The offset for the query. @@ -4849,7 +4849,7 @@ SELECT COUNT( conts.total_amount ) as cancel_count, } /** - * Getter for the qill object + * Getter for the qill object. * * @return string */ @@ -4858,7 +4858,7 @@ SELECT COUNT( conts.total_amount ) as cancel_count, } /** - * Default set of return default hier return properties + * Default set of return default hier return properties. * * @return array */ @@ -5366,7 +5366,7 @@ AND displayRelType.is_active = 1 } /** - * Builds the necessary structures for all fields that are similar to option value lookups + * Builds the necessary structures for all fields that are similar to option value lookups. * * @param string $name * the name of the field. @@ -5585,7 +5585,7 @@ AND displayRelType.is_active = 1 } /** - * Include pseudo fields LEFT JOIN + * Include pseudo fields LEFT JOIN. * @param string|array $sort can be a object or string * * @return array|NULL diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index 8d9f26cb6b..52f35deb91 100644 --- a/CRM/Contact/BAO/Query/Hook.php +++ b/CRM/Contact/BAO/Query/Hook.php @@ -44,7 +44,7 @@ class CRM_Contact_BAO_Query_Hook { protected $_queryObjects = NULL; /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * @return object */ diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 341d42cac6..e30675de5d 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** - * Various constants to indicate different type of relationships + * Various constants to indicate different type of relationships. * * @var int */ @@ -69,7 +69,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Takes an associative array and creates a relationship object + * Takes an associative array and creates a relationship object. * @deprecated For single creates use the api instead (it's tested). * For multiple a new variant of this function needs to be written and migrated to as this is a bit * nasty @@ -262,7 +262,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Add relationship to recent links + * Add relationship to recent links. * @param array $params * @param CRM_Contact_DAO_Relationship $relationship */ @@ -347,7 +347,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Specifiy defaults for creating a relationship + * Specifiy defaults for creating a relationship. * * @return array * array of defaults for creating relationship @@ -366,7 +366,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -526,7 +526,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Delete the relationship + * Delete the relationship. * * @param int $id * Relationship id. @@ -616,7 +616,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Delete the object records that are associated with this contact + * Delete the object records that are associated with this contact. * * @param int $contactId * Id of the contact to delete. @@ -636,7 +636,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Get the other contact in a relationship + * Get the other contact in a relationship. * * @param int $id * Relationship id. @@ -657,7 +657,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Check if the relationship type selected between two contacts is correct + * Check if the relationship type selected between two contacts is correct. * * @param int $contact_a * 1st contact id. @@ -700,7 +700,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * This function does the validtion for valid relationship + * This function does the validtion for valid relationship. * * @param array $params * This array contains the values there are subitted by the form. @@ -726,7 +726,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * This function checks for duplicate relationship + * This function checks for duplicate relationship. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -806,7 +806,7 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -876,7 +876,7 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); } /** - * Helper function to form the sql for relationship retrieval + * Helper function to form the sql for relationship retrieval. * * @param int $contactId * Contact id. @@ -1021,7 +1021,7 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) } /** - * Get a list of relationships + * Get a list of relationships. * * @param int $contactId * Contact id. @@ -1527,7 +1527,7 @@ SELECT count(*) } /** - * Get Current Employer for Contact + * Get Current Employer for Contact. * * @param $contactIds * Contact Ids. @@ -1578,7 +1578,7 @@ WHERE id IN ( {$contacts} ) /** - * Function to return list of permissioned contacts for a given contact and relationship type + * Function to return list of permissioned contacts for a given contact and relationship type. * * @param int $contactID * contact id whose permissioned contacts are to be found. @@ -1626,7 +1626,7 @@ AND cc.sort_name LIKE '%$name%'"; } /** - * Merge relationships from otherContact to mainContact + * Merge relationships from otherContact to mainContact. * Called during contact merge operation * * @param int $mainId @@ -1689,7 +1689,7 @@ AND cc.sort_name LIKE '%$name%'"; } /** - * Function filters the query by possible relationships for the membership type + * Function filters the query by possible relationships for the membership type. * It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal) * and to add clauses to limit the return to those relationships which COULD inherit a membership type * (as opposed to those who inherit a particular membership @@ -1741,7 +1741,7 @@ AND cc.sort_name LIKE '%$name%'"; /** - * wrapper for contact relationship selector + * wrapper for contact relationship selector. * * @param array $params * Associated array for params record id. diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index 537f5e176a..a2b82465f7 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -35,14 +35,14 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -63,7 +63,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -78,7 +78,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * 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. @@ -132,7 +132,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType } /** - * Delete Relationship Types + * Delete Relationship Types. * * @param int $relationshipTypeId * diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index a42b1fe474..7bb048ba00 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -40,7 +40,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** - * Class constructor + * Class constructor. * * @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch */ @@ -66,8 +66,9 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -149,7 +150,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * Get the where clause for a saved search + * Get the where clause for a saved search. * * @param int $id * Saved search id. diff --git a/CRM/Contact/BAO/SubscriptionHistory.php b/CRM/Contact/BAO/SubscriptionHistory.php index cffdab3153..59d873ea40 100644 --- a/CRM/Contact/BAO/SubscriptionHistory.php +++ b/CRM/Contact/BAO/SubscriptionHistory.php @@ -38,7 +38,7 @@ */ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory { /** - * Class constructor + * Class constructor. * * @return \CRM_Contact_DAO_SubscriptionHistory */ @@ -49,7 +49,7 @@ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHi } /** - * Create a new subscription history record + * Create a new subscription history record. * * @param array $params * Values for the new history record. diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index eae321ae39..c8ecfb6393 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -44,14 +44,14 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** - * The contact type of the form + * The contact type of the form. * * @var string */ public $_contactType; /** - * The contact type of the form + * The contact type of the form. * * @var string */ @@ -65,14 +65,14 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { public $_contactId; /** - * The default group id passed in via the url + * The default group id passed in via the url. * * @var int */ public $_gid; /** - * The default tag id passed in via the url + * The default tag id passed in via the url. * * @var int */ @@ -86,7 +86,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { protected $_dedupeButtonName; /** - * Name of optional save duplicate button + * Name of optional save duplicate button. * * @var string */ @@ -104,7 +104,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { public $_customValueCount; /** - * The array of greetings with option group and filed names + * The array of greetings with option group and filed names. * * @var array */ @@ -116,7 +116,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { public $_parseStreetAddress; /** - * Check contact has a subtype or not + * Check contact has a subtype or not. */ public $_isContactSubType; @@ -128,7 +128,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { public $_preEditValues; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -578,7 +578,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -717,7 +717,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -1060,7 +1060,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Is there any real significant data in the hierarchical location array + * Is there any real significant data in the hierarchical location array. * * @param array $fields * The hierarchical value representation of this location. @@ -1112,7 +1112,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * That checks for duplicate contacts + * That checks for duplicate contacts. * * @param array $fields * Fields array which are submitted. @@ -1190,7 +1190,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -1373,7 +1373,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Update membership status to deceased + * Update membership status to deceased. * function return the status message for updated membership. * * @param array $deceasedParams diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php index 1f2f8c536b..c090fbc378 100644 --- a/CRM/Contact/Form/CustomData.php +++ b/CRM/Contact/Form/CustomData.php @@ -171,7 +171,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -229,7 +229,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { } /** - * Set the default form values + * Set the default form values. * * * @return array diff --git a/CRM/Contact/Form/DedupeFind.php b/CRM/Contact/Form/DedupeFind.php index d886b03902..587f58fa3a 100644 --- a/CRM/Contact/Form/DedupeFind.php +++ b/CRM/Contact/Form/DedupeFind.php @@ -40,12 +40,12 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { /** - * Defined defaults + * Defined defaults. */ public $_defaults; /** - * Pre processing + * Pre processing. * * @return void */ @@ -54,7 +54,7 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -83,7 +83,7 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index ccf9afe5ee..8730474ac9 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; /** - * Pre processing + * Pre processing. * * @return void */ @@ -94,7 +94,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -140,7 +140,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -187,7 +187,7 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index f05dbb8339..a6537febfe 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -46,7 +46,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { protected $_id; /** - * The contact_id of domain + * The contact_id of domain. * * @var int */ @@ -60,7 +60,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { protected $_fromEmailId = NULL; /** - * Default location type fields + * Default location type fields. * * @var array */ @@ -91,7 +91,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * This virtual function is used to set the default values of + * This virtual function is used to set the default values of. * various form elements * * @return array @@ -139,7 +139,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -176,7 +176,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -186,7 +186,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -221,7 +221,7 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index 797e68b3ae..5b3ca5596f 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_Address { /** - * Build form for address input fields + * Build form for address input fields. * * @param CRM_Core_Form $form * @param int $addressBlockCount @@ -330,7 +330,7 @@ class CRM_Contact_Form_Edit_Address { } /** - * Set default values for address block + * Set default values for address block. * * @param array $defaults * Defaults associated array. diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 3dab9b73ea..bcb691ae37 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { static $greetings = array(); /** - * Build the form object elements for Communication Preferences object + * Build the form object elements for Communication Preferences object. * * @param CRM_Core_Form $form * Reference to the form object. @@ -129,7 +129,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -202,7 +202,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * set array of greeting fields + * set array of greeting fields. * * @param $contactType * diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index c7f3ca5bc6..05bdc30f03 100644 --- a/CRM/Contact/Form/Edit/CustomData.php +++ b/CRM/Contact/Form/Edit/CustomData.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_CustomData { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param CRM_Core_Form $form * @@ -66,7 +66,7 @@ class CRM_Contact_Form_Edit_CustomData { } /** - * Build the form object elements for CustomData object + * Build the form object elements for CustomData object. * * @param CRM_Core_Form $form * Reference to the form object. diff --git a/CRM/Contact/Form/Edit/Demographics.php b/CRM/Contact/Form/Edit/Demographics.php index 6a421e3795..e9d419a184 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 object elements for Demographics object + * Build the form object elements for Demographics object. * * @param CRM_Core_Form $form * Reference to the form object. diff --git a/CRM/Contact/Form/Edit/Email.php b/CRM/Contact/Form/Edit/Email.php index 96e64087a0..e984125701 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 object elements for an email object + * Build the form object elements for an email object. * * @param CRM_Core_Form $form * Reference to the form object. diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index b74fd7e6c0..26ecc97d45 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Edit_Household { /** - * This function provides the HTML form elements that are specific + * This function provides the HTML form elements that are specific. * to the Household Contact Type * * @param CRM_Core_Form $form @@ -79,7 +79,7 @@ class CRM_Contact_Form_Edit_Household { } /** - * Add rule for household + * Add rule for household. * * @param array $fields * Array of form values. diff --git a/CRM/Contact/Form/Edit/IM.php b/CRM/Contact/Form/Edit/IM.php index f193d8114c..b5ef56287d 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 object elements for an IM object + * Build the form object elements for an IM object. * * @param CRM_Core_Form $form * Reference to the form object. diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index fab8fdf970..fb314ccaaa 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.php @@ -144,7 +144,7 @@ class CRM_Contact_Form_Edit_Individual { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index f0da56b066..476b1e0b6b 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Edit_Lock { /** - * Build the form object + * Build the form object. * * @param CRM_Core_Form $form * Form object. diff --git a/CRM/Contact/Form/Edit/Notes.php b/CRM/Contact/Form/Edit/Notes.php index 59d15bd2cf..f5d47f03eb 100644 --- a/CRM/Contact/Form/Edit/Notes.php +++ b/CRM/Contact/Form/Edit/Notes.php @@ -35,7 +35,7 @@ class CRM_Contact_Form_Edit_Notes { /** - * build form elements + * build form elements. * params object $form object of the form * * @param $form diff --git a/CRM/Contact/Form/Edit/OpenID.php b/CRM/Contact/Form/Edit/OpenID.php index 7bf5456245..b27d48f3bb 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 object 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. diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 80d7eb2b82..cb25376b68 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -35,14 +35,14 @@ class CRM_Contact_Form_Edit_TagsAndGroups { /** - * Constant to determine which forms we are generating + * Constant to determine which forms we are generating. * * Used by both profile and edit contact */ const GROUP = 1, TAG = 2, ALL = 3; /** - * build form elements + * build form elements. * params object $form object of the form * * @param CRM_Core_Form $form @@ -210,7 +210,7 @@ class CRM_Contact_Form_Edit_TagsAndGroups { } /** - * Set defaults for relevant form elements + * Set defaults for relevant form elements. * * @param int $id * The contact id. diff --git a/CRM/Contact/Form/Edit/Website.php b/CRM/Contact/Form/Edit/Website.php index 504723f6f1..79b22374d4 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 object elements for an Website object + * Build the form object elements for an Website object. * * @param CRM_Core_Form $form * Reference to the form object. diff --git a/CRM/Contact/Form/GroupContact.php b/CRM/Contact/Form/GroupContact.php index 163042be97..ff29a60134 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 { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contact/Form/Inline.php b/CRM/Contact/Form/Inline.php index c41dc3d035..1241396a8a 100644 --- a/CRM/Contact/Form/Inline.php +++ b/CRM/Contact/Form/Inline.php @@ -77,7 +77,7 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Common form elements + * Common form elements. * * @return void */ @@ -99,7 +99,7 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Override default cancel action + * Override default cancel action. * * @return void */ @@ -109,7 +109,7 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -123,7 +123,7 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Add entry to log table + * Add entry to log table. * * @return void */ @@ -135,7 +135,7 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Common function for all inline contact edit forms + * Common function for all inline contact edit forms. * Prepares ajaxResponse * * @return void @@ -150,15 +150,16 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { } /** - * Render changelog footer markup for a contact and supply count + * Render change log footer markup for a contact and supply count. + * * Needed for refreshing the contact summary screen * * @param int $cid * @param bool $includeCount * @return array */ - static function renderFooter($cid, $includeCount = TRUE) { - // Load changelog footer from template + public static function renderFooter($cid, $includeCount = TRUE) { + // Load change log footer from template. $smarty = CRM_Core_Smarty::singleton(); $smarty->assign('contactId', $cid); $smarty->assign('external_identifier', CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'external_identifier')); diff --git a/CRM/Contact/Form/Inline/Address.php b/CRM/Contact/Form/Inline/Address.php index c2df08244e..e930045db2 100644 --- a/CRM/Contact/Form/Inline/Address.php +++ b/CRM/Contact/Form/Inline/Address.php @@ -76,7 +76,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -120,7 +120,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for an address object + * Build the form object elements for an address object. * * @return void */ @@ -130,7 +130,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -159,7 +159,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/CommunicationPreferences.php b/CRM/Contact/Form/Inline/CommunicationPreferences.php index a8912124d5..b1740a105c 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 object elements for communication preferences + * Build the form object elements for communication preferences. * * @return void */ @@ -50,7 +50,7 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_ } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -80,7 +80,7 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_ } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/ContactInfo.php b/CRM/Contact/Form/Inline/ContactInfo.php index dfcfd8eb4e..330ceea571 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 object elements + * Build the form object elements. * * @return void */ @@ -52,7 +52,7 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -61,7 +61,7 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/ContactName.php b/CRM/Contact/Form/Inline/ContactName.php index 1847c866c9..0a874a1113 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 object elements + * Build the form object elements. * * @return void */ @@ -52,7 +52,7 @@ class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php index 9916cf895b..a993ff2747 100644 --- a/CRM/Contact/Form/Inline/CustomData.php +++ b/CRM/Contact/Form/Inline/CustomData.php @@ -39,21 +39,21 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { /** - * Custom group id + * Custom group id. * * @int */ public $_groupID; /** - * Entity type of the table id + * Entity type of the table id. * * @var string */ protected $_entityType; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -68,7 +68,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for custom data + * Build the form object elements for custom data. * * @return void */ @@ -78,7 +78,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -87,7 +87,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/Demographics.php b/CRM/Contact/Form/Inline/Demographics.php index e17e687634..4a3a01ee8d 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 object elements + * Build the form object elements. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 98c3a2a17a..8c1b2cab35 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -39,17 +39,17 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { /** - * Email addresses of the contact that is been viewed + * Email addresses of the contact that is been viewed. */ private $_emails = array(); /** - * No of email blocks for inline edit + * No of email blocks for inline edit. */ private $_blockCount = 6; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for an email object + * Build the form object elements for an email object. * * @return void */ @@ -96,7 +96,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -131,7 +131,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -152,7 +152,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index fc2f18fd6e..39215d50ad 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -39,17 +39,17 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { /** - * Ims of the contact that is been viewed + * Ims of the contact that is been viewed. */ private $_ims = array(); /** - * No of im blocks for inline edit + * No of im blocks for inline edit. */ private $_blockCount = 6; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for im object + * Build the form object elements for im object. * * @return void */ @@ -96,7 +96,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -134,7 +134,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -154,7 +154,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 280099c68e..b963f823d0 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Inline_Lock { /** - * This function provides the HTML form elements + * This function provides the HTML form elements. * * @param CRM_Core_Form $form * Form object. diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 06aa298532..e59404ce3a 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -39,17 +39,17 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { /** - * Ims of the contact that is been viewed + * Ims of the contact that is been viewed. */ private $_openids = array(); /** - * No of openid blocks for inline edit + * No of openid blocks for inline edit. */ private $_blockCount = 6; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for openID object + * Build the form object elements for openID object. * * @return void */ @@ -96,7 +96,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -134,7 +134,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -154,7 +154,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index e4ba3f4600..9496c38f7d 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { private $_blockCount = 6; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -62,7 +62,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for phone object + * Build the form object elements for phone object. * * @return void */ @@ -96,7 +96,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -135,7 +135,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -155,7 +155,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Inline/Website.php b/CRM/Contact/Form/Inline/Website.php index a0f6152793..554ba66f2c 100644 --- a/CRM/Contact/Form/Inline/Website.php +++ b/CRM/Contact/Form/Inline/Website.php @@ -39,17 +39,17 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { /** - * Websitess of the contact that is been viewed + * Websitess of the contact that is been viewed. */ private $_websites = array(); /** - * No of website blocks for inline edit + * No of website blocks for inline edit. */ private $_blockCount = 6; /** - * Call preprocess + * Call preprocess. */ public function preProcess() { parent::preProcess(); @@ -61,7 +61,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * Build the form object elements for website object + * Build the form object elements for website object. * * @return void */ @@ -94,7 +94,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * Set defaults for the form + * Set defaults for the form. * * @return array */ @@ -115,7 +115,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index 5126495b23..35a9baa235 100644 --- a/CRM/Contact/Form/Location.php +++ b/CRM/Contact/Form/Location.php @@ -35,7 +35,7 @@ class CRM_Contact_Form_Location { /** - * Set variables up before form is built + * Set variables up before form is built. * * @param CRM_Core_Form $form * @@ -77,7 +77,7 @@ class CRM_Contact_Form_Location { } /** - * Build the form object + * Build the form object. * * @param CRM_Core_Form $form * diff --git a/CRM/Contact/Form/ProfileContact.php b/CRM/Contact/Form/ProfileContact.php index 14f7004b25..9aaf558b93 100644 --- a/CRM/Contact/Form/ProfileContact.php +++ b/CRM/Contact/Form/ProfileContact.php @@ -37,7 +37,7 @@ class CRM_Contact_Form_ProfileContact { protected $_mode; /** - * Set variables up before form is built + * Set variables up before form is built. * * @param CRM_Core_Form $form * diff --git a/CRM/Contact/Form/RelatedContact.php b/CRM/Contact/Form/RelatedContact.php index 7c01ebaa37..58c694b358 100644 --- a/CRM/Contact/Form/RelatedContact.php +++ b/CRM/Contact/Form/RelatedContact.php @@ -42,7 +42,7 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form { /** - * The contact type of the form + * The contact type of the form. * * @var string */ @@ -56,7 +56,7 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form { public $_contactId; /** - * Form defaults + * Form defaults. * * @var array */ diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php index e386bc5752..6bda27e560 100644 --- a/CRM/Contact/Form/Relationship.php +++ b/CRM/Contact/Form/Relationship.php @@ -290,7 +290,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -399,7 +399,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * This function is called when the form is submitted + * This function is called when the form is submitted. * * * @return void @@ -554,7 +554,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { } /** - * 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 5896630c73..cc48430312 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -44,35 +44,35 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** - * list of valid contexts + * list of valid contexts. * * @var array */ static $_validContext = NULL; /** - * List of values used when we want to display other objects + * List of values used when we want to display other objects. * * @var array */ static $_modeValues = NULL; /** - * The contextMenu + * The contextMenu. * * @var array */ protected $_contextMenu; /** - * The groupId retrieved from the GET vars + * The groupId retrieved from the GET vars. * * @var int */ public $_groupID; /** - * The Group ID belonging to Add Member to group ID + * The Group ID belonging to Add Member to group ID. * retrieved from the GET vars * * @var int @@ -80,14 +80,14 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_amtgID; /** - * The saved search ID retrieved from the GET vars + * The saved search ID retrieved from the GET vars. * * @var int */ protected $_ssID; /** - * The group elements + * The group elements. * * @var array */ @@ -96,7 +96,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { public $_groupIterator; /** - * The tag elements + * The tag elements. * * @var array */ @@ -104,28 +104,28 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { public $_tagElement; /** - * The params used for search + * The params used for search. * * @var array */ protected $_params; /** - * The return properties used for search + * The return properties used for search. * * @var array */ protected $_returnProperties; /** - * The sort by character + * The sort by character. * * @var string */ protected $_sortByCharacter; /** - * The profile group id used for display + * The profile group id used for display. * * @var integer */ @@ -152,7 +152,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_modeValue; /** - * Name of the selector to use + * Name of the selector to use. */ static $_selectorName = 'CRM_Contact_Selector'; protected $_customSearchID = NULL; @@ -161,7 +161,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_openedPanes = array(); /** - * Define the set of valid contexts that the search form operates on + * Define the set of valid contexts that the search form operates on. * * @return array * the valid context set and the titles @@ -462,7 +462,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { } /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -723,7 +723,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { } /** - * Common post processing + * Common post processing. * * @return void */ diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 5c18365737..09ce18cbf4 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -43,7 +43,7 @@ s | under the terms of the GNU Affero General Public License | class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -57,7 +57,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void @@ -176,7 +176,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -199,7 +199,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -409,7 +409,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Normalize default values for multiselect plugins + * Normalize default values for multiselect plugins. * * @param array $defaults * @return array diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index e908e6b5b2..4fc1bcdc66 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -51,7 +51,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { static $csv = array('contact_type', 'group', 'tag'); /** - * Build the form object + * Build the form object. * * * @return void @@ -106,7 +106,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -138,7 +138,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -148,7 +148,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -166,7 +166,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * This method is called for processing a submitted search form + * This method is called for processing a submitted search form. * * @return void */ diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index c40f158529..20c06a75d0 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -39,21 +39,21 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** - * Number of columns in where + * Number of columns in where. * * @var int */ public $_columnCount; /** - * Number of blocks to be shown + * Number of blocks to be shown. * * @var int */ public $_blockCount; /** - * Build the form object + * Build the form object. * * @return void */ @@ -123,7 +123,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -133,7 +133,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param $values * @param $files @@ -319,7 +319,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Contact/Form/Search/Custom.php b/CRM/Contact/Form/Search/Custom.php index 4dbf9e046d..919b315c5d 100644 --- a/CRM/Contact/Form/Search/Custom.php +++ b/CRM/Contact/Form/Search/Custom.php @@ -119,7 +119,7 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php index 0a8fd72628..daa784f8bb 100644 --- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php +++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php @@ -156,7 +156,7 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_ } /** - * Construct the search query + * Construct the search query. */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, @@ -282,7 +282,7 @@ ORDER BY contact_a.sort_name'; } /** - * 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 * diff --git a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php index 3eb41d1179..75469ebe33 100644 --- a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php +++ b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php @@ -105,7 +105,7 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac } /** - * Construct the search query + * Construct the search query. * * @param int $offset * @param int $rowcount @@ -184,7 +184,7 @@ civicrm_contact AS contact_a } /** - * 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 * diff --git a/CRM/Contact/Form/Search/Custom/EmployerListing.php b/CRM/Contact/Form/Search/Custom/EmployerListing.php index 5ace6dd3b7..6b77ddba3e 100644 --- a/CRM/Contact/Form/Search/Custom/EmployerListing.php +++ b/CRM/Contact/Form/Search/Custom/EmployerListing.php @@ -102,7 +102,7 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form } /** - * Construct the search query + * Construct the search query. */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, @@ -175,7 +175,7 @@ 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 * diff --git a/CRM/Contact/Form/Search/Custom/EventAggregate.php b/CRM/Contact/Form/Search/Custom/EventAggregate.php index bea5e0b820..a2029c9a10 100644 --- a/CRM/Contact/Form/Search/Custom/EventAggregate.php +++ b/CRM/Contact/Form/Search/Custom/EventAggregate.php @@ -108,7 +108,7 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea } /** - * Construct the search query + * Construct the search query. */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, @@ -202,7 +202,7 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea } /** - * 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 * diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php index 8a97932502..b52c843aed 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php +++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php @@ -246,7 +246,7 @@ GROUP BY {$tableValues['id']} } /** - * Create a SQL expression for matching against a list of + * Create a SQL expression for matching against a list of. * text columns. * * @param string $table diff --git a/CRM/Contact/Form/Search/Custom/TagContributions.php b/CRM/Contact/Form/Search/Custom/TagContributions.php index d580312bdf..9b26887ac6 100644 --- a/CRM/Contact/Form/Search/Custom/TagContributions.php +++ b/CRM/Contact/Form/Search/Custom/TagContributions.php @@ -91,7 +91,7 @@ class CRM_Contact_Form_Search_Custom_TagContributions implements CRM_Contact_For } /** - * Construct the search query + * Construct the search query. */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 5922d26a71..ffcba9bd3a 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -62,7 +62,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { protected $_title; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -75,7 +75,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -147,7 +147,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -165,7 +165,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -175,7 +175,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $params * @@ -196,7 +196,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index d8c63c0ca8..2773a44b69 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 object + * Build the form object. * * * @return void @@ -50,7 +50,7 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -106,7 +106,7 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/AddToOrganization.php b/CRM/Contact/Form/Task/AddToOrganization.php index 9cda916ba9..8614654664 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 object + * Build the form object. * * * @return void @@ -50,7 +50,7 @@ class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -109,7 +109,7 @@ class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/AddToTag.php b/CRM/Contact/Form/Task/AddToTag.php index 21a7524cc6..ba99e3dcec 100644 --- a/CRM/Contact/Form/Task/AddToTag.php +++ b/CRM/Contact/Form/Task/AddToTag.php @@ -41,21 +41,21 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { /** - * Name of the tag + * Name of the tag. * * @var string */ protected $_name; /** - * All the tags in the system + * All the tags in the system. * * @var array */ protected $_tags; /** - * Build the form object + * Build the form object. * * * @return void @@ -93,7 +93,7 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/AlterPreferences.php b/CRM/Contact/Form/Task/AlterPreferences.php index c21c1bf865..b1586642f8 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 object + * Build the form object. * * * @return void @@ -66,7 +66,7 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -94,7 +94,7 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index cded698cd6..b467f664c1 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -39,34 +39,34 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Maximum contacts that should be allowed to update + * Maximum contacts that should be allowed to update. */ protected $_maxContacts = 100; /** - * Maximum profile fields that will be displayed + * Maximum profile fields that will be displayed. */ protected $_maxFields = 9; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * When not to reset sort_name + * When not to reset sort_name. */ protected $_preserveDefault = TRUE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -76,7 +76,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -191,7 +191,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -219,7 +219,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void @@ -263,7 +263,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { } /** - * Parse street address + * Parse street address. * @param array $contactValues * Contact values. * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index c16191f622..aa07b52bd2 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -54,7 +54,7 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { protected $_sharedAddressMessage = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -147,7 +147,7 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -179,7 +179,7 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -201,7 +201,7 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/Email.php b/CRM/Contact/Form/Task/Email.php index 411ae69312..4d5a4c5c1d 100644 --- a/CRM/Contact/Form/Task/Email.php +++ b/CRM/Contact/Form/Task/Email.php @@ -56,14 +56,14 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { public $_noEmails = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ public $_templates = NULL; /** - * Store "to" contact details + * Store "to" contact details. * @var array */ public $_toContactDetails = array(); @@ -75,25 +75,25 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { public $_allContactIds = array(); /** - * Store only "to" contact ids + * Store only "to" contact ids. * @var array */ public $_toContactIds = array(); /** - * Store only "cc" contact ids + * Store only "cc" contact ids. * @var array */ public $_ccContactIds = array(); /** - * Store only "bcc" contact ids + * Store only "bcc" contact ids. * @var array */ public $_bccContactIds = array(); /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -148,7 +148,7 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -162,7 +162,7 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index f8102e3ad7..5ae914f617 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -130,7 +130,7 @@ class CRM_Contact_Form_Task_EmailCommon { } /** - * Build the form object + * Build the form object. * * * @param CRM_Core_Form $form @@ -318,7 +318,7 @@ class CRM_Contact_Form_Task_EmailCommon { } /** - * Form rule + * Form rule. * * @param array $fields * The input form values. @@ -348,7 +348,7 @@ class CRM_Contact_Form_Task_EmailCommon { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/HookSample.php b/CRM/Contact/Form/Task/HookSample.php index d743c1e7ca..9994dbcd84 100644 --- a/CRM/Contact/Form/Task/HookSample.php +++ b/CRM/Contact/Form/Task/HookSample.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_HookSample extends CRM_Contact_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -82,7 +82,7 @@ AND c.id IN ( $contactIDs )"; } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index 039069e3e1..7610482db7 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -50,7 +50,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -105,7 +105,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void @@ -361,7 +361,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * Check for presence of tokens to be swapped out + * Check for presence of tokens to be swapped out. * * @param array $contact * @param array $mailingFormatProperties diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 6235f07c42..2e6788de4f 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -71,7 +71,7 @@ class CRM_Contact_Form_Task_LabelCommon { /** - * Get the rows for the labels + * Get the rows for the labels. * * @param $contactIDs * @param int $locationTypeID @@ -250,7 +250,7 @@ class CRM_Contact_Form_Task_LabelCommon { } /** - * Get array of return properties for address fields required for mailing label + * Get array of return properties for address fields required for mailing label. * * @return array * return properties for address e.g diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 7ad8ab5d03..8a051cceb0 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -49,7 +49,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -114,7 +114,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -131,7 +131,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void @@ -140,7 +140,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { } /** - * Assign smarty variables to the template that will be used by google api to plot the contacts + * Assign smarty variables to the template that will be used by google api to plot the contacts. * * @param $ids * @param int $locationId diff --git a/CRM/Contact/Form/Task/Map/Event.php b/CRM/Contact/Form/Task/Map/Event.php index 799368976a..89a9b40c53 100644 --- a/CRM/Contact/Form/Task/Map/Event.php +++ b/CRM/Contact/Form/Task/Map/Event.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -59,7 +59,7 @@ class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Contact/Form/Task/Merge.php b/CRM/Contact/Form/Task/Merge.php index e117b2dd8a..3ee4e27e61 100644 --- a/CRM/Contact/Form/Task/Merge.php +++ b/CRM/Contact/Form/Task/Merge.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_Merge extends CRM_Contact_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ diff --git a/CRM/Contact/Form/Task/PDF.php b/CRM/Contact/Form/Task/PDF.php index f58042c2b5..3cacf95555 100644 --- a/CRM/Contact/Form/Task/PDF.php +++ b/CRM/Contact/Form/Task/PDF.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ @@ -53,7 +53,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { public $_activityId = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -107,7 +107,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -119,7 +119,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index 740b689cb4..3a0625b01a 100644 --- a/CRM/Contact/Form/Task/PDFLetterCommon.php +++ b/CRM/Contact/Form/Task/PDFLetterCommon.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param CRM_Core_Form $form * @@ -73,7 +73,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Build the form object + * Build the form object. * * @var CRM_Core_Form $form * @@ -194,7 +194,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Set default values + * Set default values. */ public static function setDefaultValues() { $defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues(); @@ -203,7 +203,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Form rule + * Form rule. * * @param array $fields * The input form values. @@ -238,7 +238,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Part of the post process which prepare and extract information from the template + * Part of the post process which prepare and extract information from the template. * * * @param CRM_Core_Form $form @@ -313,7 +313,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index 48508c0f25..43d3c2a92f 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -61,7 +61,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -94,7 +94,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -122,7 +122,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -132,7 +132,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -153,7 +153,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/Print.php b/CRM/Contact/Form/Task/Print.php index 6f3451d257..d57e96319f 100644 --- a/CRM/Contact/Form/Task/Print.php +++ b/CRM/Contact/Form/Task/Print.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_Print extends CRM_Contact_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -134,7 +134,7 @@ class CRM_Contact_Form_Task_Print extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 082e0dacef..a5423b285e 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -39,28 +39,28 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { /** - * The context that we are working on + * The context that we are working on. * * @var string */ protected $_context; /** - * The groupId retrieved from the GET vars + * The groupId retrieved from the GET vars. * * @var int */ protected $_id; /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -70,7 +70,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @param CRM_Core_Form $form @@ -104,7 +104,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -133,7 +133,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { } /** - * Set the default form values + * Set the default form values. * * * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/RemoveFromGroup.php b/CRM/Contact/Form/Task/RemoveFromGroup.php index cc93717f89..9747f36ccf 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 object + * Build the form object. * * * @return void @@ -56,7 +56,7 @@ class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -72,7 +72,7 @@ class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/RemoveFromTag.php b/CRM/Contact/Form/Task/RemoveFromTag.php index bb4b5831a4..9528ca4700 100644 --- a/CRM/Contact/Form/Task/RemoveFromTag.php +++ b/CRM/Contact/Form/Task/RemoveFromTag.php @@ -39,21 +39,21 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task { /** - * Name of the tag + * Name of the tag. * * @var string */ protected $_name; /** - * All the tags in the system + * All the tags in the system. * * @var array */ protected $_tags; /** - * Build the form object + * Build the form object. * * * @return void @@ -90,7 +90,7 @@ class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/Result.php b/CRM/Contact/Form/Task/Result.php index 223f8d27da..249a4af4ed 100644 --- a/CRM/Contact/Form/Task/Result.php +++ b/CRM/Contact/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Contact_Form_Task_Result extends CRM_Contact_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -97,7 +97,7 @@ class CRM_Contact_Form_Task_Result extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contact/Form/Task/SMS.php b/CRM/Contact/Form/Task/SMS.php index 84641c14f6..3b179886d4 100644 --- a/CRM/Contact/Form/Task/SMS.php +++ b/CRM/Contact/Form/Task/SMS.php @@ -48,7 +48,7 @@ class CRM_Contact_Form_Task_SMS extends CRM_Contact_Form_Task { public $_single = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ @@ -73,7 +73,7 @@ class CRM_Contact_Form_Task_SMS extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -86,7 +86,7 @@ class CRM_Contact_Form_Task_SMS extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 526e8541a7..f0a32bca14 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -83,7 +83,7 @@ class CRM_Contact_Form_Task_SMSCommon { } /** - * Build the form object + * Build the form object. * * * @param CRM_Core_Form $form @@ -301,7 +301,7 @@ class CRM_Contact_Form_Task_SMSCommon { } /** - * Form rule + * Form rule. * * @param array $fields * The input form values. @@ -339,7 +339,7 @@ class CRM_Contact_Form_Task_SMSCommon { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/SaveSearch.php b/CRM/Contact/Form/Task/SaveSearch.php index efc3b3b193..3185c8dc3c 100644 --- a/CRM/Contact/Form/Task/SaveSearch.php +++ b/CRM/Contact/Form/Task/SaveSearch.php @@ -40,14 +40,14 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task { /** - * Saved search id if any + * Saved search id if any. * * @var int */ protected $_id; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -142,7 +142,7 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contact/Form/Task/SaveSearch/Update.php b/CRM/Contact/Form/Task/SaveSearch/Update.php index 3b819a2e40..13da749956 100644 --- a/CRM/Contact/Form/Task/SaveSearch/Update.php +++ b/CRM/Contact/Form/Task/SaveSearch/Update.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_SaveSearch { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ diff --git a/CRM/Contact/Form/Task/Unhold.php b/CRM/Contact/Form/Task/Unhold.php index f0b2b54fb3..61ee1fed84 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Contact/Form/Task/Useradd.php b/CRM/Contact/Form/Task/Useradd.php index 53ec0361e7..d34764f7e5 100755 --- a/CRM/Contact/Form/Task/Useradd.php +++ b/CRM/Contact/Form/Task/Useradd.php @@ -46,7 +46,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { public $_displayName; /** - * Primary email of contact for whom we are adding user + * Primary email of contact for whom we are adding user. * * @var int */ @@ -82,7 +82,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -130,7 +130,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { } /** - * Validation Rule + * Validation Rule. * */ public static function usernameRule($params) { diff --git a/CRM/Contact/Import/Controller.php b/CRM/Contact/Import/Controller.php index 8769d3f222..fd408fb78d 100644 --- a/CRM/Contact/Import/Controller.php +++ b/CRM/Contact/Import/Controller.php @@ -35,7 +35,7 @@ class CRM_Contact_Import_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php index 2d669f08b3..a73074ddfd 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; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -127,7 +127,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -368,7 +368,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { } /** - * Add a PK and status column to the import table so we can track our progress + * Add a PK and status column to the import table so we can track our progress. * Returns the name of the primary key and status columns * * @param $db diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index b5d3a7d8f6..f67c4aca13 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -48,7 +48,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { protected $_formattedFieldNames; /** - * On duplicate + * On duplicate. * * @var int */ @@ -59,7 +59,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { protected static $customFields; /** - * Attempt to match header labels with our mapper fields + * Attempt to match header labels with our mapper fields. * FIXME: This is essentially the same function as parent::defaultFromHeader * * @param $columnName name of column header @@ -91,7 +91,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -199,7 +199,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -621,7 +621,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index b3f3bf4142..30e891c0c2 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -136,7 +136,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -199,7 +199,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Contact/Import/Form/Summary.php b/CRM/Contact/Import/Form/Summary.php index fd4241d2ec..61ac5bdb96 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -124,7 +124,7 @@ class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary { } /** - * Clean up the import table we used + * Clean up the import table we used. * * @return void */ diff --git a/CRM/Contact/Import/Page/AJAX.php b/CRM/Contact/Import/Page/AJAX.php index 0461fa99c8..c6a2fbc452 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 { /** - * Show import status + * Show import status. */ public static function status() { // make sure we get an id diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index 3d4a053031..84aa3ed3ba 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -402,7 +402,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * Given a list of the importable field keys that the user has selected + * Given a list of the importable field keys that the user has selected. * set the active fields array to this list * * @param array $fieldKeys @@ -451,7 +451,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * 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 { } /** - * 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 { } /** - * 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 @@ -662,7 +662,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * @@ -726,7 +726,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * Export data to a CSV file + * Export data to a CSV file. * * @param string $fileName * @param array $header diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 35981dd8e4..080c19bb27 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -79,7 +79,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { protected $_newContacts; /** - * Line count id + * Line count id. * * @var int */ @@ -93,14 +93,14 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { protected $_newRelatedContacts; /** - * Array of all the contacts whose street addresses are not parsed + * Array of all the contacts whose street addresses are not parsed. * of this import process * @var array */ protected $_unparsedStreetAddressContacts; /** - * Class constructor + * Class constructor. */ public function __construct( &$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL, @@ -245,7 +245,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -257,7 +257,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -270,7 +270,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Handle the values in summary mode + * Handle the values in summary mode. * * @param array $values * The array of values belonging to this line. @@ -440,7 +440,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. @@ -1100,7 +1100,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Check if an error in custom data + * Check if an error in custom data. * * @param array $params * @param string $errorMessage @@ -1285,7 +1285,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Check if value present in all genders or + * Check if value present in all genders or. * as a substring of any gender value, if yes than return corresponding gender. * eg value might be m/M, ma/MA, mal/MAL, male return 'Male' * but if value is 'maleabc' than return false @@ -1592,7 +1592,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Ckeck a value present or not in a array + * Ckeck a value present or not in a array. * * @param $value * @param $valueArray @@ -1628,7 +1628,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Method for creating contact + * Method for creating contact. */ public function createContact(&$formatted, &$contactFields, $onDuplicate, $contactId = NULL, $requiredCheck = TRUE, $dedupeRuleGroupID = NULL) { $dupeCheck = FALSE; @@ -1688,7 +1688,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Format params for update and fill mode + * Format params for update and fill mode. * * @param array $params * reference to an array containing all the. diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php index 9c9018c845..14ae97970e 100644 --- a/CRM/Contact/Page/AJAX.php +++ b/CRM/Contact/Page/AJAX.php @@ -103,7 +103,7 @@ class CRM_Contact_Page_AJAX { } /** - * Ajax callback for custom fields of type ContactReference + * Ajax callback for custom fields of type ContactReference. * * Todo: Migrate contact reference fields to use EntityRef */ @@ -331,7 +331,7 @@ class CRM_Contact_Page_AJAX { } /** - * Fetch the custom field help + * Fetch the custom field help. */ public static function customField() { $fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer'); @@ -533,7 +533,7 @@ ORDER BY sort_name "; } /** - * Delete custom value + * Delete custom value. */ public static function deleteCustomValue() { $customValueID = CRM_Utils_Type::escape($_REQUEST['valueID'], 'Positive'); @@ -594,7 +594,7 @@ ORDER BY sort_name "; } /** - * check the CMS username + * check the CMS username. */ static public function checkUserName() { $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), array('for', 'ts')); @@ -630,7 +630,7 @@ ORDER BY sort_name "; } /** - * Function to get email address of a contact + * Function to get email address of a contact. */ public static function getContactEmail() { if (!empty($_REQUEST['contact_id'])) { @@ -856,7 +856,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function used for CiviCRM dashboard operations + * Function used for CiviCRM dashboard operations. */ public static function dashboard() { $operation = CRM_Utils_Type::escape($_REQUEST['op'], 'String'); @@ -888,7 +888,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Retrieve signature based on email id + * Retrieve signature based on email id. */ public static function getSignature() { $emailID = CRM_Utils_Type::escape($_REQUEST['emailID'], 'Positive'); @@ -989,7 +989,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Retrieve a PDF Page Format for the PDF Letter form + * Retrieve a PDF Page Format for the PDF Letter form. */ public function pdfFormat() { $formatId = CRM_Utils_Type::escape($_REQUEST['formatId'], 'Integer'); @@ -1000,7 +1000,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Retrieve Paper Size dimensions + * Retrieve Paper Size dimensions. */ public static function paperSize() { $paperSizeName = CRM_Utils_Type::escape($_REQUEST['paperSizeName'], 'String'); @@ -1073,7 +1073,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Retrieve contact relationships + * Retrieve contact relationships. */ public static function getContactRelationships() { $contactID = CRM_Utils_Type::escape($_GET['cid'], 'Integer'); diff --git a/CRM/Contact/Page/CustomSearch.php b/CRM/Contact/Page/CustomSearch.php index 60a899b1e3..e09664c9f7 100644 --- a/CRM/Contact/Page/CustomSearch.php +++ b/CRM/Contact/Page/CustomSearch.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_CustomSearch extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ diff --git a/CRM/Contact/Page/DashBoard.php b/CRM/Contact/Page/DashBoard.php index d50fbc173f..ad108bc0b2 100644 --- a/CRM/Contact/Page/DashBoard.php +++ b/CRM/Contact/Page/DashBoard.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_DashBoard extends CRM_Core_Page { /** - * Run dashboard + * Run dashboard. * * @return void */ diff --git a/CRM/Contact/Page/Dashlet.php b/CRM/Contact/Page/Dashlet.php index b0f68fa369..4872729479 100644 --- a/CRM/Contact/Page/Dashlet.php +++ b/CRM/Contact/Page/Dashlet.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_Dashlet extends CRM_Core_Page { /** - * Run dashboard + * Run dashboard. * * @return void */ diff --git a/CRM/Contact/Page/DedupeFind.php b/CRM/Contact/Page/DedupeFind.php index 22e5100ce2..8863bfb1f7 100644 --- a/CRM/Contact/Page/DedupeFind.php +++ b/CRM/Contact/Page/DedupeFind.php @@ -39,7 +39,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { protected $_gid; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -49,7 +49,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return void * (reference) of action links @@ -58,7 +58,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Browse all rule groups + * Browse all rule groups. * * @return void */ @@ -314,7 +314,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Browse all rule groups + * Browse all rule groups. * * @return void */ @@ -331,7 +331,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * classname of edit form @@ -341,7 +341,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page @@ -351,7 +351,7 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { } /** - * Get user context + * Get user context. * * @param null $mode * diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php index 862ba1bdbc..0a95966c95 100644 --- a/CRM/Contact/Page/DedupeRules.php +++ b/CRM/Contact/Page/DedupeRules.php @@ -35,14 +35,14 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -52,7 +52,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -94,7 +94,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Run the page + * Run the page. * * This method is called after the page is created. It checks for the type * of action and executes that action. Finally it calls the parent's run @@ -135,7 +135,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Browse all rule groups + * Browse all rule groups. * * @return void */ @@ -180,7 +180,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * classname of edit form @@ -190,7 +190,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page @@ -200,7 +200,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * Get user context + * Get user context. * * @param null $mode * diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index c28de8986d..a55750cc43 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -144,7 +144,7 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links diff --git a/CRM/Contact/Page/Task.php b/CRM/Contact/Page/Task.php index 70fb69237a..18e9d1fa97 100644 --- a/CRM/Contact/Page/Task.php +++ b/CRM/Contact/Page/Task.php @@ -43,7 +43,7 @@ class CRM_Contact_Page_Task extends CRM_Core_Page { /** - * Returns the page title + * Returns the page title. * * @return string * the title of the page diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index fcd335de87..433601177b 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -342,7 +342,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { } /** - * Add urls for display in the actions menu + * Add urls for display in the actions menu. * @param CRM_Core_Page $obj * @param int $cid */ diff --git a/CRM/Contact/Page/View/ContactSmartGroup.php b/CRM/Contact/Page/View/ContactSmartGroup.php index 518c04cc0a..ca7c6ba04f 100644 --- a/CRM/Contact/Page/View/ContactSmartGroup.php +++ b/CRM/Contact/Page/View/ContactSmartGroup.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page { public $_contactId; /** - * called when action is browse + * called when action is browse. * */ public function browse() { diff --git a/CRM/Contact/Page/View/CustomData.php b/CRM/Contact/Page/View/CustomData.php index 3e7d8b40fc..b0ca7b48e8 100644 --- a/CRM/Contact/Page/View/CustomData.php +++ b/CRM/Contact/Page/View/CustomData.php @@ -47,7 +47,7 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { public $_groupId; /** - * Class constructor + * Class constructor. * * @return CRM_Contact_Page_View_CustomData */ @@ -56,7 +56,7 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { } /** - * Add a few specific things to view contact + * Add a few specific things to view contact. * * @return void */ diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index ab8a89ed45..3e1254cbcd 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -35,7 +35,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** - * called when action is browse + * called when action is browse. * */ public function browse() { @@ -69,7 +69,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { } /** - * called when action is update + * called when action is update. * * @param int $groupId * diff --git a/CRM/Contact/Page/View/Log.php b/CRM/Contact/Page/View/Log.php index 991599affd..b8cfb43cb6 100644 --- a/CRM/Contact/Page/View/Log.php +++ b/CRM/Contact/Page/View/Log.php @@ -35,7 +35,7 @@ class CRM_Contact_Page_View_Log extends CRM_Core_Page { /** - * called when action is browse + * called when action is browse. * * @return null */ diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php index 5a5deeb949..8afa5e3057 100644 --- a/CRM/Contact/Page/View/Note.php +++ b/CRM/Contact/Page/View/Note.php @@ -54,7 +54,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { static $_commentLinks = NULL; /** - * View details of a note + * View details of a note. * * @return void */ @@ -80,7 +80,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { } /** - * called when action is browse + * called when action is browse. */ public function browse() { $note = new CRM_Core_DAO_Note(); @@ -157,7 +157,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action); @@ -232,7 +232,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { } /** - * Delete the note object from the db + * Delete the note object from the db. * * @return void */ @@ -241,7 +241,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { } /** - * Get action links + * Get action links. * * @return array * (reference) of action links @@ -281,7 +281,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { } /** - * Get action links for comments + * Get action links for comments. * * @return array * (reference) of action links diff --git a/CRM/Contact/Page/View/Print.php b/CRM/Contact/Page/View/Print.php index 667d6055e3..854e3ce60b 100644 --- a/CRM/Contact/Page/View/Print.php +++ b/CRM/Contact/Page/View/Print.php @@ -56,7 +56,7 @@ class CRM_Contact_Page_View_Print extends CRM_Contact_Page_View_Summary { } /** - * View summary details of a contact + * View summary details of a contact. * * @return void */ diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php index b5957c337d..b93dfa3e1a 100644 --- a/CRM/Contact/Page/View/Relationship.php +++ b/CRM/Contact/Page/View/Relationship.php @@ -35,14 +35,14 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Casid set if called from case context + * Casid set if called from case context. * * @var int */ @@ -52,7 +52,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { public $_contactId = NULL; /** - * View details of a relationship + * View details of a relationship. * * @return void */ @@ -133,7 +133,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { } /** - * called when action is browse + * called when action is browse. * */ public function browse() { @@ -141,7 +141,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * */ public function edit() { @@ -256,7 +256,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { } /** - * called to delete the relationship of a contact + * called to delete the relationship of a contact. * */ public function delete() { @@ -265,7 +265,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { } /** - * Get action links + * Get action links. * * @return array * (reference) of action links diff --git a/CRM/Contact/Page/View/Summary.php b/CRM/Contact/Page/View/Summary.php index 62f27a32c4..d81d6e7373 100644 --- a/CRM/Contact/Page/View/Summary.php +++ b/CRM/Contact/Page/View/Summary.php @@ -104,7 +104,7 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { } /** - * Edit name and address of a contact + * Edit name and address of a contact. * * @return void */ @@ -121,7 +121,7 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { } /** - * View summary details of a contact + * View summary details of a contact. * * @return void */ diff --git a/CRM/Contact/Page/View/Sunlight.php b/CRM/Contact/Page/View/Sunlight.php index ee7cf5b98e..2d6839d87a 100644 --- a/CRM/Contact/Page/View/Sunlight.php +++ b/CRM/Contact/Page/View/Sunlight.php @@ -35,7 +35,7 @@ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View { /** - * called when action is browse + * called when action is browse. * * @return void */ diff --git a/CRM/Contact/Page/View/Tag.php b/CRM/Contact/Page/View/Tag.php index 0fe007bfbd..ae08c3ff23 100644 --- a/CRM/Contact/Page/View/Tag.php +++ b/CRM/Contact/Page/View/Tag.php @@ -35,7 +35,7 @@ class CRM_Contact_Page_View_Tag extends CRM_Core_Page { /** - * called when action is browse + * called when action is browse. * * @return void */ diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php index 66dac73021..3661b894da 100644 --- a/CRM/Contact/Page/View/UserDashBoard.php +++ b/CRM/Contact/Page/View/UserDashBoard.php @@ -42,7 +42,7 @@ 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; @@ -50,7 +50,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { public $_edit = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -108,7 +108,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * Build user dashboard + * Build user dashboard. * * @return void */ @@ -198,7 +198,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * Perform actions and display for user dashboard + * Perform actions and display for user dashboard. * * @return void */ @@ -209,7 +209,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * Get action links + * Get action links. * * @return array * (reference) of action links diff --git a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php index ccfc9544bd..daaffe44a1 100644 --- a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php +++ b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php @@ -35,7 +35,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_View_UserDashBoard { /** - * called when action is browse + * called when action is browse. * * @return void */ @@ -75,7 +75,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ } /** - * called when action is update + * called when action is update. * * @param int $groupId * diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index c67a421566..94cd3c49ae 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -136,7 +136,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se protected $_fields; /** - * Class constructor + * Class constructor. * * @param $customSearchClass * @param array $formValues @@ -511,7 +511,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. @@ -1115,7 +1115,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont } /** - * Get colunmn headers for search selector + * Get colunmn headers for search selector. * * @return array */ diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index f1f173a278..35f2775283 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -42,7 +42,7 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -117,7 +117,7 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Contact/Task.php b/CRM/Contact/Task.php index 4caa253392..c6e5825f44 100644 --- a/CRM/Contact/Task.php +++ b/CRM/Contact/Task.php @@ -354,7 +354,7 @@ class CRM_Contact_Task { } /** - * These tasks get added based on the context the user is in + * These tasks get added based on the context the user is in. * * @return array * the set of optional tasks for a group of contacts diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 030b140391..ab5a7b8d7f 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -65,7 +65,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { public $_component = NULL; /** - * Class constructor + * Class constructor. * * @return \CRM_Contribute_DAO_Contribution */ @@ -76,7 +76,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * 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 @@ -196,7 +196,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * Get defaults for new entity + * Get defaults for new entity. * @return array */ public static function getDefaults() { @@ -283,7 +283,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * Takes an associative array and creates a contribution object + * Takes an associative array and creates a contribution object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -528,10 +528,9 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -549,7 +548,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * Combine all the importable fields from the lower levels object + * Combine all the importable fields from the lower levels object. * * The ordering is important, since currently we do not have a weight * scheme. Adding weight is super important and should be done in the @@ -774,7 +773,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * Delete the indirect records associated with this contribution first + * Delete the indirect records associated with this contribution first. * * @param int $id * @@ -846,7 +845,7 @@ 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 + * Check if there is a contribution with the same trxn_id or invoice_id. * * @param array $input * An assoc array of name/value pairs. @@ -898,7 +897,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * Takes an associative array and creates a contribution_product object + * Takes an associative array and creates a contribution_product object. * * the function extract all the params it needs to initialize the create a * contribution_product object. the params array could contain additional unused name/value @@ -916,7 +915,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * 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 * @@ -1013,7 +1012,7 @@ GROUP BY p.id } /** - * 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. @@ -1051,7 +1050,7 @@ GROUP BY p.id } /** - * Get the sort name of a contact for a particular contribution + * Get the sort name of a contact for a particular contribution. * * @param int $id * Id of the contribution. @@ -1181,7 +1180,7 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id } /** - * Get the contribution details for component export + * Get the contribution details for component export. * * @param int $exportMode * Export mode. @@ -1283,7 +1282,7 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont } /** - * Delete billing address record related contribution + * Delete billing address record related contribution. * * @param int $contributionId * @param int $contactId @@ -1843,7 +1842,7 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ } /** - * Get individual id for onbehalf contribution + * Get individual id for onbehalf contribution. * * @param int $contributionId * Contribution id. @@ -1951,7 +1950,7 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac } /** - * Load objects relations to contribution object + * Load objects relations to contribution object. * Objects are stored in the $_relatedObjects property * In the first instance we are just moving functionality from BASEIpn - * @see http://issues.civicrm.org/jira/browse/CRM-9996 @@ -2613,7 +2612,7 @@ WHERE contribution_id = %1 "; } /** - * Check whether subscription is already cancelled + * Check whether subscription is already cancelled. * * @param int $contributionId * Contribution id. @@ -2637,7 +2636,7 @@ WHERE contribution_id = %1 "; } /** - * Create all financial accounts entry + * Create all financial accounts entry. * * @param array $params * Contribution object, line item array and params for trxn. @@ -2936,7 +2935,7 @@ WHERE contribution_id = %1 "; } /** - * Update all financial accounts entry + * Update all financial accounts entry. * * @param array $params * Contribution object, line item array and params for trxn. @@ -3108,7 +3107,7 @@ WHERE contribution_id = %1 "; } /** - * Check status validation on update of a contribution + * Check status validation on update of a contribution. * * @param array $values * Previous form values before submit. @@ -3146,7 +3145,7 @@ WHERE contribution_id = %1 "; } /** - * Delete contribution of contact + * Delete contribution of contact. * * CRM-12155 * @@ -3202,7 +3201,7 @@ WHERE contribution_id = %1 "; } /** - * Validate financial type + * Validate financial type. * * CRM-13231 * @@ -3225,7 +3224,7 @@ WHERE contribution_id = %1 "; /** - * Function to record additional payment for partial and refund contributions + * Function to record additional payment for partial and refund contributions. * * @param int $contributionId * is the invoice contribution id (got created after processing participant payment). @@ -3443,7 +3442,7 @@ WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']}) } /** - * Get list of payments displayed by Contribute_Page_PaymentInfo + * Get list of payments displayed by Contribute_Page_PaymentInfo. * * @param int $id * @param $component diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index d76dc8badd..ed49c7124b 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -34,7 +34,7 @@ class CRM_Contribute_BAO_Contribution_Utils { /** - * Process payment after confirmation + * Process payment after confirmation. * * @param CRM_Core_Form $form * Form object. @@ -418,7 +418,7 @@ INNER JOIN civicrm_contact AS contact ON ( contact.id = contrib.contact_id ) } /** - * Get the contribution details by year + * Get the contribution details by year. * * @return array * associated array diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 4d9647ecf6..df2fffa39f 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -39,7 +39,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_ContributionPage { /** - * Takes an associative array and creates a contribution page object + * Takes an associative array and creates a contribution page object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -64,7 +64,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -110,7 +110,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Send the emails + * Send the emails. * * @param int $contactID * Contact id. @@ -431,7 +431,7 @@ 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 array $tplParams * @param int $contactID @@ -460,7 +460,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * Send the emails for Recurring Contribution Notication + * Send the emails for Recurring Contribution Notication. * * @param string $type * TxnType. @@ -904,7 +904,7 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm } /** - * Generate html for pdf in confirmation receipt email attachment + * Generate html for pdf in confirmation receipt email attachment. * @param int $contributionId * Contribution Page Id. * @param int $userID diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index 5f5ca6024c..ee81af0b63 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 { /** - * 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 @@ -104,7 +104,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi } /** - * Check if there is a recurring contribution with the same trxn_id or invoice_id + * Check if there is a recurring contribution with the same trxn_id or invoice_id. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -321,7 +321,7 @@ SELECT r.payment_processor_id } /** - * Get list of recurring contribution of contact Ids + * Get list of recurring contribution of contact Ids. * * @param int $contactId * Contact ID. diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index 4e278040a6..a5eaeb3cac 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -35,14 +35,14 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft { /** - * Construct method + * Construct method. */ public function __construct() { parent::__construct(); } /** - * Add contribution soft credit record + * Add contribution soft credit record. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -63,7 +63,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -83,7 +83,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * Delete soft credits + * Delete soft credits. * * @param array $params * diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 7a016f5360..b0ada9e03a 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -35,19 +35,19 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultContributionType = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -68,7 +68,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -88,7 +88,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * add the financial types + * add the financial types. * * @param array $params * Reference array contains the values submitted by the form. @@ -129,7 +129,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * Delete premium Types + * Delete premium Types. * * @param int $productID */ diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 75ba837749..e57cf29dd3 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -35,20 +35,20 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { /** - * Product information + * Product information. * @var array */ private static $productInfo; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -68,7 +68,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -83,7 +83,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Delete financial Types + * Delete financial Types. * * @param int $premiumID * @@ -98,7 +98,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Build Premium Block im Contribution Pages + * Build Premium Block im Contribution Pages. * * @param CRM_Core_Form $form * @param int $pageID @@ -166,7 +166,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Build Premium B im Contribution Pages + * Build Premium B im Contribution Pages. * * @param CRM_Core_Form $form * @param int $productID @@ -239,7 +239,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Retrieve premium product and their options + * Retrieve premium product and their options. * * @return array * product and option arrays diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index dd0693dd6b..cd3be1e927 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -851,7 +851,7 @@ class CRM_Contribute_BAO_Query { } /** - * Add all the elements shared between contribute search and advnaced search + * Add all the elements shared between contribute search and advnaced search. * * * @param CRM_Core_Form $form @@ -1019,7 +1019,7 @@ class CRM_Contribute_BAO_Query { } /** - * Add the where for dates + * Add the where for dates. * * @param array $values * Array of query values. diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index b21c6c0afc..bf847ce37a 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -67,14 +67,14 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { */ protected $_paymentProcessors = array(); /** - * The id of the contribution that we are processing + * The id of the contribution that we are processing. * * @var int */ public $_id; /** - * The id of the premium that we are proceessing + * The id of the premium that we are proceessing. * * @var int */ @@ -386,7 +386,7 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * Assign billing type id to bltID + * Assign billing type id to bltID. * * @throws CRM_Core_Exception * @return void diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index e248660966..2e2565fb01 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -191,7 +191,7 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Process the Premium Information + * Process the Premium Information. * * * @param array $params @@ -250,7 +250,7 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Process the Note + * Process the Note. * * * @param array $params @@ -277,7 +277,7 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Process the Common data + * Process the Common data. * * * @param array $params diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php index a74e669594..925358c29b 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; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -131,7 +131,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -195,7 +195,7 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 5824a75775..189976e82a 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -39,14 +39,14 @@ */ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment { /** - * The id of the contribution that we are processing + * The id of the contribution that we are processing. * * @var int */ public $_id; /** - * The id of the premium that we are processing + * The id of the premium that we are processing. * * @var int */ @@ -58,35 +58,35 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_productDAO = NULL; /** - * The id of the note + * The id of the note. * * @var int */ public $_noteID; /** - * The id of the contact associated with this contribution + * The id of the contact associated with this contribution. * * @var int */ public $_contactID; /** - * The id of the pledge payment that we are processing + * The id of the pledge payment that we are processing. * * @var int */ public $_ppID; /** - * The id of the pledge that we are processing + * The id of the pledge that we are processing. * * @var int */ public $_pledgeID; /** - * Is this contribution associated with an online + * Is this contribution associated with an online. * financial transaction * * @var boolean @@ -129,7 +129,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_context; /** - * Parameter with confusing name + * Parameter with confusing name. * @todo what is it? * @var string */ @@ -479,7 +479,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * Build the form object + * Build the form object. * * @return void */ @@ -931,7 +931,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -997,7 +997,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index 20812df92b..1cb0d331bd 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase { /** - * The id of the contact associated with this contribution + * The id of the contact associated with this contribution. * * @var int */ @@ -47,14 +47,14 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** - * The id of the contribution object that is created when the form is submitted + * The id of the contribution object that is created when the form is submitted. * * @var int */ public $_contributionID; /** - * Set the parameters to be passed to contribution create function + * Set the parameters to be passed to contribution create function. * * @param array $params * @param int $contactID @@ -148,7 +148,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -441,7 +441,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Build the form object + * Build the form object. * * @return void */ @@ -672,7 +672,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index ac4c167c60..18a5efc135 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_ContributionBase { /** - * Define default MembershipType Id + * Define default MembershipType Id. */ public $_defaultMemTypeId; @@ -65,7 +65,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu protected $_snippet; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -191,7 +191,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Set the default values + * Set the default values. * * @return void */ @@ -378,7 +378,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Build the form object + * Build the form object. * * @return void */ @@ -652,7 +652,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Build elements to collect information for recurring contributions + * Build elements to collect information for recurring contributions. * * * @param CRM_Core_Form $form @@ -724,7 +724,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -1135,7 +1135,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index 6a0240baa3..8790aee8fa 100644 --- a/CRM/Contribute/Form/Contribution/OnBehalfOf.php +++ b/CRM/Contribute/Form/Contribution/OnBehalfOf.php @@ -35,7 +35,7 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { /** - * Set variables up before form is built + * Set variables up before form is built. * * @param CRM_Core_Form $form * diff --git a/CRM/Contribute/Form/Contribution/ThankYou.php b/CRM/Contribute/Form/Contribution/ThankYou.php index c0a6f01778..89045a7de8 100644 --- a/CRM/Contribute/Form/Contribution/ThankYou.php +++ b/CRM/Contribute/Form/Contribution/ThankYou.php @@ -39,12 +39,12 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_ContributionBase { /** - * Membership price set status + * Membership price set status. */ public $_useForMember; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -88,7 +88,7 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index af11f4cf41..4424649842 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -198,7 +198,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_isBillingAddressRequiredForPayLater; /** - * Set variables up before form is built + * Set variables up before form is built. * * @throws \CRM_Contribute_Exception_InactiveContributionPageException * @throws \Exception @@ -521,7 +521,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Set the default values + * Set the default values. * * @return void */ @@ -530,7 +530,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Assign the minimal set of variables to the template + * Assign the minimal set of variables to the template. * * @return void */ @@ -661,7 +661,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Add the custom fields + * Add the custom fields. * * @param int $id * @param string $name @@ -787,7 +787,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Check template file exists + * Check template file exists. * @param null $suffix * * @return null|string @@ -804,7 +804,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php index 7cbd765276..4aebe1681f 100644 --- a/CRM/Contribute/Form/ContributionCharts.php +++ b/CRM/Contribute/Form/ContributionCharts.php @@ -35,14 +35,14 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { /** - * Year of chart + * Year of chart. * * @var int */ protected $_year = NULL; /** - * The type of chart + * The type of chart. * * @var string */ @@ -62,7 +62,7 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * * @return void @@ -98,7 +98,7 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index 718805e7da..8a2cb63446 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -39,14 +39,14 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { /** - * The page id saved to the session for an update + * The page id saved to the session for an update. * * @var int */ protected $_id; /** - * The pledgeBlock id saved to the session for an update + * The pledgeBlock id saved to the session for an update. * * @var int */ @@ -83,7 +83,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_values; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -143,7 +143,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -346,7 +346,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ @@ -438,7 +438,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Contribute/Form/ContributionPage/AddProduct.php b/CRM/Contribute/Form/ContributionPage/AddProduct.php index c75b63632e..0a290cd8d2 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; /** - * Pre process the form + * Pre process the form. * * * @return void @@ -111,7 +111,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For } /** - * Build the form object + * Build the form object. * * @return void */ @@ -228,7 +228,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index 420ba3f032..4ca9d4aef1 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -51,7 +51,7 @@ class CRM_Contribute_Form_ContributionPage_Amount extends CRM_Contribute_Form_Co const NUM_OPTION = 11; /** - * Build the form object + * Build the form object. * * @return void */ @@ -274,7 +274,7 @@ SELECT id } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -407,7 +407,7 @@ SELECT id } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 6ea083c0cc..66321fa89c 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 { /** - * Build the form object + * Build the form object. * * @return void */ @@ -111,7 +111,7 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co } /** - * Process the form + * Process the form. * * @return void */ @@ -164,7 +164,7 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. diff --git a/CRM/Contribute/Form/ContributionPage/Delete.php b/CRM/Contribute/Form/ContributionPage/Delete.php index 38fc342062..97bb8c9e42 100644 --- a/CRM/Contribute/Form/ContributionPage/Delete.php +++ b/CRM/Contribute/Form/ContributionPage/Delete.php @@ -39,19 +39,19 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_ContributionPage { /** - * Page title + * Page title. * * @var string */ protected $_title; /** - * Check if there are any related contributions + * Check if there are any related contributions. */ protected $_relatedContributions; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -75,7 +75,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co } /** - * Build the form object + * Build the form object. * * @return void */ @@ -103,7 +103,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index 490ecdf7f9..03daa0d649 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -60,7 +60,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C } /** - * Build the form object + * Build the form object. * * @return void */ @@ -109,7 +109,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -128,7 +128,7 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index 0cff4b85a0..eaade9d0a1 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -111,7 +111,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * Build the form object + * Build the form object. * * @return void */ @@ -227,7 +227,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -305,7 +305,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index cd5aaec14f..93a834ce65 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -52,7 +52,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ } /** - * Build the form object + * Build the form object. * * @return void */ @@ -90,7 +90,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -117,7 +117,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index 2a67a33519..5b3fa6936d 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -218,7 +218,7 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co } /** - * 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 03af773953..6312a64d49 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -203,7 +203,7 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index e11c270868..df7e175965 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 { /** - * Pre process the form + * Pre process the form. * * * @return void @@ -85,7 +85,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -209,7 +209,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Function for validation + * Function for validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -275,7 +275,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void @@ -360,7 +360,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Resize a premium image to a different size + * Resize a premium image to a different size. * * * @param string $filename diff --git a/CRM/Contribute/Form/Search.php b/CRM/Contribute/Form/Search.php index 70a43a3e5c..b8c9574dfe 100644 --- a/CRM/Contribute/Form/Search.php +++ b/CRM/Contribute/Form/Search.php @@ -43,21 +43,21 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ @@ -66,12 +66,12 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "contribute_"; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -169,7 +169,7 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Contribute/Form/SearchContribution.php b/CRM/Contribute/Form/SearchContribution.php index 647bf28268..8a3d64f65a 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 object + * Build the form object. * * * @return void diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 9950d55084..2837a3b405 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_SoftCredit { /** - * Set variables up before form is built + * Set variables up before form is built. * * @param CRM_Core_Form $form * @@ -67,7 +67,7 @@ class CRM_Contribute_Form_SoftCredit { /** - * Function used to build form element for soft credit block + * Function used to build form element for soft credit block. * * @param CRM_Core_Form $form * @@ -160,7 +160,7 @@ class CRM_Contribute_Form_SoftCredit { } /** - * Function used to set defaults for soft credit block + * Function used to set defaults for soft credit block. * * @param $defaults * @param $form @@ -194,7 +194,7 @@ class CRM_Contribute_Form_SoftCredit { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index d8cb4ccffd..55178af850 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -40,56 +40,56 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * The array that holds all the contribution ids + * The array that holds all the contribution ids. * * @var array */ protected $_contributionIds; /** - * The array that holds all the contact ids + * The array that holds all the contact ids. * * @var array */ public $_contactIds; /** - * The array that holds all the mapping contribution and contact ids + * The array that holds all the mapping contribution and contact ids. * * @var array */ protected $_contributionContactIds = array(); /** - * The flag to tell if there are soft credits included + * The flag to tell if there are soft credits included. * * @var boolean */ public $_includesSoftCredits = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * diff --git a/CRM/Contribute/Form/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index c543c03ac5..67624f4d1c 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -56,7 +56,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -81,7 +81,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -204,7 +204,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index b567b6e1ac..5b19e4cdbc 100644 --- a/CRM/Contribute/Form/Task/Delete.php +++ b/CRM/Contribute/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -62,7 +62,7 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -72,7 +72,7 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index de5bb2846c..c60f86c518 100644 --- a/CRM/Contribute/Form/Task/Email.php +++ b/CRM/Contribute/Form/Task/Email.php @@ -50,14 +50,14 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { public $_noEmails = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ public $_templates = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -72,7 +72,7 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -85,7 +85,7 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 86a36d3e0d..7abf59d38c 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -46,27 +46,27 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { public $_single = FALSE; /** - * Gives all the statues for conribution + * Gives all the statues for conribution. */ public $_contributionStatusId; /** - * Gives the HTML template of PDF Invoice + * Gives the HTML template of PDF Invoice. */ public $_messageInvoice; /** - * This variable is used to assign parameters for HTML template of PDF Invoice + * This variable is used to assign parameters for HTML template of PDF Invoice. */ public $_invoiceTemplate; /** - * Selected output + * Selected output. */ public $_selectedOutput; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -138,7 +138,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -203,7 +203,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * @@ -221,7 +221,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void @@ -232,7 +232,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Process the PDf and email with activity and attachment + * Process the PDf and email with activity and attachment. * on click of Print Invoices * * @param array $contribIDs @@ -572,7 +572,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Add activity for Email Invoice and the PDF Invoice + * Add activity for Email Invoice and the PDF Invoice. * * @param string $subject * Activity subject. @@ -620,7 +620,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * Create the Invoice file in upload folder for attachment + * Create the Invoice file in upload folder for attachment. * * @param string $html * Content for pdf in html format. diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index c9abc96453..ae90e4134c 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -48,7 +48,7 @@ class CRM_Contribute_Form_Task_PDF extends CRM_Contribute_Form_Task { protected $_rows; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -101,7 +101,7 @@ AND {$this->_componentClause}"; } /** - * Build the form object + * Build the form object. * * * @return void @@ -137,7 +137,7 @@ AND {$this->_componentClause}"; } /** - * Set default values + * Set default values. */ public function setDefaultValues() { $defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues(); @@ -145,7 +145,7 @@ AND {$this->_componentClause}"; } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void @@ -234,7 +234,7 @@ AND {$this->_componentClause}"; } /** - * Declaration of common variables for Invoice and PDF + * Declaration of common variables for Invoice and PDF. * * * @param array $contribIds diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index 54187802a2..b987920827 100644 --- a/CRM/Contribute/Form/Task/PDFLetter.php +++ b/CRM/Contribute/Form/Task/PDFLetter.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ @@ -51,7 +51,7 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { public $_cid = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -104,7 +104,7 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -161,7 +161,7 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index f081e32b5f..d95aed8cf4 100644 --- a/CRM/Contribute/Form/Task/PDFLetterCommon.php +++ b/CRM/Contribute/Form/Task/PDFLetterCommon.php @@ -7,7 +7,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon { /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @param CRM_Contribute_Form_Task $form @@ -311,7 +311,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF } /** - * Send pdf by email + * Send pdf by email. * * @param array $contact * @param string $html diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index e5e320df97..62f2d195fa 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -56,7 +56,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -85,7 +85,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -109,7 +109,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -119,7 +119,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -132,7 +132,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/Print.php b/CRM/Contribute/Form/Task/Print.php index df88bddcb7..0ae9f5a944 100644 --- a/CRM/Contribute/Form/Task/Print.php +++ b/CRM/Contribute/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -93,7 +93,7 @@ class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/Task/Result.php b/CRM/Contribute/Form/Task/Result.php index df2ccd55ed..4e75ebac01 100644 --- a/CRM/Contribute/Form/Task/Result.php +++ b/CRM/Contribute/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contribute/Form/Task/SearchTaskHookSample.php b/CRM/Contribute/Form/Task/SearchTaskHookSample.php index 1468fd70bb..3416c61752 100644 --- a/CRM/Contribute/Form/Task/SearchTaskHookSample.php +++ b/CRM/Contribute/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_Task_SearchTaskHookSample extends CRM_Contribute_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -74,7 +74,7 @@ INNER JOIN civicrm_contact ct ON ( co.contact_id = ct.id ) } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index b05b4e46a4..9a8a111bc3 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -49,7 +49,7 @@ class CRM_Contribute_Form_Task_Status extends CRM_Contribute_Form_Task { protected $_rows; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -87,7 +87,7 @@ AND {$this->_componentClause}"; } /** - * Build the form object + * Build the form object. * * * @return void @@ -180,7 +180,7 @@ AND co.id IN ( $contribIDs )"; } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -212,7 +212,7 @@ AND co.id IN ( $contribIDs )"; } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index aa7070cb08..a4037a2ed3 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; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -190,7 +190,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -218,7 +218,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -241,7 +241,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Contribute/Form/UpdateSubscription.php b/CRM/Contribute/Form/UpdateSubscription.php index 221eae56c8..e6e0a92429 100644 --- a/CRM/Contribute/Form/UpdateSubscription.php +++ b/CRM/Contribute/Form/UpdateSubscription.php @@ -61,7 +61,7 @@ class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form { public $_paymentProcessorObj = NULL; /** - * The id of the contact associated with this recurring contribution + * The id of the contact associated with this recurring contribution. * * @var int */ @@ -141,7 +141,7 @@ class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form { } /** - * Actually build the components of the form + * Actually build the components of the form. * * @return void */ @@ -181,7 +181,7 @@ class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form { } /** - * called after the user submits the form + * called after the user submits the form. * * * @return void diff --git a/CRM/Contribute/Import/Controller.php b/CRM/Contribute/Import/Controller.php index ed3d44e3bf..eab6d18ac8 100644 --- a/CRM/Contribute/Import/Controller.php +++ b/CRM/Contribute/Import/Controller.php @@ -35,7 +35,7 @@ class CRM_Contribute_Import_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Contribute/Import/Form/DataSource.php b/CRM/Contribute/Import/Form/DataSource.php index 90c5d2009a..a76f80d9c4 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -51,7 +51,7 @@ class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -151,7 +151,7 @@ class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index 2f8de8e58c..14cc1523ad 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -40,7 +40,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -106,7 +106,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -342,7 +342,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Contribute/Import/Form/Preview.php b/CRM/Contribute/Import/Form/Preview.php index eee332bd85..7ed19940b9 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Contribute/Import/Form/Summary.php b/CRM/Contribute/Import/Form/Summary.php index 5640fdc37e..8be06fa5cb 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index e55a563ff4..b4a807bd2f 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -442,7 +442,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * 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 @@ -496,7 +496,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * @@ -562,7 +562,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * Export data to a CSV file + * Export data to a CSV file. * * @param string $fileName * @param array $header @@ -601,7 +601,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * Determines the file extension based on error code + * Determines the file extension based on error code. * * @param int $type * Error code constant. @@ -635,7 +635,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * Determines the file name based on error code + * Determines the file name based on error code. * * @param int $type * Error code constant. diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php index dd2ca07561..b51b006cdd 100644 --- a/CRM/Contribute/Import/Parser/Contribution.php +++ b/CRM/Contribute/Import/Parser/Contribution.php @@ -140,7 +140,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -152,7 +152,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -165,7 +165,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * Handle the values in summary mode + * Handle the values in summary mode. * * @param array $values * The array of values belonging to this line. @@ -242,7 +242,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index 0605f8f1ef..bfd3b3638d 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -94,7 +94,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * Provides permissions that are unwise for Anonymous Roles to have + * Provides permissions that are unwise for Anonymous Roles to have. * * @return array * list of permissions @@ -187,7 +187,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts * @param $newCredit */ diff --git a/CRM/Contribute/Page/ContributionPage.php b/CRM/Contribute/Page/ContributionPage.php index d432da34a8..79304f0320 100644 --- a/CRM/Contribute/Page/ContributionPage.php +++ b/CRM/Contribute/Page/ContributionPage.php @@ -47,7 +47,7 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -388,7 +388,7 @@ AND cp.page_type = 'contribute' } /** - * Browse all contribution pages + * Browse all contribution pages. * * @param mixed $action * Unused parameter. diff --git a/CRM/Contribute/Page/ContributionRecur.php b/CRM/Contribute/Page/ContributionRecur.php index 322825be0d..56383613f9 100644 --- a/CRM/Contribute/Page/ContributionRecur.php +++ b/CRM/Contribute/Page/ContributionRecur.php @@ -44,7 +44,7 @@ class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page { public $_contactId = NULL; /** - * View details of a recurring contribution + * View details of a recurring contribution. * * @return void */ diff --git a/CRM/Contribute/Page/ManagePremiums.php b/CRM/Contribute/Page/ManagePremiums.php index 801c634f3b..0b9807ce70 100644 --- a/CRM/Contribute/Page/ManagePremiums.php +++ b/CRM/Contribute/Page/ManagePremiums.php @@ -41,14 +41,14 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -58,7 +58,7 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -178,7 +178,7 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -188,7 +188,7 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Contribute/Page/Premium.php b/CRM/Contribute/Page/Premium.php index 0bf9e5d00a..6ba50e7e68 100644 --- a/CRM/Contribute/Page/Premium.php +++ b/CRM/Contribute/Page/Premium.php @@ -39,14 +39,14 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -56,7 +56,7 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -194,7 +194,7 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -204,7 +204,7 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Contribute/Page/Tab.php b/CRM/Contribute/Page/Tab.php index 0f899c49bf..cd33a94160 100644 --- a/CRM/Contribute/Page/Tab.php +++ b/CRM/Contribute/Page/Tab.php @@ -35,7 +35,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -102,7 +102,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { // end function /** - * called when action is browse + * called when action is browse. * */ public function browse() { @@ -197,7 +197,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { } /** - * called when action is view + * called when action is view. * * @return null */ @@ -215,7 +215,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ diff --git a/CRM/Contribute/Page/UserDashboard.php b/CRM/Contribute/Page/UserDashboard.php index ece6ccbe97..4bcb8474fc 100644 --- a/CRM/Contribute/Page/UserDashboard.php +++ b/CRM/Contribute/Page/UserDashboard.php @@ -35,7 +35,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** - * called when action is browse + * called when action is browse. */ public function listContribution() { $controller = new CRM_Core_Controller_Simple( diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index 38d41c0f95..047d04424e 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -243,7 +243,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the valid accepted credit cards + * Get all the valid accepted credit cards. * * * @return array @@ -254,7 +254,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all premiums + * Get all premiums. * * * @param int $pageID @@ -301,7 +301,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the contribution statuses + * Get all the contribution statuses. * * * @param int $id @@ -325,7 +325,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the Personal campaign pages + * Get all the Personal campaign pages. * * * @param null $pageType @@ -413,7 +413,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all batches + * Get all batches. * * * @param int $id diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index ed22579c57..f0aead14ac 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -146,7 +146,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C protected $_includeSoftCredits = FALSE; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -295,7 +295,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Contribute/StateMachine/Contribution.php b/CRM/Contribute/StateMachine/Contribution.php index f9c757b031..7362420e00 100644 --- a/CRM/Contribute/StateMachine/Contribution.php +++ b/CRM/Contribute/StateMachine/Contribution.php @@ -40,7 +40,7 @@ class CRM_Contribute_StateMachine_Contribution extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param CRM_Core_Controller $controller * @param \const|int $action diff --git a/CRM/Contribute/StateMachine/ContributionPage.php b/CRM/Contribute/StateMachine/ContributionPage.php index efff7a0d28..f61b396dd5 100644 --- a/CRM/Contribute/StateMachine/ContributionPage.php +++ b/CRM/Contribute/StateMachine/ContributionPage.php @@ -40,7 +40,7 @@ class CRM_Contribute_StateMachine_ContributionPage extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param CRM_Contribute_Controller_ContributionPage $controller * @param const|int $action diff --git a/CRM/Contribute/StateMachine/Search.php b/CRM/Contribute/StateMachine/Search.php index 1c0dc22631..6cc6a7616e 100644 --- a/CRM/Contribute/StateMachine/Search.php +++ b/CRM/Contribute/StateMachine/Search.php @@ -42,7 +42,7 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -94,7 +94,7 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Core/BAO/ActionLog.php b/CRM/Core/BAO/ActionLog.php index ab9888f89d..7cfcd6cb38 100644 --- a/CRM/Core/BAO/ActionLog.php +++ b/CRM/Core/BAO/ActionLog.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_ActionLog extends CRM_Core_DAO_ActionLog { /** - * Create or update an action log entry + * Create or update an action log entry. * * @param array $params * diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index fff01f6c8f..3786a5409f 100755 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -69,7 +69,7 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { } /** - * Get all fields of the type Date + * Get all fields of the type Date. */ public static function getDateFields() { $allFields = CRM_Core_BAO_CustomField::getFields(''); @@ -313,7 +313,7 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { } /** - * Retrieve list of Scheduled Reminders + * Retrieve list of Scheduled Reminders. * * @param bool $namesOnly * Return simple list of names. @@ -586,7 +586,7 @@ AND cas.entity_value = $id AND } /** - * 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. @@ -603,9 +603,9 @@ AND cas.entity_value = $id AND } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. It also stores all the retrieved - * values in the default array + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -634,7 +634,7 @@ AND cas.entity_value = $id AND } /** - * Delete a Reminder + * Delete a Reminder. * * @param int $id * ID of the Reminder to be deleted. @@ -653,7 +653,7 @@ AND cas.entity_value = $id AND } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 11a4c88c10..e5842af152 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { /** - * Takes an associative array and creates a address + * Takes an associative array and creates a address. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -133,7 +133,7 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { } /** - * Takes an associative array and adds address + * Takes an associative array and adds address. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -197,7 +197,7 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { } /** - * Format the address params to have reasonable values + * Format the address params to have reasonable values. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -399,7 +399,7 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -667,7 +667,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * Get address sequence + * Get address sequence. * * @return array * Array of address sequence. @@ -911,7 +911,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * Check if current address is used by any other contacts + * Check if current address is used by any other contacts. * * @param int $addressId * Address id. @@ -925,7 +925,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * 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. @@ -996,7 +996,7 @@ SELECT is_primary, } /** - * Update the shared addresses if master address is modified + * Update the shared addresses if master address is modified. * * @param int $addressId * Address id. @@ -1025,7 +1025,7 @@ SELECT is_primary, } /** - * Merge contacts with the Same address to get one shared label + * Merge contacts with the Same address to get one shared label. * @param array $rows * Array[contact_id][contactDetails]. */ @@ -1098,7 +1098,7 @@ SELECT is_primary, } /** - * Create relationship between contacts who share an address + * Create relationship between contacts who share an address. * * Note that currently we create relationship only for Individual contacts * Individual + Household and Individual + Orgnization @@ -1172,7 +1172,7 @@ SELECT is_primary, } /** - * Check and set the status for shared address delete + * Check and set the status for shared address delete. * * @param int $addressId * Address id. @@ -1234,7 +1234,7 @@ SELECT is_primary, } /** - * Call common delete function + * Call common delete function. */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Address', $id); diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 716394ec4b..fcf9f3324b 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -38,7 +38,7 @@ class CRM_Core_BAO_Block { /** - * Fields that are required for a valid block + * Fields that are required for a valid block. */ static $requiredBlockFields = array( 'email' => array('email'), @@ -126,7 +126,7 @@ class CRM_Core_BAO_Block { } /** - * Check if the current block object has any valid data + * Check if the current block object has any valid data. * * @param array $blockFields * Array of fields that are of interest for this object. @@ -146,7 +146,7 @@ class CRM_Core_BAO_Block { } /** - * Check if the current block exits + * Check if the current block exits. * * @param string $blockName * Bloack name. @@ -166,7 +166,7 @@ class CRM_Core_BAO_Block { } /** - * Get all block ids for a contact + * Get all block ids for a contact. * * @param string $blockName * Block name. @@ -210,7 +210,7 @@ class CRM_Core_BAO_Block { } /** - * Takes an associative array and creates a block + * Takes an associative array and creates a block. * * @param string $blockName * Block name. @@ -392,7 +392,7 @@ class CRM_Core_BAO_Block { } /** - * Delete block + * Delete block. * * @param string $blockName * Block name. @@ -505,7 +505,7 @@ class CRM_Core_BAO_Block { } /** - * Sort location array so primary element is first + * Sort location array so primary element is first. * * @param array $locations */ diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index 9e3c124909..47df55188a 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 { /** - * Synchronizing cms users with CiviCRM contacts + * Synchronizing cms users with CiviCRM contacts. * * @param bool $is_interactive * Whether to show statuses & perform redirects. @@ -222,7 +222,7 @@ class CRM_Core_BAO_CMSUser { } /** - * Create CMS user using Profile + * Create CMS user using Profile. * * @param array $params * @param string $mail @@ -251,7 +251,7 @@ class CRM_Core_BAO_CMSUser { } /** - * Create Form for CMS user using Profile + * Create Form for CMS user using Profile. * * @param CRM_Core_Form $form * @param int $gid diff --git a/CRM/Core/BAO/Cache.php b/CRM/Core/BAO/Cache.php index 1d4c293dae..031c8c2d09 100644 --- a/CRM/Core/BAO/Cache.php +++ b/CRM/Core/BAO/Cache.php @@ -52,7 +52,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { static $_cache = NULL; /** - * Retrieve an item from the DB cache + * Retrieve an item from the DB cache. * * @param string $group * (required) The group name of the item. @@ -93,7 +93,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { } /** - * Retrieve all items in a group + * Retrieve all items in a group. * * @param string $group * (required) The group name of the item. @@ -134,7 +134,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { } /** - * Store an item in the DB cache + * Store an item in the DB cache. * * @param object $data * (required) A reference to the data that will be serialized and stored. diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index f6b4d74638..39979f8587 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -58,7 +58,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Add civicrm settings + * Add civicrm settings. * * @param array $params * Associated array of civicrm variables. @@ -139,7 +139,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Fix civicrm setting variables + * Fix civicrm setting variables. * * @param array $params * Associated array of civicrm variables. @@ -171,7 +171,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Format the array containing before inserting in db + * Format the array containing before inserting in db. * * @param array $params * Associated array of civicrm variables(submitted). @@ -197,7 +197,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Retrieve the settings values from db + * Retrieve the settings values from db. * * @param $defaults * @@ -478,7 +478,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Return likely default settings + * Return likely default settings. * @return array * site settings * - $url @@ -649,7 +649,7 @@ WHERE option_group_id = ( } /** - * Takes a componentName and enables it in the config + * Takes a componentName and enables it in the config. * Primarily used during unit testing * * @param string $componentName diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 259de43c7f..bf96c1cb1a 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -61,7 +61,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { public static $_importFields = NULL; /** - * Build and retrieve the list of data types and descriptions + * Build and retrieve the list of data types and descriptions. * * @return array * Data type => Description @@ -118,7 +118,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Takes an associative array and creates a custom field object + * Takes an associative array and creates a custom field object. * * This function is invoked from within the web form layer and also from the api layer * @@ -313,7 +313,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -327,7 +327,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -666,7 +666,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Get the field id from an import key + * Get the field id from an import key. * * @param string $key * The key to parse. @@ -692,7 +692,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Use the cache to get all values of a specific custom field + * Use the cache to get all values of a specific custom field. * * @param int $fieldID * The custom field ID. @@ -726,7 +726,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * This function for building custom fields + * This function for building custom fields. * * @param CRM_Core_Form $qf * Form object (reference). @@ -1339,7 +1339,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Set default values for custom data used in profile + * Set default values for custom data used in profile. * * @param int $customFieldId * Custom field id. @@ -1546,7 +1546,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Format custom fields before inserting + * Format custom fields before inserting. * * @param int $customFieldId * Custom field id. @@ -1908,7 +1908,7 @@ SELECT $columnName } /** - * Determine whether it would be safe to move a field + * Determine whether it would be safe to move a field. * * @param int $fieldID * FK to civicrm_custom_field. @@ -2041,7 +2041,7 @@ WHERE id IN ( %1, %2 ) } /** - * Get the database table name and column name for a custom field + * Get the database table name and column name for a custom field. * * @param int $fieldID * The fieldID of the custom field. @@ -2076,7 +2076,7 @@ AND cf.id = %1"; } /** - * Get custom option groups + * Get custom option groups. * * @param array $includeFieldIds * Ids of custom fields for which. @@ -2123,7 +2123,7 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) } /** - * Fix orphan groups + * Fix orphan groups. * * @param int $customFieldId * Custom field id. diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 98aa0b6321..3628f67a1d 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -40,14 +40,14 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes an associative array and creates a custom group object + * Takes an associative array and creates a custom group object. * * This function is invoked from within the web form layer and also from the api layer * @@ -222,7 +222,7 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -236,7 +236,7 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -1532,7 +1532,7 @@ ORDER BY civicrm_custom_group.weight, } /** - * Generic function to build all the form elements for a specific group tree + * Generic function to build all the form elements for a specific group tree. * * @param CRM_Core_Form $form * The form object. @@ -1859,7 +1859,7 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, } /** - * Build custom data view + * Build custom data view. * * @param CRM_Core_Form $form * Page object. diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index e872746c84..7b01478cdb 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_CustomOption { /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -60,7 +60,7 @@ class CRM_Core_BAO_CustomOption { } /** - * Returns all active options ordered by weight for a given field + * Returns all active options ordered by weight for a given field. * * @param int $fieldID * Field whose options are needed. @@ -168,7 +168,7 @@ WHERE id = %1 } /** - * Delete Option + * Delete Option. * * @param $optionId integer * option id diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index 8f45597b9d..7e737e3223 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { /** - * Validate a value against a CustomField type + * Validate a value against a CustomField type. * * @param string $type * The type of the data. @@ -192,7 +192,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { } /** - * Delete option value give an option value and custom group id + * Delete option value give an option value and custom group id. * * @param int $customValueID * Custom value ID. diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index ee7ae8652e..c060d147e3 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -251,7 +251,7 @@ class CRM_Core_BAO_CustomValueTable { } /** - * Given a field return the mysql data type associated with it + * Given a field return the mysql data type associated with it. * * @param string $type * @param int $maxLength @@ -326,7 +326,7 @@ class CRM_Core_BAO_CustomValueTable { 'file_id' => $customValue['file_id'], ); - // fix Date type to be timestamp, since that is how we store in db + // Fix Date type to be timestamp, since that is how we store in db. if ($cvParam['type'] == 'Date') { $cvParam['type'] = 'Timestamp'; } @@ -351,6 +351,8 @@ class CRM_Core_BAO_CustomValueTable { } /** + * Post process function. + * * @param array $params * @param $customFields * @param $entityTable @@ -415,7 +417,7 @@ class CRM_Core_BAO_CustomValueTable { } $cond = implode(' AND ', $cond); - // first find all the fields that extend this type of entity + // First find all the fields that extend this type of entity. $query = " SELECT cg.table_name, cg.id as groupID, @@ -455,7 +457,8 @@ AND $cond if ($isMultiple[$tableName]) { if ($formatMultiRecordField) { $result["{$dao->id}"]["{$fieldID}"] = $dao->$fieldName; - } else { + } + else { $result["{$fieldID}_{$dao->id}"] = $dao->$fieldName; } } diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index c17a297d58..1e939fe640 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 { /** - * Add Dashboard + * Add Dashboard. * * @param array $params * Values. @@ -55,7 +55,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Get the list of dashlets enabled by admin + * Get the list of dashlets enabled by admin. * * @param bool $all * All or only active. @@ -147,7 +147,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Setup default dashlets for new users + * Setup default dashlets for new users. * * When a user accesses their dashboard for the first time, set up * the default dashlets. @@ -192,7 +192,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** - * Check dashlet permission for current user + * Check dashlet permission for current user. * * @param string $permission * Comma separated list. @@ -271,7 +271,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Get details of each dashlets + * Get details of each dashlets. * * @param int $dashletID * Widget ID. @@ -340,7 +340,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Save changes made by use to the Dashlet + * Save changes made by use to the Dashlet. * * @param array $columns * @@ -407,7 +407,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Add dashlets + * Add dashlets. * * @param array $params * @@ -475,7 +475,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Update contact dashboard with new dashlet + * Update contact dashboard with new dashlet. * * @param object : $dashlet * @@ -542,7 +542,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Reset dashlet cache + * Reset dashlet cache. * * @param int $contactID * Reset cache only for specific contact. @@ -561,7 +561,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Delete Dashlet + * Delete Dashlet. * * @param int $dashletID * diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index 325dabb7f1..15c6aa3f9c 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -35,14 +35,14 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Delete the discount + * Delete the discount. * * @param int $entityId * @param string $entityTable @@ -104,7 +104,7 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { } /** - * Determine in which discount set the registration date falls + * Determine in which discount set the registration date falls. * * @param int $entityID * Entity id to be searched. diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 9bb96de5db..9cdb9a0ba0 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** - * Cache for the current domain object + * Cache for the current domain object. */ static $_domain = NULL; @@ -49,7 +49,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { private $_location = NULL; /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -63,7 +63,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * Get the domain BAO + * Get the domain BAO. * * @param null $reset * @@ -129,7 +129,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * Get the location values of a domain + * Get the location values of a domain. * * @return array * Location::getValues @@ -150,7 +150,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * Save the values of a domain + * Save the values of a domain. * * @param array $params * @param int $id @@ -167,7 +167,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * Create a new domain + * Create a new domain. * * @param array $params * diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index fcd3f82671..fd546b9f12 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -59,7 +59,7 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { } /** - * Takes an associative array and adds email + * Takes an associative array and adds email. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -326,7 +326,7 @@ AND reset_date IS NULL } /** - * Call common delete function + * Call common delete function. */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Email', $id); diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index f4a8c16928..2064277944 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -64,7 +64,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Takes an associative array and creates a entityTag object + * Takes an associative array and creates a entityTag object. * * the function extract all the params it needs to initialize the create a * group object. the params array could contain additional unused name/value @@ -98,7 +98,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * An assoc array of name/value pairs. @@ -110,7 +110,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Delete the tag for a contact + * Delete the tag for a contact. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -216,7 +216,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Takes an associative array and creates tag entity record for all tag entities + * Takes an associative array and creates tag entity record for all tag entities. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -260,7 +260,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * This function returns all entities assigned to a specific tag + * This function returns all entities assigned to a specific tag. * * @param object $tag * An object of a tag. @@ -280,7 +280,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Get contact tags + * Get contact tags. */ public static function getContactTags($contactID, $count = FALSE) { $contactTags = array(); @@ -313,7 +313,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Get child contact tags given parentId + * Get child contact tags given parentId. */ public 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 f8296f4c6f..936efbea8f 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -61,7 +61,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { } /** - * Delete an extension + * Delete an extension. * * @param int $id * Id of the extension to be deleted. @@ -76,7 +76,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { } /** - * Change the schema version of an extension + * Change the schema version of an extension. * * @param string $fullName * the fully-qualified name (eg "com.example.myextension"). @@ -93,7 +93,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { } /** - * Determine the schema version of an extension + * Determine the schema version of an extension. * * @param string $fullName * the fully-qualified name (eg "com.example.myextension"). diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 0d98f34580..6556e4220c 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -34,7 +34,7 @@ */ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { /** - * Class constructor + * Class constructor. * * @return \CRM_Financial_DAO_FinancialTrxn */ @@ -45,7 +45,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { } /** - * Takes an associative array and creates a financial transaction object + * Takes an associative array and creates a financial transaction object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -117,7 +117,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -289,7 +289,7 @@ WHERE lt.entity_id = %1 "; } /** - * Delete financial transaction + * Delete financial transaction. * * @param int $entity_id * @return bool @@ -309,7 +309,7 @@ WHERE ceft.entity_id = %1"; } /** - * Create financial transaction for premium + * Create financial transaction for premium. * */ public static function createPremiumTrxn($params) { @@ -355,7 +355,7 @@ WHERE ceft.entity_id = %1"; } /** - * Create financial trxn and items when fee is charged + * Create financial trxn and items when fee is charged. * * @param array $params * To create trxn entries. @@ -411,7 +411,7 @@ WHERE ceft.entity_id = %1"; } /** - * get partial payment amount and type of it + * get partial payment amount and type of it. * * @param int $entityId * @param string $entityName diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index a66907ad6a..2f3830d419 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { /** - * Takes an associative array and adds im + * Takes an associative array and adds im. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -164,7 +164,7 @@ ORDER BY cim.is_primary DESC, im_id ASC "; } /** - * Call common delete function + * Call common delete function. */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('IM', $id); diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index af1b843c43..db5e6d7278 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -60,9 +60,9 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. It also stores all the retrieved - * values in the default array + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -83,7 +83,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -99,7 +99,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Function to delete scheduled job + * Function to delete scheduled job. * * @param $jobID * ID of the job to be deleted. @@ -123,7 +123,7 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Trim job table on a regular basis to keep it at a good size + * Trim job table on a regular basis to keep it at a good size. * * CRM-10513 */ diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index d50fc673aa..b5786cf439 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** - * Static holder for the Label Formats Option Group ID + * Static holder for the Label Formats Option Group ID. */ private static $_gid = NULL; @@ -240,7 +240,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Option Group ID for Label Formats + * Get Option Group ID for Label Formats. * * @param string $name * @@ -258,7 +258,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Add ordering fields to Label Format list + * Add ordering fields to Label Format list. * * @param array (reference) $list List of Label Formats * @param string $returnURL @@ -306,7 +306,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Retrieve the default Label Format values + * Retrieve the default Label Format values. * * @param string $groupName * Label format group name. @@ -328,7 +328,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Label Format from the DB + * Get Label Format from the DB. * * @param string $field * Field name to search by. @@ -352,7 +352,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Label Format by Name + * Get Label Format by Name. * * @param int $name * Label format name. Empty = get default label format. @@ -365,7 +365,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Label Format by ID + * Get Label Format by ID. * * @param int $id * Label format id. 0 = get default label format. @@ -380,7 +380,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Label Format field from associative array + * Get Label Format field from associative array. * * @param string $field * Name of a label format field. @@ -411,9 +411,9 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * label id. It also stores all the retrieved values in the default array. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -451,7 +451,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Return the name of the group for customized labels + * Return the name of the group for customized labels. * * @return void */ @@ -460,7 +460,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Save the Label Format in the DB + * Save the Label Format in the DB. * * @param array (reference) $values associative array of name/value pairs * @param int $id @@ -530,7 +530,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { } /** - * Delete a Label Format + * Delete a Label Format. * * @param int $id * ID of the label format to be deleted. diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 5fa6dade98..3f4d321191 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -39,12 +39,12 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { /** - * Location block element array + * Location block element array. */ static $blocks = array('phone', 'email', 'im', 'openid', 'address'); /** - * Create various elements of location block + * Create various elements of location block. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -95,7 +95,7 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { } /** - * Creates the entry in the civicrm_loc_block + * Creates the entry in the civicrm_loc_block. */ public static function createLocBlock(&$location, &$entityElements) { $locId = self::findExisting($entityElements); @@ -133,7 +133,7 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { } /** - * Takes an entity array and finds the existing location block + * Takes an entity array and finds the existing location block. */ public static function findExisting($entityElements) { $eid = $entityElements['entity_id']; @@ -152,7 +152,7 @@ WHERE e.id = %1"; } /** - * Takes an associative array and adds location block + * Takes an associative array and adds location block. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -169,7 +169,7 @@ WHERE e.id = %1"; } /** - * Delete the Location Block + * Delete the Location Block. * * @param int $locBlockId * Id of the Location Block. @@ -211,7 +211,7 @@ WHERE e.id = %1"; } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -263,7 +263,7 @@ WHERE e.id = %1"; } /** - * Delete all the block associated with the location + * Delete all the block associated with the location. * * @param int $contactId * Contact id. diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 9d48804e3d..744fd36d6b 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -35,20 +35,20 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultLocationType = NULL; static $_billingLocationType = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -69,7 +69,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -85,7 +85,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Retrieve the default location_type + * Retrieve the default location_type. * * @return object * The default location type object on success, @@ -101,7 +101,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Get ID of billing location type + * Get ID of billing location type. * * @return int */ @@ -114,7 +114,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * Add a Location Type + * Add a Location Type. * * @param array $params * Reference array contains the values submitted by the form. @@ -141,7 +141,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * 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 cc15a2190c..a97eb54732 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -67,7 +67,7 @@ class CRM_Core_BAO_Log extends CRM_Core_DAO_Log { } /** - * Add log to civicrm_log table + * Add log to civicrm_log table. * * @param array $params * Array of name-value pairs of log table. @@ -152,7 +152,7 @@ UPDATE civicrm_log } /** - * Get log record count for a Contact + * Get log record count for a Contact. * * @param int $contactID * @@ -166,7 +166,7 @@ UPDATE civicrm_log } /** - * Function for find out whether to use logging schema entries for contact + * Function for find out whether to use logging schema entries for contact. * summary, instead of normal log entries. * * @return int diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index b8ed404c0b..2187dcbbca 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -64,7 +64,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Return the domain from the default set of settings + * Return the domain from the default set of settings. * * @return string * default domain @@ -74,7 +74,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Return the localpart from the default set of settings + * Return the localpart from the default set of settings. * * @return string * default localpart @@ -84,7 +84,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Return the return path from the default set of settings + * Return the return path from the default set of settings. * * @return string * default return path @@ -108,10 +108,9 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * mail settings id. It also stores all the retrieved - * values in the default array + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -168,7 +167,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Takes an associative array and creates a mail settings object + * Takes an associative array and creates a mail settings object. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index c77d80d8c3..7857c4bfd5 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -35,14 +35,14 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -63,7 +63,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Delete the mapping + * Delete the mapping. * * @param int $id * Mapping id. @@ -89,7 +89,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Takes an associative array and creates a contact object + * Takes an associative array and creates a contact object. * * The function extract all the params it needs to initialize the create a * contact object. the params array could contain additional unused name/value @@ -110,7 +110,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Get the list of mappings + * Get the list of mappings. * * @param string $mappingTypeId * Mapping type id. @@ -132,7 +132,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Get the mapping fields + * Get the mapping fields. * * @param int $mappingId * Mapping id. @@ -197,7 +197,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Check Duplicate Mapping Name + * Check Duplicate Mapping Name. * * @param string $nameField * mapping Name. @@ -245,7 +245,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Build the mapping form + * Build the mapping form. * * @param CRM_Core_Form $form * @param string $mappingType @@ -952,7 +952,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** - * Function returns all Custom group Names + * Function returns all Custom group Names. * * @param int $customfieldId * Related file id. diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 088886d7ee..037d1e51b8 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -41,7 +41,7 @@ require_once 'Mail/mime.php'; class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -61,7 +61,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -76,7 +76,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * Add the Message Templates + * Add the Message Templates. * * @param array $params * Reference array contains the values submitted by the form. @@ -97,7 +97,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * Delete the Message Templates + * Delete the Message Templates. * * @param int $messageTemplatesID * @return void @@ -123,7 +123,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * Get the Message Templates + * Get the Message Templates. * * * @param bool $all @@ -302,7 +302,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * Send an email from the specified template based on an array of params + * Send an email from the specified template based on an array of params. * * @param array $params * A string-keyed array of function params, see function body for details. diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 5d86859ff3..2eb3042d5c 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -38,14 +38,14 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { const CACHE_KEY_STRLEN = 8; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -123,7 +123,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -147,7 +147,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Calculate navigation weight + * Calculate navigation weight. * * @param int $parentID * Parent_id of a menu. @@ -177,7 +177,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * Get formatted menu list + * Get formatted menu list. * * @return array * returns associated array @@ -263,7 +263,7 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare } /** - * Build navigation tree + * Build navigation tree. * * @param array $navigationTree * Nested array of menus. @@ -321,7 +321,7 @@ ORDER BY parent_id, weight"; } /** - * Build menu + * Build menu. * * @param bool $json * By default output is html. @@ -387,7 +387,7 @@ ORDER BY parent_id, weight"; } /** - * Recursively check child menus + * Recursively check child menus. * * @param array $value * @param string $navigationString @@ -464,7 +464,7 @@ ORDER BY parent_id, weight"; } /** - * Get Menu name + * Get Menu name. * * @param $value * @param array $skipMenuItems @@ -578,7 +578,7 @@ ORDER BY parent_id, weight"; } /** - * Create navigation for CiviCRM Admin Menu + * Create navigation for CiviCRM Admin Menu. * * @param int $contactID * Contact id. @@ -643,7 +643,7 @@ ORDER BY parent_id, weight"; } /** - * Reset navigation for all contacts or a specified contact + * Reset navigation for all contacts or a specified contact. * * @param int $contactID * Reset only entries belonging to that contact ID. @@ -680,7 +680,7 @@ ORDER BY parent_id, weight"; } /** - * Process navigation + * Process navigation. * * @param array $params * Associated array, $_GET. @@ -714,7 +714,7 @@ ORDER BY parent_id, weight"; } /** - * Process move action + * Process move action. * * @param $nodeID * Node that is being moved. @@ -779,7 +779,7 @@ ORDER BY parent_id, weight"; } /** - * Function to process rename action for tree + * Function to process rename action for tree. * * @param int $nodeID * @param $label @@ -789,7 +789,7 @@ ORDER BY parent_id, weight"; } /** - * Process delete action for tree + * Process delete action for tree. * * @param int $nodeID */ @@ -799,7 +799,7 @@ ORDER BY parent_id, weight"; } /** - * Get the info on navigation item + * Get the info on navigation item. * * @param int $navigationID * Navigation id. @@ -819,7 +819,7 @@ ORDER BY parent_id, weight"; } /** - * Update menu + * Update menu. * * @param array $params * @param array $newParams diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 1212c8e5cf..23d88c37f0 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -125,7 +125,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * Takes an associative array and creates a note object + * Takes an associative array and creates a note object. * * the function extract all the params it needs to initialize the create a * note object. the params array could contain additional unused name/value @@ -218,7 +218,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -281,7 +281,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * Delete the notes + * Delete the notes. * * @param int $id * Note id. @@ -332,7 +332,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * Delete all records for this contact id + * Delete all records for this contact id. * * @param int $id * ID of the contact for which note needs to be deleted. @@ -388,7 +388,7 @@ ORDER BY modified_date desc"; } /** - * Get log record count for a Contact + * Get log record count for a Contact. * * @param int $contactID * @@ -411,7 +411,7 @@ ORDER BY modified_date desc"; } /** - * 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. @@ -429,7 +429,7 @@ ORDER BY modified_date desc"; } /** - * Get total count of direct children visible to the current user + * Get total count of direct children visible to the current user. * * @param int $id * Note ID. @@ -453,7 +453,7 @@ ORDER BY modified_date desc"; } /** - * Recursive function to get all descendent notes of the note with given ID + * Recursive function to get all descendent notes of the note with given ID. * * @param int $parentId * ID of the note to start from. @@ -548,7 +548,7 @@ ORDER BY modified_date desc"; } /** - * Delete all note related to contact when contact is deleted + * Delete all note related to contact when contact is deleted. * * @param int $contactID * Contact id whose notes to be deleted. diff --git a/CRM/Core/BAO/OpenID.php b/CRM/Core/BAO/OpenID.php index e4feb45339..2b685578f0 100644 --- a/CRM/Core/BAO/OpenID.php +++ b/CRM/Core/BAO/OpenID.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { /** - * Takes an associative array and adds OpenID + * Takes an associative array and adds OpenID. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -73,7 +73,7 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { } /** - * Returns whether or not this OpenID is allowed to login + * Returns whether or not this OpenID is allowed to login. * * @param string $identity_url * The OpenID to check. @@ -142,7 +142,7 @@ ORDER BY } /** - * Call common delete function + * Call common delete function. */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id); diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index 883828e743..fa740f3320 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -35,14 +35,14 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -62,7 +62,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -77,7 +77,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Add the Option Group + * Add the Option Group. * * @param array $params * Reference array contains the values submitted by the form. @@ -109,7 +109,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * Delete Option Group + * Delete Option Group. * * @param int $optionGroupId * Id of the Option Group to be deleted. @@ -126,7 +126,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { } /** - * 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 711d4c80e3..9ca4a9b101 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -62,7 +62,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Set default Parameters + * Set default Parameters. * This functions sets default parameters if not set: * - name & label are set to each other as required (it might make more sense for one * to be required but this would mean a change to the api level) @@ -90,7 +90,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Get next available value + * Get next available value. * We will take the highest numeric value (or 0 if no numeric values exist) * and add one. The calling function is responsible for any * more complex decision making @@ -125,7 +125,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -145,7 +145,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -160,7 +160,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Add an Option Value + * Add an Option Value. * * @param array $params * Reference array contains the values submitted by the form. @@ -227,7 +227,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Delete Option Value + * Delete Option Value. * * @param int $optionValueId * @@ -245,7 +245,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Retrieve activity type label and description + * Retrieve activity type label and description. * * @param int $activityTypeId * Activity type id. diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index e39ac264c8..dfe09e799f 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** - * Static holder for the Paper Size Option Group ID + * Static holder for the Paper Size Option Group ID. */ private static $_gid = NULL; @@ -68,7 +68,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { ); /** - * Get Option Group ID for Paper Sizes + * Get Option Group ID for Paper Sizes. * * @return int * Group ID (null if Group ID doesn't exist) @@ -84,7 +84,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Add ordering fields to Paper Size list + * Add ordering fields to Paper Size list. * * @param array (reference) $list List of Paper Sizes * @param string $returnURL @@ -127,7 +127,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Retrieve the default Paper Size values + * Retrieve the default Paper Size values. * * @return array * Name/value pairs containing the default Paper Size values. @@ -146,7 +146,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Get Paper Size from the DB + * Get Paper Size from the DB. * * @param string $field * Field name to search by. @@ -168,7 +168,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Get Paper Size by Name + * Get Paper Size by Name. * * @param int $name * Paper Size name. Empty = get default Paper Size. @@ -181,7 +181,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Get Paper Size by ID + * Get Paper Size by ID. * * @param int $id * Paper Size id. 0 = get default Paper Size. @@ -194,7 +194,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Get Paper Size field from associative array + * Get Paper Size field from associative array. * * @param string $field * Name of a Paper Size field. @@ -225,9 +225,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * paper size id. It also stores all the retrieved values in the default array. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -263,7 +263,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * Save the Paper Size in the DB + * Save the Paper Size in the DB. * * @param array (reference) $values associative array of name/value pairs * @param int $id @@ -323,7 +323,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * 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 2de33a58bc..6f1fbced84 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** - * Static holder for the PDF Page Formats Option Group ID + * Static holder for the PDF Page Formats Option Group ID. */ private static $_gid = NULL; @@ -123,7 +123,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get Option Group ID for PDF Page Formats + * Get Option Group ID for PDF Page Formats. * * @return int * Group ID (null if Group ID doesn't exist) @@ -139,7 +139,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Add ordering fields to Page Format list + * Add ordering fields to Page Format list. * * @param array (reference) $list List of PDF Page Formats * @param string $returnURL @@ -183,7 +183,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get the default PDF Page Format values + * Get the default PDF Page Format values. * * @return array * Name/value pairs containing the default PDF Page Format values. @@ -205,7 +205,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get PDF Page Format from the DB + * Get PDF Page Format from the DB. * * @param string $field * Field name to search by. @@ -227,7 +227,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get PDF Page Format by Name + * Get PDF Page Format by Name. * * @param int $name * PDF Page Format name. Empty = get default PDF Page Format. @@ -240,7 +240,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get PDF Page Format by ID + * Get PDF Page Format by ID. * * @param int $id * PDF Page Format id. 0 = get default PDF Page Format. @@ -253,7 +253,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Get PDF Page Format field from associative array + * Get PDF Page Format field from associative array. * * @param string $field * Name of a PDF Page Format field. @@ -284,9 +284,9 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * format id. It also stores all the retrieved values in the default array. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -322,7 +322,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * Save the PDF Page Format in the DB + * Save the PDF Page Format in the DB. * * @param array (reference) $values associative array of name/value pairs * @param int $id @@ -378,7 +378,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { } /** - * 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 ae6e833d93..a6b165a4f3 100644 --- a/CRM/Core/BAO/Persistent.php +++ b/CRM/Core/BAO/Persistent.php @@ -59,7 +59,7 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { } /** - * Add the Persistent Record + * Add the Persistent Record. * * @param array $params * Reference array contains the values submitted by the form. diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 14cd04f52c..b4d6d4fbfa 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -63,7 +63,7 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { } /** - * Takes an associative array and adds phone + * Takes an associative array and adds phone. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -263,7 +263,7 @@ ORDER BY ph.is_primary DESC, phone_id ASC "; } /** - * Call common delete function + * Call common delete function. */ public static function del($id) { // Ensure mysql phone function exists diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index daf9d8275b..137748ef4d 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -35,19 +35,19 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultPreferencesDate = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -68,7 +68,7 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -84,7 +84,7 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { } /** - * Delete preference dates + * Delete preference dates. * * @param int $id * diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php index 9a2b23122a..f29beaca51 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -341,7 +341,7 @@ AND c.created_date < date_sub( NOW( ), INTERVAL %2 day ) } /** - * Save checkbox selections + * Save checkbox selections. * * @param $cacheKey * @param string $action @@ -395,7 +395,7 @@ WHERE cacheKey LIKE %1 AND is_selected = 1 } /** - * Get the selections + * Get the selections. * * @param string $cacheKey * Cache key. diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 95a4bdc4fd..ae2ef35b83 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -200,7 +200,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function updates the mode column in the civicrm_recurring_entity table + * This function updates the mode column in the civicrm_recurring_entity table. * * @param int $mode * Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity . @@ -222,7 +222,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function generates all new entities based on object vars + * This function generates all new entities based on object vars. * * @return array */ @@ -259,7 +259,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * Generate new DAOs and along with entries in civicrm_recurring_entity table + * Generate new DAOs and along with entries in civicrm_recurring_entity table. * * @return array */ @@ -401,7 +401,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function gets all the children for a particular parent entity + * This function gets all the children for a particular parent entity. * * @param int $parentId * Parent entity id . @@ -497,7 +497,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function gets the parent for the entity id passed to it + * This function gets the parent for the entity id passed to it. * * @param int $entityId * Entity ID . @@ -533,7 +533,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function copies the information from parent entity and creates other entities with same information + * This function copies the information from parent entity and creates other entities with same information. * * @param string $entityTable * Entity table name . @@ -834,7 +834,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function maps values posted from form to civicrm_action_schedule columns + * This function maps values posted from form to civicrm_action_schedule columns. * * @param array $formParams * And array of form values posted . @@ -937,7 +937,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * wrapper of getScheduleReminderDetailsById function + * wrapper of getScheduleReminderDetailsById function. * * @param int $scheduleReminderId * Primary key of civicrm_action_schedule table . @@ -1065,7 +1065,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** - * This function gets time difference between the two datetime object + * This function gets time difference between the two datetime object. * * @param DateTime $startDate * Start Date . @@ -1085,7 +1085,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function gets all columns from civicrm_action_schedule on the basis of event id + * This function gets all columns from civicrm_action_schedule on the basis of event id. * * @param int $entityId * Entity ID . @@ -1115,7 +1115,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * Update mode column in civicrm_recurring_entity table for event related tabs + * Update mode column in civicrm_recurring_entity table for event related tabs. * * @param int $entityId * Event id . diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 7b064345a3..86b73d0356 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** - * Various predefined settings that have been migrated to the setting table + * Various predefined settings that have been migrated to the setting table. */ const ADDRESS_STANDARDIZATION_PREFERENCES_NAME = 'Address Standardization Preferences', @@ -115,7 +115,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Allow key o be cleared + * Allow key o be cleared. * @param string $cacheKey */ public static function flushCache($cacheKey) { @@ -201,7 +201,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Retrieve the value of a setting from the DB table + * Retrieve the value of a setting from the DB table. * * @param string $group * (required) The group name of the item. @@ -324,7 +324,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Store an item in the setting table + * Store an item in the setting table. * * _setItem() is the common logic shared by setItem() and setItems(). * @@ -364,7 +364,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Store an item in a setting table + * Store an item in a setting table. * * _setItem() is the common logic shared by setItem() and setItems(). * @@ -689,7 +689,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Load the settings files defined in a series of folders + * Load the settings files defined in a series of folders. * @param array $metaDataFolders * List of folder paths. * @return array @@ -708,7 +708,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Load up settings metadata from files + * Load up settings metadata from files. */ public static function loadSettingsMetadata($metaDataFolder) { $settingMetaData = array(); diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index 730fd8d3af..5370623883 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -35,14 +35,14 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -181,7 +181,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Function to retrieve tags + * Function to retrieve tags. * * @param string $usedFor * Which type of tag entity. @@ -314,7 +314,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Delete the tag + * Delete the tag. * * @param int $id * Tag id. @@ -345,7 +345,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Takes an associative array and creates a contact object + * Takes an associative array and creates a contact object. * * The function extract all the params it needs to initialize the create a * contact object. the params array could contain additional unused name/value @@ -403,7 +403,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Check if there is data to create the object + * Check if there is data to create the object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -421,7 +421,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * Get the tag sets for a entity object + * Get the tag sets for a entity object. * * @param string $entityTable * Entity_table. diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index af17c1be5e..72e9b310c6 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -40,14 +40,14 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** - * Batch entry fields + * Batch entry fields. */ private static $_contriBatchEntryFields = NULL; private static $_memberBatchEntryFields = NULL; /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -75,7 +75,7 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -118,7 +118,7 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { } /** - * 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. @@ -191,7 +191,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Add the UF Field + * Add the UF Field. * * @param array $params * (reference) array containing the values submitted by the form. @@ -247,7 +247,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Automatically determine one weight and modify others + * Automatically determine one weight and modify others. * * @param array $params * UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id'. @@ -310,7 +310,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Delete profile field given a custom field + * Delete profile field given a custom field. * * @param int $customFieldId * ID of the custom field to be deleted. @@ -356,7 +356,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Check the status of custom field used in uf fields + * Check the status of custom field used in uf fields. * * @param int $UFFieldId * @@ -853,7 +853,7 @@ SELECT id } /** - * Get a list of fields which can be added to profiles + * Get a list of fields which can be added to profiles. * * @param int $gid : UF group ID * @param array $defaults : Form defaults @@ -1043,7 +1043,7 @@ SELECT id } /** - * Get a list of fields which can be added to profiles + * Get a list of fields which can be added to profiles. * * @param bool $force * @@ -1068,7 +1068,7 @@ SELECT id } /** - * Determine whether the given field_name is valid + * Determine whether the given field_name is valid. * * @param string $fieldName * @return bool diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 87d264cf48..0264d2f449 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -42,14 +42,14 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { LISTINGS_VISIBILITY = 4; /** - * Cache the match clause used in this transaction + * Cache the match clause used in this transaction. * * @var string */ static $_matchFields = NULL; /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -111,7 +111,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -126,7 +126,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Get all the registration fields + * Get all the registration fields. * * @param int $action * What action are we doing. @@ -182,7 +182,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Get all the listing fields + * Get all the listing fields. * * @param int $action * What action are we doing. @@ -535,7 +535,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Create a query to find all visible UFFields in a UFGroup + * Create a query to find all visible UFFields in a UFGroup. * * This is the SQL-variant of checkUFFieldDisplayable(). * @@ -583,7 +583,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Create a query to find all visible UFFields in a UFGroup + * Create a query to find all visible UFFields in a UFGroup. * * This is the PHP in-memory variant of createUFFieldQuery(). * @@ -700,7 +700,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Check the data validity + * Check the data validity. * * @param int $userID * The user id that we are actually editing. @@ -744,7 +744,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Get the html for the form that represents this particular group + * Get the html for the form that represents this particular group. * * @param int $userID * The user id that we are actually editing. @@ -902,7 +902,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Searches for a contact in the db with similar attributes + * Searches for a contact in the db with similar attributes. * * @param array $params * The list of values to be used in the where clause. @@ -1426,7 +1426,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * Add the UF Group + * Add the UF Group. * * @param array $params * Reference array contains the values submitted by the form. @@ -1477,7 +1477,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { } /** - * 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. @@ -1548,7 +1548,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Get the UF Join records for an ufgroup id + * Get the UF Join records for an ufgroup id. * * @param int $ufGroupId * Uf group id. @@ -1597,7 +1597,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function takes an associative array and creates a ufjoin record for ufgroup + * Function takes an associative array and creates a ufjoin record for ufgroup. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -1612,7 +1612,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Delete the uf join record for an uf group + * Delete the uf join record for an uf group. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -1626,7 +1626,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Get the weight for ufjoin record + * Get the weight for ufjoin record. * * @param int $ufGroupId * If $ufGroupId get update weight or add weight. @@ -1656,7 +1656,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Get the uf group for a module + * Get the uf group for a module. * * @param string $moduleName * Module name. @@ -1729,7 +1729,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Filter ufgroups based on logged in user contact type + * Filter ufgroups based on logged in user contact type. * * @param int $ufGroupId * Uf group id (profile id). @@ -1771,7 +1771,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Add profile field to a form + * Add profile field to a form. * * @param CRM_Core_Form $form * @param array $field @@ -2311,7 +2311,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Set profile defaults + * Set profile defaults. * * @param int $contactId * Contact id. @@ -2852,7 +2852,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Assign uf fields to template + * Assign uf fields to template. * * @param int $gid * Group id. @@ -2870,7 +2870,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Format fields for dupe Contact Matching + * Format fields for dupe Contact Matching. * * @param array $params * @@ -3162,7 +3162,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Create a "group_type" string + * Create a "group_type" string. * * @param array $coreTypes * E.g. array('Individual','Contact','Student'). @@ -3391,7 +3391,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Retrieve groups of profiles + * Retrieve groups of profiles. * * @param int $profileID * Id of the profile. @@ -3487,7 +3487,7 @@ SELECT group_id } /** - * Check if we are rendering mixed profiles + * Check if we are rendering mixed profiles. * * @param array $profileIds * Associated array of profile ids. @@ -3540,7 +3540,7 @@ SELECT group_id } /** - * Determine of we show overlay profile or not + * Determine of we show overlay profile or not. * * @return bool * true if profile should be shown else false @@ -3564,7 +3564,7 @@ SELECT group_id } /** - * Get group type values of the profile + * Get group type values of the profile. * * @param int $profileId * @param string $groupType @@ -3640,7 +3640,7 @@ SELECT group_id } /** - * Get profiles used for batch entry + * Get profiles used for batch entry. * * @return array * profileIds profile ids @@ -3685,7 +3685,7 @@ SELECT group_id } /** - * This is function is used to format pseudo fields + * This is function is used to format pseudo fields. * * @param array $fields * Associated array of profile fields. diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index f118b578ad..42573dfda3 100644 --- a/CRM/Core/BAO/UFJoin.php +++ b/CRM/Core/BAO/UFJoin.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { /** - * Takes an associative array and creates a uf join object + * Takes an associative array and creates a uf join object. * * @param array $params * (reference) an assoc array of name/value pairs. diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index bda036d8ef..d0fb614a30 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -356,7 +356,7 @@ AND domain_id = %4 } /** - * Update the uf_name in the user object + * Update the uf_name in the user object. * * @param int $contactId * Id of the contact to update. @@ -409,7 +409,7 @@ AND domain_id = %4 } /** - * Update the email value for the contact and user profile + * Update the email value for the contact and user profile. * * @param int $contactId * Contact ID of the user. @@ -465,7 +465,7 @@ AND domain_id = %4 } /** - * Delete the object records that are associated with this cms user + * Delete the object records that are associated with this cms user. * * @param int $ufID * Id of the user to delete. @@ -481,7 +481,7 @@ AND domain_id = %4 } /** - * Get the contact_id given a uf_id + * Get the contact_id given a uf_id. * * @param int $ufID * Id of UF for which related contact_id is required. @@ -505,7 +505,7 @@ AND domain_id = %4 } /** - * Get the uf_id given a contact_id + * Get the uf_id given a contact_id. * * @param int $contactID * ID of the contact for which related uf_id is required. @@ -537,7 +537,7 @@ AND domain_id = %4 } /** - * Get the list of contact_id + * Get the list of contact_id. * * * @return int diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index bf62448f66..090969c68a 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { /** - * Takes an associative array and adds im + * Takes an associative array and adds im. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -60,7 +60,7 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { } /** - * Process website + * Process website. * * @param array $params * @param int $contactID @@ -110,7 +110,7 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { } /** - * Delete website + * Delete website. * * @param array $ids * Website ids. @@ -152,7 +152,7 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { } /** - * Get all the websites for a specified contact_id + * Get all the websites for a specified contact_id. * * @param int $id * The contact id. diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index 06c5759018..be786d80f2 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -47,8 +47,9 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Function that must have never worked & should be removed. * - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Core/Base.php b/CRM/Core/Base.php index f351cb1fa7..de1a5c133c 100644 --- a/CRM/Core/Base.php +++ b/CRM/Core/Base.php @@ -44,7 +44,7 @@ require_once 'CRM/Core/I18n.php'; class CRM_Core_Base { /** - * Constructor + * Constructor. */ public function __construct() { } diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index 8200fc7c35..569f055212 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -41,7 +41,7 @@ class CRM_Core_Block { /** - * The following blocks are supported + * The following blocks are supported. * * @var int */ @@ -55,12 +55,12 @@ class CRM_Core_Block { FULLTEXT_SEARCH = 7; /** - * Template file names for the above blocks + * Template file names for the above blocks. */ static $_properties = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { } @@ -230,7 +230,7 @@ class CRM_Core_Block { } /** - * Creates the info block for drupal + * Creates the info block for drupal. * * @return array */ @@ -346,7 +346,7 @@ class CRM_Core_Block { } /** - * Create the list of options to create New objects for the application and format is as a block + * Create the list of options to create New objects for the application and format is as a block. * * @return void */ @@ -469,7 +469,7 @@ class CRM_Core_Block { } /** - * Create the list of dashboard links + * Create the list of dashboard links. * * @return void */ @@ -506,7 +506,7 @@ class CRM_Core_Block { } /** - * Create the list of mail urls for the application and format is as a block + * Create the list of mail urls for the application and format is as a block. * * @return void */ @@ -539,7 +539,7 @@ class CRM_Core_Block { } /** - * Create the list of shortcuts for the application and format is as a block + * Create the list of shortcuts for the application and format is as a block. * * @return void */ @@ -554,7 +554,7 @@ class CRM_Core_Block { } /** - * Create the event blocks for upcoming events + * Create the event blocks for upcoming events. * * @return void */ diff --git a/CRM/Core/CodeGen/Main.php b/CRM/Core/CodeGen/Main.php index 79f92c5259..6a5ff43872 100644 --- a/CRM/Core/CodeGen/Main.php +++ b/CRM/Core/CodeGen/Main.php @@ -62,7 +62,7 @@ class CRM_Core_CodeGen_Main { } /** - * Automatically generate a variety of files + * Automatically generate a variety of files. */ public function main() { if (!empty($this->digestPath) && file_exists($this->digestPath) && $this->hasExpectedFiles()) { diff --git a/CRM/Core/CodeGen/Specification.php b/CRM/Core/CodeGen/Specification.php index 65be47db88..a9063cb5fc 100644 --- a/CRM/Core/CodeGen/Specification.php +++ b/CRM/Core/CodeGen/Specification.php @@ -639,7 +639,7 @@ class CRM_Core_CodeGen_Specification { } /** - * Sets the size property of a textfield + * Sets the size property of a textfield. * See constants defined in CRM_Utils_Type for possible values */ protected function getSize($fieldXML) { diff --git a/CRM/Core/CodeGen/Util/File.php b/CRM/Core/CodeGen/Util/File.php index 278454bdb1..98680958b8 100644 --- a/CRM/Core/CodeGen/Util/File.php +++ b/CRM/Core/CodeGen/Util/File.php @@ -45,7 +45,7 @@ class CRM_Core_CodeGen_Util_File { } /** - * Calculate a cumulative digest based on a collection of files + * Calculate a cumulative digest based on a collection of files. * * @param array $files * List of file names (strings). @@ -62,7 +62,7 @@ class CRM_Core_CodeGen_Util_File { } /** - * Find the path to the main Civi source tree + * Find the path to the main Civi source tree. * * @return string * @throws RuntimeException @@ -77,7 +77,7 @@ class CRM_Core_CodeGen_Util_File { } /** - * Find files in several directories using several filename patterns + * Find files in several directories using several filename patterns. * * @param array $pairs * Each item is an array(0 => $searchBaseDir, 1 => $filePattern). diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 0059dc4e6c..68fec01b96 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -91,7 +91,7 @@ abstract class CRM_Core_Component_Info { public $info; /** - * Stores component keyword + * Stores component keyword. * @var string name of component keyword */ protected $keyword; @@ -133,7 +133,7 @@ abstract class CRM_Core_Component_Info { abstract public function getInfo(); /** - * Get a list of entities to register via API + * Get a list of entities to register via API. * * @return array * list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities) @@ -144,7 +144,7 @@ abstract class CRM_Core_Component_Info { } /** - * Provides permissions that are unwise for Anonymous Roles to have + * Provides permissions that are unwise for Anonymous Roles to have. * * @return array * list of permissions @@ -170,7 +170,7 @@ abstract class CRM_Core_Component_Info { abstract public function getPermissions($getAllUnconditionally = FALSE); /** - * Determine how many other records refer to a given record + * Determine how many other records refer to a given record. * * @param CRM_Core_DAO $dao * The item for which we want a reference count. @@ -330,7 +330,7 @@ abstract class CRM_Core_Component_Info { } /** - * Provides the xml menu files + * Provides the xml menu files. * * @return array * array of menu files diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php index c593c4f8cd..a5123237dd 100644 --- a/CRM/Core/Config/Defaults.php +++ b/CRM/Core/Config/Defaults.php @@ -75,7 +75,7 @@ class CRM_Core_Config_Defaults { } /** - * Format size + * Format size. * */ public static function formatUnitSize($size, $checkForPostMax = FALSE) { @@ -109,7 +109,7 @@ class CRM_Core_Config_Defaults { } /** - * Set the default values + * Set the default values. * in an empty db, also called when setting component using GUI * * @param array $defaults diff --git a/CRM/Core/Config/Variables.php b/CRM/Core/Config/Variables.php index 9e50bf0c69..8ea70b053e 100644 --- a/CRM/Core/Config/Variables.php +++ b/CRM/Core/Config/Variables.php @@ -38,21 +38,21 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { /** - * The debug level for civicrm + * The debug level for civicrm. * @var int */ public $debug = 0; public $backtrace = 0; /** - * The directory where Smarty and plugins are installed + * The directory where Smarty and plugins are installed. * @var string */ public $smartyDir = NULL; public $pluginsDir = NULL; /** - * The root directory of our template tree + * The root directory of our template tree. * @var string */ public $templateDir = NULL; @@ -474,7 +474,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { public $wpBasePage = NULL; /** - * Provide addressSequence + * Provide addressSequence. * * @param * @@ -489,7 +489,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { } /** - * Provide cached default currency symbol + * Provide cached default currency symbol. * * @param * @@ -514,7 +514,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { } /** - * Provide cached default currency symbol + * Provide cached default currency symbol. * * @param * @@ -535,7 +535,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { } /** - * Provide cached default country name + * Provide cached default country name. * * @param * @@ -551,7 +551,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { } /** - * Provide cached country limit translated to names + * Provide cached country limit translated to names. * * @param * @@ -581,7 +581,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { } /** - * Provide cached province limit translated to names + * Provide cached province limit translated to names. * * @param * diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 54f85cc25f..d4edfff9b3 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -70,7 +70,7 @@ class CRM_Core_DAO extends DB_DataObject { */ static $_testEntitiesToSkip = array(); /** - * The factory class for this application + * The factory class for this application. * @var object */ static $_factory = NULL; @@ -78,7 +78,7 @@ class CRM_Core_DAO extends DB_DataObject { static $_checkedSqlFunctionsExist = FALSE; /** - * Class constructor + * Class constructor. * * @return \CRM_Core_DAO */ @@ -88,14 +88,14 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Empty definition for virtual function + * Empty definition for virtual function. */ public static function getTableName() { return NULL; } /** - * Initialize the DAO object + * Initialize the DAO object. * * @param string $dsn * The database connection string. @@ -393,7 +393,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Returns list of FK relationships + * Returns list of FK relationships. * * * @return array @@ -404,7 +404,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Returns all the column names of this table + * Returns all the column names of this table. * * * @return array @@ -460,7 +460,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Deletes items from table which match current objects variables + * Deletes items from table which match current objects variables. * * Returns the true on success * @@ -682,7 +682,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Check if there is a record with the same name in the db + * Check if there is a record with the same name in the db. * * @param string $value * The value of the field we are checking. @@ -712,7 +712,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Check if there is a given column in a specific table + * Check if there is a given column in a specific table. * * @param string $tableName * @param string $columnName @@ -890,7 +890,7 @@ LIKE %1 } /** - * Check whether a specific column in a specific table has always the same value + * Check whether a specific column in a specific table has always the same value. * * @param string $tableName * @param string $columnName @@ -908,7 +908,7 @@ LIKE %1 } /** - * Check whether a specific column in a specific table is always NULL + * Check whether a specific column in a specific table is always NULL. * * @param string $tableName * @param string $columnName @@ -925,7 +925,7 @@ LIKE %1 } /** - * Check if there is a given table in the database + * Check if there is a given table in the database. * * @param string $tableName * @@ -1061,7 +1061,7 @@ FROM civicrm_domain } /** - * Get sort string + * Get sort string. * * @param array|object $sort either array or CRM_Utils_Sort * @param string $default @@ -1087,7 +1087,7 @@ FROM civicrm_domain } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param string $daoName * Name of the dao object. @@ -1119,7 +1119,7 @@ FROM civicrm_domain } /** - * Delete the object records that are associated with this contact + * Delete the object records that are associated with this contact. * * @param string $daoName * Name of the dao object. @@ -1137,7 +1137,7 @@ FROM civicrm_domain } /** - * Execute a query + * Execute a query. * * @param string $query * Query to be executed. @@ -1193,7 +1193,7 @@ FROM civicrm_domain } /** - * Execute a query and get the single result + * Execute a query and get the single result. * * @param string $query * Query to be executed. @@ -1484,7 +1484,7 @@ SELECT contact_id } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param string $daoName * Name of the dao object. @@ -1699,7 +1699,7 @@ SELECT contact_id } /** - * Deletes the this object plus any dependent objects that are associated with it + * Deletes the this object plus any dependent objects that are associated with it. * ONLY USE FOR TESTING * * @param string $daoName @@ -1745,7 +1745,7 @@ SELECT contact_id } /** - * Set defaults when creating new entity + * Set defaults when creating new entity. * (don't call this set defaults as already in use with different signature in some places) * * @param array $params @@ -1893,7 +1893,7 @@ SELECT contact_id } /** - * Wrapper function to drop triggers + * Wrapper function to drop triggers. * * @param string $tableName * the specific table requiring a rebuild; or NULL to rebuild all tables. diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 1ecbbede88..f3e16c33c2 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -215,7 +215,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Register all the standard rules that most forms potentially use + * Register all the standard rules that most forms potentially use. * * @return void */ @@ -407,7 +407,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Performs the server side validation + * Performs the server side validation. * @since 1.0 * @return bool * true if no error found @@ -575,7 +575,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for Name + * Getter function for Name. * * @return string */ @@ -584,7 +584,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for State + * Getter function for State. * * @return object */ @@ -593,7 +593,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for StateType + * Getter function for StateType. * * @return int */ @@ -623,7 +623,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Setter function for options + * Setter function for options. * * @param mixed $options * @@ -646,7 +646,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Boolean function to determine if this is a one form page + * Boolean function to determine if this is a one form page. * * @return bool */ @@ -655,7 +655,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for Form Action + * Getter function for Form Action. * * @return string */ @@ -664,7 +664,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Setter function for Form Action + * Setter function for Form Action. * * @param string $action * @@ -675,7 +675,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Render form and return contents + * Render form and return contents. * * @return string */ @@ -704,7 +704,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -747,7 +747,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Error reporting mechanism + * Error reporting mechanism. * * @param string $message * Error Message. @@ -769,7 +769,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Store the variable with the value in the form scope + * Store the variable with the value in the form scope. * * @param string $name * Name of the variable. @@ -783,7 +783,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Get the variable from the form scope + * Get the variable from the form scope. * * @param string $name * Name of the variable @@ -795,7 +795,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter for action + * Getter for action. * * @return int */ @@ -804,7 +804,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Setter for action + * Setter for action. * * @param int $action * The mode we want to set the form. @@ -816,7 +816,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Assign value to name in template + * Assign value to name in template. * * @param string $var * Name of variable. @@ -830,7 +830,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Assign value to name in template by reference + * Assign value to name in template by reference. * * @param string $var * Name of variable. @@ -844,7 +844,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Appends values to template variables + * Appends values to template variables. * * @param array|string $tpl_var the template variable name(s) * @param mixed $value @@ -856,7 +856,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Returns an array containing template variables + * Returns an array containing template variables. * * @param string $name * @@ -1032,7 +1032,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Adds a select based on field metadata + * Adds a select based on field metadata. * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata * Perhaps a method like $form->bind($name) which would look up all metadata for named field * @param $name @@ -1285,7 +1285,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Add date + * Add date. * * @code * // if you need time @@ -1383,7 +1383,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Function that will add date and time + * Function that will add date and time. */ public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) { $addTime = array('addTime' => TRUE); @@ -1398,7 +1398,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Add a currency and money element to the form + * Add a currency and money element to the form. */ public function addMoney( $name, @@ -1421,7 +1421,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Add currency element to the form + * Add currency element to the form. */ public function addCurrency( $name = 'currency', @@ -1448,7 +1448,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Create a single or multiple entity ref field + * Create a single or multiple entity ref field. * @param string $name * @param string $label * @param array $props @@ -1552,14 +1552,14 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Function that can be defined in Form to override or + * Function that can be defined in Form to override or. * perform specific action on cancel action */ public function cancelAction() { } /** - * Helper function to verify that required fields have been filled + * Helper function to verify that required fields have been filled. * Typically called within the scope of a FormRule function */ public static function validateMandatoryFields($fields, $values, &$errors) { @@ -1625,7 +1625,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Get the contact id of the logged in user + * Get the contact id of the logged in user. */ public function getLoggedInUserContactID() { // check if the user is logged in and has a contact ID @@ -1741,7 +1741,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Sets form attribute + * Sets form attribute. * @see CRM.loadForm */ public function preventAjaxSubmit() { @@ -1749,7 +1749,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Sets form attribute + * Sets form attribute. * @see CRM.loadForm */ public function allowAjaxSubmit() { @@ -1757,7 +1757,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Sets page title based on entity and action + * Sets page title based on entity and action. * @param string $entityLabel */ public function setPageTitle($entityLabel) { diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 726ced533b..c1cb9d3a63 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -35,7 +35,7 @@ class CRM_Core_Form_Date { /** - * Various Date Formats + * Various Date Formats. */ const DATE_yyyy_mm_dd = 1, DATE_mm_dd_yy = 2, DATE_mm_dd_yyyy = 4, DATE_Month_dd_yyyy = 8, DATE_dd_mon_yy = 16, DATE_dd_mm_yyyy = 32; @@ -108,7 +108,7 @@ class CRM_Core_Form_Date { } /** - * build the date range array that will provide the form option values + * build the date range array that will provide the form option values. * It can be - relative or absolute * * @param CRM_Core_Form $form diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index c202188193..b198557140 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -241,7 +241,7 @@ class CRM_Core_Form_RecurringEntity { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -326,7 +326,7 @@ class CRM_Core_Form_RecurringEntity { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Core/Form/Renderer.php b/CRM/Core/Form/Renderer.php index d10e2a1e74..16d73e947d 100644 --- a/CRM/Core/Form/Renderer.php +++ b/CRM/Core/Form/Renderer.php @@ -49,7 +49,7 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { static private $_singleton = NULL; /** - * The converter from array size to css class + * The converter from array size to css class. * * @var array */ @@ -65,7 +65,7 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { ); /** - * Constructor + * Constructor. */ public function __construct() { $template = CRM_Core_Smarty::singleton(); @@ -85,7 +85,7 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { } /** - * Creates an array representing an element containing + * Creates an array representing an element containing. * the key for storing this. We allow the parent to do most of the * work, but then we add some CiviCRM specific enhancements to * make the html compliant with our css etc @@ -200,7 +200,7 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { } /** - * Convert IDs to values and format for display + * Convert IDs to values and format for display. * * @param HTML_QuickForm_element $field */ diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index 4ddd9d9ab1..467f872453 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -122,7 +122,7 @@ class CRM_Core_Form_Tag { } /** - * Save entity tags when it is not save used AJAX + * Save entity tags when it is not save used AJAX. * * @param array $params * @param int $entityId diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index d13b06fae6..231d30a5cf 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -435,7 +435,7 @@ class CRM_Core_I18n_Schema { } /** - * CREATE INDEX queries for a given locale and table + * CREATE INDEX queries for a given locale and table. * * @param string $locale * locale for which the queries should be created (null to create original indices). @@ -478,7 +478,7 @@ class CRM_Core_I18n_Schema { } /** - * CREATE VIEW query for a given locale and table + * CREATE VIEW query for a given locale and table. * * @param string $locale * locale of the view. diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index a66d6843f3..7153125ded 100644 --- a/CRM/Core/IDS.php +++ b/CRM/Core/IDS.php @@ -35,7 +35,7 @@ class CRM_Core_IDS { /** - * Define the threshold for the ids reactions + * Define the threshold for the ids reactions. */ private $threshold = array( 'log' => 25, @@ -95,7 +95,7 @@ class CRM_Core_IDS { } /** - * Create the default config file for the IDS system + * Create the default config file for the IDS system. * * @param bool $force * Should we recreate it irrespective if it exists or not. diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php index 5978833ca7..88b60d02d2 100644 --- a/CRM/Core/Key.php +++ b/CRM/Core/Key.php @@ -38,7 +38,7 @@ class CRM_Core_Key { static $_sessionID = NULL; /** - * Generate a private key per session and store in session + * Generate a private key per session and store in session. * * @return string * private key for this session @@ -95,7 +95,7 @@ class CRM_Core_Key { } /** - * Validate a form key based on the form name + * Validate a form key based on the form name. * * @param string $key * @param string $name diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index 8338850db7..eb0c1e85a7 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -42,14 +42,14 @@ require_once 'CRM/Core/I18n.php'; class CRM_Core_Menu { /** - * The list of menu items + * The list of menu items. * * @var array */ static $_items = NULL; /** - * The list of permissioned menu items + * The list of permissioned menu items. * * @var array */ @@ -67,7 +67,7 @@ class CRM_Core_Menu { const MENU_ITEM = 1; /** - * This function fetches the menu items from xml and xmlMenu hooks + * This function fetches the menu items from xml and xmlMenu hooks. * * @param boolen $fetchFromXML * Fetch the menu items from xml and not from cache. @@ -159,7 +159,7 @@ class CRM_Core_Menu { } /** - * This function defines information for various menu items + * This function defines information for various menu items. * * @param boolen $fetchFromXML * Fetch the menu items from xml and not from cache. @@ -235,7 +235,7 @@ class CRM_Core_Menu { } /** - * We use this function to + * We use this function to. * * 1. Compute the breadcrumb * 2. Compute local tasks value if any @@ -259,7 +259,7 @@ class CRM_Core_Menu { } /** - * This function recomputes menu from xml and populates civicrm_menu + * This function recomputes menu from xml and populates civicrm_menu. * @param bool $truncate */ public static function store($truncate = TRUE) { diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index ca23899ccc..9a25dfe25b 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -198,7 +198,7 @@ WHERE v.option_group_id = g.id } /** - * This function retrieves all the values for the specific option group by id + * This function retrieves all the values for the specific option group by id. * this is primarily used to create various html based form elements * (radio, select, checkbox etc). OptionGroups for most cases have the * 'label' in the label colum and the 'id' or 'name' in the value column diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index fd87df73c3..60bcc3e07c 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -51,7 +51,7 @@ class CRM_Core_Page { protected $_name; /** - * The title associated with this page + * The title associated with this page. * * @var object */ @@ -116,7 +116,7 @@ class CRM_Core_Page { public $useLivePageJS; /** - * Class constructor + * Class constructor. * * @param string $title * Title of the page. @@ -245,7 +245,7 @@ class CRM_Core_Page { } /** - * Store the variable with the value in the form scope + * Store the variable with the value in the form scope. * * @param string|array $name name of the variable or an assoc array of name/value pairs * @param mixed $value @@ -259,7 +259,7 @@ class CRM_Core_Page { } /** - * Get the variable from the form scope + * Get the variable from the form scope. * * @param string $name name of the variable * @@ -270,7 +270,7 @@ class CRM_Core_Page { } /** - * Assign value to name in template + * Assign value to name in template. * * @param string $var * @param mixed $value @@ -283,7 +283,7 @@ class CRM_Core_Page { } /** - * Assign value to name in template by reference + * Assign value to name in template by reference. * * @param string $var * @param mixed $value @@ -296,7 +296,7 @@ class CRM_Core_Page { } /** - * Appends values to template variables + * Appends values to template variables. * * @param array|string $tpl_var the template variable name(s) * @param mixed $value @@ -308,7 +308,7 @@ class CRM_Core_Page { } /** - * Returns an array containing template variables + * Returns an array containing template variables. * * @param string $name * @@ -329,7 +329,7 @@ class CRM_Core_Page { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -364,7 +364,7 @@ class CRM_Core_Page { } /** - * Setter for embedded + * Setter for embedded. * * @param bool $embedded * @@ -375,7 +375,7 @@ class CRM_Core_Page { } /** - * Getter for embedded + * Getter for embedded. * * @return bool * return the embedded value @@ -385,7 +385,7 @@ class CRM_Core_Page { } /** - * Setter for print + * Setter for print. * * @param bool $print * @@ -396,7 +396,7 @@ class CRM_Core_Page { } /** - * Getter for print + * Getter for print. * * @return bool * return the print value diff --git a/CRM/Core/Page/AJAX.php b/CRM/Core/Page/AJAX.php index ecdd67047b..21adef2cef 100644 --- a/CRM/Core/Page/AJAX.php +++ b/CRM/Core/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Core_Page_AJAX { /** - * Call generic ajax forms + * Call generic ajax forms. * */ public static function run() { @@ -89,7 +89,7 @@ class CRM_Core_Page_AJAX { } /** - * Change is_quick_config priceSet to complex + * Change is_quick_config priceSet to complex. * */ public static function setIsQuickConfig() { @@ -199,7 +199,7 @@ class CRM_Core_Page_AJAX { } /** - * Set headers appropriate for a js file + * Set headers appropriate for a js file. * * @param int|NULL $ttl * Time-to-live (seconds). diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index a9a633a56b..a0be675c4e 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -37,18 +37,18 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { protected $_action; /** - * Define all the abstract functions here + * Define all the abstract functions here. */ /** - * Name of the BAO to perform various DB manipulations + * Name of the BAO to perform various DB manipulations. * * @return string */ abstract protected function getBAOName(); /** - * An array of action links + * An array of action links. * * @return array * (reference) @@ -56,21 +56,21 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract protected function &links(); /** - * Name of the edit form class + * Name of the edit form class. * * @return string */ abstract protected function editForm(); /** - * Name of the form + * Name of the form. * * @return string */ abstract protected function editName(); /** - * UserContext to pop back to + * UserContext to pop back to. * * @param int $mode * Mode that we are in. @@ -80,7 +80,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract protected function userContext($mode = NULL); /** - * Get userContext params + * Get userContext params. * * @param int $mode * Mode that we are in. @@ -92,7 +92,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { } /** - * Allow objects to be added based on permission + * Allow objects to be added based on permission. * * @param int $id * The id of the object. @@ -119,7 +119,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { } /** - * Class constructor + * Class constructor. * * @param string $title * Title of the page. diff --git a/CRM/Core/Page/QUnit.php b/CRM/Core/Page/QUnit.php index f58aae5444..a3e541aa96 100644 --- a/CRM/Core/Page/QUnit.php +++ b/CRM/Core/Page/QUnit.php @@ -46,7 +46,7 @@ class CRM_Core_Page_QUnit extends CRM_Core_Page { } /** - * Extrac the extension and suite from the request path + * Extrac the extension and suite from the request path. * * @return array */ diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index da4d90f51c..cc9cf7cd5c 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -38,7 +38,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -74,7 +74,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Submit a payment using Advanced Integration Method + * Submit a payment using Advanced Integration Method. * * @param array $params * Assoc array of input parameters for this transaction. @@ -191,7 +191,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Submit an Automated Recurring Billing subscription + * Submit an Automated Recurring Billing subscription. */ public function doRecurPayment() { $template = CRM_Core_Smarty::singleton(); @@ -374,7 +374,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. @@ -455,7 +455,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Calculate and return the transaction fingerprint + * Calculate and return the transaction fingerprint. * * @return string * fingerprint @@ -507,7 +507,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Extract variables from returned XML + * Extract variables from returned XML. * * Function is from Authorize.Net sample code, and used * to prevent the requirement of XML functions. @@ -534,7 +534,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Helper function for _parseArbReturn + * Helper function for _parseArbReturn. * * Function is from Authorize.Net sample code, and used to avoid using * PHP5 XML functions @@ -551,7 +551,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Get the value of a field if set + * Get the value of a field if set. * * @param string $field * The field. @@ -606,7 +606,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/AuthorizeNetIPN.php b/CRM/Core/Payment/AuthorizeNetIPN.php index 011fb7f408..a5ceec4aff 100644 --- a/CRM/Core/Payment/AuthorizeNetIPN.php +++ b/CRM/Core/Payment/AuthorizeNetIPN.php @@ -35,7 +35,7 @@ class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN { /** - * Constructor function + * Constructor function. * * @param array $inputData * contents of HTTP REQUEST. diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index f461bf693b..dfb319a34e 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -48,14 +48,14 @@ class CRM_Core_Payment_BaseIPN { protected $_isFirstOrLastRecurringPayment = FALSE; /** - * Constructor + * Constructor. */ public function __construct() { self::$_now = date('YmdHis'); } /** - * Store input array on the class + * Store input array on the class. * * @param array $parameters * @@ -124,7 +124,7 @@ class CRM_Core_Payment_BaseIPN { } /** - * Load objects related to contribution + * Load objects related to contribution. * * @input array information from Payment processor * @@ -181,7 +181,7 @@ class CRM_Core_Payment_BaseIPN { } /** - * Set contribution to failed + * Set contribution to failed. * @param array $objects * @param object $transaction * @param array $input @@ -262,7 +262,7 @@ class CRM_Core_Payment_BaseIPN { } /** - * Handled pending contribution status + * Handled pending contribution status. * @param array $objects * @param object $transaction * @return bool @@ -764,7 +764,7 @@ LIMIT 1;"; } /** - * Send start or end notification for recurring payments + * Send start or end notification for recurring payments. * @param $ids * @param $recur */ @@ -904,7 +904,7 @@ LIMIT 1;"; } /** - * Update pledge associated with a recurring contribution + * Update pledge associated with a recurring contribution. * * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage. * @@ -1017,7 +1017,7 @@ LIMIT 1;"; } /** - * copy custom data of the initial contribution into its recurring contributions + * copy custom data of the initial contribution into its recurring contributions. * @param int $recurId * @param int $targetContributionId */ @@ -1061,7 +1061,7 @@ LIMIT 1;"; } /** - * copy soft credit record of first recurring contribution + * copy soft credit record of first recurring contribution. * and add new soft credit against $targetContributionId * * @param int $recurId diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index 8bcf9809f9..2ac03d16c0 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -50,7 +50,7 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -66,7 +66,7 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { } /** - * Submit a payment using Advanced Integration Method + * Submit a payment using Advanced Integration Method. * * @param array $params * Assoc array of input parameters for this transaction. @@ -148,7 +148,7 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index 493bfec62c..a45c07c0bd 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -37,7 +37,7 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -260,7 +260,7 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { } /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. @@ -275,7 +275,7 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { } /** - * Produces error message and returns from class + * Produces error message and returns from class. * @param string $errorCode * @param string $errorMessage * @return CRM_Core_Error @@ -299,7 +299,7 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { } /** - * This public function checks to see if we have the right processor config values set + * This public function checks to see if we have the right processor config values set. * * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index 7ca813f6c4..792d23db15 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -64,7 +64,7 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -301,7 +301,7 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { // end function doDirectPayment /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. @@ -316,7 +316,7 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { } /** - * Produces error message and returns from class + * Produces error message and returns from class. */ public function &errorExit($errorCode = NULL, $errorMessage = NULL) { $e = CRM_Core_Error::singleton(); @@ -338,7 +338,7 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { } /** - * This public function checks to see if we have the right processor config values set + * This public function checks to see if we have the right processor config values set. * * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 78d5413742..2025aac134 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -81,7 +81,7 @@ class CRM_Core_Payment_Form { } /** - * Add general billing fields + * Add general billing fields. * @todo set these like processor fields & let payment processors alter them * * @param CRM_Core_Form $form @@ -335,7 +335,7 @@ class CRM_Core_Payment_Form { } /** - * Make sure that credit card number and cvv are valid + * Make sure that credit card number and cvv are valid. * Called within the scope of a QF formRule function */ public static function validateCreditCard($values, &$errors) { @@ -357,7 +357,7 @@ class CRM_Core_Payment_Form { } /** - * Map address fields + * Map address fields. * * @param int $id * @param $src @@ -398,7 +398,7 @@ class CRM_Core_Payment_Form { } /** - * 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 * @@ -415,7 +415,7 @@ class CRM_Core_Payment_Form { } /** - * 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 61d3e3863a..ab28749b43 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -59,7 +59,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -75,7 +75,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any @@ -117,7 +117,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * Sets appropriate parameters for checking out to google + * Sets appropriate parameters for checking out to google. * * @param array $params * Name value pair of contribution datat. @@ -190,7 +190,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * Builds appropriate parameters for checking out to google and submits the post params + * Builds appropriate parameters for checking out to google and submits the post params. * * @param array $params * Name value pair of contribution data. diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index 61ae8c1671..05805c6791 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -83,7 +83,7 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { } /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. diff --git a/CRM/Core/Payment/IATS.php b/CRM/Core/Payment/IATS.php index f71d842c14..3236fa5d03 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -48,7 +48,7 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -320,7 +320,7 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * 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) * diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index 91913752a6..4fad580ea4 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -46,7 +46,7 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -310,7 +310,7 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 8771a1d8f6..179217d256 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -28,7 +28,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -173,7 +173,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { /** - * This function checks the PayJunction response code + * This function checks the PayJunction response code. * * @return bool */ @@ -200,7 +200,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { } /** - * Get the value of a field if set + * Get the value of a field if set. * * @param string $field * The field. @@ -257,7 +257,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/PayPalIPN.php b/CRM/Core/Payment/PayPalIPN.php index ba1262ea8e..89af471e18 100644 --- a/CRM/Core/Payment/PayPalIPN.php +++ b/CRM/Core/Payment/PayPalIPN.php @@ -37,7 +37,7 @@ class CRM_Core_Payment_PayPalIPN extends CRM_Core_Payment_BaseIPN { static $_paymentProcessor = NULL; /** - * Constructor + * Constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 4a3be6df74..efe8fdfe4d 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -46,7 +46,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -372,7 +372,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index e4f05d1773..4804eba8d6 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -44,13 +44,13 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { protected $_inputParameters = array(); /** - * Store for the variables from the invoice string + * Store for the variables from the invoice string. * @var array */ protected $_invoiceData = array(); /** - * Is this a payment express transaction + * Is this a payment express transaction. */ protected $_isPaymentExpress = FALSE; @@ -61,7 +61,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { protected $_component = 'contribute'; /** - * Constructor function + * Constructor function. * * @param array $inputData * Contents of HTTP REQUEST. @@ -75,7 +75,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { } /** - * get the values from the rp_invoice_id string + * get the values from the rp_invoice_id string. * * @param string $name * E.g. i, values are stored in the string with letter codes. @@ -158,7 +158,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { } /** - * Process recurring contributions + * Process recurring contributions. * @param array $input * @param array $ids * @param array $objects @@ -513,7 +513,7 @@ INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contr } /** - * Handle payment express IPNs + * Handle payment express IPNs. * For one off IPNS no actual response is required * Recurring is more difficult as we have limited confirmation material * lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no @@ -578,7 +578,7 @@ INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contr } /** - * Function check if transaction already exists + * Function check if transaction already exists. * @param string $trxn_id * @return bool|void */ diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index 245caacce6..c50c11d44a 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -346,7 +346,7 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { } /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index 0aba51b29e..b87834024a 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -50,7 +50,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -67,7 +67,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * 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) * @@ -134,7 +134,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /** - * Main transaction function + * Main transaction function. * * @param array $params * Name value pair of contribution data. diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index 3b87f79970..e45494fc88 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -81,7 +81,7 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { } /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index f19f557198..b137295c97 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -53,7 +53,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param string $mode * The mode of operation: live or test. @@ -113,7 +113,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * Submit a payment using Advanced Integration Method + * Submit a payment using Advanced Integration Method. * * @param array $params * Assoc array of input parameters for this transaction. @@ -428,7 +428,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. @@ -443,7 +443,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * Get the value of a field if set + * Get the value of a field if set. * * @param string $field * The field. @@ -514,7 +514,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 9bb50281eb..f6504d7e2d 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -409,7 +409,7 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { // end function doDirectPayment /** - * Checks to see if invoice_id already exists in db + * Checks to see if invoice_id already exists in db. * * @param int $invoiceId * The ID to check. diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 2bb6da1149..06fad11155 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** - * The template to display the required "red" asterick + * The template to display the required "red" asterick. * @var string */ static $_requiredTemplate = NULL; diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index 04a51a80d7..428af96078 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -189,7 +189,7 @@ class CRM_Core_Report_Excel { } /** - * Write a CSV file to the browser output + * Write a CSV file to the browser output. * * @param string $fileName * The name of the file that will be downloaded (this is sent to the browser). diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 7586d25f24..b3effac2b5 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -99,7 +99,7 @@ class CRM_Core_Resources { public $ajaxPopupsEnabled; /** - * Get or set the single instance of CRM_Core_Resources + * Get or set the single instance of CRM_Core_Resources. * * @param CRM_Core_Resources $instance * New copy of the manager. diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php index cc9544bca8..65011151eb 100644 --- a/CRM/Core/Selector/API.php +++ b/CRM/Core/Selector/API.php @@ -61,7 +61,7 @@ interface CRM_Core_Selector_API { public function getPagerParams($action, &$params); /** - * Returns the sort order array for the given action + * Returns the sort order array for the given action. * * @param string $action * The action being performed. @@ -86,7 +86,7 @@ interface CRM_Core_Selector_API { public function &getColumnHeaders($action = NULL, $type = NULL); /** - * Returns the number of rows for this action + * Returns the number of rows for this action. * * @param string $action * The action being performed. @@ -97,7 +97,7 @@ interface CRM_Core_Selector_API { public function getTotalCount($action); /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. @@ -126,7 +126,7 @@ interface CRM_Core_Selector_API { public function getTemplateFileName($action = NULL); /** - * Return the filename for the exported CSV + * Return the filename for the exported CSV. * * @param string $type * The type of export required: csv/xml/foaf etc. diff --git a/CRM/Core/Selector/Base.php b/CRM/Core/Selector/Base.php index e8ca4990d7..8ad710873b 100644 --- a/CRM/Core/Selector/Base.php +++ b/CRM/Core/Selector/Base.php @@ -60,7 +60,7 @@ class CRM_Core_Selector_Base { protected $_key; /** - * This function gets the attribute for the action that + * This function gets the attribute for the action that. * it matches. * * @param string $match the action to match against @@ -97,7 +97,7 @@ class CRM_Core_Selector_Base { } /** - * Compose the template file name from the class name + * Compose the template file name from the class name. * * @param string $action * The action being performed. @@ -147,7 +147,7 @@ class CRM_Core_Selector_Base { } /** - * Setter for permission + * Setter for permission. * * @var string */ diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 2ee0577247..6a1577fba0 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -51,7 +51,7 @@ class CRM_Core_Selector_Controller { TRANSFER = 4, EXPORT = 8, SCREEN = 16, PDF = 32; /** - * A CRM Object that implements CRM_Core_Selector_API + * A CRM Object that implements CRM_Core_Selector_API. * @var object */ protected $_object; @@ -174,7 +174,7 @@ class CRM_Core_Selector_Controller { protected $_dynamicAction = FALSE; /** - * Class constructor + * Class constructor. * * @param CRM_Core_Selector_API $object * An object that implements the selector API. @@ -423,7 +423,7 @@ class CRM_Core_Selector_Controller { } /** - * Getter for pager + * Getter for pager. * * @return CRM_Utils_Pager */ @@ -432,7 +432,7 @@ class CRM_Core_Selector_Controller { } /** - * Getter for sort + * Getter for sort. * * @return CRM_Utils_Sort */ @@ -441,7 +441,7 @@ class CRM_Core_Selector_Controller { } /** - * Move the variables from the session to the template + * Move the variables from the session to the template. * * @return void */ @@ -483,7 +483,7 @@ class CRM_Core_Selector_Controller { } /** - * Setter for embedded + * Setter for embedded. * * @param bool $embedded * @@ -494,7 +494,7 @@ class CRM_Core_Selector_Controller { } /** - * Getter for embedded + * Getter for embedded. * * @return bool * return the embedded value @@ -504,7 +504,7 @@ class CRM_Core_Selector_Controller { } /** - * Setter for print + * Setter for print. * * @param bool $print * @@ -515,7 +515,7 @@ class CRM_Core_Selector_Controller { } /** - * Getter for print + * Getter for print. * * @return bool * return the print value diff --git a/CRM/Custom/Form/ChangeFieldType.php b/CRM/Custom/Form/ChangeFieldType.php index 627235599a..ecaac99aa8 100644 --- a/CRM/Custom/Form/ChangeFieldType.php +++ b/CRM/Custom/Form/ChangeFieldType.php @@ -56,7 +56,7 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { protected $_htmlTypeTransitions; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -90,7 +90,7 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -133,7 +133,7 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Custom/Form/DeleteField.php b/CRM/Custom/Form/DeleteField.php index 41d61385c9..79bab78945 100644 --- a/CRM/Custom/Form/DeleteField.php +++ b/CRM/Custom/Form/DeleteField.php @@ -39,21 +39,21 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { /** - * The group id + * The group id. * * @var int */ protected $_id; /** - * The title of the group being deleted + * The title of the group being deleted. * * @var string */ protected $_title; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -71,7 +71,7 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -92,7 +92,7 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Custom/Form/DeleteGroup.php b/CRM/Custom/Form/DeleteGroup.php index b794226815..57eff3dd85 100644 --- a/CRM/Custom/Form/DeleteGroup.php +++ b/CRM/Custom/Form/DeleteGroup.php @@ -39,21 +39,21 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { /** - * The group id + * The group id. * * @var int */ protected $_id; /** - * The title of the group being deleted + * The title of the group being deleted. * * @var string */ protected $_title; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -82,7 +82,7 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -103,7 +103,7 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index 0e56f959a5..dd569f6de9 100644 --- a/CRM/Custom/Form/Field.php +++ b/CRM/Custom/Form/Field.php @@ -44,7 +44,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { const NUM_OPTION = 11; /** - * The custom group id saved to the session for an update + * The custom group id saved to the session for an update. * * @var int */ @@ -65,7 +65,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { protected $_defaultDataType; /** - * Array of custom field values if update mode + * Array of custom field values if update mode. */ protected $_values; @@ -82,7 +82,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { private static $_dataToLabels = NULL; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -272,7 +272,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -560,7 +560,7 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -893,7 +893,7 @@ AND option_group_id = %2"; } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 8f88a64ac7..56e0af14da 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -39,35 +39,35 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { /** - * The set id saved to the session for an update + * The set id saved to the session for an update. * * @var int */ protected $_id; /** - * set is empty or not + * set is empty or not. * * @var bool */ protected $_isGroupEmpty = TRUE; /** - * Array of existing subtypes set for a custom set + * Array of existing subtypes set for a custom set. * * @var array */ protected $_subtypes = array(); /** - * Array of default params + * Array of default params. * * @var array */ protected $_defaults = array(); /** - * Set variables up before form is built + * Set variables up before form is built. * * * @return void @@ -104,7 +104,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -182,7 +182,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * * @return void @@ -451,7 +451,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * * @return void diff --git a/CRM/Custom/Form/MoveField.php b/CRM/Custom/Form/MoveField.php index ce10351188..fecbe7cac6 100644 --- a/CRM/Custom/Form/MoveField.php +++ b/CRM/Custom/Form/MoveField.php @@ -39,42 +39,42 @@ class CRM_Custom_Form_MoveField extends CRM_Core_Form { /** - * The src group id + * The src group id. * * @var int */ protected $_srcGID; /** - * The src field id + * The src field id. * * @var int */ protected $_srcFID; /** - * The dst group id + * The dst group id. * * @var int */ protected $_dstGID; /** - * The dst field id + * The dst field id. * * @var int */ protected $_dstFID; /** - * The title of the field being moved + * The title of the field being moved. * * @var string */ protected $_srcFieldLabel; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -103,7 +103,7 @@ class CRM_Custom_Form_MoveField extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -159,7 +159,7 @@ class CRM_Custom_Form_MoveField extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index 1e9d1e3227..1bd2863b6c 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -65,7 +65,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { protected $_id; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -145,7 +145,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -231,7 +231,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -384,7 +384,7 @@ SELECT count(*) } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Custom/Form/Preview.php b/CRM/Custom/Form/Preview.php index 7cf96a6c1a..8a7bf068b6 100644 --- a/CRM/Custom/Form/Preview.php +++ b/CRM/Custom/Form/Preview.php @@ -44,7 +44,7 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { /** - * The group tree data + * The group tree data. * * @var array */ @@ -90,7 +90,7 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { } /** - * Set the default form values + * Set the default form values. * * @return array * the default array reference @@ -104,7 +104,7 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Custom/Import/Form/DataSource.php b/CRM/Custom/Import/Form/DataSource.php index 7d80060f23..83f80801cb 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -78,7 +78,7 @@ class CRM_Custom_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -162,7 +162,7 @@ class CRM_Custom_Import_Form_DataSource extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Custom/Import/Form/MapField.php b/CRM/Custom/Import/Form/MapField.php index fc978e955d..5f6b2bda3a 100644 --- a/CRM/Custom/Import/Form/MapField.php +++ b/CRM/Custom/Import/Form/MapField.php @@ -8,13 +8,13 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { protected $_mappingType = 'Import Multi value custom data'; protected $_highlightedFields = array(); /** - * Entity being imported to + * Entity being imported to. * @var string */ protected $_entity; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -46,7 +46,7 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -56,7 +56,7 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -119,7 +119,7 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { } /** - * Process the mapped fields and map it into the uploaded file + * Process the mapped fields and map it into the uploaded file. * preview the file and extract some summary statistics * * @return void diff --git a/CRM/Custom/Import/Form/Preview.php b/CRM/Custom/Import/Form/Preview.php index 3ef4fbf53a..56887cbcf5 100644 --- a/CRM/Custom/Import/Form/Preview.php +++ b/CRM/Custom/Import/Form/Preview.php @@ -8,7 +8,7 @@ class CRM_Custom_Import_Form_Preview extends CRM_Import_Form_Preview { protected $_importParserUrl = '&parser=CRM_Custom_Import_Parser'; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -75,7 +75,7 @@ class CRM_Custom_Import_Form_Preview extends CRM_Import_Form_Preview { } /** - * Process the mapped fields and map it into the uploaded file + * Process the mapped fields and map it into the uploaded file. * preview the file and extract some summary statistics * * @return void diff --git a/CRM/Custom/Import/Form/Summary.php b/CRM/Custom/Import/Form/Summary.php index 8a96614dbb..228465fa21 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index 2b879c15cd..76a564bf5a 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -308,7 +308,7 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { } /** - * 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 @@ -327,7 +327,7 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index aa439a46e1..3a2b7777a3 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -12,7 +12,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { protected $_multipleCustomData = ''; /** - * Params for the current entity being prepared for the api + * Params for the current entity being prepared for the api. * @var array */ protected $_params = array(); @@ -58,7 +58,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -70,7 +70,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -133,7 +133,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. @@ -185,7 +185,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * Format Date params + * Format Date params. * * 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 @@ -202,7 +202,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * Set import entity + * Set import entity. * @param string $entity */ public function setEntity($entity) { diff --git a/CRM/Custom/Page/Field.php b/CRM/Custom/Page/Field.php index 871b8fd79c..c5d94bf758 100644 --- a/CRM/Custom/Page/Field.php +++ b/CRM/Custom/Page/Field.php @@ -46,14 +46,14 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * The group id of the field + * The group id of the field. * * @var int */ protected $_gid; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -295,7 +295,7 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { } /** - * Preview custom field + * Preview custom field. * * @param int $id * Custom field id. diff --git a/CRM/Custom/Page/Group.php b/CRM/Custom/Page/Group.php index bc5a713b45..d1f940f258 100644 --- a/CRM/Custom/Page/Group.php +++ b/CRM/Custom/Page/Group.php @@ -150,7 +150,7 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { } /** - * Edit custom group + * Edit custom group. * * @param int $id * Custom group id. @@ -173,7 +173,7 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { } /** - * Preview custom group + * Preview custom group. * * @param int $id * Custom group id. diff --git a/CRM/Dashlet/Page/Activity.php b/CRM/Dashlet/Page/Activity.php index c2b62f380c..0d1e1bb449 100644 --- a/CRM/Dashlet/Page/Activity.php +++ b/CRM/Dashlet/Page/Activity.php @@ -40,7 +40,7 @@ class CRM_Dashlet_Page_Activity extends CRM_Core_Page { /** - * List activities as dashlet + * List activities as dashlet. * * @return void */ diff --git a/CRM/Dashlet/Page/AllCases.php b/CRM/Dashlet/Page/AllCases.php index 54137e6ca4..27cb5767d0 100644 --- a/CRM/Dashlet/Page/AllCases.php +++ b/CRM/Dashlet/Page/AllCases.php @@ -40,7 +40,7 @@ class CRM_Dashlet_Page_AllCases extends CRM_Core_Page { /** - * List activities as dashlet + * List activities as dashlet. * * @return void */ diff --git a/CRM/Dashlet/Page/Blog.php b/CRM/Dashlet/Page/Blog.php index 1e8548d22c..02a108b23f 100644 --- a/CRM/Dashlet/Page/Blog.php +++ b/CRM/Dashlet/Page/Blog.php @@ -58,7 +58,7 @@ class CRM_Dashlet_Page_Blog extends CRM_Core_Page { } /** - * List blog articles as dashlet + * List blog articles as dashlet. */ public function run() { $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'dashlet'); @@ -70,7 +70,7 @@ class CRM_Dashlet_Page_Blog extends CRM_Core_Page { } /** - * Load blog articles from cache + * Load blog articles from cache. * Refresh cache if expired * * @return array @@ -96,7 +96,7 @@ class CRM_Dashlet_Page_Blog extends CRM_Core_Page { } /** - * Parse rss feed and cache results + * Parse rss feed and cache results. * * @param $url * diff --git a/CRM/Dashlet/Page/CaseDashboard.php b/CRM/Dashlet/Page/CaseDashboard.php index 5471a19707..5ed43c2429 100644 --- a/CRM/Dashlet/Page/CaseDashboard.php +++ b/CRM/Dashlet/Page/CaseDashboard.php @@ -40,7 +40,7 @@ class CRM_Dashlet_Page_CaseDashboard extends CRM_Core_Page { /** - * Case dashboard as dashlet + * Case dashboard as dashlet. * * @return void */ diff --git a/CRM/Dashlet/Page/MyCases.php b/CRM/Dashlet/Page/MyCases.php index 95035b6c28..988f259bd5 100644 --- a/CRM/Dashlet/Page/MyCases.php +++ b/CRM/Dashlet/Page/MyCases.php @@ -40,7 +40,7 @@ class CRM_Dashlet_Page_MyCases extends CRM_Core_Page { /** - * List activities as dashlet + * List activities as dashlet. * * @return void */ diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index eec56a6822..f8dca07695 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -50,7 +50,7 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { var $params = array(); /** - * If there are no rules in rule group + * If there are no rules in rule group. */ var $noRules = FALSE; @@ -313,7 +313,7 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { } /** - * sort queries by number of records for the table associated with them + * sort queries by number of records for the table associated with them. * @param $tableQueries */ public static function orderByTableCount(&$tableQueries) { @@ -411,7 +411,7 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { } /** - * Get all of the combinations of fields that would work with a rule + * Get all of the combinations of fields that would work with a rule. */ public static function combos($rgFields, $threshold, &$combos, $running = array()) { foreach ($rgFields as $rgField => $weight) { diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 9c938ebaf6..5bb0785828 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -156,7 +156,7 @@ class CRM_Dedupe_Merger { } /** - * Returns the related tables groups for which a contact has any info entered + * Returns the related tables groups for which a contact has any info entered. */ public static function getActiveRelTables($cid) { $cid = (int) $cid; @@ -243,7 +243,7 @@ WHERE } /** - * Return tables using locations + * Return tables using locations. */ public static function locTables() { static $locTables; diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 86453cc85a..10f8c2d5d6 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -62,7 +62,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index e837cec3a0..4f70438792 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -171,7 +171,7 @@ class CRM_Event_Badge { } /** - * This is supposed to be overrided + * This is supposed to be overrided. */ public function generateLabel($participant) { $txt = "{$this->event['title']} diff --git a/CRM/Event/Controller/Search.php b/CRM/Event/Controller/Search.php index 3154156f06..db580cfdee 100644 --- a/CRM/Event/Controller/Search.php +++ b/CRM/Event/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Event_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Event/Form/ParticipantView.php b/CRM/Event/Form/ParticipantView.php index f8a6795d52..bd3abf569e 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; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -219,7 +219,7 @@ class CRM_Event_Form_ParticipantView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Event/Import/Controller.php b/CRM/Event/Import/Controller.php index 3917f4e6ad..ce382e43fd 100644 --- a/CRM/Event/Import/Controller.php +++ b/CRM/Event/Import/Controller.php @@ -35,7 +35,7 @@ class CRM_Event_Import_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Event/Import/Form/DataSource.php b/CRM/Event/Import/Form/DataSource.php index 1166061c2c..c5d4394007 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -51,7 +51,7 @@ class CRM_Event_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -154,7 +154,7 @@ class CRM_Event_Import_Form_DataSource extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index 75bfdd647c..12293b1bff 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -40,7 +40,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -97,7 +97,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -282,7 +282,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Event/Import/Form/Preview.php b/CRM/Event/Import/Form/Preview.php index ffba083dda..47606344e4 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Event/Import/Form/Summary.php b/CRM/Event/Import/Form/Summary.php index 670964a83e..47792eb5c5 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index c23f159b7f..9da8e7c963 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 { } /** - * 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 @@ -356,7 +356,7 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * @@ -412,7 +412,7 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { } /** - * Export data to a CSV file + * Export data to a CSV file. * * @param string $fileName * @param array $header diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php index 93d10213dc..8df0f554dd 100644 --- a/CRM/Event/Import/Parser/Participant.php +++ b/CRM/Event/Import/Parser/Participant.php @@ -58,7 +58,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { protected $_newParticipants; /** - * Class constructor + * Class constructor. */ public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -123,7 +123,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -135,7 +135,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -148,7 +148,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * Handle the values in summary mode + * Handle the values in summary mode. * * @param array $values * The array of values belonging to this line. @@ -265,7 +265,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. @@ -493,7 +493,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * Get the array of successfully imported Participation ids + * Get the array of successfully imported Participation ids. * * @return array */ diff --git a/CRM/Event/Info.php b/CRM/Event/Info.php index 5c942b711d..c471626f2e 100644 --- a/CRM/Event/Info.php +++ b/CRM/Event/Info.php @@ -134,7 +134,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts * @param $newCredit */ diff --git a/CRM/Event/Page/AJAX.php b/CRM/Event/Page/AJAX.php index ac81f60aff..66ceb0e0e5 100644 --- a/CRM/Event/Page/AJAX.php +++ b/CRM/Event/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Event_Page_AJAX { /** - * 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 */ public function eventFee() { diff --git a/CRM/Event/Page/ManageEvent.php b/CRM/Event/Page/ManageEvent.php index b09b43057d..4200cbef45 100644 --- a/CRM/Event/Page/ManageEvent.php +++ b/CRM/Event/Page/ManageEvent.php @@ -39,7 +39,7 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -56,7 +56,7 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { protected $_isTemplate = FALSE; /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -98,7 +98,7 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { } /** - * Get tab Links for events + * Get tab Links for events. * * @param $enableCart * @@ -243,7 +243,7 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { } /** - * Browse all events + * Browse all events. * * @return void */ diff --git a/CRM/Event/Page/Tab.php b/CRM/Event/Page/Tab.php index 6b9b2ea1bf..e0afe4942b 100644 --- a/CRM/Event/Page/Tab.php +++ b/CRM/Event/Page/Tab.php @@ -38,7 +38,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { public $_contactId = NULL; /** - * called when action is browse + * called when action is browse. */ public function browse() { $controller = new CRM_Core_Controller_Simple( @@ -68,7 +68,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { } /** - * called when action is view + * called when action is view. * * @return null */ @@ -89,7 +89,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ diff --git a/CRM/Event/Page/UserDashboard.php b/CRM/Event/Page/UserDashboard.php index e3d164350f..57134c0a14 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 { /** - * List participations for the UF user + * List participations for the UF user. * */ public function listParticipations() { diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 4d5d14b3e5..4e4658195a 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -123,7 +123,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the n participant statuses + * Get all the n participant statuses. * * * @param int $id @@ -187,7 +187,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the n participant roles + * Get all the n participant roles. * * * @param int $id @@ -219,7 +219,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the participant listings + * Get all the participant listings. * * * @param int $id @@ -262,7 +262,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get event template titles + * Get event template titles. * * @param int $id * @@ -299,7 +299,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the Personal campaign pages + * Get all the Personal campaign pages. * * * @param int $id diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index a983983642..bde2f1d34a 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -119,28 +119,28 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_eventClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -191,7 +191,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * Can be used to alter the number of participation returned from a buildForm hook + * Can be used to alter the number of participation returned from a buildForm hook. * * @param int $limit * How many participations do we want returned. @@ -289,7 +289,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Event/StateMachine/Registration.php b/CRM/Event/StateMachine/Registration.php index ec2f600718..bc164b1659 100644 --- a/CRM/Event/StateMachine/Registration.php +++ b/CRM/Event/StateMachine/Registration.php @@ -40,7 +40,7 @@ class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php index 0df32088fc..09f5e0c7da 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -35,14 +35,14 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -96,7 +96,7 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Event/Task.php b/CRM/Event/Task.php index 5c8940e4f7..c0cd5305a2 100644 --- a/CRM/Event/Task.php +++ b/CRM/Event/Task.php @@ -167,7 +167,7 @@ class CRM_Event_Task { } /** - * These tasks get added based on the context the user is in + * These tasks get added based on the context the user is in. * * @return array * the set of optional tasks for a group of contacts diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index 42c06f7b4e..cc8e25bd3f 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; /** - * Get the list the export fields + * Get the list the export fields. * * @param int $selectAll * User preference while export. @@ -1191,7 +1191,7 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c } /** - * Name of the export file based on mode + * Name of the export file based on mode. * * @param string $output * Type of output. @@ -1963,7 +1963,7 @@ LIMIT $offset, $limit } /** - * Manipulate header rows for relationship fields + * Manipulate header rows for relationship fields. * * @param $headerRows * @param $contactRelationshipTypes diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index d168ab6d38..3abf15732a 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -60,7 +60,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { protected $_mappingId; /** - * Build the form object + * Build the form object. * * @return void */ @@ -104,7 +104,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -143,7 +143,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Export/Form/Select.php b/CRM/Export/Form/Select.php index 0add335d49..c9c1178ae0 100644 --- a/CRM/Export/Form/Select.php +++ b/CRM/Export/Form/Select.php @@ -39,7 +39,7 @@ class CRM_Export_Form_Select extends CRM_Core_Form { /** - * Various Contact types + * Various Contact types. */ const EXPORT_ALL = 1, @@ -49,7 +49,7 @@ class CRM_Export_Form_Select extends CRM_Core_Form { EXPORT_MERGE_HOUSEHOLD = 2; /** - * Export modes + * Export modes. */ const CONTACT_EXPORT = 1, @@ -62,7 +62,7 @@ class CRM_Export_Form_Select extends CRM_Core_Form { ACTIVITY_EXPORT = 8; /** - * Current export mode + * Current export mode. * * @var int */ @@ -71,7 +71,7 @@ class CRM_Export_Form_Select extends CRM_Core_Form { public $_componentTable; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * @@ -244,7 +244,7 @@ FROM {$this->_componentTable} } /** - * Build the form object + * Build the form object. * * @return void */ @@ -338,7 +338,7 @@ FROM {$this->_componentTable} } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -375,7 +375,7 @@ FROM {$this->_componentTable} } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ @@ -448,7 +448,7 @@ FROM {$this->_componentTable} } /** - * Build mapping form element + * Build mapping form element. */ public function buildMapping() { switch ($this->_exportMode) { diff --git a/CRM/Extension/Browser.php b/CRM/Extension/Browser.php index 84d0b55116..4d979ae9d0 100644 --- a/CRM/Extension/Browser.php +++ b/CRM/Extension/Browser.php @@ -37,7 +37,7 @@ class CRM_Extension_Browser { /** - * An URL for public extensions repository + * An URL for public extensions repository. */ const DEFAULT_EXTENSIONS_REPOSITORY = 'https://civicrm.org/extdir/ver={ver}|cms={uf}'; @@ -88,7 +88,7 @@ class CRM_Extension_Browser { } /** - * Determine whether downloading is supported + * Determine whether downloading is supported. * * @return array * List of error messages; empty if OK. @@ -118,7 +118,7 @@ class CRM_Extension_Browser { } /** - * Get a list of all available extensions + * Get a list of all available extensions. * * @return array * ($key => CRM_Extension_Info) @@ -141,7 +141,7 @@ class CRM_Extension_Browser { } /** - * Get a description of a particular extension + * Get a description of a particular extension. * * @param string $key * Fully-qualified extension name. @@ -325,7 +325,7 @@ class CRM_Extension_Browser { } /** - * A dummy function required for suppressing download errors + * A dummy function required for suppressing download errors. */ public static function downloadError($errorNumber, $errorString) { } diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php index a943188bf5..e7baa896fc 100644 --- a/CRM/Extension/Container/Basic.php +++ b/CRM/Extension/Container/Basic.php @@ -171,7 +171,7 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface } /** - * Determine the relative path of an extension directory + * Determine the relative path of an extension directory. * * @param string $key * Extension name. @@ -224,7 +224,7 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface } /** - * Determine the relative path of an extension directory + * Determine the relative path of an extension directory. * * @param string $key * Extension name. diff --git a/CRM/Extension/Container/Collection.php b/CRM/Extension/Container/Collection.php index 48b95aa0fd..f386c1b145 100644 --- a/CRM/Extension/Container/Collection.php +++ b/CRM/Extension/Container/Collection.php @@ -126,7 +126,7 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte } /** - * Get the container which defines a particular key + * Get the container which defines a particular key. * * @param string $key * Extension name. diff --git a/CRM/Extension/Container/Interface.php b/CRM/Extension/Container/Interface.php index 05b55a8282..a1d5a410f0 100644 --- a/CRM/Extension/Container/Interface.php +++ b/CRM/Extension/Container/Interface.php @@ -46,7 +46,7 @@ interface CRM_Extension_Container_Interface { public function checkRequirements(); /** - * Get a list of extensions available in this container + * Get a list of extensions available in this container. * * @return array * List of keys (strings). @@ -65,7 +65,7 @@ interface CRM_Extension_Container_Interface { public function getPath($key); /** - * Determine the base URL for resources provided by the extension + * Determine the base URL for resources provided by the extension. * * @param string $key * Fully-qualified extension name. diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php index a067cdad4b..dfb36abcad 100644 --- a/CRM/Extension/Downloader.php +++ b/CRM/Extension/Downloader.php @@ -57,7 +57,7 @@ class CRM_Extension_Downloader { } /** - * Determine whether downloading is supported + * Determine whether downloading is supported. * * @return array * list of error messages; empty if OK @@ -96,7 +96,7 @@ class CRM_Extension_Downloader { } /** - * Install or upgrade an extension from a remote URL + * Install or upgrade an extension from a remote URL. * * @param string $key * The name of the extension being installed. @@ -154,7 +154,7 @@ class CRM_Extension_Downloader { } /** - * Extract an extension from a zip file + * Extract an extension from a zip file. * * @param string $key * The name of the extension being installed; this usually matches the basedir in the .zip. diff --git a/CRM/Extension/Info.php b/CRM/Extension/Info.php index 3c6a9a6a4d..cc69e7044b 100644 --- a/CRM/Extension/Info.php +++ b/CRM/Extension/Info.php @@ -31,7 +31,7 @@ class CRM_Extension_Info { /** - * Extension info file name + * Extension info file name. */ const FILENAME = 'info.xml'; @@ -42,7 +42,7 @@ class CRM_Extension_Info { public $file = NULL; /** - * Load extension info an XML file + * Load extension info an XML file. * * @param $file * @@ -61,7 +61,7 @@ class CRM_Extension_Info { } /** - * Load extension info a string + * Load extension info a string. * * @param string $string * XML content. diff --git a/CRM/Extension/Manager.php b/CRM/Extension/Manager.php index 6429466ae0..7363612218 100644 --- a/CRM/Extension/Manager.php +++ b/CRM/Extension/Manager.php @@ -36,12 +36,12 @@ */ class CRM_Extension_Manager { /** - * The extension is fully installed and enabled + * The extension is fully installed and enabled. */ const STATUS_INSTALLED = 'installed'; /** - * The extension config has been applied to database but deactivated + * The extension config has been applied to database but deactivated. */ const STATUS_DISABLED = 'disabled'; @@ -331,7 +331,7 @@ class CRM_Extension_Manager { } /** - * Remove all database references to an extension + * Remove all database references to an extension. * * Add records of the extension to the database -- and enable it * @@ -382,7 +382,7 @@ class CRM_Extension_Manager { } /** - * Determine the status of an extension + * Determine the status of an extension. * * @param $key * @@ -400,7 +400,7 @@ class CRM_Extension_Manager { } /** - * Determine the status of all extensions + * Determine the status of all extensions. * * @return array * ($key => status_constant) diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index 53dd48d7dc..1b75620a52 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -178,7 +178,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * 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 0b1afae811..4409f6cfa5 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -49,12 +49,12 @@ class CRM_Extension_Mapper { /** - * An URL for public extensions repository + * An URL for public extensions repository. */ //const DEFAULT_EXTENSIONS_REPOSITORY = 'http://civicrm.org/extdir/ver={ver}|cms={uf}'; /** - * Extension info file name + * Extension info file name. */ const EXT_TEMPLATES_DIRNAME = 'templates'; @@ -325,7 +325,7 @@ class CRM_Extension_Mapper { } /** - * Get a list of base URLs for all active modules + * Get a list of base URLs for all active modules. * * @return array * (string $extKey => string $baseUrl) diff --git a/CRM/Extension/System.php b/CRM/Extension/System.php index 581761ba70..69ee2df785 100644 --- a/CRM/Extension/System.php +++ b/CRM/Extension/System.php @@ -46,7 +46,7 @@ class CRM_Extension_System { private $downloader = NULL; /** - * The URL of the remote extensions repository + * The URL of the remote extensions repository. * * @var string|FALSE */ @@ -108,7 +108,7 @@ class CRM_Extension_System { } /** - * Get a container which represents all available extensions + * Get a container which represents all available extensions. * * @return CRM_Extension_Container_Interface */ @@ -151,7 +151,7 @@ class CRM_Extension_System { } /** - * Get the container to which new extensions are installed + * Get the container to which new extensions are installed. * * This container should be a particular, writeable directory. * @@ -170,7 +170,7 @@ class CRM_Extension_System { } /** - * Get the service which provides runtime information about extensions + * Get the service which provides runtime information about extensions. * * @return CRM_Extension_Mapper */ @@ -182,7 +182,7 @@ class CRM_Extension_System { } /** - * Get the service for enabling and disabling extensions + * Get the service for enabling and disabling extensions. * * @return CRM_Extension_Manager */ @@ -252,7 +252,7 @@ class CRM_Extension_System { } /** - * Determine the URL which provides a feed of available extensions + * Determine the URL which provides a feed of available extensions. * * @return string|FALSE */ diff --git a/CRM/Extension/Upgrades.php b/CRM/Extension/Upgrades.php index e1ce7429cc..f412a54bf8 100644 --- a/CRM/Extension/Upgrades.php +++ b/CRM/Extension/Upgrades.php @@ -38,7 +38,7 @@ class CRM_Extension_Upgrades { const QUEUE_NAME = 'ext-upgrade'; /** - * Determine whether any extensions have pending upgrades + * Determine whether any extensions have pending upgrades. * * @return bool */ @@ -56,7 +56,7 @@ class CRM_Extension_Upgrades { } /** - * Fill a queue with upgrade tasks + * Fill a queue with upgrade tasks. * * @return CRM_Queue_Queue */ diff --git a/CRM/Financial/BAO/ExportFormat.php b/CRM/Financial/BAO/ExportFormat.php index fc8751c4ab..e968687a4c 100644 --- a/CRM/Financial/BAO/ExportFormat.php +++ b/CRM/Financial/BAO/ExportFormat.php @@ -41,19 +41,19 @@ class CRM_Financial_BAO_ExportFormat { /** - * data which the individual export formats will output in the desired format + * data which the individual export formats will output in the desired format. * @var array */ protected $_exportParams; /** - * smarty template + * smarty template. * @var CRM_Core_Smarty */ static protected $_template; /** - * Class constructor + * Class constructor. */ public function __construct() { if (!isset(self::$_template)) { @@ -62,7 +62,7 @@ class CRM_Financial_BAO_ExportFormat { } /** - * Override to assemble the appropriate subset of financial data for the specific export format + * Override to assemble the appropriate subset of financial data for the specific export format. * @param array $exportParams * * @return mixed @@ -105,7 +105,7 @@ class CRM_Financial_BAO_ExportFormat { } /** - * Override this if appropriate + * Override this if appropriate. * @return null */ public function getTemplateFileName() { diff --git a/CRM/Financial/BAO/ExportFormat/CSV.php b/CRM/Financial/BAO/ExportFormat/CSV.php index 88bd60d6f1..1e2e5325e7 100644 --- a/CRM/Financial/BAO/ExportFormat/CSV.php +++ b/CRM/Financial/BAO/ExportFormat/CSV.php @@ -46,7 +46,7 @@ class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat ); /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -147,7 +147,7 @@ class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat } /** - * Format table headers + * Format table headers. * * @param array $values * @return array @@ -164,7 +164,7 @@ class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat } /** - * Generate CSV array for export + * Generate CSV array for export. * * @param array $export */ diff --git a/CRM/Financial/BAO/ExportFormat/IIF.php b/CRM/Financial/BAO/ExportFormat/IIF.php index 6c0665979a..b1faed6770 100644 --- a/CRM/Financial/BAO/ExportFormat/IIF.php +++ b/CRM/Financial/BAO/ExportFormat/IIF.php @@ -50,7 +50,7 @@ class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat ); /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 2deedd5868..ce848d0dca 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -35,19 +35,19 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultContributionType = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -67,7 +67,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -82,7 +82,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Add the financial types + * Add the financial types. * * @param array $params * Reference array contains the values submitted by the form. @@ -116,7 +116,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Delete financial Types + * Delete financial Types. * * @param int $financialAccountId */ @@ -151,7 +151,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * Get accounting code for a financial type with account relation Income Account is + * Get accounting code for a financial type with account relation Income Account is. * * @param int $financialTypeId * @@ -174,7 +174,7 @@ WHERE cft.id = %1 } /** - * Get AR account + * Get AR account. * * @param $financialAccountId * Financial account id. diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index fc1772e13a..46602a06df 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -35,14 +35,14 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -62,7 +62,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Add the financial items and financial trxn + * Add the financial items and financial trxn. * * @param object $lineItem * Line item object. @@ -128,7 +128,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * 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. @@ -180,7 +180,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Takes an associative array and creates a entity financial transaction object + * Takes an associative array and creates a entity financial transaction object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -195,7 +195,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Retrive entity financial trxn details + * Retrive entity financial trxn details. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -231,7 +231,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Check if contact is present in financial_item table + * Check if contact is present in financial_item table. * * CRM-12929 * diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index f123b6fba5..df8b7c0027 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -35,19 +35,19 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultContributionType = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -67,7 +67,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -82,7 +82,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * Add the financial types + * Add the financial types. * * @param array $params * Reference array contains the values submitted by the form. @@ -114,7 +114,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * Delete financial Types + * Delete financial Types. * * @param int $financialTypeId * @@ -160,7 +160,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * fetch financial type having relationship as Income Account is + * fetch financial type having relationship as Income Account is. * * * @return array diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index d73aa779c2..8fa49e55a7 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -35,20 +35,20 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFinancialAccount { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Financial account + * Financial account. * @var array */ private static $financialAccount; /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -71,7 +71,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * Add the financial types + * Add the financial types. * * @param array $params * Reference array contains the values submitted by the form. @@ -100,7 +100,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * Delete financial Types + * Delete financial Types. * * @param int $financialTypeAccountId * @param int $accountId @@ -155,7 +155,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * Get Financial Account Name + * Get Financial Account Name. * * @param int $entityId * @@ -183,7 +183,7 @@ AND entity_id = %2"; } /** - * Financial Account for payment instrument + * Financial Account for payment instrument. * * @param int $paymentInstrumentValue * Payment instrument value. diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 962337af15..40ecf05f5c 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -43,7 +43,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces static $_defaultPaymentProcessor = NULL; /** - * Create Payment Processor + * Create Payment Processor. * * @param array $params * Parameters for Processor entity. @@ -85,16 +85,16 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. It also stores all the retrieved - * values in the default array + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -115,7 +115,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -131,7 +131,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Retrieve the default payment processor + * Retrieve the default payment processor. * * @return CRM_Financial_DAO_PaymentProcessor|null * The default payment processor object on success, @@ -147,7 +147,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Delete payment processor + * Delete payment processor. * * @param int $paymentProcessorID * @@ -173,7 +173,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Get the payment processor details + * Get the payment processor details. * * @param int $paymentProcessorID * Payment processor id. @@ -250,7 +250,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Build payment processor details + * Build payment processor details. * * @param object $dao * Payment processor object. @@ -388,7 +388,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Is there a processor on this site with the specified capability + * Is there a processor on this site with the specified capability. * @param array $capabilities * @param bool $isIncludeTest * diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 49e7a4fe82..7811eb5005 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -35,19 +35,19 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentProcessorType { /** - * Static holder for the default payment processor + * Static holder for the default payment processor. */ static $_defaultPaymentProcessorType = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -68,7 +68,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -84,7 +84,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * Retrieve the default payment processor + * Retrieve the default payment processor. * * @return object * The default payment processor object on success, @@ -168,7 +168,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * 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 636cb7be7f..b4592c364e 100644 --- a/CRM/Financial/Form/BatchTransaction.php +++ b/CRM/Financial/Form/BatchTransaction.php @@ -42,7 +42,7 @@ class CRM_Financial_Form_BatchTransaction extends CRM_Contribute_Form { static $_entityID; /** - * Batch status + * Batch status. * @var */ protected $_batchStatusId; @@ -73,7 +73,7 @@ class CRM_Financial_Form_BatchTransaction extends CRM_Contribute_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Financial/Form/Export.php b/CRM/Financial/Form/Export.php index 954c57c627..a5c29511bd 100644 --- a/CRM/Financial/Form/Export.php +++ b/CRM/Financial/Form/Export.php @@ -48,22 +48,22 @@ class CRM_Financial_Form_Export extends CRM_Core_Form { protected $_id; /** - * Financial batch ids + * Financial batch ids. */ protected $_batchIds = array(); /** - * Export status id + * Export status id. */ protected $_exportStatusId; /** - * Export format + * Export format. */ protected $_exportFormat; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -111,7 +111,7 @@ class CRM_Financial_Form_Export extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -150,7 +150,7 @@ class CRM_Financial_Form_Export extends CRM_Core_Form { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * @return void */ diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index ed9a003733..404b195456 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -40,7 +40,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** - * Flag if its a AR account type + * Flag if its a AR account type. * * @var boolean */ @@ -48,7 +48,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -75,7 +75,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -131,7 +131,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * posted values of the form @@ -189,7 +189,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * Process the form submission + * Process the form submission. * * @return void */ diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index 57bf620a95..047c780f24 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -47,7 +47,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { protected $_id; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -83,7 +83,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -171,7 +171,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * @param $files @@ -202,7 +202,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Process the form submission + * Process the form submission. * * @return void */ @@ -288,7 +288,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param $action * @param $permissions diff --git a/CRM/Financial/Form/FinancialType.php b/CRM/Financial/Form/FinancialType.php index 6679b83983..bc3b2c8506 100644 --- a/CRM/Financial/Form/FinancialType.php +++ b/CRM/Financial/Form/FinancialType.php @@ -40,7 +40,7 @@ class CRM_Financial_Form_FinancialType extends CRM_Contribute_Form { /** - * Build the form object + * Build the form object. * * @return void */ @@ -76,7 +76,7 @@ class CRM_Financial_Form_FinancialType extends CRM_Contribute_Form { } /** - * Process the form submission + * Process the form submission. * * @return void */ diff --git a/CRM/Financial/Form/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index a5c4152806..75e50e27c1 100644 --- a/CRM/Financial/Form/FinancialTypeAccount.php +++ b/CRM/Financial/Form/FinancialTypeAccount.php @@ -40,7 +40,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { /** - * The financial type id saved to the session for an update + * The financial type id saved to the session for an update. * * @var int */ @@ -54,21 +54,21 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { protected $_id; /** - * The name of the BAO object for this form + * The name of the BAO object for this form. * * @var string */ protected $_BAOName; /** - * Flag if its a AR account type + * Flag if its a AR account type. * * @var boolean */ protected $_isARFlag = FALSE; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -119,7 +119,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -230,7 +230,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * posted values of the form @@ -301,7 +301,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * Process the form submission + * Process the form submission. * * @return void */ diff --git a/CRM/Financial/Page/AJAX.php b/CRM/Financial/Page/AJAX.php index 61c702851d..f5698efeb6 100644 --- a/CRM/Financial/Page/AJAX.php +++ b/CRM/Financial/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Financial_Page_AJAX { /** - * 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 * * @param $config diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index e6922b5a9e..d8badfbb32 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -46,7 +46,7 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -56,14 +56,14 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * */ public function &links() { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -73,7 +73,7 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Financial/Page/BatchTransaction.php b/CRM/Financial/Page/BatchTransaction.php index 5c164c068e..540abb6e67 100644 --- a/CRM/Financial/Page/BatchTransaction.php +++ b/CRM/Financial/Page/BatchTransaction.php @@ -39,7 +39,7 @@ */ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -50,7 +50,7 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { static $_returnvalues = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -60,7 +60,7 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -119,7 +119,7 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { } /** - * Browse all financial batch transactions + * Browse all financial batch transactions. * * * @return void @@ -128,7 +128,7 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -138,7 +138,7 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Financial/Page/FinancialAccount.php b/CRM/Financial/Page/FinancialAccount.php index 74e83d25c4..2219d1dfb3 100644 --- a/CRM/Financial/Page/FinancialAccount.php +++ b/CRM/Financial/Page/FinancialAccount.php @@ -40,14 +40,14 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -57,7 +57,7 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -165,7 +165,7 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -175,7 +175,7 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Financial/Page/FinancialBatch.php b/CRM/Financial/Page/FinancialBatch.php index a1ff8ca5bf..8bd36347c3 100644 --- a/CRM/Financial/Page/FinancialBatch.php +++ b/CRM/Financial/Page/FinancialBatch.php @@ -39,14 +39,14 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * classname of BAO. @@ -56,7 +56,7 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -99,7 +99,7 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** - * Get name of edit form + * Get name of edit form. * * @return string * classname of edit form. @@ -109,7 +109,7 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Financial/Page/FinancialType.php b/CRM/Financial/Page/FinancialType.php index 8052e60bab..8f3335fa02 100644 --- a/CRM/Financial/Page/FinancialType.php +++ b/CRM/Financial/Page/FinancialType.php @@ -40,14 +40,14 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -57,7 +57,7 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -125,7 +125,7 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { } /** - * Browse all financial types + * Browse all financial types. * * * @return void @@ -191,7 +191,7 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -201,7 +201,7 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Financial/Page/FinancialTypeAccount.php b/CRM/Financial/Page/FinancialTypeAccount.php index 32dbec8bae..6ab2d7f021 100644 --- a/CRM/Financial/Page/FinancialTypeAccount.php +++ b/CRM/Financial/Page/FinancialTypeAccount.php @@ -38,21 +38,21 @@ */ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * The account id that we need to display for the browse screen + * The account id that we need to display for the browse screen. * * @var array */ protected $_aid = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -62,7 +62,7 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -118,7 +118,7 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { } /** - * Browse all Financial Type Account data + * Browse all Financial Type Account data. * * @return void */ diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index ffd92a48c9..8d0beacebc 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -45,7 +45,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Takes an associative array and creates a friend object + * Takes an associative array and creates a friend object. * * the function extract all the params it needs to initialize the create a * friend object. the params array could contain additional unused name/value @@ -86,7 +86,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Takes an associative array and creates a friend object + * Takes an associative array and creates a friend object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -233,7 +233,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Build the form object + * Build the form object. * * @param CRM_Core_Form $form * Form object. @@ -331,7 +331,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Takes an associative array and creates a tell a friend object + * Takes an associative array and creates a tell a friend object. * * the function extract all the params it needs to initialize the create/edit a * friend object. the params array could contain additional unused name/value diff --git a/CRM/Friend/Form.php b/CRM/Friend/Form.php index a5a2497e7c..9c7e40ee86 100644 --- a/CRM/Friend/Form.php +++ b/CRM/Friend/Form.php @@ -40,19 +40,19 @@ class CRM_Friend_Form extends CRM_Core_Form { /** - * Constants for number of friend contacts + * Constants for number of friend contacts. */ const NUM_OPTION = 3; /** - * The id of the entity that we are proceessing + * The id of the entity that we are proceessing. * * @var int */ protected $_entityId; /** - * The table name of the entity that we are proceessing + * The table name of the entity that we are proceessing. * * @var string */ @@ -61,7 +61,7 @@ class CRM_Friend_Form extends CRM_Core_Form { protected $_campaignId; /** - * The contact ID + * The contact ID. * * @var int */ @@ -174,7 +174,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -227,7 +227,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Validation + * Validation. * * @param array $fields * @@ -265,7 +265,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Friend/Form/Contribute.php b/CRM/Friend/Form/Contribute.php index af060a3bf0..ccf0c99929 100644 --- a/CRM/Friend/Form/Contribute.php +++ b/CRM/Friend/Form/Contribute.php @@ -40,7 +40,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { /** - * Tell a friend id in db + * Tell a friend id in db. * * @var int */ @@ -86,7 +86,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -103,7 +103,7 @@ class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Friend/Form/Event.php b/CRM/Friend/Form/Event.php index 89f093a93a..aac7ff1d1e 100644 --- a/CRM/Friend/Form/Event.php +++ b/CRM/Friend/Form/Event.php @@ -40,7 +40,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { /** - * Tell a friend id in db + * Tell a friend id in db. * * @var int */ @@ -88,7 +88,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -105,7 +105,7 @@ class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index 3b697eb8e9..58827dd868 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -35,20 +35,20 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** - * Static field for all the grant information that we can potentially export + * Static field for all the grant information that we can potentially export. * @var array */ static $_exportableFields = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Get events Summary + * Get events Summary. * * * @param bool $admin @@ -88,7 +88,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Get events Summary + * Get events Summary. * * * @return array @@ -110,7 +110,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -130,7 +130,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Add grant + * Add grant. * * @param array $params * Reference array contains the values submitted by the form. @@ -231,7 +231,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Create the event + * Create the event. * * @param array $params * Reference array contains the values submitted by the form. @@ -293,7 +293,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Delete the Contact + * Delete the Contact. * * @param int $id * Contact id. @@ -309,7 +309,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Delete the grant + * Delete the grant. * * @param int $id * Grant id. @@ -340,7 +340,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Combine all the exportable fields from the lower levels object + * Combine all the exportable fields from the lower levels object. * * @return array * array of exportable Fields @@ -397,7 +397,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Get grant record count for a Contact + * Get grant record count for a Contact. * * @param int $contactID * diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index ef705d7b87..f10860f476 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -43,7 +43,7 @@ class CRM_Grant_BAO_Query { } /** - * Build select for CiviGrant + * Build select for CiviGrant. * * @param $query * @@ -98,7 +98,7 @@ class CRM_Grant_BAO_Query { } /** - * Given a list of conditions in params generate the required + * Given a list of conditions in params generate the required. * where clause * * @param $query @@ -317,7 +317,7 @@ class CRM_Grant_BAO_Query { } /** - * Getter for the qill object + * Getter for the qill object. * * @return string */ @@ -356,7 +356,7 @@ class CRM_Grant_BAO_Query { } /** - * Add all the elements shared between grant search and advanaced search + * Add all the elements shared between grant search and advanaced search. * * * @param CRM_Core_Form $form diff --git a/CRM/Grant/Controller/Search.php b/CRM/Grant/Controller/Search.php index de4ab1561e..ebb415c375 100644 --- a/CRM/Grant/Controller/Search.php +++ b/CRM/Grant/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Grant_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Grant/Form/Grant.php b/CRM/Grant/Form/Grant.php index 4428b7d63a..7b36046e46 100644 --- a/CRM/Grant/Form/Grant.php +++ b/CRM/Grant/Form/Grant.php @@ -40,14 +40,14 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { /** - * The id of the case that we are proceessing + * The id of the case that we are proceessing. * * @var int */ protected $_id; /** - * The id of the contact associated with this contribution + * The id of the contact associated with this contribution. * * @var int */ @@ -56,7 +56,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { protected $_context; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -166,7 +166,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -254,7 +254,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Grant/Form/GrantView.php b/CRM/Grant/Form/GrantView.php index 8508dca8da..e34817bb98 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -126,7 +126,7 @@ class CRM_Grant_Form_GrantView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Grant/Form/Search.php b/CRM/Grant/Form/Search.php index 160beb12ed..1fca443bf6 100644 --- a/CRM/Grant/Form/Search.php +++ b/CRM/Grant/Form/Search.php @@ -43,35 +43,35 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_limit = NULL; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "grant_"; protected $_defaults; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -155,7 +155,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void @@ -265,7 +265,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { } /** - * Set the default form values + * Set the default form values. * * * @return array diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php index e102569b3a..a2c1d0f2a2 100644 --- a/CRM/Grant/Form/Task.php +++ b/CRM/Grant/Form/Task.php @@ -40,35 +40,35 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * The array that holds all the grant ids + * The array that holds all the grant ids. * * @var array */ protected $_grantIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * @@ -145,7 +145,7 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { } /** - * Simple shell that derived classes can call to add buttons to + * Simple shell that derived classes can call to add buttons to. * the form with a customized title for the main Submit * * @param string $title diff --git a/CRM/Grant/Form/Task/Delete.php b/CRM/Grant/Form/Task/Delete.php index 339c58019c..18703ab2cc 100644 --- a/CRM/Grant/Form/Task/Delete.php +++ b/CRM/Grant/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Grant_Form_Task_Delete extends CRM_Grant_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -63,7 +63,7 @@ class CRM_Grant_Form_Task_Delete extends CRM_Grant_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -73,7 +73,7 @@ class CRM_Grant_Form_Task_Delete extends CRM_Grant_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Grant/Form/Task/Print.php b/CRM/Grant/Form/Task/Print.php index 4a4cba8f73..0029937658 100644 --- a/CRM/Grant/Form/Task/Print.php +++ b/CRM/Grant/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Grant_Form_Task_Print extends CRM_Grant_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -93,7 +93,7 @@ class CRM_Grant_Form_Task_Print extends CRM_Grant_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Grant/Form/Task/Result.php b/CRM/Grant/Form/Task/Result.php index 81a8f5ef59..ed2d73a96e 100644 --- a/CRM/Grant/Form/Task/Result.php +++ b/CRM/Grant/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Grant_Form_Task_Result extends CRM_Grant_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -65,7 +65,7 @@ class CRM_Grant_Form_Task_Result extends CRM_Grant_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Grant/Form/Task/SearchTaskHookSample.php b/CRM/Grant/Form/Task/SearchTaskHookSample.php index 1115ae2633..a9ccdc7a77 100644 --- a/CRM/Grant/Form/Task/SearchTaskHookSample.php +++ b/CRM/Grant/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Grant_Form_Task_SearchTaskHookSample extends CRM_Grant_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -72,7 +72,7 @@ INNER JOIN civicrm_contact ct ON ( grt.contact_id = ct.id ) } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Grant/Form/Task/Update.php b/CRM/Grant/Form/Task/Update.php index a5b7ba053d..d2508547ff 100644 --- a/CRM/Grant/Form/Task/Update.php +++ b/CRM/Grant/Form/Task/Update.php @@ -41,7 +41,7 @@ class CRM_Grant_Form_Task_Update extends CRM_Grant_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -55,7 +55,7 @@ class CRM_Grant_Form_Task_Update extends CRM_Grant_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -76,7 +76,7 @@ class CRM_Grant_Form_Task_Update extends CRM_Grant_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Grant/Info.php b/CRM/Grant/Info.php index 1fd9082ab1..dd2c2e28e6 100644 --- a/CRM/Grant/Info.php +++ b/CRM/Grant/Info.php @@ -122,7 +122,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Grant/Page/Tab.php b/CRM/Grant/Page/Tab.php index f803992479..8025502e6c 100644 --- a/CRM/Grant/Page/Tab.php +++ b/CRM/Grant/Page/Tab.php @@ -40,7 +40,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -49,7 +49,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { public $_contactId = NULL; /** - * called when action is browse + * called when action is browse. * */ public function browse() { @@ -69,7 +69,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { } /** - * called when action is view + * called when action is view. * * @return null */ @@ -83,7 +83,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ @@ -97,7 +97,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { } /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 69ba77796e..a30d5d246f 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -77,28 +77,28 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co ); /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_limit = NULL; /** - * What context are we being invoked from + * What context are we being invoked from. * * @var string */ protected $_context = NULL; /** - * QueryParams is the array returned by exportValues called on + * QueryParams is the array returned by exportValues called on. * the HTML_QuickForm_Controller for that page. * * @var array @@ -106,28 +106,28 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_grantClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index ba2c64548a..7e9d0168ff 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -35,14 +35,14 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ protected $_task; /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action @@ -97,7 +97,7 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Group/Controller.php b/CRM/Group/Controller.php index d84a32dfed..95cba513c3 100644 --- a/CRM/Group/Controller.php +++ b/CRM/Group/Controller.php @@ -35,7 +35,7 @@ class CRM_Group_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php index 9b63a7ae7c..640fce0ede 100644 --- a/CRM/Group/Form/Edit.php +++ b/CRM/Group/Form/Edit.php @@ -81,7 +81,7 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { protected $_groupOrganizationID; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -209,7 +209,7 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -305,7 +305,7 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -366,7 +366,7 @@ WHERE title = %1 } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ @@ -434,7 +434,7 @@ WHERE title = %1 } /** - * Build parent groups form elements + * Build parent groups form elements. * * @param CRM_Core_Form $form * diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index bf3160855e..18020bfc4d 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 { } /** - * Define action links + * Define action links. * * self::$_links array of action links */ @@ -51,7 +51,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Return class name of edit form + * Return class name of edit form. * * @return string */ @@ -60,7 +60,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Return name of edit form + * Return name of edit form. * * @return string */ @@ -69,7 +69,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Return name of delete form + * Return name of delete form. * * @return string */ @@ -78,7 +78,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Return user context uri to return to + * Return user context uri to return to. * * @param null $mode * @@ -89,7 +89,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Return user context uri params + * Return user context uri params. * * @param null $mode * @@ -100,7 +100,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * Make sure that the user has permission to access this group + * Make sure that the user has permission to access this group. * * @param int $id * The id of the object. diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 559588dae6..27d69a49be 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -40,7 +40,7 @@ abstract class CRM_Import_DataSource { /** - * Provides information about the data source + * Provides information about the data source. * * @return array * collection of info about this data source @@ -48,7 +48,7 @@ abstract class CRM_Import_DataSource { abstract public function getInfo(); /** - * Set variables up before form is built + * Set variables up before form is built. */ abstract public function preProcess(&$form); @@ -65,7 +65,7 @@ abstract class CRM_Import_DataSource { abstract public function buildQuickForm(&$form); /** - * Process the form submission + * Process the form submission. */ abstract public function postProcess(&$params, &$db, &$form); diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 4c78e8797b..9161375097 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -37,7 +37,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { NUM_ROWS_TO_INSERT = 100; /** - * Provides information about the data source + * Provides information about the data source. * * @return array * collection of info about this data source @@ -47,7 +47,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * Set variables up before form is built + * Set variables up before form is built. */ public function preProcess(&$form) { } @@ -83,7 +83,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * Process the form submission + * Process the form submission. */ public function postProcess(&$params, &$db, &$form) { $file = $params['uploadFile']['name']; diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php index c6a5cb6f93..886b54cb68 100644 --- a/CRM/Import/DataSource/SQL.php +++ b/CRM/Import/DataSource/SQL.php @@ -35,7 +35,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { /** - * Provides information about the data source + * Provides information about the data source. * * @return array * collection of info about this data source @@ -45,7 +45,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { } /** - * Set variables up before form is built + * Set variables up before form is built. */ public function preProcess(&$form) { } @@ -88,7 +88,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { } /** - * Process the form submission + * Process the form submission. */ public function postProcess(&$params, &$db, &$form) { $importJob = new CRM_Contact_Import_ImportJob( diff --git a/CRM/Import/Form/MapField.php b/CRM/Import/Form/MapField.php index fda592821a..e8e29db211 100644 --- a/CRM/Import/Form/MapField.php +++ b/CRM/Import/Form/MapField.php @@ -92,7 +92,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { } /** - * Attempt to match header labels with our mapper fields + * Attempt to match header labels with our mapper fields. * * @param string $header * @param array $patterns @@ -116,7 +116,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { } /** - * Guess at the field names given the data and patterns from the schema + * Guess at the field names given the data and patterns from the schema. * * @param array $patterns * @param string $index diff --git a/CRM/Import/Form/Preview.php b/CRM/Import/Form/Preview.php index 179efb42a5..90af12d3ca 100644 --- a/CRM/Import/Form/Preview.php +++ b/CRM/Import/Form/Preview.php @@ -49,7 +49,7 @@ abstract class CRM_Import_Form_Preview extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Import/Form/Summary.php b/CRM/Import/Form/Summary.php index 6b993e1e76..52e179e6a0 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 { /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Import/Parser.php b/CRM/Import/Parser.php index 660ed55f84..31c1d63d64 100644 --- a/CRM/Import/Parser.php +++ b/CRM/Import/Parser.php @@ -192,7 +192,7 @@ abstract class CRM_Import_Parser { } /** - * Abstract function definitions + * Abstract function definitions. */ abstract protected function init(); @@ -231,7 +231,7 @@ abstract class CRM_Import_Parser { abstract protected function import($onDuplicate, &$values); /** - * Set and validate field values + * Set and validate field values. * * @param array $elements * array. @@ -265,7 +265,7 @@ abstract class CRM_Import_Parser { } /** - * 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 @@ -351,7 +351,7 @@ abstract class CRM_Import_Parser { } /** - * Setter function + * Setter function. * * @param int $max * @@ -362,7 +362,7 @@ abstract class CRM_Import_Parser { } /** - * Determines the file extension based on error code + * Determines the file extension based on error code. * * @var $type error code constant * @return string @@ -401,7 +401,7 @@ abstract class CRM_Import_Parser { } /** - * Determines the file name based on error code + * Determines the file name based on error code. * * @var $type error code constant * @return string diff --git a/CRM/Import/StateMachine.php b/CRM/Import/StateMachine.php index 038cf26866..846b2daa31 100644 --- a/CRM/Import/StateMachine.php +++ b/CRM/Import/StateMachine.php @@ -39,7 +39,7 @@ class CRM_Import_StateMachine extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action diff --git a/CRM/Mailing/BAO/BouncePattern.php b/CRM/Mailing/BAO/BouncePattern.php index fd3b756a25..d9432dab3e 100644 --- a/CRM/Mailing/BAO/BouncePattern.php +++ b/CRM/Mailing/BAO/BouncePattern.php @@ -40,14 +40,14 @@ class CRM_Mailing_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern { static $_patterns = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Build the static pattern array + * Build the static pattern array. * * @return void */ diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index 8563e5e3f5..7a632418a3 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -35,14 +35,14 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -62,7 +62,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -77,7 +77,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { } /** - * Create and Update mailing component + * Create and Update mailing component. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 5f09d9ae04..def033c034 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -910,7 +910,7 @@ ORDER BY i.contact_id, i.{$tempColumn} } /** - * Generate an event queue for a test job + * Generate an event queue for a test job. * * @param array $testParams * Contains form values. @@ -1020,7 +1020,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Static wrapper for getting verp and urls + * Static wrapper for getting verp and urls. * * @param int $job_id * ID of the Job associated with this message. @@ -1144,7 +1144,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Compose a message + * Compose a message. * * @param int $job_id * ID of the Job associated with this message. @@ -1532,7 +1532,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Add the mailings + * Add the mailings. * * @param array $params * Reference array contains the values submitted by the form. @@ -1757,7 +1757,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Replace the list of recipients on a given mailing + * Replace the list of recipients on a given mailing. * * @param int $mailingId * @param string $type @@ -1781,7 +1781,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Get hash value of the mailing + * Get hash value of the mailing. * * @param $id * @@ -2287,7 +2287,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * Get the count of mailings + * Get the count of mailings. * * @param * @@ -2394,7 +2394,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Get the rows for a browse operation + * Get the rows for a browse operation. * * @param int $offset * The row number to start from. @@ -2491,7 +2491,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Show detail Mailing report + * Show detail Mailing report. * * @param int $id * @@ -2502,7 +2502,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Delete Mails and all its associated records + * Delete Mails and all its associated records. * * @param int $id * Id of the mail to delete. @@ -2585,7 +2585,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Build the compose mail form + * Build the compose mail form. * * @param CRM_Core_Form $form * @@ -2679,7 +2679,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Build the compose PDF letter form + * Build the compose PDF letter form. * * @param CRM_Core_Form $form * @@ -2736,7 +2736,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Get the search based mailing Ids + * Get the search based mailing Ids. * * @return array * , searched base mailing ids. @@ -2972,7 +2972,7 @@ AND m.id = %1 } /** - * wrapper for ajax activity selector + * wrapper for ajax activity selector. * * @param array $params * Associated array for params record id. @@ -3059,7 +3059,7 @@ AND m.id = %1 } /** - * Retrieve contact mailing + * Retrieve contact mailing. * * @param array $params * @@ -3078,7 +3078,7 @@ AND m.id = %1 } /** - * Retrieve contact mailing count + * Retrieve contact mailing count. * * @param array $params * diff --git a/CRM/Mailing/BAO/MailingAB.php b/CRM/Mailing/BAO/MailingAB.php index 98d103b383..f56c74cd9e 100644 --- a/CRM/Mailing/BAO/MailingAB.php +++ b/CRM/Mailing/BAO/MailingAB.php @@ -39,14 +39,14 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { /** - * class constructor + * class constructor. */ public function __construct() { parent::__construct(); } /** - * Construct a new mailingab object + * Construct a new mailingab object. * * @params array $params * Form values. @@ -71,7 +71,7 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { } /** - * function to add the mailings + * function to add the mailings. * * @param array $params * Reference array contains the values submitted by the form. @@ -113,7 +113,7 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { /** - * Delete MailingAB and all its associated records + * Delete MailingAB and all its associated records. * * @param int $id * Id of the mail to delete. diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 4f5178e4df..d1c7cc0e56 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -50,7 +50,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { static $mailsProcessed = 0; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -220,7 +220,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } /** - * post process to determine if the parent job + * post process to determine if the parent job. * as well as the mailing is complete after the run * @param null $mode */ @@ -379,7 +379,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } /** - * Split the parent job into n number of child job based on an offset + * Split the parent job into n number of child job based on an offset. * If null or 0 , we create only one child job * @param int $offset */ @@ -471,7 +471,7 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) } /** - * Send the mailing + * Send the mailing. * * @param object $mailer * A Mail object to send the messages. @@ -811,7 +811,7 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) } /** - * Cancel a mailing + * Cancel a mailing. * * @param int $mailingId * The id of the mailing to be canceled. @@ -858,7 +858,7 @@ AND status IN ( 'Scheduled', 'Running', 'Paused' ) } /** - * Return a translated status enum string + * Return a translated status enum string. * * @param string $status * The status enum. diff --git a/CRM/Mailing/BAO/Query.php b/CRM/Mailing/BAO/Query.php index 7b3da4e6f7..0137a7b566 100644 --- a/CRM/Mailing/BAO/Query.php +++ b/CRM/Mailing/BAO/Query.php @@ -378,7 +378,7 @@ class CRM_Mailing_BAO_Query { } /** - * Add all the elements shared between Mailing search and advnaced search + * Add all the elements shared between Mailing search and advnaced search. * * * @param CRM_Core_Form $form diff --git a/CRM/Mailing/BAO/Recipients.php b/CRM/Mailing/BAO/Recipients.php index 4e56c2da6e..276a262480 100644 --- a/CRM/Mailing/BAO/Recipients.php +++ b/CRM/Mailing/BAO/Recipients.php @@ -35,7 +35,7 @@ class CRM_Mailing_BAO_Recipients extends CRM_Mailing_DAO_Recipients { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php index 71d1354632..9ed9818f3d 100644 --- a/CRM/Mailing/BAO/Spool.php +++ b/CRM/Mailing/BAO/Spool.php @@ -35,7 +35,7 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Mailing/BAO/TrackableURL.php b/CRM/Mailing/BAO/TrackableURL.php index 86aa45e969..a2e110669d 100644 --- a/CRM/Mailing/BAO/TrackableURL.php +++ b/CRM/Mailing/BAO/TrackableURL.php @@ -35,7 +35,7 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Config.php b/CRM/Mailing/Config.php index f517e5b380..ecdd849cb1 100644 --- a/CRM/Mailing/Config.php +++ b/CRM/Mailing/Config.php @@ -42,7 +42,7 @@ class CRM_Mailing_Config extends CRM_Core_Component_Config { const OUTBOUND_OPTION_REDIRECT_TO_DB = 5; /** - * What should be the verp separator we use + * What should be the verp separator we use. * * @var char */ diff --git a/CRM/Mailing/Controller/Send.php b/CRM/Mailing/Controller/Send.php index 287ed71ad2..153e89eabb 100644 --- a/CRM/Mailing/Controller/Send.php +++ b/CRM/Mailing/Controller/Send.php @@ -35,7 +35,7 @@ class CRM_Mailing_Controller_Send extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index 206a44ec4f..eb5b9aadf1 100755 --- a/CRM/Mailing/Event/BAO/Bounce.php +++ b/CRM/Mailing/Event/BAO/Bounce.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -123,7 +123,7 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -177,7 +177,7 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Confirm.php b/CRM/Mailing/Event/BAO/Confirm.php index 47c015722e..fce4b1eb5b 100644 --- a/CRM/Mailing/Event/BAO/Confirm.php +++ b/CRM/Mailing/Event/BAO/Confirm.php @@ -41,14 +41,14 @@ require_once 'Mail/mime.php'; class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Confirm a pending subscription + * Confirm a pending subscription. * * @param int $contact_id * The id of the contact. diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php index 403d242843..807d5db00a 100755 --- a/CRM/Mailing/Event/BAO/Delivered.php +++ b/CRM/Mailing/Event/BAO/Delivered.php @@ -35,14 +35,14 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Create a new delivery event + * Create a new delivery event. * * @param array $params * Associative array of delivery event values. @@ -81,7 +81,7 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -140,7 +140,7 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Forward.php b/CRM/Mailing/Event/BAO/Forward.php index 80018af16d..6fdaf5dfa6 100644 --- a/CRM/Mailing/Event/BAO/Forward.php +++ b/CRM/Mailing/Event/BAO/Forward.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -223,7 +223,7 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -277,7 +277,7 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 914fe31981..7cb56fcfe9 100755 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -35,14 +35,14 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Register an open event + * Register an open event. * * @param int $queue_id * The Queue Event ID of the recipient. @@ -68,7 +68,7 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -166,7 +166,7 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { } /** - * Get opened count for each mailing for a given set of mailing IDs and a specific contact + * Get opened count for each mailing for a given set of mailing IDs and a specific contact. * * @param int $mailingIDs * IDs of the mailing (comma separated). @@ -208,7 +208,7 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index cd2fa1ce38..2ef5898232 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -35,14 +35,14 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Queue a new recipient + * Queue a new recipient. * * @param array $params * Values of the new EventQueue. @@ -131,7 +131,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * Count up events given a mailing id and optional job id + * Count up events given a mailing id and optional job id. * * @param int $mailing_id * ID of the mailing to count. @@ -166,7 +166,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. @@ -251,7 +251,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * Get the mailing object for this queue event instance + * Get the mailing object for this queue event instance. * * @param * diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index bf25048f02..8ebbe99681 100644 --- a/CRM/Mailing/Event/BAO/Reply.php +++ b/CRM/Mailing/Event/BAO/Reply.php @@ -44,7 +44,7 @@ require_once 'ezc/autoload/mail_autoload.php'; class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -103,7 +103,7 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { } /** - * Forward a mailing reply + * Forward a mailing reply. * * @param int $queue_id * Queue event ID of the sender. @@ -211,7 +211,7 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { } /** - * Send an automated response + * Send an automated response. * * @param object $mailing * The mailing object. @@ -302,7 +302,7 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -356,7 +356,7 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index f606a35cfc..930261622b 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -42,7 +42,7 @@ require_once 'Mail/mime.php'; class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -176,7 +176,7 @@ SELECT civicrm_email.id as email_id } /** - * Verify the hash of a subscription event + * Verify the hash of a subscription event. * * @param int $contact_id * ID of the contact. @@ -301,7 +301,7 @@ SELECT civicrm_email.id as email_id } /** - * Get the domain object given a subscribe event + * Get the domain object given a subscribe event. * * @param int $subscribe_id * ID of the subscribe event. @@ -314,7 +314,7 @@ SELECT civicrm_email.id as email_id } /** - * Get the group details to which given email belongs + * Get the group details to which given email belongs. * * @param string $email * Email of the contact. @@ -365,7 +365,7 @@ SELECT civicrm_email.id as email_id } /** - * Send subscribe mail + * Send subscribe mail. * * @param array $groups * The list of group ids for subscribe. diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index dcadfa6bd5..70b00aa6f4 100755 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_TrackableURLOpen { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -96,7 +96,7 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -198,7 +198,7 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track } /** - * Get tracked url count for each mailing for a given set of mailing IDs + * Get tracked url count for each mailing for a given set of mailing IDs. * * @param int $mailingIDs * IDs of the mailing (comma separated). @@ -240,7 +240,7 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index da8f6d03b7..bbdd2e8537 100755 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -41,14 +41,14 @@ require_once 'Mail/mime.php'; class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscribe { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Unsubscribe a contact from the domain + * Unsubscribe a contact from the domain. * * @param int $job_id * The job ID. @@ -114,7 +114,7 @@ WHERE email = %2 } /** - * Unsubscribe a contact from all groups that received this mailing + * Unsubscribe a contact from all groups that received this mailing. * * @param int $job_id * The job ID. @@ -288,7 +288,7 @@ WHERE email = %2 } /** - * Send a reponse email informing the contact of the groups from which he + * Send a reponse email informing the contact of the groups from which he. * has been unsubscribed. * * @param string $queue_id @@ -412,7 +412,7 @@ WHERE email = %2 } /** - * Get row count for the event selector + * Get row count for the event selector. * * @param int $mailing_id * ID of the mailing. @@ -479,7 +479,7 @@ WHERE email = %2 } /** - * Get rows for the event browser + * Get rows for the event browser. * * @param int $mailing_id * ID of the mailing. diff --git a/CRM/Mailing/Form/Approve.php b/CRM/Mailing/Form/Approve.php index ebce0e735f..8771bb0ef6 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 { } /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -245,7 +245,7 @@ class CRM_Mailing_Form_Approve extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/Mailing/Form/Browse.php b/CRM/Mailing/Form/Browse.php index f8e714d1ab..56fdd6c152 100644 --- a/CRM/Mailing/Form/Browse.php +++ b/CRM/Mailing/Form/Browse.php @@ -67,7 +67,7 @@ class CRM_Mailing_Form_Browse extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Mailing/Form/Component.php b/CRM/Mailing/Form/Component.php index 32d1e8fad2..ae7596a96c 100644 --- a/CRM/Mailing/Form/Component.php +++ b/CRM/Mailing/Form/Component.php @@ -47,7 +47,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { protected $_id; /** - * The name of the BAO object for this form + * The name of the BAO object for this form. * * @var string */ @@ -59,7 +59,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -128,7 +128,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void @@ -150,7 +150,7 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { } /** - * 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 f5d1b18aed..b93eb7eeab 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 { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Mailing/Form/Group.php b/CRM/Mailing/Form/Group.php index 9909ad7286..fa32ee4eaa 100644 --- a/CRM/Mailing/Form/Group.php +++ b/CRM/Mailing/Form/Group.php @@ -40,14 +40,14 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { /** - * The mailing ID of the mailing if we are resuming a mailing + * The mailing ID of the mailing if we are resuming a mailing. * * @var integer */ protected $_mailingID; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -183,7 +183,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -541,7 +541,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { } /** - * Display Name of the form + * Display Name of the form. * * * @return string @@ -551,7 +551,7 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Mailing/Form/Schedule.php b/CRM/Mailing/Form/Schedule.php index ceea9a58f5..2635ff21fc 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -88,7 +88,7 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { } /** - * Build the form object for the last step of the mailing wizard + * Build the form object for the last step of the mailing wizard. * * @param * @@ -348,7 +348,7 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/Mailing/Form/Settings.php b/CRM/Mailing/Form/Settings.php index 21a7c31ec8..70950afbfb 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -99,7 +99,7 @@ class CRM_Mailing_Form_Settings extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -249,7 +249,7 @@ class CRM_Mailing_Form_Settings extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/Mailing/Form/Subscribe.php b/CRM/Mailing/Form/Subscribe.php index b8d9168046..8b701e62d3 100644 --- a/CRM/Mailing/Form/Subscribe.php +++ b/CRM/Mailing/Form/Subscribe.php @@ -76,7 +76,7 @@ SELECT title, description } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php index a2a6ced6da..94de4560cc 100644 --- a/CRM/Mailing/Form/Task.php +++ b/CRM/Mailing/Form/Task.php @@ -40,28 +40,28 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * diff --git a/CRM/Mailing/Form/Task/Print.php b/CRM/Mailing/Form/Task/Print.php index cfd35bc75f..2339dd8dd6 100644 --- a/CRM/Mailing/Form/Task/Print.php +++ b/CRM/Mailing/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Mailing_Form_Task_Print extends CRM_Mailing_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -93,7 +93,7 @@ class CRM_Mailing_Form_Task_Print extends CRM_Mailing_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index 1b2b6dc06a..ba492fffb2 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -376,7 +376,7 @@ ORDER BY e.is_bulkmail DESC, e.is_primary DESC } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index ff7833e627..7a57421c4c 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -201,7 +201,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -504,7 +504,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -681,7 +681,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/Mailing/Info.php b/CRM/Mailing/Info.php index 480e936d09..13f744e587 100644 --- a/CRM/Mailing/Info.php +++ b/CRM/Mailing/Info.php @@ -263,7 +263,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php index 6f3f644ca9..b50e70c7ae 100644 --- a/CRM/Mailing/MailStore.php +++ b/CRM/Mailing/MailStore.php @@ -84,7 +84,7 @@ class CRM_Mailing_MailStore { } /** - * Return all emails in the mail store + * Return all emails in the mail store. * * @return array * array of ezcMail objects @@ -100,7 +100,7 @@ class CRM_Mailing_MailStore { } /** - * Return the next X messages from the mail store + * Return the next X messages from the mail store. * * @param int $count * Number of messages to fetch (0 to fetch all). diff --git a/CRM/Mailing/MailStore/Imap.php b/CRM/Mailing/MailStore/Imap.php index d4aacc0068..450042306a 100644 --- a/CRM/Mailing/MailStore/Imap.php +++ b/CRM/Mailing/MailStore/Imap.php @@ -42,7 +42,7 @@ require_once 'ezc/autoload/mail_autoload.php'; class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { /** - * Connect to the supplied IMAP server and make sure the two mailboxes exist + * Connect to the supplied IMAP server and make sure the two mailboxes exist. * * @param string $host * Host to connect to. @@ -99,7 +99,7 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { } /** - * Move the specified message to the ignored folder + * Move the specified message to the ignored folder. * * @param int $nr * Number of the message to move. @@ -116,7 +116,7 @@ class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore { } /** - * Move the specified message to the processed folder + * Move the specified message to the processed folder. * * @param int $nr * Number of the message to move. diff --git a/CRM/Mailing/MailStore/Localdir.php b/CRM/Mailing/MailStore/Localdir.php index dfa634f780..ed988ee216 100644 --- a/CRM/Mailing/MailStore/Localdir.php +++ b/CRM/Mailing/MailStore/Localdir.php @@ -42,7 +42,7 @@ require_once 'ezc/autoload/mail_autoload.php'; class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** - * Connect to the supplied dir and make sure the two mail dirs exist + * Connect to the supplied dir and make sure the two mail dirs exist. * * @param string $dir * Dir to operate upon. @@ -67,7 +67,7 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { } /** - * Return the next X messages from the mail store + * Return the next X messages from the mail store. * FIXME: in CiviCRM 2.2 this always returns all the emails * * @param int $count @@ -125,7 +125,7 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local ignore folder + * Fetch the specified message to the local ignore folder. * * @param int $file * File location of the message to fetch. @@ -144,7 +144,7 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local processed folder + * Fetch the specified message to the local processed folder. * * @param int $file * File location of the message to fetch. diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php index 7ce192a403..cba1b5f5c4 100644 --- a/CRM/Mailing/MailStore/Maildir.php +++ b/CRM/Mailing/MailStore/Maildir.php @@ -42,7 +42,7 @@ require_once 'ezc/autoload/mail_autoload.php'; class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** - * Connect to the supplied dir and make sure the two mail dirs exist + * Connect to the supplied dir and make sure the two mail dirs exist. * * @param string $dir * Dir to operate upon. @@ -67,7 +67,7 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { } /** - * Return the next X messages from the mail store + * Return the next X messages from the mail store. * FIXME: in CiviCRM 2.2 this always returns all the emails * * @param int $count @@ -108,7 +108,7 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local ignore folder + * Fetch the specified message to the local ignore folder. * * @param int $file * File location of the message to fetch. @@ -127,7 +127,7 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local processed folder + * Fetch the specified message to the local processed folder. * * @param int $file * File location of the message to fetch. diff --git a/CRM/Mailing/MailStore/Mbox.php b/CRM/Mailing/MailStore/Mbox.php index fd768e8d31..9ebbc84edc 100644 --- a/CRM/Mailing/MailStore/Mbox.php +++ b/CRM/Mailing/MailStore/Mbox.php @@ -42,7 +42,7 @@ require_once 'ezc/autoload/mail_autoload.php'; class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { /** - * Connect to and lock the supplied file and make sure the two mail dirs exist + * Connect to and lock the supplied file and make sure the two mail dirs exist. * * @param string $file * Mbox to operate upon. @@ -86,7 +86,7 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local ignore folder + * Fetch the specified message to the local ignore folder. * * @param int $nr * Number of the message to fetch. @@ -104,7 +104,7 @@ class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local processed folder + * Fetch the specified message to the local processed folder. * * @param int $nr * Number of the message to fetch. diff --git a/CRM/Mailing/MailStore/Pop3.php b/CRM/Mailing/MailStore/Pop3.php index 4dbf594d30..cffb9fe6ef 100644 --- a/CRM/Mailing/MailStore/Pop3.php +++ b/CRM/Mailing/MailStore/Pop3.php @@ -79,7 +79,7 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local ignore folder + * Fetch the specified message to the local ignore folder. * * @param int $nr * Number of the message to fetch. @@ -97,7 +97,7 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore { } /** - * Fetch the specified message to the local processed folder + * Fetch the specified message to the local processed folder. * * @param int $nr * Number of the message to fetch. diff --git a/CRM/Mailing/Page/AJAX.php b/CRM/Mailing/Page/AJAX.php index 9812ab0fab..60e7d43e19 100644 --- a/CRM/Mailing/Page/AJAX.php +++ b/CRM/Mailing/Page/AJAX.php @@ -60,7 +60,7 @@ class CRM_Mailing_Page_AJAX { } /** - * 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 be2eb4931d..ca71f146f4 100644 --- a/CRM/Mailing/Page/Browse.php +++ b/CRM/Mailing/Page/Browse.php @@ -41,7 +41,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { /** - * All the fields that are listings related + * All the fields that are listings related. * * @var array */ @@ -67,7 +67,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { public $_archived; /** - * Scheduled mailing + * Scheduled mailing. * * @boolean */ diff --git a/CRM/Mailing/Page/Component.php b/CRM/Mailing/Page/Component.php index 625081fbd2..e588d43fa2 100644 --- a/CRM/Mailing/Page/Component.php +++ b/CRM/Mailing/Page/Component.php @@ -40,14 +40,14 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -57,7 +57,7 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -87,7 +87,7 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -97,7 +97,7 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Mailing/Page/Event.php b/CRM/Mailing/Page/Event.php index 526f8b8771..d39e35126e 100644 --- a/CRM/Mailing/Page/Event.php +++ b/CRM/Mailing/Page/Event.php @@ -41,7 +41,7 @@ class CRM_Mailing_Page_Event extends CRM_Core_Page { /** - * All the fields that are listings related + * All the fields that are listings related. * * @var array */ diff --git a/CRM/Mailing/Page/Report.php b/CRM/Mailing/Page/Report.php index 018616ad08..03adcfa276 100644 --- a/CRM/Mailing/Page/Report.php +++ b/CRM/Mailing/Page/Report.php @@ -41,7 +41,7 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic { public $_mailing_id; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO diff --git a/CRM/Mailing/Page/Tab.php b/CRM/Mailing/Page/Tab.php index e63a47ed8c..4dffe4a5d6 100644 --- a/CRM/Mailing/Page/Tab.php +++ b/CRM/Mailing/Page/Tab.php @@ -37,7 +37,7 @@ */ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ diff --git a/CRM/Mailing/Page/View.php b/CRM/Mailing/Page/View.php index 34dcd0a686..d6e0b9d5c2 100644 --- a/CRM/Mailing/Page/View.php +++ b/CRM/Mailing/Page/View.php @@ -42,7 +42,7 @@ class CRM_Mailing_Page_View extends CRM_Core_Page { protected $_contactID; /** - * Lets do permission checking here + * Lets do permission checking here. * First check for valid mailing, if false return fatal * Second check for visibility * Call a hook to see if hook wants to override visibility setting diff --git a/CRM/Mailing/PseudoConstant.php b/CRM/Mailing/PseudoConstant.php index 4b7750c227..12e4889142 100644 --- a/CRM/Mailing/PseudoConstant.php +++ b/CRM/Mailing/PseudoConstant.php @@ -63,7 +63,7 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { private static $defaultComponent; /** - * Get all the mailing components of a particular type + * Get all the mailing components of a particular type. * * @param $type * The type of component needed. @@ -102,7 +102,7 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Determine the default mailing component of a given type + * Determine the default mailing component of a given type. * * @param $type * The type of component needed. @@ -132,7 +132,7 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the mailing templates + * Get all the mailing templates. * * * @return array @@ -146,7 +146,7 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the completed mailing + * Get all the completed mailing. * * * @param null $mode diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index 3189ce9956..fcddb87b47 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -55,7 +55,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ protected $_parent; /** - * Class constructor + * Class constructor. * * * @return \CRM_Mailing_Selector_Browse @@ -206,7 +206,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index a81627a53b..4239df6609 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -81,7 +81,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C public $_columnHeaders; /** - * Class constructor + * Class constructor. * * @param string $event * The event type (queue/delivered/open...). @@ -338,7 +338,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index f50f13c1ca..f1d238bc14 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -109,28 +109,28 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_mailingClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -256,7 +256,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Mailing/StateMachine/Send.php b/CRM/Mailing/StateMachine/Send.php index ff2ac2ae60..2fbbfd7677 100644 --- a/CRM/Mailing/StateMachine/Send.php +++ b/CRM/Mailing/StateMachine/Send.php @@ -40,7 +40,7 @@ class CRM_Mailing_StateMachine_Send extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param CRM_Mailing_Controller $controller * @param \const|int $action diff --git a/CRM/Mailing/Task.php b/CRM/Mailing/Task.php index bf37207292..20654f2af8 100644 --- a/CRM/Mailing/Task.php +++ b/CRM/Mailing/Task.php @@ -103,7 +103,7 @@ class CRM_Mailing_Task { } /** - * These tasks are the core set of tasks that the user can perform + * These tasks are the core set of tasks that the user can perform. * on mailing recipients * * @param int $value diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index d238202464..20cc3a7f6b 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -35,7 +35,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { /** - * Static field for all the membership information that we can potentially import + * Static field for all the membership information that we can potentially import. * * @var array */ @@ -46,7 +46,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { static $_signupActType = NULL; /** - * Class constructor + * Class constructor. * * @return \CRM_Member_DAO_Membership */ @@ -57,7 +57,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { } /** - * Takes an associative array and creates a membership object + * Takes an associative array and creates a membership object. * * the function extracts all the params it needs to initialize the created * membership object. The params array could contain additional unused name/value @@ -224,7 +224,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { } /** - * Takes an associative array and creates a membership object + * Takes an associative array and creates a membership object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -437,7 +437,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { } /** - * Check the membership extended through relationship + * Check the membership extended through relationship. * * @param int $membershipId * Membership id. @@ -503,10 +503,9 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -668,7 +667,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Delete related memberships + * Delete related memberships. * * @param int $ownerMembershipId * @param int $contactId @@ -729,7 +728,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Build Membership Block in Contribution Pages + * Build Membership Block in Contribution Pages. * * @param CRM_Core_Form $form * Form object. @@ -934,7 +933,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Return Membership Block info in Contribution Pages + * Return Membership Block info in Contribution Pages. * * @param int $pageID * Contribution page id. @@ -972,7 +971,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Return a current membership of given contact + * Return a current membership of given contact. * NB: if more than one membership meets criteria, a randomly selected one is returned. * * @param int $contactID @@ -1071,7 +1070,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Combine all the importable fields from the lower levels object + * Combine all the importable fields from the lower levels object. * * @param string $contactType * Contact type. @@ -1136,7 +1135,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Get all exportable fields + * Get all exportable fields. * * @retun array return array of all exportable fields */ @@ -1265,7 +1264,7 @@ AND civicrm_membership.is_test = %2"; } /** - * Function check the status of the membership before adding membership for a contact + * Function check the status of the membership before adding membership for a contact. * * @param int $contactId * Contact id. @@ -1279,7 +1278,7 @@ AND civicrm_membership.is_test = %2"; } /** - * Process the Memberships + * Process the Memberships. * * @param array $membershipParams * Array of membership fields. @@ -1560,7 +1559,7 @@ AND civicrm_membership.is_test = %2"; } /** - * Method to fix membership status of stale membership + * Method to fix membership status of stale membership. * * This method first checks if the membership is stale. If it is, * then status will be updated based on existing start and end @@ -1653,7 +1652,7 @@ AND civicrm_membership.is_test = %2"; } /** - * Get the contribution page id from the membership record + * Get the contribution page id from the membership record. * * @param int $membershipID * @@ -1675,7 +1674,7 @@ SELECT c.contribution_page_id as pageID } /** - * Updated related memberships + * Updated related memberships. * * @param int $ownerMembershipId * Owner Membership Id. @@ -1699,7 +1698,7 @@ SELECT c.contribution_page_id as pageID } /** - * Get list of membership fields for profile + * Get list of membership fields for profile. * For now we only allow custom membership fields to be in * profile * @@ -1725,7 +1724,7 @@ SELECT c.contribution_page_id as pageID } /** - * Get the sort name of a contact for a particular membership + * Get the sort name of a contact for a particular membership. * * @param int $id * Id of the membership. @@ -1746,7 +1745,7 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id } /** - * Create memberships for related contacts + * Create memberships for related contacts. * takes into account the maximum related memberships * * @param array $params @@ -1919,7 +1918,7 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id } /** - * Delete the record that are associated with this Membership Payment + * Delete the record that are associated with this Membership Payment. * * @param int $membershipId * @@ -2003,7 +2002,7 @@ FROM civicrm_membership_type } /** - * Get membership record count for a Contact + * Get membership record count for a Contact. * * @param int $contactID * @param bool $activeOnly @@ -2058,7 +2057,7 @@ FROM civicrm_membership_type } /** - * Check whether subscription is already cancelled + * Check whether subscription is already cancelled. * * @param int $mid * Membership id. @@ -2185,7 +2184,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Where a second separate financial transaction is supported we will process it here + * Where a second separate financial transaction is supported we will process it here. * * @param int $contactID * @param CRM_Contribute_Form_Contribution_Confirm $form @@ -2307,7 +2306,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Turn array of errors into message string + * Turn array of errors into message string. * * @param array $errors * @@ -2323,7 +2322,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 + * Extract relevant values from the form so we can separate form logic from BAO logcis. * * @param CRM_Core_Form $form * @param $changeToday @@ -2661,7 +2660,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Retrieve the contribution id for the associated Membership id + * Retrieve the contribution id for the associated Membership id. * @todo we should get this off the line item * * @param int $membershipId @@ -2894,7 +2893,7 @@ WHERE civicrm_membership.is_test = 0"; } /** - * Record contribution record associated with membership + * Record contribution record associated with membership. * * @param array $params * Array of submitted params. @@ -2983,7 +2982,7 @@ WHERE civicrm_membership.is_test = 0"; } /** - * Record line items for default membership + * Record line items for default membership. * * @param CRM_Core_Form $qf * @param array $membershipType diff --git a/CRM/Member/BAO/MembershipBlock.php b/CRM/Member/BAO/MembershipBlock.php index 6580800f6e..e781533649 100644 --- a/CRM/Member/BAO/MembershipBlock.php +++ b/CRM/Member/BAO/MembershipBlock.php @@ -34,14 +34,14 @@ */ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * 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 { } /** - * Delete membership Blocks + * Delete membership Blocks. * * @param int $id * diff --git a/CRM/Member/BAO/MembershipLog.php b/CRM/Member/BAO/MembershipLog.php index 781e8c889e..c6392fd615 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 { /** - * Add the membership log record + * Add the membership log record. * * @param array $params * Reference array contains the values submitted by the form. @@ -56,7 +56,7 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { } /** - * Delete membership log record + * Delete membership log record. * * @param int $membershipID * diff --git a/CRM/Member/BAO/MembershipPayment.php b/CRM/Member/BAO/MembershipPayment.php index 581165c030..ca03afde57 100644 --- a/CRM/Member/BAO/MembershipPayment.php +++ b/CRM/Member/BAO/MembershipPayment.php @@ -36,14 +36,14 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Add the membership Payments + * Add the membership Payments. * * @param array $params * Reference array contains the values submitted by the form. @@ -85,7 +85,7 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment } /** - * Delete membership Payments + * Delete membership Payments. * * @param int $id * diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 55daadbac9..0fa83b3a05 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -35,19 +35,19 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** - * Static holder for the default LT + * Static holder for the default LT. */ static $_defaultMembershipStatus = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -67,7 +67,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -82,7 +82,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Takes an associative array and creates a membership Status object + * Takes an associative array and creates a membership Status object. * See http://wiki.civicrm.org/confluence/display/CRM/Database+layer * * @param array $params @@ -109,7 +109,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Add the membership types + * Add the membership types. * * @param array $params * Reference array contains the values submitted by the form. @@ -152,7 +152,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Get defaults for new entity + * Get defaults for new entity. * @return array */ public static function getDefaults() { @@ -165,7 +165,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Get membership status + * Get membership status. * * @param int $membershipStatusId * @@ -182,7 +182,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Delete membership Types + * Delete membership Types. * * @param int $membershipStatusId * @@ -375,7 +375,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Function that return the status ids whose is_current_member is set + * Function that return the status ids whose is_current_member is set. * * @return array */ diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index 30e872327f..bb3897884c 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -436,7 +436,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Does this membership start between the rollover date and the start of the next period + * Does this membership start between the rollover date and the start of the next period. * (in which case they will get an extra membership period) * ie if annual memberships run June - May & the rollover is in May memberships between * May and June will return TRUE and between June and May will return FALSE @@ -486,7 +486,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Calculate start date and end date for renewal membership + * Calculate start date and end date for renewal membership. * * @param int $membershipId * @param $changeToday @@ -598,7 +598,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Retrieve all Membership Types associated + * Retrieve all Membership Types associated. * with an Organization * * @param int $orgID @@ -620,7 +620,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Retrieve all Membership Types with Member of Contact id + * Retrieve all Membership Types with Member of Contact id. * * @param array $membershipTypes * array of membership type ids diff --git a/CRM/Member/Controller/Search.php b/CRM/Member/Controller/Search.php index a8eeaebd2e..ac64c676e3 100644 --- a/CRM/Member/Controller/Search.php +++ b/CRM/Member/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Member_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Member/Form.php b/CRM/Member/Form.php index 386f6fb5b2..cb933329be 100644 --- a/CRM/Member/Form.php +++ b/CRM/Member/Form.php @@ -118,7 +118,7 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index 315efb07db..8ef8bf90dc 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -52,7 +52,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { protected $_memTypeSelected; /** - * Display name of the member + * Display name of the member. * * @var string */ @@ -64,7 +64,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { protected $_memberEmail = NULL; /** - * Contact ID of the member + * Contact ID of the member. * * @var int */ @@ -90,7 +90,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { protected $_contributorContactID = NULL; /** - * ID of the person the receipt is to go to + * ID of the person the receipt is to go to. * * @var int */ @@ -372,7 +372,7 @@ class CRM_Member_Form_Membership extends CRM_Member_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -750,7 +750,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -992,7 +992,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Process the form submission + * Process the form submission. * * * @return void @@ -1714,7 +1714,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Send email receipt + * Send email receipt. * * @param CRM_Core_Form $form * Form object. diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index 7313ecc15c..1401097216 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -109,7 +109,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * Build the form object + * Build the form object. * * @return void */ @@ -215,7 +215,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -324,7 +324,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Member/Form/MembershipConfig.php b/CRM/Member/Form/MembershipConfig.php index 7c2e8c82f6..022a2a33e9 100644 --- a/CRM/Member/Form/MembershipConfig.php +++ b/CRM/Member/Form/MembershipConfig.php @@ -47,7 +47,7 @@ class CRM_Member_Form_MembershipConfig extends CRM_Core_Form { public $_id; /** - * The name of the BAO object for this form + * The name of the BAO object for this form. * * @var string */ @@ -98,7 +98,7 @@ class CRM_Member_Form_MembershipConfig extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php index 995bb83788..2a52f6934a 100644 --- a/CRM/Member/Form/MembershipRenewal.php +++ b/CRM/Member/Form/MembershipRenewal.php @@ -40,7 +40,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { /** - * Display name of the member + * Display name of the member. * * @var string */ @@ -52,7 +52,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { protected $_memberEmail = NULL; /** - * Contact ID of the member + * Contact ID of the member. * * * @var int @@ -266,7 +266,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -477,7 +477,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -511,7 +511,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * Process the renewal form + * Process the renewal form. * * * @return void diff --git a/CRM/Member/Form/MembershipStatus.php b/CRM/Member/Form/MembershipStatus.php index 1d80f51b61..de99bad67b 100644 --- a/CRM/Member/Form/MembershipStatus.php +++ b/CRM/Member/Form/MembershipStatus.php @@ -57,7 +57,7 @@ class CRM_Member_Form_MembershipStatus extends CRM_Member_Form_MembershipConfig } /** - * Build the form object + * Build the form object. * * @return void */ @@ -105,7 +105,7 @@ class CRM_Member_Form_MembershipStatus extends CRM_Member_Form_MembershipConfig } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php index ef83468912..5f0920f6a8 100644 --- a/CRM/Member/Form/MembershipType.php +++ b/CRM/Member/Form/MembershipType.php @@ -106,7 +106,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -209,7 +209,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -288,7 +288,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index c019ee1899..398d649c9b 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -40,14 +40,14 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Add context information at the end of a link + * Add context information at the end of a link. * * @return string * extra query parameters @@ -63,7 +63,7 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -89,7 +89,7 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { } /** - * Perform create or delete action on related memberships + * Perform create or delete action on related memberships. * * @param string $action * Create or delete. @@ -143,7 +143,7 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { } /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -393,7 +393,7 @@ SELECT r.id, c.id as cid, c.display_name as name, c.job_title as comment, } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Member/Form/Search.php b/CRM/Member/Form/Search.php index 26a1cddde3..2fc260218d 100644 --- a/CRM/Member/Form/Search.php +++ b/CRM/Member/Form/Search.php @@ -43,21 +43,21 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ @@ -66,12 +66,12 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "member_"; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -153,7 +153,7 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php index 25e507e2aa..f86cee5e96 100644 --- a/CRM/Member/Form/Task.php +++ b/CRM/Member/Form/Task.php @@ -40,42 +40,42 @@ class CRM_Member_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * The array that holds all the contact ids + * The array that holds all the contact ids. * * @var array */ public $_contactIds; /** - * The array that holds all the member ids + * The array that holds all the member ids. * * @var array */ protected $_memberIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * @@ -162,7 +162,7 @@ class CRM_Member_Form_Task extends CRM_Core_Form { } /** - * Simple shell that derived classes can call to add buttons to + * Simple shell that derived classes can call to add buttons to. * the form with a customized title for the main Submit * * @param string $title diff --git a/CRM/Member/Form/Task/Batch.php b/CRM/Member/Form/Task/Batch.php index 878fdbfe8d..8a34e38469 100644 --- a/CRM/Member/Form/Task/Batch.php +++ b/CRM/Member/Form/Task/Batch.php @@ -39,24 +39,24 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { /** - * The title of the group + * The title of the group. * * @var string */ protected $_title; /** - * Maximum profile fields that will be displayed + * Maximum profile fields that will be displayed. */ protected $_maxFields = 9; /** - * Variable to store redirect path + * Variable to store redirect path. */ protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -81,7 +81,7 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -203,7 +203,7 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/Delete.php b/CRM/Member/Form/Task/Delete.php index 10d76dec62..a661a50ba5 100644 --- a/CRM/Member/Form/Task/Delete.php +++ b/CRM/Member/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Member_Form_Task_Delete extends CRM_Member_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -62,7 +62,7 @@ class CRM_Member_Form_Task_Delete extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -72,7 +72,7 @@ class CRM_Member_Form_Task_Delete extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/Email.php b/CRM/Member/Form/Task/Email.php index fdbc4378e6..3a54414472 100644 --- a/CRM/Member/Form/Task/Email.php +++ b/CRM/Member/Form/Task/Email.php @@ -56,14 +56,14 @@ class CRM_Member_Form_Task_Email extends CRM_Member_Form_Task { public $_noEmails = FALSE; /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ public $_templates = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -78,7 +78,7 @@ class CRM_Member_Form_Task_Email extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -91,7 +91,7 @@ class CRM_Member_Form_Task_Email extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/Label.php b/CRM/Member/Form/Task/Label.php index 5742c0b6c2..47efebe95d 100644 --- a/CRM/Member/Form/Task/Label.php +++ b/CRM/Member/Form/Task/Label.php @@ -40,7 +40,7 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -51,7 +51,7 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -78,7 +78,7 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/PDFLetter.php b/CRM/Member/Form/Task/PDFLetter.php index 51f3966617..9c16fa2842 100644 --- a/CRM/Member/Form/Task/PDFLetter.php +++ b/CRM/Member/Form/Task/PDFLetter.php @@ -40,7 +40,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { /** - * All the existing templates in the system + * All the existing templates in the system. * * @var array */ @@ -51,7 +51,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { public $_cid = NULL; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -63,7 +63,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { } /** - * Set defaults + * Set defaults. * (non-PHPdoc) * @see CRM_Core_Form::setDefaultValues() */ @@ -72,7 +72,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -84,7 +84,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/PDFLetterCommon.php b/CRM/Member/Form/Task/PDFLetterCommon.php index f7df56021b..1ec2201939 100644 --- a/CRM/Member/Form/Task/PDFLetterCommon.php +++ b/CRM/Member/Form/Task/PDFLetterCommon.php @@ -7,7 +7,7 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon { /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * @todo this is horrible copy & paste code because there is so much risk of breakage * in fixing the existing pdfLetter classes to be suitably generic * @@ -44,7 +44,7 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLett } /** - * Generate htmlfor pdf letters + * Generate htmlfor pdf letters. * * @param array $membershipIDs * @param array $returnProperties diff --git a/CRM/Member/Form/Task/PickProfile.php b/CRM/Member/Form/Task/PickProfile.php index dc538ffa01..8f223965f2 100644 --- a/CRM/Member/Form/Task/PickProfile.php +++ b/CRM/Member/Form/Task/PickProfile.php @@ -56,7 +56,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { protected $_userContext; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -85,7 +85,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -108,7 +108,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { } /** - * Add local and global form rules + * Add local and global form rules. * * * @return void @@ -118,7 +118,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -131,7 +131,7 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/Print.php b/CRM/Member/Form/Task/Print.php index 41987d83b6..f3d8cff4f5 100644 --- a/CRM/Member/Form/Task/Print.php +++ b/CRM/Member/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Member_Form_Task_Print extends CRM_Member_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -93,7 +93,7 @@ class CRM_Member_Form_Task_Print extends CRM_Member_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Member/Form/Task/Result.php b/CRM/Member/Form/Task/Result.php index 0ddb832dcf..f0dd447ada 100644 --- a/CRM/Member/Form/Task/Result.php +++ b/CRM/Member/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Member_Form_Task_Result extends CRM_Member_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Member_Form_Task_Result extends CRM_Member_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Member/Form/Task/SearchTaskHookSample.php b/CRM/Member/Form/Task/SearchTaskHookSample.php index 0c34a12baf..009d8cba3b 100644 --- a/CRM/Member/Form/Task/SearchTaskHookSample.php +++ b/CRM/Member/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Member_Form_Task_SearchTaskHookSample extends CRM_Member_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -71,7 +71,7 @@ WHERE mem.id IN ( $memberIDs )"; } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Member/Import/Form/DataSource.php b/CRM/Member/Import/Form/DataSource.php index 4df02edad0..1f4cfbb96d 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -51,7 +51,7 @@ class CRM_Member_Import_Form_DataSource extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -148,7 +148,7 @@ class CRM_Member_Import_Form_DataSource extends CRM_Core_Form { } /** - * Process the uploaded file + * Process the uploaded file. * * @return void */ diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index 7cb81b7299..35fd50658e 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -40,7 +40,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * store contactType + * store contactType. * * @var int */ @@ -48,7 +48,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -111,7 +111,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -299,7 +299,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/Member/Import/Form/Preview.php b/CRM/Member/Import/Form/Preview.php index 8d2a31ad7c..8e5bc95eb5 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Member/Import/Form/Summary.php b/CRM/Member/Import/Form/Summary.php index dc2537cba8..b404f79cf6 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index 335458f624..64c694b0c1 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 { } /** - * 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 @@ -346,7 +346,7 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { } /** - * Store parser values + * Store parser values. * * @param CRM_Core_Session $store * @@ -402,7 +402,7 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { } /** - * Export data to a CSV file + * Export data to a CSV file. * * @param string $fileName * @param array $header diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index f57f9663bf..9107d979c3 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -56,7 +56,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { protected $_newMemberships; /** - * Class constructor + * Class constructor. */ public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -107,7 +107,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * Handle the values in mapField mode + * Handle the values in mapField mode. * * @param array $values * The array of values belonging to this line. @@ -119,7 +119,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * Handle the values in preview mode + * Handle the values in preview mode. * * @param array $values * The array of values belonging to this line. @@ -132,7 +132,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * Handle the values in summary mode + * Handle the values in summary mode. * * @param array $values * The array of values belonging to this line. @@ -247,7 +247,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * Handle the values in import mode + * Handle the values in import mode. * * @param int $onDuplicate * The code for what action to take on duplicates. diff --git a/CRM/Member/Info.php b/CRM/Member/Info.php index 82663f4437..1cf32e9d5a 100644 --- a/CRM/Member/Info.php +++ b/CRM/Member/Info.php @@ -173,7 +173,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts * @param $newCredit */ diff --git a/CRM/Member/Page/AJAX.php b/CRM/Member/Page/AJAX.php index bf3cf84984..b0af58aca7 100644 --- a/CRM/Member/Page/AJAX.php +++ b/CRM/Member/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Member_Page_AJAX { /** - * SetDefaults according to membership type + * SetDefaults according to membership type. */ public static function getMemberTypeDefaults() { if (!$_POST['mtype']) { diff --git a/CRM/Member/Page/MembershipStatus.php b/CRM/Member/Page/MembershipStatus.php index c29ffa0768..c72cd2b0de 100644 --- a/CRM/Member/Page/MembershipStatus.php +++ b/CRM/Member/Page/MembershipStatus.php @@ -41,14 +41,14 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -58,7 +58,7 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -180,7 +180,7 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -190,7 +190,7 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Member/Page/MembershipType.php b/CRM/Member/Page/MembershipType.php index 3450f702fe..8a943d6a37 100644 --- a/CRM/Member/Page/MembershipType.php +++ b/CRM/Member/Page/MembershipType.php @@ -39,7 +39,7 @@ class CRM_Member_Page_MembershipType extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -48,7 +48,7 @@ class CRM_Member_Page_MembershipType extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index e1306e09d9..87225197ae 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -35,7 +35,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -46,7 +46,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { public $_contactId = NULL; /** - * called when action is browse + * called when action is browse. */ public function browse() { $links = self::links('all', $this->_isPaymentProcessor, $this->_accessContribution); @@ -216,7 +216,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * called when action is view + * called when action is view. * * @return null */ @@ -234,7 +234,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ @@ -453,7 +453,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * Get action links + * Get action links. * * @param string $status * @param null $isPaymentProcessor @@ -546,7 +546,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * 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 @@ -572,7 +572,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * used for the to show the associated + * used for the to show the associated. * contribution for the membership * * @param int $contactId @@ -596,7 +596,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { } /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. diff --git a/CRM/Member/Page/UserDashboard.php b/CRM/Member/Page/UserDashboard.php index f1c4259a00..d97efb0484 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 { /** - * List memberships for the UF user + * List memberships for the UF user. * */ public function listMemberships() { diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index c233051079..d742bd5c6d 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -40,19 +40,19 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { /** - * Membership types + * Membership types. * @var array */ private static $membershipType; /** - * Membership types + * Membership types. * @var array */ private static $membershipStatus; /** - * Get all the membership types + * Get all the membership types. * * * @param int $id @@ -81,7 +81,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all the membership statuss + * Get all the membership statuss. * * * @param int $id diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index 2a97033565..13b977a93f 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -106,28 +106,28 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C public $_queryParams; /** - * Represent the type of selector + * Represent the type of selector. * * @var int */ protected $_action; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_memberClause = NULL; /** - * The query object + * The query object. * * @var string */ protected $_query; /** - * Class constructor + * Class constructor. * * @param array $queryParams * Array of parameters for query. @@ -305,7 +305,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index b7397cfde9..1e4e2356f1 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -35,7 +35,7 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { /** - * The task that the wizard is currently processing + * The task that the wizard is currently processing. * * @var string */ diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 321589e6be..d41a85154d 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -96,7 +96,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -160,7 +160,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -184,7 +184,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index abd5243d51..65e4e53734 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -84,7 +84,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -99,7 +99,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -141,7 +141,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index 31fb052e6b..7fd7b8abaa 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -90,7 +90,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -133,7 +133,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -175,7 +175,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index 4545b96f08..968933404d 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; /** - * Set variables up before form is built + * Set variables up before form is built. */ public function preProcess() { if ($this->_action & CRM_Core_Action::DELETE) { @@ -131,7 +131,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. */ public function buildQuickForm() { if ($this->_action & CRM_Core_Action::DELETE) { @@ -177,7 +177,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -192,7 +192,7 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { } /** - * Process the form + * Process the form. */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 08f96e7440..8bac834f12 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -39,7 +39,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { /** - * Variable defined for Contribution Page Id + * Variable defined for Contribution Page Id. */ public $_pageId = NULL; public $_id = NULL; @@ -53,7 +53,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { public $_single; /** - * The default values for the form + * The default values for the form. * * @var array */ @@ -137,7 +137,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -217,7 +217,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -243,7 +243,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index 9298a96926..bd62939a5f 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -39,14 +39,14 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -56,7 +56,7 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -356,7 +356,7 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -366,7 +366,7 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/PCP/StateMachine/PCP.php b/CRM/PCP/StateMachine/PCP.php index 0a60ca7d80..c85f302e9e 100644 --- a/CRM/PCP/StateMachine/PCP.php +++ b/CRM/PCP/StateMachine/PCP.php @@ -40,7 +40,7 @@ class CRM_PCP_StateMachine_PCP extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index a58a884be5..014a71faa9 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -35,25 +35,23 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { /** - * Static field for all the pledge information that we can potentially export + * Static field for all the pledge information that we can potentially export. * * @var array */ static $_exportableFields = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * pledge 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -73,7 +71,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * Add pledge + * Add pledge. * * @param array $params * Reference array contains the values submitted by the form. @@ -139,7 +137,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * Takes an associative array and creates a pledge object + * Takes an associative array and creates a pledge object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -259,7 +257,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * Delete the pledge + * Delete the pledge. * * @param int $id * Pledge id. @@ -448,7 +446,7 @@ GROUP BY currency } /** - * Get list of pledges In Honor of contact Ids + * Get list of pledges In Honor of contact Ids. * * @param int $honorId * In Honor of Contact ID. @@ -698,7 +696,7 @@ GROUP BY currency } /** - * Combine all the exportable fields from the lower levels object + * Combine all the exportable fields from the lower levels object. * * @return array * array of exportable Fields @@ -762,7 +760,7 @@ GROUP BY currency } /** - * Get pending or in progress pledges + * Get pending or in progress pledges. * * @param int $contactID * Contact id. @@ -810,7 +808,7 @@ GROUP BY currency } /** - * Get pledge record count for a Contact + * Get pledge record count for a Contact. * * @param int $contactID * @@ -1145,7 +1143,7 @@ SELECT pledge.contact_id as contact_id, } /** - * Get array of non transactional statuses + * Get array of non transactional statuses. * @return array * non transactional status ids */ @@ -1155,7 +1153,7 @@ SELECT pledge.contact_id as contact_id, } /** - * Get array of non transactional statuses + * Get array of non transactional statuses. * @return array * non transactional status ids */ diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 753b01c63f..7257488923 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -35,18 +35,16 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * pledgeBlock 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -66,7 +64,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Takes an associative array and creates a pledgeBlock object + * Takes an associative array and creates a pledgeBlock object. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -90,7 +88,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Add pledgeBlock + * Add pledgeBlock. * * @param array $params * Reference array contains the values submitted by the form. @@ -145,7 +143,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Delete the pledgeBlock + * Delete the pledgeBlock. * * @param int $id * PledgeBlock id. @@ -171,7 +169,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Return Pledge Block info in Contribution Pages + * Return Pledge Block info in Contribution Pages. * * @param int $pageID * Contribution page id. @@ -192,7 +190,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Build Pledge Block in Contribution Pages + * Build Pledge Block in Contribution Pages. * * @param CRM_Core_Form $form */ diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 7421881b28..d0e454762e 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -35,14 +35,14 @@ class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Get pledge payment details + * Get pledge payment details. * * @param int $pledgeId * Pledge id. @@ -162,7 +162,7 @@ WHERE pledge_id = %1 } /** - * Add pledge payment + * Add pledge payment. * * @param array $params * Associate array of field. @@ -199,11 +199,9 @@ WHERE pledge_id = %1 } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically the valid params are only - * pledge 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 + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -223,7 +221,7 @@ WHERE pledge_id = %1 } /** - * Delete pledge payment + * Delete pledge payment. * * @param int $id * @@ -250,7 +248,7 @@ WHERE pledge_id = %1 } /** - * Delete all pledge payments + * Delete all pledge payments. * * @param int $id * Pledge id. @@ -320,7 +318,7 @@ WHERE pledge_id = %1 } /** - * Update Pledge Payment Status + * Update Pledge Payment Status. * * @param int $pledgeID * , id of pledge. @@ -576,7 +574,7 @@ WHERE civicrm_pledge.id = %2 } /** - * Calculate the pledge status + * Calculate the pledge status. * * @param int $pledgeId * Pledge id. @@ -616,7 +614,7 @@ WHERE civicrm_pledge.id = %2 } /** - * Update pledge payment table + * Update pledge payment table. * * @param int $pledgeId * Pledge id. @@ -667,7 +665,7 @@ WHERE civicrm_pledge_payment.pledge_id = %1 } /** - * Update pledge payment table when reminder is sent + * Update pledge payment table when reminder is sent. * * @param int $paymentId * Payment id. @@ -684,7 +682,7 @@ WHERE civicrm_pledge_payment.id = {$paymentId} } /** - * Get oldest pending or in progress pledge payments + * Get oldest pending or in progress pledge payments. * * @param int $pledgeID * Pledge id. diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 89fc70d83a..3bac7c6c0f 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -42,7 +42,7 @@ class CRM_Pledge_BAO_Query { } /** - * Build select for Pledge + * Build select for Pledge. * * @param $query * @@ -460,7 +460,7 @@ class CRM_Pledge_BAO_Query { } /** - * Getter for the qill object + * Getter for the qill object. * * @return string */ @@ -469,7 +469,7 @@ class CRM_Pledge_BAO_Query { } /** - * Ideally this function should include fields that are displayed in the selector + * Ideally this function should include fields that are displayed in the selector. */ public static function defaultReturnProperties( $mode, @@ -504,7 +504,7 @@ class CRM_Pledge_BAO_Query { } /** - * This includes any extra fields that might need for export etc + * This includes any extra fields that might need for export etc. */ public static function extraReturnProperties($mode) { $properties = NULL; diff --git a/CRM/Pledge/Controller/Search.php b/CRM/Pledge/Controller/Search.php index d365375711..e0f3ae9ef1 100644 --- a/CRM/Pledge/Controller/Search.php +++ b/CRM/Pledge/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Pledge_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Pledge/Form/Payment.php b/CRM/Pledge/Form/Payment.php index 5d06b46867..9a20c7d75b 100644 --- a/CRM/Pledge/Form/Payment.php +++ b/CRM/Pledge/Form/Payment.php @@ -40,14 +40,14 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { /** - * The id of the pledge payment that we are proceessing + * The id of the pledge payment that we are proceessing. * * @var int */ public $_id; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -86,7 +86,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -129,7 +129,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index f665004540..05a29c3f22 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -41,26 +41,26 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { public $_action; /** - * The id of the pledge that we are proceessing + * The id of the pledge that we are proceessing. * * @var int */ public $_id; /** - * The id of the contact associated with this pledge + * The id of the contact associated with this pledge. * * @var int */ public $_contactID; /** - * The Pledge values if an existing pledge + * The Pledge values if an existing pledge. */ public $_values; /** - * The Pledge frequency Units + * The Pledge frequency Units. */ public $_freqUnits; @@ -70,7 +70,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { public $_isPending = FALSE; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -212,7 +212,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -444,7 +444,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -480,7 +480,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Pledge/Form/PledgeView.php b/CRM/Pledge/Form/PledgeView.php index 83cd422458..208143e716 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -131,7 +131,7 @@ class CRM_Pledge_Form_PledgeView extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index 5845128b23..0b997bc1fd 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -39,35 +39,35 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { /** - * The params that are sent to the query + * The params that are sent to the query. * * @var array */ protected $_queryParams; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_single = FALSE; /** - * Are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact. * * @var boolean */ protected $_limit = NULL; /** - * Prefix for the controller + * Prefix for the controller. */ protected $_prefix = "pledge_"; protected $_defaults; /** - * Processing needed for buildForm and later + * Processing needed for buildForm and later. * * @return void */ @@ -151,7 +151,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { } /** - * Build the form object + * Build the form object. * * * @return void @@ -291,7 +291,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -309,7 +309,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { } /** - * Set the default form values + * Set the default form values. * * * @return array diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 88633e5981..d7aec551ac 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -40,35 +40,35 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { /** - * The task being performed + * The task being performed. * * @var int */ protected $_task; /** - * The additional clause that we restrict the search with + * The additional clause that we restrict the search with. * * @var string */ protected $_componentClause = NULL; /** - * The array that holds all the component ids + * The array that holds all the component ids. * * @var array */ protected $_componentIds; /** - * The array that holds all the pledge ids + * The array that holds all the pledge ids. * * @var array */ protected $_pledgeIds; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @param * diff --git a/CRM/Pledge/Form/Task/Delete.php b/CRM/Pledge/Form/Task/Delete.php index 972dc5ed65..2bca8215a5 100644 --- a/CRM/Pledge/Form/Task/Delete.php +++ b/CRM/Pledge/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Pledge_Form_Task_Delete extends CRM_Pledge_Form_Task { protected $_single = FALSE; /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. */ public function preProcess() { //check for delete @@ -60,7 +60,7 @@ class CRM_Pledge_Form_Task_Delete extends CRM_Pledge_Form_Task { } /** - * Build the form object + * Build the form object. * * * @return void @@ -70,7 +70,7 @@ class CRM_Pledge_Form_Task_Delete extends CRM_Pledge_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Pledge/Form/Task/Print.php b/CRM/Pledge/Form/Task/Print.php index bc2051e136..1f4de0edf9 100644 --- a/CRM/Pledge/Form/Task/Print.php +++ b/CRM/Pledge/Form/Task/Print.php @@ -40,7 +40,7 @@ class CRM_Pledge_Form_Task_Print extends CRM_Pledge_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -94,7 +94,7 @@ class CRM_Pledge_Form_Task_Print extends CRM_Pledge_Form_Task { } /** - * Process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated. * * * @return void diff --git a/CRM/Pledge/Form/Task/Result.php b/CRM/Pledge/Form/Task/Result.php index b82dc4da1b..342a40f584 100644 --- a/CRM/Pledge/Form/Task/Result.php +++ b/CRM/Pledge/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Pledge_Form_Task_Result extends CRM_Pledge_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -49,7 +49,7 @@ class CRM_Pledge_Form_Task_Result extends CRM_Pledge_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Pledge/Form/Task/SearchTaskHookSample.php b/CRM/Pledge/Form/Task/SearchTaskHookSample.php index eab1c25ce1..2fa226b678 100644 --- a/CRM/Pledge/Form/Task/SearchTaskHookSample.php +++ b/CRM/Pledge/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Pledge_Form_Task_SearchTaskHookSample extends CRM_Pledge_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ @@ -69,7 +69,7 @@ INNER JOIN civicrm_contact ct ON ( plg.contact_id = ct.id ) } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php index d0c36c6056..1112f5000c 100644 --- a/CRM/Pledge/Info.php +++ b/CRM/Pledge/Info.php @@ -167,7 +167,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Pledge/Page/AJAX.php b/CRM/Pledge/Page/AJAX.php index a092d57dc7..186ef74f82 100755 --- a/CRM/Pledge/Page/AJAX.php +++ b/CRM/Pledge/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Pledge_Page_AJAX { /** - * Building Pledge Name combo box + * Building Pledge Name combo box. */ public static function pledgeName() { diff --git a/CRM/Pledge/Page/Payment.php b/CRM/Pledge/Page/Payment.php index 1851844588..3cb53af47f 100644 --- a/CRM/Pledge/Page/Payment.php +++ b/CRM/Pledge/Page/Payment.php @@ -77,7 +77,7 @@ class CRM_Pledge_Page_Payment extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ diff --git a/CRM/Pledge/Page/Tab.php b/CRM/Pledge/Page/Tab.php index 7b131f6335..4ef3efa5f1 100644 --- a/CRM/Pledge/Page/Tab.php +++ b/CRM/Pledge/Page/Tab.php @@ -37,7 +37,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { public $_contactId = NULL; /** - * called when action is browse + * called when action is browse. * * @return void */ @@ -64,7 +64,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { } /** - * called when action is view + * called when action is view. * * @return null */ @@ -81,7 +81,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { } /** - * called when action is update or new + * called when action is update or new. * * @return null */ diff --git a/CRM/Pledge/Page/UserDashboard.php b/CRM/Pledge/Page/UserDashboard.php index a7ad519538..502d43f9fb 100644 --- a/CRM/Pledge/Page/UserDashboard.php +++ b/CRM/Pledge/Page/UserDashboard.php @@ -35,7 +35,7 @@ class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** - * called when action is browse + * called when action is browse. * */ public function listPledges() { diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index 74fe68e380..4c62df0580 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -96,7 +96,7 @@ class CRM_Pledge_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/Pledge/Task.php b/CRM/Pledge/Task.php index d86fe05f47..d63c195f81 100644 --- a/CRM/Pledge/Task.php +++ b/CRM/Pledge/Task.php @@ -96,7 +96,7 @@ class CRM_Pledge_Task { } /** - * These tasks are the core set of task titles + * These tasks are the core set of task titles. * * @return array * the set of task titles @@ -111,7 +111,7 @@ class CRM_Pledge_Task { } /** - * These tasks get added based on the context the user is in + * These tasks get added based on the context the user is in. * * @return array * the set of optional tasks for a group of contacts diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index d07b4a0e7a..f056ed78a7 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -84,10 +84,9 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically, the valid params are only - * price_field_id. This is the inverse function of create. It also - * stores all of the retrieved values in the default array. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -123,7 +122,7 @@ AND li.entity_id = {$entityId} } /** - * Wrapper for line item retrieval when contribution ID is known + * Wrapper for line item retrieval when contribution ID is known. * @param int $contributionID * * @return array @@ -530,7 +529,7 @@ AND li.entity_id = {$entityId} } /** - * Calculate tax rate in percentage + * Calculate tax rate in percentage. * * @param array $lineItemId * An assoc array of lineItem. diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index dc7e7c0f44..ee0f698374 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -42,7 +42,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { protected $_options; /** - * Takes an associative array and creates a price field object + * Takes an associative array and creates a price field object. * * the function extract all the params it needs to initialize the create a * price field object. the params array could contain additional unused name/value @@ -67,7 +67,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Takes an associative array and creates a price field object + * Takes an associative array and creates a price field object. * * This function is invoked from within the web form layer and also from the api layer * @@ -168,7 +168,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -182,7 +182,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -226,7 +226,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * This function for building custom fields + * This function for building custom fields. * * @param CRM_Core_Form $qf * Form object (reference). @@ -569,7 +569,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Retrieve a list of options for the specified field + * Retrieve a list of options for the specified field. * * @param int $fieldId * Price field ID. @@ -684,7 +684,7 @@ WHERE } /** - * Validate the priceset + * Validate the priceset. * * @param int $priceSetId * , array $fields. diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 8818da7292..51e3e6f518 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -111,7 +111,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Get defaults for new entity + * Get defaults for new entity. * @return array */ public static function getDefaults() { @@ -123,8 +123,9 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array. @@ -138,7 +139,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Retrive the all values for given field id + * Retrive the all values for given field id. * * @param int $fieldId * Price_field_id. @@ -182,7 +183,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -198,7 +199,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Delete all values of the given field id + * Delete all values of the given field id. * * @param int $fieldId * Price field id. diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index cc55a91d12..711a561abd 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -40,21 +40,21 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { /** - * Static field for default price set details + * Static field for default price set details. * * @var array */ static $_defaultPriceSet = NULL; /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes an associative array and creates a price set object + * Takes an associative array and creates a price set object. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -77,7 +77,7 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -91,7 +91,7 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -274,7 +274,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Delete the price set + * Delete the price set. * * @param int $id * Price Set id. @@ -313,7 +313,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Link the price set with the specified table and id + * Link the price set with the specified table and id. * * @param string $entityTable * @param int $entityId @@ -342,7 +342,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Delete price set for the given entity and id + * Delete price set for the given entity and id. * * @param string $entityTable * @param int $entityId @@ -399,7 +399,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Find a price_set_id associated with the given option value or field ID + * Find a price_set_id associated with the given option value or field ID. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -431,7 +431,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Return an associative array of all price sets + * Return an associative array of all price sets. * * @param bool $withInactive * Whether or not to include inactive entries. @@ -476,7 +476,7 @@ WHERE ct.id = cp.financial_type_id AND } /** - * Get price set details + * Get price set details. * * An array containing price set details (including price fields) is returned * @@ -1076,7 +1076,7 @@ WHERE id = %1"; } /** - * Get field ids of a price set + * Get field ids of a price set. * * @param int $id * Price Set id. @@ -1143,7 +1143,7 @@ WHERE id = %1"; } /** - * check price set permission + * check price set permission. * * @param int $sid * The price set id. @@ -1223,7 +1223,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Check if auto renew option should be shown + * Check if auto renew option should be shown. * * @param int $priceSetId * Price set id. @@ -1272,7 +1272,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Retrieve auto renew frequency and interval + * Retrieve auto renew frequency and interval. * * @param int $priceSetId * Price set id. @@ -1304,7 +1304,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Update the is_quick_config flag in the db + * Update the is_quick_config flag in the db. * * @param int $id * Id of the database record. @@ -1405,7 +1405,7 @@ WHERE ps.id = %1 } /** - * Function to set tax_amount and tax_rate in LineItem + * Function to set tax_amount and tax_rate in LineItem. * * @param array $field * @param array $lineItem diff --git a/CRM/Price/Form/DeleteField.php b/CRM/Price/Form/DeleteField.php index 155bbb8a82..eae2e51f31 100644 --- a/CRM/Price/Form/DeleteField.php +++ b/CRM/Price/Form/DeleteField.php @@ -39,21 +39,21 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { /** - * The field id + * The field id. * * @var int */ protected $_fid; /** - * The title of the group being deleted + * The title of the group being deleted. * * @var string */ protected $_title; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void * @acess protected @@ -72,7 +72,7 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -92,7 +92,7 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Price/Form/DeleteSet.php b/CRM/Price/Form/DeleteSet.php index 34d6fc5801..5c82a97779 100644 --- a/CRM/Price/Form/DeleteSet.php +++ b/CRM/Price/Form/DeleteSet.php @@ -39,21 +39,21 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { /** - * The set id + * The set id. * * @var int */ protected $_sid; /** - * The title of the set being deleted + * The title of the set being deleted. * * @var string */ protected $_title; /** - * Set up variables to build the form + * Set up variables to build the form. * * @return void */ @@ -66,7 +66,7 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -87,7 +87,7 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { } /** - * Process the form when submitted + * Process the form when submitted. * * @return void */ diff --git a/CRM/Price/Form/Field.php b/CRM/Price/Form/Field.php index 1127e1e4c0..93352c624d 100644 --- a/CRM/Price/Form/Field.php +++ b/CRM/Price/Form/Field.php @@ -44,7 +44,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { const NUM_OPTION = 15; /** - * The custom set id saved to the session for an update + * The custom set id saved to the session for an update. * * @var int */ @@ -58,19 +58,19 @@ class CRM_Price_Form_Field extends CRM_Core_Form { protected $_fid; /** - * The extended component Id + * The extended component Id. * * @var array */ protected $_extendComponentId; /** - * Variable is set if price set is used for membership + * Variable is set if price set is used for membership. */ protected $_useForMember; /** - * Set variables up before form is built + * Set variables up before form is built. */ public function preProcess() { @@ -159,7 +159,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. */ public function buildQuickForm() { // lets trim all the whitespace @@ -372,7 +372,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -591,7 +591,7 @@ class CRM_Price_Form_Field extends CRM_Core_Form { } /** - * Process the form + * Process the form. */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Price/Form/Option.php b/CRM/Price/Form/Option.php index 8947d88306..3f815a6f7c 100644 --- a/CRM/Price/Form/Option.php +++ b/CRM/Price/Form/Option.php @@ -39,7 +39,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { /** - * The price field id saved to the session for an update + * The price field id saved to the session for an update. * * @var int */ @@ -53,7 +53,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { protected $_oid; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -108,7 +108,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -261,7 +261,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. @@ -285,7 +285,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Price/Form/Preview.php b/CRM/Price/Form/Preview.php index ac6675c5d1..d503ee80d5 100644 --- a/CRM/Price/Form/Preview.php +++ b/CRM/Price/Form/Preview.php @@ -44,7 +44,7 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { /** - * The group tree data + * The group tree data. * * @var array */ @@ -91,7 +91,7 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { } /** - * Set the default form values + * Set the default form values. * * @return array * the default array reference @@ -118,7 +118,7 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index a167af19fd..78fda20c4e 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -39,14 +39,14 @@ class CRM_Price_Form_Set extends CRM_Core_Form { /** - * The set id saved to the session for an update + * The set id saved to the session for an update. * * @var int */ protected $_sid; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -78,7 +78,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -110,7 +110,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -253,7 +253,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/Price/Page/Field.php b/CRM/Price/Page/Field.php index ad4db08f0b..67cce0858e 100644 --- a/CRM/Price/Page/Field.php +++ b/CRM/Price/Page/Field.php @@ -46,21 +46,21 @@ class CRM_Price_Page_Field extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * The price set group id of the field + * The price set group id of the field. * * @var int */ protected $_sid; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ private static $_actionLinks; /** - * The price set is reserved or not + * The price set is reserved or not. * * @var boolean */ @@ -325,7 +325,7 @@ class CRM_Price_Page_Field extends CRM_Core_Page { } /** - * Preview price field + * Preview price field. * * @param int $fid * diff --git a/CRM/Price/Page/Option.php b/CRM/Price/Page/Option.php index 3c8898f2a1..2630b75bae 100644 --- a/CRM/Price/Page/Option.php +++ b/CRM/Price/Page/Option.php @@ -46,28 +46,28 @@ class CRM_Price_Page_Option extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * The field id of the option + * The field id of the option. * * @var int */ protected $_fid; /** - * The field id of the option + * The field id of the option. * * @var int */ protected $_sid; /** - * The price set is reserved or not + * The price set is reserved or not. * * @var boolean */ protected $_isSetReserved = FALSE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index 19a7f9d248..a1e25e32f1 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -44,7 +44,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -194,7 +194,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { } /** - * Edit price set + * Edit price set. * * @param int $sid * Price set id. @@ -217,7 +217,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { } /** - * Preview price set + * Preview price set. * * @param int $sid * Price set id. @@ -241,7 +241,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { } /** - * Browse all price sets + * Browse all price sets. * * @param string $action * The action to be invoked. diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php index 47b300ff51..31e24a1691 100644 --- a/CRM/Profile/Form.php +++ b/CRM/Profile/Form.php @@ -53,14 +53,14 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_skipPermission = FALSE; /** - * The contact id that we are editing + * The contact id that we are editing. * * @var int */ protected $_id; /** - * The group id that we are editing + * The group id that we are editing. * * @var int */ @@ -72,40 +72,40 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_ufGroup = array('name' => 'unknown'); /** - * The group id that we are passing in url + * The group id that we are passing in url. * * @var int */ public $_grid; /** - * Name of button for saving matching contacts + * Name of button for saving matching contacts. * @var */ protected $_duplicateButtonName; /** - * The title of the category we are editing + * The title of the category we are editing. * * @var string */ protected $_title; /** - * The fields needed to build this form + * The fields needed to build this form. * * @var array */ public $_fields; /** - * store contact details + * store contact details. * * @var array */ protected $_contact; /** - * Do we allow updates of the contact + * Do we allow updates of the contact. * * @var int */ @@ -123,7 +123,7 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_context; /** - * THe contact type for registration case + * THe contact type for registration case. * * @var string */ @@ -145,7 +145,7 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_isContactActivityProfile = FALSE; /** - * Activity Id connected to the profile + * Activity Id connected to the profile. * * @var string */ @@ -588,7 +588,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -836,7 +836,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * Validate profile and provided activity Id + * Validate profile and provided activity Id. * * @param int $activityId * @param int $contactId @@ -876,7 +876,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -1354,7 +1354,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index b7bedd4bb0..0f857dd728 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -69,7 +69,7 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -91,7 +91,7 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. diff --git a/CRM/Profile/Form/Edit.php b/CRM/Profile/Form/Edit.php index bf6273635f..cdf0877261 100644 --- a/CRM/Profile/Form/Edit.php +++ b/CRM/Profile/Form/Edit.php @@ -138,7 +138,7 @@ SELECT module,is_reserved } /** - * Build the form object + * Build the form object. * * @return void */ @@ -302,7 +302,7 @@ SELECT module,is_reserved } /** - * 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 143438f092..b303bfd20f 100644 --- a/CRM/Profile/Form/Search.php +++ b/CRM/Profile/Form/Search.php @@ -56,7 +56,7 @@ class CRM_Profile_Form_Search extends CRM_Profile_Form { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -100,7 +100,7 @@ class CRM_Profile_Form_Search extends CRM_Profile_Form { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/Profile/Page/Dynamic.php b/CRM/Profile/Page/Dynamic.php index 31fc7601b1..44b28ecce7 100644 --- a/CRM/Profile/Page/Dynamic.php +++ b/CRM/Profile/Page/Dynamic.php @@ -44,28 +44,28 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { /** - * The contact id of the person we are viewing + * The contact id of the person we are viewing. * * @var int */ protected $_id; /** - * The profile group are are interested in + * The profile group are are interested in. * * @var int */ protected $_gid; /** - * The profile types we restrict this page to display + * The profile types we restrict this page to display. * * @var string */ protected $_restrict; /** - * Should we bypass permissions + * Should we bypass permissions. * * @var boolean */ @@ -85,7 +85,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { protected $_isContactActivityProfile = FALSE; /** - * Activity Id connected to the profile + * Activity Id connected to the profile. * * @var string */ @@ -101,7 +101,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { protected $_allFields = NULL; /** - * Class constructor + * Class constructor. * * @param int $id * The contact id. @@ -411,7 +411,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Profile/Page/Listings.php b/CRM/Profile/Page/Listings.php index f48a8a5964..c52d3a122f 100644 --- a/CRM/Profile/Page/Listings.php +++ b/CRM/Profile/Page/Listings.php @@ -403,7 +403,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { } /** - * Get the list of contacts for a profile + * Get the list of contacts for a profile. * * @param int $gid * @@ -487,7 +487,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Profile/Page/MultipleRecordFieldsListing.php b/CRM/Profile/Page/MultipleRecordFieldsListing.php index 2311d1c04a..453f008a18 100644 --- a/CRM/Profile/Page/MultipleRecordFieldsListing.php +++ b/CRM/Profile/Page/MultipleRecordFieldsListing.php @@ -35,7 +35,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -54,7 +54,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { protected $_contactType = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -64,7 +64,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -131,7 +131,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Run the page + * Run the page. * * This method is called after the page is created. It checks for the type * of action and executes that action. Finally it calls the parent's run @@ -164,7 +164,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Browse the listing + * Browse the listing. * * @return void */ @@ -413,7 +413,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * classname of edit form @@ -423,7 +423,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page @@ -433,7 +433,7 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { } /** - * Get user context + * Get user context. * * @param null $mode * diff --git a/CRM/Profile/Page/View.php b/CRM/Profile/Page/View.php index 68b8dfd360..dfe00697bf 100644 --- a/CRM/Profile/Page/View.php +++ b/CRM/Profile/Page/View.php @@ -40,14 +40,14 @@ class CRM_Profile_Page_View extends CRM_Core_Page { /** - * The id of the contact + * The id of the contact. * * @var int */ protected $_id; /** - * The group id that we are editing + * The group id that we are editing. * * @var int */ @@ -198,7 +198,7 @@ class CRM_Profile_Page_View extends CRM_Core_Page { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index 092b6a6da5..082a940d1b 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -56,63 +56,63 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR static $_columnHeaders; /** - * The sql params we use to get the list of contacts + * The sql params we use to get the list of contacts. * * @var string */ protected $_params; /** - * The public visible fields to be shown to the user + * The public visible fields to be shown to the user. * * @var array */ protected $_fields; /** - * The custom fields for this domain + * The custom fields for this domain. * * @var array */ protected $_customFields; /** - * Cache the query object + * Cache the query object. * * @var object */ protected $_query; /** - * Cache the expanded options list if any + * Cache the expanded options list if any. * * @var object */ protected $_options; /** - * The group id that we are editing + * The group id that we are editing. * * @var int */ protected $_gid; /** - * Do we enable mapping of users + * Do we enable mapping of users. * * @var boolean */ protected $_map; /** - * Do we enable edit link + * Do we enable edit link. * * @var boolean */ protected $_editLink; /** - * Should we link to the UF Profile + * Should we link to the UF Profile. * * @var boolean */ @@ -127,7 +127,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_multiRecordTableName = NULL; /** - * Class constructor + * Class constructor. * * @param array $params the params for the where clause * @param array $customFields @@ -416,7 +416,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * Return the qill for this selector + * Return the qill for this selector. * * @return string */ @@ -425,7 +425,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. @@ -743,7 +743,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * set the _multiRecordTableName to display the result set + * set the _multiRecordTableName to display the result set. * according to multi record custom field values */ public function setMultiRecordTableName($fields) { diff --git a/CRM/Queue/BAO/QueueItem.php b/CRM/Queue/BAO/QueueItem.php index c22a7976d0..bdf0e898df 100644 --- a/CRM/Queue/BAO/QueueItem.php +++ b/CRM/Queue/BAO/QueueItem.php @@ -41,7 +41,7 @@ class CRM_Queue_BAO_QueueItem extends CRM_Queue_DAO_QueueItem { /** - * Ensure that the required SQL table exists + * Ensure that the required SQL table exists. * * @return bool * TRUE if table now exists diff --git a/CRM/Queue/ErrorPolicy.php b/CRM/Queue/ErrorPolicy.php index 4a694a41a7..0d9e306b40 100644 --- a/CRM/Queue/ErrorPolicy.php +++ b/CRM/Queue/ErrorPolicy.php @@ -141,7 +141,7 @@ class CRM_Queue_ErrorPolicy { } /** - * Print a fatal error + * Print a fatal error. * * @param array $error * The PHP error (with "type", "message", etc). @@ -162,7 +162,7 @@ class CRM_Queue_ErrorPolicy { } /** - * Print an unhandled exception + * Print an unhandled exception. * * @param Exception $e * The unhandled exception. diff --git a/CRM/Queue/Page/AJAX.php b/CRM/Queue/Page/AJAX.php index 81a67d56a3..15277b024b 100644 --- a/CRM/Queue/Page/AJAX.php +++ b/CRM/Queue/Page/AJAX.php @@ -31,7 +31,7 @@ class CRM_Queue_Page_AJAX { /** - * Run the next task and return status information + * Run the next task and return status information. * * Outputs JSON: array( * is_error => bool, @@ -55,7 +55,7 @@ class CRM_Queue_Page_AJAX { } /** - * Run the next task and return status information + * Run the next task and return status information. * * Outputs JSON: array( * is_error => bool, @@ -79,7 +79,7 @@ class CRM_Queue_Page_AJAX { } /** - * Run the next task and return status information + * Run the next task and return status information. * * Outputs JSON: array( * is_error => bool, diff --git a/CRM/Queue/Queue.php b/CRM/Queue/Queue.php index 8a2253491c..c60897b0c9 100644 --- a/CRM/Queue/Queue.php +++ b/CRM/Queue/Queue.php @@ -60,7 +60,7 @@ abstract class CRM_Queue_Queue { } /** - * Determine the string name of this queue + * Determine the string name of this queue. * * @return string */ @@ -84,14 +84,14 @@ abstract class CRM_Queue_Queue { public abstract function deleteQueue(); /** - * Check if the queue exists + * Check if the queue exists. * * @return bool */ public abstract function existsQueue(); /** - * Add a new item to the queue + * Add a new item to the queue. * * @param mixed $data * Serializable PHP object or array. @@ -102,14 +102,14 @@ abstract class CRM_Queue_Queue { public abstract function createItem($data, $options = array()); /** - * Determine number of items remaining in the queue + * Determine number of items remaining in the queue. * * @return int */ public abstract function numberOfItems(); /** - * Get the next item + * Get the next item. * * @param int $lease_time * Seconds. @@ -131,7 +131,7 @@ abstract class CRM_Queue_Queue { public abstract function stealItem($lease_time = 3600); /** - * Remove an item from the queue + * Remove an item from the queue. * * @param object $item * The item returned by claimItem. @@ -139,7 +139,7 @@ abstract class CRM_Queue_Queue { public abstract function deleteItem($item); /** - * Return an item that could not be processed + * Return an item that could not be processed. * * @param object $item * The item returned by claimItem. diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index f91d5a9455..b2671c2dd3 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -87,7 +87,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Check if the queue exists + * Check if the queue exists. * * @return bool */ @@ -96,7 +96,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Add a new item to the queue + * Add a new item to the queue. * * @param mixed $data * Serializable PHP object or array. @@ -111,7 +111,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Determine number of items remaining in the queue + * Determine number of items remaining in the queue. * * @return int */ @@ -120,7 +120,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Get and remove the next item + * Get and remove the next item. * * @param int $leaseTime * Seconds. @@ -150,7 +150,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Get the next item + * Get the next item. * * @param int $leaseTime * Seconds. @@ -174,7 +174,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Remove an item from the queue + * Remove an item from the queue. * * @param object $item * The item returned by claimItem. @@ -185,7 +185,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { } /** - * Return an item that could not be processed + * Return an item that could not be processed. * * @param CRM_Core_DAO $item * The item returned by claimItem. diff --git a/CRM/Queue/Queue/Sql.php b/CRM/Queue/Queue/Sql.php index e7898ed573..f0a8ccf645 100644 --- a/CRM/Queue/Queue/Sql.php +++ b/CRM/Queue/Queue/Sql.php @@ -75,7 +75,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Check if the queue exists + * Check if the queue exists. * * @return bool */ @@ -84,7 +84,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Add a new item to the queue + * Add a new item to the queue. * * @param mixed $data * Serializable PHP object or array. @@ -102,7 +102,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Determine number of items remaining in the queue + * Determine number of items remaining in the queue. * * @return int */ @@ -117,7 +117,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Get the next item + * Get the next item. * * @param int $lease_time * Seconds. @@ -204,7 +204,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Remove an item from the queue + * Remove an item from the queue. * * @param CRM_Core_DAO $dao * The item returned by claimItem. @@ -215,7 +215,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { } /** - * Return an item that could not be processed + * Return an item that could not be processed. * * @param CRM_Core_DAO $dao * The item returned by claimItem. diff --git a/CRM/Queue/Service.php b/CRM/Queue/Service.php index c22a4bc0ed..15ce263d36 100644 --- a/CRM/Queue/Service.php +++ b/CRM/Queue/Service.php @@ -138,7 +138,7 @@ class CRM_Queue_Service { } /** - * Convert a queue "type" name to a class name + * Convert a queue "type" name to a class name. * * @param string $type * E.g. "interactive", "immediate", "stomp", "beanstalk". diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php index 4117d91633..8525c055c7 100644 --- a/CRM/Queue/Task.php +++ b/CRM/Queue/Task.php @@ -31,12 +31,12 @@ class CRM_Queue_Task { /** - * Task was performed successfully + * Task was performed successfully. */ const TASK_SUCCESS = 1; /** - * Task failed and should not be retried + * Task failed and should not be retried. */ const TASK_FAIL = 2; @@ -71,7 +71,7 @@ class CRM_Queue_Task { } /** - * Perform the task + * Perform the task. * * @param array $taskCtx * Array with keys: diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php index 03b4beebd4..80cab12969 100644 --- a/CRM/Report/BAO/Hook.php +++ b/CRM/Report/BAO/Hook.php @@ -45,7 +45,7 @@ class CRM_Report_BAO_Hook { protected $_queryObjects = NULL; /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * @return object */ diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 06f00b03d5..3e184f5945 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -35,7 +35,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { /** - * Takes an associative array and creates an instance object + * Takes an associative array and creates an instance object. * * the function extract all the params it needs to initialize the create a * instance object. the params array could contain additional unused name/value @@ -118,7 +118,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { } /** - * 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 @@ -224,7 +224,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { } /** - * Delete the instance of the Report + * Delete the instance of the Report. * * @param int $id * diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 2c7f21fddc..10ebe04f10 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -3027,7 +3027,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -3041,7 +3041,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND } /** - * Compile the report content + * Compile the report content. * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes. * * @return string @@ -3251,7 +3251,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND } /** - * Generate Membership Type SQL Clause + * Generate Membership Type SQL Clause. * @param mixed $value * @param string $op * @@ -3649,7 +3649,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause + * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause. * (building the array if it's unset) * * @return array @@ -3863,7 +3863,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Do AlterDisplay processing on Address Fields + * Do AlterDisplay processing on Address Fields. * * @param $row * @param $rows @@ -3948,7 +3948,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Add Address into From Table if required + * Add Address into From Table if required. */ public function addAddressFromClause() { // include address field if address column is to be included @@ -3966,7 +3966,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Add Phone into From Table if required + * Add Phone into From Table if required. */ public function addPhoneFromClause() { // include address field if address column is to be included @@ -3981,7 +3981,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Get phone columns to add to array + * Get phone columns to add to array. * * @param array $options * - prefix Prefix to add to table (in case of more than one instance of the table) @@ -4013,7 +4013,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Get address columns to add to array + * Get address columns to add to array. * * @param array $options * - prefix Prefix to add to table (in case of more than one instance of the table) @@ -4069,7 +4069,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * function used for showing charts on print screen + * function used for showing charts on print screen. */ public static function uploadChartImage() { // upload strictly for '.png' images @@ -4103,7 +4103,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * Apply common settings to entityRef fields + * Apply common settings to entityRef fields. * * @param array $field * @param string $table diff --git a/CRM/Report/Form/Contribute/HouseholdSummary.php b/CRM/Report/Form/Contribute/HouseholdSummary.php index f58f95fde5..d62ed23804 100644 --- a/CRM/Report/Form/Contribute/HouseholdSummary.php +++ b/CRM/Report/Form/Contribute/HouseholdSummary.php @@ -360,7 +360,7 @@ class CRM_Report_Form_Contribute_HouseholdSummary extends CRM_Report_Form { } /** - * Set variables to be accessed by API and form layer in processing + * Set variables to be accessed by API and form layer in processing. */ public function beginPostProcessCommon() { $getRelationship = $this->_params['relationship_type_id_value']; diff --git a/CRM/Report/Form/Contribute/OrganizationSummary.php b/CRM/Report/Form/Contribute/OrganizationSummary.php index dce09084ec..09c8874b51 100644 --- a/CRM/Report/Form/Contribute/OrganizationSummary.php +++ b/CRM/Report/Form/Contribute/OrganizationSummary.php @@ -361,7 +361,7 @@ class CRM_Report_Form_Contribute_OrganizationSummary extends CRM_Report_Form { } /** - * Set variables to be accessed by API and form layer in processing + * Set variables to be accessed by API and form layer in processing. */ public function beginPostProcessCommon() { $getRelationship = $this->_params['relationship_type_id_value']; diff --git a/CRM/Report/Form/Event/ParticipantListCount.php b/CRM/Report/Form/Event/ParticipantListCount.php index a18658ada8..afc32b66f2 100644 --- a/CRM/Report/Form/Event/ParticipantListCount.php +++ b/CRM/Report/Form/Event/ParticipantListCount.php @@ -270,7 +270,7 @@ class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event { } /** - * Add The statistics + * Add The statistics. * @param $rows * * @return array diff --git a/CRM/Report/Form/Event/Summary.php b/CRM/Report/Form/Event/Summary.php index a99de4caf6..9356921210 100644 --- a/CRM/Report/Form/Event/Summary.php +++ b/CRM/Report/Form/Event/Summary.php @@ -181,7 +181,7 @@ class CRM_Report_Form_Event_Summary extends CRM_Report_Form_Event { } /** - * get participants information for events + * get participants information for events. * @return array */ public function participantInfo() { diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index 88a3279099..7effc2e172 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -704,7 +704,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** - * Get address columns to add to array + * Get address columns to add to array. * * @param array $options * Options for the report. @@ -915,7 +915,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** - * Get Information about advertised Joins + * Get Information about advertised Joins. * * @return array */ @@ -1031,7 +1031,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** - * Define join from line item table to participant table + * Define join from line item table to participant table. */ public function joinParticipantFromLineItem() { $this->_from .= " LEFT JOIN civicrm_participant {$this->_aliases['civicrm_participant']} @@ -1056,7 +1056,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** - * Define join from Participant to Contribution table + * Define join from Participant to Contribution table. */ public function joinContributionFromParticipant() { $this->_from .= " LEFT JOIN civicrm_participant_payment pp @@ -1067,7 +1067,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** - * Define join from Membership to Contribution table + * Define join from Membership to Contribution table. */ public function joinContributionFromMembership() { $this->_from .= " LEFT JOIN civicrm_membership_payment pp @@ -1218,7 +1218,7 @@ WHERE line_item_civireport.id IS NOT NULL } /** - * Retrieve text for financial type from pseudoconstant + * Retrieve text for financial type from pseudoconstant. * * @param $value * @param array $row @@ -1236,7 +1236,7 @@ WHERE line_item_civireport.id IS NOT NULL } /** - * Retrieve text for contribution type from pseudoconstant + * Retrieve text for contribution type from pseudoconstant. * * @param $value * @param array $row @@ -1248,7 +1248,7 @@ WHERE line_item_civireport.id IS NOT NULL } /** - * Retrieve text for contribution status from pseudoconstant + * Retrieve text for contribution status from pseudoconstant. * * @param $value * @param array $row @@ -1260,7 +1260,7 @@ WHERE line_item_civireport.id IS NOT NULL } /** - * Retrieve text for payment instrument from pseudoconstant + * Retrieve text for payment instrument from pseudoconstant. * * @param $value * @param array $row diff --git a/CRM/Report/Form/Mailing/Summary.php b/CRM/Report/Form/Mailing/Summary.php index 82d5381e0f..0e0974c1c8 100644 --- a/CRM/Report/Form/Mailing/Summary.php +++ b/CRM/Report/Form/Mailing/Summary.php @@ -277,7 +277,7 @@ class CRM_Report_Form_Mailing_Summary extends CRM_Report_Form { } /** - * manipulate the select function to query count functions + * manipulate the select function to query count functions. */ public function select() { diff --git a/CRM/Report/Form/Pledge/Detail.php b/CRM/Report/Form/Pledge/Detail.php index f49c955fb6..63513c60dd 100644 --- a/CRM/Report/Form/Pledge/Detail.php +++ b/CRM/Report/Form/Pledge/Detail.php @@ -207,7 +207,7 @@ class CRM_Report_Form_Pledge_Detail extends CRM_Report_Form { } /** - * If we are retrieving total paid we need to define the inclusion of pledge_payment + * If we are retrieving total paid we need to define the inclusion of pledge_payment. * * @param string $tableName * @param $tableKey diff --git a/CRM/Report/Form/Register.php b/CRM/Report/Form/Register.php index a04b98c73b..16b658ad8a 100644 --- a/CRM/Report/Form/Register.php +++ b/CRM/Report/Form/Register.php @@ -54,7 +54,7 @@ class CRM_Report_Form_Register extends CRM_Core_Form { } /** - * This virtual function is used to set the default values of + * This virtual function is used to set the default values of. * various form elements * * access public @@ -173,7 +173,7 @@ class CRM_Report_Form_Register extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php index d6e09597d0..3c4719466f 100644 --- a/CRM/Report/Info.php +++ b/CRM/Report/Info.php @@ -172,7 +172,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } /** - * add shortcut to Create New + * add shortcut to Create New. * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php index 99b4a43cc7..2e601c2edb 100644 --- a/CRM/Report/Interface.php +++ b/CRM/Report/Interface.php @@ -35,14 +35,14 @@ interface CRM_Report_Interface { /** - * The constructor gets the submitted form values + * The constructor gets the submitted form values. * * @param $formValues */ public function __construct(&$formValues); /** - * Builds the quickform for this search + * Builds the quickform for this search. * @param $form */ public function buildForm(&$form); @@ -92,22 +92,22 @@ interface CRM_Report_Interface { */ /** - * The from clause for the query + * The from clause for the query. */ public function from(); /** - * The where clause for the query + * The where clause for the query. */ public function where($includeContactIDs = FALSE); /** - * The template FileName to use to display the results + * The template FileName to use to display the results. */ public function templateFile(); /** - * Returns an array of column headers and field names and sort options + * Returns an array of column headers and field names and sort options. */ public function &columns(); diff --git a/CRM/Report/Page/InstanceList.php b/CRM/Report/Page/InstanceList.php index ad4aacec09..05f9852cfb 100644 --- a/CRM/Report/Page/InstanceList.php +++ b/CRM/Report/Page/InstanceList.php @@ -43,35 +43,35 @@ class CRM_Report_Page_InstanceList extends CRM_Core_Page { static $_exceptions = array('logging/contact/detail'); /** - * Name of component if report list is filtered + * Name of component if report list is filtered. * * @var string */ protected $_compName = NULL; /** - * ID of component if report list is filtered + * ID of component if report list is filtered. * * @var int */ protected $_compID = NULL; /** - * ID of grouping if report list is filtered + * ID of grouping if report list is filtered. * * @var int */ protected $_grouping = NULL; /** - * ID of parent report template if list is filtered by template + * ID of parent report template if list is filtered by template. * * @var int */ protected $_ovID = NULL; /** - * Title of parent report template if list is filtered by template + * Title of parent report template if list is filtered by template. * * @var string */ diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index bbedb64db5..c2ee81ced1 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -41,14 +41,14 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * The option group name + * The option group name. * * @var array */ @@ -62,7 +62,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { static $_GName = NULL; /** - * The option group id + * The option group id. * * @var array */ @@ -97,7 +97,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -107,7 +107,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -154,7 +154,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Browse all options + * Browse all options. * * * @return void @@ -177,7 +177,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -187,7 +187,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. @@ -209,7 +209,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * Get userContext params + * Get userContext params. * * @param int $mode * Mode that we are in. diff --git a/CRM/Report/Utils/Get.php b/CRM/Report/Utils/Get.php index 2c1995e6eb..f5cbafe0d8 100644 --- a/CRM/Report/Utils/Get.php +++ b/CRM/Report/Utils/Get.php @@ -234,7 +234,7 @@ class CRM_Report_Utils_Get { } /** - * unset default filters + * unset default filters. * @param $defaults */ public static function unsetFilters(&$defaults) { diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index 2841776f57..94667f7dae 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -155,7 +155,7 @@ WHERE TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1"; } /** - * get instance count for a template + * get instance count for a template. * @param $optionVal * * @return int|null|string diff --git a/CRM/SMS/BAO/Provider.php b/CRM/SMS/BAO/Provider.php index f6cae91390..5bca7ba94c 100644 --- a/CRM/SMS/BAO/Provider.php +++ b/CRM/SMS/BAO/Provider.php @@ -35,7 +35,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { /** - * Class constructor + * Class constructor. * * @return \CRM_SMS_DAO_Provider */ @@ -54,7 +54,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { } /** - * Retrieves the list of providers from the database + * Retrieves the list of providers from the database. * * $selectArr array of coloumns to fetch * $getActive boolean to get active providers diff --git a/CRM/SMS/Controller/Send.php b/CRM/SMS/Controller/Send.php index 2f93152d44..c2e491004b 100644 --- a/CRM/SMS/Controller/Send.php +++ b/CRM/SMS/Controller/Send.php @@ -35,7 +35,7 @@ class CRM_SMS_Controller_Send extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param string $title * @param bool|int $action diff --git a/CRM/SMS/Form/Group.php b/CRM/SMS/Form/Group.php index 45064eac36..b0f2c5fd4a 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -101,7 +101,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -300,7 +300,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { } /** - * Display Name of the form + * Display Name of the form. * * * @return string @@ -310,7 +310,7 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/SMS/Form/Schedule.php b/CRM/SMS/Form/Schedule.php index 901d25b247..c1ddf96477 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 { /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -69,7 +69,7 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { } /** - * Build the form object for the last step of the sms wizard + * Build the form object for the last step of the sms wizard. * * @param * @@ -203,7 +203,7 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index 565182bae9..fed63f2437 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -119,7 +119,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -291,7 +291,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * Validation + * Validation. * * @param array $params * (ref.) an assoc array of name/value pairs. @@ -426,7 +426,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * Display Name of the form + * Display Name of the form. * * * @return string diff --git a/CRM/SMS/Page/Provider.php b/CRM/SMS/Page/Provider.php index de6cceef75..0bd5ff27b5 100644 --- a/CRM/SMS/Page/Provider.php +++ b/CRM/SMS/Page/Provider.php @@ -41,14 +41,14 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -58,7 +58,7 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -162,7 +162,7 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -172,7 +172,7 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index d6d1c5df11..eb4818ec94 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -44,7 +44,7 @@ abstract class CRM_SMS_Provider { const MAX_SMS_CHAR = 460; /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * @param array $providerParams * @param bool $force @@ -87,7 +87,7 @@ abstract class CRM_SMS_Provider { } /** - * Send an SMS Message via the API Server + * Send an SMS Message via the API Server. */ abstract public function send($recipients, $header, $message, $dncID = NULL); diff --git a/CRM/SMS/StateMachine/Send.php b/CRM/SMS/StateMachine/Send.php index 67ee664961..166334aee6 100644 --- a/CRM/SMS/StateMachine/Send.php +++ b/CRM/SMS/StateMachine/Send.php @@ -40,7 +40,7 @@ class CRM_SMS_StateMachine_Send extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param object $controller * @param \const|int $action diff --git a/CRM/Tag/Form/Tag.php b/CRM/Tag/Form/Tag.php index e8c6cc7b59..dc89fe3e74 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 { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/UF/Form/AbstractPreview.php b/CRM/UF/Form/AbstractPreview.php index 4e4840efb1..e9203dfa34 100644 --- a/CRM/UF/Form/AbstractPreview.php +++ b/CRM/UF/Form/AbstractPreview.php @@ -41,7 +41,7 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { /** - * The fields needed to build this form + * The fields needed to build this form. * * @var array */ @@ -73,7 +73,7 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { } /** - * Set the default form values + * Set the default form values. * * * @return array @@ -94,7 +94,7 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -107,7 +107,7 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index 2b7e89b77a..dec747e471 100644 --- a/CRM/UF/Form/Field.php +++ b/CRM/UF/Form/Field.php @@ -39,7 +39,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { /** - * The uf group id saved to the session for an update + * The uf group id saved to the session for an update. * * @var int */ @@ -81,7 +81,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { protected $_hasLocationTypes; /** - * Is this profile has searchable field + * Is this profile has searchable field. * or is any field having in selector true. * * @var boolean. @@ -89,7 +89,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { protected $_hasSearchableORInSelector; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -178,7 +178,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -499,7 +499,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ @@ -757,7 +757,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $fields * Posted values of the form. diff --git a/CRM/UF/Form/Group.php b/CRM/UF/Form/Group.php index a38c77b76e..4ee4662437 100644 --- a/CRM/UF/Form/Group.php +++ b/CRM/UF/Form/Group.php @@ -39,14 +39,14 @@ class CRM_UF_Form_Group extends CRM_Core_Form { /** - * The form id saved to the session for an update + * The form id saved to the session for an update. * * @var int */ protected $_id; /** - * The title for group + * The title for group. * * @var int */ @@ -56,7 +56,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { protected $_allPanes; /** - * Set variables up before form is built + * Set variables up before form is built. * * @return void */ @@ -106,7 +106,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -285,7 +285,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -317,7 +317,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * Process the form + * Process the form. * * @return void */ diff --git a/CRM/UF/Form/Preview.php b/CRM/UF/Form/Preview.php index b27c3d9653..3e584fa044 100644 --- a/CRM/UF/Form/Preview.php +++ b/CRM/UF/Form/Preview.php @@ -123,7 +123,7 @@ class CRM_UF_Form_Preview extends CRM_UF_Form_AbstractPreview { } /** - * Build the form object + * Build the form object. * * @return void */ diff --git a/CRM/UF/Page/AJAX.php b/CRM/UF/Page/AJAX.php index 5edb2d4979..c3b59e02c1 100644 --- a/CRM/UF/Page/AJAX.php +++ b/CRM/UF/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_UF_Page_AJAX { /** - * Function the check whether the field belongs + * Function the check whether the field belongs. * to multi-record custom set */ public function checkIsMultiRecord() { diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php index a6467ca2b5..0465662c3a 100644 --- a/CRM/UF/Page/Field.php +++ b/CRM/UF/Page/Field.php @@ -46,14 +46,14 @@ class CRM_UF_Page_Field extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * The group id of the field + * The group id of the field. * * @var int */ protected $_gid; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -275,7 +275,7 @@ class CRM_UF_Page_Field extends CRM_Core_Page { } /** - * Preview custom field + * Preview custom field. * * @param int $fieldId * Custom field id. diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php index bdae6cdd75..04c1ba21cc 100644 --- a/CRM/UF/Page/Group.php +++ b/CRM/UF/Page/Group.php @@ -44,7 +44,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ @@ -265,7 +265,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { } /** - * Edit uf group + * Edit uf group. * * @param int $id * Uf group id. @@ -378,7 +378,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { } /** - * for preview mode for ufoup + * for preview mode for ufoup. * * @param int $id * Uf group id. diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php index 025fea737e..3a1370570d 100644 --- a/CRM/UF/Page/ProfileEditor.php +++ b/CRM/UF/Page/ProfileEditor.php @@ -77,7 +77,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page { } /** - * AJAX callback + * AJAX callback. */ public static function getSchemaJSON() { $entityTypes = explode(',', $_REQUEST['entityTypes']); diff --git a/CRM/Upgrade/Controller.php b/CRM/Upgrade/Controller.php index 891efdaf85..bc94a1c9d5 100644 --- a/CRM/Upgrade/Controller.php +++ b/CRM/Upgrade/Controller.php @@ -35,7 +35,7 @@ class CRM_Upgrade_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. * * @param null $title * @param bool|int $action diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index 6f40d682b1..e6d27cbe1d 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -45,21 +45,21 @@ class CRM_Upgrade_Form extends CRM_Core_Form { protected $_config; /** - * Upgrade for multilingual + * Upgrade for multilingual. * * @var boolean */ public $multilingual = FALSE; /** - * Locales available for multilingual upgrade + * Locales available for multilingual upgrade. * * @var array */ public $locales; /** - * Number to string mapper + * Number to string mapper. * * @var array */ @@ -77,7 +77,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { ); /** - * Constructor for the basic form page + * Constructor for the basic form page. * * We should not use QuickForm directly. This class provides a lot * of default convenient functions, rules and buttons @@ -243,7 +243,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { } /** - * Use the form name to create the tpl file name + * Use the form name to create the tpl file name. * * @return string */ @@ -436,7 +436,7 @@ SET version = '$version' } /** - * Determine the start and end version of the upgrade process + * Determine the start and end version of the upgrade process. * * @return array(0=>$currentVer, 1=>$latestVer) */ @@ -547,7 +547,7 @@ SET version = '$version' } /** - * Fill the queue with upgrade tasks + * Fill the queue with upgrade tasks. * * @param string $currentVer * the original revision. @@ -614,7 +614,7 @@ SET version = '$version' } /** - * Perform an incremental version update + * Perform an incremental version update. * * @param CRM_Queue_TaskContext $ctx * @param string $rev @@ -633,7 +633,7 @@ SET version = '$version' } /** - * Perform an incremental version update + * Perform an incremental version update. * * @param CRM_Queue_TaskContext $ctx * @param string $rev @@ -705,7 +705,7 @@ SET version = '$version' } /** - * Perform an incremental version update + * Perform an incremental version update. * * @param CRM_Queue_TaskContext $ctx * @param string $rev diff --git a/CRM/Upgrade/Incremental/Legacy.php b/CRM/Upgrade/Incremental/Legacy.php index 25c3271553..602e3c387e 100644 --- a/CRM/Upgrade/Incremental/Legacy.php +++ b/CRM/Upgrade/Incremental/Legacy.php @@ -40,7 +40,7 @@ class CRM_Upgrade_Incremental_Legacy { /** - * Compute any messages which should be displayed before upgrade + * Compute any messages which should be displayed before upgrade. * * @param string $preUpgradeMessage * alterable. @@ -209,7 +209,7 @@ SELECT id } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. @@ -279,7 +279,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -324,7 +324,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -352,7 +352,7 @@ SELECT count( id ) as statusCount } /** - * This function should check if if need to skip current sql file + * This function should check if if need to skip current sql file. * Name of this function will change according to the latest release */ public static function upgrade_2_2_alpha3($rev) { @@ -365,7 +365,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -380,7 +380,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -404,7 +404,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -420,7 +420,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -441,7 +441,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -462,7 +462,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -495,7 +495,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -518,7 +518,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -539,7 +539,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -570,7 +570,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). @@ -584,7 +584,7 @@ SELECT count( id ) as statusCount } /** - * Perform an incremental upgrade + * Perform an incremental upgrade. * * @param string $rev * the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final). diff --git a/CRM/Upgrade/Incremental/php/FourFive.php b/CRM/Upgrade/Incremental/php/FourFive.php index 8e81e4605b..02f1e53152 100644 --- a/CRM/Upgrade/Incremental/php/FourFive.php +++ b/CRM/Upgrade/Incremental/php/FourFive.php @@ -44,7 +44,7 @@ class CRM_Upgrade_Incremental_php_FourFive { } /** - * Compute any messages which should be displayed beforeupgrade + * Compute any messages which should be displayed beforeupgrade. * * Note: This function is called iteratively for each upcoming * revision to the database. @@ -60,7 +60,7 @@ class CRM_Upgrade_Incremental_php_FourFive { } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index 8b24dc6d67..54bc8157bb 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -46,7 +46,7 @@ class CRM_Upgrade_Incremental_php_FourFour { } /** - * Compute any messages which should be displayed beforeupgrade + * Compute any messages which should be displayed beforeupgrade. * * Note: This function is called iteratively for each upcoming * revision to the database. @@ -76,7 +76,7 @@ class CRM_Upgrade_Incremental_php_FourFour { } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. diff --git a/CRM/Upgrade/Incremental/php/FourOne.php b/CRM/Upgrade/Incremental/php/FourOne.php index 79b1741bfa..f1373ca224 100644 --- a/CRM/Upgrade/Incremental/php/FourOne.php +++ b/CRM/Upgrade/Incremental/php/FourOne.php @@ -53,7 +53,7 @@ class CRM_Upgrade_Incremental_php_FourOne { } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. diff --git a/CRM/Upgrade/Incremental/php/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php index d7d3222548..f6ae9ac3b1 100644 --- a/CRM/Upgrade/Incremental/php/FourSix.php +++ b/CRM/Upgrade/Incremental/php/FourSix.php @@ -59,7 +59,7 @@ class CRM_Upgrade_Incremental_php_FourSix { } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index 7a726c2ba2..7c6e127577 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -44,7 +44,7 @@ class CRM_Upgrade_Incremental_php_FourThree { } /** - * Compute any messages which should be displayed beforeupgrade + * Compute any messages which should be displayed beforeupgrade. * * Note: This function is called iteratively for each upcoming * revision to the database. @@ -115,7 +115,7 @@ WHERE {$key}.id IS NULL"; } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. @@ -983,7 +983,7 @@ ALTER TABLE civicrm_financial_account } /** - * Change index and add missing constraints for civicrm_contribution_recur + * Change index and add missing constraints for civicrm_contribution_recur. */ public function addMissingConstraints(CRM_Queue_TaskContext $ctx) { $query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'"; @@ -1013,7 +1013,7 @@ ALTER TABLE civicrm_financial_account } /** - * Update financial_account_id for bad data in financial_trxn table + * Update financial_account_id for bad data in financial_trxn table. * CRM-12844 */ public function updateFinancialTrxnData(CRM_Queue_TaskContext $ctx) { @@ -1075,7 +1075,7 @@ id IN (' . implode(',', $val) . ')'; } /** - * Update financial_account_id for bad data in financial_trxn table + * Update financial_account_id for bad data in financial_trxn table. * CRM-12844 */ public function updateLineItemData(CRM_Queue_TaskContext $ctx) { @@ -1139,7 +1139,7 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v } /** - * Replace contribution_type to financial_type in table + * Replace contribution_type to financial_type in table. * civicrm_saved_search and Structure civicrm_report_instance */ public function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) { @@ -1215,7 +1215,7 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v } /** - * Add ON DELETE options for constraint if not present + * Add ON DELETE options for constraint if not present. * CRM-13088 && CRM-12156 * * @param CRM_Queue_TaskContext $ctx diff --git a/CRM/Upgrade/Incremental/php/FourTwo.php b/CRM/Upgrade/Incremental/php/FourTwo.php index 526796408c..aa8f210060 100644 --- a/CRM/Upgrade/Incremental/php/FourTwo.php +++ b/CRM/Upgrade/Incremental/php/FourTwo.php @@ -46,7 +46,7 @@ class CRM_Upgrade_Incremental_php_FourTwo { } /** - * Compute any messages which should be displayed beforeupgrade + * Compute any messages which should be displayed beforeupgrade. * * Note: This function is called iteratively for each upcoming * revision to the database. @@ -146,7 +146,7 @@ INNER JOIN civicrm_price_set cps ON cps.id = cpf.price_set_id AND cps.name <>'de } /** - * Compute any messages which should be displayed after upgrade + * Compute any messages which should be displayed after upgrade. * * @param string $postUpgradeMessage * alterable. diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 6f0b69ae32..bc48b0459d 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -42,7 +42,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p protected $_options; /** - * Takes an associative array and creates a price field object + * Takes an associative array and creates a price field object. * * the function extract all the params it needs to initialize the create a * price field object. the params array could contain additional unused name/value @@ -67,7 +67,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * Takes an associative array and creates a price field object + * Takes an associative array and creates a price field object. * * This function is invoked from within the web form layer and also from the api layer * @@ -154,7 +154,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -168,7 +168,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -198,7 +198,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * This function for building custom fields + * This function for building custom fields. * * @param CRM_Core_Form $qf * Form object (reference). @@ -458,7 +458,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p } /** - * Retrieve a list of options for the specified field + * Retrieve a list of options for the specified field. * * @param int $fieldId * Price field ID. @@ -562,7 +562,7 @@ WHERE } /** - * Validate the priceset + * Validate the priceset. * * @param int $priceSetId * @param array $fields diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index 67460368b9..23bcb6997e 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -110,8 +110,9 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array. @@ -125,7 +126,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho } /** - * Retrive the all values for given field id + * Retrive the all values for given field id. * * @param int $fieldId * Price_field_id. @@ -169,7 +170,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -185,7 +186,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho } /** - * Delete all values of the given field id + * Delete all values of the given field id. * * @param int $fieldId * Price field id. diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index c78dfd152d..bb602471a2 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -69,10 +69,9 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ } /** - * Takes a bunch of params that are needed to match certain criteria and - * retrieves the relevant objects. Typically, the valid params are only - * price_field_id. This is the inverse function of create. It also - * stores all of the retrieved values in the default array. + * Retrieve DB object based on input parameters. + * + * It also stores all the retrieved values in the default array. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -169,7 +168,7 @@ WHERE %2.id = %1"; } /** - * This method will create the lineItem array required for + * This method will create the lineItem array required for. * processAmount method * * @param int $fid diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index a29a93781f..eb62223c4c 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -40,14 +40,14 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); } /** - * Takes an associative array and creates a price set object + * Takes an associative array and creates a price set object. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -64,7 +64,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ } /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -78,7 +78,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ } /** - * Update the is_active flag in the db + * Update the is_active flag in the db. * * @param int $id * Id of the database record. @@ -93,7 +93,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ } /** - * Calculate the default price set id + * Calculate the default price set id. * assigned to the contribution/membership etc * * @param string $entity @@ -247,7 +247,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Delete the price set + * Delete the price set. * * @param int $id * Price Set id. @@ -286,7 +286,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Link the price set with the specified table and id + * Link the price set with the specified table and id. * * @param string $entityTable * @param int $entityId @@ -315,7 +315,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Delete price set for the given entity and id + * Delete price set for the given entity and id. * * @param string $entityTable * @param int $entityId @@ -372,7 +372,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Find a price_set_id associatied with the given option value or field ID + * Find a price_set_id associatied with the given option value or field ID. * * @param array $params * (reference) an assoc array of name/value pairs. @@ -404,7 +404,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Return an associative array of all price sets + * Return an associative array of all price sets. * * @param bool $withInactive * Whether or not to include inactive entries. @@ -449,7 +449,7 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Get price set details + * Get price set details. * * An array containing price set details (including price fields) is returned * @@ -899,7 +899,7 @@ WHERE id = %1"; } /** - * Get field ids of a price set + * Get field ids of a price set. * * @param int $id Price Set id * @@ -965,7 +965,7 @@ WHERE id = %1"; } /** - * check price set permission + * check price set permission. * * @param int $sid * The price set id. @@ -985,7 +985,7 @@ WHERE id = %1"; } /** - * Get the sum of participant count + * Get the sum of participant count. * for all fields of given price set. * * @param int $sid @@ -1047,7 +1047,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Function to check if auto renew option should be shown + * Function to check if auto renew option should be shown. * * @param int $priceSetId * Price set id. @@ -1096,7 +1096,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Retrieve auto renew frequency and interval + * Retrieve auto renew frequency and interval. * * @param int $priceSetId * Price set id. @@ -1128,7 +1128,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Update the is_quick_config flag in the db + * Update the is_quick_config flag in the db. * * @param int $id * Id of the database record. diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index ed86b1d692..0a582fd995 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -180,7 +180,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { public $visibility_id; /** - * Class constructor + * Class constructor. * * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field */ @@ -190,7 +190,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * return foreign links + * Return foreign links. * * @return array */ @@ -204,7 +204,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns all the column names of this table + * Returns all the column names of this table. * * @return array */ @@ -320,7 +320,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns the names of this table + * returns the names of this table. * * @return string */ @@ -329,7 +329,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns if this table needs to be logged + * returns if this table needs to be logged. * * @return boolean */ @@ -338,7 +338,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported + * returns the list of fields that can be imported. * * @return array */ @@ -361,7 +361,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported + * returns the list of fields that can be exported. * * @return array */ @@ -384,7 +384,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns an array containing the enum fields of the civicrm_price_field table + * returns an array containing the enum fields of the civicrm_price_field table. * * @return array * (reference) the array of enum fields diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php index 0cd702e29b..d8eecce99b 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php @@ -151,7 +151,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { public $is_active; /** - * Class constructor + * Class constructor. * * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue */ @@ -161,7 +161,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * return foreign links + * Return foreign links. * * @return array */ @@ -176,7 +176,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns all the column names of this table + * Returns all the column names of this table. * * @return array */ @@ -263,7 +263,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns the names of this table + * returns the names of this table. * * @return string */ @@ -272,7 +272,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns if this table needs to be logged + * returns if this table needs to be logged. * * @return boolean */ @@ -281,7 +281,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported + * returns the list of fields that can be imported. * * @return array */ @@ -304,7 +304,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported + * returns the list of fields that can be exported. * * @return array */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php index 7c9d98e981..3657a438bc 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php @@ -139,7 +139,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { public $price_field_value_id; /** - * Class constructor + * Class constructor. * * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem */ @@ -149,7 +149,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * return foreign links + * Return foreign links. * * @return array */ @@ -164,7 +164,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * returns all the column names of this table + * Returns all the column names of this table. * * @return array */ @@ -239,7 +239,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * returns the names of this table + * returns the names of this table. * * @return string */ @@ -248,7 +248,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * returns if this table needs to be logged + * returns if this table needs to be logged. * * @return boolean */ @@ -257,7 +257,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported + * returns the list of fields that can be imported. * * @return array */ @@ -280,7 +280,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported + * returns the list of fields that can be exported. * * @return array */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php index e828e12c3a..8a526d8c5e 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php @@ -151,7 +151,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { public $is_reserved; /** - * Class constructor + * Class constructor. * * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set */ @@ -161,7 +161,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * return foreign links + * Return foreign links. * * @return array */ @@ -176,7 +176,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * returns all the column names of this table + * Returns all the column names of this table. * * @return array */ @@ -263,7 +263,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * returns the names of this table + * returns the names of this table. * * @return string */ @@ -272,7 +272,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * returns if this table needs to be logged + * returns if this table needs to be logged. * * @return boolean */ @@ -281,7 +281,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported + * returns the list of fields that can be imported. * * @return array */ @@ -304,7 +304,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported + * returns the list of fields that can be exported. * * @return array */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php index 35de88c00c..9365951d8b 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php @@ -103,7 +103,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { public $price_set_id; /** - * Class constructor + * Class constructor. * * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity */ @@ -113,7 +113,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * return foreign links + * Return foreign links. * * @return array */ @@ -127,7 +127,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * returns all the column names of this table + * Returns all the column names of this table. * * @return array */ @@ -164,7 +164,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * returns the names of this table + * returns the names of this table. * * @return string */ @@ -173,7 +173,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * returns if this table needs to be logged + * returns if this table needs to be logged. * * @return boolean */ @@ -182,7 +182,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported + * returns the list of fields that can be imported. * * @return array */ @@ -205,7 +205,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported + * returns the list of fields that can be exported. * * @return array */ diff --git a/CRM/Upgrade/StateMachine.php b/CRM/Upgrade/StateMachine.php index e01714d393..63b6ec4529 100644 --- a/CRM/Upgrade/StateMachine.php +++ b/CRM/Upgrade/StateMachine.php @@ -40,7 +40,7 @@ class CRM_Upgrade_StateMachine extends CRM_Core_StateMachine { /** - * Class constructor + * Class constructor. * * @param object $controller * @param const $pages diff --git a/CRM/Utils/API/ReloadOption.php b/CRM/Utils/API/ReloadOption.php index 4d2c491642..dbb93b79d2 100644 --- a/CRM/Utils/API/ReloadOption.php +++ b/CRM/Utils/API/ReloadOption.php @@ -116,7 +116,7 @@ class CRM_Utils_API_ReloadOption implements API_Wrapper { } /** - * Identify the fields which should be returned + * Identify the fields which should be returned. * * @param $apiRequest * @return array diff --git a/CRM/Utils/Address.php b/CRM/Utils/Address.php index b4c3a20909..82b9c706a5 100644 --- a/CRM/Utils/Address.php +++ b/CRM/Utils/Address.php @@ -33,7 +33,7 @@ class CRM_Utils_Address { /** - * Format an address string from address fields and a format string + * Format an address string from address fields and a format string. * * Format an address basing on the address fields provided. * Use Setting's address_format if there's no format specified. diff --git a/CRM/Utils/Array.php b/CRM/Utils/Array.php index 3560b4fcb2..9471cb0fa2 100644 --- a/CRM/Utils/Array.php +++ b/CRM/Utils/Array.php @@ -388,7 +388,7 @@ class CRM_Utils_Array { } /** - * convert associative array names to values + * convert associative array names to values. * and vice-versa. * * This function is used by both the web form layer and the api. Note that @@ -781,7 +781,7 @@ class CRM_Utils_Array { } /** - * Get the first element of an array + * Get the first element of an array. * * @param array $array * @return mixed|NULL diff --git a/CRM/Utils/Cache.php b/CRM/Utils/Cache.php index a6a8fa9521..4aadbf1f8d 100644 --- a/CRM/Utils/Cache.php +++ b/CRM/Utils/Cache.php @@ -47,7 +47,7 @@ class CRM_Utils_Cache { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. @@ -59,7 +59,7 @@ class CRM_Utils_Cache { } /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * @return object */ @@ -91,7 +91,7 @@ class CRM_Utils_Cache { } /** - * Get cache relevant settings + * Get cache relevant settings. * * @param $cachePlugin * diff --git a/CRM/Utils/Cache/APCcache.php b/CRM/Utils/Cache/APCcache.php index 50b4b2e3bb..0a10a48b6d 100644 --- a/CRM/Utils/Cache/APCcache.php +++ b/CRM/Utils/Cache/APCcache.php @@ -37,7 +37,7 @@ class CRM_Utils_Cache_APCcache { const DEFAULT_PREFIX = ''; /** - * The default timeout to use + * The default timeout to use. * * @var int */ @@ -55,7 +55,7 @@ class CRM_Utils_Cache_APCcache { protected $_prefix = self::DEFAULT_PREFIX; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/ArrayCache.php b/CRM/Utils/Cache/ArrayCache.php index 096ab477b5..408e2ef649 100644 --- a/CRM/Utils/Cache/ArrayCache.php +++ b/CRM/Utils/Cache/ArrayCache.php @@ -11,7 +11,7 @@ class CRM_Utils_Cache_Arraycache implements CRM_Utils_Cache_Interface { private $_cache; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/Interface.php b/CRM/Utils/Cache/Interface.php index 7d21c11c6f..ac4344c9d8 100644 --- a/CRM/Utils/Cache/Interface.php +++ b/CRM/Utils/Cache/Interface.php @@ -35,7 +35,7 @@ interface CRM_Utils_Cache_Interface { /** - * Set the value in the cache + * Set the value in the cache. * * @param string $key * @param mixed $value @@ -44,7 +44,7 @@ interface CRM_Utils_Cache_Interface { public function set($key, &$value); /** - * Get a value from the cache + * Get a value from the cache. * * @param string $key * @return mixed @@ -53,7 +53,7 @@ interface CRM_Utils_Cache_Interface { public function get($key); /** - * Delete a value from the cache + * Delete a value from the cache. * * @param string $key * @return void @@ -61,7 +61,7 @@ interface CRM_Utils_Cache_Interface { public function delete($key); /** - * Delete all values from the cache + * Delete all values from the cache. * * @return void */ diff --git a/CRM/Utils/Cache/Memcache.php b/CRM/Utils/Cache/Memcache.php index c586b25810..1f1c1ef2cc 100644 --- a/CRM/Utils/Cache/Memcache.php +++ b/CRM/Utils/Cache/Memcache.php @@ -39,21 +39,21 @@ class CRM_Utils_Cache_Memcache { const DEFAULT_PREFIX = ''; /** - * The host name of the memcached server + * The host name of the memcached server. * * @var string */ protected $_host = self::DEFAULT_HOST; /** - * The port on which to connect on + * The port on which to connect on. * * @var int */ protected $_port = self::DEFAULT_PORT; /** - * The default timeout to use + * The default timeout to use. * * @var int */ @@ -71,14 +71,14 @@ class CRM_Utils_Cache_Memcache { protected $_prefix = self::DEFAULT_PREFIX; /** - * The actual memcache object + * The actual memcache object. * * @var resource */ protected $_cache; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/Memcached.php b/CRM/Utils/Cache/Memcached.php index cad43187c2..f14ddeea98 100644 --- a/CRM/Utils/Cache/Memcached.php +++ b/CRM/Utils/Cache/Memcached.php @@ -72,14 +72,14 @@ class CRM_Utils_Cache_Memcached { protected $_prefix = self::DEFAULT_PREFIX; /** - * The actual memcache object + * The actual memcache object. * * @var resource */ protected $_cache; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/NoCache.php b/CRM/Utils/Cache/NoCache.php index 5c014ba429..b37df2f594 100644 --- a/CRM/Utils/Cache/NoCache.php +++ b/CRM/Utils/Cache/NoCache.php @@ -43,7 +43,7 @@ class CRM_Utils_Cache_NoCache implements CRM_Utils_Cache_Interface { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/SerializeCache.php b/CRM/Utils/Cache/SerializeCache.php index 4ea0fe7bc5..4887eee38c 100644 --- a/CRM/Utils/Cache/SerializeCache.php +++ b/CRM/Utils/Cache/SerializeCache.php @@ -36,7 +36,7 @@ class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface { private $_cache; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Cache/SqlGroup.php b/CRM/Utils/Cache/SqlGroup.php index 085deda8e0..5d3d532258 100644 --- a/CRM/Utils/Cache/SqlGroup.php +++ b/CRM/Utils/Cache/SqlGroup.php @@ -41,7 +41,7 @@ class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface { /** - * The host name of the memcached server + * The host name of the memcached server. * * @var string */ @@ -58,7 +58,7 @@ class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface { protected $frontCache; /** - * Constructor + * Constructor. * * @param array $config * An array of configuration params. diff --git a/CRM/Utils/Check.php b/CRM/Utils/Check.php index 678172bcd0..ba102ea82d 100644 --- a/CRM/Utils/Check.php +++ b/CRM/Utils/Check.php @@ -58,7 +58,7 @@ class CRM_Utils_Check { } /** - * Execute "checkAll" + * Execute "checkAll". * * @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched */ @@ -84,7 +84,7 @@ class CRM_Utils_Check { } /** - * Throw an exception if any of the checks fail + * Throw an exception if any of the checks fail. * * @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched * diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index 1c4dc6e03c..582a7f6d0e 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -166,7 +166,7 @@ class CRM_Utils_Date { } /** - * Return abbreviated weekday names according to the locale + * Return abbreviated weekday names according to the locale. * * @return array * 0-based array with abbreviated weekday names @@ -187,7 +187,7 @@ class CRM_Utils_Date { } /** - * Return full weekday names according to the locale + * Return full weekday names according to the locale. * * @return array * 0-based array with full weekday names @@ -208,7 +208,7 @@ class CRM_Utils_Date { } /** - * Return abbreviated month names according to the locale + * Return abbreviated month names according to the locale. * * @param bool $month * @@ -233,7 +233,7 @@ class CRM_Utils_Date { } /** - * Return full month names according to the locale + * Return full month names according to the locale. * * @return array * 1-based array with full month names @@ -272,7 +272,7 @@ class CRM_Utils_Date { } /** - * Create a date and time string in a provided format + * Create a date and time string in a provided format. * * %b - abbreviated month name ('Jan'..'Dec') * %B - full month name ('January'..'December') @@ -710,7 +710,7 @@ class CRM_Utils_Date { } /** - * 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, @@ -803,7 +803,7 @@ class CRM_Utils_Date { } /** - * Calculate Age in Years if greater than one year else in months + * Calculate Age in Years if greater than one year else in months. * * @param date $birthDate * Birth Date. @@ -958,7 +958,7 @@ class CRM_Utils_Date { } /** - * Resolves the given relative time interval into finite time limits + * Resolves the given relative time interval into finite time limits. * * @param array $relativeTerm * Relative time frame like this, previous, etc. @@ -1631,7 +1631,7 @@ class CRM_Utils_Date { } /** - * Calculate current fiscal year based on the fiscal month and day + * Calculate current fiscal year based on the fiscal month and day. * * @param int $fyDate * Fiscal start date. @@ -1691,7 +1691,7 @@ class CRM_Utils_Date { } /** - * Function to convert mysql to date plugin format + * Function to convert mysql to date plugin format. * * @param string $mysqlDate * Date string. @@ -1763,7 +1763,7 @@ class CRM_Utils_Date { } /** - * Function get date format + * Function get date format. * * @param string $formatType * Date name e.g. birth. diff --git a/CRM/Utils/File.php b/CRM/Utils/File.php index 808c43aa0d..70adaed6cc 100644 --- a/CRM/Utils/File.php +++ b/CRM/Utils/File.php @@ -343,7 +343,7 @@ class CRM_Utils_File { } /** - * Determine whether a given file is listed in the PHP include path + * Determine whether a given file is listed in the PHP include path. * * @param string $name * Name of file. @@ -550,7 +550,7 @@ HTACCESS; } /** - * Make a file path relative to some base dir + * Make a file path relative to some base dir. * * @param $directory * @param $basePath @@ -567,7 +567,7 @@ HTACCESS; } /** - * Create a path to a temporary file which can endure for multiple requests + * Create a path to a temporary file which can endure for multiple requests. * * TODO: Automatic file cleanup using, eg, TTL policy * @@ -585,7 +585,7 @@ HTACCESS; } /** - * Create a path to a temporary directory which can endure for multiple requests + * Create a path to a temporary directory which can endure for multiple requests. * * TODO: Automatic file cleanup using, eg, TTL policy * diff --git a/CRM/Utils/Geocode/Google.php b/CRM/Utils/Geocode/Google.php index f224b63ec1..1a7b0c557e 100644 --- a/CRM/Utils/Geocode/Google.php +++ b/CRM/Utils/Geocode/Google.php @@ -46,7 +46,7 @@ class CRM_Utils_Geocode_Google { static protected $_server = 'maps.googleapis.com'; /** - * Uri of service + * Uri of service. * * @var string */ diff --git a/CRM/Utils/Geocode/Yahoo.php b/CRM/Utils/Geocode/Yahoo.php index e5e6344415..39289d2e5d 100644 --- a/CRM/Utils/Geocode/Yahoo.php +++ b/CRM/Utils/Geocode/Yahoo.php @@ -47,7 +47,7 @@ class CRM_Utils_Geocode_Yahoo { static protected $_server = 'query.yahooapis.com'; /** - * Uri of service + * Uri of service. * * @var string */ diff --git a/CRM/Utils/GlobalStack.php b/CRM/Utils/GlobalStack.php index b6d4a089cc..a03738ea9d 100644 --- a/CRM/Utils/GlobalStack.php +++ b/CRM/Utils/GlobalStack.php @@ -52,7 +52,7 @@ class CRM_Utils_GlobalStack { private $backups = array(); /** - * Get or set the single instance of CRM_Utils_GlobalStack + * Get or set the single instance of CRM_Utils_GlobalStack. * * @return CRM_Utils_GlobalStack */ diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 1953cfc620..da48a2ca1f 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -70,7 +70,7 @@ abstract class CRM_Utils_Hook { private $commonCiviModules = array(); /** - * Constructor and getter for the singleton instance + * Constructor and getter for the singleton instance. * * @param bool $fresh * @@ -88,7 +88,7 @@ abstract class CRM_Utils_Hook { } /** - * Invoke hooks + * Invoke hooks. * * @param int $numParams * Number of parameters to pass to the hook. @@ -307,7 +307,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook retrieves links from other modules and injects it into + * This hook retrieves links from other modules and injects it into. * the view contact tabs * * @param string $op @@ -424,7 +424,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called before a db write on a custom table + * This hook is called before a db write on a custom table. * * @param string $op * The type of operation being performed. @@ -490,7 +490,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when building the menu table + * This hook is called when building the menu table. * * @param array $files * The current set of files to process. @@ -578,7 +578,7 @@ abstract class CRM_Utils_Hook { } /** - * Determine how many other records refer to a given record + * Determine how many other records refer to a given record. * * @param CRM_Core_DAO $dao * The item for which we want a reference count. @@ -597,7 +597,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when building the amount structure for a Contribution or Event Page + * 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. @@ -870,7 +870,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when rendering the contact summary + * This hook is called when rendering the contact summary. * * @param int $contactID * The contactID for whom the summary is being rendered @@ -967,7 +967,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when membership status is being calculated + * This hook is called when membership status is being calculated. * * @param array $membershipStatus * Membership status details as determined - alter if required. @@ -992,7 +992,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when rendering the Manage Case screen + * This hook is called when rendering the Manage Case screen. * * @param int $caseID * The case ID. @@ -1051,7 +1051,7 @@ abstract class CRM_Utils_Hook { } /** - * This hooks allows to change option values + * This hooks allows to change option values. * * @param array $options * Associated array of option values / id @@ -1118,7 +1118,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called before record is exported as CSV + * This hook is called before record is exported as CSV. * * @param string $exportTempTable * Name of the temporary export table used during export. @@ -1325,7 +1325,7 @@ abstract class CRM_Utils_Hook { } /** - * Hook definition for altering the generation of Mailing Labels + * Hook definition for altering the generation of Mailing Labels. * * @param array $args * An array of the args in the order defined for the tcpdf multiCell api call. @@ -1366,7 +1366,7 @@ abstract class CRM_Utils_Hook { } /** - * This hooks allows alteration of generated page content + * This hooks allows alteration of generated page content. * * @param $content * Previously generated content. @@ -1409,7 +1409,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook collects the trigger definition from all components + * This hook collects the trigger definition from all components. * * @param $info * @param string $tableName @@ -1541,7 +1541,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called when Settings specifications are loaded + * This hook is called when Settings specifications are loaded. * * @param array $settingsFolders * List of paths from which to derive metadata @@ -1644,7 +1644,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called for declaring managed entities via API + * This hook is called for declaring managed entities via API. * * @param array[] $entityTypes * List of entity types; each entity-type is an array with keys: @@ -1662,7 +1662,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called while preparing a profile form + * This hook is called while preparing a profile form. * * @param string $name * @return mixed @@ -1673,7 +1673,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called while validating a profile form submission + * This hook is called while validating a profile form submission. * * @param string $name * @return mixed @@ -1684,7 +1684,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called processing a valid profile form submission + * This hook is called processing a valid profile form submission. * * @param string $name * @return mixed @@ -1738,7 +1738,7 @@ abstract class CRM_Utils_Hook { /** - * This hook is called before encoding data in barcode + * This hook is called before encoding data in barcode. * * @param array $data * Associated array of values available for encoding. @@ -1787,7 +1787,7 @@ abstract class CRM_Utils_Hook { } /** - * This hook is called while viewing contact dashboard + * This hook is called while viewing contact dashboard. * * @param array $availableDashlets * List of dashlets; each is formatted per api/v3/Dashboard @@ -1899,7 +1899,7 @@ abstract class CRM_Utils_Hook { } /** - * Generate a default CRUD URL for an entity + * Generate a default CRUD URL for an entity. * * @param array $spec * With keys:. diff --git a/CRM/Utils/Hook/Joomla.php b/CRM/Utils/Hook/Joomla.php index 8e63b71e11..42288664db 100644 --- a/CRM/Utils/Hook/Joomla.php +++ b/CRM/Utils/Hook/Joomla.php @@ -34,7 +34,7 @@ */ class CRM_Utils_Hook_Joomla extends CRM_Utils_Hook { /** - * Invoke hooks + * Invoke hooks. * * @param int $numParams * Number of parameters to pass to the hook. diff --git a/CRM/Utils/Hook/Soap.php b/CRM/Utils/Hook/Soap.php index 8d359f9163..d7c8a5377a 100644 --- a/CRM/Utils/Hook/Soap.php +++ b/CRM/Utils/Hook/Soap.php @@ -34,7 +34,7 @@ */ class CRM_Utils_Hook_Soap extends CRM_Utils_Hook { /** - * Invoke hooks + * Invoke hooks. * * @param int $numParams * Number of parameters to pass to the hook. diff --git a/CRM/Utils/Hook/UnitTests.php b/CRM/Utils/Hook/UnitTests.php index 0fe98057f0..2b74010432 100644 --- a/CRM/Utils/Hook/UnitTests.php +++ b/CRM/Utils/Hook/UnitTests.php @@ -60,7 +60,7 @@ class CRM_Utils_Hook_UnitTests extends CRM_Utils_Hook { } /** - * Register a piece of code to run when invoking a hook + * Register a piece of code to run when invoking a hook. * @param string $hook * Hook name, e.g civicrm_pre. * @param array $callable @@ -72,7 +72,7 @@ class CRM_Utils_Hook_UnitTests extends CRM_Utils_Hook { } /** - * Invoke hooks + * Invoke hooks. * * @param int $numParams * Number of parameters to pass to the hook. diff --git a/CRM/Utils/Hook/WordPress.php b/CRM/Utils/Hook/WordPress.php index 49198679a8..b436a8ab6c 100644 --- a/CRM/Utils/Hook/WordPress.php +++ b/CRM/Utils/Hook/WordPress.php @@ -64,7 +64,7 @@ class CRM_Utils_Hook_WordPress extends CRM_Utils_Hook { ); /** - * Invoke hooks + * Invoke hooks. * * @param int $numParams * Number of parameters to pass to the hook. diff --git a/CRM/Utils/HttpClient.php b/CRM/Utils/HttpClient.php index 921649bc2f..9c22cc4d6a 100644 --- a/CRM/Utils/HttpClient.php +++ b/CRM/Utils/HttpClient.php @@ -114,7 +114,7 @@ class CRM_Utils_HttpClient { } /** - * Send an HTTP GET for a remote resource + * Send an HTTP GET for a remote resource. * * @param string $remoteFile * URL of remote file. @@ -152,7 +152,7 @@ class CRM_Utils_HttpClient { } /** - * Send an HTTP POST for a remote resource + * Send an HTTP POST for a remote resource. * * @param string $remoteFile * URL of a .zip file. diff --git a/CRM/Utils/ICalendar.php b/CRM/Utils/ICalendar.php index b15171998b..507e643423 100644 --- a/CRM/Utils/ICalendar.php +++ b/CRM/Utils/ICalendar.php @@ -43,7 +43,7 @@ class CRM_Utils_ICalendar { /** - * Escape text elements for safe ICalendar use + * Escape text elements for safe ICalendar use. * * @param $text * Text to escape. @@ -63,7 +63,7 @@ class CRM_Utils_ICalendar { } /** - * Escape date elements for safe ICalendar use + * Escape date elements for safe ICalendar use. * * @param $date * Date to escape. diff --git a/CRM/Utils/JS.php b/CRM/Utils/JS.php index 5b7a3572e0..d29e3c9c46 100644 --- a/CRM/Utils/JS.php +++ b/CRM/Utils/JS.php @@ -35,7 +35,7 @@ */ class CRM_Utils_JS { /** - * Parse a javascript file for translatable strings + * Parse a javascript file for translatable strings. * * @param string $jsCode * Raw Javascript code. diff --git a/CRM/Utils/JSON.php b/CRM/Utils/JSON.php index c756f74351..adb349fb90 100644 --- a/CRM/Utils/JSON.php +++ b/CRM/Utils/JSON.php @@ -39,7 +39,7 @@ class CRM_Utils_JSON { /** - * Output json to the client + * Output json to the client. * @param mixed $input */ public static function output($input) { @@ -49,7 +49,7 @@ class CRM_Utils_JSON { } /** - * Create JSON object + * Create JSON object. * @deprecated * * @param array $params @@ -121,7 +121,7 @@ class CRM_Utils_JSON { } /** - * encode data for dataTable plugin + * encode data for dataTable plugin. * * @param array $params * Associated array of row elements. diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php index f3363298e2..1ed07377b7 100644 --- a/CRM/Utils/Mail.php +++ b/CRM/Utils/Mail.php @@ -271,7 +271,7 @@ class CRM_Utils_Mail { } /** - * Get the Active outBound email + * Get the Active outBound email. * * @return bool * TRUE if valid outBound email configuration found, false otherwise. diff --git a/CRM/Utils/Mail/EmailProcessor.php b/CRM/Utils/Mail/EmailProcessor.php index 28f822f02c..718fbecb43 100644 --- a/CRM/Utils/Mail/EmailProcessor.php +++ b/CRM/Utils/Mail/EmailProcessor.php @@ -117,7 +117,7 @@ class CRM_Utils_Mail_EmailProcessor { } /** - * Process the mailbox for all the settings from civicrm_mail_settings + * Process the mailbox for all the settings from civicrm_mail_settings. * * @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise. * diff --git a/CRM/Utils/Mail/Incoming.php b/CRM/Utils/Mail/Incoming.php index fe611f03a0..0c006bb9ee 100644 --- a/CRM/Utils/Mail/Incoming.php +++ b/CRM/Utils/Mail/Incoming.php @@ -408,7 +408,7 @@ class CRM_Utils_Mail_Incoming { } /** - * Retrieve a contact ID and if not present + * Retrieve a contact ID and if not present. * create one with this email */ public static function getContactID($email, $name = NULL, $create = TRUE, &$mail) { diff --git a/CRM/Utils/Migrate/ExportJSON.php b/CRM/Utils/Migrate/ExportJSON.php index 373de66e54..10ca18cf00 100644 --- a/CRM/Utils/Migrate/ExportJSON.php +++ b/CRM/Utils/Migrate/ExportJSON.php @@ -60,7 +60,7 @@ class CRM_Utils_Migrate_ExportJSON { } /** - * Split a large array of contactIDs into more manageable smaller chunks + * Split a large array of contactIDs into more manageable smaller chunks. */ public function &splitContactIDs(&$contactIDs) { // contactIDs could be a real large array, so we split it up into @@ -89,7 +89,7 @@ class CRM_Utils_Migrate_ExportJSON { } /** - * Given a set of contact IDs get the values + * Given a set of contact IDs get the values. */ public function getValues(&$contactIDs, &$additionalContactIDs) { diff --git a/CRM/Utils/Money.php b/CRM/Utils/Money.php index 9836b2a12f..22d5551dd7 100644 --- a/CRM/Utils/Money.php +++ b/CRM/Utils/Money.php @@ -40,7 +40,7 @@ class CRM_Utils_Money { static $_currencySymbols = NULL; /** - * Format a monetary string + * Format a monetary string. * * Format a monetary string basing on the amount provided, * ISO currency code provided and a format string consisting of: diff --git a/CRM/Utils/Number.php b/CRM/Utils/Number.php index c197e4b7cc..ff9c4d66d0 100644 --- a/CRM/Utils/Number.php +++ b/CRM/Utils/Number.php @@ -5,7 +5,7 @@ */ class CRM_Utils_Number { /** - * Create a random number with a given precision + * Create a random number with a given precision. * * @param array $precision * (int $significantDigits, int $postDecimalDigits). diff --git a/CRM/Utils/OptionBag.php b/CRM/Utils/OptionBag.php index 824d4d46b7..fe87d41027 100644 --- a/CRM/Utils/OptionBag.php +++ b/CRM/Utils/OptionBag.php @@ -21,7 +21,7 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { } /** - * Retrieve a value from the bag + * Retrieve a value from the bag. * * @param string $key * @param string|null $type diff --git a/CRM/Utils/PDF/Label.php b/CRM/Utils/PDF/Label.php index c6c83eda23..aa8b615c02 100644 --- a/CRM/Utils/PDF/Label.php +++ b/CRM/Utils/PDF/Label.php @@ -91,7 +91,7 @@ class CRM_Utils_PDF_Label extends TCPDF { public $countY = 0; /** - * Constructor + * Constructor. * * @param $format * Either the name of a Label Format in the Option Value table. @@ -150,7 +150,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /** - * initialize label format settings + * initialize label format settings. * * @param $format * @param $unit @@ -228,7 +228,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /** - * Print a label + * Print a label. * * @param $texte */ diff --git a/CRM/Utils/PDF/Utils.php b/CRM/Utils/PDF/Utils.php index cfb4de1f00..d6ad7bef57 100644 --- a/CRM/Utils/PDF/Utils.php +++ b/CRM/Utils/PDF/Utils.php @@ -236,7 +236,7 @@ class CRM_Utils_PDF_Utils { } /** - * convert value from one metric to another + * convert value from one metric to another. * * @param $value * @param $from diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 65b29ac741..6bfbf0a437 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -242,7 +242,7 @@ class CRM_Utils_Pager extends Pager_Sliding { } /** - * Use the pager class to get the pageId and Offset + * Use the pager class to get the pageId and Offset. * * @return array * an array of the pageID and offset @@ -315,7 +315,7 @@ class CRM_Utils_Pager extends Pager_Sliding { } /** - * Build a url for pager links + * Build a url for pager links. */ public function makeURL($key, $value) { $href = CRM_Utils_System::makeURL($key, TRUE); @@ -327,7 +327,7 @@ class CRM_Utils_Pager extends Pager_Sliding { } /** - * Output the html pager link + * Output the html pager link. * @param string $href * @param string $title * @param string $image diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php index 08ce2cf4f5..655a47ac04 100644 --- a/CRM/Utils/PagerAToZ.php +++ b/CRM/Utils/PagerAToZ.php @@ -40,7 +40,7 @@ class CRM_Utils_PagerAToZ { /** - * Returns the alphabetic array for sorting by character + * Returns the alphabetic array for sorting by character. * * @param array $query * The query object. @@ -58,7 +58,7 @@ class CRM_Utils_PagerAToZ { } /** - * Return the all the static characters + * Return the all the static characters. * * @return array * is a array of static characters @@ -96,7 +96,7 @@ class CRM_Utils_PagerAToZ { } /** - * Return the all the dynamic characters + * Return the all the dynamic characters. * * @param $query * @param $isDAO @@ -123,7 +123,7 @@ class CRM_Utils_PagerAToZ { } /** - * Create the links + * Create the links. * * @param array $query * The form values for search. diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index e64774edcf..2409cdbd2f 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -30,7 +30,7 @@ */ class CRM_Utils_PseudoConstant { /** - * CiviCRM pseudoconstant classes for wrapper functions + * CiviCRM pseudoconstant classes for wrapper functions. */ private static $constantClasses = array( 'CRM_Core_PseudoConstant', @@ -45,7 +45,7 @@ class CRM_Utils_PseudoConstant { private static $constants = NULL; /** - * Get constant + * Get constant. * * Wrapper for Pseudoconstant methods. We use this so the calling function * doesn't need to know which class the Pseudoconstant is on @@ -65,7 +65,7 @@ class CRM_Utils_PseudoConstant { } /** - * Flush constant + * Flush constant. * * Wrapper for Pseudoconstant methods. We use this so the calling function * doesn't need to know which class the Pseudoconstant is on @@ -90,7 +90,7 @@ class CRM_Utils_PseudoConstant { } /** - * Determine where a constant lives + * Determine where a constant lives. * * If there's a full, preloaded map, use it. Otherwise, use search * class space. diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php index 9a66a9febb..eed5607576 100644 --- a/CRM/Utils/REST.php +++ b/CRM/Utils/REST.php @@ -73,7 +73,7 @@ class CRM_Utils_REST { } /** - * Generates values needed for error messages + * Generates values needed for error messages. * @param string $message * * @return array diff --git a/CRM/Utils/ReCAPTCHA.php b/CRM/Utils/ReCAPTCHA.php index c04a181c9d..882556e0e4 100644 --- a/CRM/Utils/ReCAPTCHA.php +++ b/CRM/Utils/ReCAPTCHA.php @@ -51,7 +51,7 @@ class CRM_Utils_ReCAPTCHA { static private $_singleton = NULL; /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * * @return object @@ -69,7 +69,7 @@ class CRM_Utils_ReCAPTCHA { } /** - * Add element to form + * Add element to form. */ public static function add(&$form) { $error = NULL; diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php index aa66d55454..d8b45a323a 100644 --- a/CRM/Utils/Recent.php +++ b/CRM/Utils/Recent.php @@ -39,21 +39,21 @@ class CRM_Utils_Recent { /** - * Max number of items in queue + * Max number of items in queue. * * @int */ const MAX_ITEMS = 10, STORE_NAME = 'CRM_Utils_Recent'; /** - * The list of recently viewed items + * The list of recently viewed items. * * @var array */ static private $_recent = NULL; /** - * Initialize this class and set the static variables + * Initialize this class and set the static variables. * * @return void */ @@ -68,7 +68,7 @@ class CRM_Utils_Recent { } /** - * Return the recently viewed array + * Return the recently viewed array. * * @return array * the recently viewed array @@ -79,7 +79,7 @@ class CRM_Utils_Recent { } /** - * Add an item to the recent stack + * Add an item to the recent stack. * * @param string $title * The title to display. @@ -144,7 +144,7 @@ class CRM_Utils_Recent { } /** - * Delete an item from the recent stack + * Delete an item from the recent stack. * * @param array $recentItem * Array of the recent Item to be removed. @@ -172,7 +172,7 @@ class CRM_Utils_Recent { } /** - * Delete an item from the recent stack + * Delete an item from the recent stack. * * @param string $id * Contact id that had to be removed. diff --git a/CRM/Utils/Rule.php b/CRM/Utils/Rule.php index dec94a40b6..6526da977e 100644 --- a/CRM/Utils/Rule.php +++ b/CRM/Utils/Rule.php @@ -614,7 +614,7 @@ class CRM_Utils_Rule { } /** - * Check if there is a record with the same name in the db + * Check if there is a record with the same name in the db. * * @param string $value * The value of the field we are checking. diff --git a/CRM/Utils/SQL/Insert.php b/CRM/Utils/SQL/Insert.php index 11b0052080..0f94442729 100644 --- a/CRM/Utils/SQL/Insert.php +++ b/CRM/Utils/SQL/Insert.php @@ -40,7 +40,7 @@ class CRM_Utils_SQL_Insert { private $columns; /** - * Create a new INSERT query + * Create a new INSERT query. * * @param string $table * Table-name and optional alias. @@ -51,7 +51,7 @@ class CRM_Utils_SQL_Insert { } /** - * Create a new SELECT query + * Create a new SELECT query. * * @param string $table * Table-name and optional alias. @@ -98,7 +98,7 @@ class CRM_Utils_SQL_Insert { } /** - * Use REPLACE INTO instead of INSERT INTO + * Use REPLACE INTO instead of INSERT INTO. * * @param bool $asReplace * @return CRM_Utils_SQL_Insert diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php index cdbb1b926a..79560acb6c 100644 --- a/CRM/Utils/SQL/Select.php +++ b/CRM/Utils/SQL/Select.php @@ -45,7 +45,7 @@ class CRM_Utils_SQL_Select { private $offset = NULL; /** - * Create a new SELECT query + * Create a new SELECT query. * * @param string $from * Table-name and optional alias. @@ -56,7 +56,7 @@ class CRM_Utils_SQL_Select { } /** - * Create a new SELECT query + * Create a new SELECT query. * * @param string $from * Table-name and optional alias. @@ -66,7 +66,7 @@ class CRM_Utils_SQL_Select { } /** - * Add a new JOIN clause + * Add a new JOIN clause. * * @param string $name * The effective alias of the joined table. @@ -111,7 +111,7 @@ class CRM_Utils_SQL_Select { } /** - * Group results by adding extra items to the GROUP BY clause + * Group results by adding extra items to the GROUP BY clause. * * @param string|array $exprs list of SQL expressions * @param null|array $args use NULL to disable interpolation; use an array of variables to enable @@ -141,7 +141,7 @@ class CRM_Utils_SQL_Select { } /** - * Sort results by adding extra items to the ORDER BY clause + * Sort results by adding extra items to the ORDER BY clause. * * @param string|array $exprs list of SQL expressions * @param null|array $args use NULL to disable interpolation; use an array of variables to enable @@ -156,7 +156,7 @@ class CRM_Utils_SQL_Select { } /** - * Set a limit on the number of records to return + * Set a limit on the number of records to return. * * @param int $limit * @param int $offset diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php index 6a972beb05..9c7a34f202 100644 --- a/CRM/Utils/SoapServer.php +++ b/CRM/Utils/SoapServer.php @@ -82,7 +82,7 @@ class CRM_Utils_SoapServer { } /** - * Verify a SOAP key + * Verify a SOAP key. * * @param string $key * The soap key generated by authenticate(). @@ -112,7 +112,7 @@ class CRM_Utils_SoapServer { } /** - * Authentication wrapper to the UF Class + * Authentication wrapper to the UF Class. * * @param string $name * Login name. @@ -147,7 +147,7 @@ class CRM_Utils_SoapServer { } /** - * MAILER API + * MAILER API. */ public function mailer_event_bounce($key, $job, $queue, $hash, $body) { $this->verify($key); diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index 8f4bdd77f9..84a1d29b7f 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -146,7 +146,7 @@ class CRM_Utils_Sort { } /** - * Function returns the string for the order by clause + * Function returns the string for the order by clause. * * @return string * the order by clause @@ -169,7 +169,7 @@ class CRM_Utils_Sort { } /** - * Create the sortID string to be used in the GET param + * Create the sortID string to be used in the GET param. * * @param int $index * The field index. @@ -184,7 +184,7 @@ class CRM_Utils_Sort { } /** - * Init the sort ID values in the object + * Init the sort ID values in the object. * * @param string $defaultSortOrder * The sort order to use by default. @@ -221,7 +221,7 @@ class CRM_Utils_Sort { } /** - * Init the object + * Init the object. * * @param string $defaultSortOrder * The sort order to use by default. @@ -257,7 +257,7 @@ class CRM_Utils_Sort { } /** - * Getter for currentSortID + * Getter for currentSortID. * * @return int * returns of the current sort id @@ -268,7 +268,7 @@ class CRM_Utils_Sort { } /** - * Getter for currentSortDirection + * Getter for currentSortDirection. * * @return int * returns of the current sort direction diff --git a/CRM/Utils/String.php b/CRM/Utils/String.php index ecf80f8935..b561cad091 100644 --- a/CRM/Utils/String.php +++ b/CRM/Utils/String.php @@ -23,20 +23,19 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ require_once 'HTML/QuickForm/Rule/Email.php'; /** - * This class contains string functions + * This class contains string functions. * */ class CRM_Utils_String { @@ -48,8 +47,7 @@ class CRM_Utils_String { const ALPHANUMERIC = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'; /** - * Convert a display name into a potential variable - * name that we could use in forms/code + * Convert a display name into a potential variable name. * * @param $title title of the string * @param int $maxLength @@ -70,8 +68,7 @@ class CRM_Utils_String { } /** - * Given a string, replace all non alpha numeric characters and - * spaces with the replacement character + * Replace all non alpha numeric characters and spaces with the replacement character. * * @param string $name * The name to be worked on. @@ -80,12 +77,11 @@ class CRM_Utils_String { * @param int $len * Length of valid variables. * - * * @return string * returns the manipulated string */ public static function munge($name, $char = '_', $len = 63) { - // replace all white space and non-alpha numeric with $char + // Replace all white space and non-alpha numeric with $char // we only use the ascii character set since mysql does not create table names / field names otherwise // CRM-11744 $name = preg_replace('/[^a-zA-Z0-9]+/', $char, trim($name)); @@ -120,7 +116,7 @@ class CRM_Utils_String { } /** - * Takes a variable name and munges it randomly into another variable name + * Takes a variable name and munges it randomly into another variable name. * * @param string $name * Initial Variable Name. @@ -137,7 +133,8 @@ class CRM_Utils_String { /** * Takes a string and returns the last tuple of the string. - * useful while converting file names to class names etc + * + * Useful while converting file names to class names etc * * @param string $string * The input string. @@ -159,7 +156,8 @@ class CRM_Utils_String { /** * Appends a name to a string and separated by delimiter. - * does the right thing for an empty string + * + * Does the right thing for an empty string * * @param string $str * The string to be appended to. @@ -167,8 +165,6 @@ class CRM_Utils_String { * The delimiter to use. * @param mixed $name * The string (or array of strings) to append. - * - * @return void */ public static function append(&$str, $delim, $name) { if (empty($name)) { @@ -199,7 +195,7 @@ class CRM_Utils_String { } /** - * Determine if the string is composed only of ascii characters + * Determine if the string is composed only of ascii characters. * * @param string $str * Input string. @@ -242,7 +238,7 @@ class CRM_Utils_String { } /** - * Determine the string replacements for redaction + * Determine the string replacements for redaction. * on the basis of the regular expressions * * @param string $str @@ -358,7 +354,7 @@ class CRM_Utils_String { } /** - * Extract the civicrm path from the url + * Extract the civicrm path from the url. * * @param string $query * A url string. @@ -660,7 +656,7 @@ class CRM_Utils_String { } /** - * Generate a random string + * Generate a random string. * * @param $len * @param $alphabet @@ -725,7 +721,7 @@ class CRM_Utils_String { } /** - * This function compares two strings + * This function compares two strings. * * @param string $strOne * String one. @@ -778,7 +774,7 @@ class CRM_Utils_String { } /** - * Formats a string of attributes for insertion in an html tag + * Formats a string of attributes for insertion in an html tag. * * @param array $attributes * diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index e5c245eeba..bde66d9a5e 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -286,7 +286,7 @@ class CRM_Utils_System { } /** - * this is a very drupal specific function for now + * this is a very drupal specific function for now. */ public static function updateCategories() { $config = CRM_Core_Config::singleton(); @@ -489,7 +489,7 @@ class CRM_Utils_System { } /** - * Determine the post URL for a form + * Determine the post URL for a form. * * @param $action * The default action if one is pre-specified. @@ -1342,7 +1342,7 @@ class CRM_Utils_System { } /** - * Get the locale set in the hosting CMS + * Get the locale set in the hosting CMS. * * @return string * The used locale or null for none. @@ -1822,7 +1822,7 @@ class CRM_Utils_System { } /** - * Determine the standard URL for viewing or editing the specified link + * Determine the standard URL for viewing or editing the specified link. * * This function delegates the decision-making to (a) the hook system and * (b) the BAO system. diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index 475841d39b..7b827f87fe 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -48,7 +48,7 @@ abstract class CRM_Utils_System_Base { var $supports_form_extensions = FALSE; /** - * Append an additional breadcrumb tag to the existing breadcrumb + * Append an additional breadcrumb tag to the existing breadcrumb. * * @param array $breadCrumbs */ @@ -56,13 +56,13 @@ abstract class CRM_Utils_System_Base { } /** - * Reset an additional breadcrumb tag to the existing breadcrumb + * Reset an additional breadcrumb tag to the existing breadcrumb. */ public function resetBreadCrumb() { } /** - * Append a string to the head of the html file + * Append a string to the head of the html file. * * @param string $head * The new string to be appended. @@ -71,14 +71,14 @@ abstract class CRM_Utils_System_Base { } /** - * Rewrite various system urls to https + * Rewrite various system urls to https. */ public function mapConfigToSSL() { // dont need to do anything, let CMS handle their own switch to SSL } /** - * Figure out the post url for QuickForm + * Figure out the post url for QuickForm. * * @param string $action * The default url if one is pre-specified. @@ -131,7 +131,7 @@ abstract class CRM_Utils_System_Base { } /** - * Authenticate the user against the CMS db + * Authenticate the user against the CMS db. * * @param string $name * The user name. @@ -150,7 +150,7 @@ abstract class CRM_Utils_System_Base { } /** - * Set a message in the CMS to display to a user + * Set a message in the CMS to display to a user. * * @param string $message * The message to set. @@ -159,7 +159,7 @@ abstract class CRM_Utils_System_Base { } /** - * Load user into session + * Load user into session. * * @param $user * @@ -194,7 +194,7 @@ abstract class CRM_Utils_System_Base { } /** - * Get the locale set in the CMS + * Get the locale set in the CMS. * * @return string|null * Locale or null for none @@ -282,7 +282,7 @@ abstract class CRM_Utils_System_Base { } /** - * Get CMS Version + * Get CMS Version. * * @return string */ @@ -377,7 +377,7 @@ abstract class CRM_Utils_System_Base { } /** - * Determine the native ID of the CMS user + * Determine the native ID of the CMS user. * * @param string $username * @@ -389,7 +389,7 @@ abstract class CRM_Utils_System_Base { } /** - * Set a init session with user object + * Set a init session with user object. * * @param array $data * Array with user specific data @@ -417,7 +417,7 @@ abstract class CRM_Utils_System_Base { } /** - * Add a script file + * Add a script file. * * Note: This function is not to be called directly * @see CRM_Core_Region::render() @@ -434,7 +434,7 @@ abstract class CRM_Utils_System_Base { } /** - * Add an inline script + * Add an inline script. * * Note: This function is not to be called directly * @see CRM_Core_Region::render() @@ -451,7 +451,7 @@ abstract class CRM_Utils_System_Base { } /** - * Add a css file + * Add a css file. * * Note: This function is not to be called directly * @see CRM_Core_Region::render() @@ -468,7 +468,7 @@ abstract class CRM_Utils_System_Base { } /** - * Add an inline style + * Add an inline style. * * Note: This function is not to be called directly * @see CRM_Core_Region::render() @@ -485,7 +485,7 @@ abstract class CRM_Utils_System_Base { } /** - * Sets the title of the page + * Sets the title of the page. * * @param string $title * Title to set in html header @@ -496,7 +496,7 @@ abstract class CRM_Utils_System_Base { } /** - * Return default Site Settings + * Return default Site Settings. * * @param string $dir * @@ -524,7 +524,7 @@ abstract class CRM_Utils_System_Base { } /** - * Set timezone in mysql so that timestamp fields show the correct time + * Set timezone in mysql so that timestamp fields show the correct time. */ public function setMySQLTimeZone() { $timeZoneOffset = $this->getTimeZoneOffset(); @@ -536,7 +536,7 @@ abstract class CRM_Utils_System_Base { /** - * Get timezone from CMS + * Get timezone from CMS. * * @return string|false|null */ @@ -562,7 +562,7 @@ abstract class CRM_Utils_System_Base { } /** - * Get timezone as a string + * Get timezone as a string. * @return string * Timezone string e.g. 'America/Los_Angeles' */ @@ -658,7 +658,7 @@ abstract class CRM_Utils_System_Base { } /** - * Get Url to view user record + * Get Url to view user record. * @param int $contactID * Contact ID. * @@ -669,7 +669,7 @@ abstract class CRM_Utils_System_Base { } /** - * Is the current user permitted to add a user + * Is the current user permitted to add a user. * @return bool */ public function checkPermissionAddUser() { @@ -677,7 +677,7 @@ abstract class CRM_Utils_System_Base { } /** - * Output code from error function + * Output code from error function. * @param string $content */ public function outputError($content) { @@ -685,7 +685,7 @@ abstract class CRM_Utils_System_Base { } /** - * Log error to CMS + * Log error to CMS. * * $param string $message */ @@ -693,7 +693,7 @@ abstract class CRM_Utils_System_Base { } /** - * Append to coreResourcesList + * Append to coreResourcesList. * * @param array $list */ diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 5b7c1842be..b57ad32255 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -105,7 +105,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { } /** - * Check if username and email exists in the drupal db + * Check if username and email exists in the drupal db. * * @param array $params * Array of name and mail values. @@ -413,7 +413,7 @@ AND u.status = 1 } /** - * Determine the native ID of the CMS user + * Determine the native ID of the CMS user. * * @param string $username * @return int|NULL @@ -435,7 +435,7 @@ AND u.status = 1 } /** - * Get the default location for CiviCRM blocks + * Get the default location for CiviCRM blocks. * * @return string */ @@ -444,7 +444,7 @@ AND u.status = 1 } /** - * Load drupal bootstrap + * Load drupal bootstrap. * * @param array $params * Either uid, or name & pass. @@ -713,7 +713,7 @@ AND u.status = 1 } /** - * Wrapper for og_membership creation + * Wrapper for og_membership creation. * * @param int $ogID * Organic Group ID. @@ -736,7 +736,7 @@ AND u.status = 1 } /** - * Wrapper for og_membership deletion + * Wrapper for og_membership deletion. * * @param int $ogID * Organic Group ID. diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index 00ca7055f7..ca5370729d 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -129,7 +129,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Check if username and email exists in the drupal db + * Check if username and email exists in the drupal db. * * @param array $params * Array of name and mail values. @@ -249,7 +249,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Append a string to the head of the html file + * Append a string to the head of the html file. * * @param string $head * The new string to be appended. @@ -261,7 +261,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Add a css file + * Add a css file. * * @param $url : string, absolute path to file * @param string $region @@ -375,7 +375,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Determine the native ID of the CMS user + * Determine the native ID of the CMS user. * * @param string $username * @return int|NULL @@ -397,7 +397,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Load drupal bootstrap + * Load drupal bootstrap. * * @param array $params * Either uid, or name & pass. @@ -701,7 +701,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Wrapper for og_membership creation + * Wrapper for og_membership creation. * * @param int $ogID * Organic Group ID. @@ -713,7 +713,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * Wrapper for og_membership deletion + * Wrapper for og_membership deletion. * * @param int $ogID * Organic Group ID. diff --git a/CRM/Utils/System/Drupal8.php b/CRM/Utils/System/Drupal8.php index d95d91a248..ae5c9dc898 100644 --- a/CRM/Utils/System/Drupal8.php +++ b/CRM/Utils/System/Drupal8.php @@ -120,7 +120,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * Check if username and email exists in the drupal db + * Check if username and email exists in the drupal db. * * @param array $params * Array of name and mail values. @@ -278,7 +278,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * Check if a resource url is within the drupal directory and format appropriately + * Check if a resource url is within the drupal directory and format appropriately. * * This seems to be a legacy function. We assume all resources are within the drupal * directory and always return TRUE. As well, we clean up the $url. @@ -377,7 +377,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * Determine the native ID of the CMS user + * Determine the native ID of the CMS user. * * @param string $username * @return int|NULL @@ -404,7 +404,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * Load drupal bootstrap + * Load drupal bootstrap. * * @param array $params * Either uid, or name & pass. diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index 624866bd92..b831dc5092 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -84,7 +84,7 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { } /** - * Check if a resource url is within the drupal directory and format appropriately + * Check if a resource url is within the drupal directory and format appropriately. * * @param $url (reference) * @@ -281,7 +281,7 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { } /** - * Append Drupal js to coreResourcesList + * Append Drupal js to coreResourcesList. */ public function appendCoreResources(&$list) { $list[] = 'js/crm.drupal.js'; diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index a1272e8dd3..5172444496 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -109,7 +109,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Check if username and email exists in the drupal db + * Check if username and email exists in the drupal db. * * @param array $params * Array of name and mail values. @@ -314,7 +314,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Set the email address of the user + * Set the email address of the user. * * @param object $user * Handle to the user object. @@ -421,7 +421,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Set a init session with user object + * Set a init session with user object. * * @param array $data * Array with user specific data. @@ -489,7 +489,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Load joomla bootstrap + * Load joomla bootstrap. * * @param array $params * with uid or name and password. @@ -703,7 +703,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Output code from error function + * Output code from error function. * @param string $content */ public function outputError($content) { @@ -720,7 +720,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * Append Joomla js to coreResourcesList + * Append Joomla js to coreResourcesList. */ public function appendCoreResources(&$list) { $list[] = 'js/crm.joomla.js'; diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php index b96ba20d97..2f66d5d980 100644 --- a/CRM/Utils/System/Soap.php +++ b/CRM/Utils/System/Soap.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { /** - * UF container variables + * UF container variables. */ static $uf = NULL; static $ufClass = NULL; @@ -80,7 +80,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { } /** - * Set the email address of the user + * Set the email address of the user. * * @param object $user * Handle to the user object. @@ -105,7 +105,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { } /** - * Swap the current UF for soap + * Swap the current UF for soap. */ public function swapUF() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index 2a76d999ad..55171a1583 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -125,7 +125,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * WP action callback + * WP action callback. */ public static function _showHTMLHead() { $region = CRM_Core_Region::instance('wp_head', FALSE); @@ -326,7 +326,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * Load wordpress bootstrap + * Load wordpress bootstrap. * * @param string $name * optional username for login. diff --git a/CRM/Utils/Time.php b/CRM/Utils/Time.php index 50a829d0a4..6d1962a523 100644 --- a/CRM/Utils/Time.php +++ b/CRM/Utils/Time.php @@ -44,7 +44,7 @@ class CRM_Utils_Time { static private $_delta = 0; /** - * Get the time + * Get the time. * * @param string $returnFormat * Format in which date is to be retrieved. @@ -57,7 +57,7 @@ class CRM_Utils_Time { } /** - * Get the time + * Get the time. * * @return int, seconds since epoch */ @@ -66,7 +66,7 @@ class CRM_Utils_Time { } /** - * Set the given time + * Set the given time. * * @param string $newDateTime * A date formatted with strtotime. @@ -82,7 +82,7 @@ class CRM_Utils_Time { } /** - * Remove any time overrides + * Remove any time overrides. */ public static function resetTime() { self::$_delta = 0; diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index ae0b29f170..7434d380d5 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -142,7 +142,7 @@ class CRM_Utils_Token { } /** - * Wrapper for token matching + * Wrapper for token matching. * * @param string $type * The token type (domain,mailing,contact,action). @@ -160,7 +160,7 @@ class CRM_Utils_Token { } /** - * Wrapper for token replacing + * Wrapper for token replacing. * * @param string $type * The token type. @@ -201,7 +201,7 @@ class CRM_Utils_Token { } /** - * Escape the string so a malicious user cannot inject smarty code into the template + * Escape the string so a malicious user cannot inject smarty code into the template. * * @param string $string * A string that needs to be escaped from smarty parsing. @@ -808,7 +808,7 @@ class CRM_Utils_Token { } /** - * Parse html through Smarty resolving any smarty functions + * Parse html through Smarty resolving any smarty functions. * @param string $tokenHtml * @param array $entity * @param string $entityType @@ -869,7 +869,7 @@ class CRM_Utils_Token { } /** - * Replace unsubscribe tokens + * Replace unsubscribe tokens. * * @param string $str * The string with tokens to be replaced. @@ -915,7 +915,7 @@ class CRM_Utils_Token { } /** - * Replace resubscribe tokens + * Replace resubscribe tokens. * * @param string $str * The string with tokens to be replaced. @@ -1048,7 +1048,7 @@ class CRM_Utils_Token { } /** - * Find and replace tokens for each component + * Find and replace tokens for each component. * * @param string $str * The string to search. @@ -1087,7 +1087,7 @@ class CRM_Utils_Token { } /** - * Get array of string tokens + * Get array of string tokens. * * @param string $string * The input string to parse for tokens. @@ -1390,7 +1390,7 @@ class CRM_Utils_Token { } /** - * Get Membership Token Details + * Get Membership Token Details. * @param array $membershipIDs * Array of membership IDS. */ @@ -1577,7 +1577,7 @@ class CRM_Utils_Token { } /** - * Store membership tokens on the static _tokens array + * Store membership tokens on the static _tokens array. */ protected static function _buildMembershipTokens() { $key = 'membership'; @@ -1592,7 +1592,7 @@ class CRM_Utils_Token { } /** - * Replace tokens for an entity + * Replace tokens for an entity. * @param string $entity * @param array $entityArray * (e.g. in format from api). @@ -1620,7 +1620,7 @@ class CRM_Utils_Token { } /** - * Replace Contribution tokens in html + * Replace Contribution tokens in html. * * @param string $str * @param array $contribution diff --git a/CRM/Utils/Tree.php b/CRM/Utils/Tree.php index 19ecf80bf2..f2fa6a426a 100644 --- a/CRM/Utils/Tree.php +++ b/CRM/Utils/Tree.php @@ -80,7 +80,7 @@ class CRM_Utils_Tree { /** - * Store the tree information as a string or array + * Store the tree information as a string or array. * @var string|array */ private $tree; @@ -103,7 +103,7 @@ class CRM_Utils_Tree { } /** - * Find a node that matches the given string + * Find a node that matches the given string. * * @param string $name * Name of the node we are searching for. @@ -153,7 +153,7 @@ class CRM_Utils_Tree { } /** - * Create a node + * Create a node. * * @param string $name * @@ -169,7 +169,7 @@ class CRM_Utils_Tree { } /** - * Add node + * Add node. * * @param string $parentName * Name of the parent ?. @@ -185,7 +185,7 @@ class CRM_Utils_Tree { } /** - * Add Data + * Add Data. * * @param string $parentName Name of the parent ?. * @param string $childName - key to be used (optional) @@ -206,7 +206,7 @@ class CRM_Utils_Tree { } /** - * Get Tree + * Get Tree. * * @return tree */ @@ -215,7 +215,7 @@ class CRM_Utils_Tree { } /** - * Print the tree + * Print the tree. * * @return void */ diff --git a/CRM/Utils/Type.php b/CRM/Utils/Type.php index 62da0e4c3a..76f40c26e1 100644 --- a/CRM/Utils/Type.php +++ b/CRM/Utils/Type.php @@ -265,7 +265,7 @@ class CRM_Utils_Type { } /** - * Verify that a variable is of a given type + * Verify that a variable is of a given type. * * @param mixed $data * The value to validate. diff --git a/CRM/Utils/Verp.php b/CRM/Utils/Verp.php index afe1a6849c..0e62cbbe05 100644 --- a/CRM/Utils/Verp.php +++ b/CRM/Utils/Verp.php @@ -90,7 +90,7 @@ class CRM_Utils_Verp { } /** - * Decode the address and return the sender and recipient as an array + * Decode the address and return the sender and recipient as an array. * * @param string $address * The address to be decoded. diff --git a/CRM/Utils/VersionCheck.php b/CRM/Utils/VersionCheck.php index d1e8fa12e1..4f69360970 100644 --- a/CRM/Utils/VersionCheck.php +++ b/CRM/Utils/VersionCheck.php @@ -95,7 +95,7 @@ class CRM_Utils_VersionCheck { protected $cacheFile; /** - * Class constructor + * Class constructor. */ public function __construct() { global $civicrm_root; @@ -130,7 +130,7 @@ class CRM_Utils_VersionCheck { } /** - * Static instance provider + * Static instance provider. * * Method providing static instance of CRM_Utils_VersionCheck, * as in Singleton pattern @@ -145,7 +145,7 @@ class CRM_Utils_VersionCheck { } /** - * Finds the release info for a minor version + * Finds the release info for a minor version. * @param string $version * @return array|null */ @@ -238,7 +238,7 @@ class CRM_Utils_VersionCheck { } /** - * Alert the site admin of new versions of CiviCRM + * Alert the site admin of new versions of CiviCRM. * Show the message once a day */ public function versionAlert() { @@ -278,7 +278,7 @@ class CRM_Utils_VersionCheck { } /** - * Collect info about the site to be sent as pingback data + * Collect info about the site to be sent as pingback data. */ private function getSiteStats() { $config = CRM_Core_Config::singleton(); @@ -306,7 +306,7 @@ class CRM_Utils_VersionCheck { } /** - * Get active payment processor types + * Get active payment processor types. */ private function getPayProcStats() { $dao = new CRM_Financial_DAO_PaymentProcessor(); @@ -325,7 +325,7 @@ class CRM_Utils_VersionCheck { } /** - * Fetch counts from entity tables + * Fetch counts from entity tables. * Add info to the 'entities' array */ private function getEntityStats() { @@ -435,7 +435,7 @@ class CRM_Utils_VersionCheck { } /** - * Save version info to file + * Save version info to file. * @param string $contents */ private function writeCacheFile($contents) { diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php index 3f573db372..9e9d5f5087 100644 --- a/CRM/Utils/Wrapper.php +++ b/CRM/Utils/Wrapper.php @@ -40,7 +40,7 @@ class CRM_Utils_Wrapper { /** - * Simple Controller + * Simple Controller. * * The controller which will handle the display and processing of this page. */ diff --git a/CRM/Utils/XML.php b/CRM/Utils/XML.php index cd60cd3a0e..1128b75669 100644 --- a/CRM/Utils/XML.php +++ b/CRM/Utils/XML.php @@ -119,7 +119,7 @@ class CRM_Utils_XML { } /** - * Convert an XML element to an array + * Convert an XML element to an array. * * @param $obj * SimpleXMLElement. diff --git a/CRM/Utils/Zip.php b/CRM/Utils/Zip.php index d81b3ed05c..078bab427e 100644 --- a/CRM/Utils/Zip.php +++ b/CRM/Utils/Zip.php @@ -93,7 +93,7 @@ class CRM_Utils_Zip { } /** - * Determine the name of the folder within a zip + * Determine the name of the folder within a zip. * * @param ZipArchive $zip * @param $expected diff --git a/Civi/API/Events.php b/Civi/API/Events.php index cc51ff6258..2e49067194 100644 --- a/Civi/API/Events.php +++ b/Civi/API/Events.php @@ -71,7 +71,7 @@ class Events { const RESPOND = 'api.respond'; /** - * Handle any exceptions + * Handle any exceptions. * * @see ExceptionEvent */ diff --git a/Civi/API/Provider/MagicFunctionProvider.php b/Civi/API/Provider/MagicFunctionProvider.php index 601f2f6d2e..b1438955d3 100644 --- a/Civi/API/Provider/MagicFunctionProvider.php +++ b/Civi/API/Provider/MagicFunctionProvider.php @@ -163,7 +163,7 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa } /** - * Look up the implementation for a given API request + * Look up the implementation for a given API request. * * @param array $apiRequest * Array with keys: diff --git a/Civi/API/Subscriber/ChainSubscriber.php b/Civi/API/Subscriber/ChainSubscriber.php index 3d17bf277a..0a230cdea1 100644 --- a/Civi/API/Subscriber/ChainSubscriber.php +++ b/Civi/API/Subscriber/ChainSubscriber.php @@ -75,7 +75,7 @@ class ChainSubscriber implements EventSubscriberInterface { } /** - * Call any nested api calls + * Call any nested api calls. * * TODO: We don't really need this to be a separate function. * @param $params diff --git a/Civi/API/Subscriber/TransactionSubscriber.php b/Civi/API/Subscriber/TransactionSubscriber.php index b5e867e81f..9ac315be1a 100644 --- a/Civi/API/Subscriber/TransactionSubscriber.php +++ b/Civi/API/Subscriber/TransactionSubscriber.php @@ -69,7 +69,7 @@ class TransactionSubscriber implements EventSubscriberInterface { private $forceRollback = array(); /** - * Determine if an API request should be treated as transactional + * Determine if an API request should be treated as transactional. * * @param \Civi\API\Provider\ProviderInterface $apiProvider * The API provider responsible for this request. @@ -144,7 +144,7 @@ class TransactionSubscriber implements EventSubscriberInterface { } /** - * Close any pending transactions + * Close any pending transactions. * * @param \Civi\API\Event\RespondEvent $event * API response event. @@ -160,7 +160,7 @@ class TransactionSubscriber implements EventSubscriberInterface { } /** - * Rollback the pending transaction + * Rollback the pending transaction. * * @param \Civi\API\Event\ExceptionEvent $event * API exception event. diff --git a/Civi/Angular/Manager.php b/Civi/Angular/Manager.php index 215d7e1a26..99f8942bfc 100644 --- a/Civi/Angular/Manager.php +++ b/Civi/Angular/Manager.php @@ -37,7 +37,7 @@ class Manager { } /** - * Get a list of AngularJS modules which should be autoloaded + * Get a list of AngularJS modules which should be autoloaded. * * @return array * Each item has some combination of these keys: diff --git a/Civi/Angular/Page/Main.php b/Civi/Angular/Page/Main.php index 8a4686ef64..795120f10e 100644 --- a/Civi/Angular/Page/Main.php +++ b/Civi/Angular/Page/Main.php @@ -9,7 +9,7 @@ namespace Civi\Angular\Page; */ class Main extends \CRM_Core_Page { /** - * The weight to assign to any Angular JS module files + * The weight to assign to any Angular JS module files. */ const DEFAULT_MODULE_WEIGHT = 200; diff --git a/Civi/CCase/Analyzer.php b/Civi/CCase/Analyzer.php index 28b9b371ac..535e590db5 100644 --- a/Civi/CCase/Analyzer.php +++ b/Civi/CCase/Analyzer.php @@ -106,7 +106,7 @@ class Analyzer { } /** - * Get a list of all activities in the case + * Get a list of all activities in the case. * * @return array * list of activity records (api/v3 format) @@ -131,7 +131,7 @@ class Analyzer { } /** - * Get a single activity record by type + * Get a single activity record by type. * * @param string $type * @throws \Civi\CCase\Exception\MultipleActivityException @@ -215,7 +215,7 @@ class Analyzer { } /** - * Flush any cached information + * Flush any cached information. * * @return void */ diff --git a/Civi/CCase/Events.php b/Civi/CCase/Events.php index db794dbd96..cc03a28121 100644 --- a/Civi/CCase/Events.php +++ b/Civi/CCase/Events.php @@ -94,7 +94,7 @@ class Events { } /** - * Find any extra listeners declared in XML and pass the event along to them + * Find any extra listeners declared in XML and pass the event along to them. * * @param \Civi\CCase\Event\CaseChangeEvent $event */ diff --git a/Civi/Core/Transaction/Frame.php b/Civi/Core/Transaction/Frame.php index cf7fb75c92..a6fe9af8c4 100644 --- a/Civi/Core/Transaction/Frame.php +++ b/Civi/Core/Transaction/Frame.php @@ -158,7 +158,7 @@ class Frame { } /** - * Add a transaction callback + * Add a transaction callback. * * Pre-condition: isActive() * diff --git a/Civi/Install/Requirements.php b/Civi/Install/Requirements.php index 643906fc3f..d7811458eb 100644 --- a/Civi/Install/Requirements.php +++ b/Civi/Install/Requirements.php @@ -102,7 +102,7 @@ class Requirements { } /** - * Check configured php Memory + * Check configured php Memory. * @return array */ public function checkMemory() { @@ -133,7 +133,7 @@ class Requirements { } /** - * Get Configured PHP memory + * Get Configured PHP memory. * @return float */ protected function getPHPMemory() { diff --git a/install/index.php b/install/index.php index b105e05122..2b675c9507 100644 --- a/install/index.php +++ b/install/index.php @@ -278,7 +278,7 @@ class InstallRequirements { const MINIMUM_THREAD_STACK = 192; /** - * Just check that the database configuration is okay + * Just check that the database configuration is okay. * @param $databaseConfig * @param $dbName */ @@ -398,7 +398,7 @@ class InstallRequirements { } /** - * Check everything except the database + * Check everything except the database. */ public function check() { global $crmPath, $installType; diff --git a/tests/extensions/test.extension.manager.reporttest/main.php b/tests/extensions/test.extension.manager.reporttest/main.php index 8d216176e4..66e29af22c 100644 --- a/tests/extensions/test.extension.manager.reporttest/main.php +++ b/tests/extensions/test.extension.manager.reporttest/main.php @@ -5,6 +5,7 @@ */ class test_extension_manager_reporttest extends CRM_Core_Report { /** + * Class constructor. */ public function __construct() { $logging = new CRM_Logging_Schema(); diff --git a/tests/phpunit/CRM/Activity/BAO/ActivityTargetTest.php b/tests/phpunit/CRM/Activity/BAO/ActivityTargetTest.php index 7d37416ed3..aa3bb90782 100644 --- a/tests/phpunit/CRM/Activity/BAO/ActivityTargetTest.php +++ b/tests/phpunit/CRM/Activity/BAO/ActivityTargetTest.php @@ -45,14 +45,14 @@ class CRM_Activity_BAO_ActivityTargetTest extends CiviUnitTestCase { /** * Tears down the fixture, for example, closes a network connection. + * * This method is called after a test is executed. */ protected function tearDown() { } public function testRetrieveTargetIdsByActivityIdZeroID() { - $activity = $this->activityCreate(); - + $this->activityCreate(); $target = CRM_Activity_BAO_ActivityTarget::retrieveTargetIdsByActivityId(0); $this->assertSame($target, array(), 'No targets returned'); } diff --git a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php index 349b52d542..d35e70c666 100644 --- a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php +++ b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php @@ -17,8 +17,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcases for create() method - * create() method Add/Edit activity. + * Test case for create() method. */ public function testCreate() { $contactId = Contact::createIndividual(); @@ -57,8 +56,9 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcase for getContactActivity() method. - * getContactActivity() method get activities detail for given target contact id + * Test case for getContactActivity() method. + * + * getContactActivity() method get activities detail for given target contact id. */ public function testGetContactActivity() { $contactId = Contact::createIndividual(); @@ -92,8 +92,9 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcase for retrieve() method. - * retrieve($params, $defaults) method return activity detail for given params + * Test case for retrieve() method. + * + * Retrieve($params, $defaults) method return activity detail for given params * and set defaults. */ public function testRetrieve() { @@ -140,7 +141,8 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcase for deleteActivity() method. + * Test case for deleteActivity() method. + * * deleteActivity($params) method deletes activity for given params. */ public function testDeleteActivity() { @@ -187,7 +189,8 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcase for deleteActivityTarget() method. + * Test case for deleteActivityTarget() method. + * * deleteActivityTarget($activityId) method deletes activity target for given activity id. */ public function testDeleteActivityTarget() { @@ -228,7 +231,8 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Testcase for deleteActivityAssignment() method. + * Test case for deleteActivityAssignment() method. + * * deleteActivityAssignment($activityId) method deletes activity assignment for given activity id. */ public function testDeleteActivityAssignment() { diff --git a/tests/phpunit/CRM/Batch/Form/EntryTest.php b/tests/phpunit/CRM/Batch/Form/EntryTest.php index cdc252b01f..f9a7b44c97 100644 --- a/tests/phpunit/CRM/Batch/Form/EntryTest.php +++ b/tests/phpunit/CRM/Batch/Form/EntryTest.php @@ -35,36 +35,36 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class CRM_Batch_Form_EntryTest extends CiviUnitTestCase { /** - * Membership type name used in test function + * Membership type name used in test function. * @var String */ protected $_membershipTypeName = NULL; /** - * Membership type id used in test function + * Membership type id used in test function. * @var String */ protected $_membershipTypeID = NULL; /** - * Contact id used in test function + * Contact id used in test function. * @var String */ protected $_contactID = NULL; /** - * Contact id used in test function + * Contact id used in test function. * @var String */ protected $_contactID2 = NULL; /** - * Contact id used in test function + * Contact id used in test function. * @var String */ protected $_contactID3 = NULL; /** - * Contact id used in test function + * Contact id used in test function. * @var String */ protected $_contactID4 = NULL; diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php index 08254a8c8c..1502489f64 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php @@ -87,7 +87,8 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { /** * Search with only type. - * success expected. + * + * Success expected. */ public function testSearchWithType() { @@ -151,7 +152,8 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { /** * Search with only subtype. - * success expected. + * + * Success expected. */ public function testSearchWithSubype() { @@ -198,7 +200,8 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { /** * Search with type as well as subtype. - * success expected. + * + * Success expected. */ public function testSearchWithTypeSubype() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php index 2c5d8017bd..f50cbf4e22 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php @@ -60,7 +60,8 @@ DELETE FROM civicrm_contact_type /** * Methods create Contact with valid data. - * success expected + * + * Success expected */ public function testCreateContact() { //check for Type:Individual @@ -142,9 +143,10 @@ DELETE FROM civicrm_contact_type /** * Update the contact with no subtype to a valid subtype. - * success expected + * + * Success expected. */ - public function testUpdateContactNosubtypeToValid() { + public function testUpdateContactNoSubtypeToValid() { $params = array( 'first_name' => 'Anne', 'last_name' => 'Grant', diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php index 5f36ceef30..917d34a4ab 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php @@ -71,8 +71,9 @@ class CRM_Contribute_BAO_ContributionRecurTest extends CiviUnitTestCase { } /** - * Test that an object can be retrieved & saved (per CRM-14986) - * this has been causing a DB error so we are checking for absence of error + * Test that an object can be retrieved & saved (per CRM-14986). + * + * This has been causing a DB error so we are checking for absence of error */ public function testFindSave() { $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', $this->_params); @@ -84,8 +85,9 @@ class CRM_Contribute_BAO_ContributionRecurTest extends CiviUnitTestCase { } /** - * Test cancellation works per CRM-14986 - * we are checking for absence of error + * Test cancellation works per CRM-14986. + * + * We are checking for absence of error. */ public function testCancelRecur() { $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', $this->_params); diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php index eda1eebaad..f811fd8cb3 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php @@ -413,7 +413,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * Check duplicate contribution id + * Check duplicate contribution id. * during the contribution import * checkDuplicateIds(); */ diff --git a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php index de9b5fc007..4c46110b26 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Test getTree() + * Test getTree(). */ public function testGetTree() { $params = array(); diff --git a/tests/phpunit/CRM/Queue/QueueTest.php b/tests/phpunit/CRM/Queue/QueueTest.php index 338b966bfd..f28073ea13 100644 --- a/tests/phpunit/CRM/Queue/QueueTest.php +++ b/tests/phpunit/CRM/Queue/QueueTest.php @@ -150,6 +150,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase { * Test that item leases expire at the expected time. * * @dataProvider getQueueSpecs + * * @param $queueSpec */ public function testTimeoutRelease($queueSpec) { diff --git a/tests/phpunit/CRM/Queue/RunnerTest.php b/tests/phpunit/CRM/Queue/RunnerTest.php index e2c58931d2..543671c6b4 100644 --- a/tests/phpunit/CRM/Queue/RunnerTest.php +++ b/tests/phpunit/CRM/Queue/RunnerTest.php @@ -86,11 +86,12 @@ class CRM_Queue_RunnerTest extends CiviUnitTestCase { } /** - * Run a series of tasks; one of the tasks will insert more - * TODOs at the start of the list + * Run a series of tasks. + * + * One of the tasks will insert more TODOs at the start of the list. */ public function testRunAll_AddMore() { - // prepare a list of tasks with an error in the middle + // Prepare a list of tasks with an error in the middle. $this->queue->createItem(new CRM_Queue_Task( array('CRM_Queue_RunnerTest', '_recordValue'), array('a'), diff --git a/tests/phpunit/CRM/Utils/Cache/AllTests.php b/tests/phpunit/CRM/Utils/Cache/AllTests.php index 0548954fca..7c092bbef8 100644 --- a/tests/phpunit/CRM/Utils/Cache/AllTests.php +++ b/tests/phpunit/CRM/Utils/Cache/AllTests.php @@ -1,6 +1,4 @@ 'bar'); @@ -35,7 +35,7 @@ class CRM_Utils_DeprecatedUtilsTest extends CiviUnitTestCase { /** - * Test civicrm_contact_check_params with a duplicate + * Test civicrm_contact_check_params with a duplicate. */ public function testCheckParamsWithDuplicateContact() { // Insert a row in civicrm_contact creating individual contact @@ -66,7 +66,7 @@ class CRM_Utils_DeprecatedUtilsTest extends CiviUnitTestCase { /** - * Test civicrm_contact_check_params with a duplicate + * Test civicrm_contact_check_params with a duplicate. * and request the error in array format */ public function testCheckParamsWithDuplicateContact2() { diff --git a/tests/phpunit/CRM/Utils/ZipTest.php b/tests/phpunit/CRM/Utils/ZipTest.php index 1361508dae..f16a8fa2ff 100644 --- a/tests/phpunit/CRM/Utils/ZipTest.php +++ b/tests/phpunit/CRM/Utils/ZipTest.php @@ -131,7 +131,7 @@ class CRM_Utils_ZipTest extends CiviUnitTestCase { ); } - public function testGuessBaseDir_twodir() { + public function testGuessBaseDirTwoDir() { $this->_doGuessBaseDir(FALSE, array('dir-1', 'dir-2'), array('dir-1/README.txt' => 'hello'), @@ -139,7 +139,7 @@ class CRM_Utils_ZipTest extends CiviUnitTestCase { ); } - public function testGuessBaseDir_weird() { + public function testGuessBaseDirWeird() { $this->_doGuessBaseDir(FALSE, array('foo/../'), array('foo/../README.txt' => 'hello'), diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 7a336f4e40..bffe25a7be 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -1194,7 +1194,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Private helper function for calling civicrm_contact_add + * Private helper function for calling civicrm_contact_add. * * @param array $params * For civicrm_contact_add api function call. diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index b6faedbc7b..078cb9884c 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -184,8 +184,9 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * Ensure that an invalid activity type causes failure - * oddly enough this test was failing because the creation of the invalid type + * Ensure that an invalid activity type causes failure. + * + * Oddly enough this test was failing because the creation of the invalid type * got added to the set up routine. Probably a mis-fix on a test */ public function testActivityCreateWithNonNumericActivityTypeId() { diff --git a/tests/phpunit/api/v3/AddressTest.php b/tests/phpunit/api/v3/AddressTest.php index ebd4a2331d..b8f1b0baba 100644 --- a/tests/phpunit/api/v3/AddressTest.php +++ b/tests/phpunit/api/v3/AddressTest.php @@ -98,7 +98,7 @@ 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; @@ -178,9 +178,11 @@ class api_v3_AddressTest extends CiviUnitTestCase { } /** - * Is_primary should be set as a default. ie. create the address, unset the params & recreate. + * Is_primary should 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 is invalid. */ public function testCreateAddressTestDefaultWithID() { $params = $this->_params; diff --git a/tests/phpunit/api/v3/AttachmentTest.php b/tests/phpunit/api/v3/AttachmentTest.php index 940bef352a..cb3bd10471 100644 --- a/tests/phpunit/api/v3/AttachmentTest.php +++ b/tests/phpunit/api/v3/AttachmentTest.php @@ -294,7 +294,7 @@ class api_v3_AttachmentTest extends CiviUnitTestCase { } /** - * Create an attachment using "content" and then "get" the attachment + * Create an attachment using "content" and then "get" the attachment. * * @param string $testEntityClass * E.g. "CRM_Core_DAO_Activity". diff --git a/tests/phpunit/api/v3/BatchTest.php b/tests/phpunit/api/v3/BatchTest.php index 1b0cb06b44..1200b3c943 100644 --- a/tests/phpunit/api/v3/BatchTest.php +++ b/tests/phpunit/api/v3/BatchTest.php @@ -39,6 +39,7 @@ class api_v3_BatchTest extends CiviUnitTestCase { /** * Sets up the fixture, for example, opens a network connection. + * * This method is called before a test is executed. */ protected function setUp() { diff --git a/tests/phpunit/api/v3/CRM11793Test.php b/tests/phpunit/api/v3/CRM11793Test.php index e61969cd78..a30028faf0 100644 --- a/tests/phpunit/api/v3/CRM11793Test.php +++ b/tests/phpunit/api/v3/CRM11793Test.php @@ -35,7 +35,7 @@ class api_v3_CRM11793Test extends CiviUnitTestCase { } /** - * Test civicrm_contact_create + * Test civicrm_contact_create. * * Verify that attempt to create individual contact with only * first and last names succeeds diff --git a/tests/phpunit/api/v3/CaseTest.php b/tests/phpunit/api/v3/CaseTest.php index 9e2725eb57..85bdf11b4a 100644 --- a/tests/phpunit/api/v3/CaseTest.php +++ b/tests/phpunit/api/v3/CaseTest.php @@ -1,6 +1,7 @@ callAPIFailure('case', 'create', array()); + $this->callAPIFailure('case', 'create', array()); } /** - * Check if required fields are not passed + * Check if required fields are not passed. */ public function testCaseCreateWithoutRequired() { $params = array( @@ -90,7 +91,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test create function with valid parameters + * Test create function with valid parameters. */ public function testCaseCreate() { // Create Case @@ -133,7 +134,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test delete function with valid parameters + * Test delete function with valid parameters. */ public function testCaseDelete() { // Create Case @@ -156,7 +157,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test get function based on activity + * Test get function based on activity. */ public function testCaseGetByActivity() { // Create Case @@ -178,7 +179,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test get function based on contact id + * Test get function based on contact id. */ public function testCaseGetByContact() { // Create Case @@ -197,7 +198,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test get function based on subject + * Test get function based on subject. */ public function testCaseGetBySubject() { // Create Case @@ -216,7 +217,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test get function based on wrong subject + * Test get function based on wrong subject. */ public function testCaseGetByWrongSubject() { // Create Case @@ -232,7 +233,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test get function with no criteria + * Test get function with no criteria. */ public function testCaseGetNoCriteria() { // Create Case @@ -247,7 +248,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test activity api create for case activities + * Test activity api create for case activities. */ public function testCaseActivityCreate() { // Create a case first @@ -285,7 +286,7 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * Test activity api update for case activities + * Test activity api update for case activities. */ public function testCaseActivityUpdate() { // Need to create the case and activity before we can update it diff --git a/tests/phpunit/api/v3/ContactTest.php b/tests/phpunit/api/v3/ContactTest.php index f7467ed3c5..0cc0558a1b 100644 --- a/tests/phpunit/api/v3/ContactTest.php +++ b/tests/phpunit/api/v3/ContactTest.php @@ -99,8 +99,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { ); $contact = $this->callAPISuccess('contact', 'create', $params); - $this->assertTrue(is_numeric($contact['id']), "In line " . __LINE__); - $this->assertTrue($contact['id'] > 0, "In line " . __LINE__); + $this->assertTrue(is_numeric($contact['id'])); + $this->assertTrue($contact['id'] > 0); $newCount = CRM_Core_DAO::singleValueQuery('select count(*) from civicrm_contact'); $this->assertEquals($oldCount + 1, $newCount); @@ -134,7 +134,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $contact = $this->callAPISuccess('contact', 'get', $params); - $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type'], "In line " . __LINE__); + $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type']); } /** @@ -204,7 +204,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $contact = $this->callAPISuccess('contact', 'create', $params); - $this->assertEquals(1, $contact['id'], "In line " . __LINE__); + $this->assertEquals(1, $contact['id']); $email = $this->callAPISuccess('email', 'get', array('contact_id' => $contact['id'])); $this->assertEquals(1, $email['count']); $this->assertEquals('man3@yahoo.com', $email['values'][$email['id']]['email']); @@ -291,7 +291,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { 'contact_type' => 'Household', ); $contact = $this->callAPISuccess('contact', 'create', $params); - $this->assertEquals(1, $contact['id'], "In line " . __LINE__); + $this->assertEquals(1, $contact['id']); } /** @@ -522,10 +522,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess('contact', 'delete', array('id' => $contact1['id'])); $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id'])); $this->assertEquals(1, $countNotDeleted, 'contact_is_deleted => 0 is respected in line ' . __LINE__); - $this->assertEquals(1, $countActive, 'in line ' . __LINE__); - $this->assertEquals(1, $countTrash, 'in line ' . __LINE__); - $this->assertEquals(2, $countAll, 'in line ' . __LINE__); - $this->assertEquals(1, $countDeleted, 'in line ' . __LINE__); + $this->assertEquals(1, $countActive); + $this->assertEquals(1, $countTrash); + $this->assertEquals(2, $countAll); + $this->assertEquals(1, $countDeleted); $this->assertEquals(1, $countDefault, 'Only active by default in line ' . __LINE__); } @@ -742,8 +742,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertEquals(1, $result['id']); // checking child function result not covered in callAPIAndDocument $this->assertAPISuccess($result['values'][$result['id']]['api.website.create']); - $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url'], "In line " . __LINE__); - $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url'], "In line " . __LINE__); + $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url']); + $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url']); // delete the contact $this->callAPISuccess('contact', 'delete', $result); @@ -788,16 +788,15 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertEquals(1, $result['id']); // the callAndDocument doesn't check the chained call - $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error'], "In line " . __LINE__); - $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url'], "In line " . __LINE__); - $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url'], "In line " . __LINE__); + $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error']); + $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url']); + $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url']); $this->callAPISuccess('contact', 'delete', $result); } /** - * Verify that attempt to create individual contact with first. - * and last names and email succeeds + * Verify that attempt to create individual contact with first, and last names and email succeeds. */ public function testCreateIndividualWithNameEmail() { $params = array( @@ -808,9 +807,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { ); $contact = $this->callAPISuccess('contact', 'create', $params); - $this->assertEquals(1, $contact['id'], "In line " . __LINE__); + $this->assertEquals(1, $contact['id']); - // delete the contact $this->callAPISuccess('contact', 'delete', $contact); } @@ -825,8 +823,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Verify that attempt to create individual contact with first. - * and last names, email and location type succeeds + * Test create individual contact with first &last names, email and location type succeeds. */ public function testCreateIndividualWithNameEmailLocationType() { $params = array( @@ -838,14 +835,13 @@ class api_v3_ContactTest extends CiviUnitTestCase { ); $result = $this->callAPISuccess('contact', 'create', $params); - $this->assertEquals(1, $result['id'], "In line " . __LINE__); + $this->assertEquals(1, $result['id']); $this->callAPISuccess('contact', 'delete', array('id' => $result['id'])); } /** - * Verify that when changing employers - * the old employer relationship becomes inactive + * Verify that when changing employers the old employer relationship becomes inactive. */ public function testCreateIndividualWithEmployer() { $employer = $this->organizationCreate(); @@ -891,8 +887,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Verify that attempt to create household contact with details - * succeeds + * Verify that attempt to create household contact with details succeeds. */ public function testCreateHouseholdDetails() { $params = array( @@ -904,7 +899,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $contact = $this->callAPISuccess('contact', 'create', $params); - $this->assertEquals(1, $contact['id'], "In line " . __LINE__); + $this->assertEquals(1, $contact['id']); $this->callAPISuccess('contact', 'delete', $contact); } @@ -1165,7 +1160,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { * Test civicrm_contact_getquick() with empty name param. */ public function testContactGetQuick() { - // Insert a row in civicrm_contact creating individual contact + // Insert a row in civicrm_contact creating individual contact. $op = new PHPUnit_Extensions_Database_Operation_Insert(); $op->execute($this->_dbconn, $this->createXMLDataSet( @@ -1182,21 +1177,21 @@ class api_v3_ContactTest extends CiviUnitTestCase { ); $result = $this->callAPISuccess('contact', 'getquick', $params); - $this->assertEquals(17, $result['values'][0]['id'], 'in line ' . __LINE__); + $this->assertEquals(17, $result['values'][0]['id']); } /** - * Test civicrm_contact_get) with empty params + * Test civicrm_contact_get) with empty params. */ public function testContactGetEmptyParams() { $this->callAPISuccess('contact', 'get', array()); } /** - * Test civicrm_contact_get(,true) with no matches + * Test civicrm_contact_get(,true) with no matches. */ public function testContactGetOldParamsNoMatches() { - // Insert a row in civicrm_contact creating contact 17 + // Insert a row in civicrm_contact creating contact 17. $op = new PHPUnit_Extensions_Database_Operation_Insert(); $op->execute($this->_dbconn, $this->createXMLDataSet( @@ -1208,14 +1203,14 @@ class api_v3_ContactTest extends CiviUnitTestCase { 'first_name' => 'Fred', ); $result = $this->callAPISuccess('contact', 'get', $params); - $this->assertEquals(0, $result['count'], 'in line ' . __LINE__); + $this->assertEquals(0, $result['count']); } /** - * Test civicrm_contact_get(,true) with one match + * Test civicrm_contact_get(,true) with one match. */ public function testContactGetOldParamsOneMatch() { - // Insert a row in civicrm_contact creating contact 17 + // Insert a row in civicrm_contact creating contact 17 $op = new PHPUnit_Extensions_Database_Operation_Insert(); $op->execute($this->_dbconn, $this->createXMLDataSet(dirname(__FILE__) . '/dataset/contact_17.xml' @@ -1226,12 +1221,12 @@ class api_v3_ContactTest extends CiviUnitTestCase { 'first_name' => 'Test', ); $result = $this->callAPISuccess('contact', 'get', $params); - $this->assertEquals(17, $result['values'][17]['contact_id'], 'in line ' . __LINE__); - $this->assertEquals(17, $result['id'], 'in line ' . __LINE__); + $this->assertEquals(17, $result['values'][17]['contact_id']); + $this->assertEquals(17, $result['id']); } /** - * Test civicrm_contact_search_count() + * Test civicrm_contact_search_count(). */ public function testContactGetEmail() { $params = array( @@ -1256,8 +1251,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test birth date params incl value, array & birth_date_high, birth_date_low - * && deceased + * Test birth date parameters. + * + * These include value, array & birth_date_high, birth_date_low + * && deceased. */ public function testContactGetBirthDate() { $contact1 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('birth_date' => 'first day of next month - 2 years'))); @@ -1287,7 +1284,9 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test Deceased date params incl value, array & Deceased_date_high, Deceased date_low + * Test Deceased date parameters. + * + * These include value, array & Deceased_date_high, Deceased date_low * && deceased. */ public function testContactGetDeceasedDate() { @@ -1312,10 +1311,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test for Contact.get id=@user:username + * Test for Contact.get id=@user:username. */ public function testContactGetByUsername() { - // setup - create contact with a uf-match + // Setup - create contact with a uf-match. $cid = $this->individualCreate(array( 'contact_type' => 'Individual', 'first_name' => 'testGetByUsername', @@ -1394,7 +1393,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test for Contact.get id=@user:username (with an invalid username) + * Test for Contact.get id=@user:username (with an invalid username). */ public function testContactGetByUnknownUsername() { // setup - mock the calls to CRM_Utils_System_*::getUfId @@ -1649,7 +1648,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test TrueFalse format - I couldn't come up with an easy way to get an error on Get + * Test TrueFalse format - I couldn't come up with an easy way to get an error on Get. */ public function testContactGetFormatIsSuccessTrue() { $this->createContactFromXML(); @@ -1663,7 +1662,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * test TrueFalse format. + * Test TrueFalse format. */ public function testContactCreateFormatIsSuccessFalse() { @@ -1676,9 +1675,9 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * test Single Entity format. + * Test Single Entity format. */ - public function testContactGetSingle_entity_array() { + public function testContactGetSingleEntityArray() { $this->createContactFromXML(); $description = "This demonstrates use of the 'format.single_entity_array' param. /* This param causes the only contact to be returned as an array without the other levels. @@ -1693,7 +1692,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { /** * Test Single Entity format. */ - public function testContactGetFormatCount_only() { + public function testContactGetFormatCountOnly() { $this->createContactFromXML(); $description = "This demonstrates use of the 'getCount' action.\n" . " *\n" @@ -1709,7 +1708,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { /** * Test id only format. */ - public function testContactGetFormatID_only() { + public function testContactGetFormatIDOnly() { $this->createContactFromXML(); $description = "This demonstrates use of the 'format.id_only' param. /* This param causes the id of the only entity to be returned as an integer. @@ -1842,7 +1841,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { * * (note that getquick api is required for autocomplete & has ACL permissions applied) */ - public function testGetquickPermission_CRM_13744() { + public function testGetquickPermissionCRM13744() { CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviEvent'); $this->callAPIFailure('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE)); CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM'); @@ -1918,7 +1917,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * CRM-14743 - test api respects search operators + * CRM-14743 - test api respects search operators. */ public function testGetModifiedDateByOperators() { $preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact'); @@ -1938,7 +1937,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * CRM-14743 - test api respects search operators + * CRM-14743 - test api respects search operators. */ public function testGetCreatedDateByOperators() { $preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact'); @@ -1958,7 +1957,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * CRM-14263 check that API is not affected by search profile related bug + * CRM-14263 check that API is not affected by search profile related bug. */ public function testReturnCityProfile() { $contactID = $this->individualCreate(); @@ -1993,7 +1992,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * Test contact.getactions + * Test contact getactions. */ public function testGetActions() { $description = "Getting the available actions for an entity."; diff --git a/tests/phpunit/api/v3/ContributionSoftTest.php b/tests/phpunit/api/v3/ContributionSoftTest.php index 892fc23474..00caf5d614 100644 --- a/tests/phpunit/api/v3/ContributionSoftTest.php +++ b/tests/phpunit/api/v3/ContributionSoftTest.php @@ -36,7 +36,7 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class api_v3_ContributionSoftTest extends CiviUnitTestCase { /** - * Assume empty database with just civicrm_data + * Assume empty database with just civicrm_data. */ protected $_individualId; //the hard credit contact protected $_softIndividual1Id; //the first soft credit contact @@ -156,7 +156,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { /** - * civicrm_contribution_soft + * civicrm_contribution_soft. */ public function testCreateEmptyParamsContributionSoft() { $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(), @@ -281,7 +281,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { } /** - * civicrm_contribution_soft_delete methods + * civicrm_contribution_soft_delete methods. * */ public function testDeleteEmptyParamsContributionSoft() { diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index 309eaa6946..0a16cbfa5e 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -38,7 +38,7 @@ require_once 'CiviTest/CiviMailUtils.php'; class api_v3_ContributionTest extends CiviUnitTestCase { /** - * Assume empty database with just civicrm_data + * Assume empty database with just civicrm_data. */ protected $_individualId; protected $_contribution; diff --git a/tests/phpunit/api/v3/DomainTest.php b/tests/phpunit/api/v3/DomainTest.php index 3015a068e0..32d0a9a77a 100644 --- a/tests/phpunit/api/v3/DomainTest.php +++ b/tests/phpunit/api/v3/DomainTest.php @@ -46,6 +46,7 @@ class api_v3_DomainTest extends CiviUnitTestCase { /** * Sets up the fixture, for example, opens a network connection. + * * This method is called before a test is executed. */ protected function setUp() { @@ -90,10 +91,10 @@ class api_v3_DomainTest extends CiviUnitTestCase { ); } - ///////////////// civicrm_domain_get methods - /** - * Test civicrm_domain_get. Takes no params. + * Test civicrm_domain_get. + * + * Takes no params. * Testing mainly for format. */ public function testGet() { @@ -173,10 +174,11 @@ class api_v3_DomainTest extends CiviUnitTestCase { /** * Test civicrm_domain_create with empty params. + * * Error expected. */ public function testCreateWithEmptyParams() { - $result = $this->callAPIFailure('domain', 'create', array()); + $this->callAPIFailure('domain', 'create', array()); } } diff --git a/tests/phpunit/api/v3/EmailTest.php b/tests/phpunit/api/v3/EmailTest.php index 7f078339d6..6c4e62e647 100644 --- a/tests/phpunit/api/v3/EmailTest.php +++ b/tests/phpunit/api/v3/EmailTest.php @@ -77,7 +77,7 @@ class api_v3_EmailTest extends CiviUnitTestCase { } /** - * If a new email is set to is_primary the prev should no longer be + * If a new email is set to is_primary the prev should no longer be. * * If is_primary is not set then it should become is_primary is no others exist */ diff --git a/tests/phpunit/api/v3/EntityTagTest.php b/tests/phpunit/api/v3/EntityTagTest.php index f84420ed5a..709691bb29 100644 --- a/tests/phpunit/api/v3/EntityTagTest.php +++ b/tests/phpunit/api/v3/EntityTagTest.php @@ -120,7 +120,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { } /** - * civicrm_entity_tag_get methods + * civicrm_entity_tag_get methods. */ public function testGetNoEntityID() { $ContactId = $this->_individualID; @@ -181,7 +181,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { } /** - * civicrm_entity_tag_Delete methods + * civicrm_entity_tag_Delete methods. */ public function testEntityTagDeleteNoTagId() { $entityTagParams = array( @@ -257,7 +257,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { } /** - * civicrm_tag_entities_get methods + * civicrm_tag_entities_get methods. */ public function testCommonContactEntityTagAdd() { $params = array( diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index c236958968..2da71c446c 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -111,7 +111,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * civicrm_event_get methods + * civicrm_event_get methods. */ public function testGetEventById() { $params = array( @@ -263,8 +263,9 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * Legacy support for Contribution Type ID. We need to ensure this is supported - * as an alias for financial_type_id + * Legacy support for Contribution Type ID. + * + * We need to ensure this is supported as an alias for financial_type_id. */ public function testCreateGetEventLegacyContributionTypeID() { $contributionTypeArray = array('contribution_type_id' => 3); @@ -278,13 +279,13 @@ class api_v3_EventTest extends CiviUnitTestCase { $this->assertEquals($result['id'], $getresult['id']); $this->callAPISuccess('event', 'delete', array('id' => $result['id'])); } - ///////////////// civicrm_event_create methods /** - * Check with complete array + custom field + * 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 + * and / or moved to the automated test suite. */ public function testCreateWithCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); @@ -401,7 +402,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * Check event_id still supported for delete + * Check event_id still supported for delete. */ public function testDeleteWithEventId() { $params = array( @@ -436,7 +437,7 @@ class api_v3_EventTest extends CiviUnitTestCase { ///////////////// civicrm_event_search methods /** - * Test civicrm_event_search with wrong params type + * Test civicrm_event_search with wrong params type. */ public function testSearchWrongParamsType() { $params = 'a string'; @@ -476,7 +477,10 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * Test civicrm_event_search. Success expected. + * Test civicrm_event_search. + * + * Success expected. + * * return.offset and return.max_results test (CRM-5266) */ public function testSearchWithOffsetAndMaxResults() { @@ -516,7 +520,11 @@ class api_v3_EventTest extends CiviUnitTestCase { $result = $this->callAPIFailure('event', 'create', $params); $this->assertEquals('API permission check failed for event/create call; insufficient permission: require access CiviCRM and access CiviEvent and edit all events', $result['error_message'], 'lacking permissions should not be enough to create an event'); - $config->userPermissionClass->permissions = array('access CiviEvent', 'edit all events', 'access CiviCRM'); + $config->userPermissionClass->permissions = array( + 'access CiviEvent', + 'edit all events', + 'access CiviCRM', + ); $result = $this->callAPISuccess('event', 'create', $params); } @@ -528,7 +536,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * Test api_action param also works + * Test api_action param also works. */ public function testgetfieldsRest() { $description = "demonstrate use of getfields to interrogate api"; diff --git a/tests/phpunit/api/v3/GrantTest.php b/tests/phpunit/api/v3/GrantTest.php index aa61908e5f..84267928ea 100644 --- a/tests/phpunit/api/v3/GrantTest.php +++ b/tests/phpunit/api/v3/GrantTest.php @@ -75,6 +75,7 @@ class api_v3_GrantTest extends CiviUnitTestCase { /** * Check checkbox type custom fields are created correctly. + * * We want to ensure they are saved with separators as appropriate */ public function testCreateCustomCheckboxGrant() { @@ -159,6 +160,7 @@ class api_v3_GrantTest extends CiviUnitTestCase { /** * This is a test to check if setting fields one at a time alters other fields. + * * Issues Hit so far = * 1) Currency keeps getting reset to USD - BUT this may be the only enabled currency * - in which case it is valid diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php index b153d8108a..7c5e759bc6 100644 --- a/tests/phpunit/api/v3/JobTest.php +++ b/tests/phpunit/api/v3/JobTest.php @@ -75,7 +75,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * Create job with an invalid "run_frequency" value + * Create job with an invalid "run_frequency" value. */ public function testCreateWithInvalidFrequency() { $params = array( @@ -181,7 +181,8 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * Test the call reminder success sends more than 25 reminders & is not incorrectly limited + * Test the call reminder success sends more than 25 reminders & is not incorrectly limited. + * * Note that this particular test sends the reminders to the additional recipients only * as no real reminder person is configured * @@ -220,7 +221,8 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * Test scheduled reminders respect limit to (since above identified addition_to handling issue) + * Test scheduled reminders respect limit to (since above identified addition_to handling issue). + * * We create 3 contacts - 1 is in our group, 1 has our membership & the chosen one has both * & check that only the chosen one got the reminder */ diff --git a/tests/phpunit/api/v3/MailingABTest.php b/tests/phpunit/api/v3/MailingABTest.php index f4da26506a..b7602f2750 100755 --- a/tests/phpunit/api/v3/MailingABTest.php +++ b/tests/phpunit/api/v3/MailingABTest.php @@ -60,7 +60,7 @@ class api_v3_MailingABTest extends CiviUnitTestCase { } /** - * Test civicrm_mailing_create + * Test civicrm_mailing_create. */ public function testMailingABCreateSuccess() { $result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__); @@ -69,7 +69,7 @@ class api_v3_MailingABTest extends CiviUnitTestCase { } /** - * Test civicrm_mailing_delete + * Test civicrm_mailing_delete. */ public function testMailerDeleteSuccess() { $result = $this->callAPISuccess($this->_entity, 'create', $this->_params); diff --git a/tests/phpunit/api/v3/MailingTest.php b/tests/phpunit/api/v3/MailingTest.php index c908fbd934..c01ab57af2 100755 --- a/tests/phpunit/api/v3/MailingTest.php +++ b/tests/phpunit/api/v3/MailingTest.php @@ -61,7 +61,7 @@ class api_v3_MailingTest extends CiviUnitTestCase { } /** - * Test civicrm_mailing_create + * Test civicrm_mailing_create. */ public function testMailerCreateSuccess() { $result = $this->callAPIAndDocument('mailing', 'create', $this->_params, __FUNCTION__, __FILE__); @@ -434,7 +434,7 @@ SELECT event_queue_id, time_stamp FROM mail_{$type}_temp"; } /** - * Test civicrm_mailing_delete + * Test civicrm_mailing_delete. */ public function testMailerDeleteSuccess() { $result = $this->callAPISuccess($this->_entity, 'create', $this->_params); diff --git a/tests/phpunit/api/v3/MembershipStatusTest.php b/tests/phpunit/api/v3/MembershipStatusTest.php index 10d9115f03..5a23f0390c 100644 --- a/tests/phpunit/api/v3/MembershipStatusTest.php +++ b/tests/phpunit/api/v3/MembershipStatusTest.php @@ -59,7 +59,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { /** - * Test civicrm_membership_status_get with empty params + * Test civicrm_membership_status_get with empty params. */ public function testGetEmptyParams() { $result = $this->callAPISuccess('membership_status', 'get', array()); diff --git a/tests/phpunit/api/v3/MembershipTest.php b/tests/phpunit/api/v3/MembershipTest.php index 973ba40962..e3aadd43ea 100644 --- a/tests/phpunit/api/v3/MembershipTest.php +++ b/tests/phpunit/api/v3/MembershipTest.php @@ -586,7 +586,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { } /** - * If is_overide is passed in status must also be passed in + * If is_overide is passed in status must also be passed in. */ public function testCreateOverrideNoStatus() { $params = $this->_params; @@ -864,7 +864,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { } /** - * Test civicrm_contact_memberships_create Invalid membership data + * Test civicrm_contact_memberships_create Invalid membership data. * Error expected. */ public function testMembershipCreateInvalidMemData() { @@ -973,7 +973,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { } /** - * Test that if membership start date is not set it defaults to correct end date + * Test that if membership start date is not set it defaults to correct end date. * - fixed */ public function testEmptyStartDateFixed() { diff --git a/tests/phpunit/api/v3/MessageTemplateTest.php b/tests/phpunit/api/v3/MessageTemplateTest.php index c1f2ebbd7c..94b1c4f23e 100644 --- a/tests/phpunit/api/v3/MessageTemplateTest.php +++ b/tests/phpunit/api/v3/MessageTemplateTest.php @@ -34,7 +34,7 @@ require_once 'CiviTest/CiviUnitTestCase.php'; */ class api_v3_MessageTemplateTest extends CiviUnitTestCase { /** - * Assume empty database with just civicrm_data + * Assume empty database with just civicrm_data. */ protected $entity = 'MessageTemplate'; protected $params; @@ -65,8 +65,11 @@ class api_v3_MessageTemplateTest extends CiviUnitTestCase { } /** - * Test get function succeeds (this is actually largely tested in the get - * action on create. Add extra checks for any 'special' return values or + * Test get function succeeds. + * + * This is actually largely tested in the get action on create. + * + * Add extra checks for any 'special' return values or * behaviours */ public function testGet() { diff --git a/tests/phpunit/api/v3/OptionValueTest.php b/tests/phpunit/api/v3/OptionValueTest.php index 8a1e0adbed..c94512e282 100644 --- a/tests/phpunit/api/v3/OptionValueTest.php +++ b/tests/phpunit/api/v3/OptionValueTest.php @@ -154,7 +154,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * Check that domain_id is honoured + * Check that domain_id is honoured. */ public function testCreateOptionSpecifyDomain() { $result = $this->callAPISuccess('option_group', 'get', array( @@ -172,7 +172,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * Check that component_id is honoured + * Check that component_id is honoured. */ public function testCreateOptionSpecifyComponentID() { $result = $this->callAPISuccess('option_group', 'get', array( @@ -234,7 +234,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * Check that domain_id is honoured + * Check that domain_id is honoured. */ public function testCRM12133CreateOptionWeightNoValue() { $optionGroup = $this->callAPISuccess( @@ -263,7 +263,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * Check that domain_id is honoured + * Check that domain_id is honoured. */ public function testCreateOptionNoName() { $optionGroup = $this->callAPISuccess('option_group', 'get', array( @@ -278,8 +278,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * Check that pseudoconstant reflects new value added - * and deleted + * Check that pseudoconstant reflects new value added. */ public function testCRM11876CreateOptionPseudoConstantUpdated() { $optionGroupID = $this->callAPISuccess('option_group', 'getvalue', array( diff --git a/tests/phpunit/api/v3/ParticipantPaymentTest.php b/tests/phpunit/api/v3/ParticipantPaymentTest.php index 3694d27427..f78c39b598 100644 --- a/tests/phpunit/api/v3/ParticipantPaymentTest.php +++ b/tests/phpunit/api/v3/ParticipantPaymentTest.php @@ -77,7 +77,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { ///////////////// civicrm_participant_payment_create methods /** - * Test civicrm_participant_payment_create with wrong params type + * Test civicrm_participant_payment_create with wrong params type. */ public function testPaymentCreateWrongParamsType() { $params = 'a string'; @@ -85,7 +85,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * Test civicrm_participant_payment_create with empty params + * Test civicrm_participant_payment_create with empty params. */ public function testPaymentCreateEmptyParams() { $params = array(); @@ -93,7 +93,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * Check without contribution_id + * Check without contribution_id. */ public function testPaymentCreateMissingContributionId() { //Without Payment EntityID @@ -128,7 +128,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { ///////////////// civicrm_participant_payment_create methods /** - * Test civicrm_participant_payment_create with wrong params type + * Test civicrm_participant payment create with wrong params type. */ public function testPaymentUpdateWrongParamsType() { $params = 'a string'; @@ -140,24 +140,21 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { * Check with empty array. */ public function testPaymentUpdateEmpty() { - $params = array(); - $participantPayment = $this->callAPIFailure('participant_payment', 'create', $params); + $this->callAPIFailure('participant_payment', 'create', array()); } /** - * Check with missing participant_id + * Check with missing participant_id. */ public function testPaymentUpdateMissingParticipantId() { - //WithoutParticipantId $params = array( 'contribution_id' => '3', ); - - $participantPayment = $this->callAPIFailure('participant_payment', 'create', $params); + $this->callAPIFailure('participant_payment', 'create', $params); } /** - * Check with missing contribution_id + * Check with missing contribution_id. */ public function testPaymentUpdateMissingContributionId() { $params = array( @@ -263,14 +260,13 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { $deletePayment = $this->callAPISuccess('participant_payment', 'delete', $params); } - ///////////////// civicrm_participant_payment_delete methods /** - * Test civicrm_participant_payment_delete with wrong params type + * Test civicrm_participant_payment_delete with wrong params type. */ public function testPaymentDeleteWrongParamsType() { $params = 'a string'; - $result = $this->callAPIFailure('participant_payment', 'delete', $params); + $this->callAPIFailure('participant_payment', 'delete', $params); } /** diff --git a/tests/phpunit/api/v3/ParticipantTest.php b/tests/phpunit/api/v3/ParticipantTest.php index c7f84bdf80..370c3bf27d 100644 --- a/tests/phpunit/api/v3/ParticipantTest.php +++ b/tests/phpunit/api/v3/ParticipantTest.php @@ -133,14 +133,14 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Test civicrm_participant_get with empty params + * Test civicrm_participant_get with empty params. */ public function testGetEmptyParams() { $this->callAPISuccess('participant', 'get', array()); } /** - * Check with participant_id + * Check with participant_id. */ public function testGetParticipantIdOnly() { $params = array( @@ -221,7 +221,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with contact_id + * Check with contact_id. */ public function testGetContactIdOnly() { $params = array( @@ -247,7 +247,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with event_id + * Check with event_id. * fetch first record */ public function testGetMultiMatchReturnFirst() { @@ -261,7 +261,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with event_id + * Check with event_id. * in v3 this should return all participants */ public function testGetMultiMatchNoReturnFirst() { @@ -275,7 +275,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ///////////////// civicrm_participant_get methods /** - * Test civicrm_participant_get with empty params + * Test civicrm_participant_get with empty params. * In this case all the participant records are returned. */ public function testSearchEmptyParams() { @@ -285,7 +285,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with participant_id + * Check with participant_id. */ public function testSearchParticipantIdOnly() { $params = array( @@ -298,7 +298,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with contact_id + * Check with contact_id. */ public function testSearchContactIdOnly() { // Should get 2 participant records for this contact. @@ -311,7 +311,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with event_id + * Check with event_id. */ public function testSearchByEvent() { // Should get >= 3 participant records for this event. Also testing that last_name and event_title are returned. @@ -330,7 +330,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with event_id + * Check with event_id. * fetch with limit */ public function testSearchByEventWithLimit() { @@ -347,7 +347,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ///////////////// civicrm_participant_create methods /** - * Test civicrm_participant_create with empty params + * Test civicrm_participant_create with empty params. */ public function testCreateEmptyParams() { $params = array(); @@ -355,7 +355,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with event_id + * Check with event_id. */ public function testCreateMissingContactID() { $params = array( @@ -365,7 +365,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with contact_id + * Check with contact_id. * without event_id */ public function testCreateMissingEventID() { @@ -569,7 +569,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ///////////////// civicrm_participant_update methods /** - * Test civicrm_participant_update with wrong params type + * Test civicrm_participant_update with wrong params type. */ public function testUpdateWrongParamsType() { $params = 'a string'; @@ -587,7 +587,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check without event_id + * Check without event_id. */ public function testUpdateWithoutEventId() { $participantId = $this->participantCreate(array('contactID' => $this->_individualId, 'eventID' => $this->_eventID)); @@ -644,7 +644,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ///////////////// civicrm_participant_delete methods /** - * Test civicrm_participant_delete with wrong params type + * Test civicrm_participant_delete with wrong params type. */ public function testDeleteWrongParamsType() { $params = 'a string'; @@ -652,7 +652,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Test civicrm_participant_delete with empty params + * Test civicrm_participant_delete with empty params. */ public function testDeleteEmptyParams() { $params = array(); @@ -660,7 +660,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check with participant_id + * Check with participant_id. */ public function testParticipantDelete() { $params = array( @@ -672,7 +672,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * Check without participant_id + * Check without participant_id. * and with event_id * This should return an error because required param is missing.. */ diff --git a/tests/phpunit/api/v3/PhoneTest.php b/tests/phpunit/api/v3/PhoneTest.php index 5bb8aff2aa..a9d0db171e 100644 --- a/tests/phpunit/api/v3/PhoneTest.php +++ b/tests/phpunit/api/v3/PhoneTest.php @@ -128,7 +128,7 @@ class api_v3_PhoneTest extends CiviUnitTestCase { } /** - * If a new phone is set to is_primary the prev should no longer be + * If a new phone is set to is_primary the prev should no longer be. * * If is_primary is not set then it should become is_primary is no others exist */ diff --git a/tests/phpunit/api/v3/PledgePaymentTest.php b/tests/phpunit/api/v3/PledgePaymentTest.php index 9ab2f4dd2f..253c1b962c 100644 --- a/tests/phpunit/api/v3/PledgePaymentTest.php +++ b/tests/phpunit/api/v3/PledgePaymentTest.php @@ -35,7 +35,7 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class api_v3_PledgePaymentTest extends CiviUnitTestCase { /** - * Assume empty database with just civicrm_data + * Assume empty database with just civicrm_data. */ protected $_individualId; protected $_pledgeID; @@ -195,8 +195,7 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { } /** - * Test that creating a payment will add the contribution ID where only one pledge payment. - * in schedule + * Test that creating a payment adds the contribution ID where only one pledge payment is in schedule. */ public function testCreatePledgePaymentWhereOnlyOnePayment() { $pledgeParams = array( diff --git a/tests/phpunit/api/v3/PledgeTest.php b/tests/phpunit/api/v3/PledgeTest.php index 42fd346874..e40bf6c7e1 100644 --- a/tests/phpunit/api/v3/PledgeTest.php +++ b/tests/phpunit/api/v3/PledgeTest.php @@ -35,7 +35,7 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class api_v3_PledgeTest extends CiviUnitTestCase { /** - * Assume empty database with just civicrm_data + * Assume empty database with just civicrm_data. */ protected $_individualId; protected $_pledge; @@ -75,10 +75,9 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $this->contactDelete($this->_individualId); } - ///////////////// civicrm_pledge_get methods - /** - * Check with complete array + custom field + * 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 @@ -91,21 +90,27 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $result = $this->callAPISuccess($this->_entity, 'create', $params); $this->assertAPISuccess($result, " testCreateWithCustom "); - $this->assertAPISuccess($result, ' in line ' . __LINE__); - $getparams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1); - $check = $this->callAPISuccess($this->_entity, 'get', $getparams); + $this->assertAPISuccess($result); + $getParams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1); + $check = $this->callAPISuccess($this->_entity, 'get', $getParams); $this->callAPISuccess('pledge', 'delete', array('id' => $check['id'])); - $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); + $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]); $this->customFieldDelete($ids['custom_field_id']); $this->customGroupDelete($ids['custom_group_id']); } - public function testgetfieldspledge() { + /** + * Test getfields function for pledge. + */ + public function testGetfieldsPledge() { $result = $this->callAPISuccess('pledge', 'getfields', array('action' => 'get')); $this->assertEquals(1, $result['values']['next_pay_date']['api.return']); } + /** + * Test get pledge api. + */ public function testGetPledge() { $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); @@ -114,15 +119,15 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ); $result = $this->callAPIAndDocument('pledge', 'get', $params, __FUNCTION__, __FILE__); $pledge = $result['values'][$this->_pledge['id']]; - $this->assertEquals($this->_individualId, $pledge['contact_id'], 'in line' . __LINE__); - $this->assertEquals($this->_pledge['id'], $pledge['pledge_id'], 'in line' . __LINE__); - $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date'], 'in line' . __LINE__); - $this->assertEquals(100.00, $pledge['pledge_amount'], 'in line' . __LINE__); - $this->assertEquals('Pending', $pledge['pledge_status'], 'in line' . __LINE__); - $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'in line' . __LINE__); - $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'in line' . __LINE__); - $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date'], 'in line' . __LINE__); - $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00, 'in line' . __LINE__); + $this->assertEquals($this->_individualId, $pledge['contact_id']); + $this->assertEquals($this->_pledge['id'], $pledge['pledge_id']); + $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date']); + $this->assertEquals(100.00, $pledge['pledge_amount']); + $this->assertEquals('Pending', $pledge['pledge_status']); + $this->assertEquals(5, $pledge['pledge_frequency_interval']); + $this->assertEquals('year', $pledge['pledge_frequency_unit']); + $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date']); + $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00); $params2 = array( 'pledge_id' => $this->_pledge['id'], @@ -131,9 +136,9 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * Test 'return.pledge_financial_type' => 1 works + * Test 'return.pledge_financial_type' => 1 works. */ - public function testGetPledgewithReturn() { + public function testGetPledgeWithReturn() { $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); $params = array( @@ -147,10 +152,11 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * Test 'return.pledge_contribution_type' => 1 works + * Test 'return.pledge_contribution_type' => 1 works. + * * This is for legacy compatibility */ - public function testGetPledgewithReturnLegacy() { + public function testGetPledgeWithReturnLegacy() { $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); $params = array( @@ -163,8 +169,11 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $this->assertEquals('Donation', $pledge['pledge_financial_type']); } + /** + * Test date legacy date filters like pledge_start_date_high. + */ public function testPledgeGetReturnFilters() { - $oldPledge = $this->callAPISuccess('pledge', 'create', $this->_params); + $this->callAPISuccess('pledge', 'create', $this->_params); $overdueParams = array( 'scheduled_date' => 'first saturday of march last year', @@ -183,7 +192,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * create 2 pledges - see if we can get by status id + * Create 2 pledges - see if we can get by status id. */ public function testGetOverduePledge() { $overdueParams = array( @@ -206,7 +215,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { /** - * create 2 pledges - see if we can get by status id + * Create 2 pledges - see if we can get by status id. */ public function testSortParamPledge() { $pledge1 = $this->callAPISuccess('pledge', 'create', $this->_params); @@ -241,22 +250,21 @@ class api_v3_PledgeTest extends CiviUnitTestCase { public function testCreatePledge() { $result = $this->callAPIAndDocument('pledge', 'create', $this->_params, __FUNCTION__, __FILE__); - $this->assertEquals($result['values'][0]['amount'], 100.00, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['installments'], 5, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['frequency_unit'], 'year', 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['frequency_interval'], 5, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['frequency_day'], 15, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['original_installment_amount'], 20, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__); - $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__); - $this->assertAPISuccess($result, 'In line ' . __LINE__); + $this->assertEquals($result['values'][0]['amount'], 100.00); + $this->assertEquals($result['values'][0]['installments'], 5); + $this->assertEquals($result['values'][0]['frequency_unit'], 'year'); + $this->assertEquals($result['values'][0]['frequency_interval'], 5); + $this->assertEquals($result['values'][0]['frequency_day'], 15); + $this->assertEquals($result['values'][0]['original_installment_amount'], 20); + $this->assertEquals($result['values'][0]['status_id'], 2); + $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000'); + $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000'); + $this->assertAPISuccess($result); $payments = $this->callAPISuccess('PledgePayment', 'Get', array('pledge_id' => $result['id'], 'sequential' => 1)); - $this->assertAPISuccess($payments, 'In line ' . __LINE__); - $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__); - require_once 'CRM/Utils/Date.php'; + $this->assertAPISuccess($payments); + $this->assertEquals($payments['count'], 5); $shouldBeDate = CRM_Utils_Date::format(CRM_Utils_Date::intervalAdd('year', 5 * 4, $this->scheduled_date), "-"); - $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10), 'In line ' . __LINE__); + $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10)); $pledgeID = array('id' => $result['id']); $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); @@ -279,8 +287,8 @@ class api_v3_PledgeTest extends CiviUnitTestCase { 'pledge_id' => $pledge['id'], 'sequential' => 1, )); - $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__); - $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date'], 'In line ' . __LINE__); + $this->assertEquals($payments['count'], 5); + $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date']); $this->callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id'])); } @@ -323,15 +331,16 @@ class api_v3_PledgeTest extends CiviUnitTestCase { 'pledge_id' => $pledge['id'], 'sequential' => 1, )); - $this->assertEquals(1, $payments['count'], 'In line ' . __LINE__); - $this->assertEquals(2, $payments['values'][0]['status_id'], 'In line ' . __LINE__); + $this->assertEquals(1, $payments['count']); + $this->assertEquals(2, $payments['values'][0]['status_id']); $pledgeID = array('id' => $pledge['id']); $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); } /** - * test that using original_installment_amount rather than pledge_original_installment_amount works - * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields + * Test that using original_installment_amount rather than pledge_original_installment_amount works. + * + * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields. */ public function testCreatePledgeWithNonUnique() { $params = $this->_params; @@ -341,24 +350,31 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $result = $this->callAPISuccess('pledge', 'create', $params); $pledgeDetails = $this->callAPISuccess('Pledge', 'Get', array('id' => $result['id'], 'sequential' => 1)); $pledge = $pledgeDetails['values'][0]; - $this->assertEquals(100.00, $pledge['pledge_amount'], 'In line ' . __LINE__); - $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'In line ' . __LINE__); - $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'In line ' . __LINE__); - $this->assertEquals(20, $pledge['pledge_next_pay_amount'], 'In line ' . __LINE__); + $this->assertEquals(100.00, $pledge['pledge_amount']); + $this->assertEquals('year', $pledge['pledge_frequency_unit']); + $this->assertEquals(5, $pledge['pledge_frequency_interval']); + $this->assertEquals(20, $pledge['pledge_next_pay_amount']); $pledgeID = array('id' => $result['id']); $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); } + /** + * Test cancelling a pledge. + */ public function testCreateCancelPledge() { $result = $this->callAPISuccess('pledge', 'create', $this->_params); - $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__); - $cancelparams = array('sequential' => 1, 'id' => $result['id'], 'pledge_status_id' => 3); - $result = $this->callAPISuccess('pledge', 'create', $cancelparams); - $this->assertEquals(3, $result['values'][0]['status_id'], "in line " . __LINE__); + $this->assertEquals(2, $result['values'][0]['status_id']); + $cancelParams = array( + 'sequential' => 1, + 'id' => $result['id'], + 'pledge_status_id' => 3, + ); + $result = $this->callAPISuccess('pledge', 'create', $cancelParams); + $this->assertEquals(3, $result['values'][0]['status_id']); $pledgeID = array('id' => $result['id']); - $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); + $this->callAPISuccess('pledge', 'delete', $pledgeID); } /** @@ -370,8 +386,8 @@ class api_v3_PledgeTest extends CiviUnitTestCase { unset($params['status_id']); unset($params['pledge_status_id']); $result = $this->callAPISuccess('pledge', 'create', $params); - $this->assertAPISuccess($result, "in line " . __LINE__); - $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__); + $this->assertAPISuccess($result); + $this->assertEquals(2, $result['values'][0]['status_id']); $pledgeID = array('pledge_id' => $result['id']); $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); } @@ -388,7 +404,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ); $original = $this->callAPISuccess('pledge', 'get', $old_params); //Make sure it came back - $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__); + $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID); //set up list of old params, verify $old_contact_id = $original['values'][0]['contact_id']; $old_frequency_unit = $original['values'][0]['pledge_frequency_unit']; @@ -396,10 +412,10 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $old_status_id = $original['values'][0]['pledge_status']; //check against values in CiviUnitTestCase::createPledge() - $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__); - $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__); - $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__); - $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__); + $this->assertEquals($old_contact_id, $this->_individualId); + $this->assertEquals($old_frequency_unit, 'year'); + $this->assertEquals($old_frequency_interval, 5); + $this->assertEquals($old_status_id, 'Pending'); $params = array( 'id' => $pledgeID, 'contact_id' => $this->_individualId, @@ -415,37 +431,38 @@ class api_v3_PledgeTest extends CiviUnitTestCase { 'id' => $pledge['id'], ); $pledge = $this->callAPISuccess('pledge', 'get', $new_params); - $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__); - $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__); + $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId); + $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled'); $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. + * + * We test 'sequential' param here too. */ public function testCreateUpdatePledgeLegacy() { - - // we test 'sequential' param here too $pledgeID = $this->pledgeCreate($this->_individualId); $old_params = array( 'id' => $pledgeID, 'sequential' => 1, ); $original = $this->callAPISuccess('pledge', 'get', $old_params); - //Make sure it came back - $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__); - //set up list of old params, verify + // Make sure it came back. + $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID); + // Set up list of old params, verify. $old_contact_id = $original['values'][0]['contact_id']; $old_frequency_unit = $original['values'][0]['pledge_frequency_unit']; $old_frequency_interval = $original['values'][0]['pledge_frequency_interval']; $old_status_id = $original['values'][0]['pledge_status']; - //check against values in CiviUnitTestCase::createPledge() - $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__); - $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__); - $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__); - $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__); + // Check against values in CiviUnitTestCase::createPledge(). + $this->assertEquals($old_contact_id, $this->_individualId); + $this->assertEquals($old_frequency_unit, 'year'); + $this->assertEquals($old_frequency_interval, 5); + $this->assertEquals($old_status_id, 'Pending'); $params = array( 'id' => $pledgeID, 'contact_id' => $this->_individualId, @@ -461,25 +478,31 @@ class api_v3_PledgeTest extends CiviUnitTestCase { 'id' => $pledge['id'], ); $pledge = $this->callAPISuccess('pledge', 'get', $new_params); - $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__); - $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__); - $pledge = $this->callAPISuccess('pledge', 'delete', $new_params); + $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId); + $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled'); + $this->callAPISuccess('pledge', 'delete', $new_params); } + /** + * Failure test for delete without id. + */ public function testDeleteEmptyParamsPledge() { - $pledge = $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id'); + $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id'); } + /** + * Failure test for invalid pledge id. + */ public function testDeleteWrongParamPledge() { $params = array( 'pledge_source' => 'SSF', ); - $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id'); + $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id'); } /** - * Legacy support for pledge_id + * Legacy support for pledge_id. */ public function testDeletePledge() { @@ -491,7 +514,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * Std is to accept id. + * Standard is to accept id. */ public function testDeletePledgeUseID() { @@ -499,21 +522,22 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $params = array( 'id' => $pledgeID, ); - $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__); + $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 */ public function testGetEmpty() { - $result = $this->callAPISuccess('pledge', 'create', $this->_params); + $this->callAPISuccess('pledge', 'create', $this->_params); $result = $this->callAPISuccess('pledge', 'get', array()); $this->assertAPISuccess($result, "This test is failing because it's acting like a contact get when no params set. Not sure the fix"); $this->assertEquals(1, $result['count'], 'in line ' . __LINE__); $pledgeID = array('id' => $result['id']); - $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); + $this->callAPISuccess('pledge', 'delete', $pledgeID); } } diff --git a/tests/phpunit/api/v3/PriceSetTest.php b/tests/phpunit/api/v3/PriceSetTest.php index 804235483c..a1bde71fcf 100644 --- a/tests/phpunit/api/v3/PriceSetTest.php +++ b/tests/phpunit/api/v3/PriceSetTest.php @@ -39,10 +39,12 @@ class api_v3_PriceSetTest extends CiviUnitTestCase { public $DBResetRequired = TRUE; + /** + * Set up for class. + */ public function setUp() { parent::setUp(); $this->_params = array( - # [domain_id] => 'name' => 'default_goat_priceset', 'title' => 'Goat accessories', 'is_active' => 1, @@ -59,6 +61,7 @@ class api_v3_PriceSetTest extends CiviUnitTestCase { } /** + * Test create price set. */ public function testCreatePriceSet() { $result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__); @@ -91,12 +94,12 @@ class api_v3_PriceSetTest extends CiviUnitTestCase { } /** - * Check that no name doesn't cause failure + * Check that no name doesn't cause failure. */ public function testCreatePriceSetNoName() { $params = $this->_params; unset($params['name']); - $result = $this->callAPISuccess($this->_entity, 'create', $params); + $this->callAPISuccess($this->_entity, 'create', $params); } /** diff --git a/tests/phpunit/api/v3/RelationshipTest.php b/tests/phpunit/api/v3/RelationshipTest.php index 5208fd16fc..b35878ceae 100644 --- a/tests/phpunit/api/v3/RelationshipTest.php +++ b/tests/phpunit/api/v3/RelationshipTest.php @@ -817,7 +817,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * Check with valid data with contact_b + * Check with valid data with contact_b. */ public function testGetRelationshipWithContactB() { $relParams = array( @@ -1000,6 +1000,8 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** + * Test relationship get by membership type. + * * Checks that passing in 'contact_id_b' + a relationship type * will filter by relationship type for contact b * diff --git a/tests/phpunit/api/v3/ReportTemplateTest.php b/tests/phpunit/api/v3/ReportTemplateTest.php index 6108fa53ed..973900ca41 100644 --- a/tests/phpunit/api/v3/ReportTemplateTest.php +++ b/tests/phpunit/api/v3/ReportTemplateTest.php @@ -112,6 +112,7 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase { } /** + * Test getrows on contact summary report. */ public function testReportTemplateGetRowsContactSummary() { $description = "Retrieve rows from a report template (optionally providing the instance_id)"; @@ -135,22 +136,30 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase { } /** + * Tet api to get rows from reports. + * * @dataProvider getReportTemplates + * * @param $reportID + * * @throws \PHPUnit_Framework_IncompleteTestError */ public function testReportTemplateGetRowsAllReports($reportID) { if (stristr($reportID, 'has existing issues')) { $this->markTestIncomplete($reportID); } - $result = $this->callAPISuccess('report_template', 'getrows', array( + $this->callAPISuccess('report_template', 'getrows', array( 'report_id' => $reportID, )); } /** + * Test get statistics. + * * @dataProvider getReportTemplates + * * @param $reportID + * * @throws \PHPUnit_Framework_IncompleteTestError */ public function testReportTemplateGetStatisticsAllReports($reportID) { @@ -167,7 +176,9 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase { } /** - * Data provider function for getting all templates, note that the function needs to + * Data provider function for getting all templates. + * + * Note that the function needs to * be static so cannot use $this->callAPISuccess */ public static function getReportTemplates() { diff --git a/tests/phpunit/api/v3/SurveyTest.php b/tests/phpunit/api/v3/SurveyTest.php index 2da0ca6c35..5235bd05d4 100644 --- a/tests/phpunit/api/v3/SurveyTest.php +++ b/tests/phpunit/api/v3/SurveyTest.php @@ -79,7 +79,9 @@ class api_v3_SurveyTest extends CiviUnitTestCase { } /** - * Test get function succeeds (this is actually largely tested in the get + * Test get function succeeds. + * + * This is actually largely tested in the get * action on create. Add extra checks for any 'special' return values or * behaviours */ @@ -101,9 +103,11 @@ class api_v3_SurveyTest extends CiviUnitTestCase { } /** - * Test & document chained delete pattern. Note that explanation of the pattern + * Test & document chained delete pattern. + * + * Note that explanation of the pattern * is best put in the $description variable as it will then be displayed in the - * test generated examples. (these are to be found in the api/examples folder) + * test generated examples. (these are to be found in the api/examples folder). */ public function testGetSurveyChainDelete() { $description = "demonstrates get + delete in the same call"; diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index 7ad04d9dd1..8d01a2a0c5 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -1422,7 +1422,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { /** - * Verify that HTML metacharacters provided as inputs appear consistently + * Verify that HTML metacharacters provided as inputs appear consistently. * as outputs. * * At time of writing, the encoding scheme requires (for example) that an diff --git a/tests/phpunit/api/v3/SystemTest.php b/tests/phpunit/api/v3/SystemTest.php index ed007f94e8..3dd8419ded 100644 --- a/tests/phpunit/api/v3/SystemTest.php +++ b/tests/phpunit/api/v3/SystemTest.php @@ -39,6 +39,7 @@ class api_v3_SystemTest extends CiviUnitTestCase { /** * Sets up the fixture, for example, opens a network connection. + * * This method is called before a test is executed. */ protected function setUp() { @@ -46,8 +47,6 @@ class api_v3_SystemTest extends CiviUnitTestCase { $this->useTransaction(TRUE); } - ///////////////// civicrm_domain_get methods - /** * Test system flush. */ diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php index fd26f3d7b5..1f9e7b7ac6 100644 --- a/tests/phpunit/api/v3/TagTest.php +++ b/tests/phpunit/api/v3/TagTest.php @@ -105,7 +105,7 @@ class api_v3_TagTest extends CiviUnitTestCase { } /** - * Test civicrm_tag_create + * Test civicrm_tag_create. */ public function testCreatePasstagInParams() { $params = array( @@ -132,8 +132,9 @@ class api_v3_TagTest extends CiviUnitTestCase { } /** - * Test civicrm_tag_create activity tag- success expected. Test checks that used_for is set - * and not over-written by default on update + * Test civicrm_tag_create activity tag- success expected. + * + * Test checks that used_for is set and not over-written by default on update. */ public function testCreateEntitySpecificTag() { $params = array( diff --git a/tests/phpunit/api/v3/UtilsTest.php b/tests/phpunit/api/v3/UtilsTest.php index 09eb88741f..46d2caf419 100644 --- a/tests/phpunit/api/v3/UtilsTest.php +++ b/tests/phpunit/api/v3/UtilsTest.php @@ -41,6 +41,7 @@ class api_v3_UtilsTest extends CiviUnitTestCase { /** * Sets up the fixture, for example, opens a network connection. + * * This method is called before a test is executed. */ protected function setUp() { diff --git a/tests/qunit/crm-backbone/test.js b/tests/qunit/crm-backbone/test.js index 614d4b25f2..e532f4b636 100644 --- a/tests/qunit/crm-backbone/test.js +++ b/tests/qunit/crm-backbone/test.js @@ -16,7 +16,7 @@ /* ------------ Assertions ------------ */ /** - * Assert "result" contains an API error + * Assert "result" contains an API error. * @param result */ function assertApiError(result) { -- 2.25.1