From 100fef9d739cd6f5377269d230510c328e484c8c Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Mon, 1 Dec 2014 17:00:35 -0500 Subject: [PATCH] Cleanup phpdoc comments --- CRM/ACL/API.php | 8 +- CRM/ACL/BAO/ACL.php | 10 +- CRM/ACL/BAO/Cache.php | 12 +- CRM/ACL/BAO/EntityRole.php | 4 +- CRM/Activity/BAO/Activity.php | 56 +++---- CRM/Activity/BAO/ActivityAssignment.php | 2 +- CRM/Activity/BAO/ActivityContact.php | 12 +- CRM/Activity/BAO/ActivityTarget.php | 8 +- CRM/Activity/BAO/Query.php | 12 +- CRM/Activity/Controller/Search.php | 2 +- CRM/Activity/Form/Activity.php | 17 ++- CRM/Activity/Form/ActivityView.php | 2 +- CRM/Activity/Form/Search.php | 12 +- CRM/Activity/Form/Task.php | 6 +- CRM/Activity/Form/Task/AddToTag.php | 6 +- CRM/Activity/Form/Task/Batch.php | 10 +- CRM/Activity/Form/Task/Delete.php | 4 +- CRM/Activity/Form/Task/Email.php | 6 +- CRM/Activity/Form/Task/FileOnCase.php | 10 +- CRM/Activity/Form/Task/PickOption.php | 14 +- CRM/Activity/Form/Task/PickProfile.php | 12 +- CRM/Activity/Form/Task/Print.php | 4 +- CRM/Activity/Form/Task/RemoveFromTag.php | 6 +- CRM/Activity/Form/Task/SMS.php | 6 +- .../Form/Task/SearchTaskHookSample.php | 2 +- CRM/Activity/Import/Controller.php | 2 +- CRM/Activity/Import/Field.php | 20 +-- CRM/Activity/Import/Form/DataSource.php | 2 +- CRM/Activity/Import/Form/MapField.php | 4 +- CRM/Activity/Import/Form/Preview.php | 2 +- CRM/Activity/Import/Form/Summary.php | 2 +- CRM/Activity/Import/Parser.php | 14 +- CRM/Activity/Import/Parser/Activity.php | 14 +- CRM/Activity/Page/Tab.php | 2 +- CRM/Activity/Page/UserDashboard.php | 2 +- CRM/Activity/Selector/Activity.php | 18 +-- CRM/Activity/Selector/Search.php | 22 +-- CRM/Activity/StateMachine/Search.php | 4 +- CRM/Activity/Task.php | 6 +- CRM/Admin/Form/ContactType.php | 2 +- CRM/Admin/Form/Extensions.php | 4 +- CRM/Admin/Form/MailSettings.php | 2 +- CRM/Admin/Form/Options.php | 4 +- CRM/Admin/Form/PaymentProcessor.php | 2 +- CRM/Admin/Form/Preferences/Contribute.php | 2 +- CRM/Admin/Form/PreferencesDate.php | 2 +- CRM/Admin/Form/ScheduleReminders.php | 2 +- CRM/Admin/Form/Setting/Component.php | 4 +- CRM/Admin/Form/Setting/Mapping.php | 2 +- CRM/Admin/Form/Setting/Miscellaneous.php | 2 +- CRM/Admin/Form/Setting/Smtp.php | 2 +- CRM/Admin/Form/WordReplacements.php | 2 +- CRM/Admin/Page/AJAX.php | 4 +- CRM/Admin/Page/Extensions.php | 2 +- CRM/Admin/Page/MessageTemplates.php | 2 +- CRM/Admin/Page/Tag.php | 5 +- CRM/Badge/BAO/Badge.php | 2 +- CRM/Badge/BAO/Layout.php | 12 +- CRM/Batch/BAO/Batch.php | 16 +- CRM/Batch/Form/Entry.php | 18 +-- CRM/Batch/Page/Batch.php | 2 +- CRM/Bridge/OG/CiviCRM.php | 8 +- CRM/Bridge/OG/Drupal.php | 2 +- CRM/Bridge/OG/Utils.php | 8 +- CRM/Campaign/BAO/Campaign.php | 12 +- CRM/Campaign/BAO/Petition.php | 22 +-- CRM/Campaign/BAO/Query.php | 10 +- CRM/Campaign/BAO/Survey.php | 28 ++-- CRM/Campaign/Controller/Search.php | 2 +- CRM/Campaign/Form/Campaign.php | 8 +- CRM/Campaign/Form/Gotv.php | 2 +- CRM/Campaign/Form/Petition.php | 2 +- CRM/Campaign/Form/Petition/Signature.php | 18 +-- CRM/Campaign/Form/Search.php | 10 +- CRM/Campaign/Form/Search/Campaign.php | 2 +- CRM/Campaign/Form/Search/Petition.php | 2 +- CRM/Campaign/Form/Search/Survey.php | 2 +- CRM/Campaign/Form/Survey.php | 4 +- CRM/Campaign/Form/Survey/Delete.php | 4 +- CRM/Campaign/Form/Survey/Main.php | 2 +- CRM/Campaign/Form/Survey/Results.php | 2 +- CRM/Campaign/Form/SurveyType.php | 6 +- CRM/Campaign/Form/Task.php | 6 +- CRM/Campaign/Form/Task/Interview.php | 8 +- CRM/Campaign/Form/Task/Print.php | 4 +- CRM/Campaign/Form/Task/Release.php | 8 +- CRM/Campaign/Form/Task/Reserve.php | 14 +- CRM/Campaign/Form/Task/Result.php | 2 +- CRM/Campaign/Page/Petition/Confirm.php | 4 +- CRM/Campaign/Page/SurveyType.php | 2 +- CRM/Campaign/Selector/Search.php | 20 +-- CRM/Campaign/StateMachine/Search.php | 4 +- CRM/Campaign/Task.php | 6 +- CRM/Case/Audit/Audit.php | 6 +- CRM/Case/Audit/AuditConfig.php | 2 +- CRM/Case/BAO/Case.php | 90 +++++------ CRM/Case/BAO/CaseType.php | 10 +- CRM/Case/BAO/Query.php | 12 +- CRM/Case/Controller/Search.php | 2 +- CRM/Case/Form/Activity.php | 4 +- .../Form/Activity/ChangeCaseStartDate.php | 2 +- CRM/Case/Form/Activity/ChangeCaseStatus.php | 2 +- CRM/Case/Form/Activity/ChangeCaseType.php | 2 +- CRM/Case/Form/Activity/LinkCases.php | 2 +- CRM/Case/Form/Activity/OpenCase.php | 4 +- CRM/Case/Form/ActivityToCase.php | 2 +- CRM/Case/Form/ActivityView.php | 2 +- CRM/Case/Form/Case.php | 12 +- CRM/Case/Form/CaseView.php | 4 +- CRM/Case/Form/CustomData.php | 4 +- CRM/Case/Form/EditClient.php | 2 +- CRM/Case/Form/Report.php | 2 +- CRM/Case/Form/Search.php | 12 +- CRM/Case/Form/Task.php | 6 +- CRM/Case/Form/Task/Delete.php | 4 +- CRM/Case/Form/Task/Print.php | 4 +- CRM/Case/Form/Task/Restore.php | 4 +- CRM/Case/Form/Task/Result.php | 2 +- CRM/Case/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Case/Page/AJAX.php | 2 +- CRM/Case/PseudoConstant.php | 8 +- CRM/Case/Selector/Search.php | 20 +-- CRM/Case/StateMachine/Search.php | 4 +- CRM/Case/Task.php | 6 +- CRM/Case/XMLProcessor/Process.php | 2 +- CRM/Case/XMLProcessor/Report.php | 36 ++--- CRM/Contact/BAO/Contact.php | 60 ++++---- CRM/Contact/BAO/Contact/Location.php | 10 +- CRM/Contact/BAO/Contact/Permission.php | 14 +- CRM/Contact/BAO/Contact/Utils.php | 32 ++-- CRM/Contact/BAO/ContactType.php | 24 +-- CRM/Contact/BAO/Group.php | 20 +-- CRM/Contact/BAO/GroupContact.php | 14 +- CRM/Contact/BAO/GroupContactCache.php | 6 +- CRM/Contact/BAO/GroupNesting.php | 6 +- CRM/Contact/BAO/GroupNestingCache.php | 8 +- CRM/Contact/BAO/GroupOrganization.php | 8 +- CRM/Contact/BAO/Household.php | 2 +- CRM/Contact/BAO/Individual.php | 4 +- CRM/Contact/BAO/Query.php | 144 +++++++++--------- CRM/Contact/BAO/Query/Hook.php | 6 +- CRM/Contact/BAO/Query/Interface.php | 2 +- CRM/Contact/BAO/Relationship.php | 34 ++--- CRM/Contact/BAO/RelationshipType.php | 8 +- CRM/Contact/BAO/SavedSearch.php | 18 +-- CRM/Contact/BAO/SearchCustom.php | 18 +-- CRM/Contact/BAO/SubscriptionHistory.php | 2 +- CRM/Contact/Controller/Search.php | 2 +- CRM/Contact/DAO/Factory.php | 2 +- CRM/Contact/Form/Contact.php | 22 +-- CRM/Contact/Form/CustomData.php | 10 +- CRM/Contact/Form/DedupeFind.php | 4 +- CRM/Contact/Form/DedupeRules.php | 4 +- CRM/Contact/Form/Domain.php | 12 +- CRM/Contact/Form/Edit/Address.php | 6 +- .../Form/Edit/CommunicationPreferences.php | 4 +- CRM/Contact/Form/Edit/CustomData.php | 2 +- CRM/Contact/Form/Edit/Household.php | 2 +- CRM/Contact/Form/Edit/Individual.php | 4 +- CRM/Contact/Form/Edit/Lock.php | 2 +- CRM/Contact/Form/Edit/Organization.php | 2 +- CRM/Contact/Form/Edit/TagsAndGroups.php | 4 +- CRM/Contact/Form/Inline/Address.php | 14 +- .../Form/Inline/CommunicationPreferences.php | 4 +- CRM/Contact/Form/Inline/ContactInfo.php | 4 +- CRM/Contact/Form/Inline/ContactName.php | 2 +- CRM/Contact/Form/Inline/CustomData.php | 10 +- CRM/Contact/Form/Inline/Demographics.php | 2 +- CRM/Contact/Form/Inline/Email.php | 10 +- CRM/Contact/Form/Inline/IM.php | 10 +- CRM/Contact/Form/Inline/Lock.php | 4 +- CRM/Contact/Form/Inline/OpenID.php | 10 +- CRM/Contact/Form/Inline/Phone.php | 10 +- CRM/Contact/Form/Inline/Website.php | 8 +- CRM/Contact/Form/Location.php | 2 +- CRM/Contact/Form/ProfileContact.php | 4 +- CRM/Contact/Form/RelatedContact.php | 4 +- CRM/Contact/Form/Relationship.php | 6 +- CRM/Contact/Form/Search.php | 20 +-- CRM/Contact/Form/Search/Advanced.php | 6 +- CRM/Contact/Form/Search/Basic.php | 6 +- CRM/Contact/Form/Search/Builder.php | 6 +- CRM/Contact/Form/Search/Criteria.php | 2 +- CRM/Contact/Form/Search/Custom/Basic.php | 2 +- .../Search/Custom/FullText/Contribution.php | 2 +- .../Search/Custom/FullText/Membership.php | 2 +- .../Search/Custom/FullText/Participant.php | 2 +- CRM/Contact/Form/Search/Custom/PriceSet.php | 2 +- CRM/Contact/Form/Task.php | 12 +- CRM/Contact/Form/Task/AddToGroup.php | 10 +- CRM/Contact/Form/Task/AddToHousehold.php | 2 +- CRM/Contact/Form/Task/AddToOrganization.php | 2 +- CRM/Contact/Form/Task/AddToTag.php | 6 +- CRM/Contact/Form/Task/AlterPreferences.php | 2 +- CRM/Contact/Form/Task/Batch.php | 18 +-- CRM/Contact/Form/Task/Delete.php | 8 +- CRM/Contact/Form/Task/Email.php | 16 +- CRM/Contact/Form/Task/EmailCommon.php | 4 +- CRM/Contact/Form/Task/HookSample.php | 4 +- CRM/Contact/Form/Task/Label.php | 8 +- CRM/Contact/Form/Task/LabelCommon.php | 6 +- CRM/Contact/Form/Task/Map.php | 6 +- CRM/Contact/Form/Task/Map/Event.php | 2 +- CRM/Contact/Form/Task/Merge.php | 2 +- CRM/Contact/Form/Task/PDF.php | 6 +- CRM/Contact/Form/Task/PDFLetterCommon.php | 10 +- CRM/Contact/Form/Task/PickProfile.php | 14 +- CRM/Contact/Form/Task/Print.php | 4 +- CRM/Contact/Form/Task/ProximityCommon.php | 8 +- CRM/Contact/Form/Task/RemoveFromGroup.php | 2 +- CRM/Contact/Form/Task/RemoveFromTag.php | 6 +- CRM/Contact/Form/Task/Result.php | 2 +- CRM/Contact/Form/Task/SMS.php | 4 +- CRM/Contact/Form/Task/SMSCommon.php | 4 +- 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 | 4 +- CRM/Contact/Import/Controller.php | 2 +- CRM/Contact/Import/Field.php | 36 ++--- CRM/Contact/Import/Form/DataSource.php | 4 +- CRM/Contact/Import/Form/MapField.php | 10 +- CRM/Contact/Import/Form/Preview.php | 4 +- CRM/Contact/Import/Form/Summary.php | 2 +- CRM/Contact/Import/ImportJob.php | 4 +- CRM/Contact/Import/Page/AJAX.php | 2 +- CRM/Contact/Import/Parser.php | 30 ++-- CRM/Contact/Import/Parser/Contact.php | 36 ++--- CRM/Contact/Page/AJAX.php | 20 +-- CRM/Contact/Page/CustomSearch.php | 2 +- CRM/Contact/Page/DedupeRules.php | 2 +- CRM/Contact/Page/SavedSearch.php | 4 +- CRM/Contact/Page/Task.php | 2 +- CRM/Contact/Page/View.php | 10 +- CRM/Contact/Page/View/CustomData.php | 6 +- CRM/Contact/Page/View/GroupContact.php | 4 +- CRM/Contact/Page/View/Note.php | 2 +- CRM/Contact/Page/View/Relationship.php | 2 +- CRM/Contact/Page/View/UserDashBoard.php | 6 +- CRM/Contact/Selector.php | 24 +-- CRM/Contact/Selector/Controller.php | 2 +- CRM/Contact/Selector/Custom.php | 20 +-- CRM/Contact/StateMachine/Search.php | 4 +- CRM/Contact/Task.php | 6 +- CRM/Contribute/BAO/Contribution.php | 68 ++++----- CRM/Contribute/BAO/Contribution/Utils.php | 12 +- CRM/Contribute/BAO/ContributionPage.php | 22 +-- CRM/Contribute/BAO/ContributionRecur.php | 12 +- CRM/Contribute/BAO/ContributionSoft.php | 18 +-- CRM/Contribute/BAO/ManagePremiums.php | 8 +- CRM/Contribute/BAO/Premium.php | 26 ++-- CRM/Contribute/BAO/Query.php | 10 +- CRM/Contribute/Controller/Contribution.php | 2 +- .../Controller/ContributionPage.php | 2 +- CRM/Contribute/Controller/Search.php | 2 +- CRM/Contribute/Form/AbstractEditPayment.php | 36 ++--- CRM/Contribute/Form/AdditionalInfo.php | 18 +-- CRM/Contribute/Form/AdditionalPayment.php | 4 +- CRM/Contribute/Form/CancelSubscription.php | 2 +- CRM/Contribute/Form/Contribution.php | 30 ++-- CRM/Contribute/Form/Contribution/Confirm.php | 30 ++-- CRM/Contribute/Form/Contribution/Main.php | 12 +- .../Form/Contribution/OnBehalfOf.php | 4 +- CRM/Contribute/Form/Contribution/ThankYou.php | 6 +- CRM/Contribute/Form/ContributionBase.php | 36 ++--- CRM/Contribute/Form/ContributionCharts.php | 2 +- CRM/Contribute/Form/ContributionPage.php | 12 +- .../Form/ContributionPage/AddProduct.php | 2 +- .../Form/ContributionPage/Amount.php | 4 +- .../Form/ContributionPage/Custom.php | 4 +- .../Form/ContributionPage/Delete.php | 4 +- .../Form/ContributionPage/Premium.php | 2 +- .../Form/ContributionPage/Settings.php | 4 +- .../Form/ContributionPage/ThankYou.php | 2 +- .../Form/ContributionPage/Widget.php | 2 +- CRM/Contribute/Form/ContributionView.php | 2 +- CRM/Contribute/Form/ManagePremiums.php | 6 +- CRM/Contribute/Form/Search.php | 10 +- CRM/Contribute/Form/SoftCredit.php | 4 +- CRM/Contribute/Form/Task.php | 6 +- CRM/Contribute/Form/Task/Batch.php | 10 +- CRM/Contribute/Form/Task/Delete.php | 4 +- CRM/Contribute/Form/Task/Email.php | 6 +- CRM/Contribute/Form/Task/Invoice.php | 12 +- CRM/Contribute/Form/Task/PDF.php | 6 +- CRM/Contribute/Form/Task/PDFLetter.php | 6 +- CRM/Contribute/Form/Task/PDFLetterCommon.php | 6 +- CRM/Contribute/Form/Task/PickProfile.php | 12 +- CRM/Contribute/Form/Task/Print.php | 4 +- CRM/Contribute/Form/Task/Result.php | 2 +- .../Form/Task/SearchTaskHookSample.php | 2 +- CRM/Contribute/Form/Task/Status.php | 6 +- CRM/Contribute/Form/UpdateBilling.php | 4 +- CRM/Contribute/Form/UpdateSubscription.php | 4 +- CRM/Contribute/Import/Controller.php | 2 +- CRM/Contribute/Import/Field.php | 22 +-- CRM/Contribute/Import/Form/DataSource.php | 2 +- CRM/Contribute/Import/Form/MapField.php | 4 +- CRM/Contribute/Import/Form/Preview.php | 2 +- CRM/Contribute/Import/Form/Summary.php | 2 +- CRM/Contribute/Import/Parser.php | 30 ++-- CRM/Contribute/Import/Parser/Contribution.php | 16 +- CRM/Contribute/Page/ContributionPage.php | 4 +- CRM/Contribute/PseudoConstant.php | 36 ++--- CRM/Contribute/Selector/Search.php | 24 +-- CRM/Contribute/StateMachine/Contribution.php | 2 +- .../StateMachine/ContributionPage.php | 2 +- CRM/Contribute/StateMachine/Search.php | 4 +- CRM/Contribute/Task.php | 6 +- CRM/Core/Action.php | 14 +- CRM/Core/BAO/ActionSchedule.php | 28 ++-- CRM/Core/BAO/Address.php | 16 +- CRM/Core/BAO/Block.php | 12 +- CRM/Core/BAO/CMSUser.php | 8 +- CRM/Core/BAO/Cache.php | 2 +- CRM/Core/BAO/ConfigSetting.php | 12 +- CRM/Core/BAO/CustomField.php | 40 ++--- CRM/Core/BAO/CustomGroup.php | 20 +-- CRM/Core/BAO/CustomOption.php | 6 +- CRM/Core/BAO/CustomQuery.php | 22 +-- CRM/Core/BAO/CustomValue.php | 4 +- CRM/Core/BAO/CustomValueTable.php | 12 +- CRM/Core/BAO/Dashboard.php | 16 +- CRM/Core/BAO/Discount.php | 4 +- CRM/Core/BAO/Domain.php | 8 +- CRM/Core/BAO/Email.php | 4 +- CRM/Core/BAO/EntityTag.php | 14 +- CRM/Core/BAO/Extension.php | 2 +- CRM/Core/BAO/File.php | 36 ++--- CRM/Core/BAO/FinancialTrxn.php | 16 +- CRM/Core/BAO/IM.php | 2 +- CRM/Core/BAO/Job.php | 6 +- CRM/Core/BAO/LabelFormat.php | 6 +- CRM/Core/BAO/Location.php | 6 +- CRM/Core/BAO/LocationType.php | 12 +- CRM/Core/BAO/Log.php | 14 +- CRM/Core/BAO/MailSettings.php | 8 +- CRM/Core/BAO/Mapping.php | 14 +- CRM/Core/BAO/MessageTemplate.php | 14 +- CRM/Core/BAO/Navigation.php | 36 ++--- CRM/Core/BAO/Note.php | 24 +-- CRM/Core/BAO/OpenID.php | 2 +- CRM/Core/BAO/OptionGroup.php | 10 +- CRM/Core/BAO/OptionValue.php | 14 +- CRM/Core/BAO/PaperSize.php | 6 +- CRM/Core/BAO/PdfFormat.php | 4 +- CRM/Core/BAO/Persistent.php | 2 +- CRM/Core/BAO/Phone.php | 2 +- CRM/Core/BAO/PreferencesDate.php | 8 +- CRM/Core/BAO/PrevNextCache.php | 10 +- CRM/Core/BAO/RecurringEntity.php | 2 +- CRM/Core/BAO/SchemaHandler.php | 20 +-- CRM/Core/BAO/Setting.php | 50 +++--- CRM/Core/BAO/Tag.php | 14 +- CRM/Core/BAO/UFField.php | 26 ++-- CRM/Core/BAO/UFGroup.php | 62 ++++---- CRM/Core/BAO/UFJoin.php | 2 +- CRM/Core/BAO/UFMatch.php | 14 +- CRM/Core/BAO/Website.php | 4 +- CRM/Core/BAO/WordReplacement.php | 4 +- CRM/Core/Base.php | 2 +- CRM/Core/Block.php | 28 ++-- CRM/Core/CodeGen/Specification.php | 16 +- CRM/Core/Component.php | 16 +- CRM/Core/Config.php | 34 ++--- CRM/Core/Config/Defaults.php | 4 +- CRM/Core/Config/Variables.php | 30 ++-- CRM/Core/Controller.php | 40 ++--- CRM/Core/Controller/Simple.php | 2 +- CRM/Core/DAO.php | 34 ++--- CRM/Core/DAO/Factory.php | 2 +- CRM/Core/Error.php | 20 +-- CRM/Core/Form.php | 64 ++++---- CRM/Core/Form/Date.php | 2 +- CRM/Core/Form/RecurringEntity.php | 2 +- CRM/Core/Form/Renderer.php | 2 +- CRM/Core/Form/Search.php | 10 +- CRM/Core/Form/Tag.php | 4 +- CRM/Core/IDS.php | 4 +- CRM/Core/JobManager.php | 4 +- CRM/Core/Menu.php | 6 +- CRM/Core/Module.php | 2 +- CRM/Core/OptionGroup.php | 18 +-- CRM/Core/OptionValue.php | 16 +- CRM/Core/Page.php | 28 ++-- CRM/Core/Page/AJAX.php | 4 +- CRM/Core/Page/Basic.php | 22 +-- CRM/Core/Payment.php | 34 ++--- CRM/Core/Payment/AuthorizeNet.php | 4 +- CRM/Core/Payment/AuthorizeNetIPN.php | 2 +- CRM/Core/Payment/BaseIPN.php | 8 +- CRM/Core/Payment/Dummy.php | 4 +- CRM/Core/Payment/Elavon.php | 2 +- CRM/Core/Payment/FirstData.php | 2 +- CRM/Core/Payment/Form.php | 12 +- CRM/Core/Payment/Google.php | 8 +- CRM/Core/Payment/GoogleIPN.php | 6 +- CRM/Core/Payment/IATS.php | 2 +- CRM/Core/Payment/Moneris.php | 2 +- CRM/Core/Payment/PayJunction.php | 2 +- CRM/Core/Payment/PayPalIPN.php | 2 +- CRM/Core/Payment/PayPalImpl.php | 14 +- CRM/Core/Payment/PayPalProIPN.php | 6 +- CRM/Core/Payment/PayflowPro.php | 6 +- CRM/Core/Payment/PaymentExpress.php | 2 +- CRM/Core/Payment/PaymentExpressIPN.php | 6 +- CRM/Core/Payment/PaymentExpressUtils.php | 4 +- CRM/Core/Payment/Realex.php | 2 +- CRM/Core/Payment/eWAY.php | 2 +- CRM/Core/Permission.php | 12 +- CRM/Core/Permission/Base.php | 4 +- CRM/Core/Permission/Drupal.php | 10 +- CRM/Core/Permission/Drupal6.php | 10 +- CRM/Core/Permission/DrupalBase.php | 8 +- CRM/Core/Permission/Joomla.php | 2 +- CRM/Core/Permission/Soap.php | 2 +- CRM/Core/Permission/UnitTests.php | 2 +- CRM/Core/Permission/WordPress.php | 2 +- CRM/Core/PseudoConstant.php | 34 ++--- CRM/Core/QuickForm/Action.php | 6 +- CRM/Core/QuickForm/Action/Back.php | 2 +- CRM/Core/QuickForm/Action/Cancel.php | 2 +- CRM/Core/QuickForm/Action/Display.php | 10 +- CRM/Core/QuickForm/Action/Done.php | 2 +- CRM/Core/QuickForm/Action/Jump.php | 2 +- CRM/Core/QuickForm/Action/Next.php | 2 +- CRM/Core/QuickForm/Action/Process.php | 2 +- CRM/Core/QuickForm/Action/Refresh.php | 2 +- CRM/Core/QuickForm/Action/Reload.php | 2 +- CRM/Core/QuickForm/Action/Submit.php | 2 +- CRM/Core/QuickForm/Action/Upload.php | 8 +- CRM/Core/Region.php | 6 +- CRM/Core/Report/Excel.php | 2 +- CRM/Core/SelectValues.php | 82 +++++----- CRM/Core/Selector/API.php | 12 +- CRM/Core/Selector/Base.php | 10 +- CRM/Core/Selector/Controller.php | 38 ++--- CRM/Core/Session.php | 20 +-- CRM/Core/ShowHideBlocks.php | 8 +- CRM/Core/Smarty.php | 6 +- CRM/Core/Smarty/resources/String.php | 6 +- CRM/Core/State.php | 16 +- CRM/Core/StateMachine.php | 34 ++--- CRM/Custom/Form/ChangeFieldType.php | 8 +- CRM/Custom/Form/DeleteField.php | 4 +- CRM/Custom/Form/DeleteGroup.php | 4 +- CRM/Custom/Form/Field.php | 8 +- CRM/Custom/Form/Group.php | 10 +- CRM/Custom/Form/MoveField.php | 10 +- CRM/Custom/Form/Option.php | 8 +- CRM/Custom/Form/Preview.php | 4 +- CRM/Custom/Import/Controller.php | 2 +- CRM/Custom/Import/Form/DataSource.php | 2 +- CRM/Custom/Import/Form/MapField.php | 6 +- CRM/Custom/Import/Form/Preview.php | 2 +- CRM/Custom/Import/Form/Summary.php | 2 +- CRM/Custom/Import/Parser.php | 12 +- CRM/Custom/Import/Parser/Api.php | 12 +- CRM/Custom/Page/Field.php | 2 +- CRM/Custom/Page/Group.php | 2 +- CRM/Custom/Page/Option.php | 2 +- CRM/Dedupe/BAO/Rule.php | 8 +- CRM/Dedupe/BAO/RuleGroup.php | 6 +- CRM/Dedupe/Merger.php | 14 +- CRM/Event/BAO/Event.php | 50 +++--- CRM/Event/BAO/Participant.php | 68 ++++----- CRM/Event/BAO/ParticipantStatusType.php | 4 +- CRM/Event/BAO/Query.php | 8 +- CRM/Event/Badge.php | 10 +- CRM/Event/Cart/BAO/Cart.php | 20 +-- CRM/Event/Cart/BAO/Conference.php | 2 +- CRM/Event/Cart/BAO/EventInCart.php | 14 +- CRM/Event/Cart/BAO/MerParticipant.php | 8 +- CRM/Event/Cart/Form/Cart.php | 6 +- CRM/Event/Cart/Form/MerParticipant.php | 10 +- CRM/Event/Controller/Registration.php | 2 +- CRM/Event/Controller/Search.php | 2 +- CRM/Event/Form/EventFees.php | 6 +- CRM/Event/Form/ManageEvent.php | 12 +- CRM/Event/Form/ManageEvent/Delete.php | 4 +- CRM/Event/Form/ManageEvent/EventInfo.php | 4 +- CRM/Event/Form/ManageEvent/Fee.php | 6 +- CRM/Event/Form/ManageEvent/Location.php | 12 +- CRM/Event/Form/ManageEvent/Registration.php | 12 +- .../Form/ManageEvent/ScheduleReminders.php | 4 +- CRM/Event/Form/Participant.php | 34 ++--- CRM/Event/Form/ParticipantView.php | 2 +- CRM/Event/Form/Registration.php | 42 ++--- .../Registration/AdditionalParticipant.php | 10 +- CRM/Event/Form/Registration/Confirm.php | 14 +- .../Form/Registration/ParticipantConfirm.php | 2 +- CRM/Event/Form/Registration/Register.php | 10 +- CRM/Event/Form/Registration/ThankYou.php | 4 +- CRM/Event/Form/Search.php | 12 +- CRM/Event/Form/Task.php | 6 +- CRM/Event/Form/Task/AddToGroup.php | 10 +- CRM/Event/Form/Task/Badge.php | 6 +- CRM/Event/Form/Task/Batch.php | 16 +- CRM/Event/Form/Task/Cancel.php | 6 +- CRM/Event/Form/Task/Delete.php | 4 +- CRM/Event/Form/Task/Email.php | 6 +- CRM/Event/Form/Task/PickProfile.php | 12 +- CRM/Event/Form/Task/Print.php | 4 +- CRM/Event/Form/Task/Result.php | 2 +- CRM/Event/Form/Task/SaveSearch.php | 6 +- CRM/Event/Form/Task/SaveSearch/Update.php | 2 +- CRM/Event/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Event/Import/Controller.php | 2 +- CRM/Event/Import/Field.php | 16 +- CRM/Event/Import/Form/DataSource.php | 2 +- CRM/Event/Import/Form/MapField.php | 4 +- CRM/Event/Import/Form/Preview.php | 2 +- CRM/Event/Import/Form/Summary.php | 2 +- CRM/Event/Import/Parser.php | 14 +- CRM/Event/Import/Parser/Participant.php | 14 +- CRM/Event/Page/AJAX.php | 2 +- CRM/Event/Page/ManageEvent.php | 6 +- .../ParticipantListing/NameStatusAndDate.php | 2 +- CRM/Event/Page/ParticipantListing/Simple.php | 2 +- CRM/Event/Page/UserDashboard.php | 2 +- CRM/Event/PseudoConstant.php | 18 +-- CRM/Event/Selector/Search.php | 22 +-- CRM/Event/StateMachine/Registration.php | 2 +- CRM/Event/StateMachine/Search.php | 4 +- CRM/Event/Task.php | 6 +- CRM/Export/BAO/Export.php | 24 +-- CRM/Export/Form/Map.php | 10 +- CRM/Export/Form/Select.php | 12 +- CRM/Extension/Manager/Module.php | 2 +- CRM/Extension/Manager/Payment.php | 2 +- CRM/Extension/Mapper.php | 2 +- CRM/Financial/BAO/ExportFormat.php | 6 +- CRM/Financial/BAO/ExportFormat/CSV.php | 6 +- CRM/Financial/BAO/ExportFormat/IIF.php | 6 +- CRM/Financial/BAO/FinancialAccount.php | 16 +- CRM/Financial/BAO/FinancialItem.php | 12 +- CRM/Financial/BAO/FinancialType.php | 12 +- CRM/Financial/BAO/FinancialTypeAccount.php | 14 +- CRM/Financial/BAO/PaymentProcessor.php | 22 +-- CRM/Financial/BAO/PaymentProcessorType.php | 12 +- CRM/Financial/Form/Export.php | 4 +- CRM/Financial/Form/FinancialAccount.php | 4 +- CRM/Financial/Form/FinancialBatch.php | 12 +- CRM/Financial/Form/FinancialTypeAccount.php | 6 +- CRM/Financial/Page/Batch.php | 2 +- CRM/Financial/Page/FinancialTypeAccount.php | 2 +- CRM/Friend/BAO/Friend.php | 6 +- CRM/Friend/Form.php | 8 +- CRM/Friend/Form/Contribute.php | 2 +- CRM/Friend/Form/Event.php | 2 +- CRM/Grant/BAO/Grant.php | 22 +-- CRM/Grant/BAO/Query.php | 10 +- CRM/Grant/Controller/Search.php | 2 +- CRM/Grant/Form/Grant.php | 6 +- CRM/Grant/Form/GrantView.php | 2 +- CRM/Grant/Form/Search.php | 10 +- CRM/Grant/Form/Task.php | 6 +- CRM/Grant/Form/Task/Delete.php | 4 +- CRM/Grant/Form/Task/Print.php | 4 +- CRM/Grant/Form/Task/Result.php | 2 +- CRM/Grant/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Grant/Form/Task/Update.php | 4 +- CRM/Grant/Page/Tab.php | 2 +- CRM/Grant/Selector/Search.php | 20 +-- CRM/Grant/StateMachine/Search.php | 4 +- CRM/Grant/Task.php | 6 +- CRM/Group/Controller.php | 2 +- CRM/Group/Form/Edit.php | 14 +- CRM/Group/Page/Group.php | 14 +- CRM/Group/StateMachine.php | 4 +- CRM/Import/DataSource.php | 2 +- CRM/Import/DataSource/CSV.php | 2 +- CRM/Import/DataSource/SQL.php | 2 +- CRM/Import/Form/MapField.php | 12 +- CRM/Import/Parser.php | 44 +++--- CRM/Logging/Differ.php | 6 +- CRM/Logging/ReportSummary.php | 6 +- CRM/Logging/Reverter.php | 2 +- CRM/Mailing/BAO/BouncePattern.php | 2 +- CRM/Mailing/BAO/Component.php | 4 +- CRM/Mailing/BAO/Mailing.php | 40 ++--- CRM/Mailing/BAO/MailingJob.php | 14 +- CRM/Mailing/BAO/Query.php | 14 +- CRM/Mailing/BAO/Recipients.php | 6 +- CRM/Mailing/BAO/Spool.php | 4 +- CRM/Mailing/BAO/TrackableURL.php | 6 +- CRM/Mailing/Controller/Send.php | 2 +- CRM/Mailing/Event/BAO/Bounce.php | 2 +- CRM/Mailing/Event/BAO/Confirm.php | 2 +- CRM/Mailing/Event/BAO/Delivered.php | 2 +- CRM/Mailing/Event/BAO/Forward.php | 2 +- CRM/Mailing/Event/BAO/Opened.php | 4 +- CRM/Mailing/Event/BAO/Queue.php | 4 +- CRM/Mailing/Event/BAO/Reply.php | 2 +- CRM/Mailing/Event/BAO/Subscribe.php | 4 +- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 2 +- CRM/Mailing/Event/BAO/Unsubscribe.php | 4 +- CRM/Mailing/Form/Approve.php | 2 +- CRM/Mailing/Form/Component.php | 2 +- CRM/Mailing/Form/Group.php | 6 +- CRM/Mailing/Form/Schedule.php | 2 +- CRM/Mailing/Form/Settings.php | 2 +- CRM/Mailing/Form/Task.php | 6 +- CRM/Mailing/Form/Task/Print.php | 4 +- CRM/Mailing/Form/Test.php | 2 +- CRM/Mailing/Form/Upload.php | 2 +- CRM/Mailing/Page/AJAX.php | 4 +- CRM/Mailing/Page/Browse.php | 10 +- CRM/Mailing/Page/Event.php | 4 +- CRM/Mailing/Page/Preview.php | 2 +- CRM/Mailing/Page/Tab.php | 2 +- CRM/Mailing/Page/View.php | 6 +- CRM/Mailing/PseudoConstant.php | 8 +- CRM/Mailing/Selector/Browse.php | 12 +- CRM/Mailing/Selector/Event.php | 22 +-- CRM/Mailing/Selector/Search.php | 22 +-- CRM/Mailing/StateMachine/Send.php | 2 +- CRM/Mailing/Task.php | 6 +- CRM/Member/BAO/Membership.php | 86 +++++------ CRM/Member/BAO/MembershipBlock.php | 6 +- CRM/Member/BAO/MembershipLog.php | 6 +- CRM/Member/BAO/MembershipPayment.php | 6 +- CRM/Member/BAO/MembershipStatus.php | 14 +- CRM/Member/BAO/MembershipType.php | 28 ++-- CRM/Member/BAO/Query.php | 6 +- CRM/Member/Controller/Search.php | 2 +- CRM/Member/Form.php | 2 +- CRM/Member/Form/Membership.php | 4 +- CRM/Member/Form/MembershipBlock.php | 6 +- CRM/Member/Form/MembershipRenewal.php | 4 +- CRM/Member/Form/MembershipType.php | 10 +- CRM/Member/Form/MembershipView.php | 2 +- CRM/Member/Form/Search.php | 10 +- CRM/Member/Form/Task.php | 6 +- CRM/Member/Form/Task/Batch.php | 10 +- CRM/Member/Form/Task/Delete.php | 4 +- CRM/Member/Form/Task/Email.php | 6 +- CRM/Member/Form/Task/Label.php | 4 +- CRM/Member/Form/Task/PDFLetter.php | 8 +- CRM/Member/Form/Task/PDFLetterCommon.php | 4 +- CRM/Member/Form/Task/PickProfile.php | 12 +- CRM/Member/Form/Task/Print.php | 4 +- CRM/Member/Form/Task/Result.php | 2 +- CRM/Member/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Member/Import/Controller.php | 2 +- CRM/Member/Import/Field.php | 20 +-- CRM/Member/Import/Form/DataSource.php | 2 +- CRM/Member/Import/Form/MapField.php | 6 +- CRM/Member/Import/Form/Preview.php | 2 +- CRM/Member/Import/Form/Summary.php | 2 +- CRM/Member/Import/Parser.php | 14 +- CRM/Member/Import/Parser/Membership.php | 14 +- CRM/Member/Page/AJAX.php | 2 +- CRM/Member/Page/Tab.php | 4 +- CRM/Member/Page/UserDashboard.php | 2 +- CRM/Member/PseudoConstant.php | 8 +- CRM/Member/Selector/Search.php | 20 +-- CRM/Member/StateMachine/Search.php | 4 +- CRM/Member/Task.php | 6 +- CRM/PCP/BAO/PCP.php | 38 ++--- CRM/PCP/Controller/PCP.php | 2 +- CRM/PCP/Form/Campaign.php | 2 +- CRM/PCP/Form/Contribute.php | 4 +- CRM/PCP/Form/Event.php | 4 +- CRM/PCP/Form/PCP.php | 4 +- CRM/PCP/Form/PCPAccount.php | 6 +- CRM/PCP/Page/PCP.php | 2 +- CRM/PCP/StateMachine/PCP.php | 2 +- CRM/Pledge/BAO/Pledge.php | 24 +-- CRM/Pledge/BAO/PledgeBlock.php | 12 +- CRM/Pledge/BAO/PledgePayment.php | 24 +-- CRM/Pledge/BAO/Query.php | 8 +- CRM/Pledge/Controller/Search.php | 2 +- CRM/Pledge/Form/Payment.php | 4 +- CRM/Pledge/Form/Pledge.php | 10 +- CRM/Pledge/Form/PledgeView.php | 2 +- CRM/Pledge/Form/Search.php | 12 +- CRM/Pledge/Form/Task.php | 6 +- CRM/Pledge/Form/Task/Delete.php | 4 +- CRM/Pledge/Form/Task/Print.php | 4 +- CRM/Pledge/Form/Task/Result.php | 2 +- CRM/Pledge/Form/Task/SearchTaskHookSample.php | 2 +- CRM/Pledge/Page/AJAX.php | 2 +- CRM/Pledge/Selector/Search.php | 20 +-- CRM/Pledge/StateMachine/Search.php | 4 +- CRM/Pledge/Task.php | 6 +- CRM/Price/BAO/LineItem.php | 16 +- CRM/Price/BAO/PriceField.php | 10 +- CRM/Price/BAO/PriceFieldValue.php | 6 +- CRM/Price/BAO/PriceSet.php | 26 ++-- CRM/Price/Form/DeleteField.php | 4 +- CRM/Price/Form/DeleteSet.php | 4 +- CRM/Price/Form/Field.php | 8 +- CRM/Price/Form/Option.php | 8 +- CRM/Price/Form/Preview.php | 4 +- CRM/Price/Form/Set.php | 6 +- CRM/Price/Page/Field.php | 4 +- CRM/Price/Page/Option.php | 2 +- CRM/Price/Page/Set.php | 2 +- CRM/Profile/Form.php | 10 +- CRM/Profile/Form/Dynamic.php | 4 +- CRM/Profile/Form/Edit.php | 4 +- CRM/Profile/Form/Search.php | 2 +- CRM/Profile/Page/Dynamic.php | 4 +- CRM/Profile/Page/Listings.php | 14 +- CRM/Profile/Page/View.php | 2 +- CRM/Profile/Selector/Listings.php | 20 +-- CRM/Report/BAO/Hook.php | 2 +- CRM/Report/BAO/ReportInstance.php | 6 +- CRM/Report/Form.php | 24 +-- CRM/Report/Form/Activity.php | 2 +- CRM/Report/Form/Case/Demographics.php | 2 +- CRM/Report/Form/Contribute/TopDonor.php | 2 +- CRM/Report/Form/Event/ParticipantListing.php | 2 +- CRM/Report/Form/Extended.php | 8 +- CRM/Report/Form/Pledge/Detail.php | 4 +- CRM/Report/Page/Instance.php | 2 +- CRM/Report/Page/InstanceList.php | 2 +- CRM/Report/Page/List.php | 2 +- CRM/Report/Page/Options.php | 2 +- CRM/Report/Page/Report.php | 2 +- CRM/Report/Page/TemplateList.php | 4 +- CRM/Report/Utils/Get.php | 8 +- CRM/Report/Utils/Report.php | 12 +- CRM/SMS/BAO/Provider.php | 10 +- CRM/SMS/Controller/Send.php | 2 +- CRM/SMS/Form/Group.php | 4 +- CRM/SMS/Form/Schedule.php | 2 +- CRM/SMS/Form/Upload.php | 2 +- CRM/SMS/Provider.php | 14 +- CRM/SMS/StateMachine/Send.php | 2 +- CRM/UF/Form/AbstractPreview.php | 2 +- CRM/UF/Form/Field.php | 16 +- CRM/UF/Form/Group.php | 8 +- CRM/UF/Form/Inline/Preview.php | 2 +- CRM/UF/Form/Inline/PreviewById.php | 2 +- CRM/UF/Form/Preview.php | 2 +- CRM/UF/Page/Field.php | 2 +- CRM/UF/Page/Group.php | 6 +- CRM/Upgrade/Controller.php | 2 +- CRM/Upgrade/Form.php | 8 +- CRM/Upgrade/Incremental/php/FourFour.php | 8 +- CRM/Upgrade/Incremental/php/FourThree.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 10 +- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 6 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 18 +-- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 2 +- .../Snapshot/V4p2/Price/DAO/FieldValue.php | 2 +- .../Snapshot/V4p2/Price/DAO/LineItem.php | 2 +- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php | 2 +- .../Snapshot/V4p2/Price/DAO/SetEntity.php | 2 +- CRM/Upgrade/StateMachine.php | 2 +- CRM/Utils/Address.php | 2 +- CRM/Utils/Cache.php | 2 +- CRM/Utils/Check/Message.php | 2 +- CRM/Utils/Date.php | 34 ++--- CRM/Utils/DeprecatedUtils.php | 4 +- CRM/Utils/FakeObject.php | 2 +- CRM/Utils/File.php | 10 +- CRM/Utils/Geocode/Google.php | 6 +- CRM/Utils/Geocode/Yahoo.php | 6 +- CRM/Utils/Hook.php | 6 +- CRM/Utils/JSON.php | 4 +- CRM/Utils/Mail.php | 4 +- CRM/Utils/Mail/Incoming.php | 2 +- CRM/Utils/Migrate/Export.php | 2 +- CRM/Utils/Migrate/ExportJSON.php | 10 +- CRM/Utils/Migrate/ImportJSON.php | 2 +- CRM/Utils/Money.php | 2 +- CRM/Utils/OpenFlashChart.php | 2 +- CRM/Utils/PDF/Label.php | 2 +- CRM/Utils/PDF/Utils.php | 6 +- CRM/Utils/Pager.php | 6 +- CRM/Utils/PagerAToZ.php | 8 +- CRM/Utils/ReCAPTCHA.php | 2 +- CRM/Utils/Recent.php | 16 +- CRM/Utils/Request.php | 2 +- CRM/Utils/Rule.php | 10 +- CRM/Utils/SQL/Insert.php | 2 +- CRM/Utils/Sort.php | 22 +-- CRM/Utils/String.php | 26 ++-- CRM/Utils/Sunlight.php | 2 +- CRM/Utils/System.php | 2 +- CRM/Utils/System/Base.php | 14 +- CRM/Utils/System/Drupal.php | 20 +-- CRM/Utils/System/Drupal6.php | 22 +-- CRM/Utils/System/Drupal8.php | 10 +- CRM/Utils/System/DrupalBase.php | 2 +- CRM/Utils/System/Joomla.php | 16 +- CRM/Utils/System/Soap.php | 8 +- CRM/Utils/System/UnitTests.php | 4 +- CRM/Utils/System/WordPress.php | 10 +- CRM/Utils/Time.php | 4 +- CRM/Utils/Token.php | 12 +- CRM/Utils/Tree.php | 6 +- CRM/Utils/Weight.php | 12 +- api/class.api.php | 2 +- api/v3/Address.php | 2 +- api/v3/Contact.php | 2 +- api/v3/Event.php | 2 +- api/v3/MailingContact.php | 6 +- api/v3/Membership.php | 4 +- api/v3/MembershipStatus.php | 2 +- api/v3/PledgePayment.php | 4 +- api/v3/Profile.php | 2 +- api/v3/utils.php | 6 +- install/civicrm.php | 4 +- install/index.php | 28 ++-- .../main.php | 2 +- .../phpunit/CRM/Activity/BAO/ActivityTest.php | 28 ++-- tests/phpunit/CRM/Batch/Form/EntryTest.php | 2 +- tests/phpunit/CRM/Contact/BAO/ContactTest.php | 38 ++--- .../BAO/ContactType/ContactSearchTest.php | 10 +- .../Contact/BAO/ContactType/ContactTest.php | 6 +- .../BAO/ContactType/ContactTypeTest.php | 12 +- .../BAO/ContactType/RelationshipTest.php | 10 +- .../CRM/Contact/BAO/GroupContactTest.php | 4 +- tests/phpunit/CRM/Contact/BAO/GroupTest.php | 2 +- .../Contribute/BAO/ContributionPageTest.php | 8 +- .../Contribute/BAO/ContributionRecurTest.php | 4 +- .../CRM/Contribute/BAO/ContributionTest.php | 10 +- .../Contribute/BAO/ContributionTypeTest.php | 8 +- .../CRM/Contribute/BAO/ManagePremiumsTest.php | 8 +- tests/phpunit/CRM/Core/BAO/AddressTest.php | 6 +- .../phpunit/CRM/Core/BAO/CustomGroupTest.php | 38 ++--- .../CRM/Core/BAO/CustomValueTableTest.php | 10 +- tests/phpunit/CRM/Core/BAO/EmailTest.php | 6 +- .../CRM/Core/BAO/FinancialTrxnTest.php | 2 +- tests/phpunit/CRM/Core/BAO/IMTest.php | 2 +- tests/phpunit/CRM/Core/BAO/LocationTest.php | 8 +- tests/phpunit/CRM/Core/BAO/OpenIDTest.php | 6 +- tests/phpunit/CRM/Core/BAO/PhoneTest.php | 6 +- .../CRM/Core/Payment/AuthorizeNetIPNTest.php | 4 +- .../CRM/Core/Payment/AuthorizeNetTest.php | 4 +- .../CRM/Core/Payment/PayPalProIPNTest.php | 8 +- tests/phpunit/CRM/Core/PaymentTest.php | 2 +- .../CRM/Event/BAO/ParticipantStatusTest.php | 4 +- .../phpunit/CRM/Event/BAO/ParticipantTest.php | 22 +-- .../CRM/Extension/Manager/ModuleTest.php | 2 +- .../Financial/BAO/FinancialAccountTest.php | 10 +- .../CRM/Financial/BAO/FinancialItemTest.php | 10 +- .../BAO/FinancialTypeAccountTest.php | 10 +- .../CRM/Financial/BAO/FinancialTypeTest.php | 8 +- .../BAO/PaymentProcessorTypeTest.php | 10 +- tests/phpunit/CRM/Group/Page/AjaxTest.php | 30 ++-- .../phpunit/CRM/Member/BAO/MembershipTest.php | 2 +- tests/phpunit/CRM/PCP/BAO/PCPTest.php | 4 +- .../CRM/Pledge/BAO/PledgeBlockTest.php | 4 +- .../CRM/Utils/API/ReloadOptionTest.php | 4 +- tests/phpunit/CRM/Utils/MailTest.php | 2 +- .../CRM/Utils/Migrate/ImportExportTest.php | 4 +- tests/phpunit/CRM/Utils/ZipTest.php | 2 +- tests/phpunit/Civi/API/RequestTest.php | 2 +- tests/phpunit/CiviTest/CiviReportTestCase.php | 2 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 18 +-- tests/phpunit/CiviTest/CiviUnitTestCase.php | 130 ++++++++-------- tests/phpunit/CiviTest/Contact.php | 6 +- tests/phpunit/CiviTest/ContributionPage.php | 2 +- tests/phpunit/CiviTest/Event.php | 2 +- tests/phpunit/CiviTest/Participant.php | 4 +- .../WebTest/Admin/MoveCustomDataTest.php | 14 +- .../phpunit/WebTest/Campaign/ActivityTest.php | 2 +- .../phpunit/WebTest/Campaign/MailingTest.php | 4 +- .../WebTest/Campaign/MembershipTest.php | 2 +- .../Campaign/OfflineContributionTest.php | 4 +- .../Campaign/OfflineEventRegistrationTest.php | 2 +- .../Campaign/OnlineContributionTest.php | 2 +- .../Campaign/OnlineEventRegistrationTest.php | 6 +- tests/phpunit/WebTest/Campaign/PledgeTest.php | 2 +- .../WebTest/Case/ActivityToCaseTest.php | 2 +- tests/phpunit/WebTest/Case/AddCaseTest.php | 10 +- .../WebTest/Case/CaseCustomFieldsTest.php | 8 +- .../AdvanceSearchPrivacyOptionsTest.php | 8 +- .../WebTest/Contact/AdvancedSearchTest.php | 6 +- .../AdvancedSearchedRelatedContactTest.php | 6 +- .../Contact/CreateCmsUserFromContactTest.php | 2 +- .../DeceasedContactsAdvancedSearchTest.php | 6 +- .../phpunit/WebTest/Contact/GroupAddTest.php | 2 +- .../WebTest/Contact/MergeContactsTest.php | 4 +- .../WebTest/Contact/ProfileChecksumTest.php | 2 +- .../WebTest/Contact/SearchBuilderTest.php | 2 +- .../WebTest/Contribute/AddPricesetTest.php | 2 +- .../Contribute/ContributionPageAddTest.php | 4 +- .../Contribute/OfflineContributionTest.php | 4 +- .../Contribute/OnBehalfOfOrganization.php | 20 +-- .../Contribute/OnlineContributionTest.php | 2 +- .../UpdateBatchPendingContributionTest.php | 2 +- .../Contribute/UpdateContributionTest.php | 8 +- .../Contribute/VerifySSLContributionTest.php | 2 +- tests/phpunit/WebTest/Event/AddEventTest.php | 8 +- .../WebTest/Event/AddParticipationTest.php | 6 +- .../phpunit/WebTest/Event/AddPricesetTest.php | 6 +- .../WebTest/Event/AdditionalPaymentTest.php | 2 +- .../WebTest/Event/ChangeParticipantStatus.php | 2 +- .../MultipleEventRegistrationbyCartTest.php | 4 +- .../WebTest/Event/MultiprofileEventTest.php | 30 ++-- tests/phpunit/WebTest/Event/PCPAddTest.php | 32 ++-- .../WebTest/Event/ParticipantCountTest.php | 2 +- tests/phpunit/WebTest/Export/ContactTest.php | 2 +- .../Export/ExportCiviSeleniumTestCase.php | 4 +- .../Financial/FinancialBatchExport.php | 2 +- .../WebTest/Generic/CheckDashboardTest.php | 4 +- .../WebTest/Import/AddressImportTest.php | 6 +- .../WebTest/Import/AddressParsingTest.php | 4 +- .../WebTest/Import/ContactCustomDataTest.php | 4 +- .../phpunit/WebTest/Import/CustomDataTest.php | 4 +- .../Import/ImportCiviSeleniumTestCase.php | 4 +- .../WebTest/Import/MatchExternalIdTest.php | 6 +- .../WebTest/Import/SavedMappingTest.php | 2 +- .../Member/BatchUpdateViaProfileTest.php | 4 +- .../Member/DefaultMembershipPricesetTest.php | 8 +- .../OfflineMembershipAddPricesetTest.php | 12 +- .../OnlineMembershipAddPricesetTest.php | 12 +- .../Member/OnlineMembershipCreateTest.php | 8 +- .../Member/SeperateMembershipPaymentTest.php | 6 +- .../Profile/MultiRecordProfileAddTest.php | 2 +- .../Report/RolePermissionReportTest.php | 2 +- tests/phpunit/api/v3/ACLPermissionTest.php | 10 +- tests/phpunit/api/v3/APIStandardsTest.php | 2 +- tests/phpunit/api/v3/APITest.php | 2 +- tests/phpunit/api/v3/ActionScheduleTest.php | 2 +- tests/phpunit/api/v3/ActivityTest.php | 22 +-- tests/phpunit/api/v3/AddressTest.php | 4 +- tests/phpunit/api/v3/CaseTest.php | 4 +- tests/phpunit/api/v3/CaseTypeTest.php | 8 +- tests/phpunit/api/v3/ContactTest.php | 10 +- tests/phpunit/api/v3/ContactTypeTest.php | 12 +- tests/phpunit/api/v3/ContributionPageTest.php | 4 +- tests/phpunit/api/v3/ContributionSoftTest.php | 2 +- tests/phpunit/api/v3/ContributionTest.php | 32 ++-- tests/phpunit/api/v3/CustomFieldTest.php | 22 +-- tests/phpunit/api/v3/CustomGroupTest.php | 36 ++--- tests/phpunit/api/v3/DashboardTest.php | 2 +- tests/phpunit/api/v3/EventTest.php | 6 +- .../phpunit/api/v3/GroupOrganizationTest.php | 8 +- tests/phpunit/api/v3/JobTest.php | 24 +-- tests/phpunit/api/v3/MembershipTest.php | 6 +- tests/phpunit/api/v3/MessageTemplateTest.php | 2 +- tests/phpunit/api/v3/NoteTest.php | 6 +- tests/phpunit/api/v3/OptionGroupTest.php | 4 +- tests/phpunit/api/v3/OptionValueTest.php | 6 +- .../phpunit/api/v3/ParticipantPaymentTest.php | 22 +-- tests/phpunit/api/v3/ParticipantTest.php | 48 +++--- tests/phpunit/api/v3/PaymentProcessorTest.php | 8 +- .../api/v3/PaymentProcessorTypeTest.php | 24 +-- tests/phpunit/api/v3/PledgePaymentTest.php | 2 +- tests/phpunit/api/v3/PledgeTest.php | 14 +- tests/phpunit/api/v3/ProfileTest.php | 42 ++--- tests/phpunit/api/v3/RelationshipTest.php | 50 +++--- tests/phpunit/api/v3/RelationshipTypeTest.php | 26 ++-- tests/phpunit/api/v3/SettingTest.php | 20 +-- tests/phpunit/api/v3/SurveyTest.php | 4 +- .../phpunit/api/v3/SyntaxConformanceTest.php | 2 +- tests/phpunit/api/v3/TagTest.php | 2 +- .../api/v3/TaxContributionPageTest.php | 8 +- tests/phpunit/api/v3/UFFieldTest.php | 6 +- tests/phpunit/api/v3/UFGroupTest.php | 2 +- tests/phpunit/api/v3/UFJoinTest.php | 6 +- tests/phpunit/api/v3/UFMatchTest.php | 4 +- 960 files changed, 4266 insertions(+), 4258 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index bd3e6574f8..3c01be48c6 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -47,7 +47,7 @@ class CRM_ACL_API { CONST ALL = 6; /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * @param int $contactID the contactID for whom the check is made @@ -135,7 +135,7 @@ class CRM_ACL_API { } /** - * get all the groups the user has access to for the given operation + * Get all the groups the user has access to for the given operation * * @param int $type the type of permission needed * @param int $contactID the contactID for whom the check is made @@ -168,10 +168,10 @@ class CRM_ACL_API { } /** - * check if the user has access to this group for operation $type + * Check if the user has access to this group for operation $type * * @param int $type the type of permission needed - * @param $groupID + * @param int $groupID * @param int $contactID the contactID for whom the check is made * * @param string $tableName diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 78c044c93e..0512b1aee0 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -674,7 +674,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 * @param boolean $is_active value we want to set the is_active field @@ -691,7 +691,7 @@ SELECT $acl.* /** * @param $str - * @param $contactID + * @param int $contactID * * @return bool */ @@ -725,7 +725,7 @@ SELECT count( a.id ) * @param $type * @param $tables * @param $whereTables - * @param null $contactID + * @param int $contactID * * @return null|string */ @@ -847,7 +847,7 @@ SELECT g.* /** * @param int $type - * @param null $contactID + * @param int $contactID * @param string $tableName * @param null $allGroups * @param null $includedGroups @@ -963,7 +963,7 @@ ORDER BY a.object_id } /** - * delete ACL records + * Delete ACL records * * @param int $aclId ID of the ACL record to be deleted. * diff --git a/CRM/ACL/BAO/Cache.php b/CRM/ACL/BAO/Cache.php index e34265969b..c3ba69de93 100644 --- a/CRM/ACL/BAO/Cache.php +++ b/CRM/ACL/BAO/Cache.php @@ -41,7 +41,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache { static $_cache = NULL; /** - * @param $id + * @param int $id * * @return mixed */ @@ -67,7 +67,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache { } /** - * @param $id + * @param int $id * * @return array */ @@ -93,8 +93,8 @@ SELECT acl_id } /** - * @param $id - * @param $cache + * @param int $id + * @param array $cache */ static function store($id, &$cache) { foreach ($cache as $aclID => $data) { @@ -111,7 +111,7 @@ SELECT acl_id } /** - * @param $id + * @param int $id */ static function deleteEntry($id) { if (self::$_cache && @@ -129,7 +129,7 @@ WHERE contact_id = %1 } /** - * @param $id + * @param int $id */ static function updateEntry($id) { // rebuilds civicrm_acl_cache diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index 261c65b7dc..af823a1a91 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 * @param boolean $is_active value we want to set the is_active field @@ -86,7 +86,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * delete Entity Role records + * Delete Entity Role records * * @param int $entityRoleId ID of the EntityRole record to be deleted. * diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index c22465c295..ae1629f98b 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -40,7 +40,7 @@ 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 @@ -48,7 +48,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { 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 * @static @@ -76,7 +76,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return CRM_Core_BAO_Meeting object + * @return CRM_Activity_DAO_Activity object * @access public */ public static function retrieve(&$params, &$defaults) { @@ -140,7 +140,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * delete the activity + * Delete the activity * * @param array $params associated array * @param bool $moveToTrash @@ -250,7 +250,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { * Delete activity assignment record * * @param int $activityId - * @param null $recordTypeID + * @param int $recordTypeID * * @return null * @access public @@ -265,7 +265,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * process the activities + * Process the activities * * @param array $params associated array of the submitted values * @@ -643,7 +643,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { } /** - * get the list Activities + * Get the list Activities * * @param array $input array of parameters * Keys include @@ -935,7 +935,7 @@ ORDER BY fixed_sort_order } /** - * get the activity Count + * Get the activity Count * * @param array $input array of parameters * Keys include @@ -971,7 +971,7 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a } /** - * function to get the activity sql clause to pick activities + * Get the activity sql clause to pick activities * * @param array $input array of parameters * Keys include @@ -1151,7 +1151,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND } /** - * send the message to all the contacts and also insert a + * Send the message to all the contacts and also insert a * contact activity in each contacts record * * @param array $contactDetails the array of contact details to send the email @@ -1355,11 +1355,11 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND } /** - * @param $contactDetails - * @param $activityParams + * @param array $contactDetails + * @param array $activityParams * @param array $smsParams * @param $contactIds - * @param null $userID + * @param int $userID * * @return array * @throws CRM_Core_Exception @@ -1498,14 +1498,14 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND } /** - * send the sms message to a specific contact + * Send the sms message to a specific contact * * @param int $toID the contact id of the recipient * @param $tokenText * @param $tokenHtml * @param array $smsParams the params used for sending sms * @param int $activityID the activity ID that tracks the message - * @param null $userID + * @param int $userID * * @return mixed true on success or PEAR_Error object * @access public @@ -1573,10 +1573,10 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND } /** - * send the message to a specific contact + * Send the message to a specific contact * * @param string $from the name and email of the sender - * @param $fromID + * @param int $fromID * @param int $toID the contact id of the recipient * @param string $subject the subject of the message * @param $text_message @@ -1651,7 +1651,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND } /** - * 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 @@ -1782,7 +1782,7 @@ WHERE activity.id IN ($activityIds)"; } /** - * Function to add activity for Membership/Event/Contribution + * Add activity for Membership/Event/Contribution * * @param object $activity (reference) particular component object * @param string $activityType for Membership Signup or Renewal @@ -2014,11 +2014,11 @@ AND cl.modified_id = c.id } /** - * Function to find the latest revision of a given activity + * Find the latest revision of a given activity * - * @param $activityID prior activity id + * @param int $activityID prior activity id * - * @return int $params current activity id. + * @return int current activity id. * @access public */ static function getLatestActivityId($activityID) { @@ -2046,7 +2046,7 @@ AND cl.modified_id = c.id } /** - * Function to create a follow up a given activity + * Create a follow up a given activity * * @param $activityId int activity id of parent activity * @param array $params @@ -2086,7 +2086,7 @@ AND cl.modified_id = c.id } /** - * Function to get Activity specific File according activity type Id. + * Get Activity specific File according activity type Id. * * @param int $activityTypeId activity id * @param string $crmDir @@ -2120,7 +2120,7 @@ AND cl.modified_id = c.id } /** - * Function to restore the activity + * Restore the activity * * @param array $params associated array * @@ -2620,8 +2620,8 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n } /** - * @param $activityId - * @param null $recordTypeID + * @param int $activityId + * @param int $recordTypeID * @param string $column * * @return null @@ -2639,7 +2639,7 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n } /** - * @param $activityId + * @param int $activityId * * @return null */ diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index 47dc534d1e..2b59602936 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 */ function __construct() { parent::__construct(); diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 95e86985bb..752f442c7a 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -40,14 +40,14 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * funtion to add activity contact + * Funtion to add activity contact * * @param array $params the values for this table: activity id, contact id, record type * @@ -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 @@ -107,10 +107,10 @@ AND contact_a.is_deleted = 0 } /** - * retrieve id of target contact by activity_id + * Retrieve id of target contact by activity_id * - * @param $activityID - * @param $recordTypeID + * @param int $activityID + * @param int $recordTypeID * * @return mixed * diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index 3b3650848c..756f557b5d 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 */ 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 * @@ -98,7 +98,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/Query.php b/CRM/Activity/BAO/Query.php index 2fde084f55..299f79bcbf 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -36,7 +36,7 @@ class CRM_Activity_BAO_Query { /** - * build select for Case + * Build select for Case * * @param $query * @@ -183,7 +183,7 @@ class CRM_Activity_BAO_Query { } /** - * where clause for a single field + * Where clause for a single field * * @param $values * @param $query @@ -395,7 +395,7 @@ class CRM_Activity_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -452,7 +452,7 @@ class CRM_Activity_BAO_Query { } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -462,11 +462,11 @@ class CRM_Activity_BAO_Query { } /** - * add all the elements shared between case activity search and advanaced search + * Add all the elements shared between case activity search and advanced search * * @access public * - * @param $form CRM_Core_Form + * @param CRM_Core_Form $form * @return void * @static */ diff --git a/CRM/Activity/Controller/Search.php b/CRM/Activity/Controller/Search.php index d0a9129661..4750de66dc 100644 --- a/CRM/Activity/Controller/Search.php +++ b/CRM/Activity/Controller/Search.php @@ -46,7 +46,7 @@ class CRM_Activity_Controller_Search extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) { diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index bb4df1c47b..d54db9a199 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -47,7 +47,7 @@ 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 */ @@ -816,7 +816,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -867,8 +867,8 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { * * @access public * - * @param null $params - * @return void + * @param array $params + * @return array|null */ public function postProcess($params = NULL) { if ($this->_action & CRM_Core_Action::DELETE) { @@ -1165,9 +1165,10 @@ 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 */ function beginPostProcess(&$params) { if ($this->_activityTypeFile) { @@ -1177,14 +1178,16 @@ 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, after the activity has been added/updated * + * @param array $params + * @param $activity */ function endPostProcess(&$params, &$activity) { if ($this->_activityTypeFile) { $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}"; - $className::endPostProcess($this, $params, $activity ); + $className::endPostProcess($this, $params, $activity); } } } diff --git a/CRM/Activity/Form/ActivityView.php b/CRM/Activity/Form/ActivityView.php index ccbc7f3ff3..9e61ed6243 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 * @access public diff --git a/CRM/Activity/Form/Search.php b/CRM/Activity/Form/Search.php index bbbb39b903..ee667b27dc 100644 --- a/CRM/Activity/Form/Search.php +++ b/CRM/Activity/Form/Search.php @@ -42,7 +42,7 @@ 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 * @access protected @@ -50,7 +50,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -58,7 +58,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -66,7 +66,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { protected $_limit = NULL; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = "activity_"; @@ -74,7 +74,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * the saved search ID retrieved from the GET vars + * The saved search ID retrieved from the GET vars * * @var int * @access protected @@ -82,7 +82,7 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { protected $_ssID; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index 8b7ac12628..4f9205cea2 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Activity_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -75,7 +75,7 @@ class CRM_Activity_Form_Task extends CRM_Core_Form { public $_activityHolderIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -172,7 +172,7 @@ WHERE activity_id IN ( $IDs ) AND } /** - * 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 title of the main button diff --git a/CRM/Activity/Form/Task/AddToTag.php b/CRM/Activity/Form/Task/AddToTag.php index a4bf17e540..20d8ef7b7d 100644 --- a/CRM/Activity/Form/Task/AddToTag.php +++ b/CRM/Activity/Form/Task/AddToTag.php @@ -41,14 +41,14 @@ 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 */ @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Activity/Form/Task/Batch.php b/CRM/Activity/Form/Task/Batch.php index e40ef97405..9fa3a93d0e 100755 --- a/CRM/Activity/Form/Task/Batch.php +++ b/CRM/Activity/Form/Task/Batch.php @@ -39,26 +39,26 @@ 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 * @access public @@ -224,7 +224,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 * * @access public * diff --git a/CRM/Activity/Form/Task/Delete.php b/CRM/Activity/Form/Task/Delete.php index a7f476c9f3..bbd4d6540b 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 * @access public @@ -70,7 +70,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 * * @access public * diff --git a/CRM/Activity/Form/Task/Email.php b/CRM/Activity/Form/Task/Email.php index 8a435c6185..feaecd63fe 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 * @access public @@ -86,7 +86,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 * * @access public * diff --git a/CRM/Activity/Form/Task/FileOnCase.php b/CRM/Activity/Form/Task/FileOnCase.php index e0eb190220..c20206b9e7 100644 --- a/CRM/Activity/Form/Task/FileOnCase.php +++ b/CRM/Activity/Form/Task/FileOnCase.php @@ -39,26 +39,26 @@ 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 * @access public @@ -93,7 +93,7 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { function addRules() {} /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index ca57ef9258..fbda819257 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -39,32 +39,32 @@ 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 * @access public @@ -119,7 +119,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 * @@ -138,7 +138,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 * * @access public * diff --git a/CRM/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index 45c3ac054a..ac6a207019 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/Form/Task/PickProfile.php @@ -39,26 +39,26 @@ 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 * @access public @@ -147,7 +147,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 * @@ -160,7 +160,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 * * @access public * diff --git a/CRM/Activity/Form/Task/Print.php b/CRM/Activity/Form/Task/Print.php index 77e241e7fd..846f999876 100644 --- a/CRM/Activity/Form/Task/Print.php +++ b/CRM/Activity/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Activity_Form_Task_Print 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 * @access public @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Activity/Form/Task/RemoveFromTag.php b/CRM/Activity/Form/Task/RemoveFromTag.php index 8375c7213f..746984c2b3 100644 --- a/CRM/Activity/Form/Task/RemoveFromTag.php +++ b/CRM/Activity/Form/Task/RemoveFromTag.php @@ -39,14 +39,14 @@ class CRM_Activity_Form_Task_RemoveFromTag 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 */ @@ -91,7 +91,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 * * @access public * diff --git a/CRM/Activity/Form/Task/SMS.php b/CRM/Activity/Form/Task/SMS.php index 1d80011dbb..f8b32a2a0b 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 * @access public @@ -72,7 +72,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 * * @access public * diff --git a/CRM/Activity/Form/Task/SearchTaskHookSample.php b/CRM/Activity/Form/Task/SearchTaskHookSample.php index c70a91f8a0..51e049bdad 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 * @access public diff --git a/CRM/Activity/Import/Controller.php b/CRM/Activity/Import/Controller.php index ff8030c1ec..748d815f13 100644 --- a/CRM/Activity/Import/Controller.php +++ b/CRM/Activity/Import/Controller.php @@ -35,7 +35,7 @@ class CRM_Activity_Import_Controller extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Activity/Import/Field.php b/CRM/Activity/Import/Field.php index 6ee8a03e83..0808396e4e 100644 --- a/CRM/Activity/Import/Field.php +++ b/CRM/Activity/Import/Field.php @@ -40,53 +40,53 @@ class CRM_Activity_Import_Field { */ /** - * name of the field + * Name of the field */ public $_name; /** - * title of the field to be used in display + * Title of the field to be used in display */ public $_title; /** - * type of field + * Type of field * @var enum */ public $_type; /** - * is this field required + * Is this field required * @var boolean */ public $_required; /** - * data to be carried for use by a derived class + * Data to be carried for use by a derived class * @var object */ public $_payload; /** - * regexp to match the CSV header of this column/field + * Regexp to match the CSV header of this column/field * @var string */ public $_headerPattern; /** - * regexp to match the pattern of data from various column/fields + * Regexp to match the pattern of data from various column/fields * @var string */ public $_dataPattern; /** - * value of this field + * Value of this field * @var object */ public $_value; /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern @@ -107,7 +107,7 @@ class CRM_Activity_Import_Field { } /** - * the value is in string format. convert the value to the type of this field + * The value is in string format. convert the value to the type of this field * and set the field value with the appropriate type */ function setValue($value) { diff --git a/CRM/Activity/Import/Form/DataSource.php b/CRM/Activity/Import/Form/DataSource.php index 6c2f658944..692887f571 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 * @access public diff --git a/CRM/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index a25ce49ddc..70bdfa3e6e 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -267,7 +267,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 * diff --git a/CRM/Activity/Import/Form/Preview.php b/CRM/Activity/Import/Form/Preview.php index 7679e599b0..5f09d29ac3 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 * @access public diff --git a/CRM/Activity/Import/Form/Summary.php b/CRM/Activity/Import/Form/Summary.php index 7ed863af97..f1aac6585a 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 * @access public diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 5143b2fa18..e2f8311fc0 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -44,29 +44,29 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { */ /** - * imported file size + * Imported file size */ protected $_fileSize; /** - * seperator being used + * Seperator being used */ 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 */ protected $_haveColumnHeader; /** - * @param $fileName + * @param string $fileName * @param string $seperator * @param $mapper * @param bool $skipColumnHeader @@ -296,7 +296,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 * @access public @@ -316,7 +316,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php index bca07b0f93..25aa4ab0e7 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 */ function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -63,7 +63,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -128,7 +128,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 * @@ -140,7 +140,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 * @@ -152,7 +152,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 * @@ -234,7 +234,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 * @param array $values the array of values belonging to this line @@ -393,7 +393,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public diff --git a/CRM/Activity/Page/Tab.php b/CRM/Activity/Page/Tab.php index 555d1b7e86..576dfe9197 100644 --- a/CRM/Activity/Page/Tab.php +++ b/CRM/Activity/Page/Tab.php @@ -162,7 +162,7 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page { } /** - * perform actions and display for activities. + * Perform actions and display for activities. * * @return void * diff --git a/CRM/Activity/Page/UserDashboard.php b/CRM/Activity/Page/UserDashboard.php index 9429313c2d..ce5c691eb3 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 null * @access public diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index d1d85bcd59..2df5ddbc62 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -40,7 +40,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -48,7 +48,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C static $_columnHeaders; /** - * contactId - contact id of contact whose activies are displayed + * ContactId - contact id of contact whose activies are displayed * * @var int * @access protected @@ -100,9 +100,9 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * - View * * @param int $activityTypeId - * @param null $sourceRecordId + * @param int $sourceRecordId * @param bool $accessMailingReport - * @param null $activityId + * @param int $activityId * @param null $key * @param null $compContext * @@ -272,7 +272,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -289,7 +289,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -338,7 +338,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 enum $action the action being performed * @param int $offset the row number to start from @@ -464,7 +464,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C } /** - * name of export file. + * Name of export file. * * @param string $output type of output * @@ -475,7 +475,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 $_columnHeaders diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index a3aa100bc4..25afecc8be 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -49,7 +49,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -82,7 +82,7 @@ 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 * * @access protected * @var boolean @@ -90,7 +90,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -98,7 +98,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -106,7 +106,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM protected $_context = NULL; /** - * what component context are we being invoked from + * What component context are we being invoked from * * @access protected * @var string @@ -114,7 +114,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM 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 @@ -123,7 +123,7 @@ 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 * @access protected @@ -191,7 +191,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -224,7 +224,7 @@ class CRM_Activity_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 enum $action the action being performed * @param int $offset the row number to start from @@ -366,7 +366,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -428,7 +428,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index ad14391ecd..d0ad88ad91 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -42,7 +42,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -88,7 +88,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 * @access public diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php index 032f6a92f8..f5e6c80e6b 100644 --- a/CRM/Activity/Task.php +++ b/CRM/Activity/Task.php @@ -47,7 +47,7 @@ class CRM_Activity_Task { EMAIL_SMS = 6; /** - * the task array + * The task array * * @var array * @static @@ -55,7 +55,7 @@ class CRM_Activity_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -164,7 +164,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 diff --git a/CRM/Admin/Form/ContactType.php b/CRM/Admin/Form/ContactType.php index 3862ee0ca2..cc57e8dae6 100644 --- a/CRM/Admin/Form/ContactType.php +++ b/CRM/Admin/Form/ContactType.php @@ -83,7 +83,7 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * diff --git a/CRM/Admin/Form/Extensions.php b/CRM/Admin/Form/Extensions.php index 45ef291694..ffc48be156 100644 --- a/CRM/Admin/Form/Extensions.php +++ b/CRM/Admin/Form/Extensions.php @@ -40,7 +40,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** - * for pre-processing + * For pre-processing * * @return void * @access public @@ -152,7 +152,7 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Admin/Form/MailSettings.php b/CRM/Admin/Form/MailSettings.php index 2b4998eaad..35f7a5337e 100644 --- a/CRM/Admin/Form/MailSettings.php +++ b/CRM/Admin/Form/MailSettings.php @@ -103,7 +103,7 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_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/Admin/Form/Options.php b/CRM/Admin/Form/Options.php index 55a1a57cca..c7085e8a16 100644 --- a/CRM/Admin/Form/Options.php +++ b/CRM/Admin/Form/Options.php @@ -56,7 +56,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { protected $_gLabel; /** - * pre-process + * Pre-process * * @return void * @access public @@ -321,7 +321,7 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index 9136f1c2dc..3a67d0c9a3 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -367,7 +367,7 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { * Save a payment processor * * @param $values - * @param $domainID + * @param int $domainID * @param $test * * @return Void diff --git a/CRM/Admin/Form/Preferences/Contribute.php b/CRM/Admin/Form/Preferences/Contribute.php index b4e119c42e..8e5eea9a50 100644 --- a/CRM/Admin/Form/Preferences/Contribute.php +++ b/CRM/Admin/Form/Preferences/Contribute.php @@ -114,7 +114,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Admin/Form/PreferencesDate.php b/CRM/Admin/Form/PreferencesDate.php index ad9d833b63..3943daf0b2 100644 --- a/CRM/Admin/Form/PreferencesDate.php +++ b/CRM/Admin/Form/PreferencesDate.php @@ -89,7 +89,7 @@ class CRM_Admin_Form_PreferencesDate extends CRM_Admin_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/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php index 56948182bd..06451c563d 100644 --- a/CRM/Admin/Form/ScheduleReminders.php +++ b/CRM/Admin/Form/ScheduleReminders.php @@ -235,7 +235,7 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { $this->setPageTitle(ts('Scheduled Reminder')); } /** - * global form rule + * Global form rule * * @param array $fields the input form values * diff --git a/CRM/Admin/Form/Setting/Component.php b/CRM/Admin/Form/Setting/Component.php index 557c0ffbf3..f97da5b36d 100644 --- a/CRM/Admin/Form/Setting/Component.php +++ b/CRM/Admin/Form/Setting/Component.php @@ -66,7 +66,7 @@ class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -120,7 +120,7 @@ class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting { /** * @param $dsn - * @param $fileName + * @param string $fileName * @param bool $lineMode */ public static function loadCaseSampleData($dsn, $fileName, $lineMode = FALSE) { diff --git a/CRM/Admin/Form/Setting/Mapping.php b/CRM/Admin/Form/Setting/Mapping.php index c535b7c236..ec8b615968 100644 --- a/CRM/Admin/Form/Setting/Mapping.php +++ b/CRM/Admin/Form/Setting/Mapping.php @@ -59,7 +59,7 @@ class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * diff --git a/CRM/Admin/Form/Setting/Miscellaneous.php b/CRM/Admin/Form/Setting/Miscellaneous.php index b122554fb3..51e70f280a 100644 --- a/CRM/Admin/Form/Setting/Miscellaneous.php +++ b/CRM/Admin/Form/Setting/Miscellaneous.php @@ -117,7 +117,7 @@ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index f91079753c..dca16eb6cc 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -201,7 +201,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $fields posted values of the form * diff --git a/CRM/Admin/Form/WordReplacements.php b/CRM/Admin/Form/WordReplacements.php index b712c964cf..518e19afdd 100644 --- a/CRM/Admin/Form/WordReplacements.php +++ b/CRM/Admin/Form/WordReplacements.php @@ -175,7 +175,7 @@ class CRM_Admin_Form_WordReplacements extends CRM_Core_Form { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * diff --git a/CRM/Admin/Page/AJAX.php b/CRM/Admin/Page/AJAX.php index df315468d1..01df5eb449 100644 --- a/CRM/Admin/Page/AJAX.php +++ b/CRM/Admin/Page/AJAX.php @@ -62,14 +62,14 @@ class CRM_Admin_Page_AJAX { } /** - * process drag/move action for menu tree + * Process drag/move action for menu tree */ static function menuTree() { CRM_Core_BAO_Navigation::processNavigation($_GET); } /** - * build status message while + * Build status message while * enabling/ disabling various objects */ static function getStatusMsg() { diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php index a0d7449810..b43cc0bb0b 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -268,7 +268,7 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { } /** - * get userContext params + * Get userContext params * * @param int $mode mode that we are in * diff --git a/CRM/Admin/Page/MessageTemplates.php b/CRM/Admin/Page/MessageTemplates.php index be4b80ca27..bf1935a1c2 100644 --- a/CRM/Admin/Page/MessageTemplates.php +++ b/CRM/Admin/Page/MessageTemplates.php @@ -236,7 +236,7 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { } /** - * browse all entities. + * Browse all entities. * * @return void * @access public diff --git a/CRM/Admin/Page/Tag.php b/CRM/Admin/Page/Tag.php index 0214b9e5c1..b8b3a6490d 100644 --- a/CRM/Admin/Page/Tag.php +++ b/CRM/Admin/Page/Tag.php @@ -135,7 +135,10 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { } /** - * override function browse() + * Override function browse() + * + * @param null $action + * @param null $sort */ function browse($action = NULL, $sort = NULL) { $adminTagSet = FALSE; diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index a157a7623e..cf0f1f97ab 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -394,7 +394,7 @@ class CRM_Badge_BAO_Badge { } /** - * build badges parameters before actually creating badges. + * Build badges parameters before actually creating badges. * * @param array $params associated array of submitted values * @param CRM_Core_Form $form diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 96568a01cc..1cb5d6744c 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -35,7 +35,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -64,7 +64,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 * @param boolean $is_active value we want to set the is_active field @@ -79,7 +79,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * add a name label + * Add a name label * * @param array $params reference array contains the values submitted by the form * @@ -121,7 +121,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * delete name labels + * Delete name labels * * @param int $printLabelId ID of the name label to be deleted. * @@ -153,7 +153,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * build layout structure + * Build layout structure * * @param array $params associated array of submitted values * @@ -171,7 +171,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { } /** - * decode encoded data and return as an array + * Decode encoded data and return as an array * * @param json $jsonData json object * diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index fd91a72b3c..690eb515bc 100644 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -120,7 +120,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * generate batch name + * Generate batch name * * @return batch name * @static @@ -132,7 +132,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * create entity batch entry + * Create entity batch entry * @param array $params associated array * @return batch array * @access public @@ -157,7 +157,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * delete batch entry + * Delete batch entry * * @param int $batchId batch id * @@ -410,7 +410,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * define action links + * Define action links * * @param null $context * @@ -490,7 +490,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * get batch list + * Get batch list * * @return array array of all batches * excluding batches with data entry in progress @@ -625,12 +625,12 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { } /** - * Function to retrieve financial items assigned for a batch + * Retrieve financial items assigned for a batch * * @param int $entityID * @param array $returnValues * @param null $notPresent - * @param null $params + * @param array $params * @param bool $getCount * * @return Object @@ -763,7 +763,7 @@ WHERE {$where} } /** - * function to get batch names + * Get batch names * @param string $batchIds * * @return array array of batches diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index fd7ce29790..cb28ba4857 100644 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -39,7 +39,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** - * maximum profile fields that will be displayed + * Maximum profile fields that will be displayed * */ protected $_rowCount = 1; @@ -55,7 +55,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { protected $_batchInfo = array(); /** - * store the profile id associated with the batch type + * Store the profile id associated with the batch type */ protected $_profileId; @@ -67,7 +67,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; @@ -86,7 +86,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { */ public $_fields = array(); /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -234,7 +234,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * form validations + * Form validations * * @param array $params posted values of the form * @param array $files list of errors to be posted back to the form @@ -336,7 +336,7 @@ class CRM_Batch_Form_Entry 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 * * @access public * @@ -372,7 +372,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * process contribution records + * Process contribution records * * @param array $params associated array of submitted values * @@ -516,7 +516,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * process membership records + * Process membership records * * @param array $params associated array of submitted values * @@ -758,7 +758,7 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * update contact information + * Update contact information * * @param array $value associated array of submitted values * diff --git a/CRM/Batch/Page/Batch.php b/CRM/Batch/Page/Batch.php index 745ee6786a..175e1e4f75 100644 --- a/CRM/Batch/Page/Batch.php +++ b/CRM/Batch/Page/Batch.php @@ -92,7 +92,7 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { } /** - * browse all entities. + * Browse all entities. * * @return void * @access public diff --git a/CRM/Bridge/OG/CiviCRM.php b/CRM/Bridge/OG/CiviCRM.php index 384780bd93..663d27993e 100644 --- a/CRM/Bridge/OG/CiviCRM.php +++ b/CRM/Bridge/OG/CiviCRM.php @@ -35,7 +35,7 @@ class CRM_Bridge_OG_CiviCRM { /** - * @param $groupID + * @param int $groupID * @param $group * @param $op */ @@ -49,7 +49,7 @@ class CRM_Bridge_OG_CiviCRM { } /** - * @param $groupID + * @param int $groupID * @param $group */ static function groupAdd($groupID, $group) { @@ -83,7 +83,7 @@ class CRM_Bridge_OG_CiviCRM { } /** - * @param $groupID + * @param int $groupID * @param $group */ static function groupDelete($groupID, $group) { @@ -96,7 +96,7 @@ class CRM_Bridge_OG_CiviCRM { } /** - * @param $groupID + * @param int $groupID * @param $contactIDs * @param $op */ diff --git a/CRM/Bridge/OG/Drupal.php b/CRM/Bridge/OG/Drupal.php index e93358e7f4..87ee7cd875 100644 --- a/CRM/Bridge/OG/Drupal.php +++ b/CRM/Bridge/OG/Drupal.php @@ -98,7 +98,7 @@ class CRM_Bridge_OG_Drupal { } /** - * @param $aclParams + * @param array $aclParams * @param $op */ static function updateCiviACLTables($aclParams, $op) { diff --git a/CRM/Bridge/OG/Utils.php b/CRM/Bridge/OG/Utils.php index 724dddb754..fc7b6636a2 100644 --- a/CRM/Bridge/OG/Utils.php +++ b/CRM/Bridge/OG/Utils.php @@ -55,7 +55,7 @@ class CRM_Bridge_OG_Utils { } /** - * @param $ogID + * @param int $ogID * * @return string */ @@ -64,7 +64,7 @@ class CRM_Bridge_OG_Utils { } /** - * @param $ogID + * @param int $ogID * * @return string */ @@ -73,7 +73,7 @@ class CRM_Bridge_OG_Utils { } /** - * @param $groupID + * @param int $groupID * @param bool $abort * * @return int|null|string @@ -98,7 +98,7 @@ class CRM_Bridge_OG_Utils { } /** - * @param $ufID + * @param int $ufID * * @return int * @throws Exception diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index de723c7f16..0cc2def094 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 @@ -99,7 +99,7 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { } /** - * delete the campaign + * Delete the campaign * * @param int $id id of the campaign * @@ -308,7 +308,7 @@ Order By camp.title"; } /** - * retrieve campaigns for dashboard. + * Retrieve campaigns for dashboard. * * @static */ @@ -465,7 +465,7 @@ SELECT campaign.id as id, } /** - * get Campaigns groups + * Get Campaigns groups * * @param int $campaignId campaign id * @@ -499,7 +499,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 * @param boolean $is_active value we want to set the is_active field @@ -536,7 +536,7 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) */ /** * @param CRM_Core_Form $form - * @param null $connectedCampaignId + * @param int $connectedCampaignId */ public static function addCampaign(&$form, $connectedCampaignId = NULL) { //some forms do set default and freeze. diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index e39de126c7..3f6a46ec48 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -43,7 +43,7 @@ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey { } /** - * get Petition Details for dashboard. + * Get Petition Details for dashboard. * * @static */ @@ -171,7 +171,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 * @@ -229,9 +229,9 @@ SELECT petition.id as id, } /** - * @param $activity_id - * @param $contact_id - * @param $petition_id + * @param int $activity_id + * @param int $contact_id + * @param int $petition_id * * @return bool */ @@ -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 * @@ -322,7 +322,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * get Petition Signature Total + * Get Petition Signature Total * * @param int $surveyId * @@ -352,7 +352,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** - * @param null $surveyId + * @param int $surveyId * * @return array */ @@ -383,7 +383,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Function to get Petition Signature Details + * Get Petition Signature Details * * @param int $surveyId * @param int $status_id @@ -481,7 +481,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } /** - * Function to check if contact has signed this petition + * Check if contact has signed this petition * * @param int $surveyId * @param int $contactId @@ -534,7 +534,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 52b749221e..e9e6c9f5e7 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -41,7 +41,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 * @static @@ -65,7 +65,7 @@ class CRM_Campaign_BAO_Query { } /** - * if survey, campaign are involved, add the specific fields. + * If survey, campaign are involved, add the specific fields. * * @param $query * @@ -215,7 +215,7 @@ class CRM_Campaign_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -312,7 +312,7 @@ civicrm_activity_assignment.record_type_id = $assigneeID ) "; /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} @@ -335,7 +335,7 @@ civicrm_activity_assignment.record_type_id = $assigneeID ) "; } /** - * add all the elements shared between, + * Add all the elements shared between, * normal voter search and voter listing (GOTV form) * * @access public diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index d02814d09d..4fb907220f 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -71,7 +71,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. @@ -117,7 +117,7 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { } /** - * retrieve surveys for dashboard. + * Retrieve surveys for dashboard. * * @static */ @@ -242,7 +242,7 @@ SELECT survey.id as id, } /** - * get Surveys + * Get Surveys * * @param boolean $onlyActive retrieve only active surveys. * @param boolean $onlyDefault retrieve only default survey. @@ -299,7 +299,7 @@ SELECT survey.id as id, } /** - * get Surveys activity types + * Get Surveys activity types * * * @static @@ -334,7 +334,7 @@ SELECT survey.id as id, } /** - * Function to get Surveys custom groups + * Get Surveys custom groups * * @param $surveyTypes array an array of survey type id. * @@ -374,7 +374,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 * @param boolean $is_active value we want to set the is_active field @@ -387,7 +387,7 @@ SELECT survey.id as id, } /** - * Function to delete the survey + * Delete the survey * * @param int $id survey id * @@ -505,7 +505,7 @@ Group By contact.id"; * @param int $surveyId survey id. * @param array $voterIds voterIds. * - * @param null $interviewerId + * @param int $interviewerId * @param array $statusIds * * @return array $activityDetails array of survey activity.@static @@ -565,7 +565,7 @@ INNER JOIN civicrm_activity_contact activityAssignment * * @param int $surveyId survey id. * - * @param null $interviewerId + * @param int $interviewerId * @param null $statusIds * @param null $voterIds * @param bool $onlyCount @@ -768,7 +768,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function return all voter links with respecting permissions * - * @param $surveyId + * @param int $surveyId * @param bool $enclosedInUL * @param string $extraULName * @return array|string $url array of permissioned links@static @@ -854,7 +854,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * Function to retrieve survey associated profile id. + * Retrieve survey associated profile id. * */ public static function getSurveyProfileId($surveyId) { @@ -885,7 +885,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * @param $surveyId + * @param int $surveyId * * @return mixed */ @@ -901,7 +901,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * Function to decides the contact type for given survey. + * Decides the contact type for given survey. * */ public static function getSurveyContactType($surveyId) { @@ -920,7 +920,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a } /** - * Function to get survey supportable profile types + * Get survey supportable profile types * */ public static function surveyProfileTypes() { diff --git a/CRM/Campaign/Controller/Search.php b/CRM/Campaign/Controller/Search.php index 56e6221b46..88cbf16076 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Campaign/Form/Campaign.php b/CRM/Campaign/Form/Campaign.php index 55127b05b9..601be13326 100644 --- a/CRM/Campaign/Form/Campaign.php +++ b/CRM/Campaign/Form/Campaign.php @@ -40,28 +40,28 @@ class CRM_Campaign_Form_Campaign extends CRM_Core_Form { /** - * action + * Action * * @var int */ protected $_action; /** - * context + * Context * * @var string */ protected $_context; /** - * object values. + * Object values. * * @var array */ protected $_values; /** - * the id of the campaign we are proceessing + * The id of the campaign we are proceessing * * @var int * @protected diff --git a/CRM/Campaign/Form/Gotv.php b/CRM/Campaign/Form/Gotv.php index 01efe23174..5198c9dad1 100755 --- a/CRM/Campaign/Form/Gotv.php +++ b/CRM/Campaign/Form/Gotv.php @@ -51,7 +51,7 @@ class CRM_Campaign_Form_Gotv extends CRM_Core_Form { protected $_searchVoterFor; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index 4850ae9f5e..d651213496 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -253,7 +253,7 @@ class CRM_Campaign_Form_Petition extends CRM_Core_Form { } /** - * global validation rules for the form + * Global validation rules for the form * */ static function formRule($fields, $files, $form) { diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index 1a31f7993f..8936905ede 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -43,7 +43,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_mode; /** - * the id of the contact associated with this signature + * The id of the contact associated with this signature * * @var int * @public @@ -72,7 +72,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_contactProfileId; /** - * the contact profile fields used for this petition + * The contact profile fields used for this petition * * @var array */ @@ -86,14 +86,14 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_activityProfileId; /** - * the activity profile fields used for this petition + * The activity profile fields used for this petition * * @var array */ public $_activityProfileFields; /** - * the id of the survey (petition) we are proceessing + * The id of the survey (petition) we are proceessing * * @var int * @protected @@ -108,7 +108,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_tagId; /** - * values to use for custom profiles + * Values to use for custom profiles * * @var array * @protected @@ -124,7 +124,7 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_params; /** - * which email send mode do we use + * Which email send mode do we use * * @var int * EMAIL_THANK = 1, @@ -589,10 +589,10 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } /** - * build the petition profile form + * Build the petition profile form * - * @param $id - * @param $name + * @param int $id + * @param string $name * @param bool $viewOnly * * @return void diff --git a/CRM/Campaign/Form/Search.php b/CRM/Campaign/Form/Search.php index 4ad3914d63..db43e970eb 100755 --- a/CRM/Campaign/Form/Search.php +++ b/CRM/Campaign/Form/Search.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -55,7 +55,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -65,7 +65,7 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = "survey_"; @@ -74,7 +74,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 * @access public diff --git a/CRM/Campaign/Form/Search/Campaign.php b/CRM/Campaign/Form/Search/Campaign.php index b667937248..b86df5830b 100755 --- a/CRM/Campaign/Form/Search/Campaign.php +++ b/CRM/Campaign/Form/Search/Campaign.php @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { protected $_force; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Campaign/Form/Search/Petition.php b/CRM/Campaign/Form/Search/Petition.php index a9e906d6df..abbeafdc5e 100755 --- a/CRM/Campaign/Form/Search/Petition.php +++ b/CRM/Campaign/Form/Search/Petition.php @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { protected $_force; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Campaign/Form/Search/Survey.php b/CRM/Campaign/Form/Search/Survey.php index 6a9e0549f5..6e9c90d932 100755 --- a/CRM/Campaign/Form/Search/Survey.php +++ b/CRM/Campaign/Form/Search/Survey.php @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { protected $_force; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Campaign/Form/Survey.php b/CRM/Campaign/Form/Survey.php index f9c5b3f7ed..d1ea1387f9 100644 --- a/CRM/Campaign/Form/Survey.php +++ b/CRM/Campaign/Form/Survey.php @@ -47,14 +47,14 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { protected $_surveyId; /** - * action + * Action * * @var int */ protected $_action; /** - * surveyTitle + * SurveyTitle * * @var string */ diff --git a/CRM/Campaign/Form/Survey/Delete.php b/CRM/Campaign/Form/Survey/Delete.php index 308d3207b2..afd99c5f97 100644 --- a/CRM/Campaign/Form/Survey/Delete.php +++ b/CRM/Campaign/Form/Survey/Delete.php @@ -46,7 +46,7 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { protected $_surveyId; /** - * surveyTitle + * SurveyTitle * * @var string */ @@ -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 * @access public diff --git a/CRM/Campaign/Form/Survey/Main.php b/CRM/Campaign/Form/Survey/Main.php index 2b3b2aac13..dbb17bbae2 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 */ diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index 9498a2c150..0980ddf94e 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -201,7 +201,7 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * global validation rules for the form + * Global validation rules for the form * */ static function formRule($fields, $files, $form) { diff --git a/CRM/Campaign/Form/SurveyType.php b/CRM/Campaign/Form/SurveyType.php index d3f7d7fe8b..f24c6d646a 100644 --- a/CRM/Campaign/Form/SurveyType.php +++ b/CRM/Campaign/Form/SurveyType.php @@ -49,21 +49,21 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { protected $_gName; /** - * id + * Id * * @var int */ protected $_id; /** - * action + * Action * * @var int */ protected $_action; /** - * set variables up before form is built + * Set variables up before form is built * * @param null * diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index fabfb659f0..6178eecc77 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/Form/Task.php @@ -47,7 +47,7 @@ class CRM_Campaign_Form_Task extends CRM_Core_Form { protected $_componentClause = NULL; /** - * the task being performed + * The task being performed * * @var int */ @@ -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 title of the main button diff --git a/CRM/Campaign/Form/Task/Interview.php b/CRM/Campaign/Form/Task/Interview.php index cb3aab81c6..b0721677df 100755 --- a/CRM/Campaign/Form/Task/Interview.php +++ b/CRM/Campaign/Form/Task/Interview.php @@ -39,14 +39,14 @@ class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_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 * */ private $_userContext; @@ -70,7 +70,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 * @access public @@ -444,7 +444,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 * * @access public * diff --git a/CRM/Campaign/Form/Task/Print.php b/CRM/Campaign/Form/Task/Print.php index bfac70043c..e7a55ed4df 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 * @access public @@ -104,7 +104,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 * * @access public * diff --git a/CRM/Campaign/Form/Task/Release.php b/CRM/Campaign/Form/Task/Release.php index 1d946f479b..30564faac6 100644 --- a/CRM/Campaign/Form/Task/Release.php +++ b/CRM/Campaign/Form/Task/Release.php @@ -40,21 +40,21 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { /** - * survet id + * Survet id * * @var int */ protected $_surveyId; /** - * number of voters + * Number of voters * * @var int */ protected $_interviewerId; /** - * survey details + * Survey details * * @var object */ @@ -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 * @access public diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index f56416c21e..983fcce8a2 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -40,35 +40,35 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** - * survet id` + * Survet id` * * @var int */ protected $_surveyId; /** - * interviewer id + * Interviewer id * * @var int */ protected $_interviewerId; /** - * survey details + * Survey details * * @var object */ protected $_surveyDetails; /** - * number of voters + * Number of voters * * @var int */ protected $_numVoters; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -201,7 +201,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 * * @access public * diff --git a/CRM/Campaign/Form/Task/Result.php b/CRM/Campaign/Form/Task/Result.php index 9422aad75e..554240cf4f 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 * @access public diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index dd4c5cf785..0e13d6c152 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -94,8 +94,8 @@ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { * @param int $subscribe_id The id of the subscription event * @param string $hash The hash * - * @param $activity_id - * @param $petition_id + * @param int $activity_id + * @param int $petition_id * * @return boolean True on success * @access public diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index f5fdd4e218..40ef224659 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -207,7 +207,7 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { } /** - * 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 6bbab7eb3e..c10baf845a 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -82,7 +82,7 @@ class CRM_Campaign_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 * * @access protected * @var boolean @@ -90,7 +90,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -98,7 +98,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -106,7 +106,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM 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 @@ -115,7 +115,7 @@ 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 * @access protected @@ -195,7 +195,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -229,7 +229,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 enum $action the action being performed * @param int $offset the row number to start from @@ -316,7 +316,7 @@ FROM {$from} } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -368,7 +368,7 @@ FROM {$from} } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index 180f984151..e3ad4e5e32 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -91,7 +91,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 * @access public diff --git a/CRM/Campaign/Task.php b/CRM/Campaign/Task.php index 77eab97b3a..592721de50 100755 --- a/CRM/Campaign/Task.php +++ b/CRM/Campaign/Task.php @@ -43,7 +43,7 @@ class CRM_Campaign_Task { CONST INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4; /** - * the task array + * The task array * * @var array * @static @@ -51,7 +51,7 @@ class CRM_Campaign_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -124,7 +124,7 @@ class CRM_Campaign_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Case/Audit/Audit.php b/CRM/Case/Audit/Audit.php index e2b6685a8e..37c4becffc 100644 --- a/CRM/Case/Audit/Audit.php +++ b/CRM/Case/Audit/Audit.php @@ -9,7 +9,7 @@ class CRM_Case_Audit_Audit { /** * @param $xmlString - * @param $confFilename + * @param string $confFilename */ public function __construct($xmlString, $confFilename) { $this->xmlString = $xmlString; @@ -211,8 +211,8 @@ class CRM_Case_Audit_Audit { /** * @param $xmlString - * @param $clientID - * @param $caseID + * @param int $clientID + * @param int $caseID * @param bool $printReport * * @return mixed diff --git a/CRM/Case/Audit/AuditConfig.php b/CRM/Case/Audit/AuditConfig.php index 57b791e18c..f611e8a205 100644 --- a/CRM/Case/Audit/AuditConfig.php +++ b/CRM/Case/Audit/AuditConfig.php @@ -14,7 +14,7 @@ class CRM_Case_Audit_AuditConfig { private $ifBlanks; /** - * @param $filename + * @param string $filename */ public function __construct($filename) { $this->filename = $filename; diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 8ffb08a019..d146cffc3c 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -40,7 +40,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** - * static field for all the case information that we can potentially export + * Static field for all the case information that we can potentially export * * @var array * @static @@ -55,7 +55,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * takes an associative array and creates a case object + * Takes an associative array and creates a case object * * the function extract all the params it needs to initialize the create a * case object. the params array could contain additional unused name/value @@ -99,7 +99,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * takes an associative array and creates a case object + * Takes an associative array and creates a case object * * @param array $params (reference ) an assoc array of name/value pairs * @@ -257,7 +257,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * process case activity add/delete + * Process case activity add/delete * takes an associative array and * * @param array $params (reference ) an assoc array of name/value pairs @@ -275,7 +275,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * get the case subject for Activity + * Get the case subject for Activity * * @param int $activityId activity id * @@ -293,7 +293,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * get the case type. + * Get the case type. * * @param int $caseId * @@ -371,7 +371,7 @@ WHERE civicrm_case.id = %1"; } /** - * Function to enable disable case related relationships + * Enable disable case related relationships * * @param int $caseId case id * @param boolean $enable action @@ -416,7 +416,7 @@ WHERE civicrm_case.id = %1"; * * @param int $caseId ID of the case * - * @param null $contactID + * @param int $contactID * * @return array * @access public @@ -440,7 +440,7 @@ WHERE civicrm_case.id = %1"; /** * Look up a case using an activity ID * - * @param $activityId + * @param int $activityId * * @return int, case ID */ @@ -507,7 +507,7 @@ WHERE civicrm_case.id = %1"; /** * Retrieve case_id by contact_id * - * @param $contactID + * @param int $contactID * @param boolean $includeDeleted include the deleted cases in result * @param null $caseType * @@ -547,7 +547,7 @@ WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'"; /** * @param string $type - * @param null $userID + * @param int $userID * @param null $condition * @param int $isDeleted * @@ -879,7 +879,11 @@ AND civicrm_case.status_id != $closedId"; } /** - * Function to get the summary of cases counts by type and status. + * Get the summary of cases counts by type and status. + * + * @param bool $allCases + * @param int $userID + * @return array */ static function getCasesSummary($allCases = TRUE, $userID) { $caseSummary = array(); @@ -954,13 +958,13 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to get Case roles + * Get Case roles * * @param int $contactID contact id * @param int $caseID case id - * @param null $relationshipID + * @param int $relationshipID * - * @return returns case role / relationships + * @return array case role / relationships * * @static */ @@ -1011,17 +1015,17 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to get Case Activities + * Get Case Activities * * @param int $caseID case id * @param array $params posted params * @param int $contactID contact id * * @param null $context - * @param null $userID + * @param int $userID * @param null $type * - * @return returns case activities + * @return array of case activities * * @static */ @@ -1356,7 +1360,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to get Case Related Contacts + * Get Case Related Contacts * * @param int $caseID case id * @param boolean $skipDetails if true include details of contacts @@ -1403,14 +1407,14 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function that sends e-mail copy of activity + * Send e-mail copy of activity * - * @param $clientId + * @param int $clientId * @param int $activityId activity Id * @param array $contacts array of related contact * * @param null $attachments - * @param $caseId + * @param int $caseId * * @return void * @access public @@ -1665,7 +1669,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to retrieve the scheduled activity type and date + * Retrieve the scheduled activity type and date * * @param array $cases Array of contact and case id * @@ -1709,7 +1713,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * 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 * @access public @@ -1808,11 +1812,9 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c return $globalContacts; } - /* - * Convenience function to get both case contacts and global in one array - */ /** - * @param $caseId + * Convenience function to get both case contacts and global in one array + * @param int $caseId * * @return array */ @@ -1836,7 +1838,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to get Case ActivitiesDueDates with given criteria. + * Get Case ActivitiesDueDates with given criteria. * * @param int $caseID case id * @param array $criteriaParams given criteria @@ -1887,12 +1889,12 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to create activities when Case or Other roles assigned/modified/deleted. + * Create activities when Case or Other roles assigned/modified/deleted. * - * @param $caseId + * @param int $caseId * @param int $relationshipId relationship id * @param int $relContactId case role assignee contactId. - * @param null $contactId + * @param int $contactId * * @return void on success creates activity and case activity * @@ -1980,7 +1982,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Function to get case manger + * Get case manger * contact which is assigned a case role of case manager. * * @param int $caseType case type @@ -2111,7 +2113,7 @@ SELECT civicrm_contact.id as casemanager_id, } /** - * @param null $contactId + * @param int $contactId * @param bool $excludeDeleted * * @return null|string @@ -3029,7 +3031,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * since we drop 'access CiviCase', allow access + * Since we drop 'access CiviCase', allow access * if user has 'access my cases and activities' * or 'access all cases and activities' */ @@ -3056,7 +3058,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to check whether activity is a case Activity + * Check whether activity is a case Activity * * @param int $activityID activity id * @@ -3076,7 +3078,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to get all the case type ids currently in use + * Get all the case type ids currently in use * * * @return array $caseTypeIds @@ -3101,7 +3103,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to get all the case status ids currently in use + * Get all the case status ids currently in use * * * @return array $caseStatusIds @@ -3123,7 +3125,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to get all the encounter medium ids currently in use + * Get all the encounter medium ids currently in use * @return array */ static function getUsedEncounterMediums() { @@ -3143,9 +3145,9 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to check case configuration. + * Check case configuration. * - * @param null $contactId + * @param int $contactId * * @return array $configured */ @@ -3227,7 +3229,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * helper function, also used by the upgrade in case of error + * Helper function, also used by the upgrade in case of error */ static function createCaseViewsQuery($section = 'upcoming') { $sql = ""; @@ -3256,7 +3258,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to add/copy relationships, when new client is added for a case + * Add/copy relationships, when new client is added for a case * * @param int $caseId case id * @param int $contactId contact id / new client id @@ -3296,7 +3298,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Function to get the list of clients for a case + * Get the list of clients for a case * * @param int $caseId * diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index d5bf0e1c94..8b1078ee2e 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -40,7 +40,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** - * static field for all the case information that we can potentially export + * Static field for all the case information that we can potentially export * * @var array * @static @@ -98,7 +98,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** - * format / convert submitted array to xml for case type definition + * Format / convert submitted array to xml for case type definition * * @param string $name * @param array $definition the case-type defintion expressed as an array-tree @@ -179,7 +179,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * get the case definition either from db or read from xml file + * Get the case definition either from db or read from xml file * * @param SimpleXmlElement $xml a single case-type record * @@ -262,7 +262,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * takes an associative array and creates a case type object + * Takes an associative array and creates a case type object * * @param array $params (reference ) an assoc array of name/value pairs * @@ -319,7 +319,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * @param $caseTypeId + * @param int $caseTypeId * * @throws CRM_Core_Exception * @return mixed diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index 882121d0ba..65bbb9bc53 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 * @@ -244,7 +244,7 @@ class CRM_Case_BAO_Query { } /** - * where clause for a single field + * Where clause for a single field * * @param $values * @param $query @@ -530,7 +530,7 @@ class CRM_Case_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -604,7 +604,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -696,7 +696,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 * * @access public * @@ -773,7 +773,7 @@ case_relation_type.id = case_relationship.relationship_type_id )"; /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} } diff --git a/CRM/Case/Controller/Search.php b/CRM/Case/Controller/Search.php index b30893487d..00bb01b2f7 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 8f2a4f5006..2d27ce8112 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -355,7 +355,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -379,7 +379,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { * * @access public * - * @param null $params + * @param array $params * * @return void */ diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index dcf01b33d4..70a62711e7 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -102,7 +102,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index e82eced06e..d762b5f3f5 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -102,7 +102,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index ff41a8d343..3eed2d1536 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -99,7 +99,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index e86c14df18..f2ca19f725 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -91,7 +91,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 * diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index f7347a177d..f5e225e56c 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 * @public @@ -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 diff --git a/CRM/Case/Form/ActivityToCase.php b/CRM/Case/Form/ActivityToCase.php index 66672c9da7..2a5a04056f 100644 --- a/CRM/Case/Form/ActivityToCase.php +++ b/CRM/Case/Form/ActivityToCase.php @@ -40,7 +40,7 @@ class CRM_Case_Form_ActivityToCase 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 * @access public diff --git a/CRM/Case/Form/ActivityView.php b/CRM/Case/Form/ActivityView.php index 850a055947..f858849fca 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 * * @access public * diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index c9a8f4f9db..f0bd253471 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -62,27 +62,27 @@ class CRM_Case_Form_Case extends CRM_Core_Form { public $_activityTypeFile = NULL; /** - * logged in contact Id + * Logged in contact Id */ public $_currentUserId = NULL; /** - * activity type Id + * Activity type Id */ public $_activityTypeId = NULL; /** - * activity type Id + * Activity type Id */ public $_activityId = NULL; /** - * action + * Action */ public $_action; /** - * case type id + * Case type id */ public $_caseTypeId = NULL; @@ -312,7 +312,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 * diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php index 187d4576cf..7a2ca49d0b 100644 --- a/CRM/Case/Form/CaseView.php +++ b/CRM/Case/Form/CaseView.php @@ -39,13 +39,13 @@ */ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** - * check for merge cases. + * Check for merge cases. * @var bool */ private $_mergeCases = FALSE; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Case/Form/CustomData.php b/CRM/Case/Form/CustomData.php index 8187bf5b1d..3b9252175a 100644 --- a/CRM/Case/Form/CustomData.php +++ b/CRM/Case/Form/CustomData.php @@ -58,7 +58,7 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { protected $_cdType; /** - * entity sub type of the table id + * Entity sub type of the table id * * @var string * @access protected @@ -66,7 +66,7 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { protected $_subTypeID; /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for table name, id of entity in table, type of entity and stores them. * diff --git a/CRM/Case/Form/EditClient.php b/CRM/Case/Form/EditClient.php index c517a7f61a..6e63140d2a 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 * @access public diff --git a/CRM/Case/Form/Report.php b/CRM/Case/Form/Report.php index 09f518b766..2ef4de50bf 100644 --- a/CRM/Case/Form/Report.php +++ b/CRM/Case/Form/Report.php @@ -50,7 +50,7 @@ class CRM_Case_Form_Report extends CRM_Core_Form { public $_clientID = NULL; /** - * activity set name + * Activity set name */ public $_activitySetName = NULL; diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index a19c562228..0ce694bdb6 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -39,7 +39,7 @@ class CRM_Case_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 * @access protected @@ -47,7 +47,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -55,7 +55,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -63,7 +63,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { protected $_limit = NULL; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = 'case_'; @@ -71,7 +71,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 * @access public @@ -330,7 +330,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 * diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index 8c65d7d966..9ec52b3792 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -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 * @@ -150,7 +150,7 @@ class CRM_Case_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 title of the main button diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index aab4919a67..343b4d9723 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -56,7 +56,7 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { public $_moveToTrash = TRUE; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -80,7 +80,7 @@ class CRM_Case_Form_Task_Delete 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 * * @access public * diff --git a/CRM/Case/Form/Task/Print.php b/CRM/Case/Form/Task/Print.php index dfdbfff309..c197e786c0 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 * @access public @@ -96,7 +96,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 * * @access public * diff --git a/CRM/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index cdf161ab28..c370d9959b 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 * @access public @@ -69,7 +69,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 * * @access public * diff --git a/CRM/Case/Form/Task/Result.php b/CRM/Case/Form/Task/Result.php index aea40165a2..1ca203cd8e 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 * @access public diff --git a/CRM/Case/Form/Task/SearchTaskHookSample.php b/CRM/Case/Form/Task/SearchTaskHookSample.php index 5b11e1132f..1506264705 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 * @access public diff --git a/CRM/Case/Page/AJAX.php b/CRM/Case/Page/AJAX.php index b7f3b97710..30b5f08232 100644 --- a/CRM/Case/Page/AJAX.php +++ b/CRM/Case/Page/AJAX.php @@ -185,7 +185,7 @@ class CRM_Case_Page_AJAX { } /** - * delete relationships specific to case and relationship type + * Delete relationships specific to case and relationship type */ static function deleteCaseRoles() { $caseId = CRM_Utils_Type::escape($_POST['case_id'], 'Integer'); diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 1ee036bacf..904d43708f 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -40,21 +40,21 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { /** - * case statues + * Case statues * @var array * @static */ static $caseStatus = array(); /** - * redaction rules + * Redaction rules * @var array * @static */ static $redactionRule; /** - * case type + * Case type * @var array * @static */ @@ -68,7 +68,7 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { static $encounterMedium = array(); /** - * activity type + * Activity type * @var array * @static */ diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 724ae99f05..60d5494a10 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -78,7 +78,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { ); /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -86,7 +86,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -94,7 +94,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -102,7 +102,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { 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 @@ -111,7 +111,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { public $_queryParams; /** - * represent the type of selector + * Represent the type of selector * * @var int * @access protected @@ -247,7 +247,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -286,7 +286,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 enum $action the action being performed * @param int $offset the row number to start from @@ -421,7 +421,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -499,7 +499,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index f8a7bc10a5..9fc035e333 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -93,7 +93,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 * @access public diff --git a/CRM/Case/Task.php b/CRM/Case/Task.php index 919d827f8d..bb4aae3f46 100644 --- a/CRM/Case/Task.php +++ b/CRM/Case/Task.php @@ -42,7 +42,7 @@ class CRM_Case_Task { CONST DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4; /** - * the task array + * The task array * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Case_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -132,7 +132,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 diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index 8c7b5fb10c..2588e21c2a 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -202,7 +202,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { } /** - * @param $relationshipTypeName + * @param string $relationshipTypeName * @param array $params * * @return bool diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 872dbf6914..2105db5072 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -47,9 +47,9 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { public function __construct() {} /** - * @param $clientID - * @param $caseID - * @param $activitySetName + * @param int $clientID + * @param int $caseID + * @param string $activitySetName * @param array $params * * @return mixed @@ -89,8 +89,8 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { } /** - * @param $clientID - * @param $caseID + * @param int $clientID + * @param int $caseID * * @return array */ @@ -148,7 +148,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { /** * @param $xml - * @param $activitySetName + * @param string $activitySetName * * @return array|bool */ @@ -176,7 +176,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { /** * @param $xml - * @param $activitySetName + * @param string $activitySetName * * @return null|string */ @@ -192,8 +192,8 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { } /** - * @param $clientID - * @param $caseID + * @param int $clientID + * @param int $caseID * @param $activityTypes * @param $activities */ @@ -236,8 +236,8 @@ AND ac.case_id = %1 } /** - * @param $clientID - * @param $activityID + * @param int $clientID + * @param int $activityID * @param bool $anyActivity * @param int $redact * @@ -305,7 +305,7 @@ WHERE a.id = %1 } /** - * @param $clientID + * @param int $clientID * @param $activityDAO * @param $activityTypeInfo * @@ -534,7 +534,7 @@ WHERE a.id = %1 } /** - * @param $clientID + * @param int $clientID * @param $activityDAO * @param $activityTypeInfo * @@ -594,7 +594,7 @@ WHERE a.id = %1 } /** - * @param $activityTypeID + * @param int $activityTypeID * @param null $dateFormat * * @return mixed @@ -696,7 +696,7 @@ WHERE entity_id = %1 } /** - * @param $activityID + * @param int $activityID * * @return null|string */ @@ -734,9 +734,9 @@ LIMIT 1 } /** - * @param $clientID - * @param $caseID - * @param $activitySetName + * @param int $clientID + * @param int $caseID + * @param string $activitySetName * @param array $params * @param CRM_Core_Form $form * diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 998a9ab1b8..0ced7cfa72 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -60,21 +60,21 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { END"; /** - * the types of communication preferences + * The types of communication preferences * * @var array */ static $_commPrefs = array('do_not_phone', 'do_not_email', 'do_not_mail', 'do_not_sms', 'do_not_trade'); /** - * types of greetings + * Types of greetings * * @var array */ static $_greetingTypes = array('addressee', 'email_greeting', 'postal_greeting'); /** - * 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 @@ -82,7 +82,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { 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 * @static @@ -90,7 +90,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { static $_exportableFields = NULL; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Contact_DAO_Contact @@ -103,7 +103,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { } /** - * 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 @@ -261,7 +261,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { } /** - * create contact + * Create contact * takes an associative array and creates a contact object and all the associated * derived objects (i.e. individual, location, email, phone etc) * @@ -730,7 +730,7 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * get the display name of a contact + * Get the display name of a contact * * @param int $id id of the contact * @@ -878,7 +878,7 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * delete the image of a contact + * Delete the image of a contact * * @param int $id id of the contact * @@ -934,7 +934,7 @@ WHERE id={$id}; "; } /** - * function to return proportional height and width of the image + * Return proportional height and width of the image * * @param Integer $imageWidth width of image * @@ -1006,7 +1006,7 @@ WHERE id={$id}; "; } /** - * function to extract contact id from url for deleting contact image + * Extract contact id from url for deleting contact image */ public static function processImage() { @@ -1135,7 +1135,7 @@ WHERE id={$id}; "; } /** - * 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 @@ -1330,7 +1330,7 @@ WHERE id={$id}; "; } /** - * combine all the exportable fields from the lower levels object + * Combine all the exportable fields from the lower levels object * * currentlty we are using importable fields as exportable fields * @@ -1569,7 +1569,7 @@ WHERE id={$id}; "; } /** - * Function to get the all contact details(Hierarchical) + * Get the all contact details(Hierarchical) * * @param int $contactId contact id * @param array $fields fields array @@ -1595,7 +1595,7 @@ WHERE id={$id}; "; } /** - * given a set of flat profile style field names, create a hierarchy + * Given a set of flat profile style field names, create a hierarchy * for query to use and crete the right sql * * @param $fields @@ -1662,13 +1662,13 @@ WHERE id={$id}; "; } /** - * Function to return the primary location type of a contact + * Return the primary location type of a contact * * $params int $contactId contact_id * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null * - * @param $contactId + * @param int $contactId * @param bool $skipDefaultPriamry * @param null $block * @@ -1731,7 +1731,7 @@ WHERE civicrm_contact.id = %1 "; } /** - * function to get the display name, primary email and location type of a contact + * Get the display name, primary email and location type of a contact * * @param int $id id of the contact * @@ -1775,7 +1775,7 @@ ORDER BY civicrm_email.is_primary DESC"; } /** - * function to add/edit/register contacts through profile. + * Add/edit/register contacts through profile. * * @param array $params Array of profile fields to be edited/added. * @param array $fields Array of fields from UFGroup @@ -1884,8 +1884,8 @@ ORDER BY civicrm_email.is_primary DESC"; /** * @param array $params * @param $fields - * @param null $contactID - * @param null $ufGroupId + * @param int $contactID + * @param int $ufGroupId * @param null $ctype * @param bool $skipCustom * @@ -2248,7 +2248,7 @@ ORDER BY civicrm_email.is_primary DESC"; } /** - * Function to find the get contact details + * Find the get contact details * does not respect ACLs for now, which might need to be rectified at some * stage based on how its used * @@ -2302,7 +2302,7 @@ WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0"; } /** - * Function to find the contact details associated with an OpenID + * Find the contact details associated with an OpenID * * @param string $openId openId of the contact * @param string $ctype contact type @@ -2558,7 +2558,7 @@ AND civicrm_openid.is_primary = 1"; } /** - * Function to process greetings and cache + * Process greetings and cache * * @param object $contact contact object after save * @param boolean $useDefaults use default greeting values @@ -2709,7 +2709,7 @@ AND civicrm_openid.is_primary = 1"; } /** - * Function to retrieve loc block ids w/ given condition. + * Retrieve loc block ids w/ given condition. * * @param int $contactId contact id. * @param array $criteria key => value pair which should be @@ -2761,9 +2761,9 @@ AND civicrm_openid.is_primary = 1"; } /** - * Function to build context menu items. + * Build context menu items. * - * @param null $contactId + * @param int $contactId * * @return array of context menu for logged in user. * @static @@ -3021,7 +3021,7 @@ AND civicrm_openid.is_primary = 1"; } /** - * Function to retrieve display name of contact that address is shared + * Retrieve display name of contact that address is shared * based on $masterAddressId or $contactId . * * @param int $masterAddressId master id. @@ -3058,7 +3058,7 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) /** * Get the creation/modification times for a contact * - * @param $contactId + * @param int $contactId * * @return array('created_date' => $, 'modified_date' => $) */ @@ -3193,7 +3193,7 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) } /** - * Function to check if contact is being used in civicrm_domain + * Check if contact is being used in civicrm_domain * based on $contactId * * @param int $contactId contact id. diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index e7e6d38bff..41f8b27c3a 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -35,12 +35,12 @@ class CRM_Contact_BAO_Contact_Location { /** - * get the display name, primary email, location type and location id of a contact + * Get the display name, primary email, location type and location id of a contact * * @param int $id id of the contact * * @param bool $isPrimary - * @param null $locationTypeID + * @param int $locationTypeID * * @return array of display_name, email, location type and location id if found, or (null,null,null, null) * @static @@ -76,7 +76,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 * @@ -114,12 +114,12 @@ 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 * $param int $locationTypeID * - * @param null $locationTypeID + * @param int $locationTypeID * @param bool $imageUrlOnly * * @return null|string display name of the contact if found diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index fa36c3fe7a..b014b19ddb 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 * @param int|string $type the type of operation (view|edit) @@ -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) @@ -149,7 +149,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 contact id @@ -190,7 +190,7 @@ AND $operationClause LIMIT 1"; /** * @param string $contactAlias - * @param null $contactID + * @param int $contactID * * @return array */ @@ -240,7 +240,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 * @param int $contactID contact id of the current contact @@ -331,7 +331,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR /** - * @param $contactID + * @param int $contactID * @param CRM_Core_Form $form * @param bool $redirect * @@ -385,7 +385,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR } /** - * @param $contactID + * @param int $contactID * @param CRM_Core_Form $form * @param bool $redirect * diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 13c649ff48..93b69aebdf 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_Contact_Utils { /** - * given a contact type, get the contact image + * Given a contact type, get the contact image * * @param string $contactType contact type * @param boolean $urlOnly if we need to return only image url @@ -112,7 +112,7 @@ class CRM_Contact_BAO_Contact_Utils { } /** - * function check for mix contact ids(individual+household etc...) + * Function check for mix contact ids(individual+household etc...) * * @param array $contactIds array of contact ids * @@ -246,7 +246,7 @@ WHERE id IN ( $idString ) } /** - * get the count of contact loctions + * Get the count of contact loctions * * @param int $contactId contact id * @@ -350,14 +350,14 @@ UNION } /** - * create related memberships for current employer + * Create related memberships for current employer * * @param int $contactID contact id of the individual * @param int $employerID contact id of the organization. * @param array $relationshipParams relationship params. * @param boolean $duplicate are we triggered existing relationship. * - * @param null $previousEmpID + * @param int $previousEmpID * * @throws CiviCRM_API3_Exception * @access public @@ -390,7 +390,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 * @@ -408,7 +408,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 * @@ -422,7 +422,7 @@ WHERE contact_a.employer_id=contact_b.id AND contact_b.id={$organizationId}; "; } /** - * Function to clear cached current employer name + * Clear cached current employer name * * @param int $contactId contact id ( mostly individual contact id) * @param int $employerId contact id ( mostly organization contact id) @@ -468,12 +468,12 @@ WHERE id={$contactId}; "; } /** - * Function to build form for related contacts / on behalf of organization. + * Build form for related contacts / on behalf of organization. * * @param CRM_Core_Form $form * @param $contactType string contact type - * @param $countryID - * @param $stateID + * @param int $countryID + * @param int $stateID * @param $title string fieldset title * * @static @@ -543,7 +543,7 @@ WHERE id={$contactId}; "; } /** - * Function to clear cache employer name and employer id + * Clear cache employer name and employer id * of all employee when employer get deleted. * * @param int $employerId contact id of employer ( organization id ) @@ -669,7 +669,7 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) * This function retrieve component related contact information. * * @param array $componentIds array of component Ids. - * @param $componentName + * @param string $componentName * @param array $returnProperties array of return elements. * * @return array $contactDetails array of contact info.@static @@ -844,7 +844,7 @@ Group By componentId"; } /** - * Function to 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 * @@ -1094,8 +1094,8 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; * @param string $templateString the greeting template string with contact tokens + Smarty syntax * * @param $contactDetails - * @param $contactID - * @param $className + * @param int $contactID + * @param string $className * * @return void * @static diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 124fa0b65e..02cf1165df 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -440,7 +440,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. * @param bool $ignoreCache @@ -453,7 +453,7 @@ AND ( p.is_active = 1 OR p.id IS NULL ) } /** - * retrieve the basic contact type associated with given subType. + * Retrieve the basic contact type associated with given subType. * *@param array/string $subType contact subType. *@return array/string of basicTypes. @@ -508,7 +508,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * verify if a given subtype is associated with a given basic contact type. + * Verify if a given subtype is associated with a given basic contact type. * * @param string $subType contact subType * @param string $contactType contact Type @@ -528,7 +528,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * create shortcuts menu for contactTypes + * Create shortcuts menu for contactTypes * * @return array of contactTypes * @static @@ -565,7 +565,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; } /** - * delete Contact SubTypes + * Delete Contact SubTypes * * @param int $contactTypeId ID of the Contact Subtype to be deleted. * @@ -618,7 +618,7 @@ WHERE name = %1"; } /** - * Function to add or update Contact SubTypes + * Add or update Contact SubTypes * * @param array $params an assoc array of name/value pairs * @@ -684,7 +684,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 * @param boolean $is_active value we want to set the is_active field @@ -705,7 +705,7 @@ WHERE name = %1"; } /** - * @param $typeName + * @param string $typeName * * @return mixed */ @@ -719,7 +719,7 @@ WHERE name = %1"; } /** - * Function to check whether allow to change any contact's subtype + * Check whether allow to change any contact's subtype * on the basis of custom data and relationship of specific subtype * currently used in contact/edit form amd in import validation * @@ -751,7 +751,7 @@ WHERE name = %1"; /** * @param $contactType - * @param null $contactId + * @param int $contactId * * @return bool */ @@ -787,7 +787,7 @@ WHERE name = %1"; /** * @todo what does this function do? - * @param $contactId + * @param int $contactId * @param $contactType * * @return bool @@ -853,7 +853,7 @@ WHERE extends = %1 AND " . implode(" OR ", $subTypeClause); * Function that does something * @todo what does this function do? * - * @param $contactID + * @param int $contactID * @param $contactType * @param array $oldSubtypeSet * @param array $newSubtypeSet diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 3207a65153..49f89714de 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -67,7 +67,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * delete the group and all the object that connect to + * Delete the group and all the object that connect to * this group. Incredibly destructive * * @param int $id group id @@ -201,7 +201,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Get the list of member for a group id * - * @param $groupID + * @param int $groupID * @param bool $useCache * * @return array $aMembers this array contains the list of members for this group id @@ -303,7 +303,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 * @@ -503,7 +503,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * given a saved search compute the clause and the tables + * Given a saved search compute the clause and the tables * and store it for future use */ function buildClause() { @@ -552,7 +552,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 * @param boolean $isActive value we want to set the is_active field @@ -565,7 +565,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * build the condition to retrieve groups. + * Build the condition to retrieve groups. * * @param string $groupType type of group(Access/Mailing) OR the key of the group * @param bool|\boolen $excludeHidden exclude hidden groups. @@ -604,7 +604,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * get permission relevant clauses + * Get permission relevant clauses * CRM-12209 * * @param bool $force @@ -1226,7 +1226,7 @@ WHERE {$whereClause}"; } /** - * define action links + * Define action links * * @return array $links array of action links * @access public @@ -1268,7 +1268,7 @@ WHERE {$whereClause}"; /** * @param $whereClause - * @param $whereParams + * @param array $whereParams * * @return string */ diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index bcfdb2d8d6..0c1425ca06 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 */ 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 @@ -266,7 +266,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 * @@ -309,7 +309,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 * @param string $status state of membership @@ -494,7 +494,7 @@ SELECT * } /** - * takes an associative array and creates / removes + * Takes an associative array and creates / removes * contacts from the groups * * @@ -557,8 +557,8 @@ SELECT * } /** - * @param $contactID - * @param $groupID + * @param int $contactID + * @param int $groupID * * @return bool */ diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 4205fcddee..acda3a755d 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -198,7 +198,7 @@ AND g.refresh_date IS NULL } /** - * @param $groupID + * @param int $groupID */ static function add($groupID) { // first delete the current cache @@ -216,7 +216,7 @@ AND g.refresh_date IS NULL } /** - * @param $groupID + * @param int $groupID * @param $values */ static function store(&$groupID, &$values) { @@ -385,7 +385,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 * @param boolean $force - should we force a search through diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 6842abe134..d6bb5c2f63 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 */ function __construct($styleLabels = FALSE, $styleIndent = " -- ") { parent::__construct(); @@ -695,8 +695,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen } /** - * @param $contactId - * @param $parentGroupId + * @param int $contactId + * @param int $parentGroupId * * @return array */ diff --git a/CRM/Contact/BAO/GroupNestingCache.php b/CRM/Contact/BAO/GroupNestingCache.php index 6fa5bc88b0..80a2cfcaf5 100644 --- a/CRM/Contact/BAO/GroupNestingCache.php +++ b/CRM/Contact/BAO/GroupNestingCache.php @@ -118,7 +118,7 @@ WHERE id = $id /** * @param $tree - * @param $id + * @param int $id * * @return bool */ @@ -141,7 +141,7 @@ WHERE id = $id } /** - * @param $id + * @param int $id * @param $groups * * @return array @@ -168,7 +168,7 @@ WHERE id = $id /** * @param $potential * @param $tree - * @param $id + * @param int $id * @param $token */ static function invalidate(&$potential, &$tree, $id, $token) { @@ -188,7 +188,7 @@ WHERE id = $id /** * @param $all * @param $tree - * @param $id + * @param int $id * @param $token */ static function getAll(&$all, &$tree, $id, $token) { diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 4f02128b04..160fa60ca2 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 */ 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 * @@ -108,7 +108,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio } /** - * @param $groupID + * @param int $groupID * @param $defaults */ static function retrieve($groupID, &$defaults) { @@ -140,7 +140,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 3fac04ba15..20805ab7ad 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 integer $primaryContactId null if deleting primary contact * @param integer $contactId contact id diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 341781d20b..35e4906847 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -333,7 +333,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * regenerates display_name for contacts with given prefixes/suffixes + * Regenerates display_name for contacts with given prefixes/suffixes * * @param array $ids the array with the prefix/suffix id governing which contacts to regenerate * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED @@ -380,7 +380,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * creates display name + * Creates display name * * @return string the constructed display name */ diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 118d36d88a..21dfd712d8 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -58,7 +58,7 @@ class CRM_Contact_BAO_Query { MODE_MAILING = 16384; /** - * the default set of return properties + * The default set of return properties * * @var array * @static @@ -66,7 +66,7 @@ class CRM_Contact_BAO_Query { static $_defaultReturnProperties = NULL; /** - * the default set of hier return properties + * The default set of hier return properties * * @var array * @static @@ -74,7 +74,7 @@ class CRM_Contact_BAO_Query { static $_defaultHierReturnProperties; /** - * the set of input params + * The set of input params * * @var array */ @@ -86,21 +86,21 @@ class CRM_Contact_BAO_Query { public $_sort; /** - * the set of output params + * The set of output params * * @var array */ public $_returnProperties; /** - * the select clause + * The select clause * * @var array */ public $_select; /** - * the name of the elements that are in the select clause + * The name of the elements that are in the select clause * used to extract the values * * @var array @@ -108,28 +108,28 @@ class CRM_Contact_BAO_Query { public $_element; /** - * the tables involved in the query + * The tables involved in the query * * @var array */ public $_tables; /** - * the table involved in the where clause + * The table involved in the where clause * * @var array */ public $_whereTables; /** - * the where clause + * The where clause * * @var array */ public $_where; /** - * the where string + * The where string * * @var string * @@ -137,7 +137,7 @@ class CRM_Contact_BAO_Query { public $_whereClause; /** - * additional permission Where Clause + * Additional permission Where Clause * * @var string * @@ -145,7 +145,7 @@ class CRM_Contact_BAO_Query { public $_permissionWhereClause; /** - * the from string + * The from string * * @var string * @@ -153,7 +153,7 @@ class CRM_Contact_BAO_Query { public $_fromClause; /** - * additional permission from clause + * Additional permission from clause * * @var string * @@ -161,7 +161,7 @@ class CRM_Contact_BAO_Query { public $_permissionFromClause; /** - * the from clause for the simple select and alphabetical + * The from clause for the simple select and alphabetical * select * * @var string @@ -169,7 +169,7 @@ class CRM_Contact_BAO_Query { public $_simpleFromClause; /** - * the having values + * The having values * * @var string * @@ -199,28 +199,28 @@ class CRM_Contact_BAO_Query { 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 */ public $_skipDeleteClause = FALSE; /** - * are we in strict mode (use equality over LIKE) + * Are we in strict mode (use equality over LIKE) * * @var boolean */ @@ -243,7 +243,7 @@ class CRM_Contact_BAO_Query { public $_primaryLocation = TRUE; /** - * are contact ids part of the query + * Are contact ids part of the query * * @var boolean */ @@ -264,14 +264,14 @@ class CRM_Contact_BAO_Query { public $_displayRelationshipType = NULL; /** - * reference to the query object for custom values + * Reference to the query object for custom values * * @var Object */ public $_customQuery; /** - * should we enable the distinct clause, used if we are including + * Should we enable the distinct clause, used if we are including * more than one group * * @var boolean @@ -284,7 +284,7 @@ class CRM_Contact_BAO_Query { public $_useGroupBy = FALSE; /** - * the relationship type direction + * The relationship type direction * * @var array * @static @@ -292,7 +292,7 @@ class CRM_Contact_BAO_Query { static $_relType; /** - * the activity role + * The activity role * * @var array * @static @@ -318,7 +318,7 @@ class CRM_Contact_BAO_Query { static $_withContactActivitiesOnly; /** - * use distinct component clause for component searches + * Use distinct component clause for component searches * * @var string */ @@ -327,7 +327,7 @@ class CRM_Contact_BAO_Query { public $_rowCountClause; /** - * use groupBy component clause for component searches + * Use groupBy component clause for component searches * * @var string */ @@ -405,7 +405,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 @@ -476,7 +476,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 * @access private @@ -1264,7 +1264,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 boolean $count * @param boolean $sortByChar @@ -1383,7 +1383,7 @@ class CRM_Contact_BAO_Query { } /** - * @param $name + * @param string $name * @param $grouping * * @return null @@ -1480,7 +1480,7 @@ class CRM_Contact_BAO_Query { } /** - * @param $id + * @param int $id * @param $values * @param int $wildcard * @param bool $useEquals @@ -2308,7 +2308,7 @@ class CRM_Contact_BAO_Query { } /** - * getter for tables array + * Getter for tables array * * @return array * @access public @@ -2328,7 +2328,7 @@ class CRM_Contact_BAO_Query { } /** - * generate the where clause (used in match contacts and permissions) + * Generate the where clause (used in match contacts and permissions) * * @param array $params * @param array $fields @@ -2352,7 +2352,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 * if null, return mimimal from clause (i.e. civicrm_contact) @@ -2620,7 +2620,7 @@ class CRM_Contact_BAO_Query { } /** - * where / qill clause for contact_type + * Where / qill clause for contact_type * * @param $values * @@ -2688,7 +2688,7 @@ class CRM_Contact_BAO_Query { } /** - * where / qill clause for contact_sub_type + * Where / qill clause for contact_sub_type * * @param $values * @@ -2727,7 +2727,7 @@ class CRM_Contact_BAO_Query { } /** - * where / qill clause for groups + * Where / qill clause for groups * * @param $values * @@ -2841,7 +2841,7 @@ class CRM_Contact_BAO_Query { } /** - * where / qill clause for smart groups + * Where / qill clause for smart groups * * @param $values * @@ -2907,7 +2907,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for cms users + * Where / qill clause for cms users * * @param $values * @@ -2931,7 +2931,7 @@ WHERE id IN ( $groupIDs ) } /** - * all tag search specific + * All tag search specific * * @param $values * @@ -2999,7 +2999,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for tag + * Where / qill clause for tag * * @param $values * @@ -3086,7 +3086,7 @@ WHERE id IN ( $groupIDs ) } /** - * where/qill clause for notes + * Where/qill clause for notes * * @param $values * @@ -3134,7 +3134,7 @@ WHERE id IN ( $groupIDs ) } /** - * @param $name + * @param string $name * @param $op * @param $grouping * @@ -3164,7 +3164,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for sort_name + * Where / qill clause for sort_name * * @param $values * @@ -3323,7 +3323,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for email + * Where / qill clause for email * * @param $values * @@ -3366,7 +3366,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for phone number + * Where / qill clause for phone number * * @param $values * @@ -3389,7 +3389,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for phone type/location + * Where / qill clause for phone type/location * * @param $values * @@ -3407,7 +3407,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for street_address + * Where / qill clause for street_address * * @param $values * @@ -3442,7 +3442,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for street_unit + * Where / qill clause for street_unit * * @param $values * @@ -3477,7 +3477,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for sorting by character + * Where / qill clause for sorting by character * * @param $values * @@ -3494,7 +3494,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for including contact ids + * Where / qill clause for including contact ids * * @return void * @access public @@ -3516,7 +3516,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for postal code + * Where / qill clause for postal code * * @param $values * @@ -3558,7 +3558,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for location type + * Where / qill clause for location type * * @param $values * @param null $status @@ -3678,7 +3678,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for county (if present) + * Where / qill clause for county (if present) * * @param $values * @param null $status @@ -3747,7 +3747,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for state/province AND country (if present) + * Where / qill clause for state/province AND country (if present) * * @param $values * @param null $status @@ -3842,7 +3842,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for change log + * Where / qill clause for change log * * @param $values * @@ -4023,7 +4023,7 @@ WHERE id IN ( $groupIDs ) } /** - * where / qill clause for relationship + * Where / qill clause for relationship * * @param $values * @@ -4237,7 +4237,7 @@ civicrm_relationship.is_permission_a_b = 0 } /** - * default set of return properties + * Default set of return properties * * @param int $mode * @@ -4319,7 +4319,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 * @@ -4335,7 +4335,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 @@ -4452,7 +4452,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 * @param int $rowCount the number of rows to return @@ -4865,7 +4865,7 @@ SELECT COUNT( conts.total_amount ) as cancel_count, } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -4875,7 +4875,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 * @access public @@ -4960,9 +4960,9 @@ SELECT COUNT( conts.total_amount ) as cancel_count, /** * @param $values - * @param $tableName - * @param $fieldName - * @param $dbFieldName + * @param string $tableName + * @param string $fieldName + * @param string $dbFieldName * @param $fieldTitle * @param bool $appendTimeStamp */ @@ -5073,9 +5073,9 @@ SELECT COUNT( conts.total_amount ) as cancel_count, /** * @param $values - * @param $tableName - * @param $fieldName - * @param $dbFieldName + * @param string $tableName + * @param string $fieldName + * @param string $dbFieldName * @param $fieldTitle * @param null $options */ @@ -5463,7 +5463,7 @@ AND displayRelType.is_active = 1 } /** - * check and explode a user defined numeric string into an array + * Check and explode a user defined numeric string into an array * this was the protocol used by search builder in the old old days before we had * super nice js widgets to do the hard work * @@ -5505,7 +5505,7 @@ AND displayRelType.is_active = 1 } /** - * convert the pseudo constants id's to their names + * Convert the pseudo constants id's to their names * * @param CRM_Core_DAO dao * @param bool $return @@ -5581,7 +5581,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 diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index 33d9b0eacd..c64e39e702 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 * @static @@ -95,7 +95,7 @@ class CRM_Contact_BAO_Query_Hook { /** * @param $query - * @param $fnName + * @param string $fnName */ public function alterSearchQuery(&$query, $fnName) { foreach (self::getSearchQueryObjects() as $obj) { @@ -104,7 +104,7 @@ class CRM_Contact_BAO_Query_Hook { } /** - * @param $fieldName + * @param string $fieldName * @param $mode * @param $side * diff --git a/CRM/Contact/BAO/Query/Interface.php b/CRM/Contact/BAO/Query/Interface.php index 36a072fb35..46dcba987e 100644 --- a/CRM/Contact/BAO/Query/Interface.php +++ b/CRM/Contact/BAO/Query/Interface.php @@ -41,7 +41,7 @@ abstract class CRM_Contact_BAO_Query_Interface { abstract public function &getFields(); /** - * @param $fieldName + * @param string $fieldName * @param $mode * @param $side * diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 839941d17c..33f1e9c4e6 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -35,14 +35,14 @@ 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 */ CONST PAST = 1, DISABLED = 2, CURRENT = 4, INACTIVE = 8; /** - * takes an associative array and creates a relationship object + * Takes an associative array and creates a relationship object * * * @param array $params (reference ) an assoc array of name/value pairs @@ -303,7 +303,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * get get list of relationship type based on the contact type. + * Get get list of relationship type based on the contact type. * * @param int $contactId this is the contact id of the current contact. * @param null $contactSuffix @@ -422,7 +422,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * @param $id + * @param int $id * @param $action * * @return CRM_Contact_DAO_Relationship @@ -451,7 +451,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * delete the relationship + * Delete the relationship * * @param int $id relationship id * @@ -500,7 +500,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * disable/enable the relationship + * Disable/enable the relationship * * @param int $id relationship id * @@ -565,7 +565,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Function to get the other contact in a relationship + * Get the other contact in a relationship * * @param int $id relationship id * @@ -587,7 +587,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { } /** - * Function to 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 * @param int $contact_b 2nd contact id @@ -628,7 +628,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 * @param array $ids the array that holds all the db ids @@ -655,7 +655,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 * @param integer $id this the id of the contact whom we are adding relationship @@ -732,7 +732,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 * @param boolean $is_active value we want to set the is_active field @@ -799,14 +799,14 @@ 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 * @param int $status (check const at top of file) * @param int $numRelationship no of relationships to display (limit) * @param int $count get the no of relationships * $param int $relationshipId relationship id - * @param $relationshipId + * @param int $relationshipId * @param string $direction the direction we are interested in a_b or b_a * @param array $params array of extra values including relationship_type_id per api spec * @@ -1151,7 +1151,7 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) } /** - * Function to get get list of relationship type based on the target contact type. + * Get get list of relationship type based on the target contact type. * * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household) * @@ -1172,7 +1172,7 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) } /** - * Function to create / update / delete membership for related contacts. + * Create / update / delete membership for related contacts. * * This function will create/update/delete membership for related * contact based on 1) contact have active membership 2) that @@ -1434,7 +1434,7 @@ SELECT count(*) } /** - * Function to get Current Employer for Contact + * Get Current Employer for Contact * * @param $contactIds Contact Ids * @@ -1460,7 +1460,7 @@ WHERE id IN ( {$contacts} ) } /** - * Function to return list of permissioned employer for a given contact. + * Return list of permissioned employer for a given contact. * * @param $contactID int contact id whose employers * are to be found. diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index f20b58f1cb..6711f5c996 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -35,7 +35,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -76,7 +76,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 * @param array $ids the array that holds all the db ids @@ -131,7 +131,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 29ce54c14b..2581794f36 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 */ @@ -49,7 +49,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * query the db for all saved searches. + * Query the db for all saved searches. * * @return array $aSavedSearch - contains the search name as value and and id as key * @@ -88,7 +88,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * given an id, extract the formValues of the saved search + * Given an id, extract the formValues of the saved search * * @param int $id the id of the saved search * @@ -131,7 +131,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * @param $id + * @param int $id * * @return array */ @@ -150,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 * @param array $tables (reference ) add the tables that are needed for the select clause @@ -173,7 +173,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * @param $id + * @param int $id * * @return string */ @@ -197,7 +197,7 @@ WHERE $where"; } /** - * @param $id + * @param int $id * * @return array */ @@ -229,7 +229,7 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ } /** - * given a saved search compute the clause and the tables + * Given a saved search compute the clause and the tables * and store it for future use */ function buildClause() { @@ -264,7 +264,7 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ } /** - * given an id, get the name of the saved search + * Given an id, get the name of the saved search * * @param int $id the id of the saved search * diff --git a/CRM/Contact/BAO/SearchCustom.php b/CRM/Contact/BAO/SearchCustom.php index 7d720f3a2a..13a9050d75 100644 --- a/CRM/Contact/BAO/SearchCustom.php +++ b/CRM/Contact/BAO/SearchCustom.php @@ -35,9 +35,9 @@ class CRM_Contact_BAO_SearchCustom { /** - * @param $csID - * @param null $ssID - * @param null $gID + * @param int $csID + * @param int $ssID + * @param int $gID * * @return array * @throws Exception @@ -100,8 +100,8 @@ class CRM_Contact_BAO_SearchCustom { } /** - * @param $csID - * @param $ssID + * @param int $csID + * @param int $ssID * * @return mixed * @throws Exception @@ -120,8 +120,8 @@ class CRM_Contact_BAO_SearchCustom { } /** - * @param $csID - * @param $ssID + * @param int $csID + * @param int $ssID * * @return mixed */ @@ -150,8 +150,8 @@ class CRM_Contact_BAO_SearchCustom { } /** - * @param $csID - * @param $ssID + * @param int $csID + * @param int $ssID * * @return array */ diff --git a/CRM/Contact/BAO/SubscriptionHistory.php b/CRM/Contact/BAO/SubscriptionHistory.php index 09fe3ec06c..f97a899081 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 * * @access public * @return \CRM_Contact_DAO_SubscriptionHistory diff --git a/CRM/Contact/Controller/Search.php b/CRM/Contact/Controller/Search.php index a56bbbb788..3b61d31edc 100644 --- a/CRM/Contact/Controller/Search.php +++ b/CRM/Contact/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Contact_Controller_Search extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) { parent::__construct($title, $modal); diff --git a/CRM/Contact/DAO/Factory.php b/CRM/Contact/DAO/Factory.php index 27d264fb2e..e26ad410e8 100644 --- a/CRM/Contact/DAO/Factory.php +++ b/CRM/Contact/DAO/Factory.php @@ -27,7 +27,7 @@ class CRM_Contact_DAO_Factory { static $_suffix = '.php'; /** - * @param $className + * @param string $className * * @return mixed */ diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 0f05b38960..ac0ba7ec18 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -65,21 +65,21 @@ 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 */ public $_tid; /** - * name of de-dupe button + * Name of de-dupe button * * @var string * @access protected @@ -87,7 +87,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 * @access protected @@ -118,7 +118,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; @@ -130,7 +130,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 * @access public @@ -454,7 +454,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * do the set default related to location type id, + * Do the set default related to location type id, * primary location, default country * */ @@ -584,7 +584,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 * @param array $errors list of errors to be posted back to the form @@ -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 * @@ -1104,7 +1104,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 * @param $errors @@ -1277,7 +1277,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * check parse result and if some address block fails then this + * Check parse result and if some address block fails then this * function return the status message for all address blocks. * * @param $parseResult an array of address blk instance and its status. diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php index 9e9a6425aa..8d9d3641cd 100644 --- a/CRM/Contact/Form/CustomData.php +++ b/CRM/Contact/Form/CustomData.php @@ -51,14 +51,14 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { protected $_tableId; /** - * entity type of the table id + * Entity type of the table id * * @var string */ protected $_entityType; /** - * entity sub type of the table id + * Entity sub type of the table id * * @var string * @access protected @@ -66,7 +66,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { protected $_entitySubType; /** - * the group tree data + * The group tree data * * @var array */ @@ -94,7 +94,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { protected $_groupCollapseDisplay; /** - * custom group id + * Custom group id * * @int * @access public @@ -105,7 +105,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { public $_copyValueId; /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for table name, id of entity in table, type of entity and stores them. * diff --git a/CRM/Contact/Form/DedupeFind.php b/CRM/Contact/Form/DedupeFind.php index 5fcb98e83b..3a17396beb 100644 --- a/CRM/Contact/Form/DedupeFind.php +++ b/CRM/Contact/Form/DedupeFind.php @@ -40,13 +40,13 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { /** - * defined defaults + * Defined defaults * */ public $_defaults; /** - * pre processing + * Pre processing * * @return void * @access public diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index 2b125e8f58..67353e372f 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 * @access public @@ -142,7 +142,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 * diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 2ae812ce7c..af7d6a2de0 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -39,35 +39,35 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { /** - * the group id, used when editing a group + * The group id, used when editing a group * * @var int */ protected $_id; /** - * the contact_id of domain + * The contact_id of domain * * @var int */ protected $_contactId; /** - * default from email address option value id. + * Default from email address option value id. * * @var int */ protected $_fromEmailId = NULL; /** - * default location type fields + * Default location type fields * * @var array */ protected $_locationDefaults = array(); /** - * how many locationBlocks should we display? + * How many locationBlocks should we display? * * @var int * @const @@ -199,7 +199,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 * diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index 654ec493b7..8778707995 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 - the index of the address array (if multiple addresses on a page) @@ -253,7 +253,7 @@ class CRM_Contact_Form_Edit_Address { } /** - * check for correct state / country mapping. + * Check for correct state / country mapping. * * @param $fields * @param $files @@ -312,7 +312,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 * @param CRM_Core_Form $form form object diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 1261ab57fb..3ad4929985 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { /** - * greetings + * Greetings * @var array * @static */ @@ -131,7 +131,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index a1a8e69417..7cedc2e76f 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 * diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 94395a252b..839dfce3b9 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -78,7 +78,7 @@ class CRM_Contact_Form_Edit_Household { } /** - * add rule for household + * Add rule for household * * @param array $fields array of form values * @param array $files - unused diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index aeb44b4c98..d31b66e261 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.php @@ -143,11 +143,11 @@ class CRM_Contact_Form_Edit_Individual { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param null $contactID + * @param int $contactID * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index 83dfa86763..52b9d3b39f 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -56,7 +56,7 @@ class CRM_Contact_Form_Edit_Lock { * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param null $contactID + * @param int $contactID * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contact/Form/Edit/Organization.php b/CRM/Contact/Form/Edit/Organization.php index 21fb3759d3..cdc05ddd62 100644 --- a/CRM/Contact/Form/Edit/Organization.php +++ b/CRM/Contact/Form/Edit/Organization.php @@ -89,7 +89,7 @@ class CRM_Contact_Form_Edit_Organization { /** * @param $fields * @param $files - * @param null $contactID + * @param int $contactID * * @return array|bool */ diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 4745134eea..b29fa733df 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -35,7 +35,7 @@ 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 */ @@ -195,7 +195,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 * @param array $defaults the defaults array to store the values in diff --git a/CRM/Contact/Form/Inline/Address.php b/CRM/Contact/Form/Inline/Address.php index cc1a1b9109..0bc959330c 100644 --- a/CRM/Contact/Form/Inline/Address.php +++ b/CRM/Contact/Form/Inline/Address.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { /** - * location block no + * Location block no */ private $_locBlockNo; @@ -49,17 +49,17 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { public $_parseStreetAddress; /** - * store address values + * Store address values */ public $_values; /** - * form action + * Form action */ public $_action; /** - * address id + * Address id */ public $_addressId; @@ -76,7 +76,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * call preprocess + * Call preprocess */ public function preProcess() { parent::preProcess(); @@ -131,7 +131,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -161,7 +161,7 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/CommunicationPreferences.php b/CRM/Contact/Form/Inline/CommunicationPreferences.php index 5008ab2e66..058de1f4a2 100644 --- a/CRM/Contact/Form/Inline/CommunicationPreferences.php +++ b/CRM/Contact/Form/Inline/CommunicationPreferences.php @@ -51,7 +51,7 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_ } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -82,7 +82,7 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_ } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/ContactInfo.php b/CRM/Contact/Form/Inline/ContactInfo.php index f2a25ad640..b06ed185f0 100644 --- a/CRM/Contact/Form/Inline/ContactInfo.php +++ b/CRM/Contact/Form/Inline/ContactInfo.php @@ -53,7 +53,7 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -63,7 +63,7 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/ContactName.php b/CRM/Contact/Form/Inline/ContactName.php index 19f493f314..1e4749866d 100644 --- a/CRM/Contact/Form/Inline/ContactName.php +++ b/CRM/Contact/Form/Inline/ContactName.php @@ -53,7 +53,7 @@ class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php index 02e57e1698..a587e4244f 100644 --- a/CRM/Contact/Form/Inline/CustomData.php +++ b/CRM/Contact/Form/Inline/CustomData.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { /** - * custom group id + * Custom group id * * @int * @access public @@ -47,14 +47,14 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { 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(); @@ -80,7 +80,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -90,7 +90,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Demographics.php b/CRM/Contact/Form/Inline/Demographics.php index 8a7495caf6..fba13c30ab 100644 --- a/CRM/Contact/Form/Inline/Demographics.php +++ b/CRM/Contact/Form/Inline/Demographics.php @@ -50,7 +50,7 @@ class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 4e2ea860aa..f3d5bec3c0 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -39,7 +39,7 @@ 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(); @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { private $_blockCount = 6; /** - * call preprocess + * Call preprocess */ public function preProcess() { parent::preProcess(); @@ -97,7 +97,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 * @param array $errors list of errors to be posted back to the form @@ -132,7 +132,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -154,7 +154,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index 101ca7208f..90f4a846e0 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -39,7 +39,7 @@ 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(); @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { private $_blockCount = 6; /** - * call preprocess + * Call preprocess */ public function preProcess() { parent::preProcess(); @@ -97,7 +97,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 * @param array $errors list of errors to be posted back to 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 * @access public @@ -155,7 +155,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 6587732a15..b9a8ac94d6 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -67,7 +67,7 @@ class CRM_Contact_Form_Inline_Lock { * * @param array $fields the input form values * @param array $files the uploaded files if any - * @param null $contactID + * @param int $contactID * * @return true if no errors, else array of errors * @access public @@ -90,7 +90,7 @@ class CRM_Contact_Form_Inline_Lock { /** * Return any post-save data * - * @param $contactID + * @param int $contactID * * @return array extra options to return in JSON */ diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 49920d8cca..137d170337 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -39,7 +39,7 @@ 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(); @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { private $_blockCount = 6; /** - * call preprocess + * Call preprocess */ public function preProcess() { parent::preProcess(); @@ -97,7 +97,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 * @param array $errors list of errors to be posted back to 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 * @access public @@ -155,7 +155,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 42e0ae27a3..6d940f6544 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { /** - * phones of the contact that is been viewed + * Phones of the contact that is been viewed */ private $_phones = array(); @@ -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(); @@ -97,7 +97,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 * @param array $errors list of errors to be posted back to 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 * @access public @@ -156,7 +156,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Inline/Website.php b/CRM/Contact/Form/Inline/Website.php index af51305a69..4900202ad1 100644 --- a/CRM/Contact/Form/Inline/Website.php +++ b/CRM/Contact/Form/Inline/Website.php @@ -39,7 +39,7 @@ 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(); @@ -49,7 +49,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { private $_blockCount = 6; /** - * call preprocess + * Call preprocess */ public function preProcess() { parent::preProcess(); @@ -95,7 +95,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * set defaults for the form + * Set defaults for the form * * @return array * @access public @@ -117,7 +117,7 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { } /** - * process the form + * Process the form * * @return void * @access public diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index 5e49549418..4086579e6f 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 * diff --git a/CRM/Contact/Form/ProfileContact.php b/CRM/Contact/Form/ProfileContact.php index e8276c8fff..b2d3e75da0 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 * @@ -75,7 +75,7 @@ class CRM_Contact_Form_ProfileContact { } /** - * build form for honoree contact / on behalf of organization. + * Build form for honoree contact / on behalf of organization. * * @param CRM_Core_Form $form * diff --git a/CRM/Contact/Form/RelatedContact.php b/CRM/Contact/Form/RelatedContact.php index e950ed69c3..ec8a205936 100644 --- a/CRM/Contact/Form/RelatedContact.php +++ b/CRM/Contact/Form/RelatedContact.php @@ -58,14 +58,14 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form { public $_contactId; /** - * form defaults + * Form defaults * * @var array */ protected $_defaults = array(); /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php index d35d643c6f..45ff98c3f9 100644 --- a/CRM/Contact/Form/Relationship.php +++ b/CRM/Contact/Form/Relationship.php @@ -85,7 +85,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { public $_relationshipTypeId; /** - * an array of all relationship names + * An array of all relationship names * * @var array */ @@ -112,7 +112,7 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { public $_values; /** - * casid if it called from case context + * Casid if it called from case context */ public $_caseId; @@ -541,7 +541,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 077acf7c8a..a76a84914c 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -52,7 +52,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { 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 @@ -68,7 +68,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_contextMenu; /** - * the groupId retrieved from the GET vars + * The groupId retrieved from the GET vars * * @var int * @access public @@ -76,7 +76,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { 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 @@ -85,7 +85,7 @@ 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 * @access protected @@ -93,7 +93,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_ssID; /** - * the group elements + * The group elements * * @var array * @access public @@ -103,7 +103,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { public $_groupIterator; /** - * the tag elements + * The tag elements * * @var array * @access protected @@ -144,7 +144,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { protected $_ufGroupID; /** - * csv - common search values + * Csv - common search values * * @var array * @access protected @@ -166,7 +166,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; @@ -175,7 +175,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 * @access protected @@ -478,7 +478,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 * @access public diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 77e9d5389e..5a8e7e1a41 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 * @access public @@ -329,7 +329,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * normalize the form values to make it look similar to the advanced form values + * Normalize the form values to make it look similar to the advanced form values * this prevents a ton of work downstream and allows us to use the same code for * multiple purposes (queries, save/edit etc) * @@ -392,7 +392,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 $defaults array * @return array diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index 0ed93d3016..5eb4ff2d8b 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -147,7 +147,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 * @access public @@ -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 * @access public @@ -217,7 +217,7 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * normalize the form values to make it look similar to the advanced form values + * Normalize the form values to make it look similar to the advanced form values * this prevents a ton of work downstream and allows us to use the same code for * multiple purposes (queries, save/edit etc) * diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index 53c2146bf1..614ee325d8 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** - * number of columns in where + * Number of columns in where * * @var int * @access public @@ -47,7 +47,7 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { public $_columnCount; /** - * number of blocks to be shown + * Number of blocks to be shown * * @var int * @access public @@ -137,7 +137,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 diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php index fa16c44afa..94f709d8cf 100644 --- a/CRM/Contact/Form/Search/Criteria.php +++ b/CRM/Contact/Form/Search/Criteria.php @@ -34,7 +34,7 @@ */ class CRM_Contact_Form_Search_Criteria { /** - * @param $form CRM_Core_Form + * @param CRM_Core_Form $form */ static function basic(&$form) { $form->addElement('hidden', 'hidden_basic', 1); diff --git a/CRM/Contact/Form/Search/Custom/Basic.php b/CRM/Contact/Form/Search/Custom/Basic.php index 7c8ec8dd49..b8a13f027a 100644 --- a/CRM/Contact/Form/Search/Custom/Basic.php +++ b/CRM/Contact/Form/Search/Custom/Basic.php @@ -81,7 +81,7 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo } /** - * normalize the form values to make it look similar to the advanced form values + * Normalize the form values to make it look similar to the advanced form values * this prevents a ton of work downstream and allows us to use the same code for * multiple purposes (queries, save/edit etc) * diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php index b2be2c995c..a50ca5a50d 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_F } /** - * get contribution ids in entity tables. + * Get contribution ids in entity tables. * * @param string $queryText * @param string $entityIDTableName diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php index 6c30c3698e..138dd2667e 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For } /** - * get membership ids in entity tables. + * Get membership ids in entity tables. * * @param string $queryText * @param string $entityIDTableName diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index 2312c214d4..4847189477 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo } /** - * get participant ids in entity tables. + * Get participant ids in entity tables. * * @param string $queryText * @param string $entityIDTableName diff --git a/CRM/Contact/Form/Search/Custom/PriceSet.php b/CRM/Contact/Form/Search/Custom/PriceSet.php index 9f361bd464..196834af1f 100644 --- a/CRM/Contact/Form/Search/Custom/PriceSet.php +++ b/CRM/Contact/Form/Search/Custom/PriceSet.php @@ -155,7 +155,7 @@ WHERE participant_id = $participantID; } /** - * @param null $eventID + * @param int $eventID * * @return Object */ diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php index 9101fdd608..c905d054f2 100644 --- a/CRM/Contact/Form/Task.php +++ b/CRM/Contact/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -87,7 +87,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { static protected $_searchFormValues; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -278,7 +278,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { } /** - * get the contact id for custom search + * Get the contact id for custom search * we are not using prev/next table incase of custom search */ public function getContactIds() { @@ -359,7 +359,7 @@ class CRM_Contact_Form_Task 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 * * @access public * @@ -369,7 +369,7 @@ class CRM_Contact_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 title of the main button @@ -396,7 +396,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { } /** - * replace ids of household members in $this->_contactIds with the id of their household. + * Replace ids of household members in $this->_contactIds with the id of their household. * CRM-8338 * * @access public diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 310d8a3e10..86a7a38bec 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -48,21 +48,21 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { 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 * @access public @@ -180,7 +180,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 * @@ -202,7 +202,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 * * @access public * diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index 75589dab4b..01caf40f1f 100644 --- a/CRM/Contact/Form/Task/AddToHousehold.php +++ b/CRM/Contact/Form/Task/AddToHousehold.php @@ -110,7 +110,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 * * @access public * diff --git a/CRM/Contact/Form/Task/AddToOrganization.php b/CRM/Contact/Form/Task/AddToOrganization.php index 8248d00e42..68c26ae719 100644 --- a/CRM/Contact/Form/Task/AddToOrganization.php +++ b/CRM/Contact/Form/Task/AddToOrganization.php @@ -112,7 +112,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 * * @access public * diff --git a/CRM/Contact/Form/Task/AddToTag.php b/CRM/Contact/Form/Task/AddToTag.php index 4b756b9d85..d17a9bdff1 100644 --- a/CRM/Contact/Form/Task/AddToTag.php +++ b/CRM/Contact/Form/Task/AddToTag.php @@ -41,14 +41,14 @@ 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 */ @@ -94,7 +94,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 * * @access public * diff --git a/CRM/Contact/Form/Task/AlterPreferences.php b/CRM/Contact/Form/Task/AlterPreferences.php index 3801062236..9950d1c02d 100644 --- a/CRM/Contact/Form/Task/AlterPreferences.php +++ b/CRM/Contact/Form/Task/AlterPreferences.php @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index 465a6708bf..0b994af973 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -39,37 +39,37 @@ 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 * @access public @@ -196,7 +196,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 * @@ -224,7 +224,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 * * @access public * @@ -266,7 +266,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 form object */ diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index 661650b28f..002950e645 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -49,12 +49,12 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { protected $_single = FALSE; /** - * cache shared address message so we don't query twice + * Cache shared address message so we don't query twice */ 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 * @access public @@ -174,7 +174,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 * @param array $files the uploaded files if any @@ -194,7 +194,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 * * @access public * diff --git a/CRM/Contact/Form/Task/Email.php b/CRM/Contact/Form/Task/Email.php index 21baaadbeb..4ed14e81cf 100644 --- a/CRM/Contact/Form/Task/Email.php +++ b/CRM/Contact/Form/Task/Email.php @@ -56,44 +56,44 @@ 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(); /** - * store all selected contact id's, that includes to, cc and bcc contacts + * Store all selected contact id's, that includes to, cc and bcc contacts * @var array */ 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 * @access public @@ -164,7 +164,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 * * @access public * diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index 24585fea95..a3d112a165 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -317,7 +317,7 @@ class CRM_Contact_Form_Task_EmailCommon { } /** - * form rule + * Form rule * * @param array $fields the input form values * @param array $dontCare @@ -346,7 +346,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 * * @access public * diff --git a/CRM/Contact/Form/Task/HookSample.php b/CRM/Contact/Form/Task/HookSample.php index aefca7fc7e..013c108ad4 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 * @access public @@ -85,7 +85,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 * * @access public * diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index ccbe82505a..e3711ee5d0 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 * @access public @@ -109,7 +109,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 * * @access public * @@ -374,7 +374,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { return FALSE; } /** - * create labels (pdf) + * Create labels (pdf) * * @param array $contactRows assciated array of contact data * @param string $format format in which labels needs to be printed @@ -402,7 +402,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * create the array of returnProperties + * Create the array of returnProperties * * @param string $format format for which return properties build * diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 8af30fb3d3..cd08d54c95 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -58,7 +58,7 @@ class CRM_Contact_Form_Task_LabelCommon { return FALSE; } /** - * create labels (pdf) + * Create labels (pdf) * * @param array $contactRows assciated array of contact data * @param string $format format in which labels needs to be printed @@ -87,7 +87,7 @@ class CRM_Contact_Form_Task_LabelCommon { /** - * get the rows for the labels + * Get the rows for the labels * * @param $contactIDs * @param integer $locationTypeID @@ -258,7 +258,7 @@ class CRM_Contact_Form_Task_LabelCommon { } /** - * extract the return properties from the mailing format + * Extract the return properties from the mailing format * @todo I'm placing bets this is a duplicate of code elsewhere - find & merge * @param unknown_type $format * @return multitype:number diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 1041628172..cccfb10373 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 * @access public @@ -133,7 +133,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 * * @access public * @@ -142,7 +142,7 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { public function postProcess() {} /** - * 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 location_id diff --git a/CRM/Contact/Form/Task/Map/Event.php b/CRM/Contact/Form/Task/Map/Event.php index bca9f0bb75..46595968a1 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 * @access public diff --git a/CRM/Contact/Form/Task/Merge.php b/CRM/Contact/Form/Task/Merge.php index 6df9c74127..0ed24c257c 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 * @access public diff --git a/CRM/Contact/Form/Task/PDF.php b/CRM/Contact/Form/Task/PDF.php index f2e52cdad0..1104b66a24 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 * @access public @@ -123,7 +123,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 * * @access public * diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index e42cb9edcd..ea36fb09d5 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 * @@ -65,7 +65,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { /** * @param CRM_Core_Form $form - * @param $cid + * @param int $cid */ static function preProcessSingle(&$form, $cid) { $form->_contactIds = array($cid); @@ -202,7 +202,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon { } /** - * form rule + * Form rule * * @param array $fields the input form values * @param array $dontCare @@ -236,7 +236,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 * * @access protected * @@ -311,7 +311,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 * * @access public * diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index aa2fb1f060..0154f6b9d7 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -39,32 +39,32 @@ class CRM_Contact_Form_Task_PickProfile 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; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -137,7 +137,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 * @@ -158,7 +158,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 * * @access public * diff --git a/CRM/Contact/Form/Task/Print.php b/CRM/Contact/Form/Task/Print.php index fc798c302e..e165cc34a6 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 * @access public @@ -133,7 +133,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 * * @access public * diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 43a08a867c..350536f658 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -46,21 +46,21 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { 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 * @access public @@ -108,7 +108,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 * @param array $files the uploaded files if any diff --git a/CRM/Contact/Form/Task/RemoveFromGroup.php b/CRM/Contact/Form/Task/RemoveFromGroup.php index 696b19f611..eef3849b06 100644 --- a/CRM/Contact/Form/Task/RemoveFromGroup.php +++ b/CRM/Contact/Form/Task/RemoveFromGroup.php @@ -73,7 +73,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 * * @access public * diff --git a/CRM/Contact/Form/Task/RemoveFromTag.php b/CRM/Contact/Form/Task/RemoveFromTag.php index 1ba3101701..062d5740bc 100644 --- a/CRM/Contact/Form/Task/RemoveFromTag.php +++ b/CRM/Contact/Form/Task/RemoveFromTag.php @@ -39,14 +39,14 @@ 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 */ @@ -91,7 +91,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 * * @access public * diff --git a/CRM/Contact/Form/Task/Result.php b/CRM/Contact/Form/Task/Result.php index 4fb1b0e645..b3be6fe45e 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 * @access public diff --git a/CRM/Contact/Form/Task/SMS.php b/CRM/Contact/Form/Task/SMS.php index d2f826a351..79c80114d0 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 */ @@ -87,7 +87,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 * * @access public * diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 8ca6676f50..2814852094 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -300,7 +300,7 @@ class CRM_Contact_Form_Task_SMSCommon { } /** - * form rule + * Form rule * * @param array $fields the input form values * @param array $dontCare @@ -337,7 +337,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 * * @access public * diff --git a/CRM/Contact/Form/Task/SaveSearch.php b/CRM/Contact/Form/Task/SaveSearch.php index bedb416948..b8ec557158 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 * @access public @@ -144,7 +144,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 * * @access public * diff --git a/CRM/Contact/Form/Task/SaveSearch/Update.php b/CRM/Contact/Form/Task/SaveSearch/Update.php index 2e1624a681..16466128cb 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 * @access public diff --git a/CRM/Contact/Form/Task/Unhold.php b/CRM/Contact/Form/Task/Unhold.php index fafecf278d..16a7b25ac1 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 * @access public diff --git a/CRM/Contact/Form/Task/Useradd.php b/CRM/Contact/Form/Task/Useradd.php index 018e1c86d4..124a1c8b2c 100755 --- a/CRM/Contact/Form/Task/Useradd.php +++ b/CRM/Contact/Form/Task/Useradd.php @@ -39,7 +39,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { protected $_contactId; /** - * contact.display_name of contact for whom we are adding user + * Contact.display_name of contact for whom we are adding user * * @var int * @public @@ -47,7 +47,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 * @public diff --git a/CRM/Contact/Import/Controller.php b/CRM/Contact/Import/Controller.php index d5536b2505..73e80c4b53 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Contact/Import/Field.php b/CRM/Contact/Import/Field.php index 247ad98633..0391865bb0 100644 --- a/CRM/Contact/Import/Field.php +++ b/CRM/Contact/Import/Field.php @@ -36,101 +36,101 @@ class CRM_Contact_Import_Field { */ /** - * name of the field + * Name of the field */ public $_name; /** - * title of the field to be used in display + * Title of the field to be used in display */ public $_title; /** - * type of field + * Type of field * @var enum */ public $_type; /** - * is this field required + * Is this field required * @var boolean */ public $_required; /** - * data to be carried for use by a derived class + * Data to be carried for use by a derived class * @var object */ public $_payload; /** - * regexp to match the CSV header of this column/field + * Regexp to match the CSV header of this column/field * @var string */ public $_columnPattern; /** - * regexp to match the pattern of data from various column/fields + * Regexp to match the pattern of data from various column/fields * @var string */ public $_dataPattern; /** - * regexp to match the pattern of header from various column/fields + * Regexp to match the pattern of header from various column/fields * @var string */ public $_headerPattern; /** - * location type + * Location type * @var int */ public $_hasLocationType; /** - * does this field have a phone type + * Does this field have a phone type * @var string */ public $_phoneType; /** - * value of this field + * Value of this field * @var object */ public $_value; /** - * does this field have a relationship info + * Does this field have a relationship info * @var string */ public $_related; /** - * does this field have a relationship Contact Type + * Does this field have a relationship Contact Type * @var string */ public $_relatedContactType; /** - * does this field have a relationship Contact Details + * Does this field have a relationship Contact Details * @var string */ public $_relatedContactDetails; /** - * does this field have a related Contact info of Location Type + * Does this field have a related Contact info of Location Type * @var int */ public $_relatedContactLocType; /** - * does this field have a related Contact info of Phone Type + * Does this field have a related Contact info of Phone Type * @var string */ public $_relatedContactPhoneType; /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $columnPattern @@ -165,7 +165,7 @@ class CRM_Contact_Import_Field { } /** - * the value is in string format. convert the value to the type of this field + * The value is in string format. convert the value to the type of this field * and set the field value with the appropriate type */ function setValue($value) { diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php index 90cc1ac0cd..61c2ea2ec5 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 * @access public @@ -374,7 +374,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { * Returns the name of the primary key and status columns * * @param $db - * @param $importTableName + * @param string $importTableName * * @return array * @access private diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index 3694f77c59..5699e2b90e 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -40,7 +40,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * an array of all contact fields with + * An array of all contact fields with * formatted custom field names. * * @var array @@ -49,7 +49,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { protected $_formattedFieldNames; /** - * on duplicate + * On duplicate * * @var int */ @@ -93,7 +93,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 * @access public @@ -622,7 +622,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 * @@ -977,7 +977,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { } /** - * format custom field name. + * Format custom field name. * combine group and field name to avoid conflict. * * @param $fields diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index d8f3fd5a14..687d22a358 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 * @access public @@ -188,7 +188,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 9084ba82e2..b943d2a137 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 * @access public diff --git a/CRM/Contact/Import/ImportJob.php b/CRM/Contact/Import/ImportJob.php index 797c6d23f6..ffb58217c4 100644 --- a/CRM/Contact/Import/ImportJob.php +++ b/CRM/Contact/Import/ImportJob.php @@ -339,7 +339,7 @@ class CRM_Contact_Import_ImportJob { /** * @param $contactIds - * @param $newGroupName + * @param string $newGroupName * @param $newGroupDesc * * @return array|bool @@ -392,7 +392,7 @@ class CRM_Contact_Import_ImportJob { /** * @param $contactIds - * @param $newTagName + * @param string $newTagName * @param $newTagDesc * * @return array|bool diff --git a/CRM/Contact/Import/Page/AJAX.php b/CRM/Contact/Import/Page/AJAX.php index b40fd776b0..bfd3f8c387 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 */ static function status() { // make sure we get an id diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index 9d400fab96..7014de7c69 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -44,27 +44,27 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { */ /** - * total number of lines in file + * Total number of lines in file */ protected $_rowCount; /** - * running total number of un matched Conact + * Running total number of un matched Conact */ protected $_unMatchCount; /** - * array of unmatched lines + * Array of unmatched lines */ protected $_unMatch; /** - * total number of contacts with unparsed addresses + * Total number of contacts with unparsed addresses */ protected $_unparsedAddressCount; /** - * filename of mismatch data + * Filename of mismatch data * * @var string */ @@ -74,33 +74,33 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { protected $_statusFieldName; /** - * on duplicate + * On duplicate * * @var int */ public $_onDuplicate; /** - * dedupe rule group id to use if set + * Dedupe rule group id to use if set * * @var int */ public $_dedupeRuleGroupID = NULL; /** - * @param $tableName + * @param string $tableName * @param $mapper * @param int $mode * @param int $contactType * @param string $primaryKeyName * @param string $statusFieldName * @param int $onDuplicate - * @param null $statusID + * @param int $statusID * @param null $totalRowCount * @param bool $doGeocodeAddress * @param int $timeout * @param null $contactSubType - * @param null $dedupeRuleGroupID + * @param int $dedupeRuleGroupID * * @return mixed */ @@ -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 * @access public @@ -644,7 +644,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { } /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern @@ -729,7 +729,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param $fileName + * @param string $fileName * @param array $header * @param array $data * diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 2b47f9dea0..b15f5c212e 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 */ function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL, $mapperWebsiteType = NULL, $mapperRelatedContactWebsiteType = NULL @@ -123,7 +123,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -244,7 +244,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 * @@ -256,7 +256,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 * @@ -268,7 +268,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 * @@ -437,7 +437,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 * @param array $values the array of values belonging to this line @@ -1088,7 +1088,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -1096,7 +1096,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { function fini() {} /** - * check if an error in custom data + * Check if an error in custom data * * @param array $params * @param String $errorMessage A string containing all the error-fields. @@ -1317,7 +1317,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * check if an error in Core( non-custom fields ) field + * Check if an error in Core( non-custom fields ) field * * @param array $params * @param String $errorMessage A string containing all the error-fields. @@ -1588,7 +1588,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 @@ -1608,7 +1608,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * function to build error-message containing error-fields + * Build error-message containing error-fields * * @param String $errorName A string containing error-field name. * @param String $errorMessage A string containing all the error-fields, where the new errorName is concatenated. @@ -1626,7 +1626,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * method for creating contact + * Method for creating contact * * */ @@ -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 $params array reference to an array containing all the * values for import @@ -1796,7 +1796,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * convert any given date string to default date array. + * Convert any given date string to default date array. * * @param array $params has given date-format * @param array $formatted store formatted date in this array @@ -1811,7 +1811,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * format common params data to proper format to store. + * Format common params data to proper format to store. * * @param array $params contain record values. * @param array $formatted array of formatted data. @@ -2034,7 +2034,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * Function to generate status and error message for unparsed street address records. + * Generate status and error message for unparsed street address records. * * @param array $values the array of values belonging to each row * @param array $statusFieldName store formatted date in this array diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php index 73c242f11d..6c98c8d7a5 100644 --- a/CRM/Contact/Page/AJAX.php +++ b/CRM/Contact/Page/AJAX.php @@ -196,7 +196,7 @@ class CRM_Contact_Page_AJAX { } /** - * fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title + * Fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title */ static function getPCPList() { $name = CRM_Utils_Array::value('s', $_GET); @@ -317,7 +317,7 @@ class CRM_Contact_Page_AJAX { } /** - * fetch the custom field help + * Fetch the custom field help */ static function customField() { $fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer'); @@ -518,7 +518,7 @@ ORDER BY sort_name "; } /** - * delete custom value + * Delete custom value * */ static function deleteCustomValue() { @@ -537,7 +537,7 @@ ORDER BY sort_name "; } /** - * Function to perform enable / disable actions on record. + * Perform enable / disable actions on record. * */ static function enableDisable() { @@ -877,7 +877,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function to retrieve signature based on email id + * Retrieve signature based on email id */ static function getSignature() { $emailID = CRM_Utils_Type::escape($_REQUEST['emailID'], 'Positive'); @@ -896,7 +896,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function to process dupes. + * Process dupes. * */ static function processDupes() { @@ -980,7 +980,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function to retrieve a PDF Page Format for the PDF Letter form + * Retrieve a PDF Page Format for the PDF Letter form */ function pdfFormat() { $formatId = CRM_Utils_Type::escape($_REQUEST['formatId'], 'Integer'); @@ -991,7 +991,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function to retrieve Paper Size dimensions + * Retrieve Paper Size dimensions */ static function paperSize() { $paperSizeName = CRM_Utils_Type::escape($_REQUEST['paperSizeName'], 'String'); @@ -1036,7 +1036,7 @@ LIMIT {$offset}, {$rowCount} } /** - * @param $name + * @param string $name * * @return string */ @@ -1065,7 +1065,7 @@ LIMIT {$offset}, {$rowCount} } /** - * Function to 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 814cc0d8e8..916cc2d10a 100644 --- a/CRM/Contact/Page/CustomSearch.php +++ b/CRM/Contact/Page/CustomSearch.php @@ -89,7 +89,7 @@ ORDER By v.weight } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php index 13e38c458b..f46bcbd800 100644 --- a/CRM/Contact/Page/DedupeRules.php +++ b/CRM/Contact/Page/DedupeRules.php @@ -211,7 +211,7 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { } /** - * @param $id + * @param int $id */ function delete($id) { $ruleDao = new CRM_Dedupe_DAO_Rule(); diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index 0eb1cd07c1..fe703f7ba4 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -48,7 +48,7 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { static $_links = NULL; /** - * delete a saved search. + * Delete a saved search. * * @param int $id - id of saved search * @@ -125,7 +125,7 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Contact/Page/Task.php b/CRM/Contact/Page/Task.php index 1fe039b7ad..c1917d4e6e 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 * @access public diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index 2ebe283cb0..65619f6bb2 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { /** - * the id of the object being viewed (note/relationship etc) + * The id of the object being viewed (note/relationship etc) * * @int * @access protected @@ -48,7 +48,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { protected $_id; /** - * the contact id of the contact being viewed + * The contact id of the contact being viewed * * @int * @access protected @@ -259,7 +259,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { /** * Get meta details of the contact. * - * @param $contactId + * @param int $contactId * * @return array contact fields in fixed order * @access public @@ -278,7 +278,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { /** * @param $page - * @param null $contactID + * @param int $contactID */ static function checkUserPermission($page, $contactID = NULL) { // check for permissions @@ -316,7 +316,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { } /** - * @param $contactId + * @param int $contactId * @param bool $isDeleted * * @return string diff --git a/CRM/Contact/Page/View/CustomData.php b/CRM/Contact/Page/View/CustomData.php index 5b32014e8c..a23c6509d5 100644 --- a/CRM/Contact/Page/View/CustomData.php +++ b/CRM/Contact/Page/View/CustomData.php @@ -40,7 +40,7 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { /** - * the id of the object being viewed (note/relationship etc) + * The id of the object being viewed (note/relationship etc) * * @int * @access protected @@ -48,7 +48,7 @@ class CRM_Contact_Page_View_CustomData extends CRM_Core_Page { public $_groupId; /** - * class constructor + * Class constructor * * @return CRM_Contact_Page_View_CustomData */ @@ -57,7 +57,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 * @access public diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index a085c3e8b0..6c6b03c0c6 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -146,13 +146,13 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { } /** - * remove/ rejoin the group + * Remove/ rejoin the group * * @param int $groupContactId id of crm_group_contact * @param string $status this is the status that should be updated. * * $access public - * @param $contactID + * @param int $contactID * * @return bool */ diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php index 8a9e8ca44f..d71c72aca9 100644 --- a/CRM/Contact/Page/View/Note.php +++ b/CRM/Contact/Page/View/Note.php @@ -241,7 +241,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 * @access public diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php index 944a373f13..1ddb583b08 100644 --- a/CRM/Contact/Page/View/Relationship.php +++ b/CRM/Contact/Page/View/Relationship.php @@ -43,7 +43,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { static $_links = NULL; /** - * casid set if called from case context + * Casid set if called from case context * * @var int */ diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php index f1a07abcb5..4dc88e4f43 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; @@ -110,7 +110,7 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * build user dashboard + * Build user dashboard * * @return void * @access public @@ -201,7 +201,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 * diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 5c0a67de3b..b0190e3d47 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -50,7 +50,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -72,7 +72,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se ); /** - * formValues is the array returned by exportValues called on + * FormValues is the array returned by exportValues called on * the HTML_QuickForm_Controller for that page. * * @var array @@ -89,7 +89,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se protected $_contextMenu; /** - * params is the array in a value used by the search query creator + * Params is the array in a value used by the search query creator * * @var array * @access protected @@ -105,7 +105,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se protected $_returnProperties; /** - * represent the type of selector + * Represent the type of selector * * @var int * @access protected @@ -117,14 +117,14 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se protected $_query; /** - * group id + * Group id * * @var int */ protected $_ufGroupID; /** - * the public visible fields to be shown to the user + * The public visible fields to be shown to the user * * @var array * @access protected @@ -300,7 +300,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -329,7 +329,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -503,7 +503,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 enum $action the action being performed * @param int $offset the row number to start from @@ -1092,7 +1092,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont } /** - * name of export file. + * Name of export file. * * @param string $output type of output * @@ -1103,7 +1103,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 $_columnHeaders @@ -1182,7 +1182,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont /** * @param array $params * @param $action - * @param $sortID + * @param int $sortID * @param null $displayRelationshipType * @param string $queryOperator * diff --git a/CRM/Contact/Selector/Controller.php b/CRM/Contact/Selector/Controller.php index 9e078655e8..0d2aefa779 100644 --- a/CRM/Contact/Selector/Controller.php +++ b/CRM/Contact/Selector/Controller.php @@ -34,7 +34,7 @@ */ class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller { /** - * default function for qill, if needed to be implemented, we + * Default function for qill, if needed to be implemented, we * expect the subclass to do it * * @return string the status message diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index bd4118d53f..afaa3f82e9 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -50,7 +50,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -65,7 +65,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { static $_properties = array('contact_id', 'contact_type', 'display_name'); /** - * formValues is the array returned by exportValues called on + * FormValues is the array returned by exportValues called on * the HTML_QuickForm_Controller for that page. * * @var array @@ -74,7 +74,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { public $_formValues; /** - * params is the array in a value used by the search query creator + * Params is the array in a value used by the search query creator * * @var array * @access protected @@ -82,7 +82,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { public $_params; /** - * represent the type of selector + * Represent the type of selector * * @var int * @access protected @@ -92,7 +92,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { protected $_query; /** - * the public visible fields to be shown to the user + * The public visible fields to be shown to the user * * @var array * @access protected @@ -207,7 +207,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -224,7 +224,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -269,7 +269,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } /** - * returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount * * @param enum $action the action being performed * @param int $offset the row number to start from @@ -394,7 +394,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { } /** - * name of export file. + * Name of export file. * * @param string $output type of output * @@ -414,7 +414,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { /** * @param array $params * @param $action - * @param $sortID + * @param int $sortID * @param null $displayRelationshipType * @param string $queryOperator * diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index 835d4a8553..5b004e5eeb 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -113,7 +113,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 * @access public diff --git a/CRM/Contact/Task.php b/CRM/Contact/Task.php index 85b387e440..9d1b867201 100644 --- a/CRM/Contact/Task.php +++ b/CRM/Contact/Task.php @@ -67,7 +67,7 @@ class CRM_Contact_Task { COMMUNICATION_PREFS = 25; /** - * the task array + * The task array * * @var array * @static @@ -75,7 +75,7 @@ class CRM_Contact_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -310,7 +310,7 @@ class CRM_Contact_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 41e51d2768..eb5099e629 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -35,7 +35,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { /** - * static field for all the contribution information that we can potentially import + * Static field for all the contribution information that we can potentially import * * @var array * @static @@ -43,7 +43,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { static $_importableFields = NULL; /** - * static field for all the contribution information that we can potentially export + * Static field for all the contribution information that we can potentially export * * @var array * @static @@ -51,13 +51,13 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { static $_exportableFields = NULL; /** - * field for all the objects related to this contribution + * Field for all the objects related to this contribution * @var array of objects (e.g membership object, participant object) */ public $_relatedObjects = array(); /** - * field for the component - either 'event' (participant) or 'contribute' + * Field for the component - either 'event' (participant) or 'contribute' * (any item related to a contribution page e.g. membership, pledge, contribution) * This is used for composing messages because they have dependency on the * contribution_page or event page - although over time we may eliminate that @@ -70,7 +70,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * construct method */ /** - * class constructor + * Class constructor * * @access public * @return \CRM_Contribute_DAO_Contribution @@ -83,7 +83,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 @@ -289,7 +289,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 * @param array $ids the array that holds all the db ids @@ -544,7 +544,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 @@ -762,7 +762,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta /** * Delete the indirect records associated with this contribution first * - * @param $id + * @param int $id * * @return mixed|null $results no of deleted Contribution on success, false otherwise@access public * @static @@ -837,7 +837,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * @param array $input an assoc array of name/value pairs * @param array $duplicates (reference ) store ids of duplicate contribs * - * @param null $id + * @param int $id * * @return boolean true if duplicate, false otherwise * @access public @@ -884,7 +884,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 @@ -903,7 +903,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 * @@ -938,7 +938,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * add extra fields specific to contribtion + * Add extra fields specific to contribtion * * @static */ @@ -974,7 +974,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta } /** - * @param $pageID + * @param int $pageID * * @return array */ @@ -1002,7 +1002,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 * @@ -1040,7 +1040,7 @@ GROUP BY p.id } /** - * function to 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 * @@ -1061,7 +1061,7 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id } /** - * @param $contactID + * @param int $contactID * * @return array */ @@ -1170,7 +1170,7 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id } /** - * Function to get the contribution details for component export + * Get the contribution details for component export * * @param int $exportMode export mode * @param string $componentIds component ids @@ -1762,7 +1762,7 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ } /** - * @param $contactId + * @param int $contactId * @param bool $includeSoftCredit * * @return null|string @@ -1796,7 +1796,7 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ } /** - * Function to get individual id for onbehalf contribution + * Get individual id for onbehalf contribution * * @param int $contributionId contribution id * @param int $contributorId contributor id @@ -2535,7 +2535,7 @@ WHERE contribution_id = %1 "; } /** - * Function to check whether payment processor supports + * Check whether payment processor supports * cancellation of contribution subscription * * @param int $contributionId contribution id @@ -2569,7 +2569,7 @@ WHERE contribution_id = %1 "; } /** - * Function to check whether subscription is already cancelled + * Check whether subscription is already cancelled * * @param int $contributionId contribution id * @@ -2593,7 +2593,7 @@ WHERE contribution_id = %1 "; } /** - * Function to create all financial accounts entry + * Create all financial accounts entry * * @param array $params contribution object, line item array and params for trxn * @@ -2880,7 +2880,7 @@ WHERE contribution_id = %1 "; } /** - * Function to update all financial accounts entry + * Update all financial accounts entry * * @param array $params contribution object, line item array and params for trxn * @@ -3047,7 +3047,7 @@ WHERE contribution_id = %1 "; } /** - * Function to check status validation on update of a contribution + * Check status validation on update of a contribution * * @param array $values previous form values before submit * @@ -3081,7 +3081,7 @@ WHERE contribution_id = %1 "; } /** - * Function to delete contribution of contact + * Delete contribution of contact * * CRM-12155 * @@ -3137,7 +3137,7 @@ WHERE contribution_id = %1 "; } /** - * Function to validate financial type + * Validate financial type * * CRM-13231 * @@ -3168,10 +3168,10 @@ WHERE contribution_id = %1 "; * @param string $paymentType 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments */ /** - * @param $contributionId + * @param int $contributionId * @param $trxnsData * @param string $paymentType - * @param null $participantId + * @param int $participantId * * @return null|object */ @@ -3338,7 +3338,7 @@ WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']}) * @param $trxnObj * @param $activityType * @param $component - * @param $contributionId + * @param int $contributionId * * @throws CRM_Core_Exception */ @@ -3381,9 +3381,9 @@ WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']}) } /** - * function to get list of payments displayed by Contribute_Page_PaymentInfo + * Get list of payments displayed by Contribute_Page_PaymentInfo * - * @param $id + * @param int $id * @param $component * @param bool $getTrxnInfo * @param bool $usingLineTotal @@ -3494,10 +3494,10 @@ WHERE con.id = {$contributionId} } /** - * Function to get financial account id has 'Sales Tax Account is' + * Get financial account id has 'Sales Tax Account is' * account relationship with financial type * - * @param $financialTypeId + * @param int $financialTypeId * * @return FinancialAccountId */ diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index 5da726f46e..05f46693ab 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -35,7 +35,7 @@ class CRM_Contribute_BAO_Contribution_Utils { /** - * process payment after confirmation + * Process payment after confirmation * * @param CRM_Core_Form $form form object * @param array $paymentParams array with payment related key @@ -369,7 +369,7 @@ class CRM_Contribute_BAO_Contribution_Utils { } /** - * get the contribution details by month + * Get the contribution details by month * of the year * * @param int $param year @@ -413,7 +413,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 * @@ -457,7 +457,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) /** * @param array $params - * @param $contactID + * @param int $contactID * @param $mail */ static function createCMSUser(&$params, $contactID, $mail) { @@ -548,7 +548,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) } /** - * @param $apiParams + * @param array $apiParams * @param $mapper * @param string $type * @param bool $category @@ -832,7 +832,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = contrib.contact_id ) } /** - * @param $contactID + * @param int $contactID * * @return mixed */ diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 4218045fb7..594b7f645a 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 * @@ -62,7 +62,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 * @param boolean $is_active value we want to set the is_active field @@ -75,7 +75,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * @param $id + * @param int $id * @param $values */ static function setValues($id, &$values) { @@ -106,7 +106,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * send the emails + * Send the emails * * @param int $contactID contact id * @param array $values associated array of fields @@ -426,8 +426,8 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Construct the message to be sent by the send function * - * @param $tplParams - * @param $contactID + * @param array $tplParams + * @param int $contactID * @param $isTest * * @return array @@ -453,7 +453,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 * @param int $contactID contact id for contributor @@ -551,7 +551,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio } /** - * add the custom fields for contribution page (ie profile) + * Add the custom fields for contribution page (ie profile) * * @param int $gid uf group id * @param string $name @@ -698,7 +698,7 @@ WHERE entity_table = 'civicrm_contribution_page' } /** - * Function to check if contribution page contains payment + * Check if contribution page contains payment * processor that supports recurring payment * * @param int $contributionPageId Contribution Page Id @@ -726,7 +726,7 @@ WHERE entity_table = 'civicrm_contribution_page' } /** - * Function to get info for all sections enable/disable. + * Get info for all sections enable/disable. * * @param array $contribPageIds * @return array $info info regarding all sections. @@ -913,7 +913,7 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm } /** - * helper to determine if the page supports separate membership payments + * Helper to determine if the page supports separate membership payments * @param integer id form id * * @return bool isSeparateMembershipPayment diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index 1eeb9553f5..bda40a7557 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 * @@ -153,7 +153,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi } /** - * @param $id + * @param int $id * @param $mode * * @return array|null @@ -176,7 +176,7 @@ SELECT r.payment_processor_id } /** - * get the number of installment done/completed for each recurring contribution + * Get the number of installment done/completed for each recurring contribution * * @param array $ids (reference ) an array of recurring contribution ids * @@ -205,7 +205,7 @@ SELECT r.payment_processor_id /** * Delete Recurring contribution. * - * @param $recurId + * @param int $recurId * * @return bool * @access public @@ -323,7 +323,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 * @@ -360,7 +360,7 @@ SELECT r.payment_processor_id } /** - * @param $entityID + * @param int $entityID * @param string $entity * * @return null|Object diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index d47d492721..c0a7ac8a10 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 */ 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 * @@ -83,7 +83,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * delete soft credits + * Delete soft credits * * @param array $params * @@ -99,7 +99,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * @param $contact_id + * @param int $contact_id * @param int $isTest * * @return array @@ -140,9 +140,9 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * retrieve soft contributions for contribution record. + * Retrieve soft contributions for contribution record. * - * @param $contributionID + * @param int $contributionID * @param boolean $all include PCP data * * @return array of soft contribution ids, amounts, and associated contact ids @@ -198,7 +198,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio } /** - * @param $contributionID + * @param int $contributionID * @param bool $isPCP * * @return array @@ -315,8 +315,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * @param CRM_Core_Form $form * @param array $params - * @param $honoreeprofileId - * @param null $honorId + * @param int $honoreeprofileId + * @param int $honorId */ static function formatHonoreeProfileFields($form, $params, $honoreeprofileId, $honorId = NULL) { $profileContactType = CRM_Core_BAO_UFGroup::getContactType($honoreeprofileId); diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 3a565a5e31..71f094a5e4 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -35,12 +35,12 @@ 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 */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -127,7 +127,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { } /** - * delete premium Types + * Delete premium Types * * @param int $productID * @static diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index cc530da0db..6570d69dd5 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -35,14 +35,14 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { /** - * product information + * Product information * @var array * @static */ private static $productInfo; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -69,7 +69,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 * @param boolean $is_active value we want to set the is_active field @@ -82,9 +82,9 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * delete financial Types + * Delete financial Types * - * @param $premiumID + * @param int $premiumID * * @static */ @@ -98,12 +98,12 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * build Premium Block im Contribution Pages + * Build Premium Block im Contribution Pages * - * @param $form CRM_Core_Form - * @param $pageID + * @param CRM_Core_Form $form + * @param int $pageID * @param bool $formItems - * @param null $selectedProductID + * @param int $selectedProductID * @param null $selectedOption * * @static @@ -167,7 +167,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 @@ -208,9 +208,9 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Function to delete premium associated w/ contribution page. + * Delete premium associated w/ contribution page. * - * @param $contributionPageID + * @param int $contributionPageID * * @static */ @@ -242,7 +242,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { } /** - * Function to retrieve premium product and their options + * Retrieve premium product and their options * * @return array product and option arrays * @static diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index ac55537303..75a50b47e2 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -35,7 +35,7 @@ class CRM_Contribute_BAO_Query { /** - * static field for all the export/import contribution fields + * Static field for all the export/import contribution fields * * @var array * @static @@ -64,7 +64,7 @@ class CRM_Contribute_BAO_Query { } /** - * if contributions are involved, add the specific contribute fields + * If contributions are involved, add the specific contribute fields * * @param $query * @@ -684,7 +684,7 @@ class CRM_Contribute_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -954,7 +954,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 * * @access public * @@ -1109,7 +1109,7 @@ class CRM_Contribute_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) { } diff --git a/CRM/Contribute/Controller/Contribution.php b/CRM/Contribute/Controller/Contribution.php index e2eb836d2f..591d09bda9 100644 --- a/CRM/Contribute/Controller/Contribution.php +++ b/CRM/Contribute/Controller/Contribution.php @@ -47,7 +47,7 @@ class CRM_Contribute_Controller_Contribution extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Contribute/Controller/ContributionPage.php b/CRM/Contribute/Controller/ContributionPage.php index e9b3704e66..0c64db8ab7 100644 --- a/CRM/Contribute/Controller/ContributionPage.php +++ b/CRM/Contribute/Controller/ContributionPage.php @@ -47,7 +47,7 @@ class CRM_Contribute_Controller_ContributionPage extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Contribute/Controller/Search.php b/CRM/Contribute/Controller/Search.php index a1e6874a85..7d38a5ff34 100644 --- a/CRM/Contribute/Controller/Search.php +++ b/CRM/Contribute/Controller/Search.php @@ -47,7 +47,7 @@ class CRM_Contribute_Controller_Search extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 60df3ced40..6cb1ee5a64 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -53,7 +53,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_recurPaymentProcessors; /** - * array of processor options in the format id => array($id => $label) + * Array of processor options in the format id => array($id => $label) * WARNING it appears that the format used to differ to this and there are places in the code that * expect the old format. $this->_paymentProcessors provides the additional data which this * array seems to have provided in the past @@ -62,12 +62,12 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_processors; /** - * available payment processors with full details including the key 'object' indexed by their id + * Available payment processors with full details including the key 'object' indexed by their id * @var array */ protected $_paymentProcessors = array(); /** - * the id of the contribution that we are processing + * The id of the contribution that we are processing * * @var int * @public @@ -75,7 +75,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_id; /** - * the id of the premium that we are proceessing + * The id of the premium that we are proceessing * * @var int * @public @@ -88,7 +88,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_productDAO = NULL; /** - * the id of the note + * The id of the note * * @var int * @public @@ -96,7 +96,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_noteID; /** - * the id of the contact associated with this contribution + * The id of the contact associated with this contribution * * @var int * @public @@ -104,7 +104,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { 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 @@ -112,7 +112,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_ppID; /** - * the id of the pledge that we are processing + * The id of the pledge that we are processing * * @var int * @public @@ -120,7 +120,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_pledgeID; /** - * is this contribution associated with an online + * Is this contribution associated with an online * financial transaction * * @var boolean @@ -137,7 +137,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_options; /** - * stores the honor id + * Stores the honor id * * @var int * @public @@ -187,7 +187,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { protected $_cdType; /** - * array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should + * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should * be all in this array in order like * 'credit_card' => array('credit_card_number' ... * 'billing_details' => array('first_name' ... @@ -198,7 +198,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $billingFieldSets = array(); /** - * @param $id + * @param int $id */ public function showRecordLinkMesssage($id) { $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id'); @@ -213,7 +213,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { } /** - * @param $id + * @param int $id * @param $values */ public function buildValuesAndAssignOnline_Note_Type($id, &$values) { @@ -262,7 +262,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { } /** - * @param $id + * @param int $id * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find(); */ public function assignPremiumProduct($id) { //to get Premium id @@ -464,7 +464,7 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * @param $financialTypeId + * @param int $financialTypeId * * @return array */ @@ -480,8 +480,8 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * @param $financialTypeId - * @param $relationTypeId + * @param int $financialTypeId + * @param int $relationTypeId * * @return mixed */ @@ -600,7 +600,7 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * common block for setting up the parts of a form that relate to credit / debit card + * Common block for setting up the parts of a form that relate to credit / debit card * @throws Exception */ protected function assignPaymentRelatedVariables() { diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 0965885c78..2fc41c886e 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -194,13 +194,13 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * process the Premium Information + * Process the Premium Information * * @access public * * @param array $params - * @param $contributionID - * @param null $premiumID + * @param int $contributionID + * @param int $premiumID * @param null $options * @return void */ @@ -254,14 +254,14 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * process the Note + * Process the Note * * @access public * * @param array $params - * @param $contactID - * @param $contributionID - * @param null $contributionNoteID + * @param int $contactID + * @param int $contributionID + * @param int $contributionNoteID * * @return void */ @@ -282,7 +282,7 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * process the Common data + * Process the Common data * * @access public * @@ -334,7 +334,7 @@ class CRM_Contribute_Form_AdditionalInfo { } /** - * Function to send email receipt. + * Send email receipt. * * @form object of Contribution form. * diff --git a/CRM/Contribute/Form/AdditionalPayment.php b/CRM/Contribute/Form/AdditionalPayment.php index 664118c447..76b467bb1e 100644 --- a/CRM/Contribute/Form/AdditionalPayment.php +++ b/CRM/Contribute/Form/AdditionalPayment.php @@ -42,7 +42,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract public $_contributeMode = 'direct'; /** - * related component whose financial payment is being processed + * Related component whose financial payment is being processed * * @var string * @public @@ -50,7 +50,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract protected $_component = NULL; /** - * id of the component entity + * Id of the component entity */ public $_id = NULL; diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php index 3927f0294b..e12de626cc 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 * @access public diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 793b755cb1..bff0b39792 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -39,7 +39,7 @@ */ 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 @@ -47,7 +47,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_id; /** - * the id of the premium that we are processing + * The id of the premium that we are processing * * @var int * @public @@ -60,7 +60,7 @@ 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 @@ -68,7 +68,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_noteID; /** - * the id of the contact associated with this contribution + * The id of the contact associated with this contribution * * @var int * @public @@ -76,7 +76,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP 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 @@ -84,7 +84,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_ppID; /** - * the id of the pledge that we are processing + * The id of the pledge that we are processing * * @var int * @public @@ -92,7 +92,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_pledgeID; /** - * is this contribution associated with an online + * Is this contribution associated with an online * financial transaction * * @var boolean @@ -163,7 +163,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_lineItems; /** - * line item + * Line item * @todo explain why we use lineItem & lineItems * @var array */ @@ -184,7 +184,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_honoreeProfileType; /** - * array of billing panes to be displayed by billingBlock.tpl - currently this is likely to look like + * Array of billing panes to be displayed by billingBlock.tpl - currently this is likely to look like * array('Credit Card' => ts('Credit Card') or array('Direct Debit => ts('Direct Debit') * @todo billing details (address stuff) to be added when we stop hard coding the panes in billingBlock.tpl * @@ -193,14 +193,14 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $billingPane = array(); /** - * array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl + * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl * this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata * * @var array */ public $_paymentFields = array(); /** - * logged in user's email + * Logged in user's email * @var string */ public $userEmail; @@ -219,7 +219,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_priceSet; /** - * form defaults + * Form defaults * @todo can we define this a as protected? can we define higher up the chain * @var array */ @@ -232,7 +232,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP */ public $userDisplayName; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -936,7 +936,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -1818,7 +1818,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP } /** - * @param $paymentParams + * @param array $paymentParams * * @return array */ diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index 7978e02a0d..d0bbd3991e 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 * @public @@ -60,20 +60,20 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * * @param array $params * @param integer $contactID - * @param $financialTypeID + * @param int $financialTypeID * @param $online - * @param $contributionPageId + * @param int $contributionPageId * @param $nonDeductibleAmount - * @param $campaignId + * @param int $campaignId * @param $isMonetary * @param $pending * @param $paymentProcessorOutcome * @param $receiptDate - * @param $recurringContributionID + * @param int $recurringContributionID * @param $isTest - * @param $addressID - * @param $softCreditToID - * @param $lineItems + * @param int $addressID + * @param int $softCreditToID + * @param array $lineItems * * @return array */ @@ -159,7 +159,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 * @access public @@ -634,7 +634,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * overwrite action, since we are only showing elements in frozen mode + * Overwrite action, since we are only showing elements in frozen mode * no help display needed * * @return int @@ -1044,7 +1044,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * Pledges are not relevant to the membership code so that portion will not go onto the membership form. * * Comments from previous refactor indicate doubt as to what was going on - * @param $contributionTypeId + * @param int $contributionTypeId * * @return null|string */ @@ -1064,7 +1064,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * Process the form * - * @param $premiumParams + * @param array $premiumParams * @param $contribution * * @return void @@ -1600,7 +1600,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr } /** - * add on behalf of organization and it's location + * Add on behalf of organization and it's location * * @param $behalfOrganization array array of organization info * @param $contactID int individual contact id. One @@ -1849,7 +1849,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * And under certain circumstances sets * $this->_params['amount'] = null; * - * @param $priceSetID + * @param int $priceSetID * */ public function setFormAmountFields($priceSetID) { @@ -1949,7 +1949,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * Helper function for static submit function - set relevant params - help us to build up an array that we can pass in - * @param $id + * @param int $id * @param array $params * * @return array diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index 077b592f47..5856367631 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -57,7 +57,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu public $_useForMember; /** - * array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl + * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl * @var array */ public $_paymentFields = array(); @@ -66,7 +66,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 * @access public @@ -185,7 +185,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * set the default values + * Set the default values * * @return void * @access public @@ -628,7 +628,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu } /** - * build elements to enable pay on behalf of an organization. + * Build elements to enable pay on behalf of an organization. * * @access public */ @@ -650,7 +650,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 * * @access public * @@ -723,7 +723,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 * @param array $files the uploaded files if any diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index 057ed671c6..de77fe55f0 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 * @@ -123,7 +123,7 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { } /** - * build form for related contacts / on behalf of organization. + * Build form for related contacts / on behalf of organization. * * @param CRM_Core_Form $form * diff --git a/CRM/Contribute/Form/Contribution/ThankYou.php b/CRM/Contribute/Form/Contribution/ThankYou.php index 8386c5749e..0a107366ea 100644 --- a/CRM/Contribute/Form/Contribution/ThankYou.php +++ b/CRM/Contribute/Form/Contribution/ThankYou.php @@ -39,13 +39,13 @@ 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 * @access public @@ -75,7 +75,7 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont } /** - * overwrite action, since we are only showing elements in frozen mode + * Overwrite action, since we are only showing elements in frozen mode * no help display needed * * @return int diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index 2863ddce4a..fc582b1f86 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { /** - * the id of the contribution page that we are processsing + * The id of the contribution page that we are processsing * * @var int * @public @@ -48,7 +48,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_id; /** - * the mode that we are in + * The mode that we are in * * @var string * @protect @@ -56,7 +56,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_mode; /** - * the contact id related to a membership + * The contact id related to a membership * * @var int * @public @@ -64,7 +64,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_membershipContactID; /** - * the values for the contribution db object + * The values for the contribution db object * * @var array * @protected @@ -72,7 +72,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_values; /** - * the paymentProcessor attributes for this page + * The paymentProcessor attributes for this page * * @var array * @protected @@ -94,7 +94,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { */ protected $_separateMembershipPayment; /** - * the default values for the form + * The default values for the form * * @var array * @protected @@ -134,7 +134,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_amount; /** - * pcp id + * Pcp id * * @var integer * @public @@ -142,7 +142,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_pcpId; /** - * pcp block + * Pcp block * * @var array * @public @@ -150,7 +150,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_pcpBlock; /** - * pcp info + * Pcp info * * @var array * @public @@ -167,7 +167,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { protected $_userID; /** - * the Membership ID for membership renewal + * The Membership ID for membership renewal * * @var int * @public @@ -207,14 +207,14 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_contributeMode; /** - * contribution page supports memberships + * Contribution page supports memberships * @var boolean */ public $_useForMember; public $_isBillingAddressRequiredForPayLater; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -537,7 +537,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * set the default values + * Set the default values * * @return void * @access public @@ -547,7 +547,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 * @access public @@ -674,10 +674,10 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * add the custom fields + * Add the custom fields * - * @param $id - * @param $name + * @param int $id + * @param string $name * @param bool $viewOnly * @param null $profileContactType * @param null $fieldTypes @@ -840,7 +840,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { } /** - * authenticate pledge user during online payment. + * Authenticate pledge user during online payment. * * @access public * diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php index 7b99768c08..b9ccac4f3a 100644 --- a/CRM/Contribute/Form/ContributionCharts.php +++ b/CRM/Contribute/Form/ContributionCharts.php @@ -99,7 +99,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 * * @access public * diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index f8de7b74f4..759bfd30f0 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -47,7 +47,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_id; /** - * the pledgeBlock id saved to the session for an update + * The pledgeBlock id saved to the session for an update * * @var int * @access protected @@ -55,7 +55,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_pledgeBlockID; /** - * are we in single form mode or wizard mode? + * Are we in single form mode or wizard mode? * * @var boolean * @access protected @@ -63,7 +63,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_single; /** - * is this the first page? + * Is this the first page? * * @var boolean * @access protected @@ -71,7 +71,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { protected $_first = FALSE; /** - * store price set id. + * Store price set id. * * @var int * @access protected @@ -81,7 +81,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 * @access public diff --git a/CRM/Contribute/Form/ContributionPage/AddProduct.php b/CRM/Contribute/Form/ContributionPage/AddProduct.php index 23cb274571..ab5febcbe1 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 * * @access public * diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index f5a31d90c3..c433e49344 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_ContributionPage_Amount extends CRM_Contribute_Form_ContributionPage { /** - * contribution amount block. + * Contribution amount block. * * @var array * @access protected @@ -272,7 +272,7 @@ SELECT id } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index d4badeb181..317f474095 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -162,12 +162,12 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co } /** - * global form rule + * Global form rule * * @param array $fields the input form values * * @param $files - * @param $contributionPageId + * @param int $contributionPageId * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Delete.php b/CRM/Contribute/Form/ContributionPage/Delete.php index af5f825153..dd2968d340 100644 --- a/CRM/Contribute/Form/ContributionPage/Delete.php +++ b/CRM/Contribute/Form/ContributionPage/Delete.php @@ -39,7 +39,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_ContributionPage { /** - * page title + * Page title * * @var string * @protected @@ -53,7 +53,7 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co protected $_relatedContributions; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index 1292ad13a6..5953f5613b 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -111,7 +111,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 * diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index 23b64eb604..a880c93629 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 * @access public @@ -214,7 +214,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 * diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index 6cb44fb5ca..f65978fcfd 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -82,7 +82,7 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index 0eeba213a2..81e3801dad 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -206,7 +206,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 c1dd5d4e71..48daba2025 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 * @access public diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 3d91599933..55053c70b4 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 * * @access public * @@ -355,8 +355,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { * * @access private * - * @param $filename - * @param $resizedName + * @param string $filename + * @param string $resizedName * @param $width * @param $height * diff --git a/CRM/Contribute/Form/Search.php b/CRM/Contribute/Form/Search.php index f51c6426d0..8134f8c18c 100644 --- a/CRM/Contribute/Form/Search.php +++ b/CRM/Contribute/Form/Search.php @@ -43,7 +43,7 @@ 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 * @access protected @@ -51,7 +51,7 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -59,7 +59,7 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -69,13 +69,13 @@ 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 * @access public diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 17d480cd9f..6ffbf0e2e7 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 * @@ -192,7 +192,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 c40165afd6..6e69531fb1 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -89,7 +89,7 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { public $_includesSoftCredits = FALSE; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -197,7 +197,7 @@ class CRM_Contribute_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 title of the main button diff --git a/CRM/Contribute/Form/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index 0157e18127..a9ff7bcdaf 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -39,26 +39,26 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_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 * @access public @@ -212,7 +212,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index 553b778bc1..94147894fa 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 * @access public @@ -73,7 +73,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index 971d634b6d..4e9b4de737 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 * @access public @@ -86,7 +86,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 2e47f00053..ab3954d803 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -46,14 +46,14 @@ 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 * * @access public */ public $_contributionStatusId; /** - * gives the HTML template of PDF Invoice + * Gives the HTML template of PDF Invoice * * @access public */ @@ -67,12 +67,12 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { 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 * @access public @@ -227,7 +227,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 * @@ -246,7 +246,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index 13e42ab522..0280755732 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -49,7 +49,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 * @access public @@ -143,7 +143,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 * * @access public * @@ -229,7 +229,7 @@ AND {$this->_componentClause}"; } /** - * declaration of common variables for Invoice and PDF + * Declaration of common variables for Invoice and PDF * * @access public * diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index cbd70b25f0..18e4ea3020 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 * @access public @@ -163,7 +163,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index 04550ae7cd..32f3894733 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 * * @access public * @@ -154,7 +154,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF } /** - * check that the token only appears in a table cell. The '' separator cannot otherwise work + * Check that the token only appears in a table cell. The '' separator cannot otherwise work * Calculate the number of times it appears IN the cell & the number of times it appears - should be the same! * * @param $token @@ -296,7 +296,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF * @param array $contact * @param array $contributions * @param $groupBy - * @param $groupByID + * @param int $groupByID */ static function assignCombinedContributionValues($contact, $contributions, $groupBy, $groupByID) { if (!defined('CIVICRM_MAIL_SMARTY') || !CIVICRM_MAIL_SMARTY) { diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 4663fb2f38..247df5c68b 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -39,26 +39,26 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { /** - * the title of the group + * The title of the group * * @var string */ protected $_title; /** - * maximum contributions that should be allowed to update + * Maximum contributions that should be allowed to update * */ protected $_maxContributions = 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 * @access public @@ -122,7 +122,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 * @@ -135,7 +135,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/Print.php b/CRM/Contribute/Form/Task/Print.php index 31f058faf0..4671e979e2 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 * @access public @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Contribute/Form/Task/Result.php b/CRM/Contribute/Form/Task/Result.php index 52e85e5f11..01fc7912f3 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 * @access public diff --git a/CRM/Contribute/Form/Task/SearchTaskHookSample.php b/CRM/Contribute/Form/Task/SearchTaskHookSample.php index 6f046054cd..5bab672143 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 * @access public diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index f31c046b77..4c4b3938b6 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 * @access public @@ -183,7 +183,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 * @@ -215,7 +215,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 * * @access public * diff --git a/CRM/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index 96c0f0aa42..46986518c6 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 * @access public @@ -214,7 +214,7 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Contribute/Form/UpdateSubscription.php b/CRM/Contribute/Form/UpdateSubscription.php index d257c3df13..fbf5657883 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 * @public @@ -143,7 +143,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 * @access public diff --git a/CRM/Contribute/Import/Controller.php b/CRM/Contribute/Import/Controller.php index b46fde8e12..a28f43fa45 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Contribute/Import/Field.php b/CRM/Contribute/Import/Field.php index 718cc60745..4f6cd8aeaf 100644 --- a/CRM/Contribute/Import/Field.php +++ b/CRM/Contribute/Import/Field.php @@ -40,59 +40,59 @@ class CRM_Contribute_Import_Field { */ /** - * name of the field + * Name of the field */ public $_name; /** - * title of the field to be used in display + * Title of the field to be used in display */ public $_title; /** - * type of field + * Type of field * @var enum */ public $_type; /** - * is this field required + * Is this field required * @var boolean */ public $_required; /** - * data to be carried for use by a derived class + * Data to be carried for use by a derived class * @var object */ public $_payload; /** - * regexp to match the CSV header of this column/field + * Regexp to match the CSV header of this column/field * @var string */ public $_headerPattern; /** - * regexp to match the pattern of data from various column/fields + * Regexp to match the pattern of data from various column/fields * @var string */ public $_dataPattern; /** - * value of this field + * Value of this field * @var object */ public $_value; /** - * this is soft credit field + * This is soft credit field * @var string */ public $_softCreditField; /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern @@ -114,7 +114,7 @@ class CRM_Contribute_Import_Field { } /** - * the value is in string format. convert the value to the type of this field + * The value is in string format. convert the value to the type of this field * and set the field value with the appropriate type */ function setValue($value) { diff --git a/CRM/Contribute/Import/Form/DataSource.php b/CRM/Contribute/Import/Form/DataSource.php index fa7b216b0c..e35bfedb0a 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 * @access public diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index 603ced032e..af4e2954d0 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -337,7 +337,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 c039280087..ddd8c2554d 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 * @access public diff --git a/CRM/Contribute/Import/Form/Summary.php b/CRM/Contribute/Import/Form/Summary.php index dc12f89929..206dfcd432 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 * @access public diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index 309fad1fd3..4472039bb4 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -44,73 +44,73 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { protected $_fileName; /** - * imported file size + * Imported file size */ protected $_fileSize; /** - * seperator being used + * Seperator being used */ protected $_seperator; /** - * total number of lines in file + * Total number of lines in file */ protected $_lineCount; /** - * running total number of valid soft credit rows + * Running total number of valid soft credit rows */ protected $_validSoftCreditRowCount; /** - * running total number of invalid soft credit rows + * Running total number of invalid soft credit rows */ protected $_invalidSoftCreditRowCount; /** - * running total number of valid pledge payment rows + * Running total number of valid pledge payment rows */ protected $_validPledgePaymentRowCount; /** - * running total number of invalid pledge payment rows + * Running total number of invalid pledge payment rows */ protected $_invalidPledgePaymentRowCount; /** - * array of pledge payment error lines, bounded by MAX_ERROR + * Array of pledge payment error lines, bounded by MAX_ERROR */ protected $_pledgePaymentErrors; /** - * array of pledge payment error lines, bounded by MAX_ERROR + * Array of pledge payment error lines, bounded by MAX_ERROR */ protected $_softCreditErrors; /** - * filename of pledge payment error data + * Filename of pledge payment error data * * @var string */ protected $_pledgePaymentErrorsFileName; /** - * filename of soft credit error data + * Filename of soft credit error data * * @var string */ protected $_softCreditErrorsFileName; /** - * whether the file has a column header or not + * Whether the file has a column header or not * * @var boolean */ protected $_haveColumnHeader; /** - * @param $fileName + * @param string $fileName * @param string $seperator * @param $mapper * @param bool $skipColumnHeader @@ -438,7 +438,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 * @access public @@ -468,7 +468,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { } /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php index ad579f29e2..28670eadfa 100644 --- a/CRM/Contribute/Import/Parser/Contribution.php +++ b/CRM/Contribute/Import/Parser/Contribution.php @@ -55,7 +55,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa protected $_newContributions; /** - * class constructor + * Class constructor */ function __construct(&$mapperKeys, $mapperSoftCredit = NULL, $mapperPhoneType = NULL, $mapperSoftCreditType = NULL) { parent::__construct(); @@ -65,7 +65,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -136,7 +136,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 * @@ -148,7 +148,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 * @@ -160,7 +160,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 * @@ -236,7 +236,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 * @param array $values the array of values belonging to this line @@ -565,7 +565,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * process pledge payments + * Process pledge payments */ function processPledgePayments(&$formatted) { if (!empty($formatted['pledge_payment_id']) && !empty($formatted['pledge_id'])) { @@ -599,7 +599,7 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public diff --git a/CRM/Contribute/Page/ContributionPage.php b/CRM/Contribute/Page/ContributionPage.php index c958e280b7..98fcf165cf 100644 --- a/CRM/Contribute/Page/ContributionPage.php +++ b/CRM/Contribute/Page/ContributionPage.php @@ -622,7 +622,7 @@ ORDER BY title asc /** * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pager($whereClause, $whereParams) { @@ -648,7 +648,7 @@ SELECT count(id) /** * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pagerAtoZ($whereClause, $whereParams) { diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index e650b3a056..53454a7069 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -40,14 +40,14 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { /** - * financial types + * Financial types * @var array * @static */ private static $financialType; /** - * financial types + * Financial types * @var array * @static */ @@ -55,28 +55,28 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { /** - * financial types + * Financial types * @var array * @static */ private static $financialAccount; /** - * contribution pages + * Contribution pages * @var array * @static */ private static $contributionPageActive = NULL; /** - * contribution pages + * Contribution pages * @var array * @static */ private static $contributionPageAll = NULL; /** - * payment instruments + * Payment instruments * * @var array * @static @@ -84,7 +84,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { private static $paymentInstrument; /** - * contribution status + * Contribution status * * @var array * @static @@ -99,14 +99,14 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { private static $pcPage; /** - * status of personal campaign page + * Status of personal campaign page * @var array * @static */ private static $pcpStatus; /** - * contribution / financial batches + * Contribution / financial batches * @var array * @static */ @@ -119,7 +119,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * * @return array - array reference of all financial types if any * @static @@ -151,8 +151,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id - * @param null $financialAccountTypeId + * @param int $id + * @param int $financialAccountTypeId * @param string $retrieveColumn * @param string $key * @@ -273,7 +273,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $pageID + * @param int $pageID * @return array - array of all Premiums if any * @static */ @@ -321,7 +321,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param string $columnName * @return array - array reference of all contribution statuses * @static @@ -347,7 +347,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * * @param null $pageType - * @param null $id + * @param int $id * * @return array - array reference of all pcp if any * @static @@ -406,8 +406,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * - * @param $financialTypeId - * @param null $relationTypeId + * @param int $financialTypeId + * @param int $relationTypeId * @return array - array reference of all financial accounts for a Financial type */ public static function financialAccountType($financialTypeId, $relationTypeId = NULL) { @@ -437,7 +437,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @return array - array reference of all batches if any * @static */ diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 91307e36e0..1572ea3821 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -90,7 +90,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C ); /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -98,7 +98,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -106,7 +106,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -114,7 +114,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C protected $_context = NULL; /** - * what component context are we being invoked from + * What component context are we being invoked from * * @access protected * @var string @@ -122,7 +122,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C 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 @@ -131,7 +131,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C public $_queryParams; /** - * represent the type of selector + * Represent the type of selector * * @var int * @access protected @@ -217,7 +217,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * - View * - Edit * - * @param null $componentId + * @param int $componentId * @param null $componentAction * @param null $key * @param null $compContext @@ -263,7 +263,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -301,7 +301,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 enum $action the action being performed * @param int $offset the row number to start from @@ -436,7 +436,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -555,7 +555,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Contribute/StateMachine/Contribution.php b/CRM/Contribute/StateMachine/Contribution.php index f2ebf58390..af8c0a60dc 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_Contact_Import_Controller $controller * @param \const|int $action diff --git a/CRM/Contribute/StateMachine/ContributionPage.php b/CRM/Contribute/StateMachine/ContributionPage.php index a80348b113..16cfba1773 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 d3c323ee77..74165d3107 100644 --- a/CRM/Contribute/StateMachine/Search.php +++ b/CRM/Contribute/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -90,7 +90,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 * @access public diff --git a/CRM/Contribute/Task.php b/CRM/Contribute/Task.php index ff022de9a1..7b7b708f71 100644 --- a/CRM/Contribute/Task.php +++ b/CRM/Contribute/Task.php @@ -42,7 +42,7 @@ class CRM_Contribute_Task { CONST DELETE_CONTRIBUTIONS = 1, PRINT_CONTRIBUTIONS = 2, EXPORT_CONTRIBUTIONS = 3, BATCH_CONTRIBUTIONS = 4, EMAIL_CONTACTS = 5, UPDATE_STATUS = 6, PDF_RECEIPT = 7; /** - * the task array + * The task array * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Contribute_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -161,7 +161,7 @@ class CRM_Contribute_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index dbda3a7860..857f593f55 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -72,7 +72,7 @@ class CRM_Core_Action { //make sure MAX_ACTION = 2^n - 1 ( n = total number of actions ) /** - * map the action names to the relevant constant. We perform + * Map the action names to the relevant constant. We perform * bit manipulation operations so we can perform multiple * actions on the same object if needed * @@ -103,7 +103,7 @@ class CRM_Core_Action { ); /** - * the flipped version of the names array, initialized when used + * The flipped version of the names array, initialized when used * * @var array * @static @@ -111,7 +111,7 @@ class CRM_Core_Action { static $_description; /** - * called by the request object to translate a string into a mask + * Called by the request object to translate a string into a mask * * @param string $str the action to be resolved * @@ -188,7 +188,7 @@ class CRM_Core_Action { } /** - * given a set of links and a mask, return the html action string for + * Given a set of links and a mask, return the html action string for * the links associated with the mask * * @param array $links the set of link items @@ -199,7 +199,7 @@ class CRM_Core_Action { * * @param null $op * @param null $objectName - * @param null $objectId + * @param int $objectId * * @return string the html string * @access public @@ -305,7 +305,7 @@ class CRM_Core_Action { } /** - * given a string and an array of values, substitute the real values + * Given a string and an array of values, substitute the real values * in the placeholder in the str in the CiviCRM format * * @param string $str the string to be replaced @@ -323,7 +323,7 @@ class CRM_Core_Action { } /** - * get the mask for a permission (view, edit or null) + * Get the mask for a permission (view, edit or null) * * @param string the permission * diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 0e6340ad49..e6fd447e8b 100755 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { /** - * @param null $id + * @param int $id * * @return array */ @@ -262,7 +262,7 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { } /** - * @param null $id + * @param int $id * * @return array */ @@ -319,7 +319,7 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { * @param bool $namesOnly return simple list of names * * @param null $entityValue - * @param null $id + * @param int $id * * @return array (reference) reminder list * @static @@ -414,11 +414,11 @@ AND cas.entity_value = $id AND } /** - * @param $contactId + * @param int $contactId * @param $to - * @param $scheduleID + * @param int $scheduleID * @param $from - * @param $tokenParams + * @param array $tokenParams * * @return bool|null * @throws CRM_Core_Exception @@ -579,7 +579,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 * @param array $ids the array that holds all the db ids @@ -627,7 +627,7 @@ AND cas.entity_value = $id AND } /** - * delete a Reminder + * Delete a Reminder * * @param int $id ID of the Reminder to be deleted. * @@ -647,7 +647,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 * @param boolean $is_active value we want to set the is_active field @@ -660,7 +660,7 @@ AND cas.entity_value = $id AND } /** - * @param $mappingID + * @param int $mappingID * @param $now * * @throws CRM_Core_Exception @@ -895,7 +895,7 @@ WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL } /** - * @param $mappingID + * @param int $mappingID * @param $now * @param array $params * @@ -1397,8 +1397,8 @@ WHERE m.owner_membership_id IS NOT NULL AND } /** - * @param $id - * @param $mappingID + * @param int $id + * @param int $mappingID * * @return null|string */ @@ -1415,7 +1415,7 @@ WHERE m.owner_membership_id IS NOT NULL AND } /** - * @param $mappingID + * @param int $mappingID * @param $recipientType * * @return array diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 799b60c123..6987f96635 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 * @param boolean $fixAddress true if you need to fix (format) address values @@ -132,7 +132,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 * @param boolean $fixAddress true if you need to fix (format) address values @@ -196,7 +196,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 * @@ -653,7 +653,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, } /** - * get address sequence + * Get address sequence * * @return array of address sequence. */ @@ -872,7 +872,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 * @param int $contactId contact id @@ -943,7 +943,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 * @param array $params associated array of address params @@ -972,7 +972,7 @@ SELECT is_primary, } /** - * Function to 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 @@ -1046,7 +1046,7 @@ SELECT is_primary, } /** - * Function to check and set the status for shared address delete + * Check and set the status for shared address delete * * @param int $addressId address id * @param int $contactId contact id diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index c05cdd204f..8aeb8063ae 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -124,7 +124,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 * @param array $params associated array of submitted fields @@ -143,7 +143,7 @@ class CRM_Core_BAO_Block { } /** - * check if the current block exits + * Check if the current block exits * * @param string $blockName bloack name * @param array $params associated array of submitted fields @@ -162,7 +162,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 * @param int $contactId contact id @@ -205,12 +205,12 @@ 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 * @param array $params (reference ) an assoc array of name/value pairs * @param null $entity - * @param null $contactId + * @param int $contactId * * @return object CRM_Core_BAO_Block object on success, null otherwise * @access public @@ -386,7 +386,7 @@ class CRM_Core_BAO_Block { } /** - * delete block + * Delete block * * @param string $blockName block name * @param int $params associates array diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index 72c6152b00..6b9a9147be 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 * This behavior is misplaced in the BAO layer, but we'll preserve it to avoid @@ -221,7 +221,7 @@ class CRM_Core_BAO_CMSUser { } /** - * create CMS user using Profile + * Create CMS user using Profile * * @param array $params associated array * @param string $mail email id for cms user @@ -255,7 +255,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 integer $gid id of group of profile @@ -418,7 +418,7 @@ class CRM_Core_BAO_CMSUser { } /** - * Function to check if a cms user already exists. + * Check if a cms user already exists. * * @param Array $contact array of contact-details * diff --git a/CRM/Core/BAO/Cache.php b/CRM/Core/BAO/Cache.php index 7b13b49d37..60b9860eca 100644 --- a/CRM/Core/BAO/Cache.php +++ b/CRM/Core/BAO/Cache.php @@ -279,7 +279,7 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { */ /** - * @param $names + * @param string $names */ static function restoreSessionFromCache($names) { foreach ($names as $key => $sessionName) { diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 279a2fb860..7925db8b09 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -41,7 +41,7 @@ class CRM_Core_BAO_ConfigSetting { /** - * create civicrm settings. This is the same as add but it clears the cache and + * Create civicrm settings. This is the same as add but it clears the cache and * reloads the config object * * @param array $params associated array of civicrm variables @@ -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 { } /** - * Function to 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) * @param array $values associated array of civicrm variables stored in db @@ -196,7 +196,7 @@ class CRM_Core_BAO_ConfigSetting { } /** - * Function to retrieve the settings values from db + * Retrieve the settings values from db * * @param $defaults * @@ -653,7 +653,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 name of the component to be enabled, needs to be valid diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index f541e52388..dcdd91add8 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -122,7 +122,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 * @@ -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 * @param boolean $is_active Value we want to set the is_active field @@ -718,7 +718,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * * @param CRM_Core_Form $qf form object (reference) * @param string $elementName name of the custom field - * @param $fieldId + * @param int $fieldId * @param boolean $inactiveNeeded -deprecated * @param bool $useRequired true if required else false * @param boolean $search true if used for search else false @@ -1079,8 +1079,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $id the custom field id * @param int $options the assoc array of option name/value pairs * - * @param null $contactID - * @param null $fieldID + * @param int $contactID + * @param int $fieldID * * @return string the display value * @@ -1110,8 +1110,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param $html_type * @param $data_type * @param null $format - * @param null $contactID - * @param null $fieldID + * @param int $contactID + * @param int $fieldID * * @return array|mixed|null|string */ @@ -1310,7 +1310,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 * @param string $elementName custom field name @@ -1423,17 +1423,17 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * @param $contactID - * @param $cfID - * @param null $fileID + * @param int $contactID + * @param int $cfID + * @param int $fileID * @param bool $absolute * * @return array */ /** - * @param $contactID - * @param $cfID - * @param null $fileID + * @param int $contactID + * @param int $cfID + * @param int $fileID * @param bool $absolute * * @return array @@ -2026,7 +2026,7 @@ AND cf.id = %1"; } /** - * get custom option groups + * Get custom option groups * * @param array $includeFieldIds ids of custom fields for which * option groups must be included. @@ -2073,7 +2073,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 * @param int $optionGroupId option group id @@ -2100,7 +2100,7 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) } /** - * Function to check if option group is related to more than one + * Check if option group is related to more than one * custom field * * @param int $optionGroupId option group id @@ -2123,7 +2123,7 @@ WHERE option_group_id = {$optionGroupId}"; } /** - * @param $optionGroupId + * @param int $optionGroupId * @param $htmlType * * @return null|string @@ -2172,7 +2172,7 @@ ORDER BY html_type"; /** * @param array $params * @param $customFields - * @param $entityID + * @param int $entityID * @param $customFieldExtends * @param bool $inline * @@ -2438,7 +2438,7 @@ WHERE f.id IN ($ids)"; } /** - * @param $customId + * @param int $customId * * @return bool */ diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 72bd04a613..0a4de2ac9f 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 */ 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 * @@ -226,7 +226,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 * @param boolean $is_active value we want to set the is_active field @@ -1480,7 +1480,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 * @param array $groupTree the group tree object @@ -1516,7 +1516,7 @@ ORDER BY civicrm_custom_group.weight, } /** - * extract the get params from the url, validate + * Extract the get params from the url, validate * and store it in session * * @param CRM_Core_Form $form the form object @@ -1611,7 +1611,7 @@ ORDER BY civicrm_custom_group.weight, } /** - * check the type of custom field type (eg: Used for Individual, Contribution, etc) + * Check the type of custom field type (eg: Used for Individual, Contribution, etc) * this function is used to get the custom fields of a type (eg: Used for Individual, Contribution, etc ) * * @param int $customFieldId custom field id @@ -1794,9 +1794,9 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * @param CRM_Core_Form $form page object * @param array $groupTree associated array * @param boolean $returnCount true if customValue count needs to be returned - * @param null $gID + * @param int $gID * @param null $prefix - * @param null $customValueId + * @param int $customValueId * * @return array|int */ @@ -2222,8 +2222,8 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT } /** - * @param $customGroupId - * @param $entityId + * @param int $customGroupId + * @param int $entityId * * @return bool */ diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 0c7c0fb29b..07f3172a51 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -161,7 +161,7 @@ WHERE id = %1 } /** - * delete Option + * Delete Option * * param $optionId integer option id * @@ -280,8 +280,8 @@ SET {$dao->columnName} = REPLACE( {$dao->columnName}, %1, %2 )"; } /** - * @param $customFieldID - * @param null $optionGroupID + * @param int $customFieldID + * @param int $optionGroupID * * @return array */ diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index 8ca162022e..849c571ca2 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -38,21 +38,21 @@ class CRM_Core_BAO_CustomQuery { CONST PREFIX = 'custom_value_'; /** - * the set of custom field ids + * The set of custom field ids * * @var array */ protected $_ids; /** - * the select clause + * The select clause * * @var array */ public $_select; /** - * the name of the elements that are in the select clause + * The name of the elements that are in the select clause * used to extract the values * * @var array @@ -60,7 +60,7 @@ class CRM_Core_BAO_CustomQuery { public $_element; /** - * the tables involved in the query + * The tables involved in the query * * @var array */ @@ -68,7 +68,7 @@ class CRM_Core_BAO_CustomQuery { public $_whereTables; /** - * the where clause + * The where clause * * @var array */ @@ -130,7 +130,7 @@ class CRM_Core_BAO_CustomQuery { ); /** - * class constructor + * Class constructor * * Takes in a set of custom field ids andsets up the data structures to * generate a query @@ -255,7 +255,7 @@ SELECT label, value } /** - * generate the select clause and the associated tables + * Generate the select clause and the associated tables * for the from clause * * @param NULL @@ -323,7 +323,7 @@ SELECT label, value } /** - * generate the where clause and also the english language + * Generate the where clause and also the english language * equivalent * * @param NULL @@ -553,7 +553,7 @@ SELECT label, value } /** - * function that does the actual query generation + * Function that does the actual query generation * basically ties all the above functions together * * @param NULL @@ -586,10 +586,10 @@ SELECT label, value } /** - * @param $id + * @param int $id * @param $label * @param $type - * @param $fieldName + * @param string $fieldName * @param $value * @param $grouping */ diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index 597d0056a0..92cb6ae2a6 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -118,7 +118,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { } /** - * given a 'civicrm' type string, return the mysql data store area + * Given a 'civicrm' type string, return the mysql data store area * * @param string $type the civicrm type string * @@ -190,7 +190,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { } /** - * delet option value give an option value and custom group id + * Delet option value give an option value and custom group id * * @param int $customValueID custom value ID * @param int $customGroupID custom group ID diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index f836c13f09..d0ca3f6bfc 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_CustomValueTable { /** - * @param $customParams + * @param array $customParams * * @throws Exception */ @@ -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 the civicrm type string * @@ -308,7 +308,7 @@ class CRM_Core_BAO_CustomValueTable { /** * @param array $params * @param $entityTable - * @param $entityID + * @param int $entityID */ static function store(&$params, $entityTable, $entityID) { $cvParams = array(); @@ -355,7 +355,7 @@ class CRM_Core_BAO_CustomValueTable { * @param array $params * @param $customFields * @param $entityTable - * @param $entityID + * @param int $entityID * @param $customFieldExtends */ static function postProcess(&$params, &$customFields, $entityTable, $entityID, $customFieldExtends) { @@ -484,7 +484,7 @@ AND $cond } /** - * take in an array of entityID, custom_XXX => value + * Take in an array of entityID, custom_XXX => value * and set the value in the appropriate table. Should also be able * to set the value to null. Follows api parameter/return conventions * @@ -623,7 +623,7 @@ AND cf.id IN ( $fieldIDList ) } /** - * take in an array of entityID, custom_ID + * Take in an array of entityID, custom_ID * and gets the value from the appropriate table. * * To get the values of custom fields with IDs 13 and 43 for contact ID 1327, use: diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index f00a8421ab..15499fa83e 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 * @@ -186,7 +186,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 * @param string $operator @@ -260,7 +260,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 * @@ -329,11 +329,11 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Function to save changes made by use to the Dashlet + * Save changes made by use to the Dashlet * * @param array $columns associated array * - * @param null $contactID + * @param int $contactID * * @throws RuntimeException * @return void @@ -398,7 +398,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Function to add dashlets + * Add dashlets * * @param array $params associated array * @@ -533,7 +533,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * Function to reset dashlet cache + * Reset dashlet cache * * @param int $contactID reset cache only for specific contact * @@ -554,7 +554,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Delete Dashlet * - * @param $dashletID + * @param int $dashletID * * @return void * @static diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index c7da07bfb9..c68b1e7477 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 */ function __construct() { parent::__construct(); } /** - * delete the discount + * Delete the discount * * @param int $entityId * @param string $entityTable diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 72bf9c1573..736784d294 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -156,7 +156,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * Save the values of a domain * * @param array $params - * @param $id + * @param int $id * * @return array domain * @access public @@ -229,7 +229,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * @param $contactID + * @param int $contactID * * @return bool|null|object|string */ @@ -287,7 +287,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * @param $groupId + * @param int $groupId * * @return bool */ @@ -311,7 +311,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * retrieve a list of contact-ids that belongs to current domain/site. + * Retrieve a list of contact-ids that belongs to current domain/site. * * @return array */ diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index bd64e5f67d..b2a8e61045 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -58,7 +58,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 * @@ -232,7 +232,7 @@ ORDER BY e.is_primary DESC, email_id ASC "; } /** - * set / reset hold status for an email + * Set / reset hold status for an email * * @param object $email email object * diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 5c955b696c..0d6e8b256c 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 @@ -112,7 +112,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 * @@ -218,11 +218,11 @@ 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 * @param $entityTable - * @param $entityID + * @param int $entityID * * @return void * @access public @@ -282,7 +282,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * get contact tags + * Get contact tags */ static function getContactTags($contactID, $count = FALSE) { $contactTags = array(); @@ -315,7 +315,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * get child contact tags given parentId + * Get child contact tags given parentId */ static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') { $entityTags = array(); @@ -337,7 +337,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { } /** - * Function to merge two tags: tag B into tag A. + * Merge two tags: tag B into tag A. */ function mergeTags($tagAId, $tagBId) { $queryParams = array(1 => array($tagBId, 'Integer'), diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index 61bd52f8ba..2e3ddc0203 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -60,7 +60,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. * diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index 1178630047..e888505821 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -41,8 +41,8 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { static $_signableFields = array('entityTable', 'entityID', 'fileID'); /** - * @param $fileID - * @param $entityID + * @param int $fileID + * @param int $entityID * @param null $entityTable * * @return array @@ -74,9 +74,9 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { /** * @param $data - * @param $fileTypeID + * @param int $fileTypeID * @param $entityTable - * @param $entityID + * @param int $entityID * @param $entitySubtype * @param bool $overwrite * @param null|array $fileParams @@ -218,7 +218,7 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { } */ /** - * delete all the files and associated object associated with this + * Delete all the files and associated object associated with this * combination */ static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) { @@ -271,7 +271,7 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { } /** - * get all the files and associated object associated with this + * Get all the files and associated object associated with this * combination */ static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) { @@ -325,8 +325,8 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { /** * @param string $entityTable table-name or "*" (to reference files directly by file-id) * @param int $entityID - * @param null $fileTypeID - * @param null $fileID + * @param int $fileTypeID + * @param int $fileID * * @return array */ @@ -381,7 +381,7 @@ AND CEF.entity_id = %2"; /** * @param CRM_Core_Form $form * @param string $entityTable - * @param null $entityID + * @param int $entityID * @param null $numAttachments * @param bool $ajaxDelete */ @@ -457,7 +457,7 @@ AND CEF.entity_id = %2"; } /** - * return a clean url string and the number of attachment for a + * Return a clean url string and the number of attachment for a * given entityTable, entityID * * @param $entityTable string The entityTable to which the file is attached @@ -487,7 +487,7 @@ AND CEF.entity_id = %2"; * @param $formValues * @param array $params * @param $entityTable - * @param null $entityID + * @param int $entityID */ static function formatAttachment( &$formValues, @@ -540,7 +540,7 @@ AND CEF.entity_id = %2"; /** * @param array $params * @param $entityTable - * @param $entityID + * @param int $entityID */ static function processAttachment(&$params, $entityTable, $entityID) { $numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments'); @@ -585,9 +585,9 @@ AND CEF.entity_id = %2"; */ /** * @param $oldEntityTable - * @param $oldEntityId + * @param int $oldEntityId * @param $newEntityTable - * @param $newEntityId + * @param int $newEntityId */ static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) { $oldEntityFile = new CRM_Core_DAO_EntityFile(); @@ -606,8 +606,8 @@ AND CEF.entity_id = %2"; /** * @param $entityTable - * @param $entityID - * @param $fileID + * @param int $entityID + * @param int $fileID * * @return string */ @@ -622,7 +622,7 @@ AND CEF.entity_id = %2"; } /** - * delete a file attachment from an entity table / entity ID + * Delete a file attachment from an entity table / entity ID * * @static * @access public @@ -645,7 +645,7 @@ AND CEF.entity_id = %2"; /** - * function to display paper icon for a file attachment -- CRM-13624 + * Display paper icon for a file attachment -- CRM-13624 * * @param $entityTable string The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity" * If you have the ID of a specific row in civicrm_file, use $entityTable='*' diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index c6daefa77e..c58c06eadd 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { /** - * class constructor + * Class constructor * * @access public * @return \CRM_Financial_DAO_FinancialTrxn @@ -48,7 +48,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 * @@ -93,8 +93,8 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { } /** - * @param $contributionId - * @param null $contributionFinancialTypeId + * @param int $contributionId + * @param int $contributionFinancialTypeId * * @return array */ @@ -292,7 +292,7 @@ WHERE lt.entity_id = %1 "; /** * Delete financial transaction * - * @param $entity_id + * @param int $entity_id * @return true on success, false otherwise * @access public * @static @@ -311,7 +311,7 @@ WHERE ceft.entity_id = %1"; } /** - * create financial transaction for premium + * Create financial transaction for premium * * @access public * @static @@ -359,7 +359,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 * @@ -421,7 +421,7 @@ WHERE ceft.entity_id = %1"; * payment type : 'amount_owed' or 'refund_due' */ /** - * @param $entityId + * @param int $entityId * @param string $entityName * @param bool $returnType * @param null $lineItemTotal diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index e37eec8cdd..37552edab7 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 * diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 928d090f52..bfdc8dc728 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -39,14 +39,14 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * add the payment-processor type in the db + * Add the payment-processor type in the db * * @param array $params 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 * @param boolean $is_active value we want to set the is_active field diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index ce43759aa6..63ed8a678f 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; @@ -319,7 +319,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 * @@ -539,7 +539,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. * @param string $groupName group name diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index caf11dc2c1..de56bd6ce9 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { static $blocks = array('phone', 'email', 'im', 'openid', 'address'); /** - * create various elements of location block + * Create various elements of location block * * @param array $params (reference ) an assoc array of name/value pairs * @param boolean $fixAddress true if you need to fix (format) address values @@ -130,7 +130,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 * @access public * @static */ @@ -151,7 +151,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 * diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 687c6844ca..bb84bbf380 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -35,13 +35,13 @@ 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 */ function __construct() { parent::__construct(); @@ -68,7 +68,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 * @param boolean $is_active value we want to set the is_active field @@ -83,7 +83,7 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { } /** - * retrieve the default location_type + * Retrieve the default location_type * * @param NULL * @@ -117,7 +117,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 * @@ -145,7 +145,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 54ca8a133e..1ce2d7175a 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -40,7 +40,7 @@ class CRM_Core_BAO_Log extends CRM_Core_DAO_Log { static $_processed = NULL; /** - * @param $id + * @param int $id * @param string $table * * @return array|null @@ -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. * @@ -81,10 +81,10 @@ class CRM_Core_BAO_Log extends CRM_Core_DAO_Log { } /** - * @param $contactID - * @param $tableName - * @param $tableID - * @param null $userID + * @param int $contactID + * @param string $tableName + * @param int $tableID + * @param int $userID */ static function register($contactID, $tableName, @@ -151,7 +151,7 @@ UPDATE civicrm_log } /** - * get log record count for a Contact + * Get log record count for a Contact * * @param int $contactID * diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index 1e373c9d4c..b0e895b613 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 */ function __construct() { parent::__construct(); @@ -129,7 +129,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * add new mail Settings. + * Add new mail Settings. * * @param array $params reference array contains the values submitted by the form * @@ -164,7 +164,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 * @@ -187,7 +187,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * delete the mail settings. + * Delete the mail settings. * * @param int $id mail settings id * diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index af69c07c08..1940041d3e 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -62,7 +62,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * delete the mapping + * Delete the mapping * * @param int $id mapping id * @@ -90,7 +90,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 @@ -111,7 +111,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 * @@ -133,7 +133,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * get the mapping fields + * Get the mapping fields * * @param int $mappingId mapping id * @@ -236,7 +236,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * Function to build the mapping form + * Build the mapping form * * @param CRM_Core_Form $form * @param string $mappingType (Export/Import/Search Builder) @@ -1142,7 +1142,7 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { } /** - * save the mapping field info for search builder / export given the formvalues + * Save the mapping field info for search builder / export given the formvalues * * @param array $params asscociated array of formvalues * @param int $mappingId mapping id diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index d788f2c833..13b8360c16 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -74,7 +74,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 * @@ -96,12 +96,12 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * delete the Message Templates + * Delete the Message Templates * * @access public * @static * - * @param $messageTemplatesID + * @param int $messageTemplatesID * * @return object */ @@ -126,7 +126,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * get the Message Templates + * Get the Message Templates * * @access public * @static @@ -154,9 +154,9 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { } /** - * @param $contactId + * @param int $contactId * @param $email - * @param $messageTemplateID + * @param int $messageTemplateID * @param $from * * @return bool|null diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 66c874ad99..3add358f1c 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 */ 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 * @param boolean $is_active value we want to set the is_active field @@ -60,7 +60,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * get existing / build navigation for CiviCRM Admin Menu + * Get existing / build navigation for CiviCRM Admin Menu * * @static * @return array associated array @@ -81,7 +81,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { } /** - * add/update navigation record + * Add/update navigation record * * @param array associated array of submitted values * @@ -211,7 +211,7 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare } /** - * helper function for getNavigationList( ) + * Helper function for getNavigationList( ) * * @param array $list menu info * @param array $navigations navigation menus @@ -232,7 +232,7 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare } /** - * helper function for getNavigationList( ) + * Helper function for getNavigationList( ) * * @param string $val menu name * @param array $pidGroups parent menus @@ -253,7 +253,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 * @param int $parentID parent id @@ -306,7 +306,7 @@ ORDER BY parent_id, weight"; } /** - * Function to build menu + * Build menu * * @param boolean $json by default output is html * @param boolean $navigationMenu true when called for building top navigation menu @@ -450,7 +450,7 @@ ORDER BY parent_id, weight"; * Get Menu name * * @param $value - * @param $skipMenuItems + * @param array $skipMenuItems * @return bool|string */ static function getMenuName(&$value, &$skipMenuItems) { @@ -559,7 +559,7 @@ ORDER BY parent_id, weight"; } /** - * Function to create navigation for CiviCRM Admin Menu + * Create navigation for CiviCRM Admin Menu * * @param int $contactID contact id * @@ -659,7 +659,7 @@ ORDER BY parent_id, weight"; } /** - * Function to process navigation + * Process navigation * * @param array $params associated array, $_GET * @@ -693,7 +693,7 @@ ORDER BY parent_id, weight"; } /** - * Function to process move action + * Process move action * * @param $nodeID node that is being moved * @param $referenceID parent id where node is moved. 0 mean no parent @@ -758,7 +758,7 @@ ORDER BY parent_id, weight"; /** * Function to process rename action for tree * - * @param $nodeID + * @param int $nodeID * @param $label */ static function processRename($nodeID, $label) { @@ -766,9 +766,9 @@ ORDER BY parent_id, weight"; } /** - * Function to process delete action for tree + * Process delete action for tree * - * @param $nodeID + * @param int $nodeID */ static function processDelete($nodeID) { $query = "DELETE FROM civicrm_navigation WHERE id = {$nodeID}"; @@ -776,7 +776,7 @@ ORDER BY parent_id, weight"; } /** - * Function to get the info on navigation item + * Get the info on navigation item * * @param int $navigationID navigation id * @@ -795,7 +795,7 @@ ORDER BY parent_id, weight"; } /** - * Function to update menu + * Update menu * * @param array $params * @param array $newParams new value of params @@ -811,7 +811,7 @@ ORDER BY parent_id, weight"; } /** - * @param $cid + * @param int $cid * * @return object|string */ diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index be5af9e245..c7e3820142 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -39,13 +39,13 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** - * const the max number of notes we display at any given time + * Const the max number of notes we display at any given time * @var int */ CONST MAX_NOTES = 3; /** - * given a note id, retrieve the note text + * Given a note id, retrieve the note text * * @param int $id id of the note to retrieve * @@ -59,7 +59,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * given a note id, retrieve the note subject + * Given a note id, retrieve the note subject * * @param int $id id of the note to retrieve * @@ -73,7 +73,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * given a note id, decide if the note should be displayed based on privacy setting + * Given a note id, decide if the note should be displayed based on privacy setting * * @param object $note Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself * @@ -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 @@ -279,7 +279,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * delete the notes + * Delete the notes * * @param int $id note id * @param boolean $showStatus do we need to set status or not @@ -328,7 +328,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. * @@ -351,7 +351,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { } /** - * retrieve all records for this entity-id + * Retrieve all records for this entity-id * * @param int $id ID of the relationship for which records needs to be retrieved. * @@ -385,7 +385,7 @@ ORDER BY modified_date desc"; } /** - * get log record count for a Contact + * Get log record count for a Contact * * @param int $contactID * @@ -409,7 +409,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 * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents. @@ -514,7 +514,7 @@ ORDER BY modified_date desc"; } /** - * given a note id, get a list of the ids of all notes that are descendents of that note + * Given a note id, get a list of the ids of all notes that are descendents of that note * * @param int $parentId Id of the given note * @param array $ids (reference) one-dimensional array to store found descendent ids @@ -536,7 +536,7 @@ ORDER BY modified_date desc"; } /** - * function to 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 2f43ae48d0..bb0c0447c7 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 * diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index e3faeb246d..4cfa09f945 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -75,7 +75,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 * @param array $ids reference array contains the id @@ -107,7 +107,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. * @@ -128,7 +128,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 96c529a9b5..71b3975df8 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 */ function __construct() { parent::__construct(); @@ -142,7 +142,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 * @param boolean $is_active value we want to set the is_active field @@ -155,7 +155,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 * @param array $ids reference array contains the id @@ -222,7 +222,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * delete Option Value + * Delete Option Value * * @param int $optionValueId * @@ -242,7 +242,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 * @@ -280,7 +280,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * updates contacts affected by the option value passed. + * Updates contacts affected by the option value passed. * * @param Integer $optionValueId the option value id. * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED @@ -409,7 +409,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * updates options values weights. + * Updates options values weights. * * @param int $opGroupId * @param array $opWeights options value , weight pair diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index 9b61c28581..f19d1496dd 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; @@ -131,7 +131,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { } /** - * retrieve the default Paper Size values + * Retrieve the default Paper Size values * * @param NULL * @@ -327,7 +327,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 d6e0c436c2..0593ce7b1e 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; @@ -385,7 +385,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 c1972f08b9..ab786b14f4 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 * @param array $ids reference array contains the id diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 7f26b7307a..57712aeb1b 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -66,7 +66,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 * diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index eae4fd7f59..bdf26a4a53 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -35,12 +35,12 @@ 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 */ function __construct() { parent::__construct(); @@ -67,7 +67,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 * @param boolean $is_active value we want to set the is_active field @@ -82,7 +82,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 f27dad252d..52e36e57a4 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -42,7 +42,7 @@ class CRM_Core_BAO_PrevNextCache extends CRM_Core_DAO_PrevNextCache { * @param $cacheKey * @param $id1 * @param $id2 - * @param null $mergeId + * @param int $mergeId * @param null $join * @param null $where * @param bool $flip @@ -112,7 +112,7 @@ WHERE cacheKey = %3 AND } /** - * @param null $id + * @param int $id * @param null $cacheKey * @param string $entityTable */ @@ -248,8 +248,8 @@ WHERE cacheKey $op %1 } /** - * @param null $rgid - * @param null $gid + * @param int $rgid + * @param int $gid * @param null $cacheKeyString */ static function refillCache($rgid = NULL, $gid = NULL, $cacheKeyString = NULL) { @@ -395,7 +395,7 @@ WHERE cacheKey LIKE %1 AND is_selected = 1 } /** - * get the selections + * Get the selections * * @param string $cacheKey cache key * @param string $action action diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index b5b145488c..30df9808d9 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -133,7 +133,7 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { self::$status = $status; } /** - * save records in civicrm_recujrring_entity table + * Save records in civicrm_recujrring_entity table * * @param array $params reference array contains the values submitted by the form * diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 3ec0ff6efc..9dcae8fcda 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -245,8 +245,8 @@ class CRM_Core_BAO_SchemaHandler { } /** - * @param $tableName - * @param $fkTableName + * @param string $tableName + * @param string $fkTableName * * @return bool */ @@ -276,7 +276,7 @@ ALTER TABLE {$tableName} * @param array $params * @param $separator * @param $prefix - * @param $tableName + * @param string $tableName * * @return null|string */ @@ -362,7 +362,7 @@ ALTER TABLE {$tableName} } /** - * delete a civiCRM-table + * Delete a civiCRM-table * * @param String $tableName name of the table to be created. * @@ -377,8 +377,8 @@ ALTER TABLE {$tableName} } /** - * @param $tableName - * @param $columnName + * @param string $tableName + * @param string $columnName */ static function dropColumn($tableName, $columnName) { $sql = "ALTER TABLE $tableName DROP COLUMN $columnName"; @@ -386,7 +386,7 @@ ALTER TABLE {$tableName} } /** - * @param $tableName + * @param string $tableName * @param bool $dropUnique */ static function changeUniqueToIndex($tableName, $dropUnique = TRUE) { @@ -468,9 +468,9 @@ ADD UNIQUE INDEX `unique_entity_id` ( `entity_id` )"; } /** - * @param $customFieldID - * @param $tableName - * @param $columnName + * @param int $customFieldID + * @param string $tableName + * @param string $columnName * @param $length * * @throws Exception diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 2b1202c490..e15812b769 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', @@ -72,7 +72,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param int $contactID If set, this is a contactID specific setting, else its a global setting * @param bool|int $load if true, load from local cache (typically memcache) * - * @param null $domainID + * @param int $domainID * @param bool $force * * @return boolean true if item is already in cache @@ -123,9 +123,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * @param $values * @param $group - * @param null $componentID - * @param null $contactID - * @param null $domainID + * @param int $componentID + * @param int $contactID + * @param int $domainID * * @return string */ @@ -152,9 +152,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * @param $group * @param null $name - * @param null $componentID - * @param null $contactID - * @param null $domainID + * @param int $componentID + * @param int $contactID + * @param int $domainID * * @return CRM_Core_DAO_Domain|CRM_Core_DAO_Setting */ @@ -203,7 +203,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param string $defaultValue The default value to return for this setting if not present in DB * @param int $contactID If set, this is a contactID specific setting, else its a global setting * - * @param null $domainID + * @param int $domainID * * @return mixed The data if present in the setting table, else null * @static @@ -324,10 +324,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param string $group (required) The group name of the item * @param string $name (required) The name of the setting * @param int $componentID The optional component ID (so componenets can share the same name space) - * @param null $contactID + * @param int $contactID * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session * - * @param null $domainID + * @param int $domainID * * @return void * @static @@ -360,11 +360,11 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param array $metadata metadata describing this field * @param $value * @param $group - * @param $name - * @param null $componentID - * @param null $contactID - * @param null $createdID - * @param null $domainID + * @param string $name + * @param int $componentID + * @param int $contactID + * @param int $createdID + * @param int $domainID */ static function _setItem( $metadata, @@ -504,7 +504,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * gets metadata about the settings fields (from getfields) based on the fields being passed in + * Gets metadata about the settings fields (from getfields) based on the fields being passed in * * This function filters on the fields like 'version' & 'debug' that are not settings * @@ -757,7 +757,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * move an item from being in the config array to being stored as a setting + * Move an item from being in the config array to being stored as a setting * remove from config - as appropriate based on metadata * * Note that where the key name is being changed the 'legacy_key' will give us the old name @@ -799,9 +799,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * @param $group - * @param $name + * @param string $name * @param bool $system - * @param null $userID + * @param int $userID * @param bool $localize * @param string $returnField * @param bool $returnNameANDLabels @@ -861,10 +861,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * @param $group - * @param $name + * @param string $name * @param $value * @param bool $system - * @param null $userID + * @param int $userID * @param string $keyField */ static function setValueOption($group, @@ -905,7 +905,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * @param array $params - * @param null $domainID + * @param int $domainID */ static function fixAndStoreDirAndURL(&$params, $domainID = NULL) { if (self::isUpgradeFromPreFourOneAlpha1()) { @@ -1067,7 +1067,7 @@ AND domain_id = %3 * for a setting. * * @param $group - * @param $name + * @param string $name * @param $default * * @return mixed, NULL or an overriden value @@ -1083,7 +1083,7 @@ AND domain_id = %3 } /** - * civicrm_setting didn't exist before 4.1.alpha1 and this function helps taking decisions during upgrade + * Civicrm_setting didn't exist before 4.1.alpha1 and this function helps taking decisions during upgrade * * @return boolean */ diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index df2980d473..0983b663eb 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -121,7 +121,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * @param array $usedFor * @param bool $buildSelect * @param bool $all - * @param null $parentId + * @param int $parentId * * @return array */ @@ -181,7 +181,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * @param string $usedFor * @param array $tags - * @param null $parentId + * @param int $parentId * @param string $separator * * @return array @@ -263,7 +263,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * delete the tag + * Delete the tag * * @param int $id tag id * @@ -296,7 +296,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 @@ -371,7 +371,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 * @@ -392,7 +392,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { } /** - * get the tags that are not children of a tagset. + * Get the tags that are not children of a tagset. * * @return array $tags associated array of tag name and id@access public * @static diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 40cd04f808..c7398cde47 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -76,7 +76,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 * @param boolean $is_active value we want to set the is_active field @@ -120,7 +120,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 * @param $ids @@ -194,7 +194,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 * @param array $ids array containing the id @@ -268,7 +268,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * enable/disable profile field given a custom field id + * Enable/disable profile field given a custom field id * * @param int $customFieldId custom field id * @param boolean $is_active set the is_active field @@ -290,7 +290,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to copy existing profile fields to + * Copy existing profile fields to * new profile from the already built profile * * @param int $old_id from which we need to copy @@ -313,7 +313,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to 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 * @@ -335,7 +335,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to enable/disable profile field given a custom group id + * Enable/disable profile field given a custom group id * * @param int $customGroupId custom group id * @param boolean $is_active value we want to set the is_active field @@ -360,7 +360,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to check the status of custom field used in uf fields + * Check the status of custom field used in uf fields * * @param int $UFFieldId * @@ -389,7 +389,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to find out whether given profile group using Activity + * Find out whether given profile group using Activity * Profile fields with contact fields */ static function checkContactActivityProfileType($ufGroupId) { @@ -445,7 +445,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * Function to find out whether given profile group uses $required + * Find out whether given profile group uses $required * and/or $optional profile types * * @param integer $ufGroupId profile id @@ -559,7 +559,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * function to get the profile type (eg: individual/organization/household) + * Get the profile type (eg: individual/organization/household) * * @param int $ufGroupId uf group id * @param boolean $returnMixType this is true, then field type of mix profile field is returned @@ -583,7 +583,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * function to get the profile type (eg: individual/organization/household) + * Get the profile type (eg: individual/organization/household) * * @param string $ufGroupType * @param boolean $returnMixType this is true, then field type of mix profile field is returned @@ -690,7 +690,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; } /** - * function to check for mix profiles groups (eg: individual + other contact types) + * Check for mix profiles groups (eg: individual + other contact types) * * @param $ctype * diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 6446d1d575..bb96a3985e 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -42,7 +42,7 @@ 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 */ @@ -108,7 +108,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 * @param boolean $is_active value we want to set the is_active field @@ -122,7 +122,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 * @param int $mode mode @@ -177,7 +177,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 * @param int $visibility visibility of fields we are interested in @@ -682,7 +682,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 * @param string $title the title of the group we are interested in @@ -724,7 +724,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 * @param string $title the title of the group we are interested in @@ -876,7 +876,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 * @param int $id the current contact id (hence excluded from matching) @@ -902,7 +902,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * Given a contact id and a field set, return the values from the db * for this contact * - * @param $cid + * @param int $cid * @param array $fields the profile fields of interest * @param array $values the values for the above fields * @param boolean $searchable searchable or not @@ -1375,7 +1375,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 * @param array $ids reference array contains the id @@ -1418,7 +1418,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 * @param int $ufGroupId ufgroup id @@ -1488,7 +1488,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 * @param int $displayName if set return display name in array @@ -1552,7 +1552,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to 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 * @@ -1567,7 +1567,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to get the weight for ufjoin record + * Get the weight for ufjoin record * * @param int $ufGroupId if $ufGroupId get update weight or add weight * @@ -1597,7 +1597,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to get the uf group for a module + * Get the uf group for a module * * @param string $moduleName module name * @param int $count no to increment the weight @@ -1673,7 +1673,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to 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) * @param int $contactID @@ -1715,7 +1715,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to add profile field to a form + * Add profile field to a form * * @param CRM_Core_Form $form * @param array $field properties @@ -2220,7 +2220,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to set profile defaults + * Set profile defaults * * @param int $contactId contact id * @param array $fields associative array of fields @@ -2474,7 +2474,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to get profiles by type eg: pure Individual etc + * Get profiles by type eg: pure Individual etc * * @param array $types associative array of types eg: types('Individual') * @param boolean $onlyPure true if only pure profiles are required @@ -2502,7 +2502,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to check whether a profile is valid combination of + * Check whether a profile is valid combination of * required and/or optional profile types * * @param array $required array of types those are required @@ -2533,7 +2533,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to check whether a profile is valid combination of + * Check whether a profile is valid combination of * required profile fields * * @param array $ufId integer id of the profile @@ -2576,7 +2576,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to get default value for Register. + * Get default value for Register. * * @param $fields * @param $defaults @@ -2754,7 +2754,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to assign uf fields to template + * Assign uf fields to template * * @param int $gid group id * @param array $values @@ -2776,7 +2776,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @param array $params associated array * - * @param null $contactId + * @param int $contactId * * @return array $data assoicated formatted array * @access public @@ -2907,7 +2907,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * calculate the profile type 'group_type' as per profile fields. + * Calculate the profile type 'group_type' as per profile fields. * * @param int $gId profile id * @param bool $includeTypeValues @@ -2922,7 +2922,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * calculate the profile type 'group_type' as per profile fields. + * Calculate the profile type 'group_type' as per profile fields. * * @param $ufFields * @param bool $includeTypeValues @@ -3263,7 +3263,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to retrieve groups of profiles + * Retrieve groups of profiles * * @param integer $profileID id of the profile * @@ -3281,7 +3281,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) } /** - * Function to alter contact params by filtering existing subscribed groups and returns + * Alter contact params by filtering existing subscribed groups and returns * unsubscribed groups array for subscription. * * @param array $params contact params @@ -3355,7 +3355,7 @@ SELECT group_id } /** - * Function to check if we are rendering mixed profiles + * Check if we are rendering mixed profiles * * @param array $profileIds associated array of profile ids * @@ -3408,7 +3408,7 @@ SELECT group_id } /** - * Function to determine of we show overlay profile or not + * Determine of we show overlay profile or not * * @return boolean true if profile should be shown else false * @static @@ -3433,7 +3433,7 @@ SELECT group_id } /** - * function to get group type values of the profile + * Get group type values of the profile * * @param int $profileId * @param string $groupType @@ -3510,7 +3510,7 @@ SELECT group_id } /** - * get profiles used for batch entry + * Get profiles used for batch entry * * @return array profileIds profile ids * @static diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index 93df59978f..ee347199b9 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 8210c208fb..36a0dcdb93 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -357,7 +357,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 * @@ -484,7 +484,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 * @@ -508,7 +508,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 * @@ -540,7 +540,7 @@ AND domain_id = %4 } /** - * get the list of contact_id + * Get the list of contact_id * * * @return int contact_id on success, null otherwise @@ -558,10 +558,10 @@ AND domain_id = %4 } /** - * see if this user exists, and if so, if they're allowed to login + * See if this user exists, and if so, if they're allowed to login * * - * @param $openId + * @param int $openId * * @return bool true if allowed to login, false otherwise * @access public @@ -578,7 +578,7 @@ AND domain_id = %4 } /** - * get the next unused uf_id value, since the standalone UF doesn't + * Get the next unused uf_id value, since the standalone UF doesn't * have id's (it uses OpenIDs, which go in a different field) * * diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index f30131bf1a..0b2d83f27d 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 associated array * @param int $contactID contact id diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index d2543260ba..1d933ec2eb 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** - * class constructor + * Class constructor * * @access public * @return \CRM_Core_DAO_WordReplacement @@ -92,7 +92,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * Save the values of a WordReplacement * * @param array $params - * @param $id + * @param int $id * * @return WordReplacement array * @access public diff --git a/CRM/Core/Base.php b/CRM/Core/Base.php index ba103f8527..a09ec56892 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 */ function __construct() {} } diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index 92c81a3288..a865fda6df 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,18 +55,18 @@ 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 * */ function __construct() {} /** - * initialises the $_properties array + * Initialises the $_properties array * * @return void */ @@ -180,7 +180,7 @@ class CRM_Core_Block { } /** - * returns the desired property from the $_properties array + * Returns the desired property from the $_properties array * * @param int $id one of the class constants (ADD, SEARCH, etc.) * @param string $property the desired property @@ -195,7 +195,7 @@ class CRM_Core_Block { } /** - * sets the desired property in the $_properties array + * Sets the desired property in the $_properties array * * @param int $id one of the class constants (ADD, SEARCH, etc.) * @param string $property the desired property @@ -211,7 +211,7 @@ class CRM_Core_Block { } /** - * returns the whole $_properties array + * Returns the whole $_properties array * * @return array the $_properties array */ @@ -275,12 +275,12 @@ class CRM_Core_Block { } /** - * set the post action values for the block. + * Set the post action values for the block. * * php is lame and u cannot call functions from static initializers * hence this hack * - * @param $id + * @param int $id * * @return void * @access private @@ -332,7 +332,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 * @access private @@ -449,7 +449,7 @@ class CRM_Core_Block { } /** - * create the list of dashboard links + * Create the list of dashboard links * * @return void * @access private @@ -485,7 +485,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 * @access private @@ -518,7 +518,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 * @access private @@ -534,7 +534,7 @@ class CRM_Core_Block { } /** - * create the event blocks for upcoming events + * Create the event blocks for upcoming events * * @return void * @access private diff --git a/CRM/Core/CodeGen/Specification.php b/CRM/Core/CodeGen/Specification.php index 1818d3c52d..97453d1803 100644 --- a/CRM/Core/CodeGen/Specification.php +++ b/CRM/Core/CodeGen/Specification.php @@ -105,7 +105,7 @@ class CRM_Core_CodeGen_Specification { /** * @param $tables - * @param $classNames + * @param string $classNames */ function resolveForeignKeys(&$tables, &$classNames) { foreach (array_keys($tables) as $name) { @@ -115,8 +115,8 @@ class CRM_Core_CodeGen_Specification { /** * @param $tables - * @param $classNames - * @param $name + * @param string $classNames + * @param string $name */ function resolveForeignKey(&$tables, &$classNames, $name) { if (!array_key_exists('foreignKey', $tables[$name])) { @@ -156,8 +156,8 @@ class CRM_Core_CodeGen_Specification { /** * @param $tables - * @param $valid - * @param $name + * @param int $valid + * @param string $name * * @return bool */ @@ -415,7 +415,7 @@ class CRM_Core_CodeGen_Specification { } /** - * @param $name + * @param string $name * * @return string */ @@ -534,7 +534,7 @@ class CRM_Core_CodeGen_Specification { * @param $foreignXML * @param $fields * @param $foreignKeys - * @param $currentTableName + * @param string $currentTableName */ function getForeignKey(&$foreignXML, &$fields, &$foreignKeys, &$currentTableName) { $name = trim((string ) $foreignXML->name); @@ -591,7 +591,7 @@ class CRM_Core_CodeGen_Specification { /** * @param $attributes * @param $object - * @param $name + * @param string $name * @param null $pre * @param null $post */ diff --git a/CRM/Core/Component.php b/CRM/Core/Component.php index f643e847bb..e6dbbf8b0d 100644 --- a/CRM/Core/Component.php +++ b/CRM/Core/Component.php @@ -70,7 +70,7 @@ class CRM_Core_Component { } /** - * @param $name + * @param string $name * @param null $attribute * * @return mixed @@ -234,7 +234,7 @@ class CRM_Core_Component { } /** - * @param $componentName + * @param string $componentName * * @return mixed */ @@ -249,7 +249,7 @@ class CRM_Core_Component { } /** - * @param $componentID + * @param int $componentID * * @return int|null|string */ @@ -285,7 +285,7 @@ class CRM_Core_Component { /** * @param $query - * @param $fnName + * @param string $fnName */ static function alterQuery(&$query, $fnName) { $info = self::_info(); @@ -299,7 +299,7 @@ class CRM_Core_Component { } /** - * @param $fieldName + * @param string $fieldName * @param $mode * @param $side * @@ -361,7 +361,7 @@ class CRM_Core_Component { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) { $info = self::_info(); @@ -417,7 +417,7 @@ class CRM_Core_Component { } /** - * handle table dependencies of components + * Handle table dependencies of components * * @param array $tables array of tables * @@ -437,7 +437,7 @@ class CRM_Core_Component { } /** - * get components info from info file + * Get components info from info file * */ static function getComponentsFromFile($crmFolderDir) { diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index d4505be760..ffc6a9abd1 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -50,28 +50,28 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /// /** - * the dsn of the database connection + * The dsn of the database connection * * @var string */ public $dsn; /** - * the name of user framework + * The name of user framework * * @var string */ public $userFramework = 'Drupal'; /** - * the name of user framework url variable name + * The name of user framework url variable name * * @var string */ public $userFrameworkURLVar = 'q'; /** - * the dsn of the database connection for user framework + * The dsn of the database connection for user framework * * @var string */ @@ -109,7 +109,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /// /** - * are we initialized and in a proper state + * Are we initialized and in a proper state * * @var string */ @@ -121,7 +121,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { public $customPHPPathDir; /** - * the factory class used to instantiate our DB objects + * The factory class used to instantiate our DB objects * * @var string */ @@ -134,7 +134,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { private static $_log = NULL; /** - * the handle on the mail handler that we are using + * The handle on the mail handler that we are using * * @var object */ @@ -401,7 +401,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * initialize the DataObject framework + * Initialize the DataObject framework * * @return void * @access private @@ -418,7 +418,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * returns the singleton logger for the application + * Returns the singleton logger for the application * * @param * @access private @@ -434,7 +434,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * initialize the config variables + * Initialize the config variables * * @return void * @access private @@ -662,7 +662,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * verify that the needed parameters are not null in the config + * Verify that the needed parameters are not null in the config * * @param CRM_Core_Config (reference ) the system config object * @param array (reference ) the parameters that need a value @@ -681,7 +681,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * reset the serialized array and recompute + * Reset the serialized array and recompute * use with care */ function reset() { @@ -701,7 +701,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * one function to get domain ID + * One function to get domain ID */ static function domainID($domainID = NULL, $reset = FALSE) { static $domain; @@ -716,7 +716,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * do general cleanup of caches, temp directories and temp tables + * Do general cleanup of caches, temp directories and temp tables * CRM-8739 */ function cleanupCaches($sessionReset = TRUE) { @@ -772,7 +772,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * clear db cache + * Clear db cache */ public static function clearDBCache() { $queries = array( @@ -796,7 +796,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * clear leftover temporary tables + * Clear leftover temporary tables */ public static function clearTempTables() { // CRM-5645 @@ -827,7 +827,7 @@ AND } /** - * check if running in upgrade mode + * Check if running in upgrade mode */ static function isUpgradeMode($path = NULL) { if (defined('CIVICRM_UPGRADE_ACTIVE')) { diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php index c690bcc82b..f04a1256f0 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 * * @access public * @static @@ -106,7 +106,7 @@ class CRM_Core_Config_Defaults { } /** - * set the default values + * Set the default values * * @param array $defaults associated array of form elements * @param bool|\boolena $formMode this funtion is called to set default diff --git a/CRM/Core/Config/Variables.php b/CRM/Core/Config/Variables.php index 7afd1b42b8..2f826600b9 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; @@ -262,7 +262,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { public $userFrameworkLogging = FALSE; /** - * the handle for import file size + * The handle for import file size * @var int */ public $maxImportFileSize = 1048576; @@ -357,49 +357,49 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { public $enableSSL = FALSE; /** - * error template to use for fatal errors + * Error template to use for fatal errors * * @var string */ public $fatalErrorTemplate = 'CRM/common/fatal.tpl'; /** - * fatal error handler + * Fatal error handler * * @var string */ public $fatalErrorHandler = NULL; /** - * legacy encoding for file encoding conversion + * Legacy encoding for file encoding conversion * * @var string */ public $legacyEncoding = 'Windows-1252'; /** - * field separator for import/export csv file + * Field separator for import/export csv file * * @var string */ public $fieldSeparator = ','; /** - * max location blocks in address + * Max location blocks in address * * @var integer */ public $maxLocationBlocks = 2; /** - * the font path where captcha fonts are stored + * The font path where captcha fonts are stored * * @var string */ public $captchaFontPath = '/usr/X11R6/lib/X11/fonts/'; /** - * the font to use for captcha + * The font to use for captcha * * @var string */ @@ -422,7 +422,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { public $dashboardCacheTimeout = 1440; /** - * flag to indicate if acl cache is NOT to be reset + * Flag to indicate if acl cache is NOT to be reset */ public $doNotResetCache = 0; @@ -434,19 +434,19 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults { public $oldInputStyle = 1; /** - * should we disable key generation for forms + * Should we disable key generation for forms * * @var boolean */ public $formKeyDisable = FALSE; /** - * to determine whether the call is from cms or civicrm + * To determine whether the call is from cms or civicrm */ public $inCiviCRM = FALSE; /** - * component registry object (of CRM_Core_Component type) + * Component registry object (of CRM_Core_Component type) */ public $componentRegistry = NULL; diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index ddf95f60e7..d9715e457f 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -52,7 +52,7 @@ require_once 'HTML/QuickForm/Action/Direct.php'; class CRM_Core_Controller extends HTML_QuickForm_Controller { /** - * the title associated with this controller + * The title associated with this controller * * @var string */ @@ -66,14 +66,14 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { public $_key; /** - * the name of the session scope where values are stored + * The name of the session scope where values are stored * * @var object */ protected $_scope; /** - * the state machine associated with this controller + * The state machine associated with this controller * * @var object */ @@ -121,14 +121,14 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { public $_QFResponseType = 'html'; /** - * cache the smarty template for efficiency reasons + * Cache the smarty template for efficiency reasons * * @var CRM_Core_Smarty */ static protected $_template; /** - * cache the session for efficiency reasons + * Cache the session for efficiency reasons * * @var CRM_Core_Session */ @@ -284,7 +284,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * @param $name + * @param string $name * @param bool $addSequence * @param bool $ignoreKey * @@ -407,7 +407,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * getter method for stateMachine + * Getter method for stateMachine * * @return CRM_Core_StateMachine * @access public @@ -417,7 +417,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * setter method for stateMachine + * Setter method for stateMachine * * @param CRM_Core_StateMachine $stateMachine * @@ -429,7 +429,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * add pages to the controller. Note that the controller does not really care + * Add pages to the controller. Note that the controller does not really care * the order in which the pages are added * * @param CRM_Core_StateMachine $stateMachine @@ -494,7 +494,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * destroy all the session state of the controller. + * Destroy all the session state of the controller. * * @access public * @@ -506,7 +506,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * virtual function to do any processing of data. + * Virtual function to do any processing of data. * Sometimes it is useful for the controller to actually process data. * This is typically used when we need the controller to figure out * what pages are potentially involved in this wizard. (this is dynamic @@ -605,7 +605,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * assign value to name in template + * Assign value to name in template * * @param string $var * @param mixed $value value of varaible @@ -618,7 +618,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * assign value to name in template by reference + * Assign value to name in template by reference * * @param string $var * @param mixed $value (reference) value of varaible @@ -631,7 +631,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * appends values to template variables + * Appends values to template variables * * @param array|string $tpl_var the template variable name(s) * @param mixed $value the value to append @@ -653,7 +653,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * setter for embedded + * Setter for embedded * * @param boolean $embedded * @@ -665,7 +665,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * getter for embedded + * Getter for embedded * * @return boolean return the embedded value * @access public @@ -675,7 +675,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * setter for skipRedirection + * Setter for skipRedirection * * @param boolean $skipRedirection * @@ -687,7 +687,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * getter for skipRedirection + * Getter for skipRedirection * * @return boolean return the skipRedirection value * @access public @@ -726,7 +726,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * setter for print + * Setter for print * * @param boolean $print * @@ -744,7 +744,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * getter for print + * Getter for print * * @return boolean return the print value * @access public diff --git a/CRM/Core/Controller/Simple.php b/CRM/Core/Controller/Simple.php index 2536aa324f..f3319021e8 100644 --- a/CRM/Core/Controller/Simple.php +++ b/CRM/Core/Controller/Simple.php @@ -39,7 +39,7 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller { /** - * constructor + * Constructor * * @param null $path * @param bool $title diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index d413b5fa4f..57259e16b8 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -45,7 +45,7 @@ require_once 'CRM/Core/I18n.php'; class CRM_Core_DAO extends DB_DataObject { /** - * a null object so we can pass it as reference if / when needed + * A null object so we can pass it as reference if / when needed */ static $_nullObject = NULL; static $_nullArray = array(); @@ -69,7 +69,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; @@ -88,14 +88,14 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * empty definition for virtual function + * Empty definition for virtual function */ static function getTableName() { return NULL; } /** - * initialize the DAO object + * Initialize the DAO object * * @param string $dsn the database connection string * @@ -112,7 +112,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * @param $fieldName + * @param string $fieldName * @param $fieldDef * @param array $params * @@ -268,7 +268,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * reset the DAO object. DAO is kinda crappy in that there is an unwritten + * Reset the DAO object. DAO is kinda crappy in that there is an unwritten * rule of one query per DAO. We attempt to get around this crappy restricrion * by resetting some of DAO's internal fields. Use this with caution * @@ -292,7 +292,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * @param $tableName + * @param string $tableName * * @return string */ @@ -398,7 +398,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * returns list of FK relationships + * Returns list of FK relationships * * @static * @access public @@ -410,7 +410,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * returns all the column names of this table + * Returns all the column names of this table * * @access public * @@ -422,7 +422,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * get/set an associative array of table columns + * Get/set an associative array of table columns * * @access public * @param array key=>type array @@ -570,7 +570,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * create an attribute for this specific field. We only do this for strings and text + * Create an attribute for this specific field. We only do this for strings and text * * @param array $field the field under task * @@ -1085,7 +1085,7 @@ FROM civicrm_domain } /** - * execute a query + * Execute a query * * @param string $query query to be executed * @@ -1139,7 +1139,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 * @param array $params @@ -1388,7 +1388,7 @@ FROM civicrm_domain * since its used for things like send email * * @param $componentIDs - * @param $tableName + * @param string $tableName * * @return array */ @@ -1418,7 +1418,7 @@ SELECT contact_id * * @param string $daoName name of the dao object * @param string $fieldIdName - * @param $fieldId + * @param int $fieldId * @param $details * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') * @@ -1600,7 +1600,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 @@ -2105,7 +2105,7 @@ SELECT contact_id } /** - * @param $fieldName + * @param string $fieldName * @return bool|array */ function getFieldSpec($fieldName) { diff --git a/CRM/Core/DAO/Factory.php b/CRM/Core/DAO/Factory.php index b389988335..a40b31d034 100644 --- a/CRM/Core/DAO/Factory.php +++ b/CRM/Core/DAO/Factory.php @@ -23,7 +23,7 @@ class CRM_Core_DAO_Factory { static $_suffix = '.php'; /** - * @param $className + * @param string $className * * @return mixed * @throws Exception diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index a5e1481533..380f9e17ef 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -73,7 +73,7 @@ class CRM_Exception extends PEAR_Exception { class CRM_Core_Error extends PEAR_ErrorStack { /** - * status code of various types of errors + * Status code of various types of errors * @var const */ CONST FATAL_ERROR = 2; @@ -103,7 +103,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { public static $modeException = NULL; /** - * singleton function used to manage this object. + * Singleton function used to manage this object. * * @param null $package * @param bool $msgCallback @@ -122,7 +122,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * constructor + * Constructor */ function __construct() { parent::__construct('CiviCRM'); @@ -168,7 +168,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * create the main callback method. this method centralizes error processing. + * Create the main callback method. this method centralizes error processing. * * the errors we expect are from the pear modules DB, DB_DataObject * which currently use PEAR::raiseError to notify of error messages. @@ -298,7 +298,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * display an error page with an error message describing what happened + * Display an error page with an error message describing what happened * * @param string $message the error message * @param string $code the error code if any @@ -385,7 +385,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * display an error page with an error message describing what happened + * Display an error page with an error message describing what happened * * This function is evil -- it largely replicates fatal(). Hopefully the * entire CRM_Core_Error system can be hollowed out and replaced with @@ -458,7 +458,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * outputs pre-formatted debug information. Flushes the buffers + * Outputs pre-formatted debug information. Flushes the buffers * so we can interrupt a potential POST/redirect * * @param string name of debug section @@ -557,7 +557,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * display the error message on terminal + * Display the error message on terminal * * @param $message * @param bool $out should we log or return the output @@ -798,7 +798,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { * @param $message * @param int $code * @param string $level - * @param null $params + * @param array $params * * @return object */ @@ -835,7 +835,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * reset the error stack + * Reset the error stack * * @access public * @static diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index d2944122eb..2617c25793 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -74,7 +74,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { protected $_action; /** - * the renderer used for this form + * The renderer used for this form * * @var object */ @@ -96,7 +96,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { protected $_dateFields = array(); /** - * cache the smarty template for efficiency reasons + * Cache the smarty template for efficiency reasons * * @var CRM_Core_Smarty */ @@ -127,7 +127,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { public $controller; /** - * constants for attributes for various form elements + * Constants for attributes for various form elements * attempt to standardize on the number of variations that we * use of the below form elements * @@ -205,7 +205,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add one or more css classes to the form - * @param $className + * @param string $className */ public function addClass($className) { $classes = $this->getAttribute('class'); @@ -213,7 +213,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 * @access private @@ -547,7 +547,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for Name + * Getter function for Name * * @return string * @access public @@ -557,7 +557,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for State + * Getter function for State * * @return object * @access public @@ -567,7 +567,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for StateType + * Getter function for StateType * * @return int * @access public @@ -577,7 +577,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for title. Should be over-ridden by derived class + * Getter function for title. Should be over-ridden by derived class * * @return string * @access public @@ -587,7 +587,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * setter function for title. + * Setter function for title. * * @param string $title the title of the form * @@ -611,7 +611,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for link. + * Getter function for link. * * @return string * @access public @@ -624,7 +624,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 boolean * @access public @@ -634,7 +634,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for Form Action + * Getter function for Form Action * * @return string * @access public @@ -644,7 +644,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * setter function for Form Action + * Setter function for Form Action * * @param string * @@ -656,7 +656,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * render form and return contents + * Render form and return contents * * @return string * @access public @@ -673,7 +673,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter function for renderer. If renderer is not set + * Getter function for renderer. If renderer is not set * create one and initialize it * * @return object @@ -778,7 +778,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * getter for action + * Getter for action * * @return int * @access public @@ -788,7 +788,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 * @@ -800,7 +800,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 * @param mixed $value value of variable @@ -813,7 +813,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 * @param mixed $value value of varaible @@ -826,7 +826,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 the value to append @@ -848,7 +848,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $name + * @param string $name * @param $title * @param $values * @param array $attributes @@ -877,7 +877,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $id + * @param int $id * @param $title * @param bool $allowClear * @param null $required @@ -899,7 +899,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $id + * @param int $id * @param $title * @param $values * @param null $other @@ -957,7 +957,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * 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 title of the main button @@ -991,7 +991,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $name + * @param string $name * @param string $from * @param string $to * @param string $label @@ -1097,7 +1097,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $name + * @param string $name * @param $label * @param $attributes * @param bool $forceTextarea @@ -1141,7 +1141,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $id + * @param int $id * @param $title * @param null $required * @param null $extra @@ -1157,7 +1157,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * @param $name + * @param string $name * @param $label * @param $options * @param $attributes @@ -1357,7 +1357,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 */ function addMoney($name, $label, @@ -1379,7 +1379,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * add currency element to the form + * Add currency element to the form */ function addCurrency($name = 'currency', $label = NULL, @@ -1591,7 +1591,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * add autoselector field -if user has permission to view contacts + * Add autoselector field -if user has permission to view contacts * If adding this to a form you also need to add to the tpl e.g * * {if !empty($selectable)} diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 58da214144..d6c08e1fea 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; diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 896ac6fdb7..d9e5b6e584 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -226,7 +226,7 @@ class CRM_Core_Form_RecurringEntity { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $fields posted values of the form * diff --git a/CRM/Core/Form/Renderer.php b/CRM/Core/Form/Renderer.php index 7eee0a3a42..820780d415 100644 --- a/CRM/Core/Form/Renderer.php +++ b/CRM/Core/Form/Renderer.php @@ -50,7 +50,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 * @static diff --git a/CRM/Core/Form/Search.php b/CRM/Core/Form/Search.php index 9b9cbc0f7e..677cb979ed 100644 --- a/CRM/Core/Form/Search.php +++ b/CRM/Core/Form/Search.php @@ -38,7 +38,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { protected $_force; /** - * name of search button + * Name of search button * * @var string * @access protected @@ -46,7 +46,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { protected $_searchButtonName; /** - * name of action button + * Name of action button * * @var string * @access protected @@ -54,7 +54,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { protected $_actionButtonName; /** - * form values that we will be using + * Form values that we will be using * * @var array * @access public @@ -62,7 +62,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { public $_formValues; /** - * have we already done this search + * Have we already done this search * * @access protected * @var boolean @@ -70,7 +70,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { protected $_done; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index bcb1dab5b5..9f71a354ba 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -41,7 +41,7 @@ class CRM_Core_Form_Tag { public $_entityTagValues; /** - * build tag widget if correct parent is passed + * Build tag widget if correct parent is passed * * @param CRM_Core_Form $form form object * @param string $parentNames parent name ( tag name) @@ -116,7 +116,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 associated array * @param int $entityId entity id, eg: contact id, activity id, case id, file id diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index 89095af0a7..dde1c2e39d 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, @@ -44,7 +44,7 @@ class CRM_Core_IDS { ); /** - * the init object + * The init object */ private $init = NULL; diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index c1473b41da..b7dcb40afa 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -117,7 +117,7 @@ class CRM_Core_JobManager { } /** - * @param $id + * @param int $id */ public function executeJobById($id) { $job = $this->_getJob($id); @@ -186,7 +186,7 @@ class CRM_Core_JobManager { * */ /** - * @param null $id + * @param int $id * @param null $entity * @param null $action * diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index 38cc1042d1..ffbdb2a213 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -42,7 +42,7 @@ require_once 'CRM/Core/I18n.php'; class CRM_Core_Menu { /** - * the list of menu items + * The list of menu items * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Core_Menu { static $_items = NULL; /** - * the list of permissioned menu items + * The list of permissioned menu items * * @var array * @static @@ -103,7 +103,7 @@ class CRM_Core_Menu { } /** - * @param $name + * @param string $name * @param $menu * * @throws Exception diff --git a/CRM/Core/Module.php b/CRM/Core/Module.php index 29d5bab431..cbc6daacfa 100644 --- a/CRM/Core/Module.php +++ b/CRM/Core/Module.php @@ -48,7 +48,7 @@ class CRM_Core_Module { public $is_active; /** - * @param $name + * @param string $name * @param $is_active */ public function __construct($name, $is_active) { diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index 424885b90d..715629a9d6 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -165,12 +165,12 @@ WHERE v.option_group_id = g.id /** * Counterpart to values() which removes the item from the cache * - * @param $name + * @param string $name * @param $flip * @param $grouping * @param $localize * @param $condition - * @param $labelColumnName + * @param string $labelColumnName * @param $onlyActive * @param string $keyColumnName */ @@ -242,7 +242,7 @@ WHERE v.option_group_id = g.id } /** - * lookup titles OR ids for a set of option_value populated fields. The retrieved value + * Lookup titles OR ids for a set of option_value populated fields. The retrieved value * is assigned a new fieldname by id or id's by title * (each within a specificied option_group) * @@ -318,7 +318,7 @@ WHERE v.option_group_id = g.id } /** - * @param $groupName + * @param string $groupName * @param $value * @param bool $onlyActiveValue * @@ -354,7 +354,7 @@ WHERE v.option_group_id = g.id } /** - * @param $groupName + * @param string $groupName * @param $label * @param string $labelField * @param string $labelType @@ -485,7 +485,7 @@ WHERE v.option_group_id = g.id } /** - * @param $groupName + * @param string $groupName * @param $values * @param bool $flip * @param string $field @@ -531,7 +531,7 @@ ORDER BY v.weight } /** - * @param $groupName + * @param string $groupName * @param string $operator */ static function deleteAssoc($groupName, $operator = "=") { @@ -548,7 +548,7 @@ DELETE g, v } /** - * @param $groupName + * @param string $groupName * @param $value * * @return null|string @@ -568,7 +568,7 @@ SELECT v.label } /** - * @param $groupName + * @param string $groupName * @param $fieldValue * @param string $field * @param string $fieldType diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index a93862915a..3a886d74ac 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -35,7 +35,7 @@ class CRM_Core_OptionValue { /** - * static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export * * @var array * @static @@ -43,7 +43,7 @@ class CRM_Core_OptionValue { static $_exportableFields = NULL; /** - * static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export * * @var array * @static @@ -51,7 +51,7 @@ class CRM_Core_OptionValue { static $_importableFields = NULL; /** - * static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export * * @var array * @static @@ -59,7 +59,7 @@ class CRM_Core_OptionValue { static $_fields = NULL; /** - * return option-values of a particular group + * Return option-values of a particular group * * @param array $groupParams Array containing group fields whose option-values is to retrieved. * @param string $orderBy for orderBy clause @@ -170,7 +170,7 @@ class CRM_Core_OptionValue { } /** - * add/edit option-value of a particular group + * Add/edit option-value of a particular group * * @param array $params Array containing exported values from the invoking form. * @param array $groupParams Array containing group fields whose option-values is to retrieved/saved. @@ -243,7 +243,7 @@ class CRM_Core_OptionValue { * @param string $daoName the dao object name * @param string $daoID the id of the object being updated. u can change your name * as long as there is no conflict - * @param $optionGroupID + * @param int $optionGroupID * @param string $fieldName the name of the field in the DAO * * @return boolean true if object exists @@ -338,7 +338,7 @@ class CRM_Core_OptionValue { } /** - * build select query in case of option-values + * Build select query in case of option-values * * @param $query * @@ -365,7 +365,7 @@ class CRM_Core_OptionValue { } /** - * return option-values of a particular group + * Return option-values of a particular group * * @param array $groupParams Array containing group fields * whose option-values is to retrieved. diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index 6e1da70b00..1f6f844e93 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -52,7 +52,7 @@ class CRM_Core_Page { protected $_name; /** - * the title associated with this page + * The title associated with this page * * @var object * @access protected @@ -87,7 +87,7 @@ class CRM_Core_Page { protected $_print = FALSE; /** - * cache the smarty template for efficiency reasons + * Cache the smarty template for efficiency reasons * * @var CRM_Core_Smarty * @access protected @@ -96,7 +96,7 @@ class CRM_Core_Page { static protected $_template; /** - * cache the session for efficiency reasons + * Cache the session for efficiency reasons * * @var CRM_Core_Session * @access protected @@ -125,7 +125,7 @@ class CRM_Core_Page { public $useLivePageJS; /** - * class constructor + * Class constructor * * @param string $title title of the page * @param int $mode mode of the page @@ -277,7 +277,7 @@ class CRM_Core_Page { } /** - * assign value to name in template + * Assign value to name in template * * @param string $var * @param mixed $value value of varaible @@ -290,7 +290,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 (reference) value of varaible @@ -303,7 +303,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 the value to append @@ -325,7 +325,7 @@ class CRM_Core_Page { } /** - * destroy all the session state of this page. + * Destroy all the session state of this page. * * @access public * @@ -370,7 +370,7 @@ class CRM_Core_Page { } /** - * setter for embedded + * Setter for embedded * * @param boolean $embedded * @@ -382,7 +382,7 @@ class CRM_Core_Page { } /** - * getter for embedded + * Getter for embedded * * @return boolean return the embedded value * @access public @@ -392,7 +392,7 @@ class CRM_Core_Page { } /** - * setter for print + * Setter for print * * @param boolean $print * @@ -404,7 +404,7 @@ class CRM_Core_Page { } /** - * getter for print + * Getter for print * * @return boolean return the print value * @access public @@ -421,7 +421,7 @@ class CRM_Core_Page { } /** - * @param $name + * @param string $name * * @return null */ @@ -430,7 +430,7 @@ class CRM_Core_Page { } /** - * @param $name + * @param string $name * @param $value */ function setVar($name, $value) { diff --git a/CRM/Core/Page/AJAX.php b/CRM/Core/Page/AJAX.php index aab1f2fed1..4b3fc14b00 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 * * @static * @access public @@ -90,7 +90,7 @@ class CRM_Core_Page_AJAX { } /** - * change is_quick_config priceSet to complex + * Change is_quick_config priceSet to complex * * @static * @access public diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index f495abdbfb..d861cc5b1d 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -41,11 +41,11 @@ 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 * @access public @@ -54,7 +54,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function getBAOName(); /** - * an array of action links + * An array of action links * * @return array (reference) * @access public @@ -62,7 +62,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function &links(); /** - * name of the edit form class + * Name of the edit form class * * @return string * @access public @@ -70,7 +70,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function editForm(); /** - * name of the form + * Name of the form * * @return string * @access public @@ -78,7 +78,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function editName(); /** - * userContext to pop back to + * UserContext to pop back to * * @param int $mode mode that we are in * @@ -88,7 +88,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { abstract function userContext($mode = NULL); /** - * get userContext params + * Get userContext params * * @param int $mode mode that we are in * @@ -100,7 +100,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 * @param int $name the name or title of the object @@ -113,7 +113,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { } /** - * allows the derived class to add some more state variables to + * Allows the derived class to add some more state variables to * the controller. By default does nothing, and hence is abstract * * @param CRM_Core_Controller $controller the controller object @@ -124,7 +124,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { function addValues($controller) {} /** - * class constructor + * Class constructor * * @param string $title title of the page * @param int $mode mode of the page @@ -193,7 +193,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { } /** - * browse all entities. + * Browse all entities. * * @return void * @access public diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index 7e8a91ea3d..c964ce2a9e 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -36,7 +36,7 @@ abstract class CRM_Core_Payment { /** - * how are we getting billing information? + * How are we getting billing information? * * FORM - we collect it on the same page * BUTTON - the processor collects it and sends it back to us via some protocol @@ -47,7 +47,7 @@ abstract class CRM_Core_Payment { BILLING_MODE_NOTIFY = 4; /** - * which payment type(s) are we using? + * Which payment type(s) are we using? * * credit card * direct debit @@ -84,7 +84,7 @@ abstract class CRM_Core_Payment { protected $_paymentForm = NULL; /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @param array $paymentProcessor the details of the payment processor being invoked @@ -150,7 +150,7 @@ abstract class CRM_Core_Payment { } /** - * check if capability is supported + * Check if capability is supported * @param string $capability e.g BackOffice, LiveMode, FutureRecurStartDate * * @return bool @@ -164,7 +164,7 @@ abstract class CRM_Core_Payment { } /** - * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login + * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to reach a 'stable' point we disable * @return bool */ @@ -178,7 +178,7 @@ abstract class CRM_Core_Payment { } /** - * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login + * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login * @return bool */ protected function supportsLiveMode() { @@ -186,7 +186,7 @@ abstract class CRM_Core_Payment { } /** - * should the first payment date be configurable when setting up back office recurring payments + * Should the first payment date be configurable when setting up back office recurring payments * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this * @return bool */ @@ -216,7 +216,7 @@ abstract class CRM_Core_Payment { /** * Getter for accessing member vars * - * @param $name + * @param string $name * * @return null */ @@ -225,7 +225,7 @@ abstract class CRM_Core_Payment { } /** - * get name for the payment information type + * Get name for the payment information type * * @return string */ @@ -234,7 +234,7 @@ abstract class CRM_Core_Payment { } /** - * get label for the payment information type + * Get label for the payment information type * * @return string */ @@ -243,7 +243,7 @@ abstract class CRM_Core_Payment { } /** - * get array of fields that should be displayed on the payment form + * Get array of fields that should be displayed on the payment form * @todo make payment type an option value & use it in the function name - currently on debit & credit card work * @return array * @throws CiviCRM_API3_Exception @@ -256,7 +256,7 @@ abstract class CRM_Core_Payment { } /** - * get array of fields that should be displayed on the payment form for credit cards + * Get array of fields that should be displayed on the payment form for credit cards * * @return array */ @@ -270,7 +270,7 @@ abstract class CRM_Core_Payment { } /** - * get array of fields that should be displayed on the payment form for direct debits + * Get array of fields that should be displayed on the payment form for direct debits * * @return array */ @@ -284,7 +284,7 @@ abstract class CRM_Core_Payment { } /** - * return an array of all the details about the fields potentially required for payment fields + * Return an array of all the details about the fields potentially required for payment fields * Only those determined by getPaymentFormFields will actually be assigned to the form * * @return array field metadata @@ -427,7 +427,7 @@ abstract class CRM_Core_Payment { abstract function doDirectPayment(&$params); /** - * process payment - this function wraps around both doTransferPayment and doDirectPayment + * Process payment - this function wraps around both doTransferPayment and doDirectPayment * it ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms more agnostic * * @param array $params @@ -594,7 +594,7 @@ abstract class CRM_Core_Payment { } /** - * check whether a method is present ( & supported ) by the payment processor object. + * Check whether a method is present ( & supported ) by the payment processor object. * * @param string $method method to check for. * @@ -606,7 +606,7 @@ abstract class CRM_Core_Payment { } /** - * @param null $entityID + * @param int $entityID * @param null $entity * @param string $action * diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 38dc70043a..a9ae1f8a92 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -64,7 +64,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @param object $paymentProcessor the details of the payment processor being invoked @@ -84,7 +84,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * should the first payment date be configurable when setting up back office recurring payments + * Should the first payment date be configurable when setting up back office recurring payments * In the case of Authorize.net this is an option * @return bool */ diff --git a/CRM/Core/Payment/AuthorizeNetIPN.php b/CRM/Core/Payment/AuthorizeNetIPN.php index 0679b33eff..daefd8ea5c 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 $inputData array contents of HTTP REQUEST * diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 746bc2dc40..9a6ee12522 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -965,8 +965,8 @@ LIMIT 1;"; // function to copy custom data of the // initial contribution into its recurring contributions /** - * @param $recurId - * @param $targetContributionId + * @param int $recurId + * @param int $targetContributionId */ function copyCustomValues($recurId, $targetContributionId) { if ($recurId && $targetContributionId) { @@ -1010,8 +1010,8 @@ LIMIT 1;"; // function to copy soft credit record of first recurring contribution // and add new soft credit against $targetContributionId /** - * @param $recurId - * @param $targetContributionId + * @param int $recurId + * @param int $targetContributionId */ function addrecurSoftCredit($recurId, $targetContributionId) { $contriID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index 1d25494977..94afa4ce72 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -58,7 +58,7 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @@ -123,7 +123,7 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { } /** - * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login + * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login * @return bool */ protected function supportsLiveMode() { diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index 72e041207b..8dd4e6a4db 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -54,7 +54,7 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index 87ce7263c4..9f08c12a5b 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -78,7 +78,7 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 144910ebf8..72f863446a 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -79,7 +79,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 @@ -292,7 +292,7 @@ class CRM_Core_Payment_Form { } /** - * billing mode button is basically synonymous with paypal express - this is probably a good example of 'odds & sods' code we + * Billing mode button is basically synonymous with paypal express - this is probably a good example of 'odds & sods' code we * need to find a way for the payment processor to assign. A tricky aspect is that the payment processor may need to set the order * * @param $form @@ -353,9 +353,9 @@ class CRM_Core_Payment_Form { } /** - * map address fields + * Map address fields * - * @param $id + * @param int $id * @param $src * @param $dst * @param bool $reverse @@ -395,7 +395,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 * @@ -413,7 +413,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 a542e12145..1d368d1d72 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -44,7 +44,7 @@ require_once 'Google/library/googlerequest.php'; class CRM_Core_Payment_Google extends CRM_Core_Payment { /** - * mode of operation: live or test + * Mode of operation: live or test * * @var object */ @@ -75,7 +75,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @@ -299,7 +299,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * hash_call: Function to perform the API call to PayPal using API signature + * Hash_call: Function to perform the API call to PayPal using API signature * @paymentProcessor is the array of payment processor settings value. * @searchParamsnvpStr is the array of search params. * returns an associtive array containing the response from the server. @@ -354,7 +354,7 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { } /** - * @param $searchParams + * @param array $searchParams * * @return string */ diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index 276c302b2c..c0679d1874 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -51,14 +51,14 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { static private $_singleton = NULL; /** - * mode of operation: live or test + * Mode of operation: live or test * * @var object */ protected $_mode = NULL; /** - * @param $name + * @param string $name * @param $type * @param $object * @param bool $abort @@ -392,7 +392,7 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @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 a6e8d4595f..e019ed58b2 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -293,7 +293,7 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { } /** - * @param $error_id + * @param int $error_id * * @return string */ diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index ee29809164..15fa172263 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -79,7 +79,7 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 68dcb81422..eb8aee5ce3 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -47,7 +47,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/PayPalIPN.php b/CRM/Core/Payment/PayPalIPN.php index a4035e789e..9fb8e45781 100644 --- a/CRM/Core/Payment/PayPalIPN.php +++ b/CRM/Core/Payment/PayPalIPN.php @@ -44,7 +44,7 @@ class CRM_Core_Payment_PayPalIPN extends CRM_Core_Payment_BaseIPN { } /** - * @param $name + * @param string $name * @param $type * @param string $location * @param bool $abort diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 3c6ca69b5f..34e0262a7f 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -75,7 +75,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @@ -95,7 +95,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login + * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login * @return bool */ protected function supportsBackOffice() { @@ -105,7 +105,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { return FALSE; } /** - * express checkout code. Check PayPal documentation for more information + * Express checkout code. Check PayPal documentation for more information * * @param array $params assoc array of input parameters for this transaction * @@ -149,7 +149,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * get details from paypal. Check PayPal documentation for more information + * Get details from paypal. Check PayPal documentation for more information * * @param string $token the key associated with this transaction * @@ -190,7 +190,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * do the express checkout at paypal. Check PayPal documentation for more information + * Do the express checkout at paypal. Check PayPal documentation for more information * * @param array $params * @@ -437,7 +437,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * check whether a method is present ( & supported ) by the payment processor object. + * Check whether a method is present ( & supported ) by the payment processor object. * * @param string $method method to check for. * @@ -716,7 +716,7 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * hash_call: Function to perform the API call to PayPal using API signature + * Hash_call: Function to perform the API call to PayPal using API signature * @methodName is name of API method. * @nvpStr is nvp string. * returns an associtive array containing the response from the server. diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index d52e00e0a4..7d28b7718b 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -44,7 +44,7 @@ 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(); @@ -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 * @@ -74,7 +74,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { } /** - * function exists to get the values from the rp_invoice_id string + * Function exists to get the values from the rp_invoice_id string * * @param string $name e.g. i, values are stored in the string with letter codes * @param boolean $abort fatal if not found? diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index ca1d5f4cab..ed3f6e2009 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -45,7 +45,7 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @@ -626,8 +626,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { //end submit_transaction /** - * @param $recurringProfileID - * @param $processorID + * @param int $recurringProfileID + * @param int $processorID * * @throws Exception */ diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index fe3f5d5f35..802382545d 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -67,7 +67,7 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index 2402515d91..4910cd31cd 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -48,14 +48,14 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { static private $_singleton = NULL; /** - * mode of operation: live or test + * Mode of operation: live or test * * @var object */ protected $_mode = NULL; /** - * @param $name + * @param string $name * @param $type * @param $object * @param bool $abort @@ -98,7 +98,7 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/PaymentExpressUtils.php b/CRM/Core/Payment/PaymentExpressUtils.php index 8b513af143..d0031655ef 100644 --- a/CRM/Core/Payment/PaymentExpressUtils.php +++ b/CRM/Core/Payment/PaymentExpressUtils.php @@ -59,7 +59,7 @@ class CRM_Core_Payment_PaymentExpressUtils { /** * @param $xml - * @param $name + * @param string $name * * @return mixed */ @@ -70,7 +70,7 @@ class CRM_Core_Payment_PaymentExpressUtils { /** * @param $xml - * @param $name + * @param string $name * * @return mixed|null */ diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index caef3e21eb..62f3e63ac8 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -78,7 +78,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index f8ecb80018..cb13970b14 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -124,7 +124,7 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 42f6c2cba1..5f9caad165 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -71,7 +71,7 @@ class CRM_Core_Permission { CONST AUTH_SRC_UNKNOWN = 0, AUTH_SRC_CHECKSUM = 1, AUTH_SRC_SITEKEY = 2, AUTH_SRC_LOGIN = 4; /** - * get the current permission of this user + * Get the current permission of this user * * @return string the permission of the user (edit or view or null) */ @@ -81,7 +81,7 @@ class CRM_Core_Permission { } /** - * given a permission string or array, check for access requirements + * Given a permission string or array, check for access requirements * @param mixed $permissions the permission to check as an array or string -see examples * arrays * @@ -269,7 +269,7 @@ class CRM_Core_Permission { } /** - * @param $gid + * @param int $gid * @param int $type * * @return bool @@ -349,7 +349,7 @@ class CRM_Core_Permission { /** * @param int $type - * @param null $eventID + * @param int $eventID * @param string $context * * @return array|null @@ -426,7 +426,7 @@ class CRM_Core_Permission { } /** - * check permissions for delete and edit actions + * Check permissions for delete and edit actions * * @param string $module component name. * @param integer $action action to be check across component @@ -701,7 +701,7 @@ class CRM_Core_Permission { } /** - * get component name from given permission. + * Get component name from given permission. * * @param string $permission * diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index d8b0c1f9db..ad77e6afb8 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -66,7 +66,7 @@ class CRM_Core_Permission_Base { } /** - * get the current permission of this user + * Get the current permission of this user * * @return string the permission of the user (edit or view or null) */ @@ -132,7 +132,7 @@ class CRM_Core_Permission_Base { } /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index da1ab4b343..e6b0eb02b7 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ /** - * is this user someone with access for the entire system + * Is this user someone with access for the entire system * * @var boolean */ @@ -47,14 +47,14 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ protected $_editAdminUser = FALSE; /** - * am in in view permission or edit permission? + * Am in in view permission or edit permission? * @var boolean */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; /** - * the current set of permissioned groups for the user + * The current set of permissioned groups for the user * * @var array */ @@ -63,11 +63,11 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * - * @param null $contactID + * @param int $contactID * * @return boolean true if yes, else false * @access public diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index 2b14cb61cc..f23ca272ee 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** - * is this user someone with access for the entire system + * Is this user someone with access for the entire system * * @var boolean */ @@ -47,14 +47,14 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { protected $_editAdminUser = FALSE; /** - * am in in view permission or edit permission? + * Am in in view permission or edit permission? * @var boolean */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; /** - * the current set of permissioned groups for the user + * The current set of permissioned groups for the user * * @var array */ @@ -62,11 +62,11 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { protected $_editPermissionedGroups; /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * - * @param null $contactID + * @param int $contactID * * @return boolean true if yes, else false * @access public diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index 50dc86ffce..cd0ff6deee 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** - * is this user someone with access for the entire system + * Is this user someone with access for the entire system * * @var boolean */ @@ -47,14 +47,14 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { protected $_editAdminUser = FALSE; /** - * am in in view permission or edit permission? + * Am in in view permission or edit permission? * @var boolean */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; /** - * the current set of permissioned groups for the user + * The current set of permissioned groups for the user * * @var array */ @@ -202,7 +202,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { } /** - * get the current permission of this user + * Get the current permission of this user * * @return string the permission of the user (edit or view or null) */ diff --git a/CRM/Core/Permission/Joomla.php b/CRM/Core/Permission/Joomla.php index db2a31eff7..b7adb85a40 100644 --- a/CRM/Core/Permission/Joomla.php +++ b/CRM/Core/Permission/Joomla.php @@ -38,7 +38,7 @@ */ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * diff --git a/CRM/Core/Permission/Soap.php b/CRM/Core/Permission/Soap.php index 40e709827a..eab0be39e9 100644 --- a/CRM/Core/Permission/Soap.php +++ b/CRM/Core/Permission/Soap.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_Soap extends CRM_Core_Permission_Base { /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * diff --git a/CRM/Core/Permission/UnitTests.php b/CRM/Core/Permission/UnitTests.php index c083e73ec6..b64c1e51f9 100644 --- a/CRM/Core/Permission/UnitTests.php +++ b/CRM/Core/Permission/UnitTests.php @@ -42,7 +42,7 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { public $permissions = NULL; /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * diff --git a/CRM/Core/Permission/WordPress.php b/CRM/Core/Permission/WordPress.php index fbe9dbf7f6..aea00bfd04 100644 --- a/CRM/Core/Permission/WordPress.php +++ b/CRM/Core/Permission/WordPress.php @@ -38,7 +38,7 @@ */ class CRM_Core_Permission_WordPress extends CRM_Core_Permission_Base { /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index d590618895..2045fd1c9e 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -50,7 +50,7 @@ class CRM_Core_PseudoConstant { /** - * static cache for pseudoconstant arrays + * Static cache for pseudoconstant arrays * @var array * @static */ @@ -66,35 +66,35 @@ class CRM_Core_PseudoConstant { private static $activityType; /** - * states, provinces + * States, provinces * @var array * @static */ private static $stateProvince; /** - * counties + * Counties * @var array * @static */ private static $county; /** - * states/provinces abbreviations + * States/provinces abbreviations * @var array * @static */ private static $stateProvinceAbbreviation; /** - * country + * Country * @var array * @static */ private static $country; /** - * countryIsoCode + * CountryIsoCode * @var array * @static */ @@ -110,42 +110,42 @@ class CRM_Core_PseudoConstant { private static $group; /** - * groupIterator + * GroupIterator * @var mixed * @static */ private static $groupIterator; /** - * relationshipType + * RelationshipType * @var array * @static */ private static $relationshipType; /** - * civicrm groups that are not smart groups + * Civicrm groups that are not smart groups * @var array * @static */ private static $staticGroup; /** - * currency codes + * Currency codes * @var array * @static */ private static $currencyCode; /** - * payment processor + * Payment processor * @var array * @static */ private static $paymentProcessor; /** - * payment processor types + * Payment processor types * @var array * @static */ @@ -1104,7 +1104,7 @@ WHERE id = %1"; } /** - * get all the ISO 4217 currency codes + * Get all the ISO 4217 currency codes * * so far, we use this for validation only, so there's no point of putting this into the database * @@ -1468,7 +1468,7 @@ WHERE id = %1"; * * @param boolean $all - get payment processors - default is to get only active ones. * - * @param null $id + * @param int $id * @param string $return * * @return array - array of all payment processor types @@ -1565,7 +1565,7 @@ WHERE id = %1"; } /** - * @param $countryID + * @param int $countryID * @param string $field * * @return array @@ -1620,7 +1620,7 @@ ORDER BY name"; } /** - * @param $stateID + * @param int $stateID * * @return array */ @@ -1824,7 +1824,7 @@ WHERE id = %1 * * @param boolean $optionGroupName - get All Option Group values- default is to get only active ones. * - * @param null $id + * @param int $id * @param null $condition * * @return array - array reference of all Option Group Name diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php index 5ba26e4416..6349e7757b 100644 --- a/CRM/Core/QuickForm/Action.php +++ b/CRM/Core/QuickForm/Action.php @@ -42,13 +42,13 @@ require_once 'HTML/QuickForm/Action.php'; class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { /** - * reference to the state machine i belong to + * Reference to the state machine i belong to * @var object */ protected $_stateMachine; /** - * constructor + * Constructor * * @param object $stateMachine reference to state machine object * @@ -60,7 +60,7 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { } /** - * returns the user to the top of the user context stack. + * Returns the user to the top of the user context stack. * * @return void * @access public diff --git a/CRM/Core/QuickForm/Action/Back.php b/CRM/Core/QuickForm/Action/Back.php index 669c42c8a2..e100f36f88 100644 --- a/CRM/Core/QuickForm/Action/Back.php +++ b/CRM/Core/QuickForm/Action/Back.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 5724aceddb..60ea7f6635 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 28b8446d5c..42d1a4df2e 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -36,19 +36,19 @@ 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; /** - * the template to display error messages inline with the form element + * The template to display error messages inline with the form element * @var string */ static $_errorTemplate = NULL; /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * @@ -186,7 +186,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * set the various rendering templates + * Set the various rendering templates * * @param CRM_Core_Form $page the CRM_Core_Form page * @@ -205,7 +205,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * initialize the various templates + * Initialize the various templates * * @return void * @access public diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index 34682b818b..7cf2c2e9d7 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index 15791a97b9..16b26e64a3 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index 876d71e161..a3156c6f42 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index f25469065a..c17a3ae90b 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php index 564edfa6e1..0df1ad2b44 100644 --- a/CRM/Core/QuickForm/Action/Refresh.php +++ b/CRM/Core/QuickForm/Action/Refresh.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 22296f70fd..80b5a5a2a3 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -39,7 +39,7 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index 8e97f1fe81..e1b102b0f6 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 1ac79b2858..f7e07159f2 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** - * the array of uploaded file names + * The array of uploaded file names * @var array */ protected $_uploadNames; @@ -48,7 +48,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { protected $_uploadDir; /** - * class constructor + * Class constructor * * @param object $stateMachine reference to state machine object * @param string $uploadDir directory to store the uploaded files @@ -65,7 +65,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { } /** - * upload and move the file if valid to the uploaded directory + * Upload and move the file if valid to the uploaded directory * * @param CRM_Core_Form $page the CRM_Core_Form object * @param object $data the QFC data container @@ -131,7 +131,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * @param CRM_Core_Form $page - * @param $actionName + * @param string $actionName * * @return mixed */ diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index 63953d104b..1dcca501ef 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -42,7 +42,7 @@ class CRM_Core_Region { var $_isSorted; /** - * @param $name + * @param string $name */ public function __construct($name) { // Templates injected into regions should normally be file names, but sometimes inline notation is handy. @@ -126,7 +126,7 @@ class CRM_Core_Region { } /** - * @param $name + * @param string $name * @param $snippet */ public function update($name, $snippet) { @@ -135,7 +135,7 @@ class CRM_Core_Region { } /** - * @param $name + * @param string $name * * @return mixed */ diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index 13718cbe0c..023f1ff3c4 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -152,7 +152,7 @@ class CRM_Core_Report_Excel { } /** - * @param $fileName + * @param string $fileName * @param $header * @param $rows * @param null $titleHeader diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php index 5592c5151e..35e7b0a054 100644 --- a/CRM/Core/SelectValues.php +++ b/CRM/Core/SelectValues.php @@ -38,7 +38,7 @@ class CRM_Core_SelectValues { /** - * preferred mail format + * Preferred mail format * @static */ static function pmf() { @@ -50,7 +50,7 @@ class CRM_Core_SelectValues { } /** - * privacy options + * Privacy options * @static */ static function privacy() { @@ -65,7 +65,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined contact super types + * Various pre defined contact super types * @static */ static function contactType() { @@ -77,7 +77,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined unit list + * Various pre defined unit list * @static */ static function unitList($unitType = NULL) { @@ -93,7 +93,7 @@ class CRM_Core_SelectValues { } /** - * membership type unit + * Membership type unit * @static */ static function membershipTypeUnitList( ) { @@ -101,7 +101,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined period types + * Various pre defined period types * @static */ static function periodType() { @@ -112,7 +112,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined email selection methods + * Various pre defined email selection methods * @static */ static function emailSelectMethods() { @@ -125,7 +125,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined member visibility options + * Various pre defined member visibility options * @static */ static function memberVisibility() { @@ -136,7 +136,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined event dates + * Various pre defined event dates * @static */ static function eventDate() { @@ -174,7 +174,7 @@ class CRM_Core_SelectValues { } /** - * various pre defined extensions for dynamic properties and groups + * Various pre defined extensions for dynamic properties and groups * * @static */ @@ -203,7 +203,7 @@ class CRM_Core_SelectValues { } /** - * styles for displaying the custom data group + * Styles for displaying the custom data group * * @static */ @@ -216,7 +216,7 @@ class CRM_Core_SelectValues { } /** - * for displaying the uf group types + * For displaying the uf group types * * @static */ @@ -236,7 +236,7 @@ class CRM_Core_SelectValues { } /** - * the status of a contact within a group + * The status of a contact within a group * * @static */ @@ -249,7 +249,7 @@ class CRM_Core_SelectValues { } /** - * list of Group Types + * List of Group Types * @static */ static function groupType() { @@ -260,7 +260,7 @@ class CRM_Core_SelectValues { } /** - * compose the parameters for a date select object + * Compose the parameters for a date select object * * @param string|NULL $type the type of date * @param string|NULL $format date format ( QF format) @@ -312,7 +312,7 @@ class CRM_Core_SelectValues { } /** - * values for UF form visibility options + * Values for UF form visibility options * * @static */ @@ -325,7 +325,7 @@ class CRM_Core_SelectValues { } /** - * values for group form visibility options + * Values for group form visibility options * * @static */ @@ -337,7 +337,7 @@ class CRM_Core_SelectValues { } /** - * different type of Mailing Components + * Different type of Mailing Components * * @static * return array @@ -355,7 +355,7 @@ class CRM_Core_SelectValues { } /** - * get hours + * Get hours * * * @static @@ -369,7 +369,7 @@ class CRM_Core_SelectValues { } /** - * get minutes + * Get minutes * * * @static @@ -383,7 +383,7 @@ class CRM_Core_SelectValues { } /** - * get the Map Provider + * Get the Map Provider * * @return array $map array of map providers * @static @@ -397,7 +397,7 @@ class CRM_Core_SelectValues { } /** - * Function to get the Geocoding Providers from available plugins + * Get the Geocoding Providers from available plugins * * @return array $geo array of geocoder providers * @static @@ -411,7 +411,7 @@ class CRM_Core_SelectValues { } /** - * Function to get the Address Standardization Providers from available + * Get the Address Standardization Providers from available * plugins * * @return array $addr array of address standardization providers @@ -426,7 +426,7 @@ class CRM_Core_SelectValues { } /** - * different type of Mailing Tokens + * Different type of Mailing Tokens * * @static * return array @@ -453,7 +453,7 @@ class CRM_Core_SelectValues { } /** - * different type of Activity Tokens + * Different type of Activity Tokens * * @static * return array @@ -468,7 +468,7 @@ class CRM_Core_SelectValues { } /** - * different type of Membership Tokens + * Different type of Membership Tokens * * @static * return array @@ -486,7 +486,7 @@ class CRM_Core_SelectValues { } /** - * different type of Event Tokens + * Different type of Event Tokens * * @static * return array @@ -511,7 +511,7 @@ class CRM_Core_SelectValues { } /** - * different type of Event Tokens + * Different type of Event Tokens * * @static * return array @@ -545,7 +545,7 @@ class CRM_Core_SelectValues { } /** - * different type of Contact Tokens + * Different type of Contact Tokens * * @static * return array @@ -612,7 +612,7 @@ class CRM_Core_SelectValues { } /** - * different type of Participant Tokens + * Different type of Participant Tokens * * @static * return array @@ -723,7 +723,7 @@ class CRM_Core_SelectValues { } /** - * Function to get numeric options + * Get numeric options * * * @static @@ -737,7 +737,7 @@ class CRM_Core_SelectValues { } /** - * barcode types + * Barcode types * @static */ static function getBarcodeTypes() { @@ -748,7 +748,7 @@ class CRM_Core_SelectValues { } /** - * dedupe rule types + * Dedupe rule types */ static function getDedupeRuleTypes() { return array( @@ -759,7 +759,7 @@ class CRM_Core_SelectValues { } /** - * campaign group types + * Campaign group types */ static function getCampaignGroupTypes() { return array( @@ -769,7 +769,7 @@ class CRM_Core_SelectValues { } /** - * subscription history method + * Subscription history method */ static function getSubscriptionHistoryMethods() { return array( @@ -781,7 +781,7 @@ class CRM_Core_SelectValues { } /** - * premium units + * Premium units */ static function getPremiumUnits() { return array( @@ -793,7 +793,7 @@ class CRM_Core_SelectValues { } /** - * extension types + * Extension types */ static function getExtensionTypes() { return array( @@ -806,7 +806,7 @@ class CRM_Core_SelectValues { } /** - * job frequency + * Job frequency */ static function getJobFrequency() { return array( @@ -838,7 +838,7 @@ class CRM_Core_SelectValues { } /** - * profile group types + * Profile group types * * @static */ @@ -858,7 +858,7 @@ class CRM_Core_SelectValues { /** - * word replacement match type + * Word replacement match type */ static function getWordReplacementMatchType() { return array( @@ -868,7 +868,7 @@ class CRM_Core_SelectValues { } /** - * mailing group types + * Mailing group types */ static function getMailingGroupTypes() { return array( diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php index ff4e89774d..ce85b4b405 100644 --- a/CRM/Core/Selector/API.php +++ b/CRM/Core/Selector/API.php @@ -62,7 +62,7 @@ interface CRM_Core_Selector_API { 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 * @@ -73,7 +73,7 @@ interface CRM_Core_Selector_API { function &getSortOrder($action); /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -85,7 +85,7 @@ interface CRM_Core_Selector_API { 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 { function getTotalCount($action); /** - * returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount * * @param enum $action the action being performed * @param int $offset the row number to start from @@ -111,7 +111,7 @@ interface CRM_Core_Selector_API { function &getRows($action, $offset, $rowCount, $sort, $type = NULL); /** - * return the template (.tpl) filename + * Return the template (.tpl) filename * * @param string $action the action being performed * @@ -122,7 +122,7 @@ interface CRM_Core_Selector_API { 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 212b0867e9..cf3abff95b 100644 --- a/CRM/Core/Selector/Base.php +++ b/CRM/Core/Selector/Base.php @@ -39,7 +39,7 @@ class CRM_Core_Selector_Base { /** - * the sort order which is computed from the columnHeaders + * The sort order which is computed from the columnHeaders * * @var array */ @@ -99,7 +99,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 * @@ -111,7 +111,7 @@ class CRM_Core_Selector_Base { } /** - * getter for the sorting direction for the fields which will be displayed on the form. + * Getter for the sorting direction for the fields which will be displayed on the form. * * @param string action the action being performed * @@ -148,7 +148,7 @@ class CRM_Core_Selector_Base { } /** - * setter for permission + * Setter for permission * * @var string * @access public @@ -158,7 +158,7 @@ class CRM_Core_Selector_Base { } /** - * get the display text in plain language for the search + * Get the display text in plain language for the search * to display on the results page * * @return string diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 5737af8791..aa86c2271a 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -42,7 +42,7 @@ class CRM_Core_Selector_Controller { /** - * constants to determine if we should store + * Constants to determine if we should store * the output in the session or template * @var int */ @@ -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; @@ -62,13 +62,13 @@ class CRM_Core_Selector_Controller { protected $_sort; /** - * the current column to sort on + * The current column to sort on * @var int */ protected $_sortID; /** - * the sortOrder array + * The sortOrder array * @var array */ protected $_sortOrder; @@ -79,31 +79,31 @@ class CRM_Core_Selector_Controller { protected $_pager; /** - * the pageID + * The pageID * @var int */ protected $_pageID; /** - * offset + * Offset * @var int */ protected $_pagerOffset; /** - * number of rows to return + * Number of rows to return * @var int */ protected $_pagerRowCount; /** - * total number of rows + * Total number of rows * @var int */ protected $_total; /** - * the objectAction for the WebObject + * The objectAction for the WebObject */ protected $_action; @@ -153,7 +153,7 @@ class CRM_Core_Selector_Controller { protected $_prefix; /** - * cache the smarty template for efficiency reasons + * Cache the smarty template for efficiency reasons * * @var CRM_Core_Smarty */ @@ -250,7 +250,7 @@ class CRM_Core_Selector_Controller { } /** - * have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values + * Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values * * @param int $reset are we being reset * @@ -383,7 +383,7 @@ class CRM_Core_Selector_Controller { } /** - * retrieve rows. + * Retrieve rows. * * @param CRM_Core_Form $form * @@ -403,7 +403,7 @@ class CRM_Core_Selector_Controller { } /** - * default function for qill, if needed to be implemented, we + * Default function for qill, if needed to be implemented, we * expect the subclass to do it * * @return string the status message @@ -421,7 +421,7 @@ class CRM_Core_Selector_Controller { } /** - * getter for pager + * Getter for pager * * @return CRM_Utils_Pager * @access public @@ -431,7 +431,7 @@ class CRM_Core_Selector_Controller { } /** - * getter for sort + * Getter for sort * * @return CRM_Utils_Sort * @access public @@ -484,7 +484,7 @@ class CRM_Core_Selector_Controller { } /** - * setter for embedded + * Setter for embedded * * @param boolean $embedded * @@ -496,7 +496,7 @@ class CRM_Core_Selector_Controller { } /** - * getter for embedded + * Getter for embedded * * @return boolean return the embedded value * @access public @@ -506,7 +506,7 @@ class CRM_Core_Selector_Controller { } /** - * setter for print + * Setter for print * * @param boolean $print * @@ -518,7 +518,7 @@ class CRM_Core_Selector_Controller { } /** - * getter for print + * Getter for print * * @return boolean return the print value * @access public diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 24f53be63f..3ef9a7436a 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -39,7 +39,7 @@ class CRM_Core_Session { static $_managedNames = NULL; /** - * key is used to allow the application to have multiple top + * Key is used to allow the application to have multiple top * level scopes rather than a single scope. (avoids naming * conflicts). We also extend this idea further and have local * scopes within a global scope. Allows us to do cool things @@ -90,7 +90,7 @@ class CRM_Core_Session { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @return CRM_Core_Session * @static @@ -173,7 +173,7 @@ class CRM_Core_Session { } /** - * creates a session local scope + * Creates a session local scope * * @param string prefix local scope name * @param boolean isRead is this a read operation, in this case, the session will not be touched @@ -195,7 +195,7 @@ class CRM_Core_Session { } /** - * resets the session local scope + * Resets the session local scope * * @param string local scope name * @access public @@ -341,7 +341,7 @@ class CRM_Core_Session { } /** - * adds a userContext to the stack + * Adds a userContext to the stack * * @param string $userContext the url to return to when done * @param boolean $check should we do a dupe checking with the top element @@ -381,7 +381,7 @@ class CRM_Core_Session { } /** - * replace the userContext of the stack with the passed one + * Replace the userContext of the stack with the passed one * * @param string the url to return to when done * @@ -402,7 +402,7 @@ class CRM_Core_Session { } /** - * pops the top userContext stack + * Pops the top userContext stack * * @param void * @@ -416,7 +416,7 @@ class CRM_Core_Session { } /** - * reads the top userContext stack + * Reads the top userContext stack * * @param void * @@ -432,7 +432,7 @@ class CRM_Core_Session { } /** - * dumps the session to the log + * Dumps the session to the log */ function debug($all = 1) { $this->initialize(); @@ -525,7 +525,7 @@ class CRM_Core_Session { } /** - * @param $names + * @param string $names */ static function registerAndRetrieveSessionObjects($names) { if (!is_array($names)) { diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index c66b119ed4..3da48f4844 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -56,7 +56,7 @@ class CRM_Core_ShowHideBlocks { protected $_hide; /** - * class constructor + * Class constructor * * @param array $show initial value of show array * @param array $hide initial value of hide array @@ -80,7 +80,7 @@ class CRM_Core_ShowHideBlocks { } /** - * load icon vars used in hide and show links + * Load icon vars used in hide and show links * * @return void * @access public @@ -95,7 +95,7 @@ class CRM_Core_ShowHideBlocks { } /** - * add the values from this class to the template + * Add the values from this class to the template * * @return void * @access public @@ -157,7 +157,7 @@ class CRM_Core_ShowHideBlocks { } /** - * create a well formatted html link from the smaller pieces + * Create a well formatted html link from the smaller pieces * * @param string $name name of the link * @param string $href diff --git a/CRM/Core/Smarty.php b/CRM/Core/Smarty.php index f683c56574..eb39ff0ad6 100644 --- a/CRM/Core/Smarty.php +++ b/CRM/Core/Smarty.php @@ -79,7 +79,7 @@ class CRM_Core_Smarty extends Smarty { private $backupFrames = array(); /** - * class constructor + * Class constructor * * @return CRM_Core_Smarty * @access private @@ -188,7 +188,7 @@ class CRM_Core_Smarty extends Smarty { } /** - * executes & returns or displays the template results + * Executes & returns or displays the template results * * @param string $resource_name * @param string $cache_id @@ -231,7 +231,7 @@ class CRM_Core_Smarty extends Smarty { } /** - * @param $name + * @param string $name * @param $value */ function appendValue($name, $value) { diff --git a/CRM/Core/Smarty/resources/String.php b/CRM/Core/Smarty/resources/String.php index a11f921521..e4c40edadb 100644 --- a/CRM/Core/Smarty/resources/String.php +++ b/CRM/Core/Smarty/resources/String.php @@ -38,7 +38,7 @@ function civicrm_smarty_resource_string_get_template($tpl_name, &$tpl_source, &$ } /** - * @param $tpl_name + * @param string $tpl_name * @param $tpl_timestamp * @param $smarty_obj * @@ -50,7 +50,7 @@ function civicrm_smarty_resource_string_get_timestamp($tpl_name, &$tpl_timestamp } /** - * @param $tpl_name + * @param string $tpl_name * @param $smarty_obj * * @return bool @@ -60,7 +60,7 @@ function civicrm_smarty_resource_string_get_secure($tpl_name, &$smarty_obj) { } /** - * @param $tpl_name + * @param string $tpl_name * @param $smarty_obj */ function civicrm_smarty_resource_string_get_trusted($tpl_name, &$smarty_obj) {} diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 30a1373f50..fbd3031714 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -39,25 +39,25 @@ class CRM_Core_State { /** - * state name + * State name * @var string */ protected $_name; /** - * this is a combination "OR" of the STATE_* constants defined below + * This is a combination "OR" of the STATE_* constants defined below * @var int */ protected $_type; /** - * the state that precedes this state + * The state that precedes this state * @var CRM_Core_State */ protected $_back; /** - * the state that succeeds this state + * The state that succeeds this state * @var CRM_Core_State */ protected $_next; @@ -77,7 +77,7 @@ class CRM_Core_State { CONST START = 1, FINISH = 2, SIMPLE = 4; /** - * constructor + * Constructor * * @param string $name internal name of the state * @param int $type state type @@ -181,7 +181,7 @@ class CRM_Core_State { } /** - * getter for name + * Getter for name * * @return string * @access public @@ -191,7 +191,7 @@ class CRM_Core_State { } /** - * setter for name + * Setter for name * * @param string * @@ -203,7 +203,7 @@ class CRM_Core_State { } /** - * getter for type + * Getter for type * * @return int * @access public diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index 1a8dd26b65..b97c978901 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -44,19 +44,19 @@ class CRM_Core_StateMachine { /** - * the controller of this state machine + * The controller of this state machine * @var object */ protected $_controller; /** - * the list of states that belong to this state machine + * The list of states that belong to this state machine * @var array */ protected $_states; /** - * the list of pages that belong to this state machine. Note + * The list of pages that belong to this state machine. Note * that a state and a form have a 1 <-> 1 relationship. so u * can always derive one from the other * @var array @@ -71,7 +71,7 @@ class CRM_Core_StateMachine { protected $_pageNames; /** - * the mode that the state machine is operating in + * The mode that the state machine is operating in * @var int */ protected $_action = NULL; @@ -83,7 +83,7 @@ class CRM_Core_StateMachine { protected $_name = NULL; /** - * class constructor + * Class constructor * * @param object $controller the controller for this state machine * @@ -100,7 +100,7 @@ class CRM_Core_StateMachine { } /** - * getter for name + * Getter for name * * @return string * @access public @@ -110,7 +110,7 @@ class CRM_Core_StateMachine { } /** - * setter for name + * Setter for name * * @param string * @@ -122,7 +122,7 @@ class CRM_Core_StateMachine { } /** - * do a state transition jump. Currently only supported types are + * Do a state transition jump. Currently only supported types are * Next and Back. The other actions (Cancel, Done, Submit etc) do * not need the state machine to figure out where to go * @@ -171,7 +171,7 @@ class CRM_Core_StateMachine { } /** - * helper function to add a State to the state machine + * Helper function to add a State to the state machine * * @param string $name the internal name * @param int $type the type of state (START|FINISH|SIMPLE) @@ -203,7 +203,7 @@ class CRM_Core_StateMachine { } /** - * return the list of state objects + * Return the list of state objects * * @return array array of states in the state machine * @access public @@ -213,7 +213,7 @@ class CRM_Core_StateMachine { } /** - * return the state object corresponding to the name + * Return the state object corresponding to the name * * @param string $name name of page * @@ -240,7 +240,7 @@ class CRM_Core_StateMachine { } /** - * return the list of form objects + * Return the list of form objects * * @return array array of pages in the state machine * @access public @@ -250,7 +250,7 @@ class CRM_Core_StateMachine { } /** - * addSequentialStates: meta level function to create a simple + * AddSequentialStates: meta level function to create a simple * wizard for a state machine that is completely sequential. * * @access public @@ -316,7 +316,7 @@ class CRM_Core_StateMachine { } /** - * reset the state machine + * Reset the state machine * * @return void * @access public @@ -326,7 +326,7 @@ class CRM_Core_StateMachine { } /** - * getter for action + * Getter for action * * @return int * @access public @@ -336,7 +336,7 @@ class CRM_Core_StateMachine { } /** - * setter for content + * Setter for content * * @param string $content the content generated by this state machine * @@ -348,7 +348,7 @@ class CRM_Core_StateMachine { } /** - * getter for content + * Getter for content * * @return string * @access public diff --git a/CRM/Custom/Form/ChangeFieldType.php b/CRM/Custom/Form/ChangeFieldType.php index 67d2530cb8..08eb50c2bd 100644 --- a/CRM/Custom/Form/ChangeFieldType.php +++ b/CRM/Custom/Form/ChangeFieldType.php @@ -39,7 +39,7 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { /** - * the field id + * The field id * * @var int * @access protected @@ -47,17 +47,17 @@ class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form { protected $_id; /** - * array of custom field values + * Array of custom field values */ protected $_values; /** - * mapper array of valid field type + * Mapper array of valid field type */ protected $_htmlTypeTransitions; /** - * set up variables to build the form + * Set up variables to build the form * * @return void * @acess protected diff --git a/CRM/Custom/Form/DeleteField.php b/CRM/Custom/Form/DeleteField.php index 34597d1a56..28be34ae68 100644 --- a/CRM/Custom/Form/DeleteField.php +++ b/CRM/Custom/Form/DeleteField.php @@ -39,7 +39,7 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { /** - * the group id + * The group id * * @var int */ @@ -53,7 +53,7 @@ class CRM_Custom_Form_DeleteField extends CRM_Core_Form { protected $_title; /** - * set up variables to build the form + * Set up variables to build the form * * @param null * diff --git a/CRM/Custom/Form/DeleteGroup.php b/CRM/Custom/Form/DeleteGroup.php index 3664193a97..7f4cde49dc 100644 --- a/CRM/Custom/Form/DeleteGroup.php +++ b/CRM/Custom/Form/DeleteGroup.php @@ -39,7 +39,7 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { /** - * the group id + * The group id * * @var int */ @@ -53,7 +53,7 @@ class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form { protected $_title; /** - * set up variables to build the form + * Set up variables to build the form * * @return void * @acess protected diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index 1c7981cd9b..9ffa242f9e 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 * @access protected @@ -68,7 +68,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; @@ -86,7 +86,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 * * @param null * @@ -559,7 +559,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 * diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 3874fc606d..e958eee177 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -55,7 +55,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { protected $_isGroupEmpty = TRUE; /** - * array of existing subtypes set for a custom set + * Array of existing subtypes set for a custom set * * @var array * @access protected @@ -63,7 +63,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { protected $_subtypes = array(); /** - * array of default params + * Array of default params * * @var array * @access protected @@ -71,7 +71,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { protected $_defaults = array(); /** - * set variables up before form is built + * Set variables up before form is built * * @param null * @@ -110,7 +110,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Custom/Form/MoveField.php b/CRM/Custom/Form/MoveField.php index 644bb7b30a..67c41be612 100644 --- a/CRM/Custom/Form/MoveField.php +++ b/CRM/Custom/Form/MoveField.php @@ -39,28 +39,28 @@ 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 */ @@ -74,7 +74,7 @@ class CRM_Custom_Form_MoveField extends CRM_Core_Form { protected $_srcFieldLabel; /** - * set up variables to build the form + * Set up variables to build the form * * @return void * @acess protected diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index 7a30143be1..f298763835 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -39,7 +39,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { /** - * the custom field id saved to the session for an update + * The custom field id saved to the session for an update * * @var int * @access protected @@ -47,7 +47,7 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { protected $_fid; /** - * the custom group id saved to the session for an update + * The custom group id saved to the session for an update * * @var int * @access protected @@ -68,7 +68,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 * * @param null * @@ -243,7 +243,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 * diff --git a/CRM/Custom/Form/Preview.php b/CRM/Custom/Form/Preview.php index 37f7262c61..2c29a28fd0 100644 --- a/CRM/Custom/Form/Preview.php +++ b/CRM/Custom/Form/Preview.php @@ -44,14 +44,14 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { /** - * the group tree data + * The group tree data * * @var array */ protected $_groupTree; /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for group or field id * diff --git a/CRM/Custom/Import/Controller.php b/CRM/Custom/Import/Controller.php index 2194f10775..5212ea1848 100644 --- a/CRM/Custom/Import/Controller.php +++ b/CRM/Custom/Import/Controller.php @@ -5,7 +5,7 @@ */ class CRM_Custom_Import_Controller extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Custom/Import/Form/DataSource.php b/CRM/Custom/Import/Form/DataSource.php index fe2ed4b38c..07b4c0a9b4 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 * @access public diff --git a/CRM/Custom/Import/Form/MapField.php b/CRM/Custom/Import/Form/MapField.php index 81e69fc8d6..56f2a2568f 100644 --- a/CRM/Custom/Import/Form/MapField.php +++ b/CRM/Custom/Import/Form/MapField.php @@ -8,12 +8,12 @@ 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 * @access public @@ -57,7 +57,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 * diff --git a/CRM/Custom/Import/Form/Preview.php b/CRM/Custom/Import/Form/Preview.php index 3087863b91..d8abc96045 100644 --- a/CRM/Custom/Import/Form/Preview.php +++ b/CRM/Custom/Import/Form/Preview.php @@ -7,7 +7,7 @@ class CRM_Custom_Import_Form_Preview extends CRM_Import_Form_Preview { public $_parser = 'CRM_Custom_Import_Parser_Api'; protected $_importParserUrl = '&parser=CRM_Custom_Import_Parser'; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Custom/Import/Form/Summary.php b/CRM/Custom/Import/Form/Summary.php index 30ce83b653..4491c02f31 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 * @access public diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index 5aad0cf638..0b73ed91d2 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -44,29 +44,29 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { */ /** - * imported file size + * Imported file size */ protected $_fileSize; /** - * separator being used + * Separator being used */ protected $_separator; /** - * 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 */ protected $_haveColumnHeader; /** - * @param $fileName + * @param string $fileName * @param string $separator * @param int $mapper * @param bool $skipColumnHeader @@ -309,7 +309,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 * @access public diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index 12d64530a1..e178107725 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -17,7 +17,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { */ protected $_params = array(); /** - * class constructor + * Class constructor */ function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -30,7 +30,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -50,7 +50,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 * @@ -62,7 +62,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 * @@ -122,7 +122,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 * @param array $values the array of values belonging to this line @@ -198,7 +198,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public diff --git a/CRM/Custom/Page/Field.php b/CRM/Custom/Page/Field.php index 25a42d0acc..f8db73611a 100644 --- a/CRM/Custom/Page/Field.php +++ b/CRM/Custom/Page/Field.php @@ -200,7 +200,7 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { } /** - * edit custom data. + * Edit custom data. * * editing would involved modifying existing fields + adding data to new fields. * diff --git a/CRM/Custom/Page/Group.php b/CRM/Custom/Page/Group.php index 3633f26291..b1483a5eb1 100644 --- a/CRM/Custom/Page/Group.php +++ b/CRM/Custom/Page/Group.php @@ -155,7 +155,7 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { } /** - * edit custom group + * Edit custom group * * @param int $id custom group id * @param string $action the action to be invoked diff --git a/CRM/Custom/Page/Option.php b/CRM/Custom/Page/Option.php index 0c75924139..62c1aad8ce 100644 --- a/CRM/Custom/Page/Option.php +++ b/CRM/Custom/Page/Option.php @@ -238,7 +238,7 @@ ORDER BY weight, label } /** - * edit custom Option. + * Edit custom Option. * * editing would involved modifying existing fields + adding data to new fields. * diff --git a/CRM/Dedupe/BAO/Rule.php b/CRM/Dedupe/BAO/Rule.php index e8bfb88d2e..825b515fb0 100644 --- a/CRM/Dedupe/BAO/Rule.php +++ b/CRM/Dedupe/BAO/Rule.php @@ -40,12 +40,12 @@ class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_DAO_Rule { /** - * ids of the contacts to limit the SQL queries (whole-database queries otherwise) + * Ids of the contacts to limit the SQL queries (whole-database queries otherwise) */ var $contactIds = array(); /** - * params to dedupe against (queries against the whole contact set otherwise) + * Params to dedupe against (queries against the whole contact set otherwise) */ var $params = array(); @@ -209,8 +209,8 @@ class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_DAO_Rule { } /** - * @param $cid - * @param $oid + * @param int $cid + * @param int $oid * * @return bool */ diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 2adab49e4f..6f3b26e9aa 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -40,17 +40,17 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { /** - * ids of the contacts to limit the SQL queries (whole-database queries otherwise) + * Ids of the contacts to limit the SQL queries (whole-database queries otherwise) */ var $contactIds = array(); /** - * params to dedupe against (queries against the whole contact set otherwise) + * Params to dedupe against (queries against the whole contact set otherwise) */ var $params = array(); /** - * if there are no rules in rule group + * If there are no rules in rule group */ var $noRules = FALSE; diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index d8dd6421ec..4c273c795c 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -291,7 +291,7 @@ WHERE } /** - * return payment related table. + * Return payment related table. */ static function paymentTables() { static $tables; @@ -303,7 +303,7 @@ WHERE } /** - * return payment update Query. + * Return payment update Query. */ static function paymentSql($tableName, $mainContactId, $otherContactId) { $sqls = array(); @@ -349,9 +349,9 @@ INNER JOIN civicrm_participant participant ON ( participant.id = payment.partic } /** - * @param $mainId - * @param $otherId - * @param $tableName + * @param int $mainId + * @param int $otherId + * @param string $tableName * @param array $tableOperations * @param string $mode * @@ -537,7 +537,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m } /** - * batch merge a set of contacts based on rule-group and group. + * Batch merge a set of contacts based on rule-group and group. * * @param int $rgid rule group id * @param int $gid group id @@ -579,7 +579,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m } /** - * merge given set of contacts. Performs core operation. + * Merge given set of contacts. Performs core operation. * * @param array $dupePairs set of pair of contacts for whom merge is to be done. * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 87f890f26c..98d76401b2 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -35,7 +35,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -75,7 +75,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * add the event + * Add the event * * @param array $params reference array contains the values submitted by the form * @@ -115,7 +115,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * create the event + * Create the event * * @param array $params reference array contains the values submitted by the form * @@ -174,7 +174,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * delete the event + * Delete the event * * @param int $id event id * @@ -224,7 +224,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Function to delete the location block associated with an event, + * Delete the location block associated with an event, * if not being used by any other event. * * @param $locBlockId location block id to be deleted @@ -248,7 +248,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Function to get current/future Events + * Get current/future Events * * @param $all int 0 returns current and future events * 1 if events all are required @@ -310,7 +310,7 @@ WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )"; } /** - * Function to get events Summary + * Get events Summary * * @static * @@ -574,9 +574,9 @@ $event_summary_limit } /** - * Function to get participant count + * Get participant count * - * @param $eventId + * @param int $eventId * @param boolean $considerStatus consider status for participant count. * @param boolean $status consider counted participant. * @param boolean $considerRole consider role for participant count. @@ -635,7 +635,7 @@ $event_summary_limit } /** - * function to get the information to map a event + * Get the information to map a event * * @param int $id for which we want map info * @@ -699,7 +699,7 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL } /** - * function to get the complete information for one or more events + * Get the complete information for one or more events * * @param date $start get events with start date >= this date * @param integer $type get events on the a specific event type (by event_type_id) @@ -1039,9 +1039,9 @@ WHERE civicrm_event.is_active = 1 /** * Process that send e-mails * - * @param $contactID + * @param int $contactID * @param $values - * @param $participantId + * @param int $participantId * @param bool $isTest * @param bool $returnMessageText * @@ -1224,14 +1224,14 @@ WHERE civicrm_event.is_active = 1 } /** - * Function to add the custom fields OR array of participant's + * Add the custom fields OR array of participant's * profile info * - * @param $id - * @param $name - * @param $cid + * @param int $id + * @param string $name + * @param int $cid * @param $template - * @param $participantId + * @param int $participantId * @param $isTest * @param bool $isCustomProfile * @param array $participantParams @@ -1409,7 +1409,7 @@ WHERE civicrm_event.is_active = 1 } /** - * Function to build the array for display the profile fields + * Build the array for display the profile fields * * @param array $params key value. * @param int $gid profile Id @@ -1673,7 +1673,7 @@ WHERE id = $cfID } /** - * Function to build the array for Additional participant's information array of priamry and additional Ids + * Build the array for Additional participant's information array of priamry and additional Ids * * @param int $participantId id of Primary participant * @param array $values key/value event info @@ -1822,7 +1822,7 @@ ORDER BY sp.name, ca.city, ca.street_address ASC } /** - * @param $locBlockId + * @param int $locBlockId * * @return int|null|string */ @@ -1951,7 +1951,7 @@ WHERE ce.loc_block_id = $locBlockId"; } /** - * make sure that the user has permission to access this event + * Make sure that the user has permission to access this event * * @param int $eventId * @param int $type @@ -2049,7 +2049,7 @@ WHERE ce.loc_block_id = $locBlockId"; } /** - * Function to calculate event total seats occupied. + * Calculate event total seats occupied. * * @param int $eventId event id. * @param sting $extraWhereClause extra filter on participants. @@ -2124,7 +2124,7 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field } /** - * @param $event_id + * @param int $event_id * * @return object */ diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index c52c4ff33f..55f45b43ad 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -37,7 +37,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { /** - * static field for all the participant information that we can potentially import + * Static field for all the participant information that we can potentially import * * @var array * @static @@ -45,7 +45,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { static $_importableFields = NULL; /** - * static field for all the participant information that we can potentially export + * Static field for all the participant information that we can potentially export * * @var array * @static @@ -53,7 +53,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { static $_exportableFields = NULL; /** - * static array for valid status transitions rules + * Static array for valid status transitions rules * * @var array * @static @@ -75,7 +75,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { } /** - * takes an associative array and creates a participant object + * Takes an associative array and creates a participant object * * the function extract all the params it needs to initialize the create a * participant object. the params array could contain additional unused name/value @@ -184,7 +184,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { } /** - * takes an associative array and creates a participant object + * Takes an associative array and creates a participant object * * @param array $params (reference ) an assoc array of name/value pairs * @@ -610,7 +610,7 @@ GROUP BY participant.event_id } /** - * combine all the importable fields from the lower levels object + * Combine all the importable fields from the lower levels object * * @param string $contactType * @param bool $status @@ -723,7 +723,7 @@ GROUP BY participant.event_id } /** - * 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 * @access public @@ -776,7 +776,7 @@ GROUP BY participant.event_id } /** - * get the event name/sort name for a particular participation / participant + * Get the event name/sort name for a particular participation / participant * * @param int $participantId id of the participant @@ -956,7 +956,7 @@ WHERE civicrm_participant.id = {$participantId} } /** - * fix the event level + * Fix the event level * * When price sets are used as event fee, fee_level is set as ^A * separated string. We need to change that string to comma @@ -991,12 +991,12 @@ WHERE civicrm_participant.id = {$participantId} } /** - * get the additional participant ids. + * Get the additional participant ids. * * @param int $primaryParticipantId primary partycipant Id * @param boolean $excludeCancel do not include participant those are cancelled. * - * @param null $oldStatusId + * @param int $oldStatusId * * @return array $additionalParticipantIds * @static @@ -1129,8 +1129,8 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * Function for update primary and additional participant status * * @param int $participantID primary participant's id - * @param $oldStatusID - * @param null $newStatusID + * @param int $oldStatusID + * @param int $newStatusID * @param bool $updatePrimaryStatus * * @return bool|void @@ -1429,7 +1429,7 @@ UPDATE civicrm_participant } /** - * send mail and create activity + * Send mail and create activity * when participant status changed. * * @param int $participantId participant id. @@ -1539,11 +1539,11 @@ UPDATE civicrm_participant } /** - * get participant status change message. + * Get participant status change message. * - * @param $participantId + * @param int $participantId * @param $statusChangeTo - * @param $fromStatusId + * @param int $fromStatusId * * @return string * @access public @@ -1577,10 +1577,10 @@ UPDATE civicrm_participant } /** - * get event full and waiting list message. + * Get event full and waiting list message. * - * @param $eventId - * @param null $participantId + * @param int $eventId + * @param int $participantId * * @return string * @access public @@ -1639,9 +1639,9 @@ UPDATE civicrm_participant } /** - * check for whether participant is primary or not + * Check for whether participant is primary or not * - * @param $participantId + * @param int $participantId * * @return true if participant is primary * @access public @@ -1658,7 +1658,7 @@ UPDATE civicrm_participant } /** - * get additional participant Ids for cascading with primary participant status + * Get additional participant Ids for cascading with primary participant status * * @param int $participantId participant id. * @param int $oldStatusId previous status @@ -1687,7 +1687,7 @@ UPDATE civicrm_participant } /** - * get participant record count for a Contact + * Get participant record count for a Contact * * @param int $contactID * @@ -1704,7 +1704,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND } /** - * Function to get participant ids by contribution id + * Get participant ids by contribution id * * @param int $contributionId Contribution Id * @param bool $excludeCancelled Exclude cancelled additional participant @@ -1736,7 +1736,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND } /** - * Function to get additional Participant edit & view url . + * Get additional Participant edit & view url . * * @param array $participantIds an array of additional participant ids. * @@ -1761,7 +1761,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND } /** - * to create trxn entry if an event has discount. + * To create trxn entry if an event has discount. * * @param int $eventID event id * @param array $contributionParams contribution params. @@ -1798,7 +1798,7 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2"; } /** - * Function to delete participants of contact + * Delete participants of contact * * CRM-12155 * @@ -1818,12 +1818,12 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2"; /** * @param array $params - * @param $participantId - * @param $contributionId + * @param int $participantId + * @param int $contributionId * @param $feeBlock - * @param $lineItems + * @param array $lineItems * @param $paidAmount - * @param $priceSetId + * @param int $priceSetId */ static function changeFeeSelections($params, $participantId, $contributionId, $feeBlock, $lineItems, $paidAmount, $priceSetId) { $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); @@ -2004,7 +2004,7 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI /** * @param $updatedAmount * @param $paidAmount - * @param $contributionId + * @param int $contributionId */ static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL) { $balanceAmt = $updatedAmount - $paidAmount; @@ -2068,7 +2068,7 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI } /** - * @param $participantId + * @param int $participantId * @param $activityType * * @throws CRM_Core_Exception diff --git a/CRM/Event/BAO/ParticipantStatusType.php b/CRM/Event/BAO/ParticipantStatusType.php index 344eadbf93..4c6e2123fc 100644 --- a/CRM/Event/BAO/ParticipantStatusType.php +++ b/CRM/Event/BAO/ParticipantStatusType.php @@ -64,7 +64,7 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * @param $id + * @param int $id * * @return bool */ @@ -105,7 +105,7 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * @param $id + * @param int $id * @param $isActive * * @return bool diff --git a/CRM/Event/BAO/Query.php b/CRM/Event/BAO/Query.php index 2e97bd9187..376d3062e0 100644 --- a/CRM/Event/BAO/Query.php +++ b/CRM/Event/BAO/Query.php @@ -56,7 +56,7 @@ class CRM_Event_BAO_Query { } /** - * build select for CiviEvent + * Build select for CiviEvent * * @param $query * @@ -500,7 +500,7 @@ class CRM_Event_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -546,7 +546,7 @@ class CRM_Event_BAO_Query { } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -679,7 +679,7 @@ class CRM_Event_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 84e929a2bb..d09abfb9f3 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -70,7 +70,7 @@ class CRM_Event_Badge { } /** - * create the labels (pdf) + * Create the labels (pdf) * It assumes the participants are from the same event * * @param array $participants @@ -89,7 +89,7 @@ class CRM_Event_Badge { } /** - * @param $eventID + * @param int $eventID * * @return CRM_Event_BAO_Event|null */ @@ -102,7 +102,7 @@ class CRM_Event_Badge { } /** - * @param $eventID + * @param int $eventID * @param bool $img * * @return string @@ -158,7 +158,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']} @@ -171,7 +171,7 @@ class CRM_Event_Badge { function pdfExtraFormat() {} /** - * create labels (pdf) + * Create labels (pdf) * * @param array $participants * diff --git a/CRM/Event/Cart/BAO/Cart.php b/CRM/Event/Cart/BAO/Cart.php index 1fb5a076c7..4e75e7e39b 100644 --- a/CRM/Event/Cart/BAO/Cart.php +++ b/CRM/Event/Cart/BAO/Cart.php @@ -22,7 +22,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $event_id + * @param int $event_id * * @return mixed */ @@ -77,7 +77,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $id + * @param int $id * * @return bool|CRM_Event_Cart_BAO_Cart */ @@ -142,7 +142,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $id + * @param int $id * * @return bool|CRM_Event_Cart_BAO_Cart */ @@ -151,7 +151,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $user_id + * @param int $user_id * * @return bool|CRM_Event_Cart_BAO_Cart */ @@ -174,7 +174,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $main_conference_event_id + * @param int $main_conference_event_id * * @return array */ @@ -231,7 +231,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $event_id + * @param int $event_id * * @return mixed */ @@ -240,7 +240,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $event_in_cart_id + * @param int $event_in_cart_id * * @return null */ @@ -277,7 +277,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $event_in_cart_id + * @param int $event_in_cart_id * * @return bool|CRM_Event_Cart_BAO_EventInCart */ @@ -295,7 +295,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { } /** - * @param $participant_id + * @param int $participant_id * * @return int */ @@ -330,7 +330,7 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart { /** - * @param $from_cart_id + * @param int $from_cart_id */ public function adopt_participants($from_cart_id) { $params = array( diff --git a/CRM/Event/Cart/BAO/Conference.php b/CRM/Event/Cart/BAO/Conference.php index 6b4f7a44b8..f2e23f4927 100644 --- a/CRM/Event/Cart/BAO/Conference.php +++ b/CRM/Event/Cart/BAO/Conference.php @@ -7,7 +7,7 @@ class CRM_Event_Cart_BAO_Conference { //XXX assumes we don't allow a contact to register for the same conference more than once //XXX flattens the object tree for convenient templating /** - * @param $main_event_participant_id + * @param int $main_event_participant_id * * @return array|null */ diff --git a/CRM/Event/Cart/BAO/EventInCart.php b/CRM/Event/Cart/BAO/EventInCart.php index b14baf50cd..20651dadbb 100644 --- a/CRM/Event/Cart/BAO/EventInCart.php +++ b/CRM/Event/Cart/BAO/EventInCart.php @@ -70,7 +70,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $event_cart_id + * @param int $event_cart_id * * @return array */ @@ -96,7 +96,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $id + * @param int $id * * @return bool|CRM_Event_Cart_BAO_EventInCart */ @@ -121,7 +121,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $contact_id + * @param int $contact_id */ public function remove_participant_by_contact_id($contact_id) { $to_remove = array(); @@ -135,7 +135,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $participant_id + * @param int $participant_id * * @return mixed */ @@ -144,7 +144,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $participant_id + * @param int $participant_id */ public function remove_participant_by_id($participant_id) { $this->get_participant_by_id($participant_id)->delete(); @@ -275,7 +275,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param $event_id + * @param int $event_id * * @return array */ @@ -308,7 +308,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl } /** - * @param null $parent_event_id + * @param int $parent_event_id * * @return bool */ diff --git a/CRM/Event/Cart/BAO/MerParticipant.php b/CRM/Event/Cart/BAO/MerParticipant.php index f042668c61..8c035b0c5e 100644 --- a/CRM/Event/Cart/BAO/MerParticipant.php +++ b/CRM/Event/Cart/BAO/MerParticipant.php @@ -94,7 +94,7 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant { } /** - * @param $event_cart_id + * @param int $event_cart_id * * @return array|null */ @@ -106,8 +106,8 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant { } /** - * @param $event_id - * @param $event_cart_id + * @param int $event_id + * @param int $event_cart_id * * @return array|null */ @@ -136,7 +136,7 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant { } /** - * @param $id + * @param int $id * * @return mixed */ diff --git a/CRM/Event/Cart/Form/Cart.php b/CRM/Event/Cart/Form/Cart.php index e45e136843..831a45f8ec 100644 --- a/CRM/Event/Cart/Form/Cart.php +++ b/CRM/Event/Cart/Form/Cart.php @@ -77,7 +77,7 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form { } /** - * @param $event_id + * @param int $event_id * * @return bool|int|null|string */ @@ -140,7 +140,7 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form { } /** - * @param null $registeringContactID + * @param int $registeringContactID * @param array $fields * * @return int|mixed|null @@ -166,7 +166,7 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form { } /** - * @param $page_name + * @param string $page_name * * @return mixed */ diff --git a/CRM/Event/Cart/Form/MerParticipant.php b/CRM/Event/Cart/Form/MerParticipant.php index cf66852784..432b163e1f 100644 --- a/CRM/Event/Cart/Form/MerParticipant.php +++ b/CRM/Event/Cart/Form/MerParticipant.php @@ -42,7 +42,7 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form { } /** - * @param $event_id + * @param int $event_id * * @return array */ @@ -81,9 +81,9 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form { } /** - * @param $event_id - * @param $participant_id - * @param $field_name + * @param int $event_id + * @param int $participant_id + * @param string $field_name * * @return string */ @@ -92,7 +92,7 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form { } /** - * @param $field_name + * @param string $field_name * * @return string */ diff --git a/CRM/Event/Controller/Registration.php b/CRM/Event/Controller/Registration.php index eee6e2fd62..bc913c80b2 100644 --- a/CRM/Event/Controller/Registration.php +++ b/CRM/Event/Controller/Registration.php @@ -35,7 +35,7 @@ class CRM_Event_Controller_Registration extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Event/Controller/Search.php b/CRM/Event/Controller/Search.php index 2fdd7bcf00..ee6a0a0163 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index 4a12c47e5e..11397a3690 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -40,7 +40,7 @@ class CRM_Event_Form_EventFees { /** - * set variables up before form is built + * Set variables up before form is built * * @param CRM_Core_Form $form * @@ -255,8 +255,8 @@ class CRM_Event_Form_EventFees { * * @access public * - * @param $participantID - * @param null $eventID + * @param int $participantID + * @param int $eventID * @param bool $includeQtyZero * * @return void diff --git a/CRM/Event/Form/ManageEvent.php b/CRM/Event/Form/ManageEvent.php index eb40f4f14b..70330d551f 100644 --- a/CRM/Event/Form/ManageEvent.php +++ b/CRM/Event/Form/ManageEvent.php @@ -40,7 +40,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { /** - * the id of the event we are proceessing + * The id of the event we are proceessing * * @var int * @protected @@ -48,7 +48,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { public $_id; /** - * is this the first page? + * Is this the first page? * * @var boolean * @access protected @@ -56,7 +56,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { protected $_first = FALSE; /** - * are we in single form mode or wizard mode? + * Are we in single form mode or wizard mode? * * @var boolean * @access protected @@ -66,13 +66,13 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { protected $_action; /** - * are we actually managing an event template? + * Are we actually managing an event template? * @var boolean */ protected $_isTemplate = FALSE; /** - * pre-populate fields based on this template event_id + * Pre-populate fields based on this template event_id * @var integer */ protected $_templateId; @@ -91,7 +91,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { protected $_isRepeatingEvent; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/Delete.php b/CRM/Event/Form/ManageEvent/Delete.php index 2333050ed2..e0d941cb77 100644 --- a/CRM/Event/Form/ManageEvent/Delete.php +++ b/CRM/Event/Form/ManageEvent/Delete.php @@ -39,7 +39,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { /** - * page title + * Page title * * @var string * @protected @@ -47,7 +47,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { protected $_title; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 2a74a81ce1..e216936d68 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -46,7 +46,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { protected $_eventType = NULL; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -239,7 +239,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values * diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php index e4891bedba..0ec6fd1f10 100644 --- a/CRM/Event/Form/ManageEvent/Fee.php +++ b/CRM/Event/Form/ManageEvent/Fee.php @@ -55,12 +55,12 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { public $_action; /** - * in Date + * In Date */ private $_inDate; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -406,7 +406,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * diff --git a/CRM/Event/Form/ManageEvent/Location.php b/CRM/Event/Form/ManageEvent/Location.php index 96e2ed05cf..3def1e4779 100644 --- a/CRM/Event/Form/ManageEvent/Location.php +++ b/CRM/Event/Form/ManageEvent/Location.php @@ -41,7 +41,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { /** - * how many locationBlocks should we display? + * How many locationBlocks should we display? * * @var int * @const @@ -49,27 +49,27 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { CONST LOCATION_BLOCKS = 1; /** - * the variable, for storing the location array + * The variable, for storing the location array * * @var array */ protected $_locationIds = array(); /** - * the variable, for storing location block id with event + * The variable, for storing location block id with event * * @var int */ protected $_oldLocBlockId = 0; /** - * get the db values for this form + * Get the db values for this form * */ public $_values = array(); /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -139,7 +139,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { } /** - * 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/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 8276aaed8e..7007234830 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -41,7 +41,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent { /** - * what blocks should we show and hide. + * What blocks should we show and hide. * * @var CRM_Core_ShowHideBlocks */ @@ -51,7 +51,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent protected $_profilePostMultipleAdd = array(); /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -316,7 +316,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * build Registration Block + * Build Registration Block * * @param CRM_Core_Form $form * @@ -391,7 +391,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * build Confirmation Block + * Build Confirmation Block * * @param CRM_Core_Form $form * @@ -419,7 +419,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * Function to build Email Block + * Build Email Block * * @param CRM_Core_Form $form * @@ -472,7 +472,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values * @param $files diff --git a/CRM/Event/Form/ManageEvent/ScheduleReminders.php b/CRM/Event/Form/ManageEvent/ScheduleReminders.php index 3097025aa8..763edabb6e 100755 --- a/CRM/Event/Form/ManageEvent/ScheduleReminders.php +++ b/CRM/Event/Form/ManageEvent/ScheduleReminders.php @@ -41,7 +41,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_ManageEvent { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -215,7 +215,7 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage } /** - * 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/Form/Participant.php b/CRM/Event/Form/Participant.php index e5029dba47..a57d376bea 100644 --- a/CRM/Event/Form/Participant.php +++ b/CRM/Event/Form/Participant.php @@ -43,7 +43,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $useLivePageJS = TRUE; /** - * the values for the contribution db object + * The values for the contribution db object * * @var array * @protected @@ -51,7 +51,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_values; /** - * the values for the quickconfig for priceset + * The values for the quickconfig for priceset * * @var boolean * @protected @@ -75,7 +75,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_priceSet; /** - * the id of the participation that we are proceessing + * The id of the participation that we are proceessing * * @var int * @protected @@ -83,7 +83,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_id; /** - * the id of the note + * The id of the note * * @var int * @protected @@ -91,7 +91,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment protected $_noteId = NULL; /** - * the id of the contact associated with this participation + * The id of the contact associated with this participation * * @var int * @protected @@ -99,7 +99,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_contactId; /** - * array of event values + * Array of event values * * @var array * @protected @@ -135,22 +135,22 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment protected $_eventTypeId = NULL; /** - * participant status Id + * Participant status Id */ protected $_statusId = NULL; /** - * cache all the participant statuses + * Cache all the participant statuses */ protected $_participantStatuses; /** - * participant mode + * Participant mode */ public $_mode = NULL; /** - * event ID preselect + * Event ID preselect */ public $_eID = NULL; @@ -167,27 +167,27 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_online; /** - * store id of role custom data type ( option value ) + * Store id of role custom data type ( option value ) */ protected $_roleCustomDataTypeID; /** - * store id of event Name custom data type ( option value) + * Store id of event Name custom data type ( option value) */ protected $_eventNameCustomDataTypeID; /** - * selected discount id + * Selected discount id */ public $_originalDiscountId = NULL; /** - * event id + * Event id */ public $_eventId = NULL; /** - * id of payment, if any + * Id of payment, if any */ public $_paymentId = NULL; @@ -198,7 +198,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment public $_onlinePendingContributionId = NULL; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -796,7 +796,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $values posted values of the form * @param $files diff --git a/CRM/Event/Form/ParticipantView.php b/CRM/Event/Form/ParticipantView.php index c9e4ecfb9b..91b864a524 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 * @access public diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 4dc2c87b66..721b3549d2 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -41,7 +41,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** - * how many locationBlocks should we display? + * How many locationBlocks should we display? * * @var int * @const @@ -49,7 +49,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { CONST LOCATION_BLOCKS = 1; /** - * the id of the event we are proceessing + * The id of the event we are proceessing * * @var int * @protected @@ -57,7 +57,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_eventId; /** - * the array of ids of all the participant we are proceessing + * The array of ids of all the participant we are proceessing * * @var int * @protected @@ -65,7 +65,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { protected $_participantIDS = NULL; /** - * the id of the participant we are proceessing + * The id of the participant we are proceessing * * @var int * @protected @@ -73,7 +73,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { protected $_participantId; /** - * is participant able to walk registration wizard. + * Is participant able to walk registration wizard. * * @var Boolean * @protected @@ -81,7 +81,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_allowConfirmation; /** - * is participant requires approval + * Is participant requires approval * * @var Boolean * @public @@ -89,7 +89,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_requireApproval; /** - * is event configured for waitlist. + * Is event configured for waitlist. * * @var Boolean * @public @@ -97,7 +97,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_allowWaitlist; /** - * store additional participant ids + * Store additional participant ids * when there are pre-registered. * * @var array @@ -106,7 +106,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_additionalParticipantIds; /** - * the mode that we are in + * The mode that we are in * * @var string * @protect @@ -114,7 +114,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_mode; /** - * the values for the contribution db object + * The values for the contribution db object * * @var array * @protected @@ -122,7 +122,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_values; /** - * the paymentProcessor attributes for this page + * The paymentProcessor attributes for this page * * @var array * @protected @@ -190,7 +190,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { public $_isBillingAddressRequiredForPayLater; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -475,7 +475,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * assign the minimal set of variables to the template + * Assign the minimal set of variables to the template * * @return void * @access public @@ -571,10 +571,10 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * add the custom fields + * Add the custom fields * - * @param $id - * @param $name + * @param int $id + * @param string $name * @param bool $viewOnly * * @return void @@ -676,7 +676,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * @param CRM_Core_Form $form - * @param $eventID + * @param int $eventID * * @throws Exception */ @@ -733,9 +733,9 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** - * handle process after the confirmation of payment by User + * Handle process after the confirmation of payment by User * - * @param null $contactID + * @param int $contactID * @param null $contribution * @param null $payment * @@ -839,7 +839,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { * Process the participant * * @param array $params - * @param $contactID + * @param int $contactID * * @return void * @access public @@ -1346,7 +1346,7 @@ WHERE v.option_group_id = g.id // set the first participant ID if not set, CRM-10032 /** - * @param $participantID + * @param int $participantID */ function processFirstParticipant($participantID) { $this->_participantId = $participantID; diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index fc324c0988..40eb6fd667 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -47,13 +47,13 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R public $_defaults = array(); /** - * pre-registered additional participant id. + * Pre-registered additional participant id. * */ public $additionalParticipantId = NULL; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -364,7 +364,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -746,7 +746,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * check whether call current participant is last one + * Check whether call current participant is last one * * @param bool $isButtonJs * @@ -821,7 +821,7 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R } /** - * @param $elementName + * @param string $elementName * @param array $optionIds */ function resetSubmittedValue($elementName, $optionIds = array()) { diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php index 97d65e52c7..41be900951 100644 --- a/CRM/Event/Form/Registration/Confirm.php +++ b/CRM/Event/Form/Registration/Confirm.php @@ -41,7 +41,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { /** - * the values for the contribution db object + * The values for the contribution db object * * @var array * @protected @@ -49,7 +49,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { public $_values; /** - * the total amount + * The total amount * * @var float * @public @@ -57,7 +57,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { public $_totalAmount; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -203,7 +203,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * overwrite action, since we are only showing elements in frozen mode + * Overwrite action, since we are only showing elements in frozen mode * no help display needed * * @return int @@ -868,7 +868,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { * @param CRM_Core_Form $form * @param array $params * @param $result - * @param $contactID + * @param int $contactID * @param bool $pending * @param bool $isAdditionalAmount * @@ -1032,9 +1032,9 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * update contact fields + * Update contact fields * - * @param $contactID + * @param int $contactID * @param array $params * @param $fields * @param CRM_Core_Form $form diff --git a/CRM/Event/Form/Registration/ParticipantConfirm.php b/CRM/Event/Form/Registration/ParticipantConfirm.php index 588168a1c0..9f3a48e215 100644 --- a/CRM/Event/Form/Registration/ParticipantConfirm.php +++ b/CRM/Event/Form/Registration/ParticipantConfirm.php @@ -44,7 +44,7 @@ class CRM_Event_Form_Registration_ParticipantConfirm extends CRM_Event_Form_Regi protected $_cc = NULL; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 9c1b581ddb..aa68f9b115 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -77,13 +77,13 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { public $_noFees; /** - * array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl + * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl * @var array */ public $_paymentFields = array(); /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -543,7 +543,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * build the radio/text form elements for the amount field + * Build the radio/text form elements for the amount field * * @param CRM_Core_Form $form form object * @param boolean $required true if you want to add formRule @@ -800,7 +800,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any @@ -1220,7 +1220,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { */ /** * @param array $params - * @param null $contactID + * @param int $contactID */ public function processRegistration($params, $contactID = NULL) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Event/Form/Registration/ThankYou.php b/CRM/Event/Form/Registration/ThankYou.php index f49560493e..f2d316c4df 100644 --- a/CRM/Event/Form/Registration/ThankYou.php +++ b/CRM/Event/Form/Registration/ThankYou.php @@ -41,7 +41,7 @@ class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -68,7 +68,7 @@ class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration { } /** - * overwrite action, since we are only showing elements in frozen mode + * Overwrite action, since we are only showing elements in frozen mode * no help display needed * * @return int diff --git a/CRM/Event/Form/Search.php b/CRM/Event/Form/Search.php index a29a67b697..1fb279ee12 100644 --- a/CRM/Event/Form/Search.php +++ b/CRM/Event/Form/Search.php @@ -43,7 +43,7 @@ class CRM_Event_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 * @access protected @@ -51,7 +51,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -59,7 +59,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -67,7 +67,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { protected $_limit = NULL; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = "event_"; @@ -75,7 +75,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * the saved search ID retrieved from the GET vars + * The saved search ID retrieved from the GET vars * * @var int * @access protected @@ -83,7 +83,7 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { protected $_ssID; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Event/Form/Task.php b/CRM/Event/Form/Task.php index 572bc45ad4..da1b3ae2eb 100644 --- a/CRM/Event/Form/Task.php +++ b/CRM/Event/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Event_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -68,7 +68,7 @@ class CRM_Event_Form_Task extends CRM_Core_Form { protected $_participantIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -156,7 +156,7 @@ class CRM_Event_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 title of the main button diff --git a/CRM/Event/Form/Task/AddToGroup.php b/CRM/Event/Form/Task/AddToGroup.php index 4519c6a796..9a8e74fb52 100644 --- a/CRM/Event/Form/Task/AddToGroup.php +++ b/CRM/Event/Form/Task/AddToGroup.php @@ -48,21 +48,21 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { 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 * @access public @@ -179,7 +179,7 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $fields posted values of the form * @@ -201,7 +201,7 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Badge.php b/CRM/Event/Form/Task/Badge.php index 2da878a54d..16ee03cdcc 100644 --- a/CRM/Event/Form/Task/Badge.php +++ b/CRM/Event/Form/Task/Badge.php @@ -48,12 +48,12 @@ class CRM_Event_Form_Task_Badge extends CRM_Event_Form_Task { public $_single = FALSE; /** - * component clause + * Component clause */ public $_componentClause; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -108,7 +108,7 @@ class CRM_Event_Form_Task_Badge extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Batch.php b/CRM/Event/Form/Task/Batch.php index 62651c003c..a02352ba19 100644 --- a/CRM/Event/Form/Task/Batch.php +++ b/CRM/Event/Form/Task/Batch.php @@ -39,32 +39,32 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_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; /** - * variable to store previous status id. + * Variable to store previous status id. * */ protected $_fromStatusIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -272,7 +272,7 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * @@ -350,8 +350,8 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task { } /** - * @param $participantId - * @param $statusId + * @param int $participantId + * @param int $statusId * * @return Ambigous|void */ diff --git a/CRM/Event/Form/Task/Cancel.php b/CRM/Event/Form/Task/Cancel.php index 88f9a173e7..a7dd0aaf6a 100644 --- a/CRM/Event/Form/Task/Cancel.php +++ b/CRM/Event/Form/Task/Cancel.php @@ -39,13 +39,13 @@ class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task { /** - * 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 * @access public @@ -72,7 +72,7 @@ class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Delete.php b/CRM/Event/Form/Task/Delete.php index 5a32958873..a9714d6ca6 100644 --- a/CRM/Event/Form/Task/Delete.php +++ b/CRM/Event/Form/Task/Delete.php @@ -49,7 +49,7 @@ class CRM_Event_Form_Task_Delete extends CRM_Event_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 * @access public @@ -88,7 +88,7 @@ class CRM_Event_Form_Task_Delete extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Email.php b/CRM/Event/Form/Task/Email.php index 9fff4804c9..2ef474b055 100644 --- a/CRM/Event/Form/Task/Email.php +++ b/CRM/Event/Form/Task/Email.php @@ -56,14 +56,14 @@ class CRM_Event_Form_Task_Email extends CRM_Event_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 * @access public @@ -92,7 +92,7 @@ class CRM_Event_Form_Task_Email extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/PickProfile.php b/CRM/Event/Form/Task/PickProfile.php index 45c9e4d719..caa0801e12 100644 --- a/CRM/Event/Form/Task/PickProfile.php +++ b/CRM/Event/Form/Task/PickProfile.php @@ -39,26 +39,26 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { /** - * the title of the group + * The title of the group * * @var string */ protected $_title; /** - * maximum event participations that should be allowed to update + * Maximum event participations that should be allowed to update * */ protected $_maxParticipations = 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 * @access public @@ -120,7 +120,7 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { } /** - * global validation rules for the form + * Global validation rules for the form * * @param array $fields posted values of the form * @@ -133,7 +133,7 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Print.php b/CRM/Event/Form/Task/Print.php index 0d97db74eb..711b1221bb 100644 --- a/CRM/Event/Form/Task/Print.php +++ b/CRM/Event/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Event_Form_Task_Print extends CRM_Event_Form_Task { /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -95,7 +95,7 @@ class CRM_Event_Form_Task_Print extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/Result.php b/CRM/Event/Form/Task/Result.php index bf04fc9055..aa1e8845ef 100644 --- a/CRM/Event/Form/Task/Result.php +++ b/CRM/Event/Form/Task/Result.php @@ -41,7 +41,7 @@ class CRM_Event_Form_Task_Result extends CRM_Event_Form_Task { /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public diff --git a/CRM/Event/Form/Task/SaveSearch.php b/CRM/Event/Form/Task/SaveSearch.php index 3577815cc4..c1e0392024 100644 --- a/CRM/Event/Form/Task/SaveSearch.php +++ b/CRM/Event/Form/Task/SaveSearch.php @@ -41,14 +41,14 @@ class CRM_Event_Form_Task_SaveSearch extends CRM_Event_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 * @access public @@ -103,7 +103,7 @@ class CRM_Event_Form_Task_SaveSearch extends CRM_Event_Form_Task { } /** - * process the form after the input has been submitted and validated + * Process the form after the input has been submitted and validated * * @access public * diff --git a/CRM/Event/Form/Task/SaveSearch/Update.php b/CRM/Event/Form/Task/SaveSearch/Update.php index fe3352c979..e5fe41afc3 100644 --- a/CRM/Event/Form/Task/SaveSearch/Update.php +++ b/CRM/Event/Form/Task/SaveSearch/Update.php @@ -40,7 +40,7 @@ class CRM_Event_Form_Task_SaveSearch_Update extends CRM_Event_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 * @access public diff --git a/CRM/Event/Form/Task/SearchTaskHookSample.php b/CRM/Event/Form/Task/SearchTaskHookSample.php index d9e7ecc09a..d4f52bdfcf 100644 --- a/CRM/Event/Form/Task/SearchTaskHookSample.php +++ b/CRM/Event/Form/Task/SearchTaskHookSample.php @@ -39,7 +39,7 @@ class CRM_Event_Form_Task_SearchTaskHookSample extends CRM_Event_Form_Task { /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public diff --git a/CRM/Event/Import/Controller.php b/CRM/Event/Import/Controller.php index 7f61d67f5b..08c31a92f3 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Event/Import/Field.php b/CRM/Event/Import/Field.php index d3195467bb..e6a59724e2 100644 --- a/CRM/Event/Import/Field.php +++ b/CRM/Event/Import/Field.php @@ -36,41 +36,41 @@ class CRM_Event_Import_Field { */ /** - * name of the field + * Name of the field */ public $_name; /** - * title of the field to be used in display + * Title of the field to be used in display */ public $_title; /** - * type of field + * Type of field * @var enum */ public $_type; /** - * regexp to match the CSV header of this column/field + * Regexp to match the CSV header of this column/field * @var string */ public $_headerPattern; /** - * regexp to match the pattern of data from various column/fields + * Regexp to match the pattern of data from various column/fields * @var string */ public $_dataPattern; /** - * value of this field + * Value of this field * @var object */ public $_value; /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern @@ -91,7 +91,7 @@ class CRM_Event_Import_Field { } /** - * the value is in string format. convert the value to the type of this field + * The value is in string format. convert the value to the type of this field * and set the field value with the appropriate type */ function setValue($value) { diff --git a/CRM/Event/Import/Form/DataSource.php b/CRM/Event/Import/Form/DataSource.php index 0237558720..9e94eafc00 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 * @access public diff --git a/CRM/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index 5f9546143f..62eee462d4 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -42,7 +42,7 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -280,7 +280,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 e535257fa5..bdfee42636 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 * @access public diff --git a/CRM/Event/Import/Form/Summary.php b/CRM/Event/Import/Form/Summary.php index 209af3ad5d..0020145af9 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 * @access public diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index 87a227ff40..2055f8646e 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -44,29 +44,29 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { */ /** - * imported file size + * Imported file size */ protected $_fileSize; /** - * seperator being used + * Seperator being used */ 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 */ protected $_haveColumnHeader; /** - * @param $fileName + * @param string $fileName * @param string $seperator * @param $mapper * @param bool $skipColumnHeader @@ -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 * @access public @@ -330,7 +330,7 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { } /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php index 168d738af6..f097124aa5 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 */ function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -66,7 +66,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -124,7 +124,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 * @@ -136,7 +136,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 * @@ -264,7 +264,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 * @param array $values the array of values belonging to this line @@ -500,7 +500,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public diff --git a/CRM/Event/Page/AJAX.php b/CRM/Event/Page/AJAX.php index c3217c6a42..a0ddc764e0 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 */ function eventFee() { diff --git a/CRM/Event/Page/ManageEvent.php b/CRM/Event/Page/ManageEvent.php index e218713a3c..32ed626be9 100644 --- a/CRM/Event/Page/ManageEvent.php +++ b/CRM/Event/Page/ManageEvent.php @@ -241,7 +241,7 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { } /** - * browse all events + * Browse all events * * @return void */ @@ -530,7 +530,7 @@ ORDER BY start_date desc /** * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pager($whereClause, $whereParams) { @@ -556,7 +556,7 @@ SELECT count(id) /** * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pagerAtoZ($whereClause, $whereParams) { diff --git a/CRM/Event/Page/ParticipantListing/NameStatusAndDate.php b/CRM/Event/Page/ParticipantListing/NameStatusAndDate.php index eb498070c8..e5970eedb4 100644 --- a/CRM/Event/Page/ParticipantListing/NameStatusAndDate.php +++ b/CRM/Event/Page/ParticipantListing/NameStatusAndDate.php @@ -123,7 +123,7 @@ LIMIT $offset, $rowCount"; /** * @param $fromClause * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pager($fromClause, $whereClause, $whereParams) { diff --git a/CRM/Event/Page/ParticipantListing/Simple.php b/CRM/Event/Page/ParticipantListing/Simple.php index 67a0aefa5f..d89cba98fb 100644 --- a/CRM/Event/Page/ParticipantListing/Simple.php +++ b/CRM/Event/Page/ParticipantListing/Simple.php @@ -110,7 +110,7 @@ LIMIT $offset, $rowCount"; /** * @param $fromClause * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pager($fromClause, $whereClause, $whereParams) { diff --git a/CRM/Event/Page/UserDashboard.php b/CRM/Event/Page/UserDashboard.php index fef1afdda9..2938a87d3a 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 * * return null * @access public diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index dc1472b762..ff4824d3cc 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -80,7 +80,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { private static $eventType; /** - * event template titles + * Event template titles * @var array */ private static $eventTemplates; @@ -97,7 +97,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param bool $all * @param null $condition * @@ -134,7 +134,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param null $cond * @param string $retColumn tells populate() whether to return 'name' (default) or 'label' values * @@ -183,7 +183,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param null $cond * * @return array - array reference of all participant roles if any @@ -216,7 +216,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * * @return array - array reference of all participant listings if any * @static @@ -239,7 +239,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @return array - array reference of all event types. * @static */ @@ -257,9 +257,9 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * get event template titles + * Get event template titles * - * @param null $id + * @param int $id * * @return array of event id → template title pairs */ @@ -299,7 +299,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @return array - array reference of all pcp if any * @static */ diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 33cd754015..cee0830553 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -86,7 +86,7 @@ class CRM_Event_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 * * @access protected * @var boolean @@ -94,7 +94,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -102,7 +102,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -110,7 +110,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co protected $_context = NULL; /** - * what component context are we being invoked from + * What component context are we being invoked from * * @access protected * @var string @@ -118,7 +118,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co 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 @@ -127,7 +127,7 @@ 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 * @access protected @@ -260,7 +260,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -299,7 +299,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 enum $action the action being performed * @param int $offset the row number to start from @@ -441,7 +441,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -520,7 +520,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Event/StateMachine/Registration.php b/CRM/Event/StateMachine/Registration.php index afb17dd8fe..e07db2e6e0 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 512beaa0c8..5f0f3a36e9 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -93,7 +93,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 * @access public diff --git a/CRM/Event/Task.php b/CRM/Event/Task.php index 3b886ddea7..ee91e2d42b 100644 --- a/CRM/Event/Task.php +++ b/CRM/Event/Task.php @@ -46,7 +46,7 @@ class CRM_Event_Task { LABEL_CONTACTS = 16, GROUP_CONTACTS = 20; /** - * the task array + * The task array * * @var array * @static @@ -54,7 +54,7 @@ class CRM_Event_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -184,7 +184,7 @@ class CRM_Event_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index 54060a5657..fe08bda4ba 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 * @param array $ids contact ids @@ -1171,7 +1171,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 * @param int $mode export mode @@ -1207,7 +1207,7 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c } /** - * handle import error file creation. + * Handle import error file creation. * */ static function invoke() { @@ -1423,7 +1423,7 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c } /** - * @param $tableName + * @param string $tableName * @param $details * @param $sqlColumns */ @@ -1516,10 +1516,10 @@ CREATE TABLE {$exportTempTable} ( } /** - * @param $tableName + * @param string $tableName * @param $headerRows * @param $sqlColumns - * @param $exportParams + * @param array $exportParams */ static function mergeSameAddress($tableName, &$headerRows, &$sqlColumns, $exportParams) { // check if any records are present based on if they have used shared address feature, @@ -1624,8 +1624,8 @@ WHERE id IN ( $deleteIDString ) } /** - * @param $contactId - * @param $exportParams + * @param int $contactId + * @param array $exportParams * * @return array */ @@ -1687,7 +1687,7 @@ WHERE id IN ( $deleteIDString ) /** * @param $sql - * @param $exportParams + * @param array $exportParams * @param bool $sharedAddress * * @return array @@ -1789,7 +1789,7 @@ WHERE id IN ( $deleteIDString ) } /** - * merge household record into the individual record + * Merge household record into the individual record * if exists * * @param string $exportTempTable temporary temp table that stores the records @@ -1927,7 +1927,7 @@ LIMIT $offset, $limit } /** - * Function to manipulate header rows for relationship fields + * Manipulate header rows for relationship fields * */ public static function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) { @@ -1941,7 +1941,7 @@ LIMIT $offset, $limit } /** - * Function to exclude contacts who are deceased, have "Do not mail" privacy setting, + * Exclude contacts who are deceased, have "Do not mail" privacy setting, * or have no street address * */ diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index 261b547869..66544bf10d 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -39,7 +39,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { /** - * mapper fields + * Mapper fields * * @var array * @access protected @@ -47,7 +47,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { protected $_mapperFields; /** - * number of columns in import file + * Number of columns in import file * * @var int * @access protected @@ -55,7 +55,7 @@ class CRM_Export_Form_Map extends CRM_Core_Form { protected $_exportColumnCount; /** - * loaded mapping ID + * Loaded mapping ID * * @var int * @access protected @@ -108,12 +108,12 @@ 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 * * @param $values - * @param $mappingTypeId + * @param int $mappingTypeId * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Export/Form/Select.php b/CRM/Export/Form/Select.php index e8e8e97bed..8f1e1d2fa8 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 * @@ -332,7 +332,7 @@ FROM {$this->_componentTable} } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -445,7 +445,7 @@ FROM {$this->_componentTable} } /** - * build mapping form element + * Build mapping form element * */ function buildMapping() { diff --git a/CRM/Extension/Manager/Module.php b/CRM/Extension/Manager/Module.php index c0e9c05c03..30142f0e8a 100644 --- a/CRM/Extension/Manager/Module.php +++ b/CRM/Extension/Manager/Module.php @@ -60,7 +60,7 @@ class CRM_Extension_Manager_Module extends CRM_Extension_Manager_Base { /** * @param CRM_Extension_Info $info - * @param $hookName + * @param string $hookName */ private function callHook(CRM_Extension_Info $info, $hookName) { try { diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index a56a24db32..dc7433cdcd 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -176,7 +176,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * 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 8c26443cd0..658715d04e 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -329,7 +329,7 @@ class CRM_Extension_Mapper { } /** - * @param $name + * @param string $name * * @return bool */ diff --git a/CRM/Financial/BAO/ExportFormat.php b/CRM/Financial/BAO/ExportFormat.php index 2ced603bf8..d804265e4f 100644 --- a/CRM/Financial/BAO/ExportFormat.php +++ b/CRM/Financial/BAO/ExportFormat.php @@ -52,7 +52,7 @@ class CRM_Financial_BAO_ExportFormat { static protected $_template; /** - * class constructor + * Class constructor */ 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 /** - * @param $exportParams + * @param array $exportParams * * @return mixed */ @@ -177,7 +177,7 @@ class CRM_Financial_BAO_ExportFormat { /** * @param $batchIds - * @param $fileName + * @param string $fileName * * @throws CRM_Core_Exception */ diff --git a/CRM/Financial/BAO/ExportFormat/CSV.php b/CRM/Financial/BAO/ExportFormat/CSV.php index 3c871ba52b..20a79979f6 100644 --- a/CRM/Financial/BAO/ExportFormat/CSV.php +++ b/CRM/Financial/BAO/ExportFormat/CSV.php @@ -48,14 +48,14 @@ class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat ); /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * @param $exportParams + * @param array $exportParams */ function export($exportParams) { $export = parent::export($exportParams); @@ -75,7 +75,7 @@ class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat } /** - * @param $batchId + * @param int $batchId * * @return Object */ diff --git a/CRM/Financial/BAO/ExportFormat/IIF.php b/CRM/Financial/BAO/ExportFormat/IIF.php index cb9003a6ae..1ec4d0a24b 100644 --- a/CRM/Financial/BAO/ExportFormat/IIF.php +++ b/CRM/Financial/BAO/ExportFormat/IIF.php @@ -51,7 +51,7 @@ class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat ); /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -59,7 +59,7 @@ class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat } /** - * @param $exportParams + * @param array $exportParams */ function export( $exportParams ) { parent::export( $exportParams ); @@ -91,7 +91,7 @@ class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat } /** - * @param $batchId + * @param int $batchId * * @return Object */ diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 85f29a15d5..70aa059616 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -37,12 +37,12 @@ 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 */ function __construct() { parent::__construct(); @@ -69,7 +69,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 * @param boolean $is_active value we want to set the is_active field @@ -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 * @param array $ids reference array contains the id @@ -116,7 +116,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco } /** - * delete financial Types + * Delete financial Types * * @param int $financialAccountId * @static @@ -152,11 +152,11 @@ 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 * * @financialTypeId int Financial Type Id * - * @param $financialTypeId + * @param int $financialTypeId * * @return accounting code * @static @@ -177,7 +177,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 e3d6c5684f..49f207b851 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -36,7 +36,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** - * class constructor + * Class constructor */ function __construct( ) { parent::__construct( ); @@ -63,7 +63,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 * @param object $contribution contribution object @@ -127,7 +127,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 * @param array $ids financial item ids @@ -164,7 +164,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 * @@ -180,7 +180,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 * @param bool $maxId to retrive max id @@ -216,7 +216,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 9b99f007ec..eb4685bb49 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -37,12 +37,12 @@ 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 */ function __construct( ) { parent::__construct( ); @@ -69,7 +69,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 * @param boolean $is_active value we want to set the is_active field @@ -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 * @param array $ids reference array contains the id @@ -114,7 +114,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * delete financial Types + * Delete financial Types * * @param int $financialTypeId * @@ -161,7 +161,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * to fetch financial type having relationship as Income Account is + * To fetch financial type having relationship as Income Account is * * * @return array all financial type with income account is relationship diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 2bb670fcec..6538e520d1 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -36,14 +36,14 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFinancialAccount { /** - * class constructor + * Class constructor */ function __construct( ) { parent::__construct( ); } /** - * financial account + * Financial account * @var array * @static */ @@ -73,7 +73,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 * @param array $ids reference array contains the id @@ -102,7 +102,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * delete financial Types + * Delete financial Types * * @param int $financialTypeAccountId * @param int $accountId @@ -158,7 +158,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin } /** - * get Financial Account Name + * Get Financial Account Name * * @param int $entityId * @@ -186,7 +186,7 @@ AND entity_id = %2"; } /** - * Function to financial Account for payment instrument + * Financial Account for payment instrument * * @param int $paymentInstrumentValue payment instrument value * @@ -218,7 +218,7 @@ WHERE cog.name = 'payment_instrument' "; } /** - * Function to create default entity financial accounts + * Create default entity financial accounts * for financial type * CRM-12470 * diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 017c373ac4..6032409d5e 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -39,7 +39,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProcessor { /** - * static holder for the default payment processor + * Static holder for the default payment processor */ static $_defaultPaymentProcessor = NULL; @@ -85,7 +85,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -114,7 +114,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 * @param boolean $is_active value we want to set the is_active field @@ -129,7 +129,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * retrieve the default payment processor + * Retrieve the default payment processor * * @param NULL * @@ -176,7 +176,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 * @param string $mode payment mode ie test or live @@ -235,7 +235,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * compare 2 payment processors to see which should go first based on is_default + * Compare 2 payment processors to see which should go first based on is_default * (sort function for sortDefaultFirst) * @param array $processor1 * @param array_type $processor2 @@ -251,7 +251,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 * @param string $mode payment mode ie test or live @@ -279,7 +279,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * get all payment processors as an array of objects. + * Get all payment processors as an array of objects. * * @param $isExcludeTest * @param bool $reset @@ -313,7 +313,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * get Payment processors with specified capabilities. + * Get Payment processors with specified capabilities. * Note that both the singleton & the pseudoconstant function have caching so we don't add * arguably this could go on the pseudoconstant class * @@ -359,9 +359,9 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * retrieve payment processor id / info/ object based on component-id. + * Retrieve payment processor id / info/ object based on component-id. * - * @param $entityID + * @param int $entityID * @param string $component component * @param string $type type of payment information to be retrieved * diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 52d371e7ec..bda9cd5521 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -35,12 +35,12 @@ 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 */ function __construct() { parent::__construct(); @@ -67,7 +67,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 * @param boolean $is_active value we want to set the is_active field @@ -82,7 +82,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * retrieve the default payment processor + * Retrieve the default payment processor * * @param NULL * @@ -101,7 +101,7 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr } /** - * add the payment-processor type in the db + * Add the payment-processor type in the db * * @param array $params (reference ) an assoc array of name/value pairs * @@ -170,7 +170,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/Export.php b/CRM/Financial/Form/Export.php index e40815db29..e185156184 100644 --- a/CRM/Financial/Form/Export.php +++ b/CRM/Financial/Form/Export.php @@ -64,7 +64,7 @@ class CRM_Financial_Form_Export extends CRM_Core_Form { protected $_exportFormat; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @return void * @access public @@ -153,7 +153,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 * * @access public * @return void diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index 628bee7ae5..b72daebf3d 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -48,7 +48,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -128,7 +128,7 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { } /** - * global validation rules for the form + * Global validation rules for the form * * @param $values * @param $files diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index f153c5fdcf..66ec7ce3bf 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -48,7 +48,7 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { protected $_id; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -173,7 +173,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 @@ -291,13 +291,13 @@ 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 - * @param $createdID - * @param $userContactID - * @param $actionName + * @param int $createdID + * @param int $userContactID + * @param string $actionName * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Financial/Form/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index ef0545b45e..5d89b9a2e4 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 * @access protected @@ -70,7 +70,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { protected $_isARFlag = FALSE; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -232,7 +232,7 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { } /** - * global validation rules for the form + * Global validation rules for the form * * @param $values * @param $files diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index 26cfe7195a..39851a92eb 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -92,7 +92,7 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { } /** - * browse all entities. + * Browse all entities. * * @return void * @access public diff --git a/CRM/Financial/Page/FinancialTypeAccount.php b/CRM/Financial/Page/FinancialTypeAccount.php index 000afe8cef..9f6d441b2d 100644 --- a/CRM/Financial/Page/FinancialTypeAccount.php +++ b/CRM/Financial/Page/FinancialTypeAccount.php @@ -197,7 +197,7 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { } /** - * edit CiviCRM Financial Type Account data. + * Edit CiviCRM Financial Type Account data. * * editing would involved modifying existing financial Account Type + adding data * to new financial Account Type. diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 058ae754b7..8acbf425fe 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -46,7 +46,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 @@ -87,7 +87,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 * @@ -333,7 +333,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 22d6b6947f..ed2b59f257 100644 --- a/CRM/Friend/Form.php +++ b/CRM/Friend/Form.php @@ -45,7 +45,7 @@ class CRM_Friend_Form extends CRM_Core_Form { 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 @@ -53,7 +53,7 @@ class CRM_Friend_Form extends CRM_Core_Form { protected $_entityId; /** - * the table name of the entity that we are proceessing + * The table name of the entity that we are proceessing * * @var string * @protected @@ -63,7 +63,7 @@ class CRM_Friend_Form extends CRM_Core_Form { protected $_campaignId; /** - * the contact ID + * The contact ID * * @var int * @protected @@ -229,7 +229,7 @@ class CRM_Friend_Form extends CRM_Core_Form { } /** - * validation + * Validation * * @param array $fields * diff --git a/CRM/Friend/Form/Contribute.php b/CRM/Friend/Form/Contribute.php index 2257127b12..cf47fad578 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 */ diff --git a/CRM/Friend/Form/Event.php b/CRM/Friend/Form/Event.php index 1ec298b995..d7da13322f 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 */ diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index 17e5362bf5..937a704355 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -35,21 +35,21 @@ 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 */ static $_exportableFields = NULL; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * get events Summary + * Get events Summary * * @static * @@ -89,7 +89,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * get events Summary + * Get events Summary * * @static * @@ -111,7 +111,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * retrieve statistics for grants. + * Retrieve statistics for grants. * * @static * @@ -144,7 +144,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * function to add grant + * Add grant * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -245,7 +245,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * function to create the event + * Create the event * * @param array $params reference array contains the values submitted by the form * @param array $ids reference array contains the id @@ -308,7 +308,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to delete the Contact + * Delete the Contact * * @param int $id contact id * @@ -325,7 +325,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to delete the grant + * Delete the grant * * @param int $id grant id * @@ -358,7 +358,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 * @access public @@ -413,7 +413,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { } /** - * Function to 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 9c960b2ed1..59e49649bb 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -44,7 +44,7 @@ class CRM_Grant_BAO_Query { } /** - * build select for CiviGrant + * Build select for CiviGrant * * @param $query * @@ -277,7 +277,7 @@ class CRM_Grant_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -314,7 +314,7 @@ class CRM_Grant_BAO_Query { } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -353,7 +353,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 * * @access public * @@ -425,7 +425,7 @@ class CRM_Grant_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} diff --git a/CRM/Grant/Controller/Search.php b/CRM/Grant/Controller/Search.php index df428e3db7..676959b326 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 */ 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 a32dbadfe5..9ef1e291bb 100644 --- a/CRM/Grant/Form/Grant.php +++ b/CRM/Grant/Form/Grant.php @@ -40,7 +40,7 @@ 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 @@ -48,7 +48,7 @@ class CRM_Grant_Form_Grant extends CRM_Core_Form { protected $_id; /** - * the id of the contact associated with this contribution + * The id of the contact associated with this contribution * * @var int * @protected @@ -58,7 +58,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 * @access public diff --git a/CRM/Grant/Form/GrantView.php b/CRM/Grant/Form/GrantView.php index 83264294d1..5e2299950b 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 * @access public diff --git a/CRM/Grant/Form/Search.php b/CRM/Grant/Form/Search.php index 916d558171..b3c45e63c0 100644 --- a/CRM/Grant/Form/Search.php +++ b/CRM/Grant/Form/Search.php @@ -43,7 +43,7 @@ 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 * @access protected @@ -51,7 +51,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -59,7 +59,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -67,7 +67,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { protected $_limit = NULL; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = "grant_"; @@ -75,7 +75,7 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php index 9d05b50835..ade61be9fa 100644 --- a/CRM/Grant/Form/Task.php +++ b/CRM/Grant/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -68,7 +68,7 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { 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 title of the main button diff --git a/CRM/Grant/Form/Task/Delete.php b/CRM/Grant/Form/Task/Delete.php index d3a4ad78d5..a80f499100 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 * @access public @@ -74,7 +74,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 * * @access public * diff --git a/CRM/Grant/Form/Task/Print.php b/CRM/Grant/Form/Task/Print.php index 75783e00db..a217d8615b 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 * @access public @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Grant/Form/Task/Result.php b/CRM/Grant/Form/Task/Result.php index b9b331e6f3..032ad7849e 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 * @access public diff --git a/CRM/Grant/Form/Task/SearchTaskHookSample.php b/CRM/Grant/Form/Task/SearchTaskHookSample.php index 556fd2da3e..e17e4634c8 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 * @access public diff --git a/CRM/Grant/Form/Task/Update.php b/CRM/Grant/Form/Task/Update.php index 1bc0ccaa6d..be86de27cf 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 * @access public @@ -78,7 +78,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 * * @access public * diff --git a/CRM/Grant/Page/Tab.php b/CRM/Grant/Page/Tab.php index 0094dcdc17..55d1e80e01 100644 --- a/CRM/Grant/Page/Tab.php +++ b/CRM/Grant/Page/Tab.php @@ -101,7 +101,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 * @access public diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 9b9e678e16..9bb64c984b 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -80,7 +80,7 @@ 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 * * @access protected * @var boolean @@ -88,7 +88,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -96,7 +96,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -104,7 +104,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co 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 @@ -113,7 +113,7 @@ 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 * @access protected @@ -222,7 +222,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -261,7 +261,7 @@ class CRM_Grant_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 enum $action the action being performed * @param int $offset the row number to start from @@ -341,7 +341,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -413,7 +413,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index 689aec8852..66a32e9a8b 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -93,7 +93,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 * @access public diff --git a/CRM/Grant/Task.php b/CRM/Grant/Task.php index d5012f2a98..75da793762 100644 --- a/CRM/Grant/Task.php +++ b/CRM/Grant/Task.php @@ -42,7 +42,7 @@ class CRM_Grant_Task { CONST DELETE_GRANTS = 1, PRINT_GRANTS = 2, EXPORT_GRANTS = 3, UPDATE_GRANTS = 4; /** - * the task array + * The task array * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Grant_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -117,7 +117,7 @@ class CRM_Grant_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Group/Controller.php b/CRM/Group/Controller.php index a62c48b422..6a1ede8810 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php index 43a8069947..14dbd84bdd 100644 --- a/CRM/Group/Form/Edit.php +++ b/CRM/Group/Form/Edit.php @@ -39,14 +39,14 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { /** - * the group id, used when editing a group + * The group id, used when editing a group * * @var int */ protected $_id; /** - * the group object, if an id is present + * The group object, if an id is present * * @var object */ @@ -67,21 +67,21 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { protected $_groupValues; /** - * what blocks should we show and hide. + * What blocks should we show and hide. * * @var CRM_Core_ShowHideBlocks */ protected $_showHide; /** - * the civicrm_group_organization table id + * The civicrm_group_organization table id * * @var int */ protected $_groupOrganizationID; /** - * set up variables to build the form + * Set up variables to build the form * * @return void * @acess protected @@ -308,10 +308,10 @@ 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 - * @param $fileParams + * @param array $fileParams * @param $options * * @return array list of errors to be posted back to the form diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index dd491577ab..ed37d36c66 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 * * @return array self::$_links array of action links * @access public @@ -51,7 +51,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { function &links() {} /** - * return class name of edit form + * Return class name of edit form * * @return string * @access public @@ -61,7 +61,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * return name of edit form + * Return name of edit form * * @return string * @access public @@ -71,7 +71,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * return name of delete form + * Return name of delete form * * @return string * @access public @@ -81,7 +81,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 * @@ -93,7 +93,7 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { } /** - * return user context uri params + * Return user context uri params * * @param null $mode * @@ -105,7 +105,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 * @param int $title name or title of the object diff --git a/CRM/Group/StateMachine.php b/CRM/Group/StateMachine.php index 12db034fe0..d32b159107 100644 --- a/CRM/Group/StateMachine.php +++ b/CRM/Group/StateMachine.php @@ -35,7 +35,7 @@ class CRM_Group_StateMachine extends CRM_Core_StateMachine { /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -51,7 +51,7 @@ class CRM_Group_StateMachine extends CRM_Core_StateMachine { } /** - * return the form name of the task. This is + * Return the form name of the task. This is * * @return string * @access public diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 2722a11307..2dfc0ae754 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -50,7 +50,7 @@ abstract class CRM_Import_DataSource { abstract public function getInfo(); /** - * set variables up before form is built + * Set variables up before form is built * * @access public */ diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 0670fc8b67..12026b7f43 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -49,7 +49,7 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * set variables up before form is built + * Set variables up before form is built * * @access public */ diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php index 1f17917189..43d47c138f 100644 --- a/CRM/Import/DataSource/SQL.php +++ b/CRM/Import/DataSource/SQL.php @@ -47,7 +47,7 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { } /** - * set variables up before form is built + * Set variables up before form is built * * @access public */ diff --git a/CRM/Import/Form/MapField.php b/CRM/Import/Form/MapField.php index ec2291ae58..c3bdecf297 100644 --- a/CRM/Import/Form/MapField.php +++ b/CRM/Import/Form/MapField.php @@ -40,7 +40,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { /** - * cache of preview data values + * Cache of preview data values * * @var array * @access protected @@ -48,7 +48,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { protected $_dataValues; /** - * mapper fields + * Mapper fields * * @var array * @access protected @@ -56,7 +56,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { protected $_mapperFields; /** - * loaded mapping ID + * Loaded mapping ID * * @var int * @access protected @@ -64,7 +64,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { protected $_loadedMappingId; /** - * number of columns in import file + * Number of columns in import file * * @var int * @access protected @@ -72,7 +72,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { protected $_columnCount; /** - * column headers, if we have them + * Column headers, if we have them * * @var array * @access protected @@ -80,7 +80,7 @@ abstract class CRM_Import_Form_MapField extends CRM_Core_Form { protected $_columnHeaders; /** - * an array of booleans to keep track of whether a field has been used in + * An array of booleans to keep track of whether a field has been used in * form building already. * * @var array diff --git a/CRM/Import/Parser.php b/CRM/Import/Parser.php index 3115239ed4..d506c725b7 100644 --- a/CRM/Import/Parser.php +++ b/CRM/Import/Parser.php @@ -62,81 +62,81 @@ abstract class CRM_Import_Parser { /** - * total number of non empty lines + * Total number of non empty lines */ protected $_totalCount; /** - * running total number of valid lines + * Running total number of valid lines */ protected $_validCount; /** - * running total number of invalid rows + * Running total number of invalid rows */ protected $_invalidRowCount; /** - * maximum number of non-empty/comment lines to process + * Maximum number of non-empty/comment lines to process * * @var int */ protected $_maxLinesToProcess; /** - * maximum number of invalid rows to store + * Maximum number of invalid rows to store */ protected $_maxErrorCount; /** - * array of error lines, bounded by MAX_ERROR + * Array of error lines, bounded by MAX_ERROR */ protected $_errors; /** - * total number of conflict lines + * Total number of conflict lines */ protected $_conflictCount; /** - * array of conflict lines + * Array of conflict lines */ protected $_conflicts; /** - * total number of duplicate (from database) lines + * Total number of duplicate (from database) lines */ protected $_duplicateCount; /** - * array of duplicate lines + * Array of duplicate lines */ protected $_duplicates; /** - * running total number of warnings + * Running total number of warnings */ protected $_warningCount; /** - * maximum number of warnings to store + * Maximum number of warnings to store */ protected $_maxWarningCount = self::MAX_WARNINGS; /** - * array of warning lines, bounded by MAX_WARNING + * Array of warning lines, bounded by MAX_WARNING */ protected $_warnings; /** - * array of all the fields that could potentially be part + * Array of all the fields that could potentially be part * of this import process * @var array */ protected $_fields; /** - * array of the fields that are actually part of the import process + * Array of the fields that are actually part of the import process * the position in the array also dictates their position in the import * file * @var array @@ -144,42 +144,42 @@ abstract class CRM_Import_Parser { protected $_activeFields; /** - * cache the count of active fields + * Cache the count of active fields * * @var int */ protected $_activeFieldCount; /** - * cache of preview rows + * Cache of preview rows * * @var array */ protected $_rows; /** - * filename of error data + * Filename of error data * * @var string */ protected $_errorFileName; /** - * filename of conflict data + * Filename of conflict data * * @var string */ protected $_conflictFileName; /** - * filename of duplicate data + * Filename of duplicate data * * @var string */ protected $_duplicateFileName; /** - * contact type + * Contact type * * @var int */ @@ -353,7 +353,7 @@ abstract class CRM_Import_Parser { } /** - * setter function + * Setter function * * @param int $max * diff --git a/CRM/Logging/Differ.php b/CRM/Logging/Differ.php index ced2440823..75ba438825 100644 --- a/CRM/Logging/Differ.php +++ b/CRM/Logging/Differ.php @@ -39,7 +39,7 @@ class CRM_Logging_Differ { private $interval; /** - * @param $log_conn_id + * @param int $log_conn_id * @param $log_date * @param string $interval */ @@ -69,7 +69,7 @@ class CRM_Logging_Differ { /** * @param $table - * @param null $contactID + * @param int $contactID * * @return array */ @@ -152,7 +152,7 @@ WHERE lt.log_conn_id = %1 AND /** * @param $table - * @param $id + * @param int $id * * @return array */ diff --git a/CRM/Logging/ReportSummary.php b/CRM/Logging/ReportSummary.php index 0e1a381254..e29071a9e1 100644 --- a/CRM/Logging/ReportSummary.php +++ b/CRM/Logging/ReportSummary.php @@ -355,7 +355,7 @@ ORDER BY log_civicrm_entity_log_date DESC {$this->_limit}"; } /** - * @param $id + * @param int $id * @param $entity * @param $logDate * @@ -402,8 +402,8 @@ WHERE log_date <= %1 AND id = %2 ORDER BY log_date DESC LIMIT 1"; } /** - * @param $id - * @param $connId + * @param int $id + * @param int $connId * @param $entity * @param $oldAction * diff --git a/CRM/Logging/Reverter.php b/CRM/Logging/Reverter.php index 409dabcbb4..ed62765d6d 100644 --- a/CRM/Logging/Reverter.php +++ b/CRM/Logging/Reverter.php @@ -38,7 +38,7 @@ class CRM_Logging_Reverter { private $log_date; /** - * @param $log_conn_id + * @param int $log_conn_id * @param $log_date */ function __construct($log_conn_id, $log_date) { diff --git a/CRM/Mailing/BAO/BouncePattern.php b/CRM/Mailing/BAO/BouncePattern.php index cdf64941af..462d948dd2 100644 --- a/CRM/Mailing/BAO/BouncePattern.php +++ b/CRM/Mailing/BAO/BouncePattern.php @@ -40,7 +40,7 @@ class CRM_Mailing_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern { static $_patterns = NULL; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index ca4f1019e8..88c869cb22 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -35,7 +35,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 8fb997358a..f381ac3d07 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -89,15 +89,15 @@ class CRM_Mailing_BAO_Mailing extends CRM_Mailing_DAO_Mailing { private $_domain = NULL; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * @param $job_id - * @param null $mailing_id + * @param int $job_id + * @param int $mailing_id * @param null $mode * * @return int @@ -112,8 +112,8 @@ class CRM_Mailing_BAO_Mailing extends CRM_Mailing_DAO_Mailing { // note that $job_id is used only as a variable in the temp table construction // and does not play a role in the queries generated /** - * @param $job_id - * @param null $mailing_id + * @param int $job_id + * @param int $mailing_id * @param null $offset * @param null $limit * @param bool $storeRecipients @@ -1021,7 +1021,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 * @param int $event_queue_id ID of the EventQueue @@ -1043,7 +1043,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * get verp, urls and headers + * Get verp, urls and headers * * @param int $job_id ID of the Job associated with this message * @param int $event_queue_id ID of the EventQueue @@ -1505,7 +1505,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 * @param array $ids reference array contains the id @@ -1705,7 +1705,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * get hash value of the mailing + * Get hash value of the mailing * */ public static function getMailingHash($id) { @@ -2214,7 +2214,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * @param $id + * @param int $id * * @throws Exception */ @@ -2256,7 +2256,7 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** - * returns all the mailings that this user can access. This is dependent on + * Returns all the mailings that this user can access. This is dependent on * all the groups that the user has access to. * However since most civi installs dont use ACL's we special case the condition * where the user has access to ALL groups, and hence ALL mailings and return a @@ -2311,7 +2311,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id * @param string $sort The sql string that describes the sort order * * @param null $additionalClause - * @param null $additionalParams + * @param array $additionalParams * * @return array The rows * @access public @@ -2398,7 +2398,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * show detail Mailing report + * Show detail Mailing report * * @param int $id * @@ -2496,7 +2496,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 * @@ -2589,7 +2589,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id } /** - * Function to build the compose PDF letter form + * Build the compose PDF letter form * * @param CRM_Core_Form $form * @@ -2729,7 +2729,7 @@ SELECT $mailing.id as mailing_id } /** - * @param $jobID + * @param int $jobID * * @return mixed */ @@ -2807,7 +2807,7 @@ WHERE civicrm_mailing_job.id = %1 } /** - * @param $mailingID + * @param int $mailingID */ private static function addMultipleEmails($mailingID) { $sql = " @@ -2857,7 +2857,7 @@ ORDER BY civicrm_mailing.name"; } /** - * @param $mid + * @param int $mid * * @return null|string */ @@ -2962,7 +2962,7 @@ AND m.id = %1 } /** - * Function to retrieve contact mailing + * Retrieve contact mailing * * @param array $params associated array * @@ -2982,7 +2982,7 @@ AND m.id = %1 } /** - * Function to retrieve contact mailing count + * Retrieve contact mailing count * * @param array $params associated array * diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 8d04107830..e7b6865e46 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -42,7 +42,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { CONST MAX_CONTACTS_TO_PROCESS = 1000; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -68,7 +68,7 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { /** * Initiate all pending/ready jobs * - * @param null $testParams + * @param array $testParams * @param null $mode * * @return void @@ -421,7 +421,7 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) } /** - * @param null $testParams + * @param array $testParams */ public function queue($testParams = NULL) { $mailing = new CRM_Mailing_BAO_Mailing(); @@ -473,7 +473,7 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) * * @param object $mailer A Mail object to send the messages * - * @param null $testParams + * @param array $testParams * * @return void * @access public @@ -800,7 +800,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 * @static @@ -893,8 +893,8 @@ AND status IN ( 'Scheduled', 'Running', 'Paused' ) } /** - * @param $deliveredParams - * @param $targetParams + * @param array $deliveredParams + * @param array $targetParams * @param $mailing * @param $job_date * diff --git a/CRM/Mailing/BAO/Query.php b/CRM/Mailing/BAO/Query.php index ab966d346b..dcea6d6050 100644 --- a/CRM/Mailing/BAO/Query.php +++ b/CRM/Mailing/BAO/Query.php @@ -51,7 +51,7 @@ class CRM_Mailing_BAO_Query { } /** - * if mailings are involved, add the specific Mailing fields + * If mailings are involved, add the specific Mailing fields * * @param $query * @@ -145,7 +145,7 @@ class CRM_Mailing_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -375,11 +375,11 @@ 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 * * @access public * - * @param $form CRM_Core_Form + * @param CRM_Core_Form $form * @return void * @static */ @@ -427,7 +427,7 @@ class CRM_Mailing_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} @@ -442,8 +442,8 @@ class CRM_Mailing_BAO_Query { * * @param $query * @param $values - * @param $tableName - * @param $fieldName + * @param string $tableName + * @param string $fieldName * @param $fieldTitle * * @param $valueTitles diff --git a/CRM/Mailing/BAO/Recipients.php b/CRM/Mailing/BAO/Recipients.php index 841b71852e..b46f384101 100644 --- a/CRM/Mailing/BAO/Recipients.php +++ b/CRM/Mailing/BAO/Recipients.php @@ -35,14 +35,14 @@ class CRM_Mailing_BAO_Recipients extends CRM_Mailing_DAO_Recipients { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * @param $mailingID + * @param int $mailingID * * @return null|string */ @@ -57,7 +57,7 @@ WHERE mailing_id = %1 } /** - * @param $mailingID + * @param int $mailingID * @param null $offset * @param null $limit * diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php index 2d45073702..a9aed38f9b 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 */ function __construct() { parent::__construct(); @@ -50,7 +50,7 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool { * @param string $body The full text of the message body, including any * Mime parts, etc. * - * @param null $job_id + * @param int $job_id * * @internal param mixed $recipients Either a comma-seperated list of recipients * (RFC822 compliant), or an array of recipients, diff --git a/CRM/Mailing/BAO/TrackableURL.php b/CRM/Mailing/BAO/TrackableURL.php index 0f74237440..f00780e1e8 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 */ function __construct() { parent::__construct(); @@ -106,8 +106,8 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL { /** * @param $msg - * @param $mailing_id - * @param $queue_id + * @param int $mailing_id + * @param int $queue_id * @param bool $onlyHrefs */ public static function scan_and_replace(&$msg, $mailing_id, $queue_id, $onlyHrefs = FALSE) { diff --git a/CRM/Mailing/Controller/Send.php b/CRM/Mailing/Controller/Send.php index 9ccf52cc08..7dbf98c88e 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal, NULL, FALSE, TRUE); diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index c6f38080af..50b5b12781 100644 --- 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 */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Confirm.php b/CRM/Mailing/Event/BAO/Confirm.php index f29ec3c2b7..f786cbd452 100644 --- a/CRM/Mailing/Event/BAO/Confirm.php +++ b/CRM/Mailing/Event/BAO/Confirm.php @@ -41,7 +41,7 @@ require_once 'Mail/mime.php'; class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php index 2bfac17eba..f695a94844 100644 --- a/CRM/Mailing/Event/BAO/Delivered.php +++ b/CRM/Mailing/Event/BAO/Delivered.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Forward.php b/CRM/Mailing/Event/BAO/Forward.php index d9a5686649..44dfc3f10e 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 */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 97ea5004b3..6e356448cd 100644 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -210,7 +210,7 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * @param int $rowCount Number of rows * @param array $sort sort array * - * @param null $contact_id + * @param int $contact_id * * @return array Result set * @access public diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index 7e9f98f0b5..b565ee3eeb 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -35,7 +35,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -270,7 +270,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * @param $queueID + * @param int $queueID * * @return array */ diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index cac6deb61a..ef3c4aa5d7 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 */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index ff95059a92..09ef2ffe62 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 */ function __construct() { parent::__construct(); @@ -359,7 +359,7 @@ SELECT civicrm_email.id as email_id } /** - * send subscribe mail + * Send subscribe mail * * @param array $groups the list of group ids for subscribe * @param array $params the list of email diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index 774defeb8a..93b06573eb 100644 --- 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 */ function __construct() { parent::__construct(); diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index 75724efbc2..e6ca19d5a7 100644 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -41,7 +41,7 @@ require_once 'Mail/mime.php'; class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscribe { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -567,7 +567,7 @@ WHERE email = %2 } /** - * @param $queueID + * @param int $queueID * * @return array */ diff --git a/CRM/Mailing/Form/Approve.php b/CRM/Mailing/Form/Approve.php index c47560999b..cd0fe402dd 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 * @access public diff --git a/CRM/Mailing/Form/Component.php b/CRM/Mailing/Form/Component.php index 2ed18fe415..653950d18d 100644 --- a/CRM/Mailing/Form/Component.php +++ b/CRM/Mailing/Form/Component.php @@ -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/Group.php b/CRM/Mailing/Form/Group.php index 415c73f19f..de4749df23 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 * @access public @@ -541,7 +541,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 e70dca722e..e814fef894 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 * @access public diff --git a/CRM/Mailing/Form/Settings.php b/CRM/Mailing/Form/Settings.php index 82b5bd73bb..f9d5df16b3 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 * @access public diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php index f63ac9dcfe..95c2385f33 100644 --- a/CRM/Mailing/Form/Task.php +++ b/CRM/Mailing/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -61,7 +61,7 @@ class CRM_Mailing_Form_Task extends CRM_Core_Form { protected $_componentIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -134,7 +134,7 @@ class CRM_Mailing_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 title of the main button diff --git a/CRM/Mailing/Form/Task/Print.php b/CRM/Mailing/Form/Task/Print.php index 8a7ddfaaf2..4c9620afc5 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 * @access public @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index 944d6057fa..620d6b9c54 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 * @access public diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index 8f03b9c0d4..017837db91 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -501,7 +501,7 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/Mailing/Page/AJAX.php b/CRM/Mailing/Page/AJAX.php index e4416dbeae..64b20f2fb3 100644 --- a/CRM/Mailing/Page/AJAX.php +++ b/CRM/Mailing/Page/AJAX.php @@ -39,7 +39,7 @@ class CRM_Mailing_Page_AJAX { /** - * fetch the template text/html messages + * Fetch the template text/html messages */ public static function template() { $templateId = CRM_Utils_Type::escape($_POST['tid'], 'Integer'); @@ -60,7 +60,7 @@ class CRM_Mailing_Page_AJAX { } /** - * 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 0c6d2f908f..c80ca1e998 100644 --- a/CRM/Mailing/Page/Browse.php +++ b/CRM/Mailing/Page/Browse.php @@ -42,7 +42,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 * @access protected @@ -50,7 +50,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { protected $_fields; /** - * the mailing id of the mailing we're operating on + * The mailing id of the mailing we're operating on * * @int * @access protected @@ -58,7 +58,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { protected $_mailingId; /** - * the action that we are performing (in CRM_Core_Action terms) + * The action that we are performing (in CRM_Core_Action terms) * * @int * @access protected @@ -71,7 +71,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { public $_archived; /** - * scheduled mailing + * Scheduled mailing * * @boolean * @access public @@ -120,7 +120,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Mailing/Page/Event.php b/CRM/Mailing/Page/Event.php index dd5a4b3e56..746778e660 100644 --- a/CRM/Mailing/Page/Event.php +++ b/CRM/Mailing/Page/Event.php @@ -42,7 +42,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 * @access protected @@ -50,7 +50,7 @@ class CRM_Mailing_Page_Event extends CRM_Core_Page { protected $_fields; /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Mailing/Page/Preview.php b/CRM/Mailing/Page/Preview.php index c12ff6305b..3403c2a1c8 100644 --- a/CRM/Mailing/Page/Preview.php +++ b/CRM/Mailing/Page/Preview.php @@ -39,7 +39,7 @@ class CRM_Mailing_Page_Preview extends CRM_Core_Page { /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Mailing/Page/Tab.php b/CRM/Mailing/Page/Tab.php index 3eea11ebd0..30ff85c736 100644 --- a/CRM/Mailing/Page/Tab.php +++ b/CRM/Mailing/Page/Tab.php @@ -58,7 +58,7 @@ class CRM_Mailing_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 * @access public diff --git a/CRM/Mailing/Page/View.php b/CRM/Mailing/Page/View.php index 2a2813ecfc..bcedf988dd 100644 --- a/CRM/Mailing/Page/View.php +++ b/CRM/Mailing/Page/View.php @@ -71,10 +71,10 @@ class CRM_Mailing_Page_View extends CRM_Core_Page { } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * - * @param null $id - * @param null $contactID + * @param int $id + * @param int $contactID * @param bool $print * @param bool $allowID * diff --git a/CRM/Mailing/PseudoConstant.php b/CRM/Mailing/PseudoConstant.php index 5e92f7f639..18502ccfdd 100644 --- a/CRM/Mailing/PseudoConstant.php +++ b/CRM/Mailing/PseudoConstant.php @@ -40,28 +40,28 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { /** - * mailing templates + * Mailing templates * @var array * @static */ private static $template; /** - * completed mailings + * Completed mailings * @var array * @static */ private static $completed; /** - * mailing components + * Mailing components * @var array * @static */ private static $component; /** - * default component id's, indexed by component type + * Default component id's, indexed by component type */ private static $defaultComponent; diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index a55777fd6d..3f40ff0e5a 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -39,7 +39,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { /** - * array of supported links, currenly null + * Array of supported links, currenly null * * @var array * @static @@ -47,7 +47,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -78,7 +78,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -94,7 +94,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -210,7 +210,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 enum $action the action being performed * @param int $offset the row number to start from @@ -415,7 +415,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index f4f94b65d0..fe09cbff07 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -42,7 +42,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { /** - * array of supported links, currenly null + * Array of supported links, currenly null * * @var array * @static @@ -50,32 +50,32 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C static $_links = NULL; /** - * what event type are we browsing? + * What event type are we browsing? */ private $_event; /** - * should we only count distinct contacts? + * Should we only count distinct contacts? */ private $_is_distinct; /** - * which mailing are we browsing events from? + * Which mailing are we browsing events from? */ private $_mailing_id; /** - * do we want events tied to a specific job? + * Do we want events tied to a specific job? */ private $_job_id; /** - * for click-through events, do we only want those from a specific url? + * For click-through events, do we only want those from a specific url? */ private $_url_id; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array */ @@ -113,7 +113,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -129,7 +129,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -337,7 +337,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 enum $action the action being performed * @param int $offset the row number to start from @@ -417,7 +417,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index 5c3354e3f7..7ec2ff94d9 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -76,7 +76,7 @@ class CRM_Mailing_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 * * @access protected * @var boolean @@ -84,7 +84,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -92,7 +92,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -100,7 +100,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ protected $_context = NULL; /** - * what component context are we being invoked from + * What component context are we being invoked from * * @access protected * @var string @@ -108,7 +108,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ 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 @@ -117,7 +117,7 @@ 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 * @access protected @@ -226,7 +226,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -265,7 +265,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 enum $action the action being performed * @param int $offset the row number to start from @@ -339,7 +339,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -403,7 +403,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Mailing/StateMachine/Send.php b/CRM/Mailing/StateMachine/Send.php index 84f42f2e76..ec1237a351 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 adf23d005d..d48267554a 100644 --- a/CRM/Mailing/Task.php +++ b/CRM/Mailing/Task.php @@ -40,7 +40,7 @@ */ class CRM_Mailing_Task { /** - * the task array + * The task array * * @var array * @static @@ -48,7 +48,7 @@ class CRM_Mailing_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -93,7 +93,7 @@ class CRM_Mailing_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index 4ec103ed98..f6ed4adec8 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 * @static @@ -47,7 +47,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { static $_signupActType = NULL; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Member_DAO_Membership @@ -60,7 +60,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 @@ -222,7 +222,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 * @param array $ids the array that holds all the db ids @@ -430,7 +430,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 * @param int $contactId contact id @@ -571,7 +571,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * delete membership. + * Delete membership. * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent. * * @param int $membershipId membership id that needs to be deleted @@ -588,7 +588,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * delete membership. + * Delete membership. * * @param int $membershipId membership id that needs to be deleted * @@ -651,7 +651,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to delete related memberships + * Delete related memberships * * @param int $ownerMembershipId * @param int $contactId @@ -681,7 +681,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to obtain active/inactive memberships from the list of memberships passed to it. + * Obtain active/inactive memberships from the list of memberships passed to it. * * @param array $memberships membership records * @param string $status active or inactive @@ -712,7 +712,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to build Membership Block in Contribution Pages + * Build Membership Block in Contribution Pages * * @param CRM_Core_Form $form form object * @param int $pageID - unused? @@ -911,7 +911,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to return Membership Block info in Contribution Pages + * Return Membership Block info in Contribution Pages * * @param int $pageID contribution page id * @@ -949,7 +949,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to 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 contact id @@ -1110,7 +1110,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * function to get all exportable fields + * Get all exportable fields * * @retun array return array of all exportable fields * @static @@ -1133,7 +1133,7 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty } /** - * Function to get membership joins/renewals for a specified membership + * Get membership joins/renewals for a specified membership * type. Specifically, retrieves a count of memberships whose "Membership * Signup" or "Membership Renewal" activity falls in the given date range. * Dates match the pattern "yyyy-mm-dd". @@ -1186,7 +1186,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Function to get a count of membership for a specified membership type, + * Get a count of membership for a specified membership type, * optionally for a specified date. The date must have the form yyyy-mm-dd. * * If $date is omitted, this function counts as a member anyone whose @@ -1251,7 +1251,7 @@ AND civicrm_membership.is_test = %2"; * @param int $contactID contact id * @param CRM_Contribute_Form_Contribution_Confirm $form Confirmation form object * - * @param $premiumParams + * @param array $premiumParams * @param null $customFieldsFormatted * @param null $includeFieldTypes * @@ -1264,7 +1264,7 @@ AND civicrm_membership.is_test = %2"; * * @param $isProcessSeparateMembershipTransaction * - * @param $defaultContributionTypeID + * @param int $defaultContributionTypeID * @param array $membershipLineItems Line items specific to membership payment that is separate to contribution * @throws CRM_Core_Exception * @@ -1610,7 +1610,7 @@ AND civicrm_membership.is_test = %2"; } /** - * Function to get the contribution page id from the membership record + * Get the contribution page id from the membership record * * @param int membershipId membership id * @@ -1633,7 +1633,7 @@ SELECT c.contribution_page_id as pageID } /** - * Function to updated related memberships + * Updated related memberships * * @param int $ownerMembershipId owner Membership Id * @param array $params formatted array of key => value.. @@ -1656,7 +1656,7 @@ SELECT c.contribution_page_id as pageID } /** - * Function to 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 * @@ -1682,7 +1682,7 @@ SELECT c.contribution_page_id as pageID } /** - * function to 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 * @@ -1703,7 +1703,7 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id } /** - * function to create memberships for related contacts + * Create memberships for related contacts * takes into account the maximum related memberships * * @param array $params array of key - value pairs @@ -1895,7 +1895,7 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id /** * @param CRM_Core_Form $form - * @param null $membershipTypeID + * @param int $membershipTypeID * * @return array */ @@ -1947,7 +1947,7 @@ FROM civicrm_membership_type } /** - * Function to get membership record count for a Contact + * Get membership record count for a Contact * * @param int $contactID * @param boolean $activeOnly @@ -1971,7 +1971,7 @@ FROM civicrm_membership_type } /** - * Function to check whether payment processor supports + * Check whether payment processor supports * cancellation of membership subscription * * @param int $mid membership id @@ -2005,7 +2005,7 @@ FROM civicrm_membership_type } /** - * Function to check whether subscription is already cancelled + * Check whether subscription is already cancelled * * @param int $mid membership id * @@ -2029,7 +2029,7 @@ LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id ) } /** - * Function to get membership joins for a specified membership + * Get membership joins for a specified membership * type. Specifically, retrieves a count of still current memberships whose * join_date and start_date are within a specified date range. Dates match * the pattern "yyyy-mm-dd". @@ -2077,7 +2077,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Function to get membership renewals for a specified membership + * Get membership renewals for a specified membership * type. Specifically, retrieves a count of still current memberships * whose join_date is before and start_date is within a specified date * range. Dates match the pattern "yyyy-mm-dd". @@ -2126,13 +2126,13 @@ 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 * - * @param $contactID + * @param int $contactID * @param CRM_Contribute_Form_Contribution_Confirm $form - * @param $tempParams + * @param array $tempParams * @param $isTest - * @param $lineItems + * @param array $lineItems * @param $minimumFee - * @param $financialTypeID + * @param int $financialTypeID * * @throws CRM_Core_Exception * @throws Exception @@ -2215,10 +2215,10 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * @param $membershipParams - * @param $contactID + * @param array $membershipParams + * @param int $contactID * @param $customFieldsFormatted - * @param $membershipID + * @param int $membershipID * @param $memType * @param $isTest * @param $numTerms @@ -2322,13 +2322,13 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND /** * @param integer $contactID - * @param $membershipTypeID + * @param int $membershipTypeID * @param bool $is_test * @param $changeToday * @param integer $modifiedID * @param $customFieldsFormatted * @param $numRenewTerms - * @param $membershipID + * @param int $membershipID * @param $pending * @param $allStatus * @param array $membershipTypeDetails @@ -2572,11 +2572,11 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * Function to process price set and line items. + * Process price set and line items. * * @access public * - * @param $membershipId + * @param int $membershipId * @param $lineItem * * @return void @@ -2602,7 +2602,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 membership id. @@ -2790,7 +2790,7 @@ WHERE civicrm_membership.is_test = 0"; * The function returns the membershiptypes for a particular contact * who has lifetime membership without end date. * - * @param $contactID + * @param int $contactID * @param bool $isTest * @param bool $onlyLifeTime * @@ -2828,7 +2828,7 @@ WHERE civicrm_membership.is_test = 0"; } /** - * Function to record contribution record associated with membership + * Record contribution record associated with membership * * @param array $params array of submitted params * @param array $ids (param in process of being removed - try to use params) array of ids @@ -2903,7 +2903,7 @@ WHERE civicrm_membership.is_test = 0"; } /** - * Function to record line items for default membership + * Record line items for default membership * * @param CRM_Core_Form $qf * @param array $membershipType array with membership type and organization diff --git a/CRM/Member/BAO/MembershipBlock.php b/CRM/Member/BAO/MembershipBlock.php index 70a584a239..24eb65ce0b 100644 --- a/CRM/Member/BAO/MembershipBlock.php +++ b/CRM/Member/BAO/MembershipBlock.php @@ -34,13 +34,13 @@ */ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { /** - * class constructor + * Class constructor */ 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 1ec59f9baa..8d35da23c4 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 * @param array $ids reference array contains the id @@ -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 * @@ -71,7 +71,7 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { } /** - * @param $contactID + * @param int $contactID */ static function resetModifiedID($contactID) { $query = " diff --git a/CRM/Member/BAO/MembershipPayment.php b/CRM/Member/BAO/MembershipPayment.php index 0f0766ca0e..ec04cacc55 100644 --- a/CRM/Member/BAO/MembershipPayment.php +++ b/CRM/Member/BAO/MembershipPayment.php @@ -36,13 +36,13 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); } /** - * add the membership Payments + * Add the membership Payments * * @param array $params reference array contains the values submitted by the form * @@ -78,7 +78,7 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment } /** - * delete membership Payments + * Delete membership Payments * * @param int $id * diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 4c02bdcb63..277483f47c 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -35,12 +35,12 @@ 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 */ function __construct() { parent::__construct(); @@ -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 * @param boolean $is_active value we want to set the is_active field @@ -107,7 +107,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { return $membershipStatusBAO; } /** - * add the membership types + * Add the membership types * * @param array $params reference array contains the values submitted by the form * @param array $ids array contains the id - this param is deprecated @@ -165,7 +165,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * get membership status + * Get membership status * * @param int $membershipStatusId * @@ -183,7 +183,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * delete membership Types + * Delete membership Types * * @param int $membershipStatusId * @@ -213,7 +213,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { } /** - * Function to find the membership status based on start date, end date, join date & status date. + * Find the membership status based on start date, end date, join date & status date. * * @param string $startDate start date of the member whose membership status is to be calculated. * @param string $endDate end date of the member whose membership status is to be calculated. diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index e3c492cb9b..688369b213 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -35,14 +35,14 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** - * static holder for the default LT + * Static holder for the default LT */ static $_defaultMembershipType = NULL; static $_membershipTypeInfo = array(); /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -69,7 +69,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * update the is_active flag in the db + * Update the is_active flag in the db * * @param int $id id of the database record * @param boolean $is_active value we want to set the is_active field @@ -82,7 +82,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * add the membership types + * Add the membership types * * @param array $params reference array contains the values submitted by the form * @param array $ids array contains the id (deprecated) @@ -131,7 +131,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * delete membership Types + * Delete membership Types * * @param int $membershipTypeId * @@ -188,7 +188,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * convert membership Type's 'start day' & 'rollover day' to human readable formats. + * Convert membership Type's 'start day' & 'rollover day' to human readable formats. * * @param array $membershipType an array of membershipType-details. * @static @@ -229,7 +229,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to get membership Types + * Get membership Types * * @param bool $public * @@ -253,7 +253,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to get membership Type Details + * Get membership Type Details * * @param int $membershipTypeId * @@ -277,7 +277,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to calculate start date and end date for new membership + * Calculate start date and end date for new membership * * @param int $membershipTypeId membership type id * @param date $joinDate member since ( in mysql date format ) @@ -454,7 +454,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to calculate start date and end date for renewal membership + * Calculate start date and end date for renewal membership * * @param int $membershipId * @param $changeToday @@ -563,7 +563,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to retrieve all Membership Types associated + * Retrieve all Membership Types associated * with an Organization * * @param int $orgID Id of Organization @@ -584,7 +584,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { } /** - * Function to retrieve all Membership Types with Member of Contact id + * Retrieve all Membership Types with Member of Contact id * * @param array membership types * @@ -658,8 +658,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * @param array $params - * @param $previousID - * @param $membershipTypeId + * @param int $previousID + * @param int $membershipTypeId */ public static function createMembershipPriceField($params, $previousID, $membershipTypeId) { diff --git a/CRM/Member/BAO/Query.php b/CRM/Member/BAO/Query.php index 52689ebe2e..60eee28c9c 100644 --- a/CRM/Member/BAO/Query.php +++ b/CRM/Member/BAO/Query.php @@ -43,7 +43,7 @@ class CRM_Member_BAO_Query { } /** - * if membership are involved, add the specific membership fields + * If membership are involved, add the specific membership fields * * @param $query * @@ -348,7 +348,7 @@ class CRM_Member_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -484,7 +484,7 @@ class CRM_Member_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} diff --git a/CRM/Member/Controller/Search.php b/CRM/Member/Controller/Search.php index 8aec7e48b7..023aa01122 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Member/Form.php b/CRM/Member/Form.php index dbcb6f3290..8acd4b29c0 100644 --- a/CRM/Member/Form.php +++ b/CRM/Member/Form.php @@ -182,7 +182,7 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { } /** - * extract values from the contact create boxes on the form and assign appropriately to + * Extract values from the contact create boxes on the form and assign appropriately to * * - $this->_contributorEmail, * - $this->_memberEmail & diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index f7b7d150c6..57ea44a997 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -732,7 +732,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -1693,7 +1693,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * send email receipt + * Send email receipt * * @param CRM_Core_Form $form form object * @param array $formValues diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index a4119601a5..4df41a19fb 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -39,7 +39,7 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPage { /** - * store membership price set id + * Store membership price set id */ protected $_memPriceSetId = NULL; @@ -210,12 +210,12 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * * @param $files - * @param null $contributionPageId + * @param int $contributionPageId * * @return mixed true or array of errors * @access public diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php index dc71acaf50..a14888fc8a 100644 --- a/CRM/Member/Form/MembershipRenewal.php +++ b/CRM/Member/Form/MembershipRenewal.php @@ -452,7 +452,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -486,7 +486,7 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; } /** - * process the renewal form + * Process the renewal form * * @access public * diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php index b9f2f1ea1e..a5d73b6bf6 100644 --- a/CRM/Member/Form/MembershipType.php +++ b/CRM/Member/Form/MembershipType.php @@ -40,7 +40,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { /** - * max number of contacts we will display for membership-organisation + * Max number of contacts we will display for membership-organisation */ CONST MAX_CONTACTS = 50; @@ -212,7 +212,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * @@ -415,9 +415,9 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { } /** - * @param $previousID - * @param $priceSetId - * @param $membershipTypeId + * @param int $previousID + * @param int $priceSetId + * @param int $membershipTypeId * @param $optionsIds */ public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) { diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index 971a870b0b..011e7e20e0 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -139,7 +139,7 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { } /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Member/Form/Search.php b/CRM/Member/Form/Search.php index 94d0bc118b..4117645868 100644 --- a/CRM/Member/Form/Search.php +++ b/CRM/Member/Form/Search.php @@ -43,7 +43,7 @@ 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 * @access protected @@ -51,7 +51,7 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -59,7 +59,7 @@ class CRM_Member_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -69,13 +69,13 @@ 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 * @access public diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php index f4eae47d7c..72848015af 100644 --- a/CRM/Member/Form/Task.php +++ b/CRM/Member/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Member_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -75,7 +75,7 @@ class CRM_Member_Form_Task extends CRM_Core_Form { protected $_memberIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -163,7 +163,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 title of the main button diff --git a/CRM/Member/Form/Task/Batch.php b/CRM/Member/Form/Task/Batch.php index 63d359a9b9..6f223ec1fb 100644 --- a/CRM/Member/Form/Task/Batch.php +++ b/CRM/Member/Form/Task/Batch.php @@ -39,26 +39,26 @@ 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 * @access public @@ -211,7 +211,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 * * @access public * diff --git a/CRM/Member/Form/Task/Delete.php b/CRM/Member/Form/Task/Delete.php index 2c6efa9b52..7c4f0a959a 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 * @access public @@ -74,7 +74,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 * * @access public * diff --git a/CRM/Member/Form/Task/Email.php b/CRM/Member/Form/Task/Email.php index 83d2f66736..e8f17674aa 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 * @access public @@ -93,7 +93,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 * * @access public * diff --git a/CRM/Member/Form/Task/Label.php b/CRM/Member/Form/Task/Label.php index 80a06c4ba3..16e32ace60 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 * @access public @@ -82,7 +82,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 * * @access public * diff --git a/CRM/Member/Form/Task/PDFLetter.php b/CRM/Member/Form/Task/PDFLetter.php index c72d203368..46c766c5dd 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 * @access public @@ -86,7 +86,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 * * @access public * @@ -103,7 +103,7 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task { } /** - * list available tokens, at time of writing these were + * List available tokens, at time of writing these were * {membership.id} => Membership ID * {membership.status} => Membership Status * {membership.type} => Membership Type diff --git a/CRM/Member/Form/Task/PDFLetterCommon.php b/CRM/Member/Form/Task/PDFLetterCommon.php index 0307350921..710ad6486f 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 * @access public @@ -45,7 +45,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 0784859cea..29f43690f7 100644 --- a/CRM/Member/Form/Task/PickProfile.php +++ b/CRM/Member/Form/Task/PickProfile.php @@ -39,26 +39,26 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { /** - * the title of the group + * The title of the group * * @var string */ protected $_title; /** - * maximum members that should be allowed to update + * Maximum members that should be allowed to update * */ protected $_maxMembers = 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 * @access public @@ -119,7 +119,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 * @@ -132,7 +132,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 * * @access public * diff --git a/CRM/Member/Form/Task/Print.php b/CRM/Member/Form/Task/Print.php index 90fbf78da1..ef40cf2b95 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 * @access public @@ -95,7 +95,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 * * @access public * diff --git a/CRM/Member/Form/Task/Result.php b/CRM/Member/Form/Task/Result.php index 142eb242c3..464656da17 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 * @access public diff --git a/CRM/Member/Form/Task/SearchTaskHookSample.php b/CRM/Member/Form/Task/SearchTaskHookSample.php index b67d1aaef5..d426d068a8 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 * @access public diff --git a/CRM/Member/Import/Controller.php b/CRM/Member/Import/Controller.php index 61bb9ea49c..f93e3e46a0 100644 --- a/CRM/Member/Import/Controller.php +++ b/CRM/Member/Import/Controller.php @@ -35,7 +35,7 @@ class CRM_Member_Import_Controller extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Member/Import/Field.php b/CRM/Member/Import/Field.php index adfad40ac0..4dcbd0ec6d 100644 --- a/CRM/Member/Import/Field.php +++ b/CRM/Member/Import/Field.php @@ -40,53 +40,53 @@ class CRM_Member_Import_Field { */ /** - * name of the field + * Name of the field */ public $_name; /** - * title of the field to be used in display + * Title of the field to be used in display */ public $_title; /** - * type of field + * Type of field * @var enum */ public $_type; /** - * is this field required + * Is this field required * @var boolean */ public $_required; /** - * data to be carried for use by a derived class + * Data to be carried for use by a derived class * @var object */ public $_payload; /** - * regexp to match the CSV header of this column/field + * Regexp to match the CSV header of this column/field * @var string */ public $_headerPattern; /** - * regexp to match the pattern of data from various column/fields + * Regexp to match the pattern of data from various column/fields * @var string */ public $_dataPattern; /** - * value of this field + * Value of this field * @var object */ public $_value; /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern @@ -107,7 +107,7 @@ class CRM_Member_Import_Field { } /** - * the value is in string format. convert the value to the type of this field + * The value is in string format. convert the value to the type of this field * and set the field value with the appropriate type */ function setValue($value) { diff --git a/CRM/Member/Import/Form/DataSource.php b/CRM/Member/Import/Form/DataSource.php index 8c7d383f89..e358626089 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 * @access public diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index 49d0705ae7..c295ed782d 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -41,7 +41,7 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { /** - * to store contactType + * To store contactType * * @var int * @static @@ -50,7 +50,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 * @access public @@ -298,7 +298,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 33597f8c49..159619eb04 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 * @access public diff --git a/CRM/Member/Import/Form/Summary.php b/CRM/Member/Import/Form/Summary.php index 5ce1208605..de4de5c50e 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 * @access public diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index e61e56d79d..5d865c1b3f 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -44,29 +44,29 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { */ /** - * imported file size + * Imported file size */ protected $_fileSize; /** - * seperator being used + * Seperator being used */ 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 */ protected $_haveColumnHeader; /** - * @param $fileName + * @param string $fileName * @param string $seperator * @param $mapper * @param bool $skipColumnHeader @@ -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 * @access public @@ -320,7 +320,7 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { } /** - * @param $name + * @param string $name * @param $title * @param int $type * @param string $headerPattern diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index c0811d1ac7..dfc312169f 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 */ function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -64,7 +64,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public @@ -108,7 +108,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 * @@ -120,7 +120,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 * @@ -246,7 +246,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 * @param array $values the array of values belonging to this line @@ -576,7 +576,7 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } /** - * the initializer code, called before the processing + * The initializer code, called before the processing * * @return void * @access public diff --git a/CRM/Member/Page/AJAX.php b/CRM/Member/Page/AJAX.php index fa1493732a..1cab218291 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 */ static function getMemberTypeDefaults() { if (!$_POST['mtype']) { diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index e0c67e237f..42a43735ca 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -369,7 +369,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * @param CRM_Core_Form $form - * @param null $contactId + * @param int $contactId */ public static function setContext(&$form, $contactId = NULL) { $context = CRM_Utils_Request::retrieve('context', 'String', $form, FALSE, 'search' ); @@ -552,7 +552,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 * @access public diff --git a/CRM/Member/Page/UserDashboard.php b/CRM/Member/Page/UserDashboard.php index 85862cb293..683fbfbcd5 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 * * return null * @access public diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index fbcdaa9a00..9003803fd6 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -40,14 +40,14 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { /** - * membership types + * Membership types * @var array * @static */ private static $membershipType; /** - * membership types + * Membership types * @var array * @static */ @@ -58,7 +58,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param bool $force * * @return array - array reference of all membership types if any @@ -88,7 +88,7 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * - * @param null $id + * @param int $id * @param null $cond * @param string $column * @param bool $force diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index f1b1f3349f..819f802dcb 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -80,7 +80,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C ); /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -88,7 +88,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -96,7 +96,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -104,7 +104,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C 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 @@ -113,7 +113,7 @@ 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 * @access protected @@ -273,7 +273,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -311,7 +311,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 enum $action the action being performed * @param int $offset the row number to start from @@ -458,7 +458,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -535,7 +535,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index 22460d863d..b942964dd6 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -90,7 +90,7 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { } /** - * return the form name of the task + * Return the form name of the task * * @return string * @access public diff --git a/CRM/Member/Task.php b/CRM/Member/Task.php index c5e15a252a..587c05abdf 100644 --- a/CRM/Member/Task.php +++ b/CRM/Member/Task.php @@ -43,7 +43,7 @@ class CRM_Member_Task { CONST DELETE_MEMBERS = 1, PRINT_MEMBERS = 2, EXPORT_MEMBERS = 3, EMAIL_CONTACTS = 4, BATCH_MEMBERS = 5; /** - * the task array + * The task array * * @var array * @static @@ -51,7 +51,7 @@ class CRM_Member_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -146,7 +146,7 @@ class CRM_Member_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 90a9e410ba..777a5395a3 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -50,7 +50,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { } /** - * add or update either a Personal Campaign Page OR a PCP Block + * Add or update either a Personal Campaign Page OR a PCP Block * * @param array $params reference array contains the values submitted by the form * @param bool $pcpBlock if true, create or update PCPBlock, else PCP @@ -89,7 +89,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { } /** - * get the Display name of a contact for a PCP + * Get the Display name of a contact for a PCP * * @param int $id id for the PCP * @@ -110,9 +110,9 @@ WHERE civicrm_pcp.contact_id = civicrm_contact.id } /** - * return PCP Block info for dashboard + * Return PCP Block info for dashboard * - * @param $contactId + * @param int $contactId * * @return array array of Pcp if found * @access public @@ -228,7 +228,7 @@ ORDER BY target_entity_type, target_entity_id } /** - * function to show the total amount for Personal Campaign Page on thermometer + * Show the total amount for Personal Campaign Page on thermometer * * @param array $pcpId contains the pcp ID * @@ -250,7 +250,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * function to show the amount, nickname on honor roll + * Show the amount, nickname on honor roll * * @param array $pcpId contains the pcp ID * @@ -348,7 +348,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to Delete the campaign page + * Delete the campaign page * * @param int $id campaign page id * @@ -482,7 +482,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * Process a PCP contribution/ */ /** - * @param $pcpId + * @param int $pcpId * @param $component * @param $entity * @@ -582,7 +582,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to Approve / Reject the campaign page + * Approve / Reject the campaign page * * @param int $id campaign page id * @@ -625,7 +625,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to send notfication email to supporter + * Send notfication email to supporter * 1. when their PCP status is changed by site admin. * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true). * @@ -724,7 +724,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to Enable / Disable the campaign page + * Enable / Disable the campaign page * * @param int $id campaign page id * @@ -738,7 +738,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to get pcp block is active + * Get pcp block is active * * @param int $pcpId * @param $component @@ -762,7 +762,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to get pcp block is enabled for component page + * Get pcp block is enabled for component page * * @param int $pageId * @param $component @@ -786,7 +786,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to find out if the PCP block is in use by one or more PCP page + * Find out if the PCP block is in use by one or more PCP page * * @param int $id pcp block id * @@ -807,7 +807,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Function to get email is enabled for supporter's profile + * Get email is enabled for supporter's profile * * @param int $profileId supporter's profile id * @@ -830,7 +830,7 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; } /** - * Function to obtain the title of page associated with a pcp + * Obtain the title of page associated with a pcp * * @param int $pcpId * @param $component @@ -860,7 +860,7 @@ WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; } /** - * Function to get pcp block & entity id given pcp id + * Get pcp block & entity id given pcp id * * @param int $pcpId * @param $component @@ -888,7 +888,7 @@ WHERE pcp.id = %1"; } /** - * Function to get pcp entity table given a component. + * Get pcp entity table given a component. * * @param $component * @@ -907,7 +907,7 @@ WHERE pcp.id = %1"; } /** - * Function to get supporter profile id + * Get supporter profile id * * @param int $component_id * @param string $component diff --git a/CRM/PCP/Controller/PCP.php b/CRM/PCP/Controller/PCP.php index 369fba195f..64359b2bfd 100644 --- a/CRM/PCP/Controller/PCP.php +++ b/CRM/PCP/Controller/PCP.php @@ -47,7 +47,7 @@ class CRM_PCP_Controller_PCP extends CRM_Core_Controller { /** - * class constructor + * Class constructor */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 2c95477bf8..65d191bed1 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -147,7 +147,7 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index afa98322df..0df50d4ffd 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -40,7 +40,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { /** - * the type of pcp component. + * The type of pcp component. * * @var int * @protected @@ -100,7 +100,7 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index f7c816b51b..a3c4368c73 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -40,7 +40,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { /** - * the type of pcp component. + * The type of pcp component. * * @var int * @protected @@ -131,7 +131,7 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index a5a2a7197b..0d95ed09a4 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 * * @param null * @@ -190,7 +190,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 * diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 5b0f7c6d66..4d05185bb8 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -49,7 +49,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { public $_component = NULL; /** - * are we in single form mode or wizard mode? + * Are we in single form mode or wizard mode? * * @var boolean * @access protected @@ -57,7 +57,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 * @protected @@ -223,7 +223,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index 90441a9d61..b0f52d1011 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -388,7 +388,7 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { //@TODO this function changed, debug this at runtime /** * @param $whereClause - * @param $whereParams + * @param array $whereParams */ function pagerAtoZ($whereClause, $whereParams) { $where = ''; diff --git a/CRM/PCP/StateMachine/PCP.php b/CRM/PCP/StateMachine/PCP.php index a414441a84..18b5cc37ce 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 73cf278062..4d027ee8b7 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -35,7 +35,7 @@ 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 @@ -43,7 +43,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { static $_exportableFields = NULL; /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -74,7 +74,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 +139,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 * @@ -253,7 +253,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * delete the pledge + * Delete the pledge * * @param int $id pledge id * @@ -299,7 +299,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { } /** - * get the amount details date wise. + * Get the amount details date wise. * * @param string $status * @param string $startDate @@ -442,7 +442,7 @@ GROUP BY currency } /** - * Function to 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 * @@ -487,7 +487,7 @@ GROUP BY currency } /** - * Function to send Acknowledgment and create activity. + * Send Acknowledgment and create activity. * * @param CRM_Core_Form $form form object. * @param array $params an assoc array of name/value pairs. @@ -682,7 +682,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 * @access public @@ -745,7 +745,7 @@ GROUP BY currency } /** - * Function to get pending or in progress pledges + * Get pending or in progress pledges * * @param int $contactID contact id * @@ -789,9 +789,9 @@ GROUP BY currency } /** - * Function to get pledge record count for a Contact + * Get pledge record count for a Contact * - * @param $contactID + * @param int $contactID * * @return int count of pledge records * @access public diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 0596b91db8..5d42f5c2be 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -35,7 +35,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** - * class constructor + * Class constructor */ function __construct() { parent::__construct(); @@ -66,7 +66,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 * @@ -91,7 +91,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 * @@ -147,7 +147,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * delete the pledgeBlock + * Delete the pledgeBlock * * @param int $id pledgeBlock id * @@ -174,7 +174,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 * @@ -195,7 +195,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { } /** - * Function to build Pledge Block in Contribution Pages + * Build Pledge Block in Contribution Pages * * @param CRM_Core_Form $form * @static diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 9b8b9e8f1e..0c521db427 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 */ function __construct() { parent::__construct(); } /** - * get pledge payment details + * Get pledge payment details * * @param int $pledgeId pledge id * @@ -225,7 +225,7 @@ WHERE pledge_id = %1 /** * Delete pledge payment * - * @param $id + * @param int $id * * @return int pledge payment id * @static @@ -250,7 +250,7 @@ WHERE pledge_id = %1 } /** - * delete all pledge payments + * Delete all pledge payments * * @param int $id pledge id * @@ -323,7 +323,7 @@ WHERE pledge_id = %1 } /** - * update Pledge Payment Status + * Update Pledge Payment Status * * @param int $pledgeID , id of pledge * @param array $paymentIDs , ids of pledge payment(s) to update @@ -608,7 +608,7 @@ WHERE civicrm_pledge.id = %2 } /** - * update pledge payment table + * Update pledge payment table * * @param int $pledgeId pledge id * @param int $paymentStatusId payment status id to set @@ -654,7 +654,7 @@ WHERE civicrm_pledge_payment.pledge_id = %1 } /** - * Function to update pledge payment table when reminder is sent + * Update pledge payment table when reminder is sent * * @param int $paymentId payment id * @@ -671,7 +671,7 @@ WHERE civicrm_pledge_payment.id = {$paymentId} } /** - * Function to get oldest pending or in progress pledge payments + * Get oldest pending or in progress pledge payments * * @param int $pledgeID pledge id * @@ -718,12 +718,12 @@ LIMIT 0, %2 } /** - * @param $pledgeID + * @param int $pledgeID * @param $actualAmount * @param $pledgeScheduledAmount - * @param null $paymentContributionId - * @param null $pPaymentId - * @param null $paymentStatusID + * @param int $paymentContributionId + * @param int $pPaymentId + * @param int $paymentStatusID */ static function adjustPledgePayment($pledgeID, $actualAmount, $pledgeScheduledAmount, $paymentContributionId = NULL, $pPaymentId = NULL, $paymentStatusID = NULL) { $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 9fd9f2be7c..45817bcda5 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -43,7 +43,7 @@ class CRM_Pledge_BAO_Query { } /** - * build select for Pledge + * Build select for Pledge * * @param $query * @@ -421,7 +421,7 @@ class CRM_Pledge_BAO_Query { } /** - * @param $name + * @param string $name * @param $mode * @param $side * @@ -462,7 +462,7 @@ class CRM_Pledge_BAO_Query { } /** - * getter for the qill object + * Getter for the qill object * * @return string * @access public @@ -626,7 +626,7 @@ class CRM_Pledge_BAO_Query { /** * @param $row - * @param $id + * @param int $id */ static function searchAction(&$row, $id) {} diff --git a/CRM/Pledge/Controller/Search.php b/CRM/Pledge/Controller/Search.php index 84b2bebcfe..0a5f63a2aa 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 */ 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 5eda5b0bdc..679d8b2d4d 100644 --- a/CRM/Pledge/Form/Payment.php +++ b/CRM/Pledge/Form/Payment.php @@ -40,7 +40,7 @@ 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 @@ -48,7 +48,7 @@ class CRM_Pledge_Form_Payment extends CRM_Core_Form { public $_id; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index 12715b7522..6223154247 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -41,7 +41,7 @@ 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 @@ -49,7 +49,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { public $_id; /** - * the id of the contact associated with this pledge + * The id of the contact associated with this pledge * * @var int * @public @@ -69,13 +69,13 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { public $_freqUnits; /** - * is current pledge pending. + * Is current pledge pending. * @public */ public $_isPending = FALSE; /** - * set variables up before form is built + * Set variables up before form is built * * @return void * @access public @@ -446,7 +446,7 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Pledge/Form/PledgeView.php b/CRM/Pledge/Form/PledgeView.php index 5cdd45a33e..4e255599f6 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 * @access public diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index f859aa950a..b5ec46f10c 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -47,7 +47,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { protected $_queryParams; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -55,7 +55,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -63,7 +63,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { protected $_limit = NULL; /** - * prefix for the controller + * Prefix for the controller * */ protected $_prefix = "pledge_"; @@ -71,7 +71,7 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { protected $_defaults; /** - * processing needed for buildForm and later + * Processing needed for buildForm and later * * @return void * @access public @@ -300,7 +300,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 * diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 2d01f0934e..24ac400847 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -40,7 +40,7 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { /** - * the task being performed + * The task being performed * * @var int */ @@ -68,7 +68,7 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { protected $_pledgeIds; /** - * build all the data structures needed to build the form + * Build all the data structures needed to build the form * * @param * @@ -147,7 +147,7 @@ class CRM_Pledge_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 title of the main button diff --git a/CRM/Pledge/Form/Task/Delete.php b/CRM/Pledge/Form/Task/Delete.php index 5eb69746ec..b14dfe515f 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 * * @return void * @access public @@ -73,7 +73,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 * * @access public * diff --git a/CRM/Pledge/Form/Task/Print.php b/CRM/Pledge/Form/Task/Print.php index d431a5a3cb..c65781377f 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 * @access public @@ -96,7 +96,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 * * @access public * diff --git a/CRM/Pledge/Form/Task/Result.php b/CRM/Pledge/Form/Task/Result.php index d80e14ac07..7d22138759 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 * @access public diff --git a/CRM/Pledge/Form/Task/SearchTaskHookSample.php b/CRM/Pledge/Form/Task/SearchTaskHookSample.php index b6568966c2..f3deed9f35 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 * @access public diff --git a/CRM/Pledge/Page/AJAX.php b/CRM/Pledge/Page/AJAX.php index b912e35b68..9373a194fe 100644 --- 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 */ static function pledgeName() { diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index e6755b2afe..8090756d94 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -50,7 +50,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -83,7 +83,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { ); /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -91,7 +91,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { protected $_single = FALSE; /** - * are we restricting ourselves to a single contact + * Are we restricting ourselves to a single contact * * @access protected * @var boolean @@ -99,7 +99,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { protected $_limit = NULL; /** - * what context are we being invoked from + * What context are we being invoked from * * @access protected * @var string @@ -107,7 +107,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { 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 @@ -116,7 +116,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { public $_queryParams; /** - * represent the type of selector + * Represent the type of selector * * @var int * @access protected @@ -234,7 +234,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -273,7 +273,7 @@ class CRM_Pledge_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 enum $action the action being performed * @param int $offset the row number to start from @@ -378,7 +378,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -455,7 +455,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index c24073e67c..1c307bda3d 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Pledge_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * class constructor + * Class constructor */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -92,7 +92,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 * @access public diff --git a/CRM/Pledge/Task.php b/CRM/Pledge/Task.php index c01b3134f6..e7d95adafb 100644 --- a/CRM/Pledge/Task.php +++ b/CRM/Pledge/Task.php @@ -42,7 +42,7 @@ class CRM_Pledge_Task { CONST DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3; /** - * the task array + * The task array * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Pledge_Task { static $_tasks = NULL; /** - * the optional task array + * The optional task array * * @var array * @static @@ -126,7 +126,7 @@ class CRM_Pledge_Task { } /** - * show tasks selectively based on the permission level + * Show tasks selectively based on the permission level * of the user * * @param int $permission diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index 79e2a3a9f1..f399343cef 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -108,7 +108,7 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { } /** - * @param $entityId + * @param int $entityId * @param $entityTable * * @return null|string @@ -124,8 +124,8 @@ AND li.entity_id = {$entityId} } /** - * wrapper for line item retrieval when contribution ID is known - * @param $contributionID + * Wrapper for line item retrieval when contribution ID is known + * @param int $contributionID * * @return array */ @@ -350,9 +350,9 @@ AND li.entity_id = {$entityId} } /** - * process price set and line items. + * Process price set and line items. * - * @param $entityId + * @param int $entityId * @param array $lineItem line item array * @param object $contributionDetails * @param string $entityTable entity table @@ -407,10 +407,10 @@ AND li.entity_id = {$entityId} } /** - * @param $entityId + * @param int $entityId * @param string $entityTable * @param $amount - * @param null $otherParams + * @param array $otherParams */ public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) { if (!$entityId || CRM_Utils_System::isNull($amount)) @@ -461,7 +461,7 @@ AND li.entity_id = {$entityId} } /** - * build line items array. + * Build line items array. * @param array $params form values * * @param string $entityId entity id diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index 57c8d52c21..78ea203788 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 @@ -68,7 +68,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 * @@ -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 * @param boolean $is_active Value we want to set the is_active field @@ -216,7 +216,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * * @param CRM_Core_Form $qf form object (reference) * @param string $elementName name of the custom field - * @param $fieldId + * @param int $fieldId * @param boolean $inactiveNeeded * @param boolean $useRequired true if required else false * @param string $label label for custom field @@ -560,7 +560,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { /** * @param $optionLabel - * @param $fid + * @param int $fid * * @return mixed */ diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 3a4ccc7c7f..ebc8d3035f 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -40,7 +40,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { /** - * insert/update a new entry in the database. + * Insert/update a new entry in the database. * * @param array $params (reference), array $ids * @@ -182,7 +182,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 * @param boolean $is_active Value we want to set the is_active field @@ -197,7 +197,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 1a98ae5568..8f642c9dd4 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -40,7 +40,7 @@ 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 @@ -48,14 +48,14 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { static $_defaultPriceSet = NULL; /** - * class constructor + * Class constructor */ 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 * @@ -90,7 +90,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 * @param $isActive @@ -476,7 +476,7 @@ WHERE ct.id = cp.financial_type_id AND * * An array containing price set details (including price fields) is returned * - * @param $setID + * @param int $setID * @param bool $required * @param bool $validOnly * @@ -605,10 +605,10 @@ WHERE id = %1"; /** * @param CRM_Core_Form $form - * @param $id + * @param int $id * @param string $entityTable * @param bool $validOnly - * @param null $priceSetId + * @param int $priceSetId * * @return bool|false|int|null */ @@ -882,7 +882,7 @@ WHERE id = %1"; } /** - * build the price set form. + * Build the price set form. * * @param CRM_Core_Form $form * @@ -969,7 +969,7 @@ WHERE id = %1"; } /** - * check the current Membership + * Check the current Membership * having end date null. */ static function checkCurrentMembership(&$options, $userid) { @@ -999,7 +999,7 @@ WHERE id = %1"; } /** - * set daefult the price set fields. + * Set daefult the price set fields. * * @param CRM_Core_Form $form * @param $defaults @@ -1217,7 +1217,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Function to check if auto renew option should be shown + * Check if auto renew option should be shown * * @param int $priceSetId price set id * @@ -1264,7 +1264,7 @@ GROUP BY mt.member_of_contact_id"; } /** - * Function to retrieve auto renew frequency and interval + * Retrieve auto renew frequency and interval * * @param int $priceSetId price set id * @@ -1296,7 +1296,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 * @param boolean $isQuickConfig value we want to set the is_quick_config field diff --git a/CRM/Price/Form/DeleteField.php b/CRM/Price/Form/DeleteField.php index 89413a46cc..14818c36bd 100644 --- a/CRM/Price/Form/DeleteField.php +++ b/CRM/Price/Form/DeleteField.php @@ -39,7 +39,7 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { /** - * the field id + * The field id * * @var int */ @@ -53,7 +53,7 @@ class CRM_Price_Form_DeleteField extends CRM_Core_Form { protected $_title; /** - * set up variables to build the form + * Set up variables to build the form * * @param null * diff --git a/CRM/Price/Form/DeleteSet.php b/CRM/Price/Form/DeleteSet.php index a55bd08361..12ab825b0b 100644 --- a/CRM/Price/Form/DeleteSet.php +++ b/CRM/Price/Form/DeleteSet.php @@ -39,7 +39,7 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { /** - * the set id + * The set id * * @var int */ @@ -53,7 +53,7 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { protected $_title; /** - * set up variables to build the form + * Set up variables to build the form * * @return void * @acess protected diff --git a/CRM/Price/Form/Field.php b/CRM/Price/Form/Field.php index 2be5586f0a..7146644ac2 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 * @access protected @@ -68,13 +68,13 @@ class CRM_Price_Form_Field extends CRM_Core_Form { protected $_extendComponentId; /** - * variable is set if price set is used for membership + * Variable is set if price set is used for membership * @access protected */ protected $_useForMember; /** - * set variables up before form is built + * Set variables up before form is built * * @param null * @@ -389,7 +389,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 * diff --git a/CRM/Price/Form/Option.php b/CRM/Price/Form/Option.php index 4f65a42eea..64c20a6e0a 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 * @access protected @@ -47,7 +47,7 @@ class CRM_Price_Form_Option extends CRM_Core_Form { protected $_fid; /** - * option value id, used when editing the Option + * Option value id, used when editing the Option * * @var int * @access protected @@ -55,7 +55,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 * * @param null * @@ -269,7 +269,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 * diff --git a/CRM/Price/Form/Preview.php b/CRM/Price/Form/Preview.php index 21bba9e89f..5cd7dcb03b 100644 --- a/CRM/Price/Form/Preview.php +++ b/CRM/Price/Form/Preview.php @@ -44,14 +44,14 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { /** - * the group tree data + * The group tree data * * @var array */ protected $_groupTree; /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for group or field id * diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index cf65892768..e97de315ec 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -47,7 +47,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { protected $_sid; /** - * set variables up before form is built + * Set variables up before form is built * * @param null * @@ -79,7 +79,7 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Price/Page/Field.php b/CRM/Price/Page/Field.php index 3afee6085d..8bcc368dcb 100644 --- a/CRM/Price/Page/Field.php +++ b/CRM/Price/Page/Field.php @@ -215,7 +215,7 @@ class CRM_Price_Page_Field extends CRM_Core_Page { } /** - * edit price data. + * Edit price data. * * editing would involved modifying existing fields + adding data to new fields. * @@ -338,7 +338,7 @@ class CRM_Price_Page_Field extends CRM_Core_Page { /** * Preview price field * - * @param $fid + * @param int $fid * * @internal param int $id price field id * diff --git a/CRM/Price/Page/Option.php b/CRM/Price/Page/Option.php index f9432ed9b6..aa5eab60a0 100644 --- a/CRM/Price/Page/Option.php +++ b/CRM/Price/Page/Option.php @@ -199,7 +199,7 @@ class CRM_Price_Page_Option extends CRM_Core_Page { } /** - * edit custom Option. + * Edit custom Option. * * editing would involved modifying existing fields + adding data to new fields. * diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index 889060ef04..04eba47898 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -199,7 +199,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { } /** - * edit price set + * Edit price set * * @param int $sid price set id * @param string $action the action to be invoked diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php index 3c98c3b2e6..1646ba3956 100644 --- a/CRM/Profile/Form.php +++ b/CRM/Profile/Form.php @@ -91,14 +91,14 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_title; /** - * the fields needed to build this form + * The fields needed to build this form * * @var array */ public $_fields; /** - * to store contact details + * To store contact details * * @var array */ @@ -157,7 +157,7 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_recordId = NULL; /** - * action for multi record profile (create/edit/delete) + * Action for multi record profile (create/edit/delete) * * @var string */ @@ -177,7 +177,7 @@ class CRM_Profile_Form extends CRM_Core_Form { protected $_session = NULL; /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for table name, id of entity in table, type of entity and stores them. * @@ -867,7 +867,7 @@ class CRM_Profile_Form extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index bb26b21bd1..4cb361ff17 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -44,7 +44,7 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { /** - * pre processing work done here. + * Pre processing work done here. * * @param * @@ -95,7 +95,7 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/Profile/Form/Edit.php b/CRM/Profile/Form/Edit.php index 72aca4c486..e8f3d9d9fd 100644 --- a/CRM/Profile/Form/Edit.php +++ b/CRM/Profile/Form/Edit.php @@ -50,7 +50,7 @@ class CRM_Profile_Form_Edit extends CRM_Profile_Form { protected $_prefix; /** - * pre processing work done here. + * Pre processing work done here. * * @param * @@ -307,7 +307,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 79126f0e11..5741e255ce 100644 --- a/CRM/Profile/Form/Search.php +++ b/CRM/Profile/Form/Search.php @@ -44,7 +44,7 @@ class CRM_Profile_Form_Search extends CRM_Profile_Form { /** - * pre processing work done here. + * Pre processing work done here. * * @param * diff --git a/CRM/Profile/Page/Dynamic.php b/CRM/Profile/Page/Dynamic.php index 08b3bcb246..844e8f1413 100644 --- a/CRM/Profile/Page/Dynamic.php +++ b/CRM/Profile/Page/Dynamic.php @@ -52,7 +52,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { protected $_id; /** - * the profile group are are interested in + * The profile group are are interested in * * @var int * @access protected @@ -105,7 +105,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { protected $_allFields = NULL; /** - * class constructor + * Class constructor * * @param int $id the contact id * @param int $gid the group id diff --git a/CRM/Profile/Page/Listings.php b/CRM/Profile/Page/Listings.php index 22e527943d..905f567474 100644 --- a/CRM/Profile/Page/Listings.php +++ b/CRM/Profile/Page/Listings.php @@ -42,7 +42,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { /** - * all the fields that are listings related + * All the fields that are listings related * * @var array * @access protected @@ -50,7 +50,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { protected $_fields; /** - * the custom fields for this domain + * The custom fields for this domain * * @var array * @access protected @@ -73,7 +73,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { protected $_gid; /** - * state whether to display search form or not + * State whether to display search form or not * * @var int */ @@ -93,7 +93,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { protected $_profileIds = array(); /** - * extracts the parameters from the request and constructs information for + * Extracts the parameters from the request and constructs information for * the selector object to do a query * * @return void @@ -275,7 +275,7 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ @@ -398,9 +398,9 @@ 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 $gid + * @param int $gid * * @return array * @access public diff --git a/CRM/Profile/Page/View.php b/CRM/Profile/Page/View.php index 6762cc0df4..c787ef5e4e 100644 --- a/CRM/Profile/Page/View.php +++ b/CRM/Profile/Page/View.php @@ -164,7 +164,7 @@ class CRM_Profile_Page_View extends CRM_Core_Page { } /** - * build the outcome basing on the CRM_Profile_Page_Dynamic's HTML + * Build the outcome basing on the CRM_Profile_Page_Dynamic's HTML * * @return void * @access public diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index afc0564b19..5f366043c0 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -42,7 +42,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { /** - * array of supported links, currenly view and edit + * Array of supported links, currenly view and edit * * @var array * @static @@ -50,7 +50,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR static $_links = NULL; /** - * we use desc to remind us what that column is, name is used in the tpl + * We use desc to remind us what that column is, name is used in the tpl * * @var array * @static @@ -66,7 +66,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_params; /** - * the public visible fields to be shown to the user + * The public visible fields to be shown to the user * * @var array * @access protected @@ -74,7 +74,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_fields; /** - * the custom fields for this domain + * The custom fields for this domain * * @var array * @access protected @@ -82,7 +82,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_customFields; /** - * cache the query object + * Cache the query object * * @var object * @access protected @@ -90,7 +90,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_query; /** - * cache the expanded options list if any + * Cache the expanded options list if any * * @var object * @access protected @@ -277,7 +277,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * getter for array of the parameters required for creating pager. + * Getter for array of the parameters required for creating pager. * * @param $action * @param array $params @@ -296,7 +296,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * * @param string $action the action being performed @@ -432,7 +432,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 enum $action the action being performed * @param int $offset the row number to start from @@ -725,7 +725,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR } /** - * name of export file. + * Name of export file. * * @param string $output type of output * diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php index 068e9c973c..dbca273fb5 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 * @static diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 92f40dd059..0e72586be3 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -36,7 +36,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 @@ -227,7 +227,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { /** * Delete the instance of the Report * - * @param null $id + * @param int $id * * @return mixed $results no of deleted Instance on success, false otherwise@access public */ diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index cec9d6c217..5a672f4f15 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -142,13 +142,13 @@ class CRM_Report_Form extends CRM_Core_Form { protected $_customGroupJoin = 'LEFT JOIN'; /** - * build tags filter + * Build tags filter * */ protected $_tagFilter = FALSE; /** - * build groups filter + * Build groups filter * */ protected $_groupFilter = FALSE; @@ -261,7 +261,7 @@ class CRM_Report_Form extends CRM_Core_Form { protected $_selectedTables; /** - * outputmode e.g 'print', 'csv', 'pdf' + * Outputmode e.g 'print', 'csv', 'pdf' * @var string */ protected $_outputMode; @@ -278,7 +278,7 @@ class CRM_Report_Form extends CRM_Core_Form { public $_havingClauses = array(); /** - * dashBoardRowCount Dashboard row count + * DashBoardRowCount Dashboard row count * @var Integer */ public $_dashBoardRowCount; @@ -773,7 +773,7 @@ class CRM_Report_Form extends CRM_Core_Form { /** * @param $group - * @param $grpFieldName + * @param string $grpFieldName * * @return bool */ @@ -798,7 +798,7 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Setter for $_id * - * @param $instanceid + * @param int $instanceid */ function setID($instanceid) { $this->_id = $instanceid; @@ -1520,7 +1520,7 @@ class CRM_Report_Form extends CRM_Core_Form { } /** - * @param $fieldName + * @param string $fieldName * @param $relative * @param $from * @param $to @@ -2097,9 +2097,9 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND } /** - * @param $tableName + * @param string $tableName * @param $tableKey - * @param $fieldName + * @param string $fieldName * @param $field * * @return bool @@ -2284,7 +2284,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND } /** - * beginPostProcess function run in both report mode and non-report mode (api) + * BeginPostProcess function run in both report mode and non-report mode (api) */ function beginPostProcessCommon() { @@ -3660,7 +3660,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * Adjusts dates passed in to YEAR() for fiscal year. */ /** - * @param $fieldName + * @param string $fieldName * * @return string */ @@ -3760,7 +3760,7 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a } /** - * @param $groupID + * @param int $groupID */ function add2group($groupID) { if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) { diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php index f46b8639ef..ef575eadb9 100644 --- a/CRM/Report/Form/Activity.php +++ b/CRM/Report/Form/Activity.php @@ -566,7 +566,7 @@ class CRM_Report_Form_Activity extends CRM_Report_Form { } /** - * @param $groupID + * @param int $groupID * * @throws Exception */ diff --git a/CRM/Report/Form/Case/Demographics.php b/CRM/Report/Form/Case/Demographics.php index 3994e417d2..6ad964019e 100644 --- a/CRM/Report/Form/Case/Demographics.php +++ b/CRM/Report/Form/Case/Demographics.php @@ -445,7 +445,7 @@ where (cg.extends='Contact' OR cg.extends='Individual' OR cg.extends_entity_colu } /** - * @param $fname + * @param string $fname * @param $val * * @return null|string diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php index f423b8e310..c8c72e4e19 100644 --- a/CRM/Report/Form/Contribute/TopDonor.php +++ b/CRM/Report/Form/Contribute/TopDonor.php @@ -373,7 +373,7 @@ class CRM_Report_Form_Contribute_TopDonor extends CRM_Report_Form { } /** - * @param $groupID + * @param int $groupID */ function add2group($groupID) { if (is_numeric($groupID)) { diff --git a/CRM/Report/Form/Event/ParticipantListing.php b/CRM/Report/Form/Event/ParticipantListing.php index db21cd9335..79bcc9178d 100644 --- a/CRM/Report/Form/Event/ParticipantListing.php +++ b/CRM/Report/Form/Event/ParticipantListing.php @@ -609,7 +609,7 @@ GROUP BY cv.label * @param $rows * @param $entryFound * @param $row - * @param $rowId + * @param int $rowId * @param $rowNum * @param $types */ diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index 27f553b442..8954f2f318 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -1323,7 +1323,7 @@ WHERE line_item_civireport.id IS NOT NULL * @param $value * @param $row * @param $selectedfield - * @param $criteriaFieldName + * @param string $criteriaFieldName * * @return array */ @@ -1341,7 +1341,7 @@ WHERE line_item_civireport.id IS NOT NULL * @param $value * @param $row * @param $selectedfield - * @param $criteriaFieldName + * @param string $criteriaFieldName * * @return array */ @@ -1359,7 +1359,7 @@ WHERE line_item_civireport.id IS NOT NULL * @param $value * @param $row * @param $selectedfield - * @param $criteriaFieldName + * @param string $criteriaFieldName * * @return array */ @@ -1377,7 +1377,7 @@ WHERE line_item_civireport.id IS NOT NULL /** * @param $value * @param $row - * @param $fieldname + * @param string $fieldname * * @return mixed */ diff --git a/CRM/Report/Form/Pledge/Detail.php b/CRM/Report/Form/Pledge/Detail.php index ae4107a463..1c622ee20e 100644 --- a/CRM/Report/Form/Pledge/Detail.php +++ b/CRM/Report/Form/Pledge/Detail.php @@ -230,9 +230,9 @@ 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 */ /** - * @param $tableName + * @param string $tableName * @param $tableKey - * @param $fieldName + * @param string $fieldName * @param $field * * @return bool|string diff --git a/CRM/Report/Page/Instance.php b/CRM/Report/Page/Instance.php index d68a48d2a5..625c3b5d13 100644 --- a/CRM/Report/Page/Instance.php +++ b/CRM/Report/Page/Instance.php @@ -39,7 +39,7 @@ */ class CRM_Report_Page_Instance extends CRM_Core_Page { /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Report/Page/InstanceList.php b/CRM/Report/Page/InstanceList.php index 468670fc54..1387d4233b 100644 --- a/CRM/Report/Page/InstanceList.php +++ b/CRM/Report/Page/InstanceList.php @@ -176,7 +176,7 @@ class CRM_Report_Page_InstanceList extends CRM_Core_Page { } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Report/Page/List.php b/CRM/Report/Page/List.php index 734cc54188..854fa50644 100644 --- a/CRM/Report/Page/List.php +++ b/CRM/Report/Page/List.php @@ -74,7 +74,7 @@ ORDER BY v.weight"; } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index e769e1fc4a..bd6a1752e4 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -213,7 +213,7 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { } /** - * get userContext params + * Get userContext params * * @param int $mode mode that we are in * diff --git a/CRM/Report/Page/Report.php b/CRM/Report/Page/Report.php index d0c1fbaec0..a02b0c9756 100644 --- a/CRM/Report/Page/Report.php +++ b/CRM/Report/Page/Report.php @@ -40,7 +40,7 @@ class CRM_Report_Page_Report extends CRM_Core_Page { /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Report/Page/TemplateList.php b/CRM/Report/Page/TemplateList.php index 2eac142299..e133662c15 100644 --- a/CRM/Report/Page/TemplateList.php +++ b/CRM/Report/Page/TemplateList.php @@ -40,7 +40,7 @@ class CRM_Report_Page_TemplateList extends CRM_Core_Page { /** - * @param null $compID + * @param int $compID * @param null $grouping * * @return array @@ -107,7 +107,7 @@ LEFT JOIN civicrm_component comp } /** - * run this page (figure out the action needed and perform it). + * Run this page (figure out the action needed and perform it). * * @return void */ diff --git a/CRM/Report/Utils/Get.php b/CRM/Report/Utils/Get.php index cad6f333e7..6d55e625b5 100644 --- a/CRM/Report/Utils/Get.php +++ b/CRM/Report/Utils/Get.php @@ -36,7 +36,7 @@ class CRM_Report_Utils_Get { /** - * @param $name + * @param string $name * @param $type * * @return mixed|null @@ -53,7 +53,7 @@ class CRM_Report_Utils_Get { } /** - * @param $fieldName + * @param string $fieldName * @param $field * @param $defaults */ @@ -96,7 +96,7 @@ class CRM_Report_Utils_Get { } /** - * @param $fieldName + * @param string $fieldName * @param $field * @param $defaults */ @@ -134,7 +134,7 @@ class CRM_Report_Utils_Get { } /** - * @param $fieldName + * @param string $fieldName * @param $field * @param $defaults */ diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index b69e75df69..42ad6bde97 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -36,7 +36,7 @@ class CRM_Report_Utils_Report { /** - * @param null $instanceID + * @param int $instanceID * * @return null|string */ @@ -63,7 +63,7 @@ class CRM_Report_Utils_Report { } /** - * @param null $instanceID + * @param int $instanceID * * @return array|bool */ @@ -123,7 +123,7 @@ WHERE TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1"; * @param $urlValue * @param string $query * @param bool $absolute - * @param null $instanceID + * @param int $instanceID * @param array $drilldownReport * * @return bool|string @@ -174,7 +174,7 @@ WHERE inst.report_id = %1"; /** * @param $fileContent - * @param null $instanceID + * @param int $instanceID * @param string $outputMode * @param array $attachments * @@ -325,7 +325,7 @@ WHERE inst.report_id = %1"; } /** - * @param $instanceId + * @param int $instanceId * * @return bool */ @@ -357,7 +357,7 @@ WHERE inst.report_id = %1"; * * @instanceId string $str the report instance to check * - * @param $instanceId + * @param int $instanceId * * @return boolean true if yes, else false * @static diff --git a/CRM/SMS/BAO/Provider.php b/CRM/SMS/BAO/Provider.php index 3202f197b2..4cafb4d7be 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 * * @access public * @return \CRM_SMS_DAO_Provider @@ -107,7 +107,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { /** * @param $values - * @param $providerId + * @param int $providerId */ static function updateRecord($values, $providerId) { $dao = new CRM_SMS_DAO_Provider(); @@ -119,7 +119,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { } /** - * @param $id + * @param int $id * @param $is_active * * @return bool @@ -129,7 +129,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { } /** - * @param $providerID + * @param int $providerID * * @return null * @throws Exception @@ -148,7 +148,7 @@ class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider { } /** - * @param $providerID + * @param int $providerID * @param null $returnParam * @param null $returnDefaultString * diff --git a/CRM/SMS/Controller/Send.php b/CRM/SMS/Controller/Send.php index 32467633c2..344d11d721 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal, NULL, FALSE, TRUE); diff --git a/CRM/SMS/Form/Group.php b/CRM/SMS/Form/Group.php index 4e2fd845e1..5e2d1bce59 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 * @access public @@ -308,7 +308,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 c7ff282234..66fe82f1f5 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 * @access public diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index 5e97c12b04..a531d03574 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -290,7 +290,7 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { } /** - * validation + * Validation * * @param array $params (ref.) an assoc array of name/value pairs * diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index 8420a3d09a..5fa2f04788 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -46,7 +46,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 @@ -96,7 +96,7 @@ abstract class CRM_SMS_Provider { abstract function send($recipients, $header, $message, $dncID = NULL); /** - * return message text. Child class could override this function to have better control over the message being sent. + * Return message text. Child class could override this function to have better control over the message being sent. * * @access public */ @@ -120,11 +120,11 @@ abstract class CRM_SMS_Provider { } /** - * @param $apiMsgID + * @param int $apiMsgID * @param $message * @param array $headers - * @param null $jobID - * @param null $userID + * @param int $jobID + * @param int $userID * * @return $this|null|object * @throws CRM_Core_Exception @@ -165,7 +165,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1"; } /** - * @param $name + * @param string $name * @param $type * @param bool $abort * @param null $default @@ -190,7 +190,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1"; * @param $from * @param $body * @param null $to - * @param null $trackID + * @param int $trackID * * @return $this|null|object * @throws CRM_Core_Exception diff --git a/CRM/SMS/StateMachine/Send.php b/CRM/SMS/StateMachine/Send.php index 8a982c2a75..3cf62c6117 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/UF/Form/AbstractPreview.php b/CRM/UF/Form/AbstractPreview.php index 8372987b62..0fe1964a8c 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 */ diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index b3d2d96701..e0471efbb0 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 * @access protected @@ -63,7 +63,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { protected $_fields; /** - * the title for field + * The title for field * * @var int * @access protected @@ -79,7 +79,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { protected $_selectFields; /** - * to store fields with if locationtype exits status + * To store fields with if locationtype exits status * * @var array * @access protected @@ -87,7 +87,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. @@ -96,7 +96,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 * @access public @@ -617,7 +617,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * validation rule for subtype. + * Validation rule for subtype. * * @param array $groupType contains all groupTypes. * @@ -661,7 +661,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { } /** - * validation rule for custom data extends entity column values. + * Validation rule for custom data extends entity column values. * * @param Object $customField Custom field * @param Integer $gid Group Id. @@ -746,7 +746,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 ae301b49f3..26cf0f715a 100644 --- a/CRM/UF/Form/Group.php +++ b/CRM/UF/Form/Group.php @@ -39,7 +39,7 @@ 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 * @access protected @@ -47,7 +47,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { protected $_id; /** - * the title for group + * The title for group * * @var int * @access protected @@ -58,7 +58,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 * @access public @@ -284,7 +284,7 @@ class CRM_UF_Form_Group extends CRM_Core_Form { } /** - * global form rule + * Global form rule * * @param array $fields the input form values * @param array $files the uploaded files if any diff --git a/CRM/UF/Form/Inline/Preview.php b/CRM/UF/Form/Inline/Preview.php index fea1f950c5..53ac26103d 100644 --- a/CRM/UF/Form/Inline/Preview.php +++ b/CRM/UF/Form/Inline/Preview.php @@ -41,7 +41,7 @@ class CRM_UF_Form_Inline_Preview extends CRM_UF_Form_AbstractPreview { /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for group or field id * diff --git a/CRM/UF/Form/Inline/PreviewById.php b/CRM/UF/Form/Inline/PreviewById.php index cd1008f5f9..b8276f08c0 100644 --- a/CRM/UF/Form/Inline/PreviewById.php +++ b/CRM/UF/Form/Inline/PreviewById.php @@ -41,7 +41,7 @@ class CRM_UF_Form_Inline_PreviewById extends CRM_UF_Form_AbstractPreview { /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for group or field id * diff --git a/CRM/UF/Form/Preview.php b/CRM/UF/Form/Preview.php index 6d813e3d2e..b3409bfcbb 100644 --- a/CRM/UF/Form/Preview.php +++ b/CRM/UF/Form/Preview.php @@ -41,7 +41,7 @@ class CRM_UF_Form_Preview extends CRM_UF_Form_AbstractPreview { /** - * pre processing work done here. + * Pre processing work done here. * * gets session variables for group or field id * diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php index a684abbcbf..32a549dedb 100644 --- a/CRM/UF/Page/Field.php +++ b/CRM/UF/Page/Field.php @@ -204,7 +204,7 @@ class CRM_UF_Page_Field extends CRM_Core_Page { } /** - * edit CiviCRM Profile data. + * Edit CiviCRM Profile data. * * editing would involved modifying existing fields + adding data to new fields. * diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php index 184a07a08a..0842b66c18 100644 --- a/CRM/UF/Page/Group.php +++ b/CRM/UF/Page/Group.php @@ -269,7 +269,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { } /** - * edit uf group + * Edit uf group * * @param int $id uf group id * @param string $action the action to be invoked @@ -383,7 +383,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { } /** - * this function is for preview mode for ufoup + * This function is for preview mode for ufoup * * @param int $id uf group id * @@ -401,7 +401,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { } /** - * @param $id + * @param int $id * @param $action */ function setContext($id, $action) { diff --git a/CRM/Upgrade/Controller.php b/CRM/Upgrade/Controller.php index ad80fde888..1d993a7d6f 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 */ function __construct($title = NULL, $action = CRM_Core_Action::NONE, diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index b8571df122..6f9dda2573 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -53,7 +53,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { public $multilingual = FALSE; /** - * locales available for multilingual upgrade + * Locales available for multilingual upgrade * * @var array * @public @@ -61,7 +61,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { public $locales; /** - * number to string mapper + * Number to string mapper * * @var array * @public @@ -187,7 +187,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { } /** - * @param $fileName + * @param string $fileName * @param bool $isQueryString */ function source($fileName, $isQueryString = FALSE) { @@ -217,7 +217,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { } /** - * getter function for title. Should be over-ridden by derived class + * Getter function for title. Should be over-ridden by derived class * * @return string * @access public diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index 1ec5761816..a62a64bdfc 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -353,8 +353,8 @@ ALTER TABLE civicrm_dashboard /** * @param CRM_Queue_TaskContext $ctx - * @param $startId - * @param $endId + * @param int $startId + * @param int $endId * * @return bool */ @@ -455,8 +455,8 @@ ALTER TABLE civicrm_dashboard * (e.g. "http://example.com/?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg"). * * @param CRM_Queue_TaskContext $ctx - * @param $startId - * @param $endId + * @param int $startId + * @param int $endId * @return bool */ static function cleanupBackendImageUrls(CRM_Queue_TaskContext $ctx, $startId, $endId) { diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index 45fa0073d0..30daff27d2 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -965,7 +965,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 */ function addMissingConstraints(CRM_Queue_TaskContext $ctx) { $query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'"; @@ -1122,7 +1122,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 */ function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 572c6f98b8..dce798023d 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 @@ -68,7 +68,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 * @@ -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 * @param boolean $is_active Value we want to set the is_active field @@ -202,7 +202,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * * @param CRM_Core_Form $qf form object (reference) * @param string $elementName name of the custom field - * @param $fieldId + * @param int $fieldId * @param boolean $inactiveNeeded * @param boolean $useRequired true if required else false * @param string $label label for custom field @@ -469,7 +469,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p /** * @param $optionLabel - * @param $fid + * @param int $fid * * @return mixed */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index 48ba55bd00..c423450ea2 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -40,7 +40,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue { /** - * insert/update a new entry in the database. + * Insert/update a new entry in the database. * * @param array $params (reference), array $ids * @@ -169,7 +169,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 * @param boolean $is_active Value we want to set the is_active field @@ -184,7 +184,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 34139a6d1b..40ef521b2d 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -255,10 +255,10 @@ WHERE %2.id = %1"; } /** - * @param $entityId + * @param int $entityId * @param string $entityTable * @param $amount - * @param null $otherParams + * @param array $otherParams */ public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) { if (!$entityId || CRM_Utils_System::isNull($amount)) diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 0315dacffb..c7b4d26bfe 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 */ 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 * @@ -79,7 +79,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 * @param bool $isActive value we want to set the is_active field @@ -547,10 +547,10 @@ WHERE id = %1"; /** * @param CRM_Core_Form $form - * @param $id + * @param int $id * @param string $entityTable * @param bool $validOnly - * @param null $priceSetId + * @param int $priceSetId * * @return bool|false|int|null */ @@ -756,7 +756,7 @@ WHERE id = %1"; } /** - * build the price set form. + * Build the price set form. * * @param CRM_Core_Form $form * @@ -865,7 +865,7 @@ return FALSE; } /** - * set daefult the price set fields. + * Set daefult the price set fields. * * @param CRM_Core_Form $form * @param $defaults @@ -1090,7 +1090,7 @@ return 0; } /** - * Function to retrieve auto renew frequency and interval + * Retrieve auto renew frequency and interval * * @param int $priceSetId price set id * @@ -1122,7 +1122,7 @@ return 0; } /** - * 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 * @param boolean $isQuickConfig value we want to set the is_quick_config field diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index 52709e4e53..6670d3bf9c 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -187,7 +187,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO public $visibility_id; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php index 895d9a2b88..66b22f0649 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php @@ -158,7 +158,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO public $is_active; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php index d990cdb0de..d7fb79f006 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php @@ -146,7 +146,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO public $price_field_value_id; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php index 5645ae17b3..9f2b761dd6 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php @@ -158,7 +158,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO public $is_reserved; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php index aa01941372..de4a74c3d1 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php @@ -110,7 +110,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO public $price_set_id; /** - * class constructor + * Class constructor * * @access public * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity diff --git a/CRM/Upgrade/StateMachine.php b/CRM/Upgrade/StateMachine.php index 815dbbc9c9..3d5b782924 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/Address.php b/CRM/Utils/Address.php index c024acc78d..4e2416716d 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/Cache.php b/CRM/Utils/Cache.php index e2cdd2d52c..21ae89399b 100644 --- a/CRM/Utils/Cache.php +++ b/CRM/Utils/Cache.php @@ -59,7 +59,7 @@ class CRM_Utils_Cache { } /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @return object * @static diff --git a/CRM/Utils/Check/Message.php b/CRM/Utils/Check/Message.php index 1dfb818ce7..934671d15b 100644 --- a/CRM/Utils/Check/Message.php +++ b/CRM/Utils/Check/Message.php @@ -49,7 +49,7 @@ class CRM_Utils_Check_Message { private $title; /** - * @param $name + * @param string $name * @param $message * @param $title */ diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index 34e5569969..76598219a0 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -39,7 +39,7 @@ class CRM_Utils_Date { /** - * format a date by padding it with leading '0'. + * Format a date by padding it with leading '0'. * * @param array $date ('Y', 'M', 'd') * @param string $separator the seperator to use when formatting the date @@ -164,7 +164,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 * @@ -185,7 +185,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 * @@ -206,7 +206,7 @@ class CRM_Utils_Date { } /** - * return abbreviated month names according to the locale + * Return abbreviated month names according to the locale * * @param bool $month * @@ -231,7 +231,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 * @@ -270,7 +270,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') @@ -421,7 +421,7 @@ class CRM_Utils_Date { } /** - * converts the date/datetime from MySQL format to ISO format + * Converts the date/datetime from MySQL format to ISO format * * @param string $mysql date/datetime in MySQL format * @@ -460,7 +460,7 @@ class CRM_Utils_Date { } /** - * converts the date/datetime from ISO format to MySQL format + * Converts the date/datetime from ISO format to MySQL format * Note that until CRM-14986/ 4.4.7 this was required whenever the pattern $dao->find(TRUE): $dao->save(); was * used to update an object with a date field was used. The DAO now checks for a '-' in date field strings * & runs this function if the - appears - meaning it is likely redundant in the form & BAO layers @@ -476,7 +476,7 @@ class CRM_Utils_Date { } /** - * converts the any given date to default date format. + * Converts the any given date to default date format. * * @param array $params has given date-format * @param int $dateType type of date @@ -702,7 +702,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, @@ -735,7 +735,7 @@ class CRM_Utils_Date { } /** - * find whether today's date lies in + * Find whether today's date lies in * the given range * * @param date $startDate start date for the range @@ -763,7 +763,7 @@ class CRM_Utils_Date { } /** - * get start date and end from + * Get start date and end from * the given relative term and unit * * @param date $relative eg: term.unit @@ -790,7 +790,7 @@ class CRM_Utils_Date { } /** - * Function to 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 * @@ -846,7 +846,7 @@ class CRM_Utils_Date { } /** - * Function to calculate next payment date according to provided unit & interval + * Calculate next payment date according to provided unit & interval * * @param string $unit frequency unit like year,month, week etc.. * @@ -910,7 +910,7 @@ class CRM_Utils_Date { } /** - * function to check given format is valid for bith date. + * Check given format is valid for bith date. * and retrun supportable birth date format w/ qf mapping. * * @param $format given format ( eg 'M Y', 'Y M' ) @@ -941,7 +941,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 * @param int $unit frequency unit like year, month, week etc.. @@ -1610,7 +1610,7 @@ class CRM_Utils_Date { } /** - * Function to 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 * diff --git a/CRM/Utils/DeprecatedUtils.php b/CRM/Utils/DeprecatedUtils.php index 85effe9287..ea991fdd84 100644 --- a/CRM/Utils/DeprecatedUtils.php +++ b/CRM/Utils/DeprecatedUtils.php @@ -1331,7 +1331,7 @@ function _civicrm_api3_deprecated_contact_check_custom_params($params, $csType = * @param bool $dupeCheck * @param bool $dupeErrorArray * @param bool $requiredCheck - * @param null $dedupeRuleGroupID + * @param int $dedupeRuleGroupID * * @return array|null */ @@ -1465,7 +1465,7 @@ function _civicrm_api3_deprecated_contact_check_params( /** * * @param $result - * @param $activityTypeID + * @param int $activityTypeID * * @return array $params */ diff --git a/CRM/Utils/FakeObject.php b/CRM/Utils/FakeObject.php index 0f87c043f8..a7b71b8a9f 100644 --- a/CRM/Utils/FakeObject.php +++ b/CRM/Utils/FakeObject.php @@ -20,7 +20,7 @@ class CRM_Utils_FakeObject { } /** - * @param $name + * @param string $name * @param $arguments * * @throws Exception diff --git a/CRM/Utils/File.php b/CRM/Utils/File.php index f169fb0273..2d29823906 100644 --- a/CRM/Utils/File.php +++ b/CRM/Utils/File.php @@ -95,7 +95,7 @@ class CRM_Utils_File { } /** - * create a directory given a path name, creates parent directories + * Create a directory given a path name, creates parent directories * if needed * * @param string $path the path name @@ -126,7 +126,7 @@ class CRM_Utils_File { } /** - * delete a directory given a path name, delete children directories + * Delete a directory given a path name, delete children directories * and files if needed * * @param string $target the path name @@ -265,7 +265,7 @@ class CRM_Utils_File { /** * @param $dsn - * @param $fileName + * @param string $fileName * @param null $prefix * @param bool $isQueryString * @param bool $dieOnErrors @@ -359,7 +359,7 @@ class CRM_Utils_File { } /** - * remove the 32 bit md5 we add to the fileName + * Remove the 32 bit md5 we add to the fileName * also remove the unknown tag if we added it */ static function cleanFileName($name) { @@ -369,7 +369,7 @@ class CRM_Utils_File { } /** - * @param $name + * @param string $name * * @return string */ diff --git a/CRM/Utils/Geocode/Google.php b/CRM/Utils/Geocode/Google.php index 5034d9b96c..7e315dc15d 100644 --- a/CRM/Utils/Geocode/Google.php +++ b/CRM/Utils/Geocode/Google.php @@ -39,7 +39,7 @@ class CRM_Utils_Geocode_Google { /** - * server to retrieve the lat/long + * Server to retrieve the lat/long * * @var string * @static @@ -47,7 +47,7 @@ class CRM_Utils_Geocode_Google { static protected $_server = 'maps.googleapis.com'; /** - * uri of service + * Uri of service * * @var string * @static @@ -55,7 +55,7 @@ class CRM_Utils_Geocode_Google { static protected $_uri = '/maps/api/geocode/xml?sensor=false&address='; /** - * function that takes an address object and gets the latitude / longitude for this + * Function that takes an address object and gets the latitude / longitude for this * address. Note that at a later stage, we could make this function also clean up * the address into a more valid format * diff --git a/CRM/Utils/Geocode/Yahoo.php b/CRM/Utils/Geocode/Yahoo.php index efe2b49c40..fc9f64c497 100644 --- a/CRM/Utils/Geocode/Yahoo.php +++ b/CRM/Utils/Geocode/Yahoo.php @@ -40,7 +40,7 @@ class CRM_Utils_Geocode_Yahoo { /** - * server to retrieve the lat/long + * Server to retrieve the lat/long * * @var string * @static @@ -48,7 +48,7 @@ class CRM_Utils_Geocode_Yahoo { static protected $_server = 'query.yahooapis.com'; /** - * uri of service + * Uri of service * * @var string * @static @@ -56,7 +56,7 @@ class CRM_Utils_Geocode_Yahoo { static protected $_uri = '/v1/public/yql'; /** - * function that takes an address array and gets the latitude / longitude + * Function that takes an address array and gets the latitude / longitude * and postal code for this address. Note that at a later stage, we could * make this function also clean up the address into a more valid format * diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 21406e6f24..fa8b6be2d3 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -109,7 +109,7 @@ abstract class CRM_Utils_Hook { ); /** - * @param $numParams + * @param array $numParams * @param $arg1 * @param $arg2 * @param $arg3 @@ -161,7 +161,7 @@ abstract class CRM_Utils_Hook { /** * @param $civiModules * @param $fnSuffix - * @param $numParams + * @param array $numParams * @param $arg1 * @param $arg2 * @param $arg3 @@ -921,7 +921,7 @@ abstract class CRM_Utils_Hook { /** * @param $recordBAO - * @param $recordID + * @param int $recordID * @param $isActive * * @return mixed diff --git a/CRM/Utils/JSON.php b/CRM/Utils/JSON.php index 0a3d9f50f6..b4b278955b 100644 --- a/CRM/Utils/JSON.php +++ b/CRM/Utils/JSON.php @@ -49,7 +49,7 @@ class CRM_Utils_JSON { } /** - * create JSON object + * Create JSON object * @deprecated * * @param array $params associated array, that needs to be @@ -72,7 +72,7 @@ class CRM_Utils_JSON { } /** - * encode json format for flexigrid, NOTE: "id" should be present in $params for each row + * Encode json format for flexigrid, NOTE: "id" should be present in $params for each row * * @param array $params associated array of values rows * @param int $page page no for selector diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php index 9a80593b2d..86cdf330a3 100644 --- a/CRM/Utils/Mail.php +++ b/CRM/Utils/Mail.php @@ -305,7 +305,7 @@ class CRM_Utils_Mail { /** * @param $message - * @param null $params + * @param array $params * * @return mixed */ @@ -327,7 +327,7 @@ class CRM_Utils_Mail { } /** - * @param $name + * @param string $name * @param $email * @param bool $useQuote * diff --git a/CRM/Utils/Mail/Incoming.php b/CRM/Utils/Mail/Incoming.php index d8bae19d90..5567541539 100644 --- a/CRM/Utils/Mail/Incoming.php +++ b/CRM/Utils/Mail/Incoming.php @@ -409,7 +409,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/Export.php b/CRM/Utils/Migrate/Export.php index de8ace27af..05be0bfc6b 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -396,7 +396,7 @@ class CRM_Utils_Migrate_Export { } /** - * @param $groupName + * @param string $groupName * @param string $daoName * @param null $sql */ diff --git a/CRM/Utils/Migrate/ExportJSON.php b/CRM/Utils/Migrate/ExportJSON.php index adeff2efb3..f0e074cc89 100644 --- a/CRM/Utils/Migrate/ExportJSON.php +++ b/CRM/Utils/Migrate/ExportJSON.php @@ -180,7 +180,7 @@ WHERE g.name IN ( $nameString ) /** * @param $ids - * @param $tableName + * @param string $tableName * @param $fields * @param $whereField * @param null $additionalWhereCond @@ -212,7 +212,7 @@ SELECT * /** * @param $sql - * @param $tableName + * @param string $tableName * @param $fields */ function sql($sql, $tableName, &$fields) { @@ -495,8 +495,8 @@ WHERE ac.contact_id IN ( $ids ) } /** - * @param $id - * @param $name + * @param int $id + * @param string $name * @param $value */ function appendValue($id, $name, $value) { @@ -585,7 +585,7 @@ WHERE ac.contact_id IN ( $ids ) } /** - * @param $fileName + * @param string $fileName * @param null $lastExportTime * @param bool $discoverContacts */ diff --git a/CRM/Utils/Migrate/ImportJSON.php b/CRM/Utils/Migrate/ImportJSON.php index 071d8cc7e1..2de4dced64 100644 --- a/CRM/Utils/Migrate/ImportJSON.php +++ b/CRM/Utils/Migrate/ImportJSON.php @@ -280,7 +280,7 @@ class CRM_Utils_Migrate_ImportJSON { } /** - * @param $tableName + * @param string $tableName */ function populateCache($tableName) { if (isset($this->_lookupCache[$tableName])) { diff --git a/CRM/Utils/Money.php b/CRM/Utils/Money.php index 69e60df322..82ee2f71f8 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/OpenFlashChart.php b/CRM/Utils/OpenFlashChart.php index b96562b581..0815708c12 100644 --- a/CRM/Utils/OpenFlashChart.php +++ b/CRM/Utils/OpenFlashChart.php @@ -41,7 +41,7 @@ require_once 'packages/OpenFlashChart/php-ofc-library/open-flash-chart.php'; class CRM_Utils_OpenFlashChart { /** - * colours. + * Colours. * @var array * @static */ diff --git a/CRM/Utils/PDF/Label.php b/CRM/Utils/PDF/Label.php index 4884a3542d..f2f2375746 100644 --- a/CRM/Utils/PDF/Label.php +++ b/CRM/Utils/PDF/Label.php @@ -130,7 +130,7 @@ class CRM_Utils_PDF_Label extends TCPDF { } /** - * @param $name + * @param string $name * @param bool $convert * * @return float|int|mixed diff --git a/CRM/Utils/PDF/Utils.php b/CRM/Utils/PDF/Utils.php index 0bfed717b2..6cc6040c43 100644 --- a/CRM/Utils/PDF/Utils.php +++ b/CRM/Utils/PDF/Utils.php @@ -174,7 +174,7 @@ class CRM_Utils_PDF_Utils { * @param $orientation * @param $html * @param $output - * @param $fileName + * @param string $fileName * * @return string */ @@ -200,7 +200,7 @@ class CRM_Utils_PDF_Utils { * @param $margins * @param $html * @param $output - * @param $fileName + * @param string $fileName */ static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) { require_once 'packages/snappy/src/autoload.php'; @@ -292,7 +292,7 @@ class CRM_Utils_PDF_Utils { } /** - * @param $fileName + * @param string $fileName * @param $searchPath * @param $values * @param int $numPages diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 3632fedb77..feab68279a 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -51,12 +51,12 @@ require_once 'Pager/Sliding.php'; class CRM_Utils_Pager extends Pager_Sliding { /** - * constants for static parameters of the pager + * Constants for static parameters of the pager */ CONST ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount'; /** - * the output of the pager. This is a name/value array with various keys + * The output of the pager. This is a name/value array with various keys * that an application could use to display the pager * @var array */ @@ -129,7 +129,7 @@ class CRM_Utils_Pager extends Pager_Sliding { } /** - * helper function to assign remaining pager options as good default + * Helper function to assign remaining pager options as good default * values * * @param array $params the set of options needed to initialize the parent diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php index e957a7246d..e4fcb06b35 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 * @param string $sortByCharacter The character that we are potentially sorting on @@ -57,7 +57,7 @@ class CRM_Utils_PagerAToZ { } /** - * return the all the static characters + * Return the all the static characters * * @return array $staticAlphabets is a array of static characters * @access private @@ -69,7 +69,7 @@ class CRM_Utils_PagerAToZ { } /** - * return the all the dynamic characters + * Return the all the dynamic characters * * @param $query * @param $isDAO @@ -97,7 +97,7 @@ class CRM_Utils_PagerAToZ { } /** - * create the links + * Create the links * * @param array $query The form values for search * @param string $sortByCharacter The character that we are potentially sorting on diff --git a/CRM/Utils/ReCAPTCHA.php b/CRM/Utils/ReCAPTCHA.php index 1465efc3f4..213f7e60bb 100644 --- a/CRM/Utils/ReCAPTCHA.php +++ b/CRM/Utils/ReCAPTCHA.php @@ -52,7 +52,7 @@ class CRM_Utils_ReCAPTCHA { static private $_singleton = NULL; /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string the key to permit session scope's * diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php index 7663474420..1d3bc8b509 100644 --- a/CRM/Utils/Recent.php +++ b/CRM/Utils/Recent.php @@ -40,7 +40,7 @@ class CRM_Utils_Recent { /** - * max number of items in queue + * Max number of items in queue * * @int */ @@ -55,7 +55,7 @@ class CRM_Utils_Recent { static private $_recent = NULL; /** - * initialize this class and set the static variables + * Initialize this class and set the static variables * * @return void * @access public @@ -72,7 +72,7 @@ class CRM_Utils_Recent { } /** - * return the recently viewed array + * Return the recently viewed array * * @return array the recently viewed array * @access public @@ -84,14 +84,14 @@ 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 * @param string $url the link for the above title * @param string $id object id * @param $type - * @param $contactId - * @param $contactName + * @param int $contactId + * @param string $contactName * @param array $others * * @return void @@ -147,7 +147,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 * @@ -175,7 +175,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/Request.php b/CRM/Utils/Request.php index a3021c2f11..3581e27791 100644 --- a/CRM/Utils/Request.php +++ b/CRM/Utils/Request.php @@ -50,7 +50,7 @@ class CRM_Utils_Request { static private $_singleton = NULL; /** - * class constructor + * Class constructor */ function __construct() {} diff --git a/CRM/Utils/Rule.php b/CRM/Utils/Rule.php index 4730d930a9..a4111ce3ea 100644 --- a/CRM/Utils/Rule.php +++ b/CRM/Utils/Rule.php @@ -212,7 +212,7 @@ class CRM_Utils_Rule { } /** - * check the validity of the date (in qf format) + * Check the validity of the date (in qf format) * note that only a year is valid, or a mon-year is * also valid in addition to day-mon-year. The date * specified has to be beyond today. (i.e today or later) @@ -305,7 +305,7 @@ class CRM_Utils_Rule { } /** - * check the validity of a date or datetime (timestamp) + * Check the validity of a date or datetime (timestamp) * value which is in YYYYMMDD or YYYYMMDDHHMMSS format * * Uses PHP checkdate() - params are ( int $month, int $day, int $year ) @@ -549,7 +549,7 @@ class CRM_Utils_Rule { } /** - * see how file rules are written in HTML/QuickForm/file.php + * See how file rules are written in HTML/QuickForm/file.php * Checks to make sure the uploaded file is ascii * * @param array Uploaded file info (from $_FILES) @@ -596,7 +596,7 @@ class CRM_Utils_Rule { } /** - * see how file rules are written in HTML/QuickForm/file.php + * See how file rules are written in HTML/QuickForm/file.php * Checks to make sure the uploaded file is html * * @param array Uploaded file info (from $_FILES) @@ -741,7 +741,7 @@ class CRM_Utils_Rule { } /** - * check the validity of the date (in qf format) + * Check the validity of the date (in qf format) * note that only a year is valid, or a mon-year is * also valid in addition to day-mon-year * diff --git a/CRM/Utils/SQL/Insert.php b/CRM/Utils/SQL/Insert.php index 20c8785347..f1419f79a5 100644 --- a/CRM/Utils/SQL/Insert.php +++ b/CRM/Utils/SQL/Insert.php @@ -35,7 +35,7 @@ class CRM_Utils_SQL_Insert { private $rows; /** - * array list of column names + * Array list of column names */ private $columns; diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index 8f56c9dc82..a01157c965 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -48,7 +48,7 @@ class CRM_Utils_Sort { /** - * constants to determine what direction each variable + * Constants to determine what direction each variable * is to be sorted * * @var int @@ -56,27 +56,27 @@ class CRM_Utils_Sort { CONST ASCENDING = 1, DESCENDING = 2, DONTCARE = 4, /** - * the name for the sort GET/POST param + * The name for the sort GET/POST param * * @var string */ SORT_ID = 'crmSID', SORT_DIRECTION = 'crmSortDirection', SORT_ORDER = 'crmSortOrder'; /** - * name of the sort function. Used to isolate session variables + * Name of the sort function. Used to isolate session variables * @var string */ protected $_name; /** - * array of variables that influence the query + * Array of variables that influence the query * * @var array */ public $_vars; /** - * the newly formulated base url to be used as links + * The newly formulated base url to be used as links * for various table elements * * @var string @@ -84,7 +84,7 @@ class CRM_Utils_Sort { protected $_link; /** - * what's the name of the sort variable in a REQUEST + * What's the name of the sort variable in a REQUEST * * @var string */ @@ -168,7 +168,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 * @param int $dir the direction of the sort @@ -182,7 +182,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 * @@ -219,7 +219,7 @@ class CRM_Utils_Sort { } /** - * init the object + * Init the object * * @param string $defaultSortOrder the sort order to use by default * @@ -255,7 +255,7 @@ class CRM_Utils_Sort { } /** - * getter for currentSortID + * Getter for currentSortID * * @return int returns of the current sort id * @acccess public @@ -265,7 +265,7 @@ class CRM_Utils_Sort { } /** - * getter for currentSortDirection + * Getter for currentSortDirection * * @return int returns of the current sort direction * @acccess public diff --git a/CRM/Utils/String.php b/CRM/Utils/String.php index d5fbb23a8b..c435cd7a7b 100644 --- a/CRM/Utils/String.php +++ b/CRM/Utils/String.php @@ -75,7 +75,7 @@ class CRM_Utils_String { } /** - * given a string, replace all non alpha numeric characters and + * Given a string, replace all non alpha numeric characters and * spaces with the replacement character * * @param string $name the name to be worked on @@ -103,7 +103,7 @@ class CRM_Utils_String { } /** - * convert possibly underscore separated words to camel case with special handling for 'UF' + * Convert possibly underscore separated words to camel case with special handling for 'UF' * e.g * membership_payment returns MembershipPayment * @param string $string @@ -139,7 +139,7 @@ class CRM_Utils_String { } /** - * takes a string and returns the last tuple of the string. + * Takes a string and returns the last tuple of the string. * useful while converting file names to class names etc * * @param string $string the input string @@ -161,7 +161,7 @@ class CRM_Utils_String { } /** - * appends a name to a string and seperated by delimiter. + * Appends a name to a string and seperated by delimiter. * does the right thing for an empty string * * @param string $str the string to be appended to @@ -201,7 +201,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 * @param boolean $utf8 attempt utf8 match on failure (default yes) @@ -243,7 +243,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 input string @@ -333,7 +333,7 @@ class CRM_Utils_String { } /** - * determine if two href's are equivalent (fuzzy match) + * Determine if two href's are equivalent (fuzzy match) * * @param string $url1 the first url to be matched * @param string $url2 the second url to be matched against @@ -358,7 +358,7 @@ class CRM_Utils_String { } /** - * extract variable values + * Extract variable values * * @param mix $query this is basically url * @@ -383,7 +383,7 @@ class CRM_Utils_String { } /** - * translate a true/false/yes/no string to a 0 or 1 value + * Translate a true/false/yes/no string to a 0 or 1 value * * @param string $str the string to be translated * @@ -403,7 +403,7 @@ class CRM_Utils_String { } /** - * returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false + * Returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false * * @param string $str the string to be translated * @@ -541,7 +541,7 @@ class CRM_Utils_String { } /** - * strip leading, trailing, double spaces from string + * Strip leading, trailing, double spaces from string * used for postal/greeting/addressee * * @param string $string input string to be cleaned @@ -682,7 +682,7 @@ class CRM_Utils_String { } /** - * this function will mask part of the the user portion of an Email address (everything before the @) + * This function will mask part of the the user portion of an Email address (everything before the @) * * @param string $email the email address to be masked * @param string $maskChar the character used for masking @@ -704,7 +704,7 @@ class CRM_Utils_String { } /** - * this function compares two strings + * This function compares two strings * * @param string $strOne string one * @param string $strTwo string two diff --git a/CRM/Utils/Sunlight.php b/CRM/Utils/Sunlight.php index a6cf20d31c..fd4ed0385d 100644 --- a/CRM/Utils/Sunlight.php +++ b/CRM/Utils/Sunlight.php @@ -77,7 +77,7 @@ class CRM_Utils_Sunlight { } /** - * @param $peopleID + * @param int $peopleID * * @return array */ diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 91fc83dd25..c41ef0c251 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -1642,7 +1642,7 @@ class CRM_Utils_System { } /** - * clean url, replaces first '&' with '?' + * Clean url, replaces first '&' with '?' * * @param string $url * diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index 02109a6f52..c5c4fe761a 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -5,7 +5,7 @@ */ abstract class CRM_Utils_System_Base { /** - * deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific + * Deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific * functions and leave the codebase oblivious to the type of CMS * @deprecated * @var bool @@ -13,7 +13,7 @@ abstract class CRM_Utils_System_Base { var $is_drupal = FALSE; /** - * deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific + * Deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific * functions and leave the codebase oblivious to the type of CMS * @deprecated * @var bool @@ -41,7 +41,7 @@ abstract class CRM_Utils_System_Base { var $supports_form_extensions = FALSE; /** - * if we are using a theming system, invoke theme, else just print the + * If we are using a theming system, invoke theme, else just print the * content * * @param string $content the content that will be themed @@ -151,7 +151,7 @@ abstract class CRM_Utils_System_Base { /** * Determine the native ID of the CMS user * - * @param $username + * @param string $username * * @throws CRM_Core_Exception * @return int|NULL @@ -297,7 +297,7 @@ abstract class CRM_Utils_System_Base { function getLoggedInUniqueIdentifier() {} /** - * return a UFID (user account ID from the UserFramework / CMS system being based on the user object + * Return a UFID (user account ID from the UserFramework / CMS system being based on the user object * passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs * in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the user id before calling * the function @@ -315,7 +315,7 @@ abstract class CRM_Utils_System_Base { } /** - * return a unique identifier (usually an email address or username) from the UserFramework / CMS system being based on the user object + * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system being based on the user object * passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs * in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the unique identifier before calling * the function @@ -348,7 +348,7 @@ abstract class CRM_Utils_System_Base { } /** - * output code from error function + * Output code from error function * @param string $content */ function outputError($content) { diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 309274672c..26e29320f5 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { /** - * create a user in Drupal. + * Create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -105,8 +105,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * @param string $ufName User name */ /** - * @param $ufID - * @param $ufName + * @param int $ufID + * @param string $ufName */ function updateCMSName($ufID, $ufName) { // CRM-5555 @@ -232,7 +232,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { /** - * sets the title of the page + * Sets the title of the page * * @param string $title * @param null $pageTitle @@ -414,7 +414,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { } /** - * rewrite various system urls to https + * Rewrite various system urls to https * * @param null * @@ -427,7 +427,7 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param mix $action the default action if one is pre-specified * @@ -531,7 +531,7 @@ AND u.status = 1 * Load user into session */ /** - * @param $username + * @param string $username * * @return bool */ @@ -570,7 +570,7 @@ AND u.status = 1 /** * Determine the native ID of the CMS user * - * @param $username + * @param string $username * @return int|NULL */ function getUfId($username) { @@ -654,7 +654,7 @@ AND u.status = 1 } /** - * load drupal bootstrap + * Load drupal bootstrap * * @param array $params Either uid, or name & pass. * @param boolean $loadUser boolean Require CMS user load. @@ -811,7 +811,7 @@ AND u.status = 1 } /** - * check is user logged in. + * Check is user logged in. * * @return boolean true/false. */ diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index f269514fa9..5bf6056ec3 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** - * if we are using a theming system, invoke theme, else just print the + * If we are using a theming system, invoke theme, else just print the * content * * @param string $content the content that will be themed @@ -73,7 +73,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * create a user in Drupal. + * Create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -125,8 +125,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param string $ufName User name */ /** - * @param $ufID - * @param $ufName + * @param int $ufID + * @param string $ufName */ function updateCMSName($ufID, $ufName) { // CRM-5555 @@ -211,7 +211,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * get the drupal destination string. When this is passed in the + * Get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * * @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned @@ -249,7 +249,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * sets the title of the page + * Sets the title of the page * * @param string $title * @param null $pageTitle @@ -396,7 +396,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * rewrite various system urls to https + * Rewrite various system urls to https * * @param null * @@ -409,7 +409,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param mix $action the default action if one is pre-specified * @@ -521,7 +521,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Determine the native ID of the CMS user * - * @param $username + * @param string $username * @return int|NULL */ function getUfId($username) { @@ -596,7 +596,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. * @param boolean $loadUser boolean Require CMS user load. @@ -756,7 +756,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } /** - * check is user logged in. + * Check is user logged in. * * @return boolean true/false. */ diff --git a/CRM/Utils/System/Drupal8.php b/CRM/Utils/System/Drupal8.php index 454a61c7b1..34e2f1a731 100644 --- a/CRM/Utils/System/Drupal8.php +++ b/CRM/Utils/System/Drupal8.php @@ -39,7 +39,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { /** - * create a user in Drupal. + * Create a user in Drupal. * * @param array $params associated array * @param string $mail email id for cms user @@ -173,7 +173,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { } /** - * get the drupal destination string. When this is passed in the + * Get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * * @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned @@ -225,7 +225,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { /** - * sets the title of the page + * Sets the title of the page * * @param string $title * @param string $pageTitle @@ -496,7 +496,7 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { /** * Determine the native ID of the CMS user * - * @param $username + * @param string $username * @return int|NULL */ function getUfId($username) { @@ -529,7 +529,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. * @param boolean $loadUser boolean Require CMS user load. diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index 5872840455..cc32c9cd61 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -465,7 +465,7 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param mix $action the default action if one is pre-specified * diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index f8fc2190af..8471667dc8 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -51,7 +51,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * create a user of Joomla. + * Create a user of Joomla. * * @param array $params associated array * @param string $mail email id for cms user @@ -175,7 +175,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * sets the title of the page + * Sets the title of the page * * @param string $title title to set * @param string $pageTitle @@ -411,7 +411,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * rewrite various system urls to https + * Rewrite various system urls to https * * @return void * access public @@ -422,7 +422,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param $action the default action if one is pre-specified * @@ -440,7 +440,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 * @@ -626,7 +626,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * load joomla bootstrap + * Load joomla bootstrap * * @param $params array with uid or name and password * @param $loadUser boolean load cms user? @@ -683,7 +683,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * check is user logged in. + * Check is user logged in. * * @return boolean true/false. */ @@ -863,7 +863,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { } /** - * output code from error function + * Output code from error function * @param string $content */ function outputError($content) { diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php index 5a0ef48d36..05e804f7ea 100644 --- a/CRM/Utils/System/Soap.php +++ b/CRM/Utils/System/Soap.php @@ -45,7 +45,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { static $ufClass = NULL; /** - * sets the title of the page + * Sets the title of the page * * @param string $title title for page * @param $pageTitle @@ -60,7 +60,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { } /** - * given a permission string, check for access requirements + * Given a permission string, check for access requirements * * @param string $str the permission to check * @@ -123,7 +123,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param the default action if one is pre-specified * @@ -135,7 +135,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 * diff --git a/CRM/Utils/System/UnitTests.php b/CRM/Utils/System/UnitTests.php index 9176383c85..553f2052d5 100644 --- a/CRM/Utils/System/UnitTests.php +++ b/CRM/Utils/System/UnitTests.php @@ -46,7 +46,7 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { } /** - * sets the title of the page + * Sets the title of the page * * @param string $title * @param null $pageTitle @@ -133,7 +133,7 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param mix $action the default action if one is pre-specified * diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index dbe0356b1b..54d3b5c0a3 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -237,7 +237,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * rewrite various system urls to https + * Rewrite various system urls to https * * @param null * @@ -251,7 +251,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * figure out the post url for the form + * Figure out the post url for the form * * @param mix $action the default action if one is pre-specified * @@ -481,7 +481,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * load wordpress bootstrap + * Load wordpress bootstrap * * @param $name string optional username for login * @param $pass string optional password for login @@ -663,7 +663,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * check is user logged in. + * Check is user logged in. * * @return boolean true/false. */ @@ -764,7 +764,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * get timezone as a string + * Get timezone as a string * @return string Timezone e.g. 'America/Los_Angeles' */ function getTimeZoneString() { diff --git a/CRM/Utils/Time.php b/CRM/Utils/Time.php index a70ad24267..a55e8efabb 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 * @@ -66,7 +66,7 @@ class CRM_Utils_Time { } /** - * set the given time + * Set the given time * * @param string $newDateTime a date formatted with strtotime * @param string $returnFormat format in which date is to be retrieved diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index 290e68c86d..1b27afc40e 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -185,7 +185,7 @@ class CRM_Utils_Token { } /** - * get< the regex for token replacement + * Get< the regex for token replacement * * @param string $token_type a string indicating the the type of token to be used in the expression * @@ -198,7 +198,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 * @@ -1079,7 +1079,7 @@ class CRM_Utils_Token { } /** - * gives required details of contacts in an indexed array format so we + * Gives required details of contacts in an indexed array format so we * can iterate in a nice loop and do token evaluation * * @param $contactIDs @@ -1240,7 +1240,7 @@ class CRM_Utils_Token { } /** - * gives required details of contribuion in an indexed array format so we + * Gives required details of contribuion in an indexed array format so we * can iterate in a nice loop and do token evaluation * * @param array $contributionIDs @@ -1312,7 +1312,7 @@ class CRM_Utils_Token { return $memberships['values']; } /** - * replace greeting tokens exists in message/subject + * Replace greeting tokens exists in message/subject * * @access public */ @@ -1485,7 +1485,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'; diff --git a/CRM/Utils/Tree.php b/CRM/Utils/Tree.php index eaae076c00..e8cb8e5ec6 100644 --- a/CRM/Utils/Tree.php +++ b/CRM/Utils/Tree.php @@ -88,7 +88,7 @@ class CRM_Utils_Tree { /** * Constructor for the tree. * - * @param $nodeName + * @param string $nodeName * * @internal param string $rootNode * @@ -145,7 +145,7 @@ class CRM_Utils_Tree { } /** - * check if node is a leaf node. + * Check if node is a leaf node. * Currently leaf nodes are strings and non-leaf nodes are arrays * * @param array( @@ -230,7 +230,7 @@ class CRM_Utils_Tree { } /** - * print the tree + * Print the tree * * @param none * diff --git a/CRM/Utils/Weight.php b/CRM/Utils/Weight.php index a5d0dc994f..0856c985b2 100644 --- a/CRM/Utils/Weight.php +++ b/CRM/Utils/Weight.php @@ -39,7 +39,7 @@ class CRM_Utils_Weight { static $SIGNABLE_FIELDS = array('reset', 'dao', 'idName', 'url', 'filter'); // 'id','src','dst','dir' /** - * correct duplicate weight entries by putting them (duplicate weights) in sequence. + * Correct duplicate weight entries by putting them (duplicate weights) in sequence. * * @param string $daoName full name of the DAO * @param array $fieldValues field => value to be used in the WHERE @@ -85,7 +85,7 @@ class CRM_Utils_Weight { * * @param string $daoName full name of the DAO * $param integer $weight the weight to be removed - * @param $fieldID + * @param int $fieldID * @param array $fieldValues field => value to be used in the WHERE * @param string $weightField field which contains the weight value, * defaults to 'weight' @@ -181,7 +181,7 @@ class CRM_Utils_Weight { } /** - * returns the new calculated weight. + * Returns the new calculated weight. * * @param string $daoName full name of the DAO * @param array $fieldValues field => value to be used in the WHERE @@ -219,7 +219,7 @@ class CRM_Utils_Weight { } /** - * returns the highest weight. + * Returns the highest weight. * * @param string $daoName full name of the DAO * @param array $fieldValues field => value to be used in the WHERE @@ -239,7 +239,7 @@ class CRM_Utils_Weight { } /** - * returns the default weight ( highest weight + 1 ) to be used. + * Returns the default weight ( highest weight + 1 ) to be used. * * @param string $daoName full name of the DAO * @param array $fieldValues field => value to be used in the WHERE @@ -339,7 +339,7 @@ class CRM_Utils_Weight { /** * @param $rows * @param string $daoName - * @param $idName + * @param string $idName * @param $returnURL * @param null $filter */ diff --git a/api/class.api.php b/api/class.api.php index 1a59ce43db..7112996141 100644 --- a/api/class.api.php +++ b/api/class.api.php @@ -290,7 +290,7 @@ class civicrm_api3 { } /** - * @param $name + * @param string $name * @return bool */ public function is_set($name) { diff --git a/api/v3/Address.php b/api/v3/Address.php index 3e11a82041..c90509826f 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -50,7 +50,7 @@ */ function civicrm_api3_address_create(&$params) { /** - * if street_parsing, street_address has to be parsed into + * If street_parsing, street_address has to be parsed into * separate parts */ if (array_key_exists('street_parsing', $params)) { diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 36c02f416d..9ad8ff8fd2 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -296,7 +296,7 @@ function civicrm_api3_contact_delete($params) { * @param bool $dupeCheck * @param bool $dupeErrorArray * @param bool $obsoletevalue - * @param null $dedupeRuleGroupID + * @param int $dedupeRuleGroupID * * @return null * @throws API_Exception diff --git a/api/v3/Event.php b/api/v3/Event.php index 322a516e4a..3053bdd8a6 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -208,7 +208,7 @@ function civicrm_api3_event_delete($params) { */ /** * @param $event - * @param $event_id + * @param int $event_id */ function _civicrm_api3_event_getisfull(&$event, $event_id) { $eventFullResult = CRM_Event_BAO_Participant::eventFull($event_id, 1); diff --git a/api/v3/MailingContact.php b/api/v3/MailingContact.php index 39d978c4b9..ce4103b25d 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -96,7 +96,7 @@ function _civicrm_api3_mailing_contact_get_spec(&$params) { /** * @param $type - * @param $contactID + * @param int $contactID * @param $offset * @param $limit * @param $selectFields @@ -210,7 +210,7 @@ LIMIT %2, %3 } /** - * @param $contactID + * @param int $contactID * @param $offset * @param $limit * @param $sort @@ -250,7 +250,7 @@ AND meb.id IS NULL } /** - * @param $contactID + * @param int $contactID * @param $offset * @param $limit * @param $sort diff --git a/api/v3/Membership.php b/api/v3/Membership.php index 03582db73e..1893186bdf 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -228,7 +228,7 @@ function civicrm_api3_membership_get($params) { * as stable as possible * * @param array $params parameters passed into get function - * @param $membershipTypeId + * @param int $membershipTypeId * @param $activeOnly * * @return array result for calling function @@ -250,7 +250,7 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp * * @param array $params parameters passed into get function * @param $membershipValues - * @param $contactID + * @param int $contactID * * @return array result for calling function */ diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index 23752ce5d8..3abff8b96b 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -132,7 +132,7 @@ function civicrm_api3_membership_status_delete($params) { * This API is used for deriving Membership Status of a given Membership * record using the rules encoded in the membership_status table. * - * @param $membershipParams + * @param array $membershipParams * * @throws API_Exception * diff --git a/api/v3/PledgePayment.php b/api/v3/PledgePayment.php index 6a24544ff7..6a5ad34b65 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -129,8 +129,8 @@ function civicrm_api3_pledge_payment_get($params) { } /** - * @param $pledgeId - * @param $paymentStatusId + * @param int $pledgeId + * @param int $paymentStatusId * @param $paymentIds * * @return mixed diff --git a/api/v3/Profile.php b/api/v3/Profile.php index 6d7536bdf9..b78980a779 100644 --- a/api/v3/Profile.php +++ b/api/v3/Profile.php @@ -689,7 +689,7 @@ function _civicrm_api3_map_profile_fields_to_entity(&$field) { * @todo this should be handled by the api wrapper using getfields info - need to check * how we add a a pseudoconstant to this pseudo api to make that work * - * @param $profileID + * @param int $profileID * * @return integer|string * @throws CiviCRM_API3_Exception diff --git a/api/v3/utils.php b/api/v3/utils.php index 64825db980..3a7f0033db 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -1253,7 +1253,7 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this * if api::del doesn't exist it will try DAO delete method * - * @param $bao_name + * @param string $bao_name * @param array $params * * @return array API result array @@ -1293,7 +1293,7 @@ function _civicrm_api3_basic_delete($bao_name, &$params) { * * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id. * @param string $entity e.g membership, event - * @param $entity_id + * @param int $entity_id * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types * @param string $subName - Subtype of entity @@ -1422,7 +1422,7 @@ function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) { * we accept 'whatever strtotime accepts' * * @param string $dateValue - * @param $fieldName + * @param string $fieldName * @param $fieldType * * @throws Exception diff --git a/install/civicrm.php b/install/civicrm.php index debefb2925..02b50b994c 100644 --- a/install/civicrm.php +++ b/install/civicrm.php @@ -63,7 +63,7 @@ function civicrm_setup($filesDirectory) { } /** - * @param $name + * @param string $name * @param $buffer */ function civicrm_write_file($name, &$buffer) { @@ -130,7 +130,7 @@ function civicrm_main(&$config) { /** * @param $dsn - * @param $fileName + * @param string $fileName * @param bool $lineMode */ function civicrm_source($dsn, $fileName, $lineMode = FALSE) { diff --git a/install/index.php b/install/index.php index db9a3907d0..cb18967a2f 100644 --- a/install/index.php +++ b/install/index.php @@ -587,7 +587,7 @@ class InstallRequirements { } /** - * @param $funcName + * @param string $funcName * @param $testDetails * * @return bool @@ -649,7 +649,7 @@ class InstallRequirements { } /** - * @param $filename + * @param string $filename * @param $testDetails * @param bool $absolute */ @@ -675,7 +675,7 @@ class InstallRequirements { } /** - * @param $filename + * @param string $filename * @param $testDetails */ function requireNoFile($filename, $testDetails) { @@ -688,7 +688,7 @@ class InstallRequirements { } /** - * @param $filename + * @param string $filename * @param $testDetails */ function moveFileOutOfTheWay($filename, $testDetails) { @@ -703,7 +703,7 @@ class InstallRequirements { } /** - * @param $filename + * @param string $filename * @param $testDetails * @param bool $absolute */ @@ -729,7 +729,7 @@ class InstallRequirements { } /** - * @param $moduleName + * @param string $moduleName * @param $testDetails */ function requireApacheModule($moduleName, $testDetails) { @@ -741,7 +741,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $testDetails */ @@ -802,7 +802,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $testDetails @@ -837,7 +837,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $testDetails @@ -867,7 +867,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $testDetails @@ -908,7 +908,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $testDetails @@ -957,7 +957,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $testDetails */ @@ -989,7 +989,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $minValueKB @@ -1025,7 +1025,7 @@ class InstallRequirements { /** * @param $server - * @param $username + * @param string $username * @param $password * @param $database * @param $testDetails diff --git a/tests/extensions/test.extension.manager.paymenttest/main.php b/tests/extensions/test.extension.manager.paymenttest/main.php index b280aa471b..29d2a682b5 100644 --- a/tests/extensions/test.extension.manager.paymenttest/main.php +++ b/tests/extensions/test.extension.manager.paymenttest/main.php @@ -7,7 +7,7 @@ class test_extension_manager_paymenttest extends CRM_Core_Payment { static private $_singleton = NULL; /** - * singleton function used to manage this object + * Singleton function used to manage this object * * @param string $mode the mode of operation: live or test * @param array $paymentProcessor the details of the payment processor being invoked diff --git a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php index 74a91049ca..0345e7117e 100644 --- a/tests/phpunit/CRM/Activity/BAO/ActivityTest.php +++ b/tests/phpunit/CRM/Activity/BAO/ActivityTest.php @@ -28,7 +28,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcases for create() method + * Testcases for create() method * create() method Add/Edit activity. */ function testCreate() { @@ -68,7 +68,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcase for getContactActivity() method. + * Testcase for getContactActivity() method. * getContactActivity() method get activities detail for given target contact id */ function testGetContactActivity() { @@ -103,7 +103,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcase for retrieve() method. + * Testcase for retrieve() method. * retrieve($params, $defaults) method return activity detail for given params * and set defaults. */ @@ -151,7 +151,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcase for deleteActivity() method. + * Testcase for deleteActivity() method. * deleteActivity($params) method deletes activity for given params. */ function testDeleteActivity() { @@ -198,7 +198,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcase for deleteActivityTarget() method. + * Testcase for deleteActivityTarget() method. * deleteActivityTarget($activityId) method deletes activity target for given activity id. */ function testDeleteActivityTarget() { @@ -239,7 +239,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * testcase for deleteActivityAssignment() method. + * Testcase for deleteActivityAssignment() method. * deleteActivityAssignment($activityId) method deletes activity assignment for given activity id. */ function testDeleteActivityAssignment() { @@ -280,7 +280,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * test getActivitiesCount BAO method + * Test getActivitiesCount BAO method */ function testGetActivitiesCountforAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -309,7 +309,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * test getActivitiesCount BAO method + * Test getActivitiesCount BAO method */ function testGetActivitiesCountforNonAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -339,7 +339,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * test getActivitiesCount BAO method + * Test getActivitiesCount BAO method */ function testGetActivitiesCountforContactSummary() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -368,7 +368,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivitiesCount BAO method + * Test getActivitiesCount BAO method */ function testGetActivitiesCountforContactSummaryWithNoActivities() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -396,7 +396,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivities BAO method + * Test getActivities BAO method */ function testGetActivitiesforAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -431,7 +431,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivities BAO method + * Test getActivities BAO method */ function testGetActivitiesforNonAdminDashboard() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -474,7 +474,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivities BAO method + * Test getActivities BAO method */ function testGetActivitiesforContactSummary() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); @@ -529,7 +529,7 @@ class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase { } /** - * Function to test getActivities BAO method + * Test getActivities BAO method */ function testGetActivitiesforContactSummaryWithNoActivities() { $op = new PHPUnit_Extensions_Database_Operation_Insert(); diff --git a/tests/phpunit/CRM/Batch/Form/EntryTest.php b/tests/phpunit/CRM/Batch/Form/EntryTest.php index 1fab4fb644..dbd606818b 100644 --- a/tests/phpunit/CRM/Batch/Form/EntryTest.php +++ b/tests/phpunit/CRM/Batch/Form/EntryTest.php @@ -204,7 +204,7 @@ class CRM_Batch_Form_EntryTest extends CiviUnitTestCase { } } /** - * data provider for test process membership + * Data provider for test process membership * @return array */ function getMembershipData() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactTest.php b/tests/phpunit/CRM/Contact/BAO/ContactTest.php index 1acfb30530..1f739463ec 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactTest.php @@ -23,7 +23,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) * test with empty params. */ function testAddWithEmptyParams() { @@ -35,7 +35,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) * test with names * (create and update modes) */ @@ -76,7 +76,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) * test with all contact params * (creat and update modes) */ @@ -227,7 +227,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) * test with All contact types. */ function testAddWithAllContactTypes() { @@ -300,7 +300,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for create( ) + * Test case for create( ) * test with missing params. */ function testCreateWithEmptyParams() { @@ -315,7 +315,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for create( ) + * Test case for create( ) * test with all params. * ( create and update modes ). */ @@ -509,7 +509,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for resolveDefaults( ) + * Test case for resolveDefaults( ) * test all pseudoConstant, stateProvince, country. */ function testResolveDefaults() { @@ -546,7 +546,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for retrieve( ) + * Test case for retrieve( ) * test with all values. */ function testRetrieve() { @@ -646,7 +646,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for deleteContact( ) + * Test case for deleteContact( ) */ function testDeleteContact() { $contactParams = $this->contactParams(); @@ -731,7 +731,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for createProfileContac( ) + * Test case for createProfileContac( ) * test with all params. * ( create and update modes ) */ @@ -1120,7 +1120,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for getContactDetails( ) + * Test case for getContactDetails( ) */ function testGetContactDetails() { //get the contact params @@ -1146,7 +1146,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for + * Test case for * importableFields( ) and exportableFields( ) */ function testFields() { @@ -1172,7 +1172,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for getPrimaryEmail( ) + * Test case for getPrimaryEmail( ) * */ function testGetPrimaryEmail() { @@ -1196,7 +1196,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for getPrimaryOpenId( ) + * Test case for getPrimaryOpenId( ) * */ function testGetPrimaryOpenId() { @@ -1221,7 +1221,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for matchContactOnEmail( ) + * Test case for matchContactOnEmail( ) * */ function testMatchContactOnEmail() { @@ -1243,7 +1243,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for getContactType( ) + * Test case for getContactType( ) * */ function testGetContactType() { @@ -1263,7 +1263,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for displayName( ) + * Test case for displayName( ) * */ function testDisplayName() { @@ -1291,7 +1291,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { } /** - * test case for getDisplayAndImage( ) + * Test case for getDisplayAndImage( ) * */ function testGetDisplayAndImage() { @@ -1338,7 +1338,7 @@ class CRM_Contact_BAO_ContactTest extends CiviUnitTestCase { // } /** - * build common params + * Build common params * */ private function contactParams() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php index 7180400384..ef73bc1599 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactSearchTest.php @@ -97,7 +97,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { } /** - * search with only type + * Search with only type * success expected. */ function testSearchWithType() { @@ -161,7 +161,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { } /** - * search with only subtype + * Search with only subtype * success expected. */ function testSearchWithSubype() { @@ -208,7 +208,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { } /** - * search with type as well as subtype + * Search with type as well as subtype * success expected. */ function testSearchWithTypeSubype() { @@ -255,7 +255,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { } /** - * search with invalid type or subtype + * Search with invalid type or subtype */ function testSearchWithInvalidData() { // for invalid type @@ -289,7 +289,7 @@ class CRM_Contact_BAO_ContactType_ContactSearchTest extends CiviUnitTestCase { } /** - * search with wrong type or subtype + * Search with wrong type or subtype */ function testSearchWithWrongdData() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php index af6afa3a90..6a87759c13 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTest.php @@ -70,7 +70,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create Contact with valid data + * Methods create Contact with valid data * success expected * */ @@ -148,7 +148,7 @@ DELETE FROM civicrm_contact_type } /** - * update the contact with no subtype to a valid subtype + * Update the contact with no subtype to a valid subtype * success expected */ function testUpdateContactNosubtypeToValid() { @@ -200,7 +200,7 @@ DELETE FROM civicrm_contact_type } /** - * update the contact with subtype to another valid subtype + * Update the contact with subtype to another valid subtype * success expected */ function testUpdateContactSubtype() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php index 35e8258c40..977d26f652 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/ContactTypeTest.php @@ -64,7 +64,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test contactTypes() and subTypes() methods with valid data + * Test contactTypes() and subTypes() methods with valid data * success expected */ function testGetMethods() { @@ -123,7 +123,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test subTypes() methods with invalid data + * Test subTypes() methods with invalid data */ function testGetMethodsInvalid() { @@ -137,7 +137,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test add() methods with valid data + * Test add() methods with valid data * success expected */ function testAdd() { @@ -170,7 +170,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test add() with invalid data + * Test add() with invalid data */ function testAddInvalid1() { @@ -210,7 +210,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test del() with valid data + * Test del() with valid data * success expected */ function testDel() { @@ -230,7 +230,7 @@ class CRM_Contact_BAO_ContactType_ContactTypeTest extends CiviUnitTestCase { } /** - * test del() with invalid data + * Test del() with invalid data */ function testDelInvalid() { diff --git a/tests/phpunit/CRM/Contact/BAO/ContactType/RelationshipTest.php b/tests/phpunit/CRM/Contact/BAO/ContactType/RelationshipTest.php index d33dcfbcca..60037a0c05 100644 --- a/tests/phpunit/CRM/Contact/BAO/ContactType/RelationshipTest.php +++ b/tests/phpunit/CRM/Contact/BAO/ContactType/RelationshipTest.php @@ -100,7 +100,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create relationshipType with valid data + * Methods create relationshipType with valid data * success expected * */ @@ -161,7 +161,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create relationshipe within same contact type with invalid Relationships + * Methods create relationshipe within same contact type with invalid Relationships * */ function testRelationshipCreateInvalidWithinSameType() { @@ -189,7 +189,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create relationshipe within diff contact type with invalid Relationships + * Methods create relationshipe within diff contact type with invalid Relationships * */ function testRelCreateInvalidWithinDiffTypeSpocorIndivi() { @@ -242,7 +242,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create relationshipe within same contact type with valid data + * Methods create relationshipe within same contact type with valid data * success expected * */ @@ -271,7 +271,7 @@ DELETE FROM civicrm_contact_type } /** - * methods create relationshipe within different contact type with valid data + * Methods create relationshipe within different contact type with valid data * success expected * */ diff --git a/tests/phpunit/CRM/Contact/BAO/GroupContactTest.php b/tests/phpunit/CRM/Contact/BAO/GroupContactTest.php index cd3fb1c5b4..0cf02de5f4 100644 --- a/tests/phpunit/CRM/Contact/BAO/GroupContactTest.php +++ b/tests/phpunit/CRM/Contact/BAO/GroupContactTest.php @@ -55,7 +55,7 @@ class CRM_Contact_BAO_GroupContactTest extends CiviUnitTestCase { protected function tearDown() {} /** - * test case for add( ) + * Test case for add( ) */ function testAdd() { @@ -71,7 +71,7 @@ class CRM_Contact_BAO_GroupContactTest extends CiviUnitTestCase { } /** - * test case for getGroupId( ) + * Test case for getGroupId( ) */ function testGetGroupId() { diff --git a/tests/phpunit/CRM/Contact/BAO/GroupTest.php b/tests/phpunit/CRM/Contact/BAO/GroupTest.php index 17c67b4ce5..f87e6dc91d 100644 --- a/tests/phpunit/CRM/Contact/BAO/GroupTest.php +++ b/tests/phpunit/CRM/Contact/BAO/GroupTest.php @@ -56,7 +56,7 @@ class CRM_Contact_BAO_GroupTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) */ function testAddSimple() { diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionPageTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionPageTest.php index 4ca46625e9..aa8162e9e2 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionPageTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionPageTest.php @@ -56,7 +56,7 @@ class CRM_Contribute_BAO_ContributionPageTest extends CiviUnitTestCase { } /** - * create() method (create Contribution Page) + * Create() method (create Contribution Page) */ function testCreate() { @@ -107,7 +107,7 @@ class CRM_Contribute_BAO_ContributionPageTest extends CiviUnitTestCase { } /** - * test setValues() method + * Test setValues() method */ function testSetValues() { @@ -130,7 +130,7 @@ class CRM_Contribute_BAO_ContributionPageTest extends CiviUnitTestCase { } /** - * test copy() method + * Test copy() method */ function testcopy() { $params = array( @@ -162,7 +162,7 @@ class CRM_Contribute_BAO_ContributionPageTest extends CiviUnitTestCase { } /** - * test checkRecurPaymentProcessor() method + * Test checkRecurPaymentProcessor() method */ function testcheckRecurPaymentProcessor() { //@todo paypalpro create seems to fail silently without causing this class to fail diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php index e7e5af1c9a..94a5f63c15 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionRecurTest.php @@ -67,7 +67,7 @@ class CRM_Contribute_BAO_ContributionRecurTest extends CiviUnitTestCase { } /** - * test that an object can be retrieved & saved (per CRM-14986) + * 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 */ function testFindSave() { @@ -80,7 +80,7 @@ class CRM_Contribute_BAO_ContributionRecurTest extends CiviUnitTestCase { } /** - * test cancellation works per CRM-14986 + * Test cancellation works per CRM-14986 * we are checking for absence of error */ function testCancelRecur() { diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php index b0bf9264d1..6e0eb268d0 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php @@ -53,7 +53,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * create() method (create and update modes) + * Create() method (create and update modes) */ function testCreate() { $contactId = Contact::createIndividual(); @@ -100,7 +100,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * create() method with custom data + * Create() method with custom data */ function testCreateWithCustomData() { $contactId = Contact::createIndividual(); @@ -172,7 +172,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * deleteContribution() method + * DeleteContribution() method */ function testDeleteContribution() { $contactId = Contact::createIndividual(); @@ -211,7 +211,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * create honor-contact method + * Create honor-contact method */ function testcreateAndGetHonorContact() { $firstName = 'John_' . substr(sha1(rand()), 0, 7); @@ -295,7 +295,7 @@ class CRM_Contribute_BAO_ContributionTest extends CiviUnitTestCase { } /** - * display sort name during + * Display sort name during * contribution batch update through profile * sortName(); */ diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionTypeTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionTypeTest.php index 92e4353b3f..f5a2a4c0a1 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ContributionTypeTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ContributionTypeTest.php @@ -52,7 +52,7 @@ class CRM_Contribute_BAO_ContributionTypeTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $params = array( @@ -72,7 +72,7 @@ class CRM_Contribute_BAO_ContributionTypeTest extends CiviUnitTestCase { } /** - * check method retrive() + * Check method retrive() */ function testRetrieve() { $params = array( @@ -90,7 +90,7 @@ class CRM_Contribute_BAO_ContributionTypeTest extends CiviUnitTestCase { } /** - * check method setIsActive() + * Check method setIsActive() */ function testSetIsActive() { $params = array( @@ -111,7 +111,7 @@ class CRM_Contribute_BAO_ContributionTypeTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testdel() { $params = array( diff --git a/tests/phpunit/CRM/Contribute/BAO/ManagePremiumsTest.php b/tests/phpunit/CRM/Contribute/BAO/ManagePremiumsTest.php index aa598ca63a..9b3f523663 100644 --- a/tests/phpunit/CRM/Contribute/BAO/ManagePremiumsTest.php +++ b/tests/phpunit/CRM/Contribute/BAO/ManagePremiumsTest.php @@ -47,7 +47,7 @@ class CRM_Contribute_BAO_ManagePremiumsTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $ids = array(); @@ -72,7 +72,7 @@ class CRM_Contribute_BAO_ManagePremiumsTest extends CiviUnitTestCase { } /** - * check method retrieve( ) + * Check method retrieve( ) */ function testRetrieve() { $ids = array(); @@ -94,7 +94,7 @@ class CRM_Contribute_BAO_ManagePremiumsTest extends CiviUnitTestCase { } /** - * check method setIsActive( ) + * Check method setIsActive( ) */ function testSetIsActive() { $ids = array(); @@ -120,7 +120,7 @@ class CRM_Contribute_BAO_ManagePremiumsTest extends CiviUnitTestCase { } /** - * check method del( ) + * Check method del( ) */ function testDel() { $ids = array(); diff --git a/tests/phpunit/CRM/Core/BAO/AddressTest.php b/tests/phpunit/CRM/Core/BAO/AddressTest.php index 30092c9e56..b94cc4e9c2 100644 --- a/tests/phpunit/CRM/Core/BAO/AddressTest.php +++ b/tests/phpunit/CRM/Core/BAO/AddressTest.php @@ -51,7 +51,7 @@ class CRM_Core_BAO_AddressTest extends CiviUnitTestCase { } /** - * create() method (create and update modes) + * Create() method (create and update modes) */ function testCreate() { $contactId = Contact::createIndividual(); @@ -250,7 +250,7 @@ class CRM_Core_BAO_AddressTest extends CiviUnitTestCase { } /** - * getValues() method (get Address fields) + * GetValues() method (get Address fields) */ function testGetValues() { $contactId = Contact::createIndividual(); @@ -290,7 +290,7 @@ class CRM_Core_BAO_AddressTest extends CiviUnitTestCase { } /** - * parseStreetAddress() method (get street address parsed) + * ParseStreetAddress() method (get street address parsed) */ function testParseStreetAddress() { diff --git a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php index c4534cc4e3..11164b54e8 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomGroupTest.php @@ -51,7 +51,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * test getTree() + * Test getTree() */ function testGetTree() { $params = array(); @@ -91,7 +91,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * test retrieve() with Empty Params + * Test retrieve() with Empty Params */ function testRetrieveEmptyParams() { $params = array(); @@ -100,7 +100,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * test retrieve() with Inalid Params + * Test retrieve() with Inalid Params */ function testRetrieveInvalidParams() { $params = array('id' => 99); @@ -109,7 +109,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test retrieve() + * Test retrieve() */ function testRetrieve() { $customGrouptitle = 'My Custom Group'; @@ -145,7 +145,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test setIsActive() + * Test setIsActive() */ function testSetIsActive() { $customGrouptitle = 'My Custom Group'; @@ -175,7 +175,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getGroupDetail() with Empty Params + * Test getGroupDetail() with Empty Params */ function testGetGroupDetailEmptyParams() { $customGroupId = array(); @@ -184,7 +184,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getGroupDetail() with Inalid Params + * Test getGroupDetail() with Inalid Params */ function testGetGroupDetailInvalidParams() { $customGroupId = 99; @@ -193,7 +193,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getGroupDetail() + * Test getGroupDetail() */ function testGetGroupDetail() { $customGrouptitle = 'My Custom Group'; @@ -247,7 +247,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getTitle() with Invalid Params() + * Test getTitle() with Invalid Params() */ function testGetTitleWithInvalidParams() { $params = 99; @@ -257,7 +257,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getTitle() + * Test getTitle() */ function testGetTitle() { $customGrouptitle = 'My Custom Group'; @@ -284,7 +284,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test deleteGroup() + * Test deleteGroup() */ function testDeleteGroup() { $customGrouptitle = 'My Custom Group'; @@ -321,7 +321,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test createTable() + * Test createTable() */ function testCreateTable() { $customGrouptitle = 'My Custom Group'; @@ -360,7 +360,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test checkCustomField() + * Test checkCustomField() */ function testCheckCustomField() { $customGroupTitle = 'My Custom Group'; @@ -423,7 +423,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getActiveGroups() with Invalid Params() + * Test getActiveGroups() with Invalid Params() */ function testGetActiveGroupsWithInvalidParams() { $contactId = Contact::createIndividual(); @@ -461,7 +461,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test create() + * Test create() */ function testCreate() { $params = array( @@ -493,7 +493,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test create() given a table_name + * Test create() given a table_name */ function testCreateTableName() { $params = array( @@ -525,7 +525,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test isGroupEmpty() + * Test isGroupEmpty() */ function testIsGroupEmpty() { $customGrouptitle = 'Test Custom Group'; @@ -548,7 +548,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getGroupTitles() with Invalid Params() + * Test getGroupTitles() with Invalid Params() */ function testgetGroupTitlesWithInvalidParams() { $params = array(99); @@ -557,7 +557,7 @@ class CRM_Core_BAO_CustomGroupTest extends CiviUnitTestCase { } /** - * Function to test getGroupTitles() + * Test getGroupTitles() */ function testgetGroupTitles() { $customGrouptitle = 'Test Custom Group'; diff --git a/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php b/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php index c7e6f5566e..c3927f9a9b 100644 --- a/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php +++ b/tests/phpunit/CRM/Core/BAO/CustomValueTableTest.php @@ -24,7 +24,7 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { /** - * test store function for country + * Test store function for country * */ function testStoreCountry() { @@ -59,7 +59,7 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { } /** - * test store function for file + * Test store function for file * */ function atestStoreFile() { @@ -94,7 +94,7 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { } /** - * test store function for state province + * Test store function for state province * */ function testStoreStateProvince() { @@ -128,7 +128,7 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { } /** - * test store function for date + * Test store function for date * */ function testStoreDate() { @@ -198,7 +198,7 @@ class CRM_Core_BAO_CustomValueTableTest extends CiviUnitTestCase { } /** - * test getEntityValues function for stored value + * Test getEntityValues function for stored value * */ function testgetEntityValues() { diff --git a/tests/phpunit/CRM/Core/BAO/EmailTest.php b/tests/phpunit/CRM/Core/BAO/EmailTest.php index 3ca6ab6c06..2ffe95b843 100644 --- a/tests/phpunit/CRM/Core/BAO/EmailTest.php +++ b/tests/phpunit/CRM/Core/BAO/EmailTest.php @@ -24,7 +24,7 @@ class CRM_Core_BAO_EmailTest extends CiviUnitTestCase { } /** - * add() method (create and update modes) + * Add() method (create and update modes) */ function testAdd() { $contactId = Contact::createIndividual(); @@ -64,7 +64,7 @@ class CRM_Core_BAO_EmailTest extends CiviUnitTestCase { } /** - * holdEmail() method (set and reset on_hold condition) + * HoldEmail() method (set and reset on_hold condition) */ function testHoldEmail() { $contactId = Contact::createIndividual(); @@ -137,7 +137,7 @@ class CRM_Core_BAO_EmailTest extends CiviUnitTestCase { } /** - * allEmails() method - get all emails for our contact, with primary email first + * AllEmails() method - get all emails for our contact, with primary email first */ function testAllEmails() { $contactParams = array( diff --git a/tests/phpunit/CRM/Core/BAO/FinancialTrxnTest.php b/tests/phpunit/CRM/Core/BAO/FinancialTrxnTest.php index 7fd52c549e..43911460cd 100644 --- a/tests/phpunit/CRM/Core/BAO/FinancialTrxnTest.php +++ b/tests/phpunit/CRM/Core/BAO/FinancialTrxnTest.php @@ -47,7 +47,7 @@ class CRM_Core_BAO_FinancialTrxnTest extends CiviUnitTestCase { } /** - * check method create() + * Check method create() */ function testCreate() { $contactId = $this->individualCreate(); diff --git a/tests/phpunit/CRM/Core/BAO/IMTest.php b/tests/phpunit/CRM/Core/BAO/IMTest.php index 22735a36d8..daaae2d6c8 100644 --- a/tests/phpunit/CRM/Core/BAO/IMTest.php +++ b/tests/phpunit/CRM/Core/BAO/IMTest.php @@ -22,7 +22,7 @@ class CRM_Core_BAO_IMTest extends CiviUnitTestCase { } /** - * add() method (create and update modes) + * Add() method (create and update modes) */ function testAdd() { $contactId = Contact::createIndividual(); diff --git a/tests/phpunit/CRM/Core/BAO/LocationTest.php b/tests/phpunit/CRM/Core/BAO/LocationTest.php index 3c0b3983e9..355e680d6e 100644 --- a/tests/phpunit/CRM/Core/BAO/LocationTest.php +++ b/tests/phpunit/CRM/Core/BAO/LocationTest.php @@ -92,7 +92,7 @@ class CRM_Core_BAO_LocationTest extends CiviUnitTestCase { } /** - * create() method + * Create() method * create various elements of location block * without civicrm_loc_block entry */ @@ -216,7 +216,7 @@ class CRM_Core_BAO_LocationTest extends CiviUnitTestCase { } /** - * create() method + * Create() method * create various elements of location block * with civicrm_loc_block */ @@ -363,7 +363,7 @@ class CRM_Core_BAO_LocationTest extends CiviUnitTestCase { } /** - * deleteLocBlock() method + * DeleteLocBlock() method * delete the location block * created with various elements. * @@ -457,7 +457,7 @@ class CRM_Core_BAO_LocationTest extends CiviUnitTestCase { } /** - * getValues() method + * GetValues() method * get the values of various location elements */ function testLocBlockgetValues() { diff --git a/tests/phpunit/CRM/Core/BAO/OpenIDTest.php b/tests/phpunit/CRM/Core/BAO/OpenIDTest.php index 1e9305367e..b125ab93de 100644 --- a/tests/phpunit/CRM/Core/BAO/OpenIDTest.php +++ b/tests/phpunit/CRM/Core/BAO/OpenIDTest.php @@ -30,7 +30,7 @@ class CRM_Core_BAO_OpenIDTest extends CiviUnitTestCase { } /** - * add() method (create and update modes) + * Add() method (create and update modes) */ function testAdd() { $contactId = Contact::createIndividual(); @@ -74,7 +74,7 @@ class CRM_Core_BAO_OpenIDTest extends CiviUnitTestCase { } /** - * ifAllowedToLogin() method (set and reset allowed_to_login) + * IfAllowedToLogin() method (set and reset allowed_to_login) */ function testIfAllowedToLogin() { $contactId = Contact::createIndividual(); @@ -119,7 +119,7 @@ class CRM_Core_BAO_OpenIDTest extends CiviUnitTestCase { } /** - * allOpenIDs() method - get all OpenIDs for the given contact + * AllOpenIDs() method - get all OpenIDs for the given contact */ function testAllOpenIDs() { $contactId = Contact::createIndividual(); diff --git a/tests/phpunit/CRM/Core/BAO/PhoneTest.php b/tests/phpunit/CRM/Core/BAO/PhoneTest.php index 4161f0627d..0fecc84b0a 100644 --- a/tests/phpunit/CRM/Core/BAO/PhoneTest.php +++ b/tests/phpunit/CRM/Core/BAO/PhoneTest.php @@ -51,7 +51,7 @@ class CRM_Core_BAO_PhoneTest extends CiviUnitTestCase { } /** - * add() method (create and update modes) + * Add() method (create and update modes) */ function testAdd() { $contactId = Contact::createIndividual(); @@ -94,7 +94,7 @@ class CRM_Core_BAO_PhoneTest extends CiviUnitTestCase { } /** - * allPhones() method - get all Phones for our contact, with primary Phone first + * AllPhones() method - get all Phones for our contact, with primary Phone first */ function testAllPhones() { $contactParams = array( @@ -121,7 +121,7 @@ class CRM_Core_BAO_PhoneTest extends CiviUnitTestCase { } /** - * allEntityPhones() method - get all Phones for a location block, with primary Phone first + * AllEntityPhones() method - get all Phones for a location block, with primary Phone first * @todo FIXME: Fixing this test requires add helper functions in CiviTest to create location block and phone and link them to an event. Punting to 3.1 cycle. DGG */ function SKIPPED_testAllEntityPhones() {} diff --git a/tests/phpunit/CRM/Core/Payment/AuthorizeNetIPNTest.php b/tests/phpunit/CRM/Core/Payment/AuthorizeNetIPNTest.php index eac0b7e819..a1a1b9332f 100644 --- a/tests/phpunit/CRM/Core/Payment/AuthorizeNetIPNTest.php +++ b/tests/phpunit/CRM/Core/Payment/AuthorizeNetIPNTest.php @@ -45,7 +45,7 @@ class CRM_Core_Payment_AuthorizeNetIPNTest extends CiviUnitTestCase { } /** - * test IPN response updates contribution_recur & contribution for first & second contribution + * Test IPN response updates contribution_recur & contribution for first & second contribution */ function testIPNPaymentRecurSuccess() { $this->setupRecurringPaymentProcessorTransaction(); @@ -66,7 +66,7 @@ class CRM_Core_Payment_AuthorizeNetIPNTest extends CiviUnitTestCase { } /** - * test IPN response updates contribution_recur & contribution for first & second contribution + * Test IPN response updates contribution_recur & contribution for first & second contribution */ function testIPNPaymentMembershipRecurSuccess() { $this->setupMembershipRecurringPaymentProcessorTransaction(); diff --git a/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php b/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php index 923bee14c6..f94a0577df 100644 --- a/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php +++ b/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php @@ -70,7 +70,7 @@ class CRM_Core_Payment_AuthorizeNetTest extends CiviUnitTestCase { } /** - * create a single post dated payment as a recurring transaction. + * Create a single post dated payment as a recurring transaction. * * Test works but not both due to some form of caching going on in the SmartySingleton */ @@ -203,7 +203,7 @@ class CRM_Core_Payment_AuthorizeNetTest extends CiviUnitTestCase { } /** - * create a single post dated payment as a recurring transaction + * Create a single post dated payment as a recurring transaction */ function testCreateSinglePostDated() { $start_date = date('Ymd', strtotime("+ 1 week")); diff --git a/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php b/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php index bdc8c96325..54a3f49b52 100644 --- a/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php +++ b/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php @@ -69,7 +69,7 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { } /** - * test IPN response updates contribution_recur & contribution for first & second contribution + * Test IPN response updates contribution_recur & contribution for first & second contribution */ function testIPNPaymentRecurSuccess() { $this->setupRecurringPaymentProcessorTransaction(); @@ -90,7 +90,7 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { } /** - * test IPN response updates contribution_recur & contribution for first & second contribution + * Test IPN response updates contribution_recur & contribution for first & second contribution */ function testIPNPaymentMembershipRecurSuccess() { $this->setupMembershipRecurringPaymentProcessorTransaction(); @@ -144,7 +144,7 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { } /** - * check a payment express IPN call does not throw any errors + * Check a payment express IPN call does not throw any errors * At this stage nothing it supposed to happen so it's a pretty blunt test * but at least it should be e-notice free @@ -178,7 +178,7 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { } /** - * get PaymentExpress IPN for a single transaction + * Get PaymentExpress IPN for a single transaction * @return array array representing a Paypal IPN POST */ function getPaypalExpressTransactionIPN() { diff --git a/tests/phpunit/CRM/Core/PaymentTest.php b/tests/phpunit/CRM/Core/PaymentTest.php index 07b645e56c..97d54ffbbe 100644 --- a/tests/phpunit/CRM/Core/PaymentTest.php +++ b/tests/phpunit/CRM/Core/PaymentTest.php @@ -44,7 +44,7 @@ class CRM_Core_PaymentTest extends CiviUnitTestCase { } /** - * test the payment method is adequately logged - we don't expect the processing to succeed + * Test the payment method is adequately logged - we don't expect the processing to succeed */ function testHandlePaymentMethodLogging() { $params = array('processor_name' => 'Paypal', 'data' => 'blah'); diff --git a/tests/phpunit/CRM/Event/BAO/ParticipantStatusTest.php b/tests/phpunit/CRM/Event/BAO/ParticipantStatusTest.php index c048a13409..c9a5e157e9 100644 --- a/tests/phpunit/CRM/Event/BAO/ParticipantStatusTest.php +++ b/tests/phpunit/CRM/Event/BAO/ParticipantStatusTest.php @@ -131,7 +131,7 @@ class CRM_Event_BAO_ParticipantStatusTest extends CiviUnitTestCase { } /** - * retrieve() method of participant status type + * Retrieve() method of participant status type */ function testRetrieveStatusType() { @@ -159,7 +159,7 @@ class CRM_Event_BAO_ParticipantStatusTest extends CiviUnitTestCase { } /** - * setIsActive() method of participant status type + * SetIsActive() method of participant status type */ function testSetIsActiveStatusType() { diff --git a/tests/phpunit/CRM/Event/BAO/ParticipantTest.php b/tests/phpunit/CRM/Event/BAO/ParticipantTest.php index 0b142eeff5..0ea81769d8 100644 --- a/tests/phpunit/CRM/Event/BAO/ParticipantTest.php +++ b/tests/phpunit/CRM/Event/BAO/ParticipantTest.php @@ -54,7 +54,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * add() method (add and edit modes of participant) + * Add() method (add and edit modes of participant) */ function testAdd() { $params = array( @@ -101,7 +101,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * getValues() method (fetch value of participant) + * GetValues() method (fetch value of participant) */ function testgetValuesWithValidParams() { $participantId = Participant::create($this->_contactId, $this->_eventId); @@ -145,7 +145,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * getValues() method (checking for behavior when params are empty ) + * GetValues() method (checking for behavior when params are empty ) */ function testgetValuesWithoutValidParams() { $params = $values = $ids = array(); @@ -158,7 +158,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * eventFull() method (checking the event for full ) + * EventFull() method (checking the event for full ) */ function testEventFull() { $eventParams = array( @@ -178,7 +178,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * importableFields() method ( Checking the Event's Importable Fields ) + * ImportableFields() method ( Checking the Event's Importable Fields ) */ function testimportableFields() { $importableFields = CRM_Event_BAO_Participant::importableFields(); @@ -189,7 +189,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * participantDetails() method ( Checking the Participant Details ) + * ParticipantDetails() method ( Checking the Participant Details ) */ function testparticipantDetails() { $participantId = Participant::create($this->_contactId, $this->_eventId); @@ -207,7 +207,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * deleteParticipant() method ( Delete a Participant ) + * DeleteParticipant() method ( Delete a Participant ) */ function testdeleteParticipant() { $params = array( @@ -241,7 +241,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * checkDuplicate() method ( Checking for Duplicate Participant returns array of participant id) + * CheckDuplicate() method ( Checking for Duplicate Participant returns array of participant id) */ function testcheckDuplicate() { $duplicate = array(); @@ -271,7 +271,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * create() method (create and updation of participant) + * Create() method (create and updation of participant) */ function testCreate() { $params = array( @@ -340,7 +340,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * exportableFields() method ( Exportable Fields for Participant) + * ExportableFields() method ( Exportable Fields for Participant) */ function testexportableFields() { $exportableFields = CRM_Event_BAO_Participant::exportableFields(); @@ -351,7 +351,7 @@ class CRM_Event_BAO_ParticipantTest extends CiviUnitTestCase { } /** - * fixEventLevel() method (Setting ',' values), resolveDefaults(assinging value to array) method + * FixEventLevel() method (Setting ',' values), resolveDefaults(assinging value to array) method */ function testfixEventLevel() { diff --git a/tests/phpunit/CRM/Extension/Manager/ModuleTest.php b/tests/phpunit/CRM/Extension/Manager/ModuleTest.php index dfc2a37054..8a35cccf71 100644 --- a/tests/phpunit/CRM/Extension/Manager/ModuleTest.php +++ b/tests/phpunit/CRM/Extension/Manager/ModuleTest.php @@ -277,7 +277,7 @@ class CRM_Extension_Manager_ModuleTest extends CiviUnitTestCase { /** * @param $module - * @param $name + * @param string $name */ public static function incHookCount($module, $name) { global $_test_extension_manager_moduletest_counts; diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php index c28a65f6ee..cc780609cd 100644 --- a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php +++ b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php @@ -52,7 +52,7 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $params = array( @@ -75,7 +75,7 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase { } /** - * check method retrive() + * Check method retrive() */ function testRetrieve() { $params = array( @@ -92,7 +92,7 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase { } /** - * check method setIsActive() + * Check method setIsActive() */ function testSetIsActive() { $params = array( @@ -116,7 +116,7 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testdel() { $params = array( @@ -134,7 +134,7 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase { } /** - * check method getAccountingCode() + * Check method getAccountingCode() */ function testGetAccountingCode() { $params = array( diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php index 7058488f3a..68b5d66791 100755 --- a/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php +++ b/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php @@ -49,7 +49,7 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $firstName = 'Shane'; @@ -98,7 +98,7 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { } /** - * check method retrive() + * Check method retrive() */ function testRetrieve() { $firstName = 'Shane'; @@ -145,7 +145,7 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { } /** - * check method create() + * Check method create() */ function testCreate() { $firstName = 'Shane'; @@ -221,7 +221,7 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testCreateEntityTrxn() { $fParams = array( @@ -257,7 +257,7 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { } /** - * check method retrieveEntityFinancialTrxn() + * Check method retrieveEntityFinancialTrxn() */ function testRetrieveEntityFinancialTrxn() { $entityTrxn = self::testCreateEntityTrxn(); diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialTypeAccountTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialTypeAccountTest.php index b8b7bb5d14..7f7997a47c 100755 --- a/tests/phpunit/CRM/Financial/BAO/FinancialTypeAccountTest.php +++ b/tests/phpunit/CRM/Financial/BAO/FinancialTypeAccountTest.php @@ -48,7 +48,7 @@ class CRM_Financial_BAO_FinancialTypeAccountTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $params = array( @@ -84,7 +84,7 @@ class CRM_Financial_BAO_FinancialTypeAccountTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testDel() { $params = array( @@ -114,7 +114,7 @@ class CRM_Financial_BAO_FinancialTypeAccountTest extends CiviUnitTestCase { } /** - * check method getFinancialAccount() + * Check method getFinancialAccount() */ function testRetrieve() { $params = array( @@ -143,7 +143,7 @@ class CRM_Financial_BAO_FinancialTypeAccountTest extends CiviUnitTestCase { } /** - * check method getFinancialAccount() + * Check method getFinancialAccount() */ function testGetFinancialAccount() { $params = array( @@ -172,7 +172,7 @@ class CRM_Financial_BAO_FinancialTypeAccountTest extends CiviUnitTestCase { } /** - * check method getInstrumentFinancialAccount() + * Check method getInstrumentFinancialAccount() */ function testGetInstrumentFinancialAccount() { $paymentInstrumentValue = 1; diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php index 7408c58368..f94151f9a0 100755 --- a/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php +++ b/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php @@ -51,7 +51,7 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase { } /** - * check method add() + * Check method add() */ function testAdd() { $params = array( @@ -73,7 +73,7 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase { } /** - * check method retrive() + * Check method retrive() */ function testRetrieve() { $params = array( @@ -92,7 +92,7 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase { } /** - * check method setIsActive() + * Check method setIsActive() */ function testSetIsActive() { $params = array( @@ -115,7 +115,7 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testDel() { $params = array( diff --git a/tests/phpunit/CRM/Financial/BAO/PaymentProcessorTypeTest.php b/tests/phpunit/CRM/Financial/BAO/PaymentProcessorTypeTest.php index 0ae2257926..90177adafd 100755 --- a/tests/phpunit/CRM/Financial/BAO/PaymentProcessorTypeTest.php +++ b/tests/phpunit/CRM/Financial/BAO/PaymentProcessorTypeTest.php @@ -50,7 +50,7 @@ class CRM_Financial_BAO_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check method create() + * Check method create() */ function testCreate() { $params = array( @@ -70,7 +70,7 @@ class CRM_Financial_BAO_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check method retrieve() + * Check method retrieve() */ function testRetrieve() { $params = array( @@ -85,7 +85,7 @@ class CRM_Financial_BAO_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check method setIsActive() + * Check method setIsActive() */ function testSetIsActive() { $params = array( @@ -110,7 +110,7 @@ class CRM_Financial_BAO_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check method getDefault() + * Check method getDefault() */ function testGetDefault() { $params = array('is_default' => 1); @@ -122,7 +122,7 @@ class CRM_Financial_BAO_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check method del() + * Check method del() */ function testDel() { $params = array( diff --git a/tests/phpunit/CRM/Group/Page/AjaxTest.php b/tests/phpunit/CRM/Group/Page/AjaxTest.php index 257afdec4d..b62e90a2cb 100644 --- a/tests/phpunit/CRM/Group/Page/AjaxTest.php +++ b/tests/phpunit/CRM/Group/Page/AjaxTest.php @@ -81,7 +81,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { $_REQUEST = $this->_params; } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContacts() { $this->setPermissionAndRequest('view all contacts'); @@ -92,7 +92,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' permissioned user + * Retrieve groups as 'view all contacts' permissioned user * Without setting params the default is both enabled & disabled * (if you do set default it is enabled only) */ @@ -106,7 +106,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsNotFoundTitle() { $this->_params['title'] = 'z'; @@ -115,7 +115,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { $this->assertEquals(0, $total); } /** - * retrieve groups as 'edit all contacts' + * Retrieve groups as 'edit all contacts' */ function testGroupListEditAllContacts() { $this->setPermissionAndRequest('edit all contacts'); @@ -126,7 +126,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsEnabled() { $this->_params['status'] = 1; @@ -138,7 +138,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsDisabled() { $this->_params['status'] = 2; @@ -150,7 +150,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsDisabledNotFoundTitle() { $this->_params['status'] = 2; @@ -162,7 +162,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsDisabledFoundTitle() { $this->_params['status'] = 2; @@ -174,7 +174,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListViewAllContactsAll() { $this->_params['status'] = 3; @@ -189,7 +189,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRM() { $this->setPermissionAndRequest('access CiviCRM'); @@ -200,7 +200,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions'); } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRMEnabled() { $this->_params['status'] = 1; @@ -210,7 +210,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions'); } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRMDisabled() { $this->_params['status'] = 2; @@ -221,7 +221,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRMAll() { $this->_params['status'] = 2; @@ -232,7 +232,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRMFound() { $this->_params['title'] = 'p'; @@ -243,7 +243,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { } /** - * retrieve groups as 'view all contacts' + * Retrieve groups as 'view all contacts' */ function testGroupListAccessCiviCRMNotFound() { $this->_params['title'] = 'z'; diff --git a/tests/phpunit/CRM/Member/BAO/MembershipTest.php b/tests/phpunit/CRM/Member/BAO/MembershipTest.php index 9b48291b64..22894ee1a4 100644 --- a/tests/phpunit/CRM/Member/BAO/MembershipTest.php +++ b/tests/phpunit/CRM/Member/BAO/MembershipTest.php @@ -338,7 +338,7 @@ class CRM_Member_BAO_MembershipTest extends CiviUnitTestCase { /** - * get the contribution + * Get the contribution * page id from the membership record */ function testgetContributionPageId() { diff --git a/tests/phpunit/CRM/PCP/BAO/PCPTest.php b/tests/phpunit/CRM/PCP/BAO/PCPTest.php index 7747581889..3c18364c12 100644 --- a/tests/phpunit/CRM/PCP/BAO/PCPTest.php +++ b/tests/phpunit/CRM/PCP/BAO/PCPTest.php @@ -141,7 +141,7 @@ class CRM_PCP_BAO_PCPTest extends CiviUnitTestCase { } /** - * build params + * Build params * */ private function pcpBlockParams() { @@ -166,7 +166,7 @@ class CRM_PCP_BAO_PCPTest extends CiviUnitTestCase { } /** - * build params + * Build params * */ private function pcpParams() { diff --git a/tests/phpunit/CRM/Pledge/BAO/PledgeBlockTest.php b/tests/phpunit/CRM/Pledge/BAO/PledgeBlockTest.php index 641f2e80fe..6a30652301 100644 --- a/tests/phpunit/CRM/Pledge/BAO/PledgeBlockTest.php +++ b/tests/phpunit/CRM/Pledge/BAO/PledgeBlockTest.php @@ -100,7 +100,7 @@ class CRM_Pledge_BAO_PledgeBlockTest extends CiviUnitTestCase { } /** - * add() method (add and edit modes of pledge block) + * Add() method (add and edit modes of pledge block) */ function testAddPledgeBlock() { @@ -144,7 +144,7 @@ class CRM_Pledge_BAO_PledgeBlockTest extends CiviUnitTestCase { } /** - * retrieve() and getPledgeBlock() method of pledge block + * Retrieve() and getPledgeBlock() method of pledge block */ function testRetrieveAndGetPledgeBlock() { diff --git a/tests/phpunit/CRM/Utils/API/ReloadOptionTest.php b/tests/phpunit/CRM/Utils/API/ReloadOptionTest.php index 23b18a8954..99a480055b 100644 --- a/tests/phpunit/CRM/Utils/API/ReloadOptionTest.php +++ b/tests/phpunit/CRM/Utils/API/ReloadOptionTest.php @@ -90,8 +90,8 @@ class CRM_Utils_API_ReloadOptionTest extends CiviUnitTestCase { * Implementation of hook_civicrm_post used with all our test cases * * @param $op - * @param $objectName - * @param $objectId + * @param string $objectName + * @param int $objectId * @param $objectRef */ function onPost($op, $objectName, $objectId, &$objectRef) { diff --git a/tests/phpunit/CRM/Utils/MailTest.php b/tests/phpunit/CRM/Utils/MailTest.php index a403c58a2e..c4d97a4430 100644 --- a/tests/phpunit/CRM/Utils/MailTest.php +++ b/tests/phpunit/CRM/Utils/MailTest.php @@ -21,7 +21,7 @@ class CRM_Utils_MailTest extends CiviUnitTestCase { } /** - * test case for add( ) + * Test case for add( ) * test with empty params. */ function testFormatRFC822() { diff --git a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php index 6a52816b5b..c13f720ac4 100644 --- a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php +++ b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php @@ -153,8 +153,8 @@ class CRM_Utils_Migrate_ImportExportTest extends CiviUnitTestCase { * Execute a basic XML test case. Each test case creates a custom-group and * custom-field then compares the output to a pre-defined XML file. * - * @param $customGroupParams - * @param $fieldParams + * @param array $customGroupParams + * @param array $fieldParams * @param $expectedXmlFilePath * @dataProvider basicXmlTestCases */ diff --git a/tests/phpunit/CRM/Utils/ZipTest.php b/tests/phpunit/CRM/Utils/ZipTest.php index 99884e53b1..ea16799079 100644 --- a/tests/phpunit/CRM/Utils/ZipTest.php +++ b/tests/phpunit/CRM/Utils/ZipTest.php @@ -158,7 +158,7 @@ class CRM_Utils_ZipTest extends CiviUnitTestCase { } /** - * @param $expectedBaseDirName + * @param string $expectedBaseDirName * @param $dirs * @param $files */ diff --git a/tests/phpunit/Civi/API/RequestTest.php b/tests/phpunit/Civi/API/RequestTest.php index 26b01aede9..594578f051 100644 --- a/tests/phpunit/Civi/API/RequestTest.php +++ b/tests/phpunit/Civi/API/RequestTest.php @@ -74,7 +74,7 @@ class RequestTest extends \CiviUnitTestCase { } /** - * @param $inputParams + * @param array $inputParams * @param $expectedOptions * @param $expectedData * @param $expectedChains diff --git a/tests/phpunit/CiviTest/CiviReportTestCase.php b/tests/phpunit/CiviTest/CiviReportTestCase.php index ffe24bca90..726e2d815e 100644 --- a/tests/phpunit/CiviTest/CiviReportTestCase.php +++ b/tests/phpunit/CiviTest/CiviReportTestCase.php @@ -48,7 +48,7 @@ class CiviReportTestCase extends CiviUnitTestCase { /** * @param $reportClass - * @param $inputParams + * @param array $inputParams * * @return string * @throws Exception diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index f05698cdec..a9f3587b25 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -328,7 +328,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * @param $option_group_name + * @param string $option_group_name * * @return array|int */ @@ -997,7 +997,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @param bool $pledges * @param bool $recurring * @param bool $membershipTypes - * @param null $memPriceSetId + * @param int $memPriceSetId * @param bool $friend * @param int $profilePreId * @param int $profilePostId @@ -1331,7 +1331,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * update default strict rule. + * Update default strict rule. * * @param string $contactType * @param array $fields Fields to be set for strict rule @@ -1640,7 +1640,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Request a record from the DB by id. Success if row not found. /** * @param string $daoName - * @param $id + * @param int $id * @param $message */ function assertDBRowNotExist($daoName, $id, $message) { @@ -1675,7 +1675,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { // Compare all values in a single retrieved DB record to an array of expected values /** * @param string $daoName - * @param $searchParams + * @param array $searchParams * @param $expectedValues */ function assertDBCompareValues($daoName, $searchParams, $expectedValues) { @@ -2007,7 +2007,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * @param $name + * @param string $name * @param $sku * @param $amount * @param $price @@ -2196,7 +2196,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * type and select first occurance of autocomplete + * Type and select first occurance of autocomplete */ function select2($fieldName,$label, $multiple = FALSE, $xpath=FALSE) { // In the case of chainSelect, wait for options to load @@ -2228,7 +2228,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * select multiple options + * Select multiple options */ function multiselect2($fieldid, $params) { // In the case of chainSelect, wait for options to load @@ -2264,7 +2264,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { } /** - * function to enable or disable Pop-ups via Display Preferences + * Enable or disable Pop-ups via Display Preferences */ function enableDisablePopups($enabled = TRUE) { $this->openCiviPage('admin/setting/preferences/display', 'reset=1'); diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 3eea6f067f..c043e2dfb6 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -53,7 +53,7 @@ define('API_LATEST_VERSION', 3); class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** - * api version - easier to override than just a define + * Api version - easier to override than just a define */ protected $_apiversion = API_LATEST_VERSION; /** @@ -419,7 +419,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * emulate a logged in user since certain functions use that + * Emulate a logged in user since certain functions use that * value to store a record in the DB (like activity) * CRM-8180 */ @@ -573,7 +573,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by id. Success if row not found. /** * @param string $daoName - * @param $id + * @param int $id * @param null $message */ function assertDBRowNotExist($daoName, $id, $message = NULL) { @@ -585,7 +585,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Request a record from the DB by id. Success if row not found. /** * @param string $daoName - * @param $id + * @param int $id * @param null $message */ function assertDBRowExist($daoName, $id, $message = NULL) { @@ -613,7 +613,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { // Compare all values in a single retrieved DB record to an array of expected values /** * @param string $daoName - * @param $searchParams + * @param array $searchParams * @param $expectedValues */ function assertDBCompareValues($daoName, $searchParams, $expectedValues) { @@ -722,7 +722,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * check that api returned 'is_error' => 0 + * Check that api returned 'is_error' => 0 * else provide full message * @param array $apiResult api result * @param string $prefix extra test to add to message @@ -743,7 +743,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * check that api returned 'is_error' => 1 + * Check that api returned 'is_error' => 1 * else provide full message * * @param array $apiResult api result @@ -771,7 +771,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * check that a deleted item has been deleted + * Check that a deleted item has been deleted */ function assertAPIDeleted($entity, $id) { $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0); @@ -779,7 +779,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** - * check that api returned 'is_error' => 1 + * Check that api returned 'is_error' => 1 * else provide full message * @param array $result * @param $expected @@ -1096,7 +1096,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param $contactID + * @param int $contactID * * @return array|int */ @@ -1118,7 +1118,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param $contactTypeId + * @param int $contactTypeId * * @throws Exception */ @@ -1184,7 +1184,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * delete Membership Type + * Delete Membership Type * * @param array $params */ @@ -1193,7 +1193,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param $membershipID + * @param int $membershipID */ function membershipDelete($membershipID) { $deleteParams = array('id' => $membershipID); @@ -1219,7 +1219,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param $membershipStatusID + * @param int $membershipStatusID */ function membershipStatusDelete($membershipStatusID) { if (!$membershipStatusID) { @@ -1253,7 +1253,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * delete Relatinship Type + * Delete Relatinship Type * * @param int $relationshipTypeID */ @@ -1263,7 +1263,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * @param null $params + * @param array $params * * @return mixed */ @@ -1287,7 +1287,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * create Participant + * Create Participant * * @param array $params array of contact id and event id values * @@ -1316,7 +1316,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create Payment Processor + * Create Payment Processor * * @return object of Payment Processsor */ @@ -1337,7 +1337,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create contribution page + * Create contribution page * * @param array $params * @return object of contribution page @@ -1359,7 +1359,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create Tag + * Create Tag * * @param array $params * @return array result of created tag @@ -1376,7 +1376,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete Tag + * Delete Tag * * @param int $tagId id of the tag to be deleted */ @@ -1402,7 +1402,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create contribution + * Create contribution * * @param int $cID contact_id * @@ -1429,7 +1429,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete contribution + * Delete contribution * * @param int $pledgeId */ @@ -1441,7 +1441,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create contribution + * Create contribution * * @param int $cID contact_id * @param int $cTypeID id of financial type @@ -1478,7 +1478,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create online contribution + * Create online contribution * * @param array $params * @param int $financialType id of financial type @@ -1505,7 +1505,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete contribution + * Delete contribution * * @param int $contributionId * @@ -1520,7 +1520,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create an Event + * Create an Event * * @param array $params name-value pair for an event * @@ -1559,7 +1559,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete event + * Delete event * * @param int $id ID of the event * @@ -1573,7 +1573,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete participant + * Delete participant * * @param int $participantID * @@ -1587,10 +1587,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create participant payment + * Create participant payment * - * @param $participantID - * @param null $contributionID + * @param int $participantID + * @param int $contributionID * @return int $id of created payment */ function participantPaymentCreate($participantID, $contributionID = NULL) { @@ -1605,7 +1605,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete participant payment + * Delete participant payment * * @param int $paymentID */ @@ -1617,9 +1617,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to add a Location + * Add a Location * - * @param $contactID + * @param int $contactID * @return int location id of created location */ function locationAdd($contactID) { @@ -1648,7 +1648,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete Locations of contact + * Delete Locations of contact * * @param array $params parameters */ @@ -1657,9 +1657,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to add a Location Type + * Add a Location Type * - * @param null $params + * @param array $params * @return int location id of created location */ function locationTypeCreate($params = NULL) { @@ -1682,7 +1682,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete a Location Type + * Delete a Location Type * * @param int location type id */ @@ -1693,7 +1693,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to add a Group + * Add a Group * * @param array $params * @return int groupId of created group @@ -1717,7 +1717,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete a Group + * Delete a Group * * @param int $gid */ @@ -1750,9 +1750,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to add a UF Join Entry + * Add a UF Join Entry * - * @param null $params + * @param array $params * @return int $id of created UF Join */ function ufjoinCreate($params = NULL) { @@ -1771,7 +1771,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete a UF Join Entry + * Delete a UF Join Entry * * @param array with missing uf_group_id */ @@ -1791,7 +1791,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create Group for a contact + * Create Group for a contact * * @param int $contactId */ @@ -1805,9 +1805,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete Group for a contact + * Delete Group for a contact * - * @param $contactId + * @param int $contactId */ function contactGroupDelete($contactId) { $params = array( @@ -1818,7 +1818,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create Activity + * Create Activity * * @param array $params * @return array|int @@ -1861,7 +1861,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create an activity type + * Create an activity type * * @param array $params parameters */ @@ -1871,7 +1871,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete activity type + * Delete activity type * * @param int $activityTypeId id of the activity type */ @@ -1882,7 +1882,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create custom group + * Create custom group * * @param array $params * @return array|int @@ -1909,7 +1909,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * existing function doesn't allow params to be over-ridden so need a new one + * Existing function doesn't allow params to be over-ridden so need a new one * this one allows you to only pass in the params you want to change */ function CustomGroupCreateByParams($params = array()) { @@ -1979,7 +1979,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete custom group + * Delete custom group * * @param int $customGroupID * @@ -1991,7 +1991,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create custom field + * Create custom field * * @param array $params (custom_group_id) is required * @return array|int @@ -2017,7 +2017,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete custom field + * Delete custom field * * @param int $customFieldID * @@ -2030,9 +2030,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create note + * Create note * - * @param $cId + * @param int $cId * @return array $note */ function noteCreate($cId) { @@ -2255,7 +2255,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to delete note + * Delete note * * @param array $params * @@ -2266,7 +2266,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * Function to create custom field with Option Values + * Create custom field with Option Values * * @param array $customGroup * @param string $name name of custom field @@ -2407,7 +2407,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) */ /** * @param array $params - * @param $id + * @param int $id * @param $entity * @param int $delete * @param string $errorText @@ -2476,7 +2476,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * Function to get formatted values in the actual and expected result + * Get formatted values in the actual and expected result * @param array $actual actual calculated values * @param array $expected expected values * @@ -2488,7 +2488,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * Function to unset the key 'id' from the array + * Unset the key 'id' from the array * @param array $unformattedArray The array from which the 'id' has to be unset * */ @@ -2613,7 +2613,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * @param $name + * @param string $name */ function financialAccountDelete($name) { $financialAccount = new CRM_Financial_DAO_FinancialAccount(); @@ -2875,7 +2875,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * alter default price set so that the field numbers are not all 1 (hiding errors) + * Alter default price set so that the field numbers are not all 1 (hiding errors) */ function offsetDefaultPriceSet() { $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount')); @@ -2963,7 +2963,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * we don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it + * We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it */ function setupMembershipRecurringPaymentProcessorTransaction() { $this->ids['membership_type'] = $this->membershipTypeCreate(); diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php index c0ded3fa4c..c4f0529b60 100644 --- a/tests/phpunit/CiviTest/Contact.php +++ b/tests/phpunit/CiviTest/Contact.php @@ -22,7 +22,7 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Individual * - * @param null $params + * @param array $params * @return int $contactID id of created Individual */ static function createIndividual($params = NULL) { @@ -44,7 +44,7 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Household * - * @param null $params + * @param array $params * @return mixed $contactID id of created Household */ static function createHousehold($params = NULL) { @@ -65,7 +65,7 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Organisation * - * @param null $params + * @param array $params * @return mixed $contactID id of created Organisation */ static function createOrganisation($params = NULL) { diff --git a/tests/phpunit/CiviTest/ContributionPage.php b/tests/phpunit/CiviTest/ContributionPage.php index 2d68bf23fa..083214d562 100644 --- a/tests/phpunit/CiviTest/ContributionPage.php +++ b/tests/phpunit/CiviTest/ContributionPage.php @@ -8,7 +8,7 @@ class ContributionPage extends PHPUnit_Framework_Testcase { * Helper function to create * a Contribution Page * - * @param null $id + * @param int $id * * @return mixed $contributionPage id of created Contribution Page */ diff --git a/tests/phpunit/CiviTest/Event.php b/tests/phpunit/CiviTest/Event.php index 8483460f20..cdb44ac0c9 100644 --- a/tests/phpunit/CiviTest/Event.php +++ b/tests/phpunit/CiviTest/Event.php @@ -8,7 +8,7 @@ class Event extends PHPUnit_Framework_Testcase { * Helper function to create * an Event * - * @param $contactId + * @param int $contactId * * @return mixed $event id of created Event */ diff --git a/tests/phpunit/CiviTest/Participant.php b/tests/phpunit/CiviTest/Participant.php index 031ce481ee..405271f863 100644 --- a/tests/phpunit/CiviTest/Participant.php +++ b/tests/phpunit/CiviTest/Participant.php @@ -7,8 +7,8 @@ class Participant extends PHPUnit_Framework_Testcase { /** * Helper function to create a Participant * - * @param $contactId - * @param $eventId + * @param int $contactId + * @param int $eventId * * @return mixed $participant id of created Participant */ diff --git a/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php b/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php index 63623a5e03..a1cebd85ef 100644 --- a/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php +++ b/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php @@ -116,8 +116,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { //moves a field from one field to another /** * @param $field_to_move - * @param $from_group_id - * @param $to_group_id + * @param int $from_group_id + * @param int $to_group_id */ function _moveCustomField($field_to_move, $from_group_id, $to_group_id) { //go to the move field page @@ -162,8 +162,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { //Get all custom field values for a given contact and custom group id using the api /** - * @param $contact_id - * @param $group_id + * @param int $contact_id + * @param int $group_id * @param bool $reset_cache * * @return array @@ -251,7 +251,7 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { //Adds a new custom field to a specfied custom field group, using the given //datatype and widget. /** - * @param $group_id + * @param int $group_id * @param string $type * @param string $widget * @param string $prefix @@ -411,8 +411,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { //randomly generates data for a specific custom field /** - * @param $contact_id - * @param $group_id + * @param int $contact_id + * @param int $group_id */ function _fillCustomDataForContact($contact_id, $group_id) { //edit the given contact diff --git a/tests/phpunit/WebTest/Campaign/ActivityTest.php b/tests/phpunit/WebTest/Campaign/ActivityTest.php index 47cc062d5e..661e246d1d 100644 --- a/tests/phpunit/WebTest/Campaign/ActivityTest.php +++ b/tests/phpunit/WebTest/Campaign/ActivityTest.php @@ -113,7 +113,7 @@ class WebTest_Campaign_ActivityTest extends CiviSeleniumTestCase { /** * @param $campaignTitle - * @param $id + * @param int $id */ function activityAddTest($campaignTitle, $id) { // Adding Adding contact with randomized first name for test testContactContextActivityAdd diff --git a/tests/phpunit/WebTest/Campaign/MailingTest.php b/tests/phpunit/WebTest/Campaign/MailingTest.php index 6693fee5a0..f80501425e 100644 --- a/tests/phpunit/WebTest/Campaign/MailingTest.php +++ b/tests/phpunit/WebTest/Campaign/MailingTest.php @@ -101,9 +101,9 @@ class WebTest_Campaign_MailingTest extends CiviSeleniumTestCase { } /** - * @param $groupName + * @param string $groupName * @param $campaignTitle - * @param $id + * @param int $id */ function mailingAddTest($groupName, $campaignTitle, $id) { //---- create mailing contact and add to mailing Group diff --git a/tests/phpunit/WebTest/Campaign/MembershipTest.php b/tests/phpunit/WebTest/Campaign/MembershipTest.php index ce9d06c873..c11e300d18 100644 --- a/tests/phpunit/WebTest/Campaign/MembershipTest.php +++ b/tests/phpunit/WebTest/Campaign/MembershipTest.php @@ -111,7 +111,7 @@ class WebTest_Campaign_MembershipTest extends CiviSeleniumTestCase { /** * @param $campaignTitle - * @param $id + * @param int $id */ function memberAddTest($campaignTitle, $id) { //Add new memebershipType diff --git a/tests/phpunit/WebTest/Campaign/OfflineContributionTest.php b/tests/phpunit/WebTest/Campaign/OfflineContributionTest.php index aa65cc6af7..fa153d99d7 100644 --- a/tests/phpunit/WebTest/Campaign/OfflineContributionTest.php +++ b/tests/phpunit/WebTest/Campaign/OfflineContributionTest.php @@ -119,7 +119,7 @@ class WebTest_Campaign_OfflineContributionTest extends CiviSeleniumTestCase { /** * @param $campaignTitle - * @param $id + * @param int $id * @param bool $past */ function offlineContributionTest($campaignTitle, $id, $past = FALSE) { @@ -230,7 +230,7 @@ class WebTest_Campaign_OfflineContributionTest extends CiviSeleniumTestCase { } /** - * @param $groupName + * @param string $groupName */ function pastCampaignsTest($groupName) { $this->openCiviPage('campaign/add', 'reset=1', '_qf_Campaign_upload-bottom'); diff --git a/tests/phpunit/WebTest/Campaign/OfflineEventRegistrationTest.php b/tests/phpunit/WebTest/Campaign/OfflineEventRegistrationTest.php index f67d426525..cbbc7b7856 100644 --- a/tests/phpunit/WebTest/Campaign/OfflineEventRegistrationTest.php +++ b/tests/phpunit/WebTest/Campaign/OfflineEventRegistrationTest.php @@ -121,7 +121,7 @@ class WebTest_Campaign_OfflineEventRegistrationTest extends CiviSeleniumTestCase /** * @param $campaignTitle - * @param $id + * @param int $id */ function offlineParticipantAddTest($campaignTitle, $id) { // connect campaign with event diff --git a/tests/phpunit/WebTest/Campaign/OnlineContributionTest.php b/tests/phpunit/WebTest/Campaign/OnlineContributionTest.php index 40a6d6b9c8..cfe5bd4e4a 100644 --- a/tests/phpunit/WebTest/Campaign/OnlineContributionTest.php +++ b/tests/phpunit/WebTest/Campaign/OnlineContributionTest.php @@ -117,7 +117,7 @@ class WebTest_Campaign_OnlineContributionTest extends CiviSeleniumTestCase { /** * @param $campaignTitle - * @param $id + * @param int $id */ function onlineContributionAddTest($campaignTitle, $id) { // Use default payment processor diff --git a/tests/phpunit/WebTest/Campaign/OnlineEventRegistrationTest.php b/tests/phpunit/WebTest/Campaign/OnlineEventRegistrationTest.php index 146538eeb8..c66fc6411f 100644 --- a/tests/phpunit/WebTest/Campaign/OnlineEventRegistrationTest.php +++ b/tests/phpunit/WebTest/Campaign/OnlineEventRegistrationTest.php @@ -114,7 +114,7 @@ class WebTest_Campaign_OnlineEventRegistrationTest extends CiviSeleniumTestCase /** * @param $campaignTitle - * @param $id + * @param int $id */ function onlineParticipantAddTest($campaignTitle, $id) { // Use default payment processor @@ -150,7 +150,7 @@ class WebTest_Campaign_OnlineEventRegistrationTest extends CiviSeleniumTestCase } /** - * @param $id + * @param int $id * @param $eventTitle * @param $eventDescription */ @@ -210,7 +210,7 @@ class WebTest_Campaign_OnlineEventRegistrationTest extends CiviSeleniumTestCase /** * @param bool $discount * @param bool $priceSet - * @param $processorId + * @param int $processorId */ function _testAddFees($discount = FALSE, $priceSet = FALSE, $processorId) { // Go to Fees tab diff --git a/tests/phpunit/WebTest/Campaign/PledgeTest.php b/tests/phpunit/WebTest/Campaign/PledgeTest.php index 9ca12c268c..3c51ece25f 100644 --- a/tests/phpunit/WebTest/Campaign/PledgeTest.php +++ b/tests/phpunit/WebTest/Campaign/PledgeTest.php @@ -119,7 +119,7 @@ class WebTest_Campaign_PledgeTest extends CiviSeleniumTestCase { /** * @param $campaignTitle - * @param $id + * @param int $id */ function pledgeAddTest($campaignTitle, $id) { // create unique name diff --git a/tests/phpunit/WebTest/Case/ActivityToCaseTest.php b/tests/phpunit/WebTest/Case/ActivityToCaseTest.php index 54d781012e..fc8e9a3693 100644 --- a/tests/phpunit/WebTest/Case/ActivityToCaseTest.php +++ b/tests/phpunit/WebTest/Case/ActivityToCaseTest.php @@ -187,7 +187,7 @@ class WebTest_Case_ActivityToCaseTest extends CiviSeleniumTestCase { $this->webtestVerifyTabularData($LinkCaseActivityData); } /** - * @param $firstName + * @param string $firstName * @param $caseSubject * @param $customGroupTitle * @param $contactName diff --git a/tests/phpunit/WebTest/Case/AddCaseTest.php b/tests/phpunit/WebTest/Case/AddCaseTest.php index 5d3a681591..4a73b1d08a 100644 --- a/tests/phpunit/WebTest/Case/AddCaseTest.php +++ b/tests/phpunit/WebTest/Case/AddCaseTest.php @@ -176,7 +176,7 @@ class WebTest_Case_AddCaseTest extends CiviSeleniumTestCase { /** * @param $caseRoles - * @param $creatorName + * @param string $creatorName */ function _testVerifyCaseRoles($caseRoles, $creatorName) { $id = $this->urlArg('id'); @@ -222,8 +222,8 @@ class WebTest_Case_AddCaseTest extends CiviSeleniumTestCase { } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $action */ function _testSearchbyDate($firstName, $lastName, $action) { @@ -271,8 +271,8 @@ class WebTest_Case_AddCaseTest extends CiviSeleniumTestCase { } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $caseTypeLabel * * test for assign case to another client diff --git a/tests/phpunit/WebTest/Case/CaseCustomFieldsTest.php b/tests/phpunit/WebTest/Case/CaseCustomFieldsTest.php index 55d88df4b0..ab3da446b2 100644 --- a/tests/phpunit/WebTest/Case/CaseCustomFieldsTest.php +++ b/tests/phpunit/WebTest/Case/CaseCustomFieldsTest.php @@ -246,7 +246,7 @@ class WebTest_Case_CaseCustomFieldsTest extends CiviSeleniumTestCase { /** * @param $customGrpId1 - * @param $customId + * @param int $customId */ function _testDeleteCustomData($customGrpId1, $customId) { // delete all custom data @@ -392,9 +392,9 @@ class WebTest_Case_CaseCustomFieldsTest extends CiviSeleniumTestCase { } /** - * @param $customId - * @param $custFname - * @param $custMname + * @param int $customId + * @param string $custFname + * @param string $custMname * @param $custLname */ function _testAdvansearchCaseData($customId, $custFname, $custMname, $custLname) { diff --git a/tests/phpunit/WebTest/Contact/AdvanceSearchPrivacyOptionsTest.php b/tests/phpunit/WebTest/Contact/AdvanceSearchPrivacyOptionsTest.php index 676e179c0d..dfdb4f330b 100644 --- a/tests/phpunit/WebTest/Contact/AdvanceSearchPrivacyOptionsTest.php +++ b/tests/phpunit/WebTest/Contact/AdvanceSearchPrivacyOptionsTest.php @@ -155,8 +155,8 @@ class WebTest_Contact_AdvanceSearchPrivacyOptionsTest extends CiviSeleniumTestCa } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * * @return bool */ @@ -197,8 +197,8 @@ class WebTest_Contact_AdvanceSearchPrivacyOptionsTest extends CiviSeleniumTestCa } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $options */ function _addIndividual($firstName, $lastName, $options) { diff --git a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php index 8fdee7be3b..083bbe5de6 100644 --- a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php +++ b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php @@ -212,7 +212,7 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { //function to check match for sumbit Advance Search /** - * @param $firstName + * @param string $firstName */ function submitSearch($firstName) { $this->clickLink("_qf_Advanced_refresh"); @@ -247,8 +247,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { // function to fill basic search detail /** - * @param $firstName - * @param $groupName + * @param string $firstName + * @param string $groupName * @param $tagName */ function addBasicSearchDetail($firstName, $groupName, $tagName) { diff --git a/tests/phpunit/WebTest/Contact/AdvancedSearchedRelatedContactTest.php b/tests/phpunit/WebTest/Contact/AdvancedSearchedRelatedContactTest.php index e1c573dfa0..239bfd9151 100644 --- a/tests/phpunit/WebTest/Contact/AdvancedSearchedRelatedContactTest.php +++ b/tests/phpunit/WebTest/Contact/AdvancedSearchedRelatedContactTest.php @@ -197,7 +197,7 @@ class WebTest_Contact_AdvancedSearchedRelatedContactTest extends CiviSeleniumTes /** * @param bool $discount * @param bool $priceSet - * @param $processorId + * @param int $processorId */ function _testAddFees($discount = FALSE, $priceSet = FALSE, $processorId) { // Go to Fees tab @@ -230,8 +230,8 @@ class WebTest_Contact_AdvancedSearchedRelatedContactTest extends CiviSeleniumTes } /** - * @param $ContactName - * @param $relatedName + * @param string $ContactName + * @param string $relatedName * @param $relType */ function _testAddRelationship($ContactName, $relatedName, $relType) { diff --git a/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php b/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php index 8fbdc2360b..8b39129a1d 100644 --- a/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php +++ b/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php @@ -204,7 +204,7 @@ class WebTest_Contact_CreateCmsUserFromContactTest extends CiviSeleniumTestCase } /** - * @param $username + * @param string $username * @param $password * @param $confirm_password */ diff --git a/tests/phpunit/WebTest/Contact/DeceasedContactsAdvancedSearchTest.php b/tests/phpunit/WebTest/Contact/DeceasedContactsAdvancedSearchTest.php index 60381a5364..8bc420a1d1 100644 --- a/tests/phpunit/WebTest/Contact/DeceasedContactsAdvancedSearchTest.php +++ b/tests/phpunit/WebTest/Contact/DeceasedContactsAdvancedSearchTest.php @@ -90,10 +90,10 @@ class WebTest_Contact_DeceasedContactsAdvancedSearchTest extends CiviSeleniumTes } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $email - * @param $groupName + * @param string $groupName * @param bool $deceased */ function _testAddContact($firstName, $lastName, $email, $groupName, $deceased = FALSE) { diff --git a/tests/phpunit/WebTest/Contact/GroupAddTest.php b/tests/phpunit/WebTest/Contact/GroupAddTest.php index dbcadb778e..98ead2ad6e 100644 --- a/tests/phpunit/WebTest/Contact/GroupAddTest.php +++ b/tests/phpunit/WebTest/Contact/GroupAddTest.php @@ -182,7 +182,7 @@ class WebTest_Contact_GroupAddTest extends CiviSeleniumTestCase { } /** - * @param $roleid + * @param int $roleid * * @return string */ diff --git a/tests/phpunit/WebTest/Contact/MergeContactsTest.php b/tests/phpunit/WebTest/Contact/MergeContactsTest.php index 3a56e44ebe..95a3dd7116 100644 --- a/tests/phpunit/WebTest/Contact/MergeContactsTest.php +++ b/tests/phpunit/WebTest/Contact/MergeContactsTest.php @@ -251,8 +251,8 @@ class WebTest_Contact_MergeContactsTest extends CiviSeleniumTestCase { $this->assertTrue($this->isTextPresent("Staff, Student")); } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $subject */ function addActivity($firstName, $lastName, $subject) { diff --git a/tests/phpunit/WebTest/Contact/ProfileChecksumTest.php b/tests/phpunit/WebTest/Contact/ProfileChecksumTest.php index cfe220b39a..2c661451ab 100644 --- a/tests/phpunit/WebTest/Contact/ProfileChecksumTest.php +++ b/tests/phpunit/WebTest/Contact/ProfileChecksumTest.php @@ -144,7 +144,7 @@ class WebTest_Contact_ProfileChecksumTest extends CiviSeleniumTestCase { /** * @param $fields - * @param $profileName + * @param string $profileName * * @return null */ diff --git a/tests/phpunit/WebTest/Contact/SearchBuilderTest.php b/tests/phpunit/WebTest/Contact/SearchBuilderTest.php index cb7041f7c2..3d67c5e334 100644 --- a/tests/phpunit/WebTest/Contact/SearchBuilderTest.php +++ b/tests/phpunit/WebTest/Contact/SearchBuilderTest.php @@ -332,7 +332,7 @@ class WebTest_Contact_SearchBuilderTest extends CiviSeleniumTestCase { /** * @param $contactType - * @param $name + * @param string $name * @param $email * @param null $streetName * @param null $postalCode diff --git a/tests/phpunit/WebTest/Contribute/AddPricesetTest.php b/tests/phpunit/WebTest/Contribute/AddPricesetTest.php index 8721b711d7..bf9d07a1e8 100644 --- a/tests/phpunit/WebTest/Contribute/AddPricesetTest.php +++ b/tests/phpunit/WebTest/Contribute/AddPricesetTest.php @@ -198,7 +198,7 @@ class WebTest_Contribute_AddPricesetTest extends CiviSeleniumTestCase { /** * @param $validateStrings - * @param $sid + * @param int $sid */ function _testVerifyPriceSet($validateStrings, $sid) { // verify Price Set at Preview page diff --git a/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php b/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php index 90ee451689..b68700a89b 100644 --- a/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php +++ b/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php @@ -140,7 +140,7 @@ class WebTest_Contribute_ContributionPageAddTest extends CiviSeleniumTestCase { } /** - * check CRM-7943 + * Check CRM-7943 */ function testContributionPageSeparatePayment() { // open browser, login @@ -185,7 +185,7 @@ class WebTest_Contribute_ContributionPageAddTest extends CiviSeleniumTestCase { } /** - * check CRM-7949 + * Check CRM-7949 */ function testContributionPageSeparatePaymentPayLater() { // open browser, login diff --git a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php index 10c7e46240..1dd916fad6 100644 --- a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php @@ -313,8 +313,8 @@ class WebTest_Contribute_OfflineContributionTest extends CiviSeleniumTestCase { //common function for doing offline contribution /** * @param array $params - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $processorName */ function _doOfflineContribution($params, $firstName, $lastName, $processorName) { diff --git a/tests/phpunit/WebTest/Contribute/OnBehalfOfOrganization.php b/tests/phpunit/WebTest/Contribute/OnBehalfOfOrganization.php index f0da52f82f..d767b933e5 100644 --- a/tests/phpunit/WebTest/Contribute/OnBehalfOfOrganization.php +++ b/tests/phpunit/WebTest/Contribute/OnBehalfOfOrganization.php @@ -647,8 +647,8 @@ class WebTest_Contribute_OnBehalfOfOrganization extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $cid + * @param int $pageId + * @param int $cid * @param $pageTitle */ function _testOrganization($pageId, $cid, $pageTitle) { @@ -678,8 +678,8 @@ class WebTest_Contribute_OnBehalfOfOrganization extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $cid + * @param int $pageId + * @param int $cid * @param $pageTitle */ function _testAnomoyousOganization($pageId, $cid, $pageTitle) { @@ -753,8 +753,8 @@ class WebTest_Contribute_OnBehalfOfOrganization extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $cid + * @param int $pageId + * @param int $cid * @param $pageTitle */ function _testUserWithOneRelationship($pageId, $cid, $pageTitle) { @@ -999,8 +999,8 @@ class WebTest_Contribute_OnBehalfOfOrganization extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $cid + * @param int $pageId + * @param int $cid * @param $pageTitle */ function _testUserWithMoreThanOneRelationship($pageId, $cid, $pageTitle) { @@ -1475,8 +1475,8 @@ class WebTest_Contribute_OnBehalfOfOrganization extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $cid + * @param int $pageId + * @param int $cid * @param $pageTitle */ function _testOrganizationWithImageUpload($pageId, $cid, $pageTitle) { diff --git a/tests/phpunit/WebTest/Contribute/OnlineContributionTest.php b/tests/phpunit/WebTest/Contribute/OnlineContributionTest.php index b70cef7e6f..08fa752a98 100644 --- a/tests/phpunit/WebTest/Contribute/OnlineContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/OnlineContributionTest.php @@ -252,7 +252,7 @@ class WebTest_Contribute_OnlineContributionTest extends CiviSeleniumTestCase { } /** - * @param $pageId + * @param int $pageId * @param bool $priceSet */ function _doContributionAndVerifyData($pageId, $priceSet = FALSE) { diff --git a/tests/phpunit/WebTest/Contribute/UpdateBatchPendingContributionTest.php b/tests/phpunit/WebTest/Contribute/UpdateBatchPendingContributionTest.php index 724e26916a..a8013836c3 100644 --- a/tests/phpunit/WebTest/Contribute/UpdateBatchPendingContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/UpdateBatchPendingContributionTest.php @@ -131,7 +131,7 @@ class WebTest_Contribute_UpdateBatchPendingContributionTest extends CiviSelenium } /** - * @param $firstName + * @param string $firstName */ function _addParticipant($firstName) { diff --git a/tests/phpunit/WebTest/Contribute/UpdateContributionTest.php b/tests/phpunit/WebTest/Contribute/UpdateContributionTest.php index d45df49d24..3cff1f0c9d 100755 --- a/tests/phpunit/WebTest/Contribute/UpdateContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/UpdateContributionTest.php @@ -366,7 +366,7 @@ class WebTest_Contribute_UpdateContributionTest extends CiviSeleniumTestCase { } /** - * @param $entityId + * @param int $entityId * @param null $from * @param null $to * @param null $cost @@ -400,7 +400,7 @@ class WebTest_Contribute_UpdateContributionTest extends CiviSeleniumTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */function _getFinancialTrxnAmount($contId) { @@ -415,7 +415,7 @@ class WebTest_Contribute_UpdateContributionTest extends CiviSeleniumTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */function _getFinancialItemAmount($contId) { @@ -430,7 +430,7 @@ class WebTest_Contribute_UpdateContributionTest extends CiviSeleniumTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */function _getTotalContributedAmount($contId) { diff --git a/tests/phpunit/WebTest/Contribute/VerifySSLContributionTest.php b/tests/phpunit/WebTest/Contribute/VerifySSLContributionTest.php index 3f3f45a54d..b409005bfc 100644 --- a/tests/phpunit/WebTest/Contribute/VerifySSLContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/VerifySSLContributionTest.php @@ -104,7 +104,7 @@ class WebTest_Contribute_VerifySSLContributionTest extends CiviSeleniumTestCase } /** - * @param $name + * @param string $name */ function _tryPaymentProcessor($name) { // load contribution page diff --git a/tests/phpunit/WebTest/Event/AddEventTest.php b/tests/phpunit/WebTest/Event/AddEventTest.php index e02f35e78e..51142ecebe 100644 --- a/tests/phpunit/WebTest/Event/AddEventTest.php +++ b/tests/phpunit/WebTest/Event/AddEventTest.php @@ -203,7 +203,7 @@ class WebTest_Event_AddEventTest extends CiviSeleniumTestCase { } /** - * @param $id + * @param int $id * @param $eventTitle * @param $discount */ @@ -366,8 +366,8 @@ class WebTest_Event_AddEventTest extends CiviSeleniumTestCase { /** * @param $eventTitle * @param $eventDescription - * @param $templateID - * @param $eventTypeID + * @param int $templateID + * @param int $eventTypeID */ function _testAddEventInfoFromTemplate($eventTitle, $eventDescription, $templateID, $eventTypeID) { $this->waitForElementPresent("_qf_EventInfo_upload-bottom"); @@ -852,7 +852,7 @@ class WebTest_Event_AddEventTest extends CiviSeleniumTestCase { } /** - * @param $contributionID + * @param int $contributionID */ function verifyFinancialRecords($contributionID) { // check count for civicrm_contribution and civicrm_financial_item in civicrm_entity_financial_trxn diff --git a/tests/phpunit/WebTest/Event/AddParticipationTest.php b/tests/phpunit/WebTest/Event/AddParticipationTest.php index 6e375e6fd5..828628063f 100644 --- a/tests/phpunit/WebTest/Event/AddParticipationTest.php +++ b/tests/phpunit/WebTest/Event/AddParticipationTest.php @@ -402,9 +402,9 @@ class WebTest_Event_AddParticipationTest extends CiviSeleniumTestCase { } /** - * @param $firstName - * @param $lastName - * @param $processorId + * @param string $firstName + * @param string $lastName + * @param int $processorId */ function _fillParticipantDetails($processorId) { $contact = $this->createDialogContact(); diff --git a/tests/phpunit/WebTest/Event/AddPricesetTest.php b/tests/phpunit/WebTest/Event/AddPricesetTest.php index e7bdbe2ae1..8a4afc860b 100644 --- a/tests/phpunit/WebTest/Event/AddPricesetTest.php +++ b/tests/phpunit/WebTest/Event/AddPricesetTest.php @@ -182,7 +182,7 @@ class WebTest_Event_AddPricesetTest extends CiviSeleniumTestCase { /** * @param $validateStrings - * @param $sid + * @param int $sid */ function _testVerifyPriceSet($validateStrings, $sid) { // verify Price Set at Preview page @@ -498,7 +498,7 @@ class WebTest_Event_AddPricesetTest extends CiviSeleniumTestCase { } /** - * test to regiter participant for event with + * Test to regiter participant for event with * multiple price fields in price-set * CRM-11986 @@ -746,7 +746,7 @@ class WebTest_Event_AddPricesetTest extends CiviSeleniumTestCase { } /** - * @param $expectedLineItems + * @param array $expectedLineItems */ function _checkLineItems($expectedLineItems) { foreach ($expectedLineItems as $lineKey => $lineValue) { diff --git a/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php b/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php index 8467774ecc..84f15d288d 100644 --- a/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php +++ b/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php @@ -209,7 +209,7 @@ class WebTest_Event_AdditionalPaymentTest extends CiviSeleniumTestCase { /** * @param $feeAmt - * @param $amtPaid + * @param int $amtPaid */ function _checkPaymentInfoTable($feeAmt, $amtPaid) { $this->assertElementContainsText("xpath=//td[@id='payment-info']/table[@id='info']/tbody/tr[2]/td", "$ {$feeAmt}", 'Missing text: appropriate fee amount'); diff --git a/tests/phpunit/WebTest/Event/ChangeParticipantStatus.php b/tests/phpunit/WebTest/Event/ChangeParticipantStatus.php index 86322ef4bc..7e0c5b8922 100644 --- a/tests/phpunit/WebTest/Event/ChangeParticipantStatus.php +++ b/tests/phpunit/WebTest/Event/ChangeParticipantStatus.php @@ -96,7 +96,7 @@ class WebTest_Event_ChangeParticipantStatus extends CiviSeleniumTestCase { } /** - * @param $firstName + * @param string $firstName */ function addParticipant($firstName) { $this->openCiviPage("participant/add", "reset=1&action=add&context=standalone", '_qf_Participant_upload-bottom'); diff --git a/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php b/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php index 94380c810f..962f18e38c 100755 --- a/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php +++ b/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php @@ -452,8 +452,8 @@ class WebTest_Event_MultipleEventRegistrationbyCartTest extends CiviSeleniumTest } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $events */ function _checkContributionsandEventRegistration($firstName, $lastName, $events) { diff --git a/tests/phpunit/WebTest/Event/MultiprofileEventTest.php b/tests/phpunit/WebTest/Event/MultiprofileEventTest.php index 75c892821a..ff4739dc75 100644 --- a/tests/phpunit/WebTest/Event/MultiprofileEventTest.php +++ b/tests/phpunit/WebTest/Event/MultiprofileEventTest.php @@ -316,7 +316,7 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $eventPageId + * @param int $eventPageId */ function _testRemoveProfile($eventPageId) { $this->openCiviPage("event/manage/settings", "reset=1&action=update&id=$eventPageId"); @@ -333,7 +333,7 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $customId + * @param int $customId * * @return array */ @@ -555,7 +555,7 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $profileId + * @param int $profileId * * @return null */ @@ -627,12 +627,12 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $eventPageId - * @param $customId - * @param $firstName - * @param $lastName - * @param $participantfname - * @param $participantlname + * @param int $eventPageId + * @param int $customId + * @param string $firstName + * @param string $lastName + * @param string $participantfname + * @param string $participantlname * @param $email1 * @param $email2 */ @@ -720,11 +720,11 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $eventPageId - * @param $customId - * @param $firstName2 - * @param $lastName2 - * @param $participantfname2 + * @param int $eventPageId + * @param int $customId + * @param string $firstName2 + * @param string $lastName2 + * @param string $participantfname2 * @param $participantlname2 * @param $email3 * @param $email4 @@ -817,7 +817,7 @@ class WebTest_Event_MultiprofileEventTest extends CiviSeleniumTestCase { } /** - * @param $cfId + * @param int $cfId */ function _removeEmailField($cfId) { $this->openCiviPage("admin/uf/group/field", "action=delete&id={$cfId}"); diff --git a/tests/phpunit/WebTest/Event/PCPAddTest.php b/tests/phpunit/WebTest/Event/PCPAddTest.php index 5a72d15213..41c7af9589 100644 --- a/tests/phpunit/WebTest/Event/PCPAddTest.php +++ b/tests/phpunit/WebTest/Event/PCPAddTest.php @@ -116,12 +116,12 @@ class WebTest_Event_PCPAddTest extends CiviSeleniumTestCase { } /** - * @param $processorName + * @param string $processorName * @param $campaignType - * @param null $contributionPageId - * @param $firstName - * @param $lastName - * @param $middleName + * @param int $contributionPageId + * @param string $firstName + * @param string $lastName + * @param string $middleName * @param $email */ function _testAddEventForPCP($processorName, $campaignType, $contributionPageId = NULL, $firstName, $lastName, $middleName, $email) { @@ -265,10 +265,10 @@ class WebTest_Event_PCPAddTest extends CiviSeleniumTestCase { /** * @param $eventTitle - * @param $pageId - * @param $firstName - * @param $lastName - * @param $middleName + * @param int $pageId + * @param string $firstName + * @param string $lastName + * @param string $middleName * @param $email * @param int $numberRegistrations * @param $campaignType @@ -435,7 +435,7 @@ class WebTest_Event_PCPAddTest extends CiviSeleniumTestCase { /** * @param $campaignType - * @param $contributionPageId + * @param int $contributionPageId * * @return null */ @@ -477,11 +477,11 @@ class WebTest_Event_PCPAddTest extends CiviSeleniumTestCase { } /** - * @param $eventName - * @param $lastNameDonar - * @param $firstNameDonar - * @param $firstNameCreator - * @param $lastNameCreator + * @param string $eventName + * @param string $lastNameDonar + * @param string $firstNameDonar + * @param string $firstNameCreator + * @param string $lastNameCreator * @param $amount */ function _testParticipantSearchEventName($eventName, $lastNameDonar, $firstNameDonar, $firstNameCreator, $lastNameCreator, $amount) { @@ -507,7 +507,7 @@ class WebTest_Event_PCPAddTest extends CiviSeleniumTestCase { } /** - * @param $firstName + * @param string $firstName * @param $lastName * @param $pcpCreatorFirstName * @param $pcpCreatorLastName diff --git a/tests/phpunit/WebTest/Event/ParticipantCountTest.php b/tests/phpunit/WebTest/Event/ParticipantCountTest.php index 93bd04debe..ef4d06dd3f 100644 --- a/tests/phpunit/WebTest/Event/ParticipantCountTest.php +++ b/tests/phpunit/WebTest/Event/ParticipantCountTest.php @@ -437,7 +437,7 @@ class WebTest_Event_ParticipantCountTest extends CiviSeleniumTestCase { } /** - * @param $eventParams + * @param array $eventParams * @param $participants * @param $priceFieldOptionCounts */ diff --git a/tests/phpunit/WebTest/Export/ContactTest.php b/tests/phpunit/WebTest/Export/ContactTest.php index a385ee5cc8..1b81ab9ba4 100644 --- a/tests/phpunit/WebTest/Export/ContactTest.php +++ b/tests/phpunit/WebTest/Export/ContactTest.php @@ -457,7 +457,7 @@ class WebTest_Export_ContactTest extends ExportCiviSeleniumTestCase { } /** - * @param $optionGroupName + * @param string $optionGroupName * @param $optionValue * * @return array|int diff --git a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php index 4f54b5da1d..52bbf48ac9 100644 --- a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php @@ -32,7 +32,7 @@ require_once 'CiviTest/CiviSeleniumTestCase.php'; class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { /** - * download CSV file. + * Download CSV file. * * @param string $selector element selector(download button in most of the cases). * @param string $fileName file name to be download. @@ -63,7 +63,7 @@ class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { } /** - * read CSV file and fire provided assertions. + * Read CSV file and fire provided assertions. * * @param string $file file path of CSV file. * @param array $checkColumns check first row of csv diff --git a/tests/phpunit/WebTest/Financial/FinancialBatchExport.php b/tests/phpunit/WebTest/Financial/FinancialBatchExport.php index 071991ef7f..1bc0f04ac8 100644 --- a/tests/phpunit/WebTest/Financial/FinancialBatchExport.php +++ b/tests/phpunit/WebTest/Financial/FinancialBatchExport.php @@ -113,7 +113,7 @@ class WebTest_Financial_FinancialBatchExport extends CiviSeleniumTestCase { /** * @param $setTitle - * @param $batchId + * @param int $batchId * @param $exportFormat */ function _testExportBatch($setTitle, $batchId, $exportFormat) { diff --git a/tests/phpunit/WebTest/Generic/CheckDashboardTest.php b/tests/phpunit/WebTest/Generic/CheckDashboardTest.php index 912ca2ab5d..c1badd9d70 100644 --- a/tests/phpunit/WebTest/Generic/CheckDashboardTest.php +++ b/tests/phpunit/WebTest/Generic/CheckDashboardTest.php @@ -51,7 +51,7 @@ class WebTest_Generic_CheckDashboardTest extends CiviSeleniumTestCase { } /** - * @param $widgetConfigureID + * @param int $widgetConfigureID * @param $widgetEnabledSelector * @param $widgetTitle */ @@ -98,7 +98,7 @@ class WebTest_Generic_CheckDashboardTest extends CiviSeleniumTestCase { } /** - * @param $widgetConfigureID + * @param int $widgetConfigureID * @param $widgetEnabledSelector */ function _testRemoveDashboardElement($widgetConfigureID, $widgetEnabledSelector) { diff --git a/tests/phpunit/WebTest/Import/AddressImportTest.php b/tests/phpunit/WebTest/Import/AddressImportTest.php index 8ec32e417a..acc1e9a598 100644 --- a/tests/phpunit/WebTest/Import/AddressImportTest.php +++ b/tests/phpunit/WebTest/Import/AddressImportTest.php @@ -68,8 +68,8 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { /** * Helper function to provide data for custom data import. * - * @param $customDataParams - * @param $firstName1 + * @param array $customDataParams + * @param string $firstName1 * * @return array */ @@ -288,7 +288,7 @@ class WebTest_Import_AddressImportTest extends ImportCiviSeleniumTestCase { } /** - * @param $customFieldName + * @param string $customFieldName * @param $type * * @return array diff --git a/tests/phpunit/WebTest/Import/AddressParsingTest.php b/tests/phpunit/WebTest/Import/AddressParsingTest.php index 98a8e4565e..674ce3dba3 100644 --- a/tests/phpunit/WebTest/Import/AddressParsingTest.php +++ b/tests/phpunit/WebTest/Import/AddressParsingTest.php @@ -36,7 +36,7 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { } /** - * check for Valid Street Address + * Check for Valid Street Address */ function testValidStreetAddressParsing() { $this->webtestLogin(); @@ -91,7 +91,7 @@ class WebTest_Import_AddressParsingTest extends ImportCiviSeleniumTestCase { } /** - * check for Invalid Street Address + * Check for Invalid Street Address */ function testInvalidStreetAddressParsing() { $this->webtestLogin(); diff --git a/tests/phpunit/WebTest/Import/ContactCustomDataTest.php b/tests/phpunit/WebTest/Import/ContactCustomDataTest.php index 520f049f13..4e0e0ecc74 100644 --- a/tests/phpunit/WebTest/Import/ContactCustomDataTest.php +++ b/tests/phpunit/WebTest/Import/ContactCustomDataTest.php @@ -108,8 +108,8 @@ class WebTest_Import_ContactCustomDataTest extends ImportCiviSeleniumTestCase { /** * Helper function to provide data for custom data import. * - * @param $customDataParams - * @param $firstName1 + * @param array $customDataParams + * @param string $firstName1 * * @return array */ diff --git a/tests/phpunit/WebTest/Import/CustomDataTest.php b/tests/phpunit/WebTest/Import/CustomDataTest.php index 68ddefc624..a4968d6c6c 100644 --- a/tests/phpunit/WebTest/Import/CustomDataTest.php +++ b/tests/phpunit/WebTest/Import/CustomDataTest.php @@ -106,8 +106,8 @@ class WebTest_Import_CustomDataTest extends ImportCiviSeleniumTestCase { * Helper function to provide data for custom data import. * * @param $customGroupTitle - * @param $firstName1 - * @param $firstName2 + * @param string $firstName1 + * @param string $firstName2 * @param $id1 * @param $id2 * diff --git a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php index bec67830bb..477996eb2f 100644 --- a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php @@ -33,7 +33,7 @@ require_once 'CRM/Utils/Array.php'; class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { /** - * test csv import for each component. + * Test csv import for each component. * * @param string $component component name ( Event, Contribution, Membership, Activity etc) * @param array $headers csv data headers @@ -159,7 +159,7 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { } /** - * test contact import. + * Test contact import. * * @param array $headers csv data headers * @param array $rows csv data rows diff --git a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php index 38216dfe72..9c665e825d 100644 --- a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php +++ b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php @@ -235,9 +235,9 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { /** * Helper function to add new contact * - * @param $firstName - * @param $lastName - * @param $externalId + * @param string $firstName + * @param string $lastName + * @param int $externalId * * @return int external id */ diff --git a/tests/phpunit/WebTest/Import/SavedMappingTest.php b/tests/phpunit/WebTest/Import/SavedMappingTest.php index 9a8ee93435..6cf5fd5061 100644 --- a/tests/phpunit/WebTest/Import/SavedMappingTest.php +++ b/tests/phpunit/WebTest/Import/SavedMappingTest.php @@ -36,7 +36,7 @@ class WebTest_Import_SavedMappingTest extends ImportCiviSeleniumTestCase { } /** - * test Saved Import Mapping for Individuals. + * Test Saved Import Mapping for Individuals. */ function testSaveIndividualMapping() { diff --git a/tests/phpunit/WebTest/Member/BatchUpdateViaProfileTest.php b/tests/phpunit/WebTest/Member/BatchUpdateViaProfileTest.php index 1f17817873..c6faebe9d2 100644 --- a/tests/phpunit/WebTest/Member/BatchUpdateViaProfileTest.php +++ b/tests/phpunit/WebTest/Member/BatchUpdateViaProfileTest.php @@ -150,7 +150,7 @@ class WebTest_Member_BatchUpdateViaProfileTest extends CiviSeleniumTestCase { } /** - * @param $memTypeParams + * @param array $memTypeParams */ function _addMembership($memTypeParams) { // click through to the membership view screen @@ -187,7 +187,7 @@ class WebTest_Member_BatchUpdateViaProfileTest extends CiviSeleniumTestCase { /** * @param $profileTitle - * @param $customDataParams + * @param array $customDataParams */ function _addProfile($profileTitle, $customDataParams) { diff --git a/tests/phpunit/WebTest/Member/DefaultMembershipPricesetTest.php b/tests/phpunit/WebTest/Member/DefaultMembershipPricesetTest.php index d33aa0fd72..ddb37fc5b4 100755 --- a/tests/phpunit/WebTest/Member/DefaultMembershipPricesetTest.php +++ b/tests/phpunit/WebTest/Member/DefaultMembershipPricesetTest.php @@ -124,10 +124,10 @@ class WebTest_Member_DefaultMembershipPricesetTest extends CiviSeleniumTestCase } /** - * @param $firstName - * @param $lastName + * @param string $firstName + * @param string $lastName * @param $email - * @param $contactParams + * @param array $contactParams * @param $streetAddress */ function contactInfoFill($firstName, $lastName, $email, $contactParams, $streetAddress) { @@ -199,7 +199,7 @@ class WebTest_Member_DefaultMembershipPricesetTest extends CiviSeleniumTestCase * @param $validateString * @param bool $dateSpecificFields * @param $title - * @param $sid + * @param int $sid * @param bool $defaultPriceSet * @param $contributionType * diff --git a/tests/phpunit/WebTest/Member/OfflineMembershipAddPricesetTest.php b/tests/phpunit/WebTest/Member/OfflineMembershipAddPricesetTest.php index a760210d18..9deeb3a41e 100644 --- a/tests/phpunit/WebTest/Member/OfflineMembershipAddPricesetTest.php +++ b/tests/phpunit/WebTest/Member/OfflineMembershipAddPricesetTest.php @@ -201,7 +201,7 @@ class WebTest_Member_OfflineMembershipAddPricesetTest extends CiviSeleniumTestCa * @param $validateString * @param bool $dateSpecificFields * @param $title - * @param $sid + * @param int $sid * @param $contributionType * * @return array @@ -270,7 +270,7 @@ class WebTest_Member_OfflineMembershipAddPricesetTest extends CiviSeleniumTestCa /** * @param $validateStrings - * @param $sid + * @param int $sid */ function _testVerifyPriceSet($validateStrings, $sid) { // verify Price Set at Preview page @@ -288,8 +288,8 @@ class WebTest_Member_OfflineMembershipAddPricesetTest extends CiviSeleniumTestCa } /** - * @param $sid - * @param $contactParams + * @param int $sid + * @param array $contactParams * @param $memTypeTitle1 * @param $memTypeTitle2 * @param bool $renew @@ -376,8 +376,8 @@ class WebTest_Member_OfflineMembershipAddPricesetTest extends CiviSeleniumTestCa } /** - * @param $sid - * @param $contactParams + * @param int $sid + * @param array $contactParams * @param $memTypeTitle1 * @param $term */ diff --git a/tests/phpunit/WebTest/Member/OnlineMembershipAddPricesetTest.php b/tests/phpunit/WebTest/Member/OnlineMembershipAddPricesetTest.php index 039ca97b1c..49d6369cf4 100644 --- a/tests/phpunit/WebTest/Member/OnlineMembershipAddPricesetTest.php +++ b/tests/phpunit/WebTest/Member/OnlineMembershipAddPricesetTest.php @@ -217,7 +217,7 @@ class WebTest_Member_OnlineMembershipAddPricesetTest extends CiviSeleniumTestCas * @param $validateString * @param bool $dateSpecificFields * @param $title - * @param $sid + * @param int $sid * @param $contributionType * * @return array @@ -284,7 +284,7 @@ class WebTest_Member_OnlineMembershipAddPricesetTest extends CiviSeleniumTestCas /** * @param $validateStrings - * @param $sid + * @param int $sid */ function _testVerifyPriceSet($validateStrings, $sid) { // verify Price Set at Preview page @@ -299,8 +299,8 @@ class WebTest_Member_OnlineMembershipAddPricesetTest extends CiviSeleniumTestCas } /** - * @param $pageId - * @param $contactParams + * @param int $pageId + * @param array $contactParams * @param $memTypeTitle1 * @param $memTypeTitle2 * @param bool $renew @@ -409,8 +409,8 @@ class WebTest_Member_OnlineMembershipAddPricesetTest extends CiviSeleniumTestCas } /** - * @param $pageId - * @param $contactParams + * @param int $pageId + * @param array $contactParams * @param $memTypeTitle1 * @param $term * @param bool $renew diff --git a/tests/phpunit/WebTest/Member/OnlineMembershipCreateTest.php b/tests/phpunit/WebTest/Member/OnlineMembershipCreateTest.php index 82cf0e0274..285a648a42 100644 --- a/tests/phpunit/WebTest/Member/OnlineMembershipCreateTest.php +++ b/tests/phpunit/WebTest/Member/OnlineMembershipCreateTest.php @@ -182,10 +182,10 @@ class WebTest_Member_OnlineMembershipCreateTest extends CiviSeleniumTestCase { } /** - * @param $pageId - * @param $memTypeId - * @param $firstName - * @param $lastName + * @param int $pageId + * @param int $memTypeId + * @param string $firstName + * @param string $lastName * @param $payLater * @param $hash * @param bool $otherAmount diff --git a/tests/phpunit/WebTest/Member/SeperateMembershipPaymentTest.php b/tests/phpunit/WebTest/Member/SeperateMembershipPaymentTest.php index 34011e6d4c..16bc2cce4f 100644 --- a/tests/phpunit/WebTest/Member/SeperateMembershipPaymentTest.php +++ b/tests/phpunit/WebTest/Member/SeperateMembershipPaymentTest.php @@ -144,9 +144,9 @@ class WebTest_Member_SeperateMembershipPaymentTest extends CiviSeleniumTestCase } /** - * @param $pageId - * @param $memTypeId - * @param null $cid + * @param int $pageId + * @param int $memTypeId + * @param int $cid */ function _testOnlineMembershipSignup($pageId, $memTypeId, $cid = NULL) { //Open Live Contribution Page diff --git a/tests/phpunit/WebTest/Profile/MultiRecordProfileAddTest.php b/tests/phpunit/WebTest/Profile/MultiRecordProfileAddTest.php index 95e1585e81..4762d3e31c 100644 --- a/tests/phpunit/WebTest/Profile/MultiRecordProfileAddTest.php +++ b/tests/phpunit/WebTest/Profile/MultiRecordProfileAddTest.php @@ -281,7 +281,7 @@ class WebTest_Profile_MultiRecordProfileAddTest extends CiviSeleniumTestCase { } /** - * @param $gid + * @param int $gid * @param $profileTitle */ function _deleteProfile($gid, $profileTitle) { diff --git a/tests/phpunit/WebTest/Report/RolePermissionReportTest.php b/tests/phpunit/WebTest/Report/RolePermissionReportTest.php index 01f5b96ce9..7156faef3a 100644 --- a/tests/phpunit/WebTest/Report/RolePermissionReportTest.php +++ b/tests/phpunit/WebTest/Report/RolePermissionReportTest.php @@ -218,7 +218,7 @@ class WebTest_Report_RolePermissionReportTest extends CiviSeleniumTestCase { } /** - * @param $roleid + * @param int $roleid * * @return string */ diff --git a/tests/phpunit/api/v3/ACLPermissionTest.php b/tests/phpunit/api/v3/ACLPermissionTest.php index 2f0c47204e..dbf0e3dfb0 100644 --- a/tests/phpunit/api/v3/ACLPermissionTest.php +++ b/tests/phpunit/api/v3/ACLPermissionTest.php @@ -119,7 +119,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase { } /** - * test permissions limited by hook + * Test permissions limited by hook */ function testContactGetHookLimitingHook() { $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond')); @@ -132,7 +132,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase { } /** - * confirm that without check permissions we still get 2 contacts returned + * Confirm that without check permissions we still get 2 contacts returned */ function testContactGetHookLimitingHookDontCheck() { // @@ -330,13 +330,13 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase { } /** - * no results returned + * No results returned */ function aclWhereHookNoResults($type, &$tables, &$whereTables, &$contactID, &$where) { } /** - * all results returned + * All results returned * @implements CRM_Utils_Hook::aclWhereClause */ function aclWhereHookAllResults($type, &$tables, &$whereTables, &$contactID, &$where) { @@ -344,7 +344,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase { } /** - * full results returned + * Full results returned * @implements CRM_Utils_Hook::aclWhereClause */ function aclWhereOnlySecond($type, &$tables, &$whereTables, &$contactID, &$where) { diff --git a/tests/phpunit/api/v3/APIStandardsTest.php b/tests/phpunit/api/v3/APIStandardsTest.php index c41d265278..ce39f7732d 100644 --- a/tests/phpunit/api/v3/APIStandardsTest.php +++ b/tests/phpunit/api/v3/APIStandardsTest.php @@ -94,7 +94,7 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { } /** - * test checks that all v3 API return a standardised error message when + * Test checks that all v3 API return a standardised error message when * the $params passed in is not an array. */ function testParamsNotArray() { diff --git a/tests/phpunit/api/v3/APITest.php b/tests/phpunit/api/v3/APITest.php index 03e9328515..32fb1bc43b 100644 --- a/tests/phpunit/api/v3/APITest.php +++ b/tests/phpunit/api/v3/APITest.php @@ -166,7 +166,7 @@ class api_v3_APITest extends CiviUnitTestCase { } /** - * test exception is thrown + * Test exception is thrown */ function testv3WrapperException(){ try{ diff --git a/tests/phpunit/api/v3/ActionScheduleTest.php b/tests/phpunit/api/v3/ActionScheduleTest.php index 8dbdcc73de..b3dc5e2e47 100644 --- a/tests/phpunit/api/v3/ActionScheduleTest.php +++ b/tests/phpunit/api/v3/ActionScheduleTest.php @@ -94,7 +94,7 @@ class api_v3_ActionScheduleTest extends CiviUnitTestCase { } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testActionScheduleCreateWithoutRequired() { $params = array( diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index 5bdc9ecc7e..92e277b9b8 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -111,14 +111,14 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testActivityCreateEmpty() { $result = $this->callAPIFailure('activity', 'create', array()); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testActivityCreateWithoutRequired() { $params = array( @@ -205,7 +205,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testActivityCreateWithUnknownActivityTypeId() { $params = array( @@ -727,7 +727,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity deletion with empty params + * Check activity deletion with empty params */ function testDeleteActivityForEmptyParams() { $params = array('version' => $this->_apiversion); @@ -735,7 +735,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity deletion without activity id + * Check activity deletion without activity id */ function testDeleteActivityWithoutId() { $params = array( @@ -746,7 +746,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity deletion without activity type + * Check activity deletion without activity type */ function testDeleteActivityWithoutActivityType() { $params = array('id' => 1); @@ -754,7 +754,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity deletion with incorrect data + * Check activity deletion with incorrect data */ function testDeleteActivityWithIncorrectActivityType() { $params = array( @@ -766,7 +766,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity deletion with correct data + * Check activity deletion with correct data */ function testDeleteActivity() { $result = $this->callAPISuccess('activity', 'create', $this->_params); @@ -780,7 +780,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testActivityUpdateWithoutRequired() { $params = array( @@ -806,7 +806,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testActivityUpdateWithIncorrectContactActivityType() { $params = array( @@ -1028,7 +1028,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } /** - * check activity update with status + * Check activity update with status */ function testActivityUpdateWithStatus() { $activity = $this->callAPISuccess('activity', 'create', $this->_params); diff --git a/tests/phpunit/api/v3/AddressTest.php b/tests/phpunit/api/v3/AddressTest.php index 4f6079f9cf..383f8b9bad 100644 --- a/tests/phpunit/api/v3/AddressTest.php +++ b/tests/phpunit/api/v3/AddressTest.php @@ -97,7 +97,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; @@ -115,7 +115,7 @@ class api_v3_AddressTest extends CiviUnitTestCase { } /** - * is_primary shoule be set as a default. ie. create the address, unset the params & recreate. + * Is_primary shoule be set as a default. ie. create the address, unset the params & recreate. * is_primary should be 0 before & after the update. ie - having no other address * is_primary is invalid */ diff --git a/tests/phpunit/api/v3/CaseTest.php b/tests/phpunit/api/v3/CaseTest.php index 74fe11ce64..be1c562940 100644 --- a/tests/phpunit/api/v3/CaseTest.php +++ b/tests/phpunit/api/v3/CaseTest.php @@ -71,14 +71,14 @@ class api_v3_CaseTest extends CiviCaseTestCase { } /** - * check with empty array + * Check with empty array */ function testCaseCreateEmpty() { $result = $this->callAPIFailure('case', 'create', array()); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testCaseCreateWithoutRequired() { $params = array( diff --git a/tests/phpunit/api/v3/CaseTypeTest.php b/tests/phpunit/api/v3/CaseTypeTest.php index e8b4d3d60a..2f34786900 100644 --- a/tests/phpunit/api/v3/CaseTypeTest.php +++ b/tests/phpunit/api/v3/CaseTypeTest.php @@ -73,14 +73,14 @@ class api_v3_CaseTypeTest extends CiviCaseTestCase { } /** - * check with empty array + * Check with empty array */ function testCaseTypeCreateEmpty() { $this->callAPIFailure('CaseType', 'create', array()); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testCaseTypeCreateWithoutRequired() { $params = array( @@ -96,7 +96,7 @@ class api_v3_CaseTypeTest extends CiviCaseTestCase { } /** - * test create methods with valid data + * Test create methods with valid data * success expected */ function testCaseTypeCreate() { @@ -181,7 +181,7 @@ class api_v3_CaseTypeTest extends CiviCaseTestCase { } /** - * test create methods with xml file + * Test create methods with xml file * success expected */ function testCaseTypeCreateWithDefinition() { diff --git a/tests/phpunit/api/v3/ContactTest.php b/tests/phpunit/api/v3/ContactTest.php index 3f72b8e705..d051c59aac 100644 --- a/tests/phpunit/api/v3/ContactTest.php +++ b/tests/phpunit/api/v3/ContactTest.php @@ -321,7 +321,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPIFailure('contact', 'create', $params); } /** - * 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 @@ -538,7 +538,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * 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 @@ -562,7 +562,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * 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 @@ -1650,7 +1650,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * test that permissions are respected when creating contacts + * Test that permissions are respected when creating contacts */ function testContactCreationPermissions() { $params = array( @@ -1738,7 +1738,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } /** - * test get ref api - gets a list of references to an entity + * Test get ref api - gets a list of references to an entity */ function testGetReferenceCounts() { $result = $this->callAPISuccess('Contact', 'create', array( diff --git a/tests/phpunit/api/v3/ContactTypeTest.php b/tests/phpunit/api/v3/ContactTypeTest.php index 0f98ed7c28..14ee8d697c 100644 --- a/tests/phpunit/api/v3/ContactTypeTest.php +++ b/tests/phpunit/api/v3/ContactTypeTest.php @@ -91,7 +91,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } /** - * test add methods with valid data + * Test add methods with valid data * success expected */ function testContactCreate() { @@ -135,7 +135,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { /** - * test add with invalid data + * Test add with invalid data */ function testContactAddInvalidData() { @@ -159,7 +159,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { /** - * test update with no subtype to valid subtype + * Test update with no subtype to valid subtype * success expected */ function testContactUpdateNoSubtypeValid() { @@ -225,7 +225,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { /** - * test update with no subtype to invalid subtype + * Test update with no subtype to invalid subtype */ function testContactUpdateNoSubtypeInvalid() { @@ -272,7 +272,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } /** - * test update with no subtype to valid subtype + * Test update with no subtype to valid subtype * success expected */ function testContactUpdateSubtypeValid() { @@ -362,7 +362,7 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase { } /** - * test update with no subtype to invalid subtype + * Test update with no subtype to invalid subtype */ function testContactUpdateSubtypeInvalid() { diff --git a/tests/phpunit/api/v3/ContributionPageTest.php b/tests/phpunit/api/v3/ContributionPageTest.php index 37c209a93a..ad541df38a 100644 --- a/tests/phpunit/api/v3/ContributionPageTest.php +++ b/tests/phpunit/api/v3/ContributionPageTest.php @@ -372,7 +372,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase { } /** - * set up membership contribution page + * Set up membership contribution page * @param bool $isSeparatePayment */ function setUpMembershipContributionPage($isSeparatePayment = FALSE) { @@ -427,7 +427,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase { } /** - * help function to set up contribution page with some defaults + * Help function to set up contribution page with some defaults */ function setUpContributionPage() { $contributionPageResult = $this->callAPISuccess($this->_entity, 'create', $this->params); diff --git a/tests/phpunit/api/v3/ContributionSoftTest.php b/tests/phpunit/api/v3/ContributionSoftTest.php index ad1a5af425..e04ff2e9e5 100644 --- a/tests/phpunit/api/v3/ContributionSoftTest.php +++ b/tests/phpunit/api/v3/ContributionSoftTest.php @@ -100,7 +100,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { } /** - * test get methods + * Test get methods * @todo - this might be better broken down into more smaller tests */ function testGetContributionSoft() { diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index d8ed23fabb..366018bbe3 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -280,7 +280,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * 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 @@ -303,7 +303,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * 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 @@ -427,7 +427,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->contributionGetnCheck($params, $contribution['id']); } /** - * test create with valid payment instument + * Test create with valid payment instument */ function testCreateContributionWithPaymentInstrument() { $params = $this->_params + array('payment_instrument' => 'EFT'); @@ -558,7 +558,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * test note created correctly + * Test note created correctly */ function testCreateContributionWithNote() { $description = "Demonstrates creating contribution with Note Entity"; @@ -770,7 +770,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * in the interests of removing financial type / contribution type checks from + * In the interests of removing financial type / contribution type checks from * legacy format function lets test that the api is doing this for us */ function testCreateInvalidFinancialType() { @@ -780,7 +780,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * in the interests of removing financial type / contribution type checks from + * In the interests of removing financial type / contribution type checks from * legacy format function lets test that the api is doing this for us */ function testValidNamedFinancialType() { @@ -855,7 +855,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * test that BAO defaults work + * Test that BAO defaults work */ function testCreateBAODefaults() { unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']); @@ -1051,7 +1051,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * test that update does not change status id CRM-15105 + * Test that update does not change status id CRM-15105 */ function testCreateUpdateWithoutChangingPendingStatus() { $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array('contribution_status_id' => 2))); @@ -1320,7 +1320,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * test membership is renewed when transaction completed + * Test membership is renewed when transaction completed */ function testCompleteTransactionMembershipPriceSet() { $this->createPriceSetWithPage('membership'); @@ -1332,7 +1332,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * test membership is renewed when transaction completed + * Test membership is renewed when transaction completed */ function testCompleteTransactionMembershipPriceSetTwoTerms() { $this->createPriceSetWithPage('membership'); @@ -1351,7 +1351,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { /** - * this could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage + * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage * on parent class at some point (fn is not in 4.4) * @param $entity * @param array $params @@ -1410,7 +1410,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { /** * Set up a pending transaction with a specific price field id - * @param $priceFieldValueID + * @param int $priceFieldValueID */ function setUpPendingContribution($priceFieldValueID){ $contactID = $this->individualCreate(); @@ -1566,7 +1566,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */function _getFinancialTrxnAmount($contId) { @@ -1582,7 +1582,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */function _getFinancialItemAmount($contId) { @@ -1597,7 +1597,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } /** - * @param $contId + * @param int $contId * @param $context */ function _checkFinancialItem($contId, $context) { @@ -1667,7 +1667,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { /** * @param $contribution * @param $context - * @param null $instrumentId + * @param int $instrumentId */ function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL) { $trxnParams = array( diff --git a/tests/phpunit/api/v3/CustomFieldTest.php b/tests/phpunit/api/v3/CustomFieldTest.php index b186fcc3c8..e07b4f9e9f 100644 --- a/tests/phpunit/api/v3/CustomFieldTest.php +++ b/tests/phpunit/api/v3/CustomFieldTest.php @@ -64,7 +64,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check with no array + * Check with no array */ function testCustomFieldCreateNoArray() { $fieldParams = NULL; @@ -74,7 +74,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check with no label + * Check with no label */ function testCustomFieldCreateWithoutLabel() { $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group')); @@ -95,7 +95,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check with edit + * Check with edit */ function testCustomFieldCreateWithEdit() { $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group')); @@ -120,7 +120,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check without groupId + * Check without groupId */ function testCustomFieldCreateWithoutGroupID() { $fieldParams = array( @@ -171,7 +171,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * @param $gid + * @param int $gid * @param $htype * @param $dtype * @@ -195,7 +195,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * @param $gid + * @param int $gid * @param $htype * @param $dtype * @@ -230,7 +230,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { }*/ /** - * check with data type - Options with option_values + * Check with data type - Options with option_values */ function testCustomFieldCreateWithEmptyOptionGroup() { $customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'select_test_group')); @@ -392,7 +392,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { ///////////////// civicrm_custom_field_delete methods /** - * check with no array + * Check with no array */ function testCustomFieldDeleteNoArray() { $params = NULL; @@ -401,7 +401,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check without Field ID + * Check without Field ID */ function testCustomFieldDeleteWithoutFieldID() { $params = array(); @@ -410,7 +410,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check without valid array + * Check without valid array */ function testCustomFieldDelete() { $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group')); @@ -426,7 +426,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { } /** - * check for Option Value + * Check for Option Value */ function testCustomFieldOptionValueDelete() { $customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'ABC')); diff --git a/tests/phpunit/api/v3/CustomGroupTest.php b/tests/phpunit/api/v3/CustomGroupTest.php index e4c9bad764..8d44de6980 100644 --- a/tests/phpunit/api/v3/CustomGroupTest.php +++ b/tests/phpunit/api/v3/CustomGroupTest.php @@ -78,7 +78,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { ///////////////// civicrm_custom_group_create methods /** - * check with empty array + * Check with empty array * note that these tests are of marginal value so should not be included in copy & paste * code. The SyntaxConformance is capable of testing this for all entities on create * & delete (& it would be easy to add if not there) @@ -90,7 +90,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testCustomGroupCreateNoExtends() { $params = array( @@ -111,7 +111,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testCustomGroupCreateInvalidExtends() { $params = array( @@ -132,7 +132,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with a string instead of array for extends + * Check with a string instead of array for extends */ function testCustomGroupCreateExtendsString() { $params = array( @@ -152,7 +152,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with valid array + * Check with valid array */ function testCustomGroupCreate() { $params = array( @@ -173,7 +173,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with valid array + * Check with valid array */ function testCustomGroupGetFields() { $params = array( @@ -190,7 +190,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with extends array length greater than 1 + * Check with extends array length greater than 1 */ function testCustomGroupExtendsMultipleCreate() { $params = array( @@ -210,7 +210,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with style missing from params array + * Check with style missing from params array */ function testCustomGroupCreateNoStyle() { $params = array( @@ -230,7 +230,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with not array + * Check with not array */ function testCustomGroupCreateNotArray() { $params = NULL; @@ -239,7 +239,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check without title + * Check without title */ function testCustomGroupCreateNoTitle() { $params = array('extends' => array('Contact'), @@ -255,7 +255,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check for household without weight + * Check for household without weight */ function testCustomGroupCreateHouseholdNoWeight() { $params = array( @@ -276,7 +276,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check for Contribution Donation + * Check for Contribution Donation */ function testCustomGroupCreateContributionDonation() { $params = array( @@ -297,7 +297,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with valid array + * Check with valid array */ function testCustomGroupCreateGroup() { $params = array( @@ -319,7 +319,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with Activity - Meeting Type + * Check with Activity - Meeting Type */ function testCustomGroupCreateActivityMeeting() { $params = array( @@ -341,7 +341,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { ///////////////// civicrm_custom_group_delete methods /** - * check without GroupID + * Check without GroupID */ function testCustomGroupDeleteWithoutGroupID() { $customGroup = $this->callAPIFailure('custom_group', 'delete', array()); @@ -349,7 +349,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with no array + * Check with no array */ function testCustomGroupDeleteNoArray() { $params = NULL; @@ -358,7 +358,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * check with valid custom group id + * Check with valid custom group id */ function testCustomGroupDelete() { $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group')); @@ -370,7 +370,7 @@ class api_v3_CustomGroupTest extends CiviUnitTestCase { } /** - * main success get function + * Main success get function */ public function testGetCustomGroupSuccess() { diff --git a/tests/phpunit/api/v3/DashboardTest.php b/tests/phpunit/api/v3/DashboardTest.php index 39bf9e62e0..245de3b46a 100644 --- a/tests/phpunit/api/v3/DashboardTest.php +++ b/tests/phpunit/api/v3/DashboardTest.php @@ -79,7 +79,7 @@ class api_v3_DashboardTest extends CiviUnitTestCase { } /** - * @param $id + * @param int $id * @param $oldCount */ function DashboardDelete($id, $oldCount) { diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index 56df71d35f..eff60ed6c3 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -276,7 +276,7 @@ class api_v3_EventTest extends CiviUnitTestCase { ///////////////// 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 @@ -392,7 +392,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * check event_id still supported for delete + * Check event_id still supported for delete */ function testDeleteWithEventId() { $params = array( @@ -510,7 +510,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } /** - * test api_action param also works + * Test api_action param also works */ function testgetfieldsRest() { $description = "demonstrate use of getfields to interrogate api"; diff --git a/tests/phpunit/api/v3/GroupOrganizationTest.php b/tests/phpunit/api/v3/GroupOrganizationTest.php index c64e31da11..349ddd86d0 100644 --- a/tests/phpunit/api/v3/GroupOrganizationTest.php +++ b/tests/phpunit/api/v3/GroupOrganizationTest.php @@ -149,7 +149,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ///////////////// civicrm_group_organization_create methods /** - * check with valid params + * Check with valid params */ public function testGroupOrganizationCreate() { $params = array( @@ -170,7 +170,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { $this->assertEquals($result['values'], $result2['values']); } /** - * check with empty params array + * Check with empty params array */ public function testGroupOrganizationCreateWithEmptyParams() { $params = array( ); @@ -179,7 +179,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { } /** - * check with invalid params + * Check with invalid params */ public function testGroupOrganizationCreateParamsNotArray() { $params = 'group_org'; @@ -188,7 +188,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { } /** - * check with invalid params keys + * Check with invalid params keys */ public function testGroupOrganizationCreateWithInvalidKeys() { $params = array( diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php index c201df4b3a..1be311d739 100644 --- a/tests/phpunit/api/v3/JobTest.php +++ b/tests/phpunit/api/v3/JobTest.php @@ -69,7 +69,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * check with no name + * Check with no name */ function testCreateWithoutName() { $params = array( @@ -80,7 +80,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * create job with an invalid "run_frequency" value + * Create job with an invalid "run_frequency" value */ function testCreateWithInvalidFrequency() { $params = array( @@ -97,7 +97,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * create job + * Create job */ function testCreate() { $result = $this->callAPIAndDocument('job', 'create', $this->_params, __FUNCTION__, __FILE__); @@ -110,7 +110,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testDeleteEmpty() { $params = array(); @@ -118,14 +118,14 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * check with No array + * Check with No array */ function testDeleteParamsNotArray() { $result = $this->callAPIFailure('job', 'delete', 'string'); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testDeleteWithoutRequired() { $params = array( @@ -139,7 +139,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testDeleteWithIncorrectData() { $params = array( @@ -148,7 +148,7 @@ class api_v3_JobTest extends CiviUnitTestCase { } /** - * check job delete + * Check job delete */ function testDelete() { $createResult = $this->callAPISuccess('job', 'create', $this->_params); @@ -182,7 +182,7 @@ 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 * @@ -217,7 +217,7 @@ 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 */ @@ -285,8 +285,8 @@ class api_v3_JobTest extends CiviUnitTestCase { /** * @param $op - * @param $objectName - * @param $id + * @param string $objectName + * @param int $id * @param array $params */ function hookPreRelationship($op, $objectName, $id, &$params ) { diff --git a/tests/phpunit/api/v3/MembershipTest.php b/tests/phpunit/api/v3/MembershipTest.php index b8611d21aa..9dbcc5ead4 100644 --- a/tests/phpunit/api/v3/MembershipTest.php +++ b/tests/phpunit/api/v3/MembershipTest.php @@ -258,7 +258,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { $this->assertEquals($result['membership_type_id'], $this->_membershipTypeID2); } /** - * 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 @@ -663,7 +663,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { } /** - * 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 @@ -799,7 +799,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { } /** - * change custom field using update + * Change custom field using update */ function testUpdateWithCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); diff --git a/tests/phpunit/api/v3/MessageTemplateTest.php b/tests/phpunit/api/v3/MessageTemplateTest.php index 892657a9d7..a347692802 100644 --- a/tests/phpunit/api/v3/MessageTemplateTest.php +++ b/tests/phpunit/api/v3/MessageTemplateTest.php @@ -58,7 +58,7 @@ class api_v3_MessageTemplateTest extends CiviUnitTestCase { function tearDown() {} /** - * test create function succeeds + * Test create function succeeds */ public function testCreate() { $result = $this->callAPIAndDocument('MessageTemplate', 'create', $this->params, __FUNCTION__, __FILE__); diff --git a/tests/phpunit/api/v3/NoteTest.php b/tests/phpunit/api/v3/NoteTest.php index 76eb1bb1f4..fef78847bf 100644 --- a/tests/phpunit/api/v3/NoteTest.php +++ b/tests/phpunit/api/v3/NoteTest.php @@ -87,7 +87,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { ///////////////// civicrm_note_get methods /** - * check retrieve note with empty parameter array + * Check retrieve note with empty parameter array * Error expected */ function testGetWithEmptyParams() { @@ -95,7 +95,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { } /** - * check retrieve note with missing patrameters + * Check retrieve note with missing patrameters * Error expected */ function testGetWithoutEntityId() { @@ -106,7 +106,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { } /** - * check civicrm_note_get + * Check civicrm_note_get */ function testGet() { $entityId = $this->_noteID; diff --git a/tests/phpunit/api/v3/OptionGroupTest.php b/tests/phpunit/api/v3/OptionGroupTest.php index 3b243e91b5..7b91b4365c 100644 --- a/tests/phpunit/api/v3/OptionGroupTest.php +++ b/tests/phpunit/api/v3/OptionGroupTest.php @@ -137,7 +137,7 @@ class api_v3_OptionGroupTest extends CiviUnitTestCase { } /** - * success test for updating an existing Option Group + * Success test for updating an existing Option Group */ public function testCreateUpdateOptionGroup() { $result = $this->callAPISuccess($this->_entity, 'create', $this->_params); @@ -147,7 +147,7 @@ class api_v3_OptionGroupTest extends CiviUnitTestCase { } /** - * success test for deleting an existing Option Group + * Success test for deleting an existing Option Group */ public function testDeleteOptionGroup() { $result = $this->callAPISuccess($this->_entity, 'create', $this->_params); diff --git a/tests/phpunit/api/v3/OptionValueTest.php b/tests/phpunit/api/v3/OptionValueTest.php index a1073b3f43..02fe242c17 100644 --- a/tests/phpunit/api/v3/OptionValueTest.php +++ b/tests/phpunit/api/v3/OptionValueTest.php @@ -134,7 +134,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * test that using option_group_name returns more than 1 & less than all + * Test that using option_group_name returns more than 1 & less than all */ public function testGetOptionGroupByName() { $activityTypesParams = array('option_group_name' => 'activity_type', 'option.limit' => 100); @@ -288,7 +288,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { /** - * update option value with 'id' paramter and the value to update + * Update option value with 'id' paramter and the value to update * and not passing option group id */ public function testUpdateOptionValueNoGroupId() { @@ -307,7 +307,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { } /** - * update option value with 'id' paramter and the value to update + * Update option value with 'id' paramter and the value to update * and as well as option group id */ public function testUpdateOptionValueWithGroupId() { diff --git a/tests/phpunit/api/v3/ParticipantPaymentTest.php b/tests/phpunit/api/v3/ParticipantPaymentTest.php index 540501b460..ae1324efec 100644 --- a/tests/phpunit/api/v3/ParticipantPaymentTest.php +++ b/tests/phpunit/api/v3/ParticipantPaymentTest.php @@ -115,7 +115,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check without contribution_id + * Check without contribution_id */ function testPaymentCreateMissingContributionId() { //Without Payment EntityID @@ -126,7 +126,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with valid array + * Check with valid array */ function testPaymentCreate() { //Create Contribution & get contribution ID @@ -158,7 +158,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testPaymentUpdateEmpty() { $params = array(); @@ -166,7 +166,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with missing participant_id + * Check with missing participant_id */ function testPaymentUpdateMissingParticipantId() { //WithoutParticipantId @@ -177,7 +177,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with missing contribution_id + * Check with missing contribution_id */ function testPaymentUpdateMissingContributionId() { $params = array( @@ -186,7 +186,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check financial records for offline Participants + * Check financial records for offline Participants */ function testPaymentOffline() { @@ -212,7 +212,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check financial records for online Participant + * Check financial records for online Participant */ function testPaymentOnline() { @@ -245,7 +245,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check financial records for online Participant pay later scenario + * Check financial records for online Participant pay later scenario */ function testPaymentPayLaterOnline() { @@ -290,7 +290,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testPaymentDeleteWithEmptyParams() { $params = array(); @@ -299,7 +299,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with wrong id + * Check with wrong id */ function testPaymentDeleteWithWrongID() { $params = array( @@ -309,7 +309,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { } /** - * check with valid array + * Check with valid array */ function testPaymentDelete() { diff --git a/tests/phpunit/api/v3/ParticipantTest.php b/tests/phpunit/api/v3/ParticipantTest.php index 380720264a..8aab82c20e 100644 --- a/tests/phpunit/api/v3/ParticipantTest.php +++ b/tests/phpunit/api/v3/ParticipantTest.php @@ -98,7 +98,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * 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 @@ -124,7 +124,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ///////////////// civicrm_participant_get methods /** - * check with wrong params type + * Check with wrong params type */ function testGetWrongParamsType() { $params = 'a string'; @@ -139,7 +139,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with participant_id + * Check with participant_id */ function testGetParticipantIdOnly() { $params = array( @@ -168,7 +168,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with params id + * Check with params id */ function testGetParamsAsIdOnly() { $params = array( @@ -182,7 +182,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with params id + * Check with params id */ function testGetNestedEventGet() { //create a second event & add participant to it. @@ -217,7 +217,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with contact_id + * Check with contact_id */ function testGetContactIdOnly() { $params = array( @@ -242,7 +242,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with event_id + * Check with event_id * fetch first record */ function testGetMultiMatchReturnFirst() { @@ -255,7 +255,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with event_id + * Check with event_id * in v3 this should return all participants */ function testGetMultiMatchNoReturnFirst() { @@ -279,7 +279,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with participant_id + * Check with participant_id */ function testSearchParticipantIdOnly() { $params = array( @@ -292,7 +292,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with contact_id + * Check with contact_id */ function testSearchContactIdOnly() { // Should get 2 participant records for this contact. @@ -305,7 +305,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with event_id + * Check with event_id */ function testSearchByEvent() { // Should get >= 3 participant records for this event. Also testing that last_name and event_title are returned. @@ -324,7 +324,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with event_id + * Check with event_id * fetch with limit */ function testSearchByEventWithLimit() { @@ -349,7 +349,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with event_id + * Check with event_id */ function testCreateMissingContactID() { $params = array( @@ -359,7 +359,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with contact_id + * Check with contact_id * without event_id */ function testCreateMissingEventID() { @@ -370,7 +370,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with contact_id & event_id + * Check with contact_id & event_id */ function testCreateEventIdOnly() { $params = array( @@ -382,7 +382,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with complete array + * Check with complete array */ function testCreateAllParams() { $params = $this->_params; @@ -519,7 +519,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with complete array + * Check with complete array */ function testUpdate() { $participantId = $this->participantCreate(array( @@ -572,7 +572,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with empty array + * Check with empty array */ function testUpdateEmptyParams() { $params = array(); @@ -581,7 +581,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check without event_id + * Check without event_id */ function testUpdateWithoutEventId() { $participantId = $this->participantCreate(array('contactID' => $this->_individualId, 'eventID' => $this->_eventID)); @@ -599,7 +599,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with Invalid participantId + * Check with Invalid participantId */ function testUpdateWithWrongParticipantId() { $params = array( @@ -613,7 +613,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with Invalid ContactId + * Check with Invalid ContactId */ function testUpdateWithWrongContactId() { $participantId = $this->participantCreate(array( @@ -651,7 +651,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * check with participant_id + * Check with participant_id */ function testParticipantDelete() { $params = array( @@ -662,7 +662,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.. */ @@ -674,7 +674,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { } /** - * delete with a get - a 'criteria delete' + * Delete with a get - a 'criteria delete' */ function testNestedDelete() { $description = "Criteria delete by nesting a GET & a DELETE"; diff --git a/tests/phpunit/api/v3/PaymentProcessorTest.php b/tests/phpunit/api/v3/PaymentProcessorTest.php index b676090252..d819e8647d 100644 --- a/tests/phpunit/api/v3/PaymentProcessorTest.php +++ b/tests/phpunit/api/v3/PaymentProcessorTest.php @@ -80,7 +80,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_add methods /** - * check with no name + * Check with no name */ function testPaymentProcessorCreateWithoutName() { $payProcParams = array( @@ -90,7 +90,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { } /** - * create payment processor + * Create payment processor */ function testPaymentProcessorCreate() { $params = $this->_params; @@ -115,7 +115,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_delete methods /** - * check payment processor delete + * Check payment processor delete */ function testPaymentProcessorDelete() { $id = $this->testPaymentProcessorCreate(); @@ -129,7 +129,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processors_get methods /** - * check with valid params array. + * Check with valid params array. */ function testPaymentProcessorsGet() { $params = $this->_params; diff --git a/tests/phpunit/api/v3/PaymentProcessorTypeTest.php b/tests/phpunit/api/v3/PaymentProcessorTypeTest.php index 9c564ff4e9..277a1d6ab8 100644 --- a/tests/phpunit/api/v3/PaymentProcessorTypeTest.php +++ b/tests/phpunit/api/v3/PaymentProcessorTypeTest.php @@ -63,7 +63,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_type_add methods /** - * check with no name + * Check with no name */ function testPaymentProcessorTypeCreateWithoutName() { $payProcParams = array( @@ -75,7 +75,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * create payment processor type + * Create payment processor type */ function testPaymentProcessorTypeCreate() { $params = array( 'sequential' => 1, @@ -108,7 +108,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_type_delete methods /** - * check with empty array + * Check with empty array */ function testPaymentProcessorTypeDeleteEmpty() { $params = array(); @@ -116,14 +116,14 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check with No array + * Check with No array */ function testPaymentProcessorTypeDeleteParamsNotArray() { $result = $this->callAPIFailure('payment_processor_type', 'delete', 'string'); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testPaymentProcessorTypeDeleteWithoutRequired() { $params = array( @@ -137,14 +137,14 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testPaymentProcessorTypeDeleteWithIncorrectData() { $result = $this->callAPIFailure('payment_processor_type', 'delete', array('id' => 'abcd')); } /** - * check payment processor type delete + * Check payment processor type delete */ function testPaymentProcessorTypeDelete() { $payProcType = $this->paymentProcessorTypeCreate(); @@ -158,7 +158,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_type_update /** - * check with empty array + * Check with empty array */ function testPaymentProcessorTypeUpdateEmpty() { $params = array(); @@ -167,7 +167,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check with No array + * Check with No array */ function testPaymentProcessorTypeUpdateParamsNotArray() { $result = $this->callAPIFailure('payment_processor_type', 'create', 'string'); @@ -175,7 +175,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check with all parameters + * Check with all parameters */ function testPaymentProcessorTypeUpdate() { // create sample payment processor type. @@ -198,7 +198,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { ///////////////// civicrm_payment_processor_types_get methods /** - * check with empty array + * Check with empty array */ function testPaymentProcessorTypesGetEmptyParams() { $results = $this->callAPISuccess('payment_processor_type', 'get', array( )); @@ -227,7 +227,7 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { } /** - * check with valid params array. + * Check with valid params array. */ function testPaymentProcessorTypesGet() { $firstRelTypeParams = array( diff --git a/tests/phpunit/api/v3/PledgePaymentTest.php b/tests/phpunit/api/v3/PledgePaymentTest.php index 962e79146c..0f308e7044 100644 --- a/tests/phpunit/api/v3/PledgePaymentTest.php +++ b/tests/phpunit/api/v3/PledgePaymentTest.php @@ -155,7 +155,7 @@ class api_v3_PledgePaymentTest extends CiviUnitTestCase { } /** - * test checks behaviour when more payments are created than should be possible + * Test checks behaviour when more payments are created than should be possible */ function testCreatePledgePaymentAllCreated() { $params = array( diff --git a/tests/phpunit/api/v3/PledgeTest.php b/tests/phpunit/api/v3/PledgeTest.php index f0c4974c37..30bfeee52d 100644 --- a/tests/phpunit/api/v3/PledgeTest.php +++ b/tests/phpunit/api/v3/PledgeTest.php @@ -78,7 +78,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ///////////////// 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 @@ -133,7 +133,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $pledge = $this->callAPISuccess('pledge', 'delete', $params2); } /** - * test 'return.pledge_financial_type' => 1 works + * Test 'return.pledge_financial_type' => 1 works */ function testGetPledgewithReturn() { @@ -147,7 +147,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $this->assertEquals('Donation', $pledge['pledge_financial_type']); } /** - * test 'return.pledge_contribution_type' => 1 works + * Test 'return.pledge_contribution_type' => 1 works * This is for legacy compatibility */ function testGetPledgewithReturnLegacy() { @@ -355,7 +355,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * test that status is set to pending + * Test that status is set to pending */ function testCreatePledgeNoStatus() { @@ -472,7 +472,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * legacy support for pledge_id + * Legacy support for pledge_id */ function testDeletePledge() { @@ -484,7 +484,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * std is to accept id + * Std is to accept id */ function testDeletePledgeUseID() { @@ -496,7 +496,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { } /** - * test to make sure empty get returns nothing + * 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 */ diff --git a/tests/phpunit/api/v3/ProfileTest.php b/tests/phpunit/api/v3/ProfileTest.php index 4499acaa73..52d078ab15 100644 --- a/tests/phpunit/api/v3/ProfileTest.php +++ b/tests/phpunit/api/v3/ProfileTest.php @@ -80,7 +80,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { ////////////// test $this->callAPISuccess3_profile_get ////////////////// /** - * check Without ProfileId + * Check Without ProfileId */ function testProfileGetWithoutProfileId() { $params = array( @@ -92,7 +92,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with no invalid profile Id + * Check with no invalid profile Id */ function testProfileGetInvalidProfileId() { $params = array( @@ -103,7 +103,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with success + * Check with success */ function testProfileGet() { $pofileFieldValues = $this->_createIndividualContact(); @@ -211,7 +211,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * get Billing empty contact - this will return generic defaults + * Get Billing empty contact - this will return generic defaults */ function testProfileGetBillingEmptyContact() { @@ -235,7 +235,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile without activity id + * Check contact activity profile without activity id */ function testContactActivityGetWithoutActivityId() { list($params, $expected) = $this->_createContactWithActivity(); @@ -246,7 +246,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile wrong activity id + * Check contact activity profile wrong activity id */ function testContactActivityGetWrongActivityId() { list($params, $expected) = $this->_createContactWithActivity(); @@ -257,7 +257,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile with wrong activity type + * Check contact activity profile with wrong activity type */ function testContactActivityGetWrongActivityType() { //flush cache by calling with reset @@ -290,7 +290,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile with success + * Check contact activity profile with success */ function testContactActivityGetSuccess() { list($params, $expected) = $this->_createContactWithActivity(); @@ -368,7 +368,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { /////////////// test $this->callAPISuccess3_profile_set ////////////////// /** - * check Without ProfileId + * Check Without ProfileId */ function testProfileSubmitWithoutProfileId() { $params = array( @@ -380,7 +380,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with no invalid profile Id + * Check with no invalid profile Id */ function testProfileSubmitInvalidProfileId() { $params = array( @@ -391,7 +391,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with missing required field in profile + * Check with missing required field in profile */ function testProfileSubmitCheckProfileRequired() { $pofileFieldValues = $this->_createIndividualContact(); @@ -415,7 +415,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with success + * Check with success */ function testProfileSubmit() { $pofileFieldValues = $this->_createIndividualContact(); @@ -502,7 +502,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { )); } /** - * set is deprecated but we need to ensure it still works + * Set is deprecated but we need to ensure it still works */ function testLegacySet() { $pofileFieldValues = $this->_createIndividualContact(); @@ -538,7 +538,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile without activity id + * Check contact activity profile without activity id */ function testContactActivitySubmitWithoutActivityId() { list($params, $expected) = $this->_createContactWithActivity(); @@ -550,7 +550,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile wrong activity id + * Check contact activity profile wrong activity id */ function testContactActivitySubmitWrongActivityId() { list($params, $expected) = $this->_createContactWithActivity(); @@ -561,7 +561,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile with wrong activity type + * Check contact activity profile with wrong activity type */ function testContactActivitySubmitWrongActivityType() { //flush cache by calling with reset @@ -594,7 +594,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check contact activity profile with success + * Check contact activity profile with success */ function testContactActivitySubmitSuccess() { list($params, $expected) = $this->_createContactWithActivity(); @@ -620,7 +620,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check profile apply Without ProfileId + * Check profile apply Without ProfileId */ function testProfileApplyWithoutProfileId() { $params = array( @@ -631,7 +631,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check profile apply with no invalid profile Id + * Check profile apply with no invalid profile Id */ function testProfileApplyInvalidProfileId() { $params = array( @@ -642,7 +642,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * check with success + * Check with success */ function testProfileApply() { $pofileFieldValues = $this->_createIndividualContact(); @@ -902,7 +902,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { } /** - * @param $profileID + * @param int $profileID */ function _addCustomFieldToProfile($profileID) { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, ''); diff --git a/tests/phpunit/api/v3/RelationshipTest.php b/tests/phpunit/api/v3/RelationshipTest.php index a2c54549b4..b01a1ca4ef 100644 --- a/tests/phpunit/api/v3/RelationshipTest.php +++ b/tests/phpunit/api/v3/RelationshipTest.php @@ -35,7 +35,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { protected $_apiversion = 3; protected $_cId_a; /** - * second individual + * Second individual * @var integer */ protected $_cId_a_2; @@ -101,14 +101,14 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_create methods /** - * check with empty array + * Check with empty array */ function testRelationshipCreateEmpty() { $this->callAPIFailure('relationship', 'create', array()); } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testRelationshipCreateWithoutRequired() { $params = array( @@ -121,7 +121,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testRelationshipCreateWithIncorrectData() { @@ -154,7 +154,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check relationship creation with invalid Relationship + * Check relationship creation with invalid Relationship */ function testRelationshipCreatInvalidRelationship() { // both the contact of type Individual @@ -181,7 +181,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check relationship already exists + * Check relationship already exists */ function testRelationshipCreateAlreadyExists() { $params = array( @@ -207,7 +207,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check relationship already exists + * Check relationship already exists */ function testRelationshipCreateUpdateAlreadyExists() { $params = array( @@ -232,7 +232,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * checkupdate doesn't reset stuff badly - CRM-11789 + * Checkupdate doesn't reset stuff badly - CRM-11789 */ function testRelationshipCreateUpdateDoesntMangle() { $params = array( @@ -260,7 +260,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { /** - * check relationship creation + * Check relationship creation */ function testRelationshipCreate() { $params = array( @@ -293,7 +293,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $this->callAPISuccess('relationship', 'delete', $params); } /** - * ensure disabling works + * Ensure disabling works */ function testRelationshipUpdate() { $result = $this->callAPISuccess('relationship', 'create', $this->_params); @@ -309,7 +309,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $this->assertEquals(1, $result['values'][$result['id']]['is_permission_b_a']); } /** - * check relationship creation + * Check relationship creation */ function testRelationshipCreateEmptyEndDate() { $params = array( @@ -347,7 +347,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check relationship creation with custom data + * Check relationship creation with custom data */ function testRelationshipCreateWithCustomData() { $customGroup = $this->createCustomGroup(); @@ -382,7 +382,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * 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 @@ -515,7 +515,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_delete methods /** - * check with empty array + * Check with empty array */ function testRelationshipDeleteEmpty() { $params = array(); @@ -523,7 +523,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testRelationshipDeleteWithoutRequired() { $params = array( @@ -536,7 +536,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testRelationshipDeleteWithIncorrectData() { $params = array( @@ -552,7 +552,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check relationship creation + * Check relationship creation */ function testRelationshipDelete() { $params = array( @@ -576,7 +576,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_update methods /** - * check with empty array + * Check with empty array */ function testRelationshipUpdateEmpty() { $result = $this->callAPIFailure('relationship', 'create', array(), @@ -584,11 +584,11 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check if required fields are not passed + * Check if required fields are not passed */ /** - * check relationship update + * Check relationship update */ function testRelationshipCreateDuplicate() { $relParams = array( @@ -628,7 +628,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with valid params array. + * Check with valid params array. */ function testRelationshipsGet() { $relParams = array( @@ -662,7 +662,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with valid params array. + * Check with valid params array. * (The get function will behave differently without 'contact_id' passed */ function testRelationshipsGetGeneric() { @@ -803,7 +803,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with invalid relationshipType Id + * Check with invalid relationshipType Id */ function testRelationshipTypeAddInvalidId() { $relTypeParams = array( @@ -818,7 +818,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with valid data with contact_b + * Check with valid data with contact_b */ function testGetRelationshipWithContactB() { $relParams = array( @@ -846,7 +846,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { } /** - * check with valid data with relationshipTypes + * Check with valid data with relationshipTypes */ function testGetRelationshipWithRelTypes() { $relParams = array( diff --git a/tests/phpunit/api/v3/RelationshipTypeTest.php b/tests/phpunit/api/v3/RelationshipTypeTest.php index 48dbb97131..2d268fc6d7 100644 --- a/tests/phpunit/api/v3/RelationshipTypeTest.php +++ b/tests/phpunit/api/v3/RelationshipTypeTest.php @@ -94,7 +94,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_type_add methods /** - * check with no name + * Check with no name */ function testRelationshipTypeCreateWithoutName() { $relTypeParams = array( @@ -107,7 +107,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with no contact type + * Check with no contact type */ function testRelationshipTypeCreateWithoutContactType() { $relTypeParams = array( @@ -120,7 +120,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * create relationship type + * Create relationship type */ function testRelationshipTypeCreate() { $params = array( @@ -150,7 +150,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check if required fields are not passed + * Check if required fields are not passed */ function testRelationshipTypeDeleteWithoutRequired() { $params = array( @@ -165,7 +165,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with incorrect required fields + * Check with incorrect required fields */ function testRelationshipTypeDeleteWithIncorrectData() { $params = array( @@ -183,7 +183,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check relationship type delete + * Check relationship type delete */ function testRelationshipTypeDelete() { $id = $this->_relationshipTypeCreate(); @@ -198,7 +198,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_type_update /** - * check with empty array + * Check with empty array */ function testRelationshipTypeUpdateEmpty() { $params = array(); @@ -207,7 +207,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with no contact type + * Check with no contact type */ function testRelationshipTypeUpdateWithoutContactType() { // create sample relationship type. @@ -229,7 +229,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with all parameters + * Check with all parameters */ function testRelationshipTypeUpdate() { // create sample relationship type. @@ -256,7 +256,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ///////////////// civicrm_relationship_types_get methods /** - * check with empty array + * Check with empty array */ function testRelationshipTypesGetEmptyParams() { $firstRelTypeParams = array( @@ -287,7 +287,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with params Not Array. + * Check with params Not Array. */ function testRelationshipTypesGetParamsNotArray() { @@ -295,7 +295,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * check with valid params array. + * Check with valid params array. */ function testRelationshipTypesGet() { $firstRelTypeParams = array( @@ -333,7 +333,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { } /** - * create relationship type. + * Create relationship type. */ function _relationshipTypeCreate($params = NULL) { if (!is_array($params) || empty($params)) { diff --git a/tests/phpunit/api/v3/SettingTest.php b/tests/phpunit/api/v3/SettingTest.php index ac51335d55..824048b098 100644 --- a/tests/phpunit/api/v3/SettingTest.php +++ b/tests/phpunit/api/v3/SettingTest.php @@ -110,7 +110,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** /** - * check getfields works + * Check getfields works */ function testGetFields() { $description = 'Demonstrate return from getfields - see subfolder for variants'; @@ -124,7 +124,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * let's check it's loading from cache by meddling with the cache + * Let's check it's loading from cache by meddling with the cache */ function testGetFieldsCaching() { $settingsMetadata = array(); @@ -228,7 +228,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * check getfields works + * Check getfields works */ function testCreateSetting() { $description = "shows setting a variable for a given domain - if no domain is set current is assumed"; @@ -246,7 +246,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * check getfields works + * Check getfields works */ function testCreateInvalidSettings() { $params = array( @@ -257,7 +257,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * check invalid settings rejected - + * Check invalid settings rejected - */ function testCreateInvalidURLSettings() { $params = array( @@ -273,7 +273,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * check getfields works + * Check getfields works */ function testCreateInvalidBooleanSettings() { $params = array( @@ -307,7 +307,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * check getfields works + * Check getfields works */ function testCreateSettingMultipleDomains() { $description = "shows setting a variable for all domains"; @@ -389,7 +389,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * setting api should set & fetch settings stored in config as well as those in settings table + * Setting api should set & fetch settings stored in config as well as those in settings table */ function testSetConfigSetting() { $config = CRM_Core_Config::singleton(); @@ -411,7 +411,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * setting api should set & fetch settings stored in config as well as those in settings table + * Setting api should set & fetch settings stored in config as well as those in settings table */ function testGetConfigSetting() { $settings = $this->callAPISuccess('setting', 'get', array( @@ -421,7 +421,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { } /** - * setting api should set & fetch settings stored in config as well as those in settings table + * Setting api should set & fetch settings stored in config as well as those in settings table */ function testGetSetConfigSettingMultipleDomains() { $settings = $this->callAPISuccess('setting', 'create', array( diff --git a/tests/phpunit/api/v3/SurveyTest.php b/tests/phpunit/api/v3/SurveyTest.php index 724ff0aec8..0b80f4f398 100644 --- a/tests/phpunit/api/v3/SurveyTest.php +++ b/tests/phpunit/api/v3/SurveyTest.php @@ -77,7 +77,7 @@ class api_v3_SurveyTest extends CiviUnitTestCase { } /** - * test create function succeeds + * Test create function succeeds */ public function testCreateSurvey() { $result = $this->callAPIAndDocument('survey', 'create', $this->params, __FUNCTION__, __FILE__); @@ -109,7 +109,7 @@ 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) * diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index 541d54ef97..c609069e7d 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -1247,7 +1247,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { return $returnEntities; } /** - * @param $entityName + * @param string $entityName * @param int $count * * diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php index 24d531a93e..1140a4624b 100644 --- a/tests/phpunit/api/v3/TagTest.php +++ b/tests/phpunit/api/v3/TagTest.php @@ -42,7 +42,7 @@ class api_v3_TagTest extends CiviUnitTestCase { */ protected $ids = array(); /** - * tag id + * Tag id * @var integer */ protected $tag = array(); diff --git a/tests/phpunit/api/v3/TaxContributionPageTest.php b/tests/phpunit/api/v3/TaxContributionPageTest.php index dca090139f..b6ec921905 100644 --- a/tests/phpunit/api/v3/TaxContributionPageTest.php +++ b/tests/phpunit/api/v3/TaxContributionPageTest.php @@ -238,7 +238,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { } /** - * online and offline contrbution from above created contrbution page + * Online and offline contrbution from above created contrbution page */ function testCreateContributionOnline() { $this->setUpContributionPage(); @@ -408,7 +408,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */ @@ -424,7 +424,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { } /** - * @param $contId + * @param int $contId * * @return null|string */ @@ -504,7 +504,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { /** * @param array $params - * @param $financialTypeId + * @param int $financialTypeId */ function _getFinancialAccountId($financialTypeId) { $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' ")); diff --git a/tests/phpunit/api/v3/UFFieldTest.php b/tests/phpunit/api/v3/UFFieldTest.php index b09f62da25..eb6a3d5fcf 100644 --- a/tests/phpunit/api/v3/UFFieldTest.php +++ b/tests/phpunit/api/v3/UFFieldTest.php @@ -92,7 +92,7 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { } /** - * create / updating field + * Create / updating field */ public function testCreateUFField() { $params = $this->_params; // copy @@ -139,7 +139,7 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { } /** - * deleting field + * Deleting field */ public function testDeleteUFField() { $ufField = $this->callAPISuccess('uf_field', 'create', $this->_params); @@ -156,7 +156,7 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { } /** - * create / updating field + * Create / updating field */ public function testReplaceUFFields() { $baseFields = array(); diff --git a/tests/phpunit/api/v3/UFGroupTest.php b/tests/phpunit/api/v3/UFGroupTest.php index 10cc0e80a9..1e3ea26a25 100644 --- a/tests/phpunit/api/v3/UFGroupTest.php +++ b/tests/phpunit/api/v3/UFGroupTest.php @@ -97,7 +97,7 @@ class api_v3_UFGroupTest extends CiviUnitTestCase { } /** - * updating group + * Updating group */ public function testUpdateUFGroup() { $params = array( diff --git a/tests/phpunit/api/v3/UFJoinTest.php b/tests/phpunit/api/v3/UFJoinTest.php index 164827e067..e158ae9380 100644 --- a/tests/phpunit/api/v3/UFJoinTest.php +++ b/tests/phpunit/api/v3/UFJoinTest.php @@ -77,7 +77,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { } /** - * find uf join group id + * Find uf join group id */ public function testFindUFGroupId() { $params = array( @@ -124,7 +124,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { } /** - * create/update uf join + * Create/update uf join */ public function testCreateUFJoin() { $params = array( @@ -180,7 +180,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { } /** - * find uf join id + * Find uf join id */ public function testGetUFJoinId() { $params = array( diff --git a/tests/phpunit/api/v3/UFMatchTest.php b/tests/phpunit/api/v3/UFMatchTest.php index 3849d0f85c..8403bccc10 100644 --- a/tests/phpunit/api/v3/UFMatchTest.php +++ b/tests/phpunit/api/v3/UFMatchTest.php @@ -87,7 +87,7 @@ class api_v3_UFMatchTest extends CiviUnitTestCase { } /** - * fetch contact id by uf id + * Fetch contact id by uf id */ public function testGetUFMatchID() { $params = array( @@ -103,7 +103,7 @@ class api_v3_UFMatchTest extends CiviUnitTestCase { } /** - * fetch uf id by contact id + * Fetch uf id by contact id */ public function testGetUFID() { $params = array( -- 2.25.1