From a6c01b45f0cdaee8677de72b8bf3e784d8b6b62a Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Fri, 9 Jan 2015 14:54:55 -0500 Subject: [PATCH] INFRA-132 - Fix spacing of @return tag in comments --- CRM/ACL/API.php | 12 ++- CRM/ACL/BAO/ACL.php | 24 ++++-- CRM/ACL/BAO/EntityRole.php | 3 +- CRM/ACL/Form/WordPress/Permissions.php | 3 +- CRM/ACL/Page/ACL.php | 15 ++-- CRM/ACL/Page/ACLBasic.php | 15 ++-- CRM/ACL/Page/EntityRole.php | 15 ++-- CRM/Activity/BAO/Activity.php | 47 +++++++---- CRM/Activity/BAO/ActivityAssignment.php | 3 +- CRM/Activity/BAO/ActivityContact.php | 3 +- CRM/Activity/BAO/ActivityTarget.php | 3 +- CRM/Activity/BAO/ICalendar.php | 3 +- CRM/Activity/Form/ActivityFilter.php | 6 +- CRM/Activity/Form/Task/PickOption.php | 3 +- CRM/Activity/Form/Task/PickProfile.php | 3 +- CRM/Activity/Import/Form/MapField.php | 3 +- CRM/Activity/Import/Parser.php | 3 +- CRM/Activity/Import/Parser/Activity.php | 9 ++- CRM/Activity/Selector/Activity.php | 14 ++-- CRM/Activity/Selector/Search.php | 15 ++-- CRM/Activity/StateMachine/Search.php | 3 +- CRM/Activity/Task.php | 12 ++- CRM/Admin/Form/MailSettings.php | 3 +- CRM/Admin/Form/Options.php | 3 +- CRM/Admin/Form/PreferencesDate.php | 3 +- CRM/Admin/Form/Setting/Smtp.php | 3 +- CRM/Admin/Form/WordReplacements.php | 3 +- CRM/Admin/Page/APIDoc.php | 3 +- CRM/Admin/Page/APIExplorer.php | 3 +- CRM/Admin/Page/ContactType.php | 15 ++-- CRM/Admin/Page/EventTemplate.php | 15 ++-- CRM/Admin/Page/Extensions.php | 15 ++-- CRM/Admin/Page/Job.php | 15 ++-- CRM/Admin/Page/JobLog.php | 15 ++-- CRM/Admin/Page/LabelFormats.php | 15 ++-- CRM/Admin/Page/LocationType.php | 15 ++-- CRM/Admin/Page/MailSettings.php | 15 ++-- CRM/Admin/Page/Mapping.php | 21 +++-- CRM/Admin/Page/MessageTemplates.php | 15 ++-- CRM/Admin/Page/Navigation.php | 15 ++-- CRM/Admin/Page/Options.php | 15 ++-- CRM/Admin/Page/PaymentProcessor.php | 15 ++-- CRM/Admin/Page/PaymentProcessorType.php | 15 ++-- CRM/Admin/Page/PdfFormats.php | 15 ++-- CRM/Admin/Page/Persistent.php | 3 +- CRM/Admin/Page/PreferencesDate.php | 15 ++-- CRM/Admin/Page/RelationshipType.php | 15 ++-- CRM/Admin/Page/ScheduleReminders.php | 15 ++-- CRM/Admin/Page/Tag.php | 21 +++-- CRM/Badge/BAO/Badge.php | 3 +- CRM/Badge/BAO/Layout.php | 12 ++- CRM/Badge/Page/Layout.php | 15 ++-- CRM/Batch/BAO/Batch.php | 24 ++++-- CRM/Batch/Form/Entry.php | 3 +- CRM/Batch/Page/Batch.php | 15 ++-- CRM/Campaign/BAO/Campaign.php | 3 +- CRM/Campaign/BAO/Petition.php | 3 +- CRM/Campaign/BAO/Query.php | 3 +- CRM/Campaign/BAO/Survey.php | 26 +++--- CRM/Campaign/Form/Petition.php | 3 +- CRM/Campaign/Form/Survey/Main.php | 3 +- CRM/Campaign/Form/Survey/Questions.php | 3 +- CRM/Campaign/Form/Survey/Results.php | 3 +- CRM/Campaign/Form/SurveyType.php | 3 +- CRM/Campaign/Form/Task/Reserve.php | 3 +- CRM/Campaign/Page/Campaign.php | 2 +- CRM/Campaign/Page/DashBoard.php | 2 +- CRM/Campaign/Page/Petition/Confirm.php | 3 +- CRM/Campaign/Page/SurveyType.php | 15 ++-- CRM/Campaign/PseudoConstant.php | 12 ++- CRM/Campaign/Selector/Search.php | 15 ++-- CRM/Campaign/StateMachine/Search.php | 3 +- CRM/Campaign/Task.php | 12 ++- CRM/Case/BAO/Case.php | 46 +++++++---- CRM/Case/BAO/CaseType.php | 9 ++- .../Form/Activity/ChangeCaseStartDate.php | 3 +- CRM/Case/Form/Activity/ChangeCaseStatus.php | 3 +- CRM/Case/Form/Activity/ChangeCaseType.php | 3 +- CRM/Case/Form/Activity/LinkCases.php | 3 +- CRM/Case/Form/Activity/OpenCase.php | 3 +- CRM/Case/Form/Case.php | 3 +- CRM/Case/Form/Search.php | 3 +- CRM/Case/Page/Tab.php | 3 +- CRM/Case/PseudoConstant.php | 15 ++-- CRM/Case/Selector/Search.php | 15 ++-- CRM/Case/StateMachine/Search.php | 3 +- CRM/Case/Task.php | 15 ++-- CRM/Case/XMLProcessor/Process.php | 6 +- CRM/Contact/BAO/Contact.php | 63 ++++++++++----- CRM/Contact/BAO/Contact/Location.php | 6 +- CRM/Contact/BAO/Contact/Permission.php | 6 +- CRM/Contact/BAO/Contact/Utils.php | 21 +++-- CRM/Contact/BAO/ContactType.php | 38 ++++++--- CRM/Contact/BAO/Group.php | 26 +++--- CRM/Contact/BAO/GroupContact.php | 24 ++++-- CRM/Contact/BAO/GroupContactCache.php | 15 ++-- CRM/Contact/BAO/Household.php | 3 +- CRM/Contact/BAO/Individual.php | 3 +- CRM/Contact/BAO/Query.php | 18 +++-- CRM/Contact/BAO/Query/Hook.php | 3 +- CRM/Contact/BAO/Relationship.php | 33 +++++--- CRM/Contact/BAO/RelationshipType.php | 3 +- CRM/Contact/BAO/SavedSearch.php | 12 ++- CRM/Contact/BAO/SubscriptionHistory.php | 3 +- CRM/Contact/Form/Contact.php | 9 ++- CRM/Contact/Form/CustomData.php | 3 +- CRM/Contact/Form/DedupeRules.php | 3 +- CRM/Contact/Form/Domain.php | 6 +- CRM/Contact/Form/Inline/Email.php | 2 +- CRM/Contact/Form/Inline/IM.php | 2 +- CRM/Contact/Form/Inline/Lock.php | 3 +- CRM/Contact/Form/Inline/OpenID.php | 2 +- CRM/Contact/Form/Inline/Phone.php | 2 +- CRM/Contact/Form/Merge.php | 3 +- CRM/Contact/Form/Search.php | 3 +- CRM/Contact/Form/Search/Advanced.php | 3 +- CRM/Contact/Form/Search/Basic.php | 3 +- CRM/Contact/Form/Search/Builder.php | 6 +- CRM/Contact/Form/Search/Custom.php | 3 +- CRM/Contact/Form/Search/Custom/FullText.php | 3 +- .../Custom/FullText/AbstractPartialQuery.php | 15 ++-- .../Form/Search/Custom/FullText/Activity.php | 3 +- .../Form/Search/Custom/FullText/Case.php | 3 +- .../Form/Search/Custom/FullText/Contact.php | 3 +- .../Search/Custom/FullText/Contribution.php | 3 +- .../Search/Custom/FullText/Membership.php | 3 +- .../Search/Custom/FullText/Participant.php | 3 +- CRM/Contact/Form/Task/AddToGroup.php | 6 +- CRM/Contact/Form/Task/AlterPreferences.php | 3 +- CRM/Contact/Form/Task/Label.php | 3 +- CRM/Contact/Form/Task/LabelCommon.php | 6 +- CRM/Contact/Form/Task/Map.php | 3 +- CRM/Contact/Form/Task/PickProfile.php | 3 +- CRM/Contact/Form/Task/ProximityCommon.php | 3 +- CRM/Contact/Form/Task/RemoveFromGroup.php | 3 +- CRM/Contact/Import/Form/DataSource.php | 3 +- CRM/Contact/Import/Form/MapField.php | 3 +- CRM/Contact/Import/Form/Preview.php | 3 +- CRM/Contact/Import/Parser.php | 3 +- CRM/Contact/Import/Parser/Contact.php | 9 ++- CRM/Contact/Page/DedupeFind.php | 15 ++-- CRM/Contact/Page/DedupeRules.php | 15 ++-- CRM/Contact/Page/SavedSearch.php | 3 +- CRM/Contact/Page/Task.php | 3 +- CRM/Contact/Page/View.php | 3 +- CRM/Contact/Page/View/Note.php | 6 +- CRM/Contact/Page/View/Relationship.php | 3 +- CRM/Contact/Page/View/UserDashBoard.php | 3 +- CRM/Contact/Selector.php | 17 ++-- CRM/Contact/Selector/Controller.php | 3 +- CRM/Contact/Selector/Custom.php | 15 ++-- CRM/Contact/StateMachine/Search.php | 3 +- CRM/Contact/Task.php | 9 ++- CRM/Contribute/BAO/Contribution.php | 26 +++--- CRM/Contribute/BAO/Contribution/Utils.php | 12 ++- CRM/Contribute/BAO/ContributionPage.php | 14 ++-- CRM/Contribute/BAO/ContributionRecur.php | 12 ++- CRM/Contribute/BAO/ContributionSoft.php | 6 +- CRM/Contribute/BAO/ManagePremiums.php | 3 +- CRM/Contribute/BAO/Premium.php | 6 +- CRM/Contribute/BAO/Query.php | 3 +- CRM/Contribute/Form/AbstractEditPayment.php | 3 +- CRM/Contribute/Form/AdditionalPayment.php | 3 +- CRM/Contribute/Form/CancelSubscription.php | 3 +- CRM/Contribute/Form/ContributionPage.php | 3 +- .../Form/ContributionPage/Settings.php | 3 +- CRM/Contribute/Form/SoftCredit.php | 3 +- CRM/Contribute/Form/Task/Invoice.php | 3 +- CRM/Contribute/Form/Task/PDF.php | 3 +- CRM/Contribute/Form/Task/PDFLetter.php | 3 +- CRM/Contribute/Form/Task/PDFLetterCommon.php | 3 +- CRM/Contribute/Form/Task/PickProfile.php | 3 +- CRM/Contribute/Form/Task/Status.php | 3 +- CRM/Contribute/Form/UpdateBilling.php | 3 +- CRM/Contribute/Import/Form/MapField.php | 3 +- CRM/Contribute/Import/Parser.php | 3 +- CRM/Contribute/Import/Parser/Contribution.php | 9 ++- CRM/Contribute/Info.php | 6 +- CRM/Contribute/Page/ManagePremiums.php | 15 ++-- CRM/Contribute/Page/PaymentInfo.php | 3 +- CRM/Contribute/Page/Premium.php | 15 ++-- CRM/Contribute/PseudoConstant.php | 33 +++++--- CRM/Contribute/Selector/Search.php | 15 ++-- CRM/Contribute/StateMachine/Search.php | 3 +- CRM/Contribute/Task.php | 12 ++- CRM/Core/Action.php | 21 +++-- CRM/Core/BAO/ActionSchedule.php | 9 ++- CRM/Core/BAO/Address.php | 26 +++--- CRM/Core/BAO/Block.php | 18 +++-- CRM/Core/BAO/CMSUser.php | 3 +- CRM/Core/BAO/Cache.php | 6 +- CRM/Core/BAO/ConfigSetting.php | 8 +- CRM/Core/BAO/CustomField.php | 27 ++++--- CRM/Core/BAO/CustomGroup.php | 37 ++++++--- CRM/Core/BAO/CustomOption.php | 6 +- CRM/Core/BAO/CustomQuery.php | 3 +- CRM/Core/BAO/CustomValue.php | 3 +- CRM/Core/BAO/CustomValueTable.php | 3 +- CRM/Core/BAO/Dashboard.php | 18 +++-- CRM/Core/BAO/Discount.php | 9 ++- CRM/Core/BAO/Domain.php | 12 ++- CRM/Core/BAO/Email.php | 12 ++- CRM/Core/BAO/EntityTag.php | 9 ++- CRM/Core/BAO/File.php | 3 +- CRM/Core/BAO/FinancialTrxn.php | 12 ++- CRM/Core/BAO/IM.php | 9 ++- CRM/Core/BAO/Job.php | 3 +- CRM/Core/BAO/LabelFormat.php | 39 ++++++--- CRM/Core/BAO/Location.php | 11 ++- CRM/Core/BAO/LocationType.php | 6 +- CRM/Core/BAO/Log.php | 6 +- CRM/Core/BAO/MailSettings.php | 12 ++- CRM/Core/BAO/Mapping.php | 21 +++-- CRM/Core/BAO/MessageTemplate.php | 6 +- CRM/Core/BAO/Navigation.php | 24 ++++-- CRM/Core/BAO/Note.php | 33 +++++--- CRM/Core/BAO/OpenID.php | 6 +- CRM/Core/BAO/OptionGroup.php | 6 +- CRM/Core/BAO/OptionValue.php | 18 +++-- CRM/Core/BAO/PaperSize.php | 21 +++-- CRM/Core/BAO/PdfFormat.php | 24 ++++-- CRM/Core/BAO/Phone.php | 12 ++- CRM/Core/BAO/PreferencesDate.php | 3 +- CRM/Core/BAO/RecurringEntity.php | 21 +++-- CRM/Core/BAO/Setting.php | 9 ++- CRM/Core/BAO/Tag.php | 12 ++- CRM/Core/BAO/UFField.php | 25 +++--- CRM/Core/BAO/UFGroup.php | 80 ++++++++++++------- CRM/Core/BAO/UFJoin.php | 6 +- CRM/Core/BAO/UFMatch.php | 15 ++-- CRM/Core/BAO/Website.php | 6 +- CRM/Core/BAO/WordReplacement.php | 3 +- CRM/Core/Block.php | 6 +- CRM/Core/CodeGen/Main.php | 3 +- CRM/Core/CodeGen/Util/File.php | 3 +- CRM/Core/Component/Config.php | 3 +- CRM/Core/Component/Info.php | 30 ++++--- CRM/Core/Controller.php | 12 ++- CRM/Core/DAO.php | 66 ++++++++++----- CRM/Core/DAO/permissions.php | 3 +- CRM/Core/Error.php | 21 +++-- CRM/Core/FileSearchInterface.php | 3 +- CRM/Core/Form.php | 6 +- CRM/Core/Form/Date.php | 3 +- CRM/Core/Form/RecurringEntity.php | 3 +- CRM/Core/HTMLInputCoder.php | 3 +- CRM/Core/I18n.php | 24 ++++-- CRM/Core/I18n/Form.php | 3 +- CRM/Core/I18n/Schema.php | 9 ++- CRM/Core/IDS.php | 3 +- CRM/Core/InnoDBIndexer.php | 9 ++- CRM/Core/JobManager.php | 3 +- CRM/Core/Key.php | 9 ++- CRM/Core/ManagedEntities.php | 6 +- CRM/Core/Menu.php | 3 +- CRM/Core/OptionGroup.php | 12 ++- CRM/Core/OptionValue.php | 12 ++- CRM/Core/Page.php | 6 +- CRM/Core/Page/Angular.php | 6 +- CRM/Core/Page/Basic.php | 6 +- CRM/Core/Page/Redirect.php | 3 +- CRM/Core/Payment.php | 12 ++- CRM/Core/Payment/AuthorizeNet.php | 24 ++++-- CRM/Core/Payment/Dummy.php | 6 +- CRM/Core/Payment/Elavon.php | 3 +- CRM/Core/Payment/FirstData.php | 3 +- CRM/Core/Payment/Google.php | 6 +- CRM/Core/Payment/GoogleIPN.php | 3 +- CRM/Core/Payment/IATS.php | 6 +- CRM/Core/Payment/Moneris.php | 6 +- CRM/Core/Payment/PayJunction.php | 9 ++- CRM/Core/Payment/PayPalImpl.php | 15 ++-- CRM/Core/Payment/PayflowPro.php | 9 ++- CRM/Core/Payment/PaymentExpress.php | 6 +- CRM/Core/Payment/PaymentExpressIPN.php | 3 +- CRM/Core/Payment/Realex.php | 15 ++-- CRM/Core/Payment/eWAY.php | 3 +- CRM/Core/Permission.php | 21 +++-- CRM/Core/Permission/Base.php | 33 +++++--- CRM/Core/Permission/Drupal.php | 9 ++- CRM/Core/Permission/Drupal6.php | 15 ++-- CRM/Core/Permission/DrupalBase.php | 15 ++-- CRM/Core/Permission/Joomla.php | 6 +- CRM/Core/Permission/Soap.php | 3 +- CRM/Core/Permission/UnitTests.php | 6 +- CRM/Core/Permission/WordPress.php | 3 +- CRM/Core/PseudoConstant.php | 69 ++++++++++------ CRM/Core/Reference/Interface.php | 3 +- CRM/Core/Resources.php | 9 ++- CRM/Core/SelectValues.php | 12 ++- CRM/Core/Selector/API.php | 15 ++-- CRM/Core/Selector/Base.php | 9 ++- CRM/Core/Selector/Controller.php | 15 ++-- CRM/Core/Session.php | 9 ++- CRM/Core/ShowHideBlocks.php | 3 +- CRM/Core/Smarty/plugins/block.edit.php | 3 +- CRM/Core/Smarty/plugins/block.htxt.php | 3 +- CRM/Core/Smarty/plugins/block.localize.php | 3 +- CRM/Core/Smarty/plugins/block.serialize.php | 3 +- CRM/Core/Smarty/plugins/block.ts.php | 3 +- CRM/Core/Smarty/plugins/function.crmKey.php | 3 +- .../plugins/function.crmNavigationMenu.php | 3 +- CRM/Core/Smarty/plugins/function.docURL.php | 3 +- CRM/Core/Smarty/plugins/function.help.php | 3 +- .../Smarty/plugins/function.sectionTotal.php | 3 +- .../Smarty/plugins/modifier.crmAddClass.php | 3 +- .../Smarty/plugins/modifier.crmBtnType.php | 3 +- CRM/Core/Smarty/plugins/modifier.crmDate.php | 3 +- .../Smarty/plugins/modifier.crmDelete.php | 3 +- .../Smarty/plugins/modifier.crmICalDate.php | 3 +- .../Smarty/plugins/modifier.crmICalText.php | 3 +- .../Smarty/plugins/modifier.crmInsert.php | 3 +- CRM/Core/Smarty/plugins/modifier.crmMoney.php | 3 +- .../plugins/modifier.crmNumberFormat.php | 3 +- .../Smarty/plugins/modifier.crmReplace.php | 3 +- .../plugins/modifier.crmStripAlternatives.php | 3 +- CRM/Core/Smarty/plugins/modifier.htmlize.php | 3 +- CRM/Core/Smarty/plugins/modifier.json.php | 3 +- CRM/Core/StateMachine.php | 9 ++- CRM/Custom/Form/Field.php | 6 +- CRM/Custom/Form/Group.php | 6 +- CRM/Custom/Form/Option.php | 6 +- CRM/Custom/Form/Preview.php | 3 +- CRM/Custom/Import/Form/MapField.php | 3 +- CRM/Custom/Import/Parser.php | 3 +- CRM/Custom/Import/Parser/Api.php | 11 ++- CRM/Custom/Page/Field.php | 3 +- CRM/Custom/Page/Group.php | 3 +- CRM/Custom/Page/Option.php | 3 +- CRM/Dedupe/BAO/Rule.php | 3 +- CRM/Dedupe/BAO/RuleGroup.php | 9 ++- CRM/Dedupe/Finder.php | 15 ++-- CRM/Dedupe/Merger.php | 3 +- CRM/Event/BAO/Event.php | 35 +++++--- CRM/Event/BAO/Participant.php | 30 ++++--- CRM/Event/BAO/ParticipantPayment.php | 6 +- CRM/Event/Form/ManageEvent/EventInfo.php | 6 +- CRM/Event/Form/ManageEvent/Fee.php | 3 +- CRM/Event/Form/ManageEvent/Location.php | 3 +- CRM/Event/Form/ManageEvent/Registration.php | 3 +- CRM/Event/Form/Participant.php | 3 +- CRM/Event/Form/Registration.php | 6 +- .../Registration/AdditionalParticipant.php | 3 +- CRM/Event/Form/Search.php | 3 +- CRM/Event/Form/Task/AddToGroup.php | 6 +- CRM/Event/Form/Task/PickProfile.php | 3 +- CRM/Event/Import/Form/MapField.php | 3 +- CRM/Event/Import/Parser.php | 3 +- CRM/Event/Import/Parser/Participant.php | 9 ++- CRM/Event/Page/ManageEvent.php | 6 +- CRM/Event/PseudoConstant.php | 24 ++++-- CRM/Event/Selector/Search.php | 15 ++-- CRM/Event/StateMachine/Search.php | 3 +- CRM/Event/Task.php | 15 ++-- CRM/Export/BAO/Export.php | 3 +- CRM/Export/Form/Map.php | 3 +- CRM/Extension/Browser.php | 3 +- CRM/Extension/Container/Collection.php | 3 +- CRM/Extension/Downloader.php | 9 ++- CRM/Extension/Manager.php | 12 ++- CRM/Extension/Manager/Payment.php | 3 +- CRM/Extension/Mapper.php | 39 ++++++--- CRM/Financial/BAO/FinancialAccount.php | 6 +- CRM/Financial/BAO/FinancialType.php | 6 +- CRM/Financial/BAO/PaymentProcessor.php | 18 +++-- CRM/Financial/BAO/PaymentProcessorType.php | 6 +- CRM/Financial/Form/FinancialAccount.php | 3 +- CRM/Financial/Form/FinancialBatch.php | 6 +- CRM/Financial/Form/FinancialTypeAccount.php | 3 +- CRM/Financial/Page/Batch.php | 15 ++-- CRM/Financial/Page/BatchTransaction.php | 15 ++-- CRM/Financial/Page/FinancialAccount.php | 15 ++-- CRM/Financial/Page/FinancialBatch.php | 15 ++-- CRM/Financial/Page/FinancialType.php | 15 ++-- CRM/Financial/Page/FinancialTypeAccount.php | 6 +- CRM/Friend/BAO/Friend.php | 3 +- CRM/Grant/BAO/Grant.php | 15 ++-- CRM/Grant/Form/Search.php | 3 +- CRM/Grant/Selector/Search.php | 15 ++-- CRM/Grant/StateMachine/Search.php | 3 +- CRM/Grant/Task.php | 12 ++- CRM/Group/Form/Edit.php | 6 +- CRM/Group/Page/Group.php | 6 +- CRM/Import/DataSource.php | 6 +- CRM/Import/DataSource/CSV.php | 9 ++- CRM/Import/DataSource/SQL.php | 6 +- CRM/Import/Parser.php | 3 +- CRM/Mailing/BAO/BouncePattern.php | 3 +- CRM/Mailing/BAO/Component.php | 3 +- CRM/Mailing/BAO/Mailing.php | 51 ++++++++---- CRM/Mailing/BAO/MailingAB.php | 3 +- CRM/Mailing/BAO/MailingJob.php | 6 +- CRM/Mailing/BAO/TrackableURL.php | 3 +- CRM/Mailing/Event/BAO/Bounce.php | 6 +- CRM/Mailing/Event/BAO/Confirm.php | 3 +- CRM/Mailing/Event/BAO/Delivered.php | 6 +- CRM/Mailing/Event/BAO/Forward.php | 6 +- CRM/Mailing/Event/BAO/Opened.php | 12 ++- CRM/Mailing/Event/BAO/Queue.php | 15 ++-- CRM/Mailing/Event/BAO/Reply.php | 6 +- CRM/Mailing/Event/BAO/Subscribe.php | 6 +- CRM/Mailing/Event/BAO/TrackableURLOpen.php | 15 ++-- CRM/Mailing/Event/BAO/Unsubscribe.php | 9 ++- CRM/Mailing/Form/Group.php | 3 +- CRM/Mailing/Form/Schedule.php | 3 +- CRM/Mailing/Form/Test.php | 3 +- CRM/Mailing/MailStore.php | 12 ++- CRM/Mailing/MailStore/Localdir.php | 3 +- CRM/Mailing/MailStore/Maildir.php | 3 +- CRM/Mailing/Page/Component.php | 15 ++-- CRM/Mailing/Page/Report.php | 6 +- CRM/Mailing/PseudoConstant.php | 12 ++- CRM/Mailing/Selector/Browse.php | 12 ++- CRM/Mailing/Selector/Event.php | 12 ++- CRM/Mailing/Selector/Search.php | 15 ++-- CRM/Mailing/Task.php | 12 ++- CRM/Member/BAO/Membership.php | 41 ++++++---- CRM/Member/BAO/MembershipStatus.php | 3 +- CRM/Member/BAO/MembershipType.php | 18 +++-- CRM/Member/Form.php | 3 +- CRM/Member/Form/Membership.php | 3 +- CRM/Member/Form/MembershipConfig.php | 3 +- CRM/Member/Form/MembershipView.php | 3 +- CRM/Member/Form/Task/Label.php | 3 +- CRM/Member/Form/Task/PickProfile.php | 3 +- CRM/Member/Import/Form/MapField.php | 3 +- CRM/Member/Import/Parser.php | 3 +- CRM/Member/Import/Parser/Membership.php | 12 ++- CRM/Member/Info.php | 3 +- CRM/Member/Page/MembershipStatus.php | 15 ++-- CRM/Member/Page/MembershipType.php | 3 +- CRM/Member/Page/Tab.php | 9 ++- CRM/Member/PseudoConstant.php | 6 +- CRM/Member/Selector/Search.php | 15 ++-- CRM/Member/StateMachine/Search.php | 3 +- CRM/Member/Task.php | 12 ++- CRM/PCP/BAO/PCP.php | 8 +- CRM/PCP/Form/PCP.php | 6 +- CRM/PCP/Page/PCP.php | 15 ++-- CRM/Pledge/BAO/Pledge.php | 33 +++++--- CRM/Pledge/BAO/PledgePayment.php | 18 +++-- CRM/Pledge/Form/Search.php | 3 +- CRM/Pledge/Info.php | 3 +- CRM/Pledge/Selector/Search.php | 15 ++-- CRM/Pledge/StateMachine/Search.php | 3 +- CRM/Pledge/Task.php | 15 ++-- CRM/Price/BAO/LineItem.php | 3 +- CRM/Price/BAO/PriceField.php | 12 ++- CRM/Price/BAO/PriceFieldValue.php | 8 +- CRM/Price/BAO/PriceSet.php | 32 +++++--- CRM/Price/Form/Field.php | 6 +- CRM/Price/Form/Option.php | 6 +- CRM/Price/Form/Preview.php | 3 +- CRM/Price/Form/Set.php | 3 +- CRM/Price/Page/Field.php | 3 +- CRM/Price/Page/Option.php | 3 +- CRM/Price/Page/Set.php | 3 +- CRM/Profile/Form/Edit.php | 3 +- CRM/Profile/Form/Search.php | 3 +- CRM/Profile/Page/Dynamic.php | 2 +- .../Page/MultipleRecordFieldsListing.php | 15 ++-- CRM/Profile/Selector/Listings.php | 12 ++- CRM/Queue/BAO/QueueItem.php | 3 +- CRM/Queue/Queue.php | 6 +- CRM/Report/BAO/Hook.php | 3 +- CRM/Report/Form.php | 14 ++-- CRM/Report/Form/Activity.php | 3 +- CRM/Report/Form/Extended.php | 6 +- CRM/Report/Form/Register.php | 3 +- CRM/Report/Info.php | 3 +- CRM/Report/Page/InstanceList.php | 2 +- CRM/Report/Page/Options.php | 15 ++-- CRM/Report/Utils/Report.php | 6 +- CRM/SMS/Form/Group.php | 3 +- CRM/SMS/Form/Provider.php | 3 +- CRM/SMS/Form/Schedule.php | 3 +- CRM/SMS/Page/Provider.php | 15 ++-- CRM/UF/Form/AbstractPreview.php | 3 +- CRM/UF/Form/Field.php | 9 ++- CRM/UF/Page/Field.php | 2 +- CRM/UF/Page/Group.php | 2 +- CRM/UF/Page/ProfileEditor.php | 3 +- CRM/Upgrade/Incremental/php/FourFive.php | 6 +- CRM/Upgrade/Incremental/php/FourFour.php | 15 ++-- CRM/Upgrade/Incremental/php/FourThree.php | 9 ++- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 9 ++- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 8 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 3 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 29 ++++--- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 6 +- CRM/Utils/API/AbstractFieldCoder.php | 3 +- CRM/Utils/API/MatchOption.php | 6 +- CRM/Utils/Address.php | 3 +- CRM/Utils/Array.php | 3 +- CRM/Utils/Check.php | 3 +- CRM/Utils/Check/Security.php | 12 ++- CRM/Utils/Date.php | 50 ++++++++---- CRM/Utils/DeprecatedUtils.php | 9 ++- CRM/Utils/File.php | 15 ++-- CRM/Utils/Geocode/Google.php | 3 +- CRM/Utils/Geocode/Yahoo.php | 3 +- CRM/Utils/GlobalStack.php | 3 +- CRM/Utils/Hook.php | 45 +++++++---- CRM/Utils/HttpClient.php | 9 ++- CRM/Utils/JS.php | 3 +- CRM/Utils/JSON.php | 3 +- CRM/Utils/Mail.php | 11 ++- CRM/Utils/Mail/EmailProcessor.php | 3 +- CRM/Utils/Migrate/Export.php | 12 ++- CRM/Utils/Money.php | 3 +- CRM/Utils/Network.php | 3 +- CRM/Utils/OpenFlashChart.php | 9 ++- CRM/Utils/OptionBag.php | 6 +- CRM/Utils/Pager.php | 9 ++- CRM/Utils/PagerAToZ.php | 12 ++- CRM/Utils/PseudoConstant.php | 12 ++- CRM/Utils/REST.php | 2 +- CRM/Utils/Recent.php | 3 +- CRM/Utils/Rule.php | 21 +++-- CRM/Utils/SQL/Insert.php | 6 +- CRM/Utils/SQL/Select.php | 9 ++- CRM/Utils/SoapServer.php | 5 +- CRM/Utils/Sort.php | 15 ++-- CRM/Utils/String.php | 48 +++++++---- CRM/Utils/System.php | 15 ++-- CRM/Utils/System/Base.php | 15 ++-- CRM/Utils/System/Drupal.php | 38 ++++++--- CRM/Utils/System/Drupal6.php | 41 ++++++---- CRM/Utils/System/Drupal8.php | 21 +++-- CRM/Utils/System/DrupalBase.php | 27 ++++--- CRM/Utils/System/Joomla.php | 38 ++++++--- CRM/Utils/System/Soap.php | 18 +++-- CRM/Utils/System/UnitTests.php | 18 +++-- CRM/Utils/System/WordPress.php | 38 ++++++--- CRM/Utils/Token.php | 78 ++++++++++++------ CRM/Utils/Tree.php | 3 +- CRM/Utils/Verp.php | 6 +- CRM/Utils/Wrapper.php | 3 +- CRM/Utils/XML.php | 6 +- CRM/Utils/Zip.php | 3 +- Civi/API/Kernel.php | 3 +- Civi/API/Provider/ProviderInterface.php | 3 +- Civi/API/Request.php | 3 +- .../API/Subscriber/DynamicFKAuthorization.php | 3 +- Civi/API/Subscriber/TransactionSubscriber.php | 3 +- Civi/CCase/Analyzer.php | 6 +- Civi/CiUtil/CSVParser.php | 3 +- Civi/CiUtil/EnvTestRunner.php | 3 +- Civi/CiUtil/JenkinsParser.php | 3 +- Civi/CiUtil/PHPUnitParser.php | 3 +- Civi/CiUtil/PHPUnitScanner.php | 6 +- Civi/Install/Requirements.php | 3 +- api/api.php | 8 +- api/v3/Acl.php | 9 ++- api/v3/AclRole.php | 9 ++- api/v3/ActionSchedule.php | 3 +- api/v3/Activity.php | 9 ++- api/v3/ActivityContact.php | 9 ++- api/v3/ActivityType.php | 12 ++- api/v3/Address.php | 9 ++- api/v3/Attachment.php | 12 ++- api/v3/Batch.php | 9 ++- api/v3/Campaign.php | 9 ++- api/v3/Case.php | 18 +++-- api/v3/CaseType.php | 9 ++- api/v3/Constant.php | 3 +- api/v3/Contact.php | 15 ++-- api/v3/ContactType.php | 9 ++- api/v3/Contribution.php | 18 +++-- api/v3/ContributionPage.php | 12 ++- api/v3/ContributionRecur.php | 12 ++- api/v3/ContributionSoft.php | 9 ++- api/v3/Country.php | 9 ++- api/v3/CustomField.php | 3 +- api/v3/CustomGroup.php | 3 +- api/v3/CustomSearch.php | 9 ++- api/v3/CustomValue.php | 3 +- api/v3/Dashboard.php | 3 +- api/v3/Email.php | 9 ++- api/v3/Entity.php | 3 +- api/v3/EntityTag.php | 3 +- api/v3/Event.php | 9 ++- api/v3/Extension.php | 27 ++++--- api/v3/File.php | 12 ++- api/v3/FinancialAccount.php | 9 ++- api/v3/FinancialType.php | 9 ++- api/v3/Generic.php | 21 +++-- api/v3/Grant.php | 9 ++- api/v3/Group.php | 9 ++- api/v3/GroupContact.php | 12 ++- api/v3/GroupNesting.php | 9 ++- api/v3/GroupOrganization.php | 6 +- api/v3/Im.php | 9 ++- api/v3/Job.php | 39 ++++++--- api/v3/LineItem.php | 9 ++- api/v3/LocBlock.php | 9 ++- api/v3/LocationType.php | 9 ++- api/v3/MailSettings.php | 9 ++- api/v3/Mailing.php | 9 ++- api/v3/MailingAB.php | 6 +- api/v3/MailingComponent.php | 9 ++- api/v3/MailingContact.php | 6 +- api/v3/MailingEventConfirm.php | 3 +- api/v3/MailingEventQueue.php | 3 +- api/v3/MailingEventResubscribe.php | 3 +- api/v3/MailingEventSubscribe.php | 3 +- api/v3/MailingEventUnsubscribe.php | 3 +- api/v3/MailingGroup.php | 3 +- api/v3/MailingJob.php | 3 +- api/v3/MailingRecipients.php | 3 +- api/v3/Membership.php | 15 ++-- api/v3/MembershipBlock.php | 9 ++- api/v3/MembershipPayment.php | 6 +- api/v3/MembershipStatus.php | 15 ++-- api/v3/MembershipType.php | 9 ++- api/v3/MessageTemplate.php | 6 +- api/v3/Note.php | 9 ++- api/v3/OptionGroup.php | 6 +- api/v3/OptionValue.php | 9 ++- api/v3/Participant.php | 6 +- api/v3/ParticipantPayment.php | 9 ++- api/v3/ParticipantStatusType.php | 9 ++- api/v3/PaymentProcessor.php | 9 ++- api/v3/PaymentProcessorType.php | 3 +- api/v3/Phone.php | 6 +- api/v3/Phone/Get.php | 3 +- api/v3/Pledge.php | 9 ++- api/v3/PledgePayment.php | 12 ++- api/v3/Premium.php | 9 ++- api/v3/PriceField.php | 9 ++- api/v3/PriceFieldValue.php | 9 ++- api/v3/PriceSet.php | 9 ++- api/v3/PrintLabel.php | 9 ++- api/v3/Product.php | 9 ++- api/v3/Profile.php | 12 ++- api/v3/Relationship.php | 9 ++- api/v3/RelationshipType.php | 3 +- api/v3/ReportInstance.php | 9 ++- api/v3/ReportTemplate.php | 15 ++-- api/v3/Setting.php | 9 ++- api/v3/SmsProvider.php | 9 ++- api/v3/Survey.php | 9 ++- api/v3/SurveyRespondant.php | 6 +- api/v3/System.php | 6 +- api/v3/Tag.php | 9 ++- api/v3/UFField.php | 9 ++- api/v3/UFGroup.php | 6 +- api/v3/UFJoin.php | 6 +- api/v3/UFMatch.php | 8 +- api/v3/Website.php | 9 ++- api/v3/WordReplacement.php | 3 +- api/v3/utils.php | 19 +++-- .../main.php | 3 +- tests/phpunit/CRM/Core/BAO/UFFieldTest.php | 3 +- .../CRM/Core/Payment/PayPalProIPNTest.php | 6 +- .../phpunit/CRM/Core/Permission/BaseTest.php | 3 +- .../CRM/Core/Permission/GenericTest.php | 3 +- .../CRM/Core/Permission/JoomlaTest.php | 3 +- tests/phpunit/CRM/Core/TransactionTest.php | 6 +- tests/phpunit/CRM/Utils/versionCheckTest.php | 6 +- tests/phpunit/CiviTest/AuthorizeNet.php | 3 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 9 ++- tests/phpunit/CiviTest/CiviUnitTestCase.php | 66 +++++++++------ tests/phpunit/CiviTest/Contact.php | 9 ++- tests/phpunit/CiviTest/ContributionPage.php | 3 +- tests/phpunit/CiviTest/Custom.php | 9 ++- tests/phpunit/CiviTest/Event.php | 3 +- tests/phpunit/CiviTest/PCP.php | 6 +- tests/phpunit/CiviTest/Participant.php | 3 +- tests/phpunit/CiviTest/PaypalPro.php | 6 +- .../UpdatePendingContributionTest.php | 3 +- .../Export/ExportCiviSeleniumTestCase.php | 3 +- .../Import/ImportCiviSeleniumTestCase.php | 6 +- .../WebTest/Import/MatchExternalIdTest.php | 6 +- .../WebTest/Import/ParticipantTest.php | 3 +- tests/phpunit/api/v3/APIStandardsTest.php | 5 +- .../phpunit/api/v3/SyntaxConformanceTest.php | 6 +- tests/phpunit/api/v3/UtilsTest.php | 3 +- 678 files changed, 4169 insertions(+), 2114 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index 03b700bbd9..271352fafb 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -54,7 +54,8 @@ class CRM_ACL_API { * @param int $contactID * The contactID for whom the check is made. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public static function check($str, $contactID = NULL) { @@ -88,7 +89,8 @@ class CRM_ACL_API { * Don't add delete clause if this is true,. * this means it is handled by generating query * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public static function whereClause( $type, @@ -153,7 +155,8 @@ class CRM_ACL_API { * @param null $allGroups * @param null $includedGroups * - * @return array the ids of the groups for which the user has permissions + * @return array + * the ids of the groups for which the user has permissions */ public static function group( $type, @@ -189,7 +192,8 @@ class CRM_ACL_API { * @param null $includedGroups * @param bool $flush * - * @return array the ids of the groups for which the user has permissions + * @return array + * the ids of the groups for which the user has permissions */ public static function groupPermission( $type, diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index ff64129ec5..042c2113ea 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -105,7 +105,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param bool $acl_role * For grant operations, this flag determines if we're granting a single acl (false) or an entire group. * - * @return string - The WHERE clause, or 0 on failure + * @return string + * The WHERE clause, or 0 on failure * @static */ public static function permissionClause( @@ -359,7 +360,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param bool $hideEmpty * Only return elements that have a value set. * - * @return array - Assoc. array of the ACL rule's properties + * @return array + * Assoc. array of the ACL rule's properties */ public function toArray($format = '%s', $hideEmpty = FALSE) { $result = array(); @@ -388,7 +390,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param bool $aclRoles * Should we include ACL Roles. * - * @return array - Array of assoc. arrays of ACL rules + * @return array + * Array of assoc. arrays of ACL rules * @static */ public static function &getACLs($contact_id = NULL, $group_id = NULL, $aclRoles = FALSE) { @@ -453,7 +456,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param int $group_id * ID of a group to search for. * - * @return array - Array of assoc. arrays of ACL rules + * @return array + * Array of assoc. arrays of ACL rules * @static */ public static function &getACLRoles($contact_id = NULL, $group_id = NULL) { @@ -519,7 +523,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param bool $aclRoles * Include ACL Roles?. * - * @return array - Assoc array of ACL rules + * @return array + * Assoc array of ACL rules * @static */ public static function &getGroupACLs($contact_id, $aclRoles = FALSE) { @@ -563,7 +568,8 @@ SELECT $acl.* * @param int $contact_id * ID of a contact to search for. * - * @return array - Array of assoc. arrays of ACL rules + * @return array + * Array of assoc. arrays of ACL rules * @static */ public static function &getGroupACLRoles($contact_id) { @@ -635,7 +641,8 @@ SELECT $acl.* * @param int $contact_id * The contact ID. * - * @return array - Assoc array of ACL rules + * @return array + * Assoc array of ACL rules * @static */ public static function &getAllByContact($contact_id) { @@ -678,7 +685,8 @@ SELECT $acl.* * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index ffc2c2116e..40778c736c 100644 --- a/CRM/ACL/BAO/EntityRole.php +++ b/CRM/ACL/BAO/EntityRole.php @@ -80,7 +80,8 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/ACL/Form/WordPress/Permissions.php b/CRM/ACL/Form/WordPress/Permissions.php index a6abf1bb46..230d215e08 100644 --- a/CRM/ACL/Form/WordPress/Permissions.php +++ b/CRM/ACL/Form/WordPress/Permissions.php @@ -170,7 +170,8 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { * This function should be shared from a similar one in * distmaker/utils/joomlaxml.php * - * @return array civicrm permissions + * @return array + * civicrm permissions */ public static function getPermissionArray() { global $civicrm_root; diff --git a/CRM/ACL/Page/ACL.php b/CRM/ACL/Page/ACL.php index aaa149e23a..a104ee761d 100644 --- a/CRM/ACL/Page/ACL.php +++ b/CRM/ACL/Page/ACL.php @@ -55,7 +55,8 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_ACL_BAO_ACL'; @@ -64,7 +65,8 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -255,7 +257,8 @@ ORDER BY entity_id /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_ACL_Form_ACL'; @@ -264,7 +267,8 @@ ORDER BY entity_id /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'ACL'; @@ -275,7 +279,8 @@ ORDER BY entity_id * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/acl'; diff --git a/CRM/ACL/Page/ACLBasic.php b/CRM/ACL/Page/ACLBasic.php index afb403ebf8..2f0a4b1d15 100644 --- a/CRM/ACL/Page/ACLBasic.php +++ b/CRM/ACL/Page/ACLBasic.php @@ -53,7 +53,8 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_ACL_BAO_ACL'; @@ -62,7 +63,8 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -189,7 +191,8 @@ ORDER BY entity_id /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_ACL_Form_ACLBasic'; @@ -198,7 +201,8 @@ ORDER BY entity_id /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Core ACLs'; @@ -209,7 +213,8 @@ ORDER BY entity_id * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/acl/basic'; diff --git a/CRM/ACL/Page/EntityRole.php b/CRM/ACL/Page/EntityRole.php index b7a0791a22..4f23c41193 100644 --- a/CRM/ACL/Page/EntityRole.php +++ b/CRM/ACL/Page/EntityRole.php @@ -55,7 +55,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_ACL_BAO_EntityRole'; @@ -64,7 +65,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -196,7 +198,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_ACL_Form_EntityRole'; @@ -205,7 +208,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'ACL EntityRole'; @@ -216,7 +220,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/acl/entityrole'; diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index f52bc92c5f..33c490e752 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -657,7 +657,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { * - context string page on which selector is build * - activity_type_id int|string the activitiy types we want to restrict by * - * @return array (reference) $values the relevant data object values of open activities + * @return array + * (reference) $values the relevant data object values of open activities * * @static */ @@ -906,7 +907,8 @@ ORDER BY fixed_sort_order * user has permission. To decide whether we are going to include * component related activities w/ core activity retrieve process. * - * @return array of component id and name. + * @return array + * of component id and name. * @static **/ public static function activityComponents() { @@ -946,7 +948,8 @@ ORDER BY fixed_sort_order * - context string page on which selector is build * - activity_type_id int|string the activity types we want to restrict by * - * @return int count of activities + * @return int + * count of activities * * @static */ @@ -983,7 +986,8 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a * - count boolean are we interested in the count clause only? * - activity_type_id int|string the activity types we want to restrict by * - * @return int count of activities + * @return int + * count of activities * * @static */ @@ -1176,7 +1180,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @param string $additionalDetails * The additional information of CC and BCC appended to the activity Details. * - * @return array ( sent, activityId) if any email is sent and activityId + * @return array + * ( sent, activityId) if any email is sent and activityId * @static */ static function sendEmail( @@ -1591,7 +1596,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @param null $cc * @param null $bcc * - * @return boolean true if successfull else false. + * @return boolean + * true if successfull else false. * @static */ static function sendMessage( @@ -1663,7 +1669,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * * @param bool $status * - * @return array array of importable Fields + * @return array + * array of importable Fields * @static */ public static function &importableFields($status = FALSE) { @@ -1717,7 +1724,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * @param int $contactId * Id of the contact whose activities need to find. * - * @return array array of activity fields + * @return array + * array of activity fields */ public static function getContactActivity($contactId) { $activities = array(); @@ -1910,7 +1918,8 @@ SELECT display_name * @param int $activityId * Current activity id. * - * @return int $parentId Id of parent activity otherwise false. + * @return int + * $parentId Id of parent activity otherwise false. */ public static function getParentActivity($activityId) { static $parentActivities = array(); @@ -1937,7 +1946,8 @@ SELECT display_name * @param $activityID * Current activity id. * - * @return int $params count of prior activities otherwise false. + * @return int + * $params count of prior activities otherwise false. */ public static function getPriorCount($activityID) { static $priorCounts = array(); @@ -1975,7 +1985,8 @@ AND id < {$activityID} * Current activity id. * @param bool $onlyPriorRevisions * - * @return array $result prior activities info. + * @return array + * prior activities info. */ public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) { static $priorActivities = array(); @@ -2024,7 +2035,8 @@ AND cl.modified_id = c.id * @param int $activityID * Prior activity id. * - * @return int current activity id. + * @return int + * current activity id. */ public static function getLatestActivityId($activityID) { static $latestActivityIds = array(); @@ -2150,7 +2162,8 @@ AND cl.modified_id = c.id * @param string $name * If it is called by case $name = Case else $name = Activity. * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields($name = 'Activity') { @@ -2210,7 +2223,8 @@ AND cl.modified_id = c.id /** * Get the allowed profile fields for Activities * - * @return array array of activity profile Fields + * @return array + * array of activity profile Fields */ public static function getProfileFields() { $exportableFields = self::exportableFields('Activity'); @@ -2298,7 +2312,7 @@ AND cl.modified_id = c.id * @param int $action * Edit/view. * - * @return boolean $allow true/false + * @return boolean */ public static function checkPermission($activityId, $action) { $allow = FALSE; @@ -2448,7 +2462,8 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n * @param array $params * Associated array for params record id. * - * @return array $contactActivities associated array of contact activities + * @return array + * associated array of contact activities */ public static function getContactActivitySelector(&$params) { // format the params diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index 94279db174..f7b3b4d919 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -52,7 +52,8 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object activity type of object that is added + * @return object + * activity type of object that is added */ public static function create(&$params) { $assignment = new CRM_Activity_BAO_ActivityContact(); diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 5f76c47624..b4bf047f12 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -52,7 +52,8 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact * @param array $params * The values for this table: activity id, contact id, record type. * - * @return object activity_contact object + * @return object + * activity_contact object * */ public static function create(&$params) { diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index dba9688d2e..5b20adc245 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -51,7 +51,8 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { * * @param array $params * - * @return object activity type of object that is added + * @return object + * activity type of object that is added */ public static function create(&$params) { $target = new CRM_Activity_BAO_ActivityContact(); diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index 427199eecd..671bd64d98 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -65,7 +65,8 @@ class CRM_Activity_BAO_ICalendar { * @param array $contacts * Array of contacts (attendees). * - * @return string Array index of the added attachment in the $attachments array, or else NULL. + * @return string + * Array index of the added attachment in the $attachments array, or else NULL. */ public function addAttachment(&$attachments, $contacts) { // Check preferences setting diff --git a/CRM/Activity/Form/ActivityFilter.php b/CRM/Activity/Form/ActivityFilter.php index 1bedfa0904..1b9b99bf0e 100644 --- a/CRM/Activity/Form/ActivityFilter.php +++ b/CRM/Activity/Form/ActivityFilter.php @@ -54,7 +54,8 @@ class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** @@ -63,7 +64,8 @@ class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index e9ef39a468..49bcce7e24 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -121,7 +121,8 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index 8230af89b2..cfb9adbd53 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/Form/Task/PickProfile.php @@ -149,7 +149,8 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index 7ee9c42ce3..87baedbc39 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -268,7 +268,8 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 3bc0feb1be..259cfa25ae 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -296,7 +296,8 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php index bdd45567e0..31e25b906c 100644 --- a/CRM/Activity/Import/Parser/Activity.php +++ b/CRM/Activity/Import/Parser/Activity.php @@ -144,7 +144,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -156,7 +157,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function summary(&$values) { $erroneousField = NULL; @@ -240,7 +242,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values) { // first make sure this is a valid line diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 37db986ac4..be0e34ba57 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -308,7 +308,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if ($output == CRM_Core_Selector_Controller::EXPORT || $output == CRM_Core_Selector_Controller::SCREEN) { @@ -333,7 +334,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * * @param null $case * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action, $case = NULL) { $params = array( @@ -365,7 +367,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * * @param null $case * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $case = NULL) { $params = array( @@ -486,7 +489,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Activity'); @@ -496,7 +500,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * Get colunmn headers for search selector * * - * @return array $_columnHeaders + * @return array */ private static function &_getColumnHeaders() { if (!isset(self::$_columnHeaders)) { diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 0108556ef0..00c576bbf6 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -209,7 +209,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -234,7 +235,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param enum $output * What should the result set include (web/email/csv). * - * @return array rows in the given offset and rowCount + * @return array + * rows in the given offset and rowCount */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery( @@ -359,7 +361,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ public function getQILL() { return $this->_query->qill(); @@ -374,7 +377,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -434,7 +438,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Activity Search'); diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index aa1dbcf8f1..d9713b8c29 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -74,7 +74,8 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php index 482a0770f2..3b47f1f476 100644 --- a/CRM/Activity/Task.php +++ b/CRM/Activity/Task.php @@ -66,7 +66,8 @@ class CRM_Activity_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -149,7 +150,8 @@ class CRM_Activity_Task { * These tasks are the core set of task titles * on activity * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -167,7 +169,8 @@ class CRM_Activity_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -193,7 +196,8 @@ class CRM_Activity_Task { * * @param int $value * - * @return array the set of tasks for a group of activity + * @return array + * the set of tasks for a group of activity * @static */ public static function getTask($value) { diff --git a/CRM/Admin/Form/MailSettings.php b/CRM/Admin/Form/MailSettings.php index 72ffd4ef07..5b331db125 100644 --- a/CRM/Admin/Form/MailSettings.php +++ b/CRM/Admin/Form/MailSettings.php @@ -107,7 +107,8 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Admin/Form/Options.php b/CRM/Admin/Form/Options.php index 1f03724d38..c2e653bc39 100644 --- a/CRM/Admin/Form/Options.php +++ b/CRM/Admin/Form/Options.php @@ -328,7 +328,8 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { * @param array $self * Current form object. * - * @return array array of errors / empty array. + * @return array + * array of errors / empty array. * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Admin/Form/PreferencesDate.php b/CRM/Admin/Form/PreferencesDate.php index 688681c713..ab904d0ecc 100644 --- a/CRM/Admin/Form/PreferencesDate.php +++ b/CRM/Admin/Form/PreferencesDate.php @@ -93,7 +93,8 @@ class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form { * @param array $fields * Posted values of the form. * - * @return array if errors then list of errors to be posted back to the form, + * @return array + * if errors then list of errors to be posted back to the form, * true otherwise * @static */ diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index 8c87d325ba..943c8a8bdd 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -205,7 +205,8 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Admin/Form/WordReplacements.php b/CRM/Admin/Form/WordReplacements.php index fbe7fe33ba..773eda2ae6 100644 --- a/CRM/Admin/Form/WordReplacements.php +++ b/CRM/Admin/Form/WordReplacements.php @@ -180,7 +180,8 @@ class CRM_Admin_Form_WordReplacements extends CRM_Core_Form { * @param array $values * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values) { diff --git a/CRM/Admin/Page/APIDoc.php b/CRM/Admin/Page/APIDoc.php index 3582ec77f8..5b5e1bdf3a 100644 --- a/CRM/Admin/Page/APIDoc.php +++ b/CRM/Admin/Page/APIDoc.php @@ -58,7 +58,8 @@ class CRM_Admin_Page_APIDoc extends CRM_Core_Page { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/api/doc'; diff --git a/CRM/Admin/Page/APIExplorer.php b/CRM/Admin/Page/APIExplorer.php index 04579650be..c5f4d39287 100644 --- a/CRM/Admin/Page/APIExplorer.php +++ b/CRM/Admin/Page/APIExplorer.php @@ -54,7 +54,8 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { /** * Get user context. * - * @return string user context. + * @return string + * user context. */ public function userContext() { return 'civicrm/api/explorer'; diff --git a/CRM/Admin/Page/ContactType.php b/CRM/Admin/Page/ContactType.php index 2e6d793151..c386824998 100644 --- a/CRM/Admin/Page/ContactType.php +++ b/CRM/Admin/Page/ContactType.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Contact_BAO_ContactType'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -133,7 +135,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_ContactType'; @@ -142,7 +145,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Contact Types'; @@ -153,7 +157,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/options/subtype'; diff --git a/CRM/Admin/Page/EventTemplate.php b/CRM/Admin/Page/EventTemplate.php index 8cc7a7ee3d..5cc3b81cdf 100644 --- a/CRM/Admin/Page/EventTemplate.php +++ b/CRM/Admin/Page/EventTemplate.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Event_BAO_Event'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -143,7 +145,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_EventTemplate'; @@ -152,7 +155,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Event Templates'; @@ -163,7 +167,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/eventTemplate'; diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php index 9f79a50438..c3e63be686 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -65,7 +65,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Extension'; @@ -74,7 +75,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -244,7 +246,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Extensions'; @@ -253,7 +256,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'CRM_Admin_Form_Extensions'; @@ -264,7 +268,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/extensions'; diff --git a/CRM/Admin/Page/Job.php b/CRM/Admin/Page/Job.php index f53dc32e59..b6871555c0 100644 --- a/CRM/Admin/Page/Job.php +++ b/CRM/Admin/Page/Job.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Job'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -190,7 +192,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Job'; @@ -199,7 +202,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Scheduled Jobs'; @@ -210,7 +214,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/job'; diff --git a/CRM/Admin/Page/JobLog.php b/CRM/Admin/Page/JobLog.php index ce697f3ada..1db60cc5b4 100644 --- a/CRM/Admin/Page/JobLog.php +++ b/CRM/Admin/Page/JobLog.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Job'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { return self::$_links; @@ -134,7 +136,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Job'; @@ -143,7 +146,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Scheduled Jobs'; @@ -154,7 +158,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/job'; diff --git a/CRM/Admin/Page/LabelFormats.php b/CRM/Admin/Page/LabelFormats.php index bdc26e9637..9826496bbe 100644 --- a/CRM/Admin/Page/LabelFormats.php +++ b/CRM/Admin/Page/LabelFormats.php @@ -52,7 +52,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_LabelFormat'; @@ -61,7 +62,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -94,7 +96,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_LabelFormats'; @@ -103,7 +106,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Mailing Label Formats'; @@ -114,7 +118,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/labelFormats'; diff --git a/CRM/Admin/Page/LocationType.php b/CRM/Admin/Page/LocationType.php index 285583a8ff..8a22660daa 100644 --- a/CRM/Admin/Page/LocationType.php +++ b/CRM/Admin/Page/LocationType.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_LocationType'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -95,7 +97,8 @@ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_LocationType'; @@ -104,7 +107,8 @@ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Location Types'; @@ -115,7 +119,8 @@ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/locationType'; diff --git a/CRM/Admin/Page/MailSettings.php b/CRM/Admin/Page/MailSettings.php index b9a83aef66..a3f915b7e5 100644 --- a/CRM/Admin/Page/MailSettings.php +++ b/CRM/Admin/Page/MailSettings.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_MailSettings'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -132,7 +134,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_MailSettings'; @@ -141,7 +144,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Mail Settings'; @@ -152,7 +156,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/mailSettings'; diff --git a/CRM/Admin/Page/Mapping.php b/CRM/Admin/Page/Mapping.php index 609cac7fad..068a13a051 100644 --- a/CRM/Admin/Page/Mapping.php +++ b/CRM/Admin/Page/Mapping.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get BAO * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Mapping'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -87,7 +89,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Mapping'; @@ -96,7 +99,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get form name for edit form * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Mapping'; @@ -105,7 +109,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get form name for delete form * - * @return string name of this page. + * @return string + * name of this page. */ public function deleteName() { return 'Mapping'; @@ -116,7 +121,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/mapping'; @@ -125,7 +131,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * Get name of delete form * - * @return string Classname of delete form. + * @return string + * Classname of delete form. */ public function deleteForm() { return 'CRM_Admin_Form_Mapping'; diff --git a/CRM/Admin/Page/MessageTemplates.php b/CRM/Admin/Page/MessageTemplates.php index e7e6cf2d98..5321f75ab4 100644 --- a/CRM/Admin/Page/MessageTemplates.php +++ b/CRM/Admin/Page/MessageTemplates.php @@ -81,7 +81,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_MessageTemplate'; @@ -90,7 +91,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -209,7 +211,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_MessageTemplates'; @@ -218,7 +221,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return ts('Message Template'); @@ -229,7 +233,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/messageTemplates'; diff --git a/CRM/Admin/Page/Navigation.php b/CRM/Admin/Page/Navigation.php index 0063f50b63..ac6ce47fb1 100644 --- a/CRM/Admin/Page/Navigation.php +++ b/CRM/Admin/Page/Navigation.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Navigation'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { } @@ -66,7 +68,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Navigation'; @@ -75,7 +78,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'CiviCRM Navigation'; @@ -86,7 +90,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/menu'; diff --git a/CRM/Admin/Page/Options.php b/CRM/Admin/Page/Options.php index ebbf792b7f..61c601db98 100644 --- a/CRM/Admin/Page/Options.php +++ b/CRM/Admin/Page/Options.php @@ -162,7 +162,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return self::$_gName ? 'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup'; @@ -171,7 +172,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -258,7 +260,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return self::$_gName ? 'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup'; @@ -267,7 +270,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return self::$_gLabel; @@ -278,7 +282,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/options' . (self::$_gName ? '/' . self::$_gName : ''); diff --git a/CRM/Admin/Page/PaymentProcessor.php b/CRM/Admin/Page/PaymentProcessor.php index 0b366fcc7a..ed306ba22a 100644 --- a/CRM/Admin/Page/PaymentProcessor.php +++ b/CRM/Admin/Page/PaymentProcessor.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Financial_BAO_PaymentProcessor'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -167,7 +169,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_PaymentProcessor'; @@ -176,7 +179,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Payment Processors'; @@ -187,7 +191,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/paymentProcessor'; diff --git a/CRM/Admin/Page/PaymentProcessorType.php b/CRM/Admin/Page/PaymentProcessorType.php index 67c06f8348..f6a7e315c4 100644 --- a/CRM/Admin/Page/PaymentProcessorType.php +++ b/CRM/Admin/Page/PaymentProcessorType.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Financial_BAO_PaymentProcessorType'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -93,7 +95,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_PaymentProcessorType'; @@ -102,7 +105,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Payment Processor Type'; @@ -113,7 +117,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/paymentProcessorType'; diff --git a/CRM/Admin/Page/PdfFormats.php b/CRM/Admin/Page/PdfFormats.php index b36a435bb3..261ca0006b 100644 --- a/CRM/Admin/Page/PdfFormats.php +++ b/CRM/Admin/Page/PdfFormats.php @@ -52,7 +52,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_PdfFormat'; @@ -61,7 +62,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -88,7 +90,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_PdfFormats'; @@ -97,7 +100,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'PDF Page Formats'; @@ -108,7 +112,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/pdfFormats'; diff --git a/CRM/Admin/Page/Persistent.php b/CRM/Admin/Page/Persistent.php index 4df76d2b8c..e838a904a4 100644 --- a/CRM/Admin/Page/Persistent.php +++ b/CRM/Admin/Page/Persistent.php @@ -50,7 +50,8 @@ class CRM_Admin_Page_Persistent extends CRM_Core_Page { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ function &stringActionLinks() { // check if variable _actionsLinks is populated diff --git a/CRM/Admin/Page/PreferencesDate.php b/CRM/Admin/Page/PreferencesDate.php index 29c1381d8c..a5640c17cc 100644 --- a/CRM/Admin/Page/PreferencesDate.php +++ b/CRM/Admin/Page/PreferencesDate.php @@ -49,7 +49,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_PreferencesDate'; @@ -58,7 +59,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -93,7 +95,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_PreferencesDate'; @@ -102,7 +105,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Date Preferences'; @@ -113,7 +117,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/setting/preferences/date'; diff --git a/CRM/Admin/Page/RelationshipType.php b/CRM/Admin/Page/RelationshipType.php index 593fcc8c40..928b120917 100644 --- a/CRM/Admin/Page/RelationshipType.php +++ b/CRM/Admin/Page/RelationshipType.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Contact_BAO_RelationshipType'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -101,7 +103,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_RelationshipType'; @@ -110,7 +113,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Relationship Types'; @@ -121,7 +125,8 @@ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/reltype'; diff --git a/CRM/Admin/Page/ScheduleReminders.php b/CRM/Admin/Page/ScheduleReminders.php index e106831d98..1103162059 100644 --- a/CRM/Admin/Page/ScheduleReminders.php +++ b/CRM/Admin/Page/ScheduleReminders.php @@ -52,7 +52,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_ActionSchedule'; @@ -61,7 +62,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -98,7 +100,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_ScheduleReminders'; @@ -107,7 +110,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'ScheduleReminders'; @@ -118,7 +122,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/scheduleReminders'; diff --git a/CRM/Admin/Page/Tag.php b/CRM/Admin/Page/Tag.php index dd817f2d55..f572fe3286 100644 --- a/CRM/Admin/Page/Tag.php +++ b/CRM/Admin/Page/Tag.php @@ -51,7 +51,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get BAO * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_Tag'; @@ -60,7 +61,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -90,7 +92,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Admin_Form_Tag'; @@ -99,7 +102,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get form name for edit form * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Tag'; @@ -108,7 +112,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get form name for delete form * - * @return string name of this page. + * @return string + * name of this page. */ public function deleteName() { return 'Tag'; @@ -119,7 +124,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/tag'; @@ -128,7 +134,8 @@ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { /** * Get name of delete form * - * @return string Classname of delete form. + * @return string + * Classname of delete form. */ public function deleteForm() { return 'CRM_Admin_Form_Tag'; diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index b63f5a2ef9..deb7bd0c42 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -82,7 +82,8 @@ class CRM_Badge_BAO_Badge { * @param array $layout * Layout meta data. * - * @return array $formattedRow row with meta data + * @return array + * row with meta data */ public static function formatLabel(&$row, &$layout) { $formattedRow = array('labelFormat' => $layout['label_format_name']); diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 1f6a867c6a..9d393b524e 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -72,7 +72,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on success, null otherwise + * @return Object + * DAO object on success, null otherwise * * @static */ @@ -139,7 +140,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * get the list of print labels * - * @return array list of labels + * @return array + * list of labels * @static */ public static function getList() { @@ -159,7 +161,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * @param array $params * Associated array of submitted values. * - * @return array $formattedLayout array formatted array + * @return array + * array formatted array */ public static function buildLayout(&$params) { $layoutParams = array('id' => $params['badge_id']); @@ -177,7 +180,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * @param json $jsonData * Json object. * - * @return array associated array of decoded elements + * @return array + * associated array of decoded elements * @static */ static public function getDecodedData($jsonData) { diff --git a/CRM/Badge/Page/Layout.php b/CRM/Badge/Page/Layout.php index 4e49d6a8d9..4402684f52 100644 --- a/CRM/Badge/Page/Layout.php +++ b/CRM/Badge/Page/Layout.php @@ -49,7 +49,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Badge_BAO_Layout'; @@ -58,7 +59,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -93,7 +95,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Badge_Form_Layout'; @@ -102,7 +105,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Badge Layout'; @@ -113,7 +117,8 @@ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/badgelayout'; diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index e97b3c8d85..56194b60bb 100755 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -59,7 +59,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * @param string $context * String. * - * @return object $batch batch object + * @return object + * $batch batch object */ public static function create(&$params, $ids = NULL, $context = NULL) { if (empty($params['id'])) { @@ -84,7 +85,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return array CRM_Batch_BAO_Batch object on success, null otherwise + * @return array + * CRM_Batch_BAO_Batch object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { @@ -103,7 +105,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * @param int $batchTypeId * Batch type id. * - * @return int $profileId profile id + * @return int + * $profileId profile id * @static */ public static function getProfileId($batchTypeId) { @@ -185,7 +188,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * @param array $params * Associated array for params record id. * - * @return array $batchList associated array of batch list + * @return array + * associated array of batch list */ public function getBatchListSelector(&$params) { // format the params @@ -423,7 +427,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * * @param null $context * - * @return array $links array of action links + * @return array + * array of action links */ public function links($context = NULL) { if ($context == 'financialBatch') { @@ -500,7 +505,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Get batch list * - * @return array array of all batches + * @return array + * array of all batches * excluding batches with data entry in progress */ public static function getBatches() { @@ -775,7 +781,8 @@ WHERE {$where} * Get batch names * @param string $batchIds * - * @return array array of batches + * @return array + * array of batches */ public static function getBatchNames($batchIds) { $query = 'SELECT id, title @@ -795,7 +802,8 @@ WHERE {$where} * * @param string $batchIds * - * @return array array of batches + * @return array + * array of batches */ public static function getBatchStatuses($batchIds) { $query = 'SELECT id, status_id diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index d3701e053e..9c72ab1edf 100755 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -268,7 +268,8 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { * @param array $self * Form object. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/Batch/Page/Batch.php b/CRM/Batch/Page/Batch.php index 4684cd5e23..6192585550 100644 --- a/CRM/Batch/Page/Batch.php +++ b/CRM/Batch/Page/Batch.php @@ -49,7 +49,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Batch_BAO_Batch'; @@ -58,7 +59,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { } @@ -66,7 +68,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Batch_Form_Batch'; @@ -75,7 +78,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return ts('Batch Processing'); @@ -86,7 +90,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return CRM_Utils_System::currentPath(); diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 1c8111e743..a2f2aa1d35 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -514,7 +514,8 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 7055ce1550..ec1bca6ded 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -466,7 +466,8 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * @param object $tag * An object of a tag. * - * @return array $contactIds array of contact ids + * @return array + * array of contact ids */ public function getEntitiesByTag($tag) { $contactIds = array(); diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 9b8fbe7596..9ab392da24 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -53,7 +53,8 @@ class CRM_Campaign_BAO_Query { /** * Function get the fields for campaign. * - * @return array self::$_campaignFields an associative array of campaign fields + * @return array + * self::$_campaignFields an associative array of campaign fields * @static */ public static function &getFields() { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index c9c9098941..a241005785 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -387,7 +387,8 @@ SELECT survey.id as id, * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -424,7 +425,8 @@ SELECT survey.id as id, * @param array $returnProperties * An array of return elements. * - * @return array $voterDetails array of contact info. + * @return array + * array of contact info. * @static */ public static function voterDetails($voterIds, $returnProperties = array()) { @@ -518,7 +520,8 @@ Group By contact.id"; * @param int $interviewerId * @param array $statusIds * - * @return array $activityDetails array of survey activity. + * @return array + * array of survey activity. * @static */ static function voterActivityDetails( @@ -722,7 +725,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * This function retrieve all option groups which are created as a result set * * @param string $valueColumnName - * @return array $resultSets an array of option groups. + * @return array + * an array of option groups. * @static */ public static function getResultSets($valueColumnName = 'title') { @@ -743,7 +747,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * * @param int $activityId * Activity id. - * @return boolean $isSurveyActivity true/false + * @return boolean * @static */ public static function isSurveyActivity($activityId) { @@ -772,7 +776,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * * @param int $surveyId * Survey id. - * @return array $responseOptions an array of option values + * @return array + * an array of option values * @static */ public static function getResponsesOptions($surveyId) { @@ -968,7 +973,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * @param int $surveyTypeId * Survey activity type id. * - * @return array an array of valid survey response fields. + * @return array + * an array of valid survey response fields. */ public static function getSurveyResponseFields($surveyId, $surveyTypeId = NULL) { if (empty($surveyId)) { @@ -1035,7 +1041,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * Get all interviewers of surveys. * - * @return array an array of valid survey response fields. + * @return array + * an array of valid survey response fields. */ public static function getInterviewers() { static $interviewers; @@ -1076,7 +1083,8 @@ INNER JOIN civicrm_survey survey ON ( activity.source_record_id = survey.id ) * * @param array $params * - * @return array success message + * @return array + * success message */ public static function releaseRespondent($params) { $activityStatus = CRM_Core_PseudoConstant::activityStatus('name'); diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index e97bde0aac..72d4927fbe 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -125,7 +125,8 @@ class CRM_Campaign_Form_Petition extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = $this->_values; diff --git a/CRM/Campaign/Form/Survey/Main.php b/CRM/Campaign/Form/Survey/Main.php index 2998297539..1164ef1e70 100644 --- a/CRM/Campaign/Form/Survey/Main.php +++ b/CRM/Campaign/Form/Survey/Main.php @@ -106,7 +106,8 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { if ($this->_cdType) { diff --git a/CRM/Campaign/Form/Survey/Questions.php b/CRM/Campaign/Form/Survey/Questions.php index cf8552bdbf..eecf3b19ad 100644 --- a/CRM/Campaign/Form/Survey/Questions.php +++ b/CRM/Campaign/Form/Survey/Questions.php @@ -45,7 +45,8 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index a9ccbaa593..de176da02f 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -79,7 +79,8 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = $this->_values; diff --git a/CRM/Campaign/Form/SurveyType.php b/CRM/Campaign/Form/SurveyType.php index 48c116e2a1..011a0ed6d9 100644 --- a/CRM/Campaign/Form/SurveyType.php +++ b/CRM/Campaign/Form/SurveyType.php @@ -101,7 +101,8 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index 1775bac2d4..caa0fdc875 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -208,7 +208,8 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Campaign/Page/Campaign.php b/CRM/Campaign/Page/Campaign.php index bee0234590..0e231e3dc1 100644 --- a/CRM/Campaign/Page/Campaign.php +++ b/CRM/Campaign/Page/Campaign.php @@ -50,7 +50,7 @@ class CRM_Campaign_Page_Campaign extends CRM_Core_Page { /** * Get the action links for this page. * - * @return array $_actionLinks + * @return array * */ public function &actionLinks() { diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index d1eb133931..fa41b14c73 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -50,7 +50,7 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { /** * Get the action links for this page. * - * @return array $_campaignActionLinks + * @return array * */ public function &campaignActionLinks() { diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index d42b8e0fad..80360a287f 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -103,7 +103,8 @@ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { * @param int $activity_id * @param int $petition_id * - * @return boolean True on success + * @return boolean + * True on success * @static */ public static function confirm($contact_id, $subscribe_id, $hash, $activity_id, $petition_id) { diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index 93b9e4a326..81d12a2b13 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -96,7 +96,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_OptionValue'; @@ -105,7 +106,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -178,7 +180,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Campaign_Form_SurveyType'; @@ -187,7 +190,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return $this->_GName; @@ -198,7 +202,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/campaign/surveyType'; diff --git a/CRM/Campaign/PseudoConstant.php b/CRM/Campaign/PseudoConstant.php index d3ac40c872..fa9dbd47ad 100755 --- a/CRM/Campaign/PseudoConstant.php +++ b/CRM/Campaign/PseudoConstant.php @@ -73,7 +73,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * * @param string $returnColumn * - * @return array - array reference of all survey activity types. + * @return array + * array reference of all survey activity types. * @static */ public static function &activityType($returnColumn = 'name') { @@ -100,7 +101,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * * @static * - * @return array - array reference of all campaign types. + * @return array + * array reference of all campaign types. * */ public static function &campaignType() { @@ -119,7 +121,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * * @static * - * @return array - array reference of all campaign status. + * @return array + * array reference of all campaign status. * */ public static function &campaignStatus() { @@ -138,7 +141,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant { * * @static * - * @return array - array reference of all Engagement Level. + * @return array + * array reference of all Engagement Level. */ public static function &engagementLevel() { if (!isset(self::$engagementLevel)) { diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 5bf7310213..e5ff4c4d5b 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -213,7 +213,8 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -239,7 +240,8 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -309,7 +311,8 @@ FROM {$from} } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings **/ public function getQILL() { return $this->_query->qill(); @@ -324,7 +327,8 @@ FROM {$from} * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { self::$_columnHeaders = array(); @@ -380,7 +384,8 @@ FROM {$from} * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Respondent Search'); diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index c5fd3cfe2b..369c38e79c 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -77,7 +77,8 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Campaign/Task.php b/CRM/Campaign/Task.php index a8a46b6cef..e44f3d85c0 100755 --- a/CRM/Campaign/Task.php +++ b/CRM/Campaign/Task.php @@ -62,7 +62,8 @@ class CRM_Campaign_Task { * These tasks are the core set of tasks that the user can perform * on a voter / group of voters * - * @return array the set of tasks for a group of voters. + * @return array + * the set of tasks for a group of voters. * @static */ public static function &tasks() { @@ -109,7 +110,8 @@ class CRM_Campaign_Task { * These tasks are the core set of task titles * on voters. * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -128,7 +130,8 @@ class CRM_Campaign_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = self::taskTitles(); @@ -142,7 +145,8 @@ class CRM_Campaign_Task { * * @param int $value * - * @return array the set of tasks for a group of voters. + * @return array + * the set of tasks for a group of voters. * @static */ public static function getTask($value) { diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 35cdd7504e..aa9ce51c02 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -310,7 +310,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param int $caseId * @param string $colName * - * @return string case type + * @return string + * case type * @static */ public static function getCaseType($caseId, $colName = 'title') { @@ -334,7 +335,8 @@ WHERE civicrm_case.id = %1"; * * @param bool $moveToTrash * - * @return bool is successful + * @return bool + * is successful * @static */ public static function deleteCase($caseId, $moveToTrash = FALSE) { @@ -726,7 +728,8 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type' * * @param string $context * - * @return array Array of Cases + * @return array + * Array of Cases * */ public static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') { @@ -974,7 +977,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Case id. * @param int $relationshipID * - * @return array case role / relationships + * @return array + * case role / relationships * * @static */ @@ -1037,7 +1041,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $userID * @param null $type * - * @return array of case activities + * @return array + * of case activities * * @static */ @@ -1377,7 +1382,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param bool $skipDetails * If true include details of contacts. * - * @return array $searchRows array of return properties + * @return array + * array of return properties * * @static */ @@ -1692,7 +1698,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * * @param string $type * - * @return array $activityInfo Array of scheduled activity type and date + * @return array + * Array of scheduled activity type and date * * * @static @@ -1731,7 +1738,8 @@ 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 * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields() { @@ -1916,7 +1924,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Case role assignee contactId. * @param int $contactId * - * @return void on success creates activity and case activity + * @return void + * on success creates activity and case activity * * @static */ @@ -2010,7 +2019,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $caseId * Case id. * - * @return array $caseManagerContact array of contact on success otherwise empty + * @return array + * array of contact on success otherwise empty * * @static */ @@ -2055,7 +2065,8 @@ SELECT civicrm_contact.id as casemanager_id, * @param array $excludeCaseIds * @param bool $excludeDeleted * - * @return array of case and related data keyed on case id + * @return array + * of case and related data keyed on case id */ public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) { //params from ajax call. @@ -2819,7 +2830,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * @param bool $checkComponent * Do we need to check component enabled. * - * @return boolean $allow true/false + * @return boolean * @static */ public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) { @@ -3131,7 +3142,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * @param int $activityID * Activity id. * - * @return boolean $isCaseActivity true/false + * @return boolean */ public static function isCaseActivity($activityID) { $isCaseActivity = FALSE; @@ -3150,7 +3161,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Get all the case type ids currently in use * * - * @return array $caseTypeIds + * @return array */ public static function getUsedCaseType() { static $caseTypeIds; @@ -3175,7 +3186,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Get all the case status ids currently in use * * - * @return array $caseStatusIds + * @return array */ public static function getUsedCaseStatuses() { static $caseStatusIds; @@ -3218,7 +3229,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * * @param int $contactId * - * @return array $configured + * @return array */ public static function isCaseConfigured($contactId = NULL) { $configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE); @@ -3373,7 +3384,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * * @param int $caseId * - * @return array $clients associated array with client ids + * @return array + * associated array with client ids * @static */ public static function getCaseClients($caseId) { diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index d17a4aafb4..71ddd9cc6e 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -104,7 +104,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * @param string $name * @param array $definition * The case-type defintion expressed as an array-tree. - * @return string XML + * @return string + * XML * @static */ public static function convertDefinitionToXML($name, $definition) { @@ -187,7 +188,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * @param SimpleXmlElement $xml * A single case-type record. * - * @return array the definition of the case-type, expressed as PHP array-tree + * @return array + * the definition of the case-type, expressed as PHP array-tree * @static */ public static function convertXmlToDefinition($xml) { @@ -373,7 +375,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * Determine if modifications are allowed on the case-type * * @param int $caseTypeId - * @return bool TRUE if the definition can be modified + * @return bool + * TRUE if the definition can be modified */ public static function isForkable($caseTypeId) { $caseTypeName = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name', 'id', TRUE); diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index dddeefab7b..c9af2a21e8 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -109,7 +109,8 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index 8c64255242..bb27d4209f 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -109,7 +109,8 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index 0fbc58421d..ce5f053877 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -106,7 +106,8 @@ class CRM_Case_Form_Activity_ChangeCaseType { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 0539ec4775..153f1cab37 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -98,7 +98,8 @@ class CRM_Case_Form_Activity_LinkCases { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index 4c9d88766d..95e83b96de 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -254,7 +254,8 @@ class CRM_Case_Form_Activity_OpenCase { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index 08435728d8..6f37d0c049 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -319,7 +319,8 @@ class CRM_Case_Form_Case extends CRM_Core_Form { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 9d9e575d59..e06308b82f 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -344,7 +344,8 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php index 3ca767085f..0cde99ac2c 100644 --- a/CRM/Case/Page/Tab.php +++ b/CRM/Case/Page/Tab.php @@ -223,7 +223,8 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { /** * Get action links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ static diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 8795b03288..7d44e4f393 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -83,7 +83,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * @param null $condition * @param bool $fresh * - * @return array - array reference of all case statues + * @return array + * array reference of all case statues * @static */ public static function caseStatus($column = 'label', $onlyActive = TRUE, $condition = NULL, $fresh = FALSE) { @@ -108,7 +109,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * * @param null $filter * - * @return array - array reference of all redaction rules + * @return array + * array reference of all redaction rules * @static */ @@ -138,7 +140,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $column * @param bool $onlyActive * - * @return array - array reference of all case type + * @return array + * array reference of all case type * @static */ public static function caseType($column = 'title', $onlyActive = TRUE) { @@ -171,7 +174,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $column * @param bool $onlyActive * - * @return array - array reference of all Encounter Medium. + * @return array + * array reference of all Encounter Medium. * @static */ public static function encounterMedium($column = 'label', $onlyActive = TRUE) { @@ -199,7 +203,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * * @static * - * @return array - array reference of all activity types. + * @return array + * array reference of all activity types. */ public static function &caseActivityType($indexName = TRUE, $all = FALSE) { $cache = (int) $indexName . '_' . (int) $all; diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index daf9572657..052b4ad10e 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -271,7 +271,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -296,7 +297,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -411,7 +413,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -429,7 +432,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -505,7 +509,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('Case Search'); diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 2b1582c693..d391bf267c 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -79,7 +79,8 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Case/Task.php b/CRM/Case/Task.php index 0d98f79df9..261e28d16a 100644 --- a/CRM/Case/Task.php +++ b/CRM/Case/Task.php @@ -61,7 +61,8 @@ class CRM_Case_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -105,7 +106,8 @@ class CRM_Case_Task { /** * These tasks are the core set of task titles * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -120,7 +122,8 @@ class CRM_Case_Task { /** * These tasks get added based on the context the user is in * - * @return array the set of optional tasks for a group of contacts + * @return array + * the set of optional tasks for a group of contacts * @static */ public static function &optionalTaskTitle() { @@ -134,7 +137,8 @@ class CRM_Case_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -161,7 +165,8 @@ class CRM_Case_Task { * * @param int $value * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function getTask($value) { diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index 94d0afe4e1..e129ca7d63 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -646,7 +646,8 @@ AND a.is_deleted = 0 /** * Retrieves AllowMultipleCaseClients setting * - * @return string 1 if allowed, 0 if not + * @return string + * 1 if allowed, 0 if not */ public function getAllowMultipleCaseClients() { $xml = $this->retrieve("Settings"); @@ -659,7 +660,8 @@ AND a.is_deleted = 0 /** * Retrieves NaturalActivityTypeSort setting * - * @return string 1 if natural, 0 if alphabetic + * @return string + * 1 if natural, 0 if alphabetic */ public function getNaturalActivityTypeSort() { $xml = $this->retrieve("Settings"); diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index b5b11cc6c8..e499430b8f 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -471,7 +471,8 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * * @param bool $type * - * @return array the displayName and contactImage for this contact + * @return array + * the displayName and contactImage for this contact * @static */ public static function getDisplayAndImage($id, $type = FALSE) { @@ -764,7 +765,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); * @param bool $skipUndelete * Whether to force contact delete or not. * - * @return boolean true if contact deleted, false otherwise + * @return boolean + * true if contact deleted, false otherwise * @static */ public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE) { @@ -897,7 +899,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); * @param int $id * Id of the contact. * - * @return boolean true if contact image is deleted + * @return boolean + * true if contact image is deleted */ public static function deleteContactImage($id) { if (!$id) { @@ -918,7 +921,8 @@ WHERE id={$id}; "; * @param string $absolutePath * Absolute path. * - * @return String $relativePath Relative url of uploaded image + * @return String + * Relative url of uploaded image */ public static function getRelativePath($absolutePath) { $relativePath = NULL; @@ -959,7 +963,8 @@ WHERE id={$id}; "; * @param Integer $imageHeight * Height of image. * - * @return Array thumb dimension of image + * @return Array + * thumb dimension of image */ public static function getThumbSize($imageWidth, $imageHeight) { $thumbWidth = 100; @@ -992,7 +997,8 @@ WHERE id={$id}; "; * @param string $opType * Type of operation like fatal, bounce etc. * - * @return boolean true if valid image extension + * @return boolean + * true if valid image extension */ public static function processImageParams( &$params, @@ -1088,7 +1094,8 @@ WHERE id={$id}; "; * @param int $id * Id of the contact whose contact type is needed. * - * @return string contact_type if $id found else null "" + * @return string + * contact_type if $id found else null "" * * * @static @@ -1106,7 +1113,8 @@ WHERE id={$id}; "; * * @param null $implodeDelimiter * - * @return string contact_sub_type if $id found else null "" + * @return string + * contact_sub_type if $id found else null "" * * * @static @@ -1177,7 +1185,8 @@ WHERE id={$id}; "; * * @param bool $withMultiCustomFields * - * @return array array of importable Fields + * @return array + * array of importable Fields * @static */ static function importableFields( @@ -1376,7 +1385,8 @@ WHERE id={$id}; "; * * @param bool $withMultiRecord * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) { @@ -1637,7 +1647,8 @@ WHERE id={$id}; "; * @param int $contactId * Contact id. * - * @return array a hierarchical property tree if appropriate + * @return array + * a hierarchical property tree if appropriate * @static */ public static function &makeHierReturnProperties($fields, $contactId = NULL) { @@ -1712,7 +1723,8 @@ WHERE id={$id}; "; * @param bool $skipDefaultPriamry * @param null $block * - * @return int $locationType location_type_id + * @return int + * $locationType location_type_id * @static */ public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) { @@ -1775,7 +1787,8 @@ WHERE civicrm_contact.id = %1 "; * @param int $id * Id of the contact. * - * @return array of display_name, email if found, do_not_email or (null,null,null) + * @return array + * of display_name, email if found, do_not_email or (null,null,null) * @static */ public static function getContactDetails($id) { @@ -1831,7 +1844,8 @@ ORDER BY civicrm_email.is_primary DESC"; * Basically lets us know where this request is coming from. * if via a profile from web, we restrict what groups are changed * - * @return int contact id created/edited + * @return int + * contact id created/edited * @static */ static function createProfileContact( @@ -2305,7 +2319,8 @@ ORDER BY civicrm_email.is_primary DESC"; * @param string $ctype * Contact type. * - * @return object $dao contact details + * @return object + * $dao contact details * @static */ public static function &matchContactOnEmail($mail, $ctype = NULL) { @@ -2357,7 +2372,8 @@ WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0"; * @param string $ctype * Contact type. * - * @return object $dao contact details + * @return object + * $dao contact details * @static */ public static function &matchContactOnOpenId($openId, $ctype = NULL) { @@ -2394,7 +2410,8 @@ WHERE civicrm_openid.openid = %1"; * @param int $contactID * Contact id. * - * @return string $dao->email email address if present else null + * @return string + * >email email address if present else null * @static */ public static function getPrimaryEmail($contactID) { @@ -2422,7 +2439,8 @@ LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id ) * @param int $contactID * Contact id. * - * @return string $dao->openid OpenID if present else null + * @return string + * >openid OpenID if present else null * @static */ public static function getPrimaryOpenId($contactID) { @@ -2775,7 +2793,8 @@ AND civicrm_openid.is_primary = 1"; * @param string $condOperator * Operator use for grouping multiple conditions. * - * @return array $locBlockIds loc block ids which fulfill condition. + * @return array + * loc block ids which fulfill condition. * @static */ public static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') { @@ -2824,7 +2843,8 @@ AND civicrm_openid.is_primary = 1"; * * @param int $contactId * - * @return array of context menu for logged in user. + * @return array + * of context menu for logged in user. * @static */ public static function contextMenu($contactId = NULL) { @@ -3266,7 +3286,8 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * @param int $contactId * Contact id. * - * @return bool true if present else false. + * @return bool + * true if present else false. * @static */ public static function checkDomainContact($contactId) { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 435e2ca4a4..595310b491 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -43,7 +43,8 @@ class CRM_Contact_BAO_Contact_Location { * @param bool $isPrimary * @param int $locationTypeID * - * @return array of display_name, email, location type and location id if found, or (null,null,null, null) + * @return array + * of display_name, email, location type and location id if found, or (null,null,null, null) * @static */ public static function getEmailDetails($id, $isPrimary = TRUE, $locationTypeID = NULL) { @@ -83,7 +84,8 @@ WHERE civicrm_contact.id = %1"; * * @param null $type * - * @return array tuple of display_name and sms if found, or (null,null) + * @return array + * tuple of display_name and sms if found, or (null,null) * @static */ public static function getPhoneDetails($id, $type = NULL) { diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 45d625dd6e..5e15d51022 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -41,7 +41,8 @@ class CRM_Contact_BAO_Contact_Permission { * Contact id. * @param int|string $type the type of operation (view|edit) * - * @return boolean true if the user has permission, false otherwise + * @return boolean + * true if the user has permission, false otherwise * @static */ public static function allow($id, $type = CRM_Core_Permission::VIEW) { @@ -248,7 +249,8 @@ AND $operationClause LIMIT 1"; * @param int $contactID * Contact id of the current contact. * - * @return bool true if logged in user has permission to view + * @return bool + * true if logged in user has permission to view * selected contact record else false * @static */ diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 1883d94fad..a34b01321d 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -155,7 +155,8 @@ WHERE id IN ( $idString ) * @param string $entityType * @param null $hashSize * - * @return array ( $cs, $ts, $live ) + * @return array + * ( $cs, $ts, $live ) * @static */ public static function generateChecksum($entityId, $ts = NULL, $live = NULL, $hash = NULL, $entityType = 'contact', $hashSize = NULL) { @@ -223,7 +224,8 @@ WHERE id IN ( $idString ) * @param string $inputCheck * Checksum to match against. * - * @return boolean true if valid, else false + * @return boolean + * true if valid, else false * @static */ public static function validChecksum($contactID, $inputCheck) { @@ -256,7 +258,8 @@ WHERE id IN ( $idString ) * @param int $contactId * Contact id. * - * @return int $locationCount max locations for the contact + * @return int + * $locationCount max locations for the contact * @static */ public static function maxLocations($contactId) { @@ -585,7 +588,8 @@ UPDATE civicrm_contact * Associated with the contact which is edited. * * - * @return array $contactViewLinks returns array with links to contact view + * @return array + * returns array with links to contact view * @static */ public static function formatContactIDSToLinks($contactIDs, $addViewLink = TRUE, $addEditLink = TRUE, $originalId = NULL) { @@ -691,7 +695,8 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) * @param array $returnProperties * Array of return elements. * - * @return array $contactDetails array of contact info. + * @return array + * array of contact info. * @static */ public static function contactDetails($componentIds, $componentName, $returnProperties = array()) { @@ -870,7 +875,8 @@ Group By componentId"; * @param array $addresses * Associated array of. * - * @return array $contactNames associated array of contact names + * @return array + * associated array of contact names * @static */ public static function getAddressShareContactNames(&$addresses) { @@ -1085,7 +1091,8 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; * @param string $greetingType * Greeting type. * - * @return int or null + * @return int + * or null */ public static function defaultGreeting($contactType, $greetingType) { $contactTypeFilters = array('Individual' => 1, 'Household' => 2, 'Organization' => 3); diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index a9c7063497..968d9a798b 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -71,7 +71,8 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { * * @param bool $all * - * @return array of basic contact types information. + * @return array + * of basic contact types information. * @static */ public static function &basicTypeInfo($all = FALSE) { @@ -117,7 +118,8 @@ WHERE parent_id IS NULL * * @param bool $all * - * @return array of basic contact types + * @return array + * of basic contact types * @static */ public static function basicTypes($all = FALSE) { @@ -150,7 +152,8 @@ WHERE parent_id IS NULL * @param bool $ignoreCache * @param bool $reset * - * @return array of sub type information + * @return array + * of sub type information * @static */ public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) { @@ -219,7 +222,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param string $columnName * @param bool $ignoreCache * - * @return array of all subtypes OR list of subtypes associated to + * @return array + * of all subtypes OR list of subtypes associated to * a given basic contact type * @static */ @@ -261,7 +265,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * * @param bool $all * - * @return array of basic types + all subtypes. + * @return array + * of basic types + all subtypes. * @static */ public static function contactTypes($all = FALSE) { @@ -275,7 +280,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param bool $all * @param bool $reset * - * @return array of basic types + all subtypes. + * @return array + * of basic types + all subtypes. * @static */ public static function contactTypeInfo($all = FALSE, $reset = FALSE) { @@ -335,7 +341,8 @@ WHERE type.name IS NOT NULL * @param null $typeName * @param null $delimiter * - * @return array of basictypes with name as 'built-in name' and 'label' as value + * @return array + * of basictypes with name as 'built-in name' and 'label' as value * @static */ public static function contactTypePairs($all = FALSE, $typeName = NULL, $delimiter = NULL) { @@ -451,7 +458,8 @@ AND ( p.is_active = 1 OR p.id IS NULL ) * Contact subType. * @param bool $ignoreCache * - * @return boolean true if subType, false otherwise. + * @return boolean + * true if subType, false otherwise. * @static */ public static function isaSubType($subType, $ignoreCache = FALSE) { @@ -506,7 +514,8 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; * Contact subTypes. * @param bool $ignoreCache * - * @return array of suppressed subTypes. + * @return array + * of suppressed subTypes. * @static */ public static function suppressSubTypes(&$subTypes, $ignoreCache = FALSE) { @@ -524,7 +533,8 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; * @param bool $ignoreCache * @param string $columnName * - * @return boolean true if contact extends, false otherwise. + * @return boolean + * true if contact extends, false otherwise. * @static */ public static function isExtendsContactType($subType, $contactType, $ignoreCache = FALSE, $columnName = 'name') { @@ -539,7 +549,8 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; /** * Create shortcuts menu for contactTypes * - * @return array of contactTypes + * @return array + * of contactTypes * @static */ public static function getCreateNewList() { @@ -700,7 +711,8 @@ WHERE name = %1"; * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on success, null otherwise + * @return Object + * DAO object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -739,7 +751,7 @@ WHERE name = %1"; * @param string $subType * Subtype. * - * @return boolean true/false. + * @return boolean * @static */ public static function isAllowEdit($contactId, $subType = NULL) { diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index b3658aa2b5..8283ae49da 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -161,7 +161,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * * @param bool $countChildGroups * - * @return int count of members in the group with above status + * @return int + * count of members in the group with above status */ public static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) { $groupContact = new CRM_Contact_DAO_GroupContact(); @@ -205,7 +206,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param int $groupID * @param bool $useCache * - * @return array $aMembers this array contains the list of members for this group id + * @return array + * this array contains the list of members for this group id * @static */ public static function &getMember($groupID, $useCache = TRUE) { @@ -234,7 +236,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param NULL $offset * @param NULL $rowCount * - * @return array of group objects. + * @return array + * of group objects. * * * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and @@ -309,7 +312,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param int $id * The id of the object. * - * @return string the permission that the user has (or NULL) + * @return string + * the permission that the user has (or NULL) * @static */ public static function checkPermission($id) { @@ -560,7 +564,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param bool $isActive * Value we want to set the is_active field. * - * @return Object DAO object on sucess, NULL otherwise + * @return Object + * DAO object on sucess, NULL otherwise * @static */ public static function setIsActive($id, $isActive) { @@ -574,7 +579,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * Type of group(Access/Mailing) OR the key of the group. * @param bool|\boolen $excludeHidden exclude hidden groups. * - * @return string $condition + * @return string * @static */ public static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) { @@ -647,7 +652,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $params * ( reference ) an assoc array of name/value pairs. * - * @return array ( smartGroupId, ssId ) smart group id and saved search id + * @return array + * ( smartGroupId, ssId ) smart group id and saved search id * @static */ public static function createHiddenSmartGroup($params) { @@ -717,7 +723,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $params * Associated array for params record id. * - * @return array $groupList associated array of group list + * @return array + * associated array of group list * -rp = rowcount * -page= offset * @todo there seems little reason for the small number of functions that call this to pass in @@ -1232,7 +1239,8 @@ WHERE {$whereClause}"; /** * Define action links * - * @return array $links array of action links + * @return array + * array of action links */ public static function actionLinks() { $links = array( diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 863ad13a4a..c47ce54d4c 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -95,7 +95,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param array $values * Output values of the object. * - * @return array (reference) the values that could be potentially assigned to smarty + * @return array + * (reference) the values that could be potentially assigned to smarty * @static */ public static function getValues(&$params, &$values) { @@ -128,7 +129,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param string $status * @param int $tracking * - * @return array (total, added, notAdded) count of contacts added to group + * @return array + * (total, added, notAdded) count of contacts added to group * @static */ static function addContactsToGroup( @@ -178,7 +180,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param string $status * @param NULL $tracking * - * @return array (total, removed, notRemoved) count of contacts removed to group + * @return array + * (total, removed, notRemoved) count of contacts removed to group * @static */ static function removeContactsFromGroup( @@ -277,7 +280,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param bool $visibility * * - * @return array $values this array has key-> group id and value group title + * @return array + * this array has key-> group id and value group title * @static */ public static function getGroupList($contactId = 0, $visibility = FALSE) { @@ -331,7 +335,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * * @param bool $excludeHidden * - * @return array (reference )|int $values the relevant data object values for the contact or + * @return array + * (reference )|int $values the relevant data object values for the contact or * the total count when $count is TRUE * * $access public @@ -458,7 +463,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param string $method * If we want the subscription history details for a specific method. * - * @return object of group contact + * @return object + * of group contact * @static */ public static function getMembershipDetail($contactId, $groupID, $method = 'Email') { @@ -611,7 +617,8 @@ SELECT * * * TODO: use the 3rd $sqls param to append sql statements rather than executing them here * - * @return void. + * @return void + * * @static */ public static function mergeGroupContact($mainContactId, $otherContactId) { @@ -719,7 +726,8 @@ AND group_id IN ( $groupIDString ) * @param string $status * @param NULL $tracking * - * @return array (total, added, notAdded) count of contacts added to group + * @return array + * (total, added, notAdded) count of contacts added to group * @static */ static function bulkAddContactsToGroup( diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 2bb9288ff5..fee28ef28c 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -43,7 +43,8 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * @param $groupIDs * Of group that we are checking against. * - * @return boolean TRUE if we did not regenerate, FALSE if we did + * @return boolean + * TRUE if we did not regenerate, FALSE if we did */ public static function check($groupIDs) { if (empty($groupIDs)) { @@ -62,7 +63,8 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * @param bool $includeHiddenGroups * Hidden groups are excluded by default. * - * @return string the sql query which lists the groups that need to be refreshed + * @return string + * the sql query which lists the groups that need to be refreshed * @static */ public static function groupRefreshedClause($groupIDClause = NULL, $includeHiddenGroups = FALSE) { @@ -101,7 +103,8 @@ AND ( g.cache_date IS NULL OR * @param bool $includeHiddenGroups * Hidden groups are excluded by default. * - * @return string the sql query which lists the groups that need to be refreshed + * @return string + * the sql query which lists the groups that need to be refreshed * @static */ public static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) { @@ -121,7 +124,8 @@ AND ( g.cache_date IS NULL OR * @param int $limit * Limits the number of groups we evaluate. * - * @return boolean TRUE if we did not regenerate, FALSE if we did + * @return boolean + * TRUE if we did not regenerate, FALSE if we did */ public static function loadAll($groupIDs = NULL, $limit = 0) { // ensure that all the smart groups are loaded @@ -609,7 +613,8 @@ AND civicrm_group_contact.group_id = $groupID "; * @param bool $showHidden * Hidden groups are shown only if this flag is set. * - * @return array an array of groups that this contact belongs to + * @return array + * an array of groups that this contact belongs to */ public static function contactGroup($contactID, $showHidden = FALSE) { if (empty($contactID)) { diff --git a/CRM/Contact/BAO/Household.php b/CRM/Contact/BAO/Household.php index 75480da7b0..1bf59f5687 100644 --- a/CRM/Contact/BAO/Household.php +++ b/CRM/Contact/BAO/Household.php @@ -49,7 +49,8 @@ class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact { * @param int $contactId * Contact id. * - * @return Object DAO object on success + * @return Object + * DAO object on success * @static */ public static function updatePrimaryContact($primaryContactId, $contactId) { diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 5150e6bc86..88613b8e4f 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -385,7 +385,8 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** * Creates display name * - * @return string the constructed display name + * @return string + * the constructed display name */ public function displayName() { $prefix = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'); diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 84ec03fccd..3e88c46927 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -1301,7 +1301,8 @@ class CRM_Contact_BAO_Query { * @param bool $groupContacts * @param bool $onlyDeleted * - * @return array sql query parts as an array + * @return array + * sql query parts as an array */ public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) { // build permission clause @@ -2305,7 +2306,8 @@ class CRM_Contact_BAO_Query { * * @param CRM_Core_DAO $dao * - * @return array values for this query + * @return array + * values for this query */ public function store($dao) { $value = array(); @@ -2403,7 +2405,8 @@ class CRM_Contact_BAO_Query { * @param bool $primaryLocation * @param int $mode * - * @return string the from clause + * @return string + * the from clause * @static */ public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) { @@ -4210,7 +4213,8 @@ civicrm_relationship.is_permission_a_b = 0 * * @param int $mode * - * @return array derault return properties + * @return array + * derault return properties */ public static function &defaultReturnProperties($mode = 1) { if (!isset(self::$_defaultReturnProperties)) { @@ -5147,7 +5151,8 @@ SELECT COUNT( conts.total_amount ) as cancel_count, * @param string $dataType * Data type of the field. * - * @return string where clause for the query + * @return string + * where clause for the query */ public static function buildClause($field, $op, $value = NULL, $dataType = NULL) { $op = trim($op); @@ -5383,7 +5388,8 @@ AND displayRelType.is_active = 1 * The data type for this element. * @param bool $useIDsOnly * - * @return void adds the where clause and qill to the query object + * @return void + * adds the where clause and qill to the query object */ function optionValueQuery( $name, diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index d9ba5127d7..055259a7d5 100644 --- a/CRM/Contact/BAO/Query/Hook.php +++ b/CRM/Contact/BAO/Query/Hook.php @@ -61,7 +61,8 @@ class CRM_Contact_BAO_Query_Hook { /** * Get or build the list of search objects (via hook) * - * @return array of CRM_Contact_BAO_Query_Interface objects + * @return array + * of CRM_Contact_BAO_Query_Interface objects */ public function getSearchQueryObjects() { if ($this->_queryObjects === NULL) { diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 76b4d71ffd..11ebf22a9c 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -352,7 +352,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Specifiy defaults for creating a relationship * - * @return array $defaults array of defaults for creating relationship + * @return array + * array of defaults for creating relationship * @static */ public static function getdefaults() { @@ -408,7 +409,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * * @static * - * @return array - array reference of all relationship types with context to current contact. + * @return array + * array reference of all relationship types with context to current contact. */ static function getContactRelationshipType( $contactId = NULL, @@ -675,7 +677,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * @param int $relationshipTypeId * Relationship type id. * - * @return boolean true if it is valid relationship else false + * @return boolean + * true if it is valid relationship else false * @static */ public static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) { @@ -748,7 +751,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * @param int $relationshipId * This is relationship id for the contact. * - * @return boolean true if record exists else false + * @return boolean + * true if record exists else false * @static */ public static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) { @@ -825,7 +829,8 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * Value we want to set the is_active field. * * @throws CiviCRM_API3_Exception - * @return Object DAO object on success, null otherwise + * @return Object + * DAO object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -860,7 +865,8 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * @param array $values * Output values of the object. * - * @return array (reference) the values that could be potentially assigned to smarty + * @return array + * (reference) the values that could be potentially assigned to smarty * @static */ public static function &getValues(&$params, &$values) { @@ -1253,7 +1259,8 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) * @param string $targetContactType * It's valid contact tpye(may be Individual , Organization , Household). * - * @return array - array reference of all relationship types with context to current contact type . + * @return array + * array reference of all relationship types with context to current contact type . * */ public function getRelationType($targetContactType) { @@ -1551,7 +1558,8 @@ SELECT count(*) * @param $contactIds * Contact Ids. * - * @return array $currentEmployer array of the current employer + * @return array + * array of the current employer * @static */ public static function getCurrentEmployer($contactIds) { @@ -1584,7 +1592,8 @@ WHERE id IN ( {$contacts} ) * * @static * - * @return array array of employers. + * @return array + * array of employers. * */ public static function getPermissionedEmployer($contactID, $name = NULL) { @@ -1608,7 +1617,8 @@ WHERE id IN ( {$contacts} ) * * @static * - * @return array of contacts + * @return array + * of contacts */ public static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) { $contacts = array(); @@ -1766,7 +1776,8 @@ AND cc.sort_name LIKE '%$name%'"; * @param array $params * Associated array for params record id. * - * @return array $contactRelationships associated array of contact relationships + * @return array + * associated array of contact relationships */ public static function getContactRelationshipSelector(&$params) { // format the params diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index ec0bfcd626..e443192b48 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -71,7 +71,8 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 18e2118d87..8b82ca3524 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -51,7 +51,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** * Query the db for all saved searches. * - * @return array $aSavedSearch - contains the search name as value and and id as key + * @return array + * contains the search name as value and and id as key * */ public function getAll() { @@ -93,7 +94,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { * @param int $id * The id of the saved search. * - * @return array the values of the posted saved search + * @return array + * the values of the posted saved search * @static */ public static function &getFormValues($id) { @@ -159,7 +161,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the where clause for this saved search + * @return string + * the where clause for this saved search * @static */ public static function whereClause($id, &$tables, &$whereTables) { @@ -274,7 +277,8 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ * * @param string $value * - * @return string the name of the saved search + * @return string + * the name of the saved search * @static */ public static function getName($id, $value = 'name') { diff --git a/CRM/Contact/BAO/SubscriptionHistory.php b/CRM/Contact/BAO/SubscriptionHistory.php index 60a7a1dae5..b54ff60603 100644 --- a/CRM/Contact/BAO/SubscriptionHistory.php +++ b/CRM/Contact/BAO/SubscriptionHistory.php @@ -55,7 +55,8 @@ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHi * @param array $params * Values for the new history record. * - * @return object $history The new history object + * @return object + * $history The new history object * @static */ public static function &create(&$params) { diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index e7c9dffb8a..cb8435e865 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -588,7 +588,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param int $contactId * Contact id if doing update. * - * @return bool $primaryID email/openId + * @return bool + * email/openId * @static */ public static function formRule($fields, &$errors, $contactId = NULL) { @@ -1061,7 +1062,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $fields * The hierarchical value representation of this location. * - * @return boolean true if data exists, false otherwise + * @return boolean + * true if data exists, false otherwise * @static */ public static function blockDataExists(&$fields) { @@ -1196,7 +1198,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $params * of key value consist of address blocks. * - * @return array $parseSuccess as array of sucess/fails for each address block + * @return array + * as array of sucess/fails for each address block * @static */ public function parseAddress(&$params) { diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php index ade28593a0..7bb59a2d4b 100644 --- a/CRM/Contact/Form/CustomData.php +++ b/CRM/Contact/Form/CustomData.php @@ -233,7 +233,8 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { if ($this->_cdType || $this->_multiRecordDisplay == 'single') { diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index c769b42037..670c7cb265 100644 --- a/CRM/Contact/Form/DedupeRules.php +++ b/CRM/Contact/Form/DedupeRules.php @@ -148,7 +148,8 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 5978859faf..8008b6667c 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -102,7 +102,8 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** @@ -201,7 +202,8 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index d52fa59726..72bf2f1a46 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -103,7 +103,7 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors + * @return array * @static */ public static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index fc1049a52d..dfed038617 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -103,7 +103,7 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors + * @return array * @static */ public static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index daeb775ec3..5ee0681d0c 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -93,7 +93,8 @@ class CRM_Contact_Form_Inline_Lock { * * @param int $contactID * - * @return array extra options to return in JSON + * @return array + * extra options to return in JSON */ public static function getResponse($contactID) { $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID); diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index bc1014db2f..4b0c3828d5 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -103,7 +103,7 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors + * @return array * @static */ public static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 6297a8d221..9f2f96f979 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -103,7 +103,7 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors + * @return array * @static */ public static function formRule($fields, $errors) { diff --git a/CRM/Contact/Form/Merge.php b/CRM/Contact/Form/Merge.php index 8e998aba44..5b110413b1 100644 --- a/CRM/Contact/Form/Merge.php +++ b/CRM/Contact/Form/Merge.php @@ -247,7 +247,8 @@ class CRM_Contact_Form_Merge extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php index ef4560524d..0a4aa10438 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -166,7 +166,8 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** * Define the set of valid contexts that the search form operates on * - * @return array the valid context set and the titles + * @return array + * the valid context set and the titles * @static */ public static function &validContext() { diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 4ae3e984e3..d7fd336071 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -202,7 +202,8 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = $this->_formValues; diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index 28b5c5a562..9a5716143f 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -100,7 +100,8 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index bfcc5d20e8..89550d769c 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -139,7 +139,8 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { @@ -416,7 +417,8 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * CRM-9434 Hackish function to fetch fields with options. * FIXME: When our core fields contain reliable metadata this will be much simpler. - * @return array: (string => string) key: field_name value: api entity name + * @return array + * (string => string) key: field_name value: api entity name * Note: options are fetched via ajax using the api "getoptions" method */ public static function fieldOptions() { diff --git a/CRM/Contact/Form/Search/Custom.php b/CRM/Contact/Form/Search/Custom.php index d56354eb14..057b9254da 100644 --- a/CRM/Contact/Form/Search/Custom.php +++ b/CRM/Contact/Form/Search/Custom.php @@ -95,7 +95,8 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contact/Form/Search/Custom/FullText.php b/CRM/Contact/Form/Search/Custom/FullText.php index 88d0cfcf6b..16c9846d5e 100644 --- a/CRM/Contact/Form/Search/Custom/FullText.php +++ b/CRM/Contact/Form/Search/Custom/FullText.php @@ -530,7 +530,8 @@ FROM {$this->_tableName} contact_a /** * @param int|array $limit - * @return string SQL + * @return string + * SQL * @see CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery::toLimit */ public function toLimit($limit) { diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php index f4c5abcaa0..128d6a3e3b 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php +++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php @@ -79,7 +79,8 @@ abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { * NULL if no limit; or array(0 => $limit, 1 => $offset) * @param array|NULL $detailLimit final limit (applied when building $detailTable) * NULL if no limit; or array(0 => $limit, 1 => $offset) - * @return array keys: match-descriptor + * @return array + * keys: match-descriptor * - count: int */ public abstract function fillTempTable($queryText, $entityIDTableName, $detailTable, $queryLimit, $detailLimit); @@ -127,7 +128,8 @@ AND cf.html_type IN ( 'Text', 'TextArea', 'RichTextEditor' ) * - sql: an array of SQL queries to execute * - final: an array of SQL queries to execute at the end * - *: All other keys are treated as table names - * @return array keys: match-descriptor + * @return array + * keys: match-descriptor * - count: int * - files: NULL | array */ @@ -239,7 +241,8 @@ GROUP BY {$tableValues['id']} * Eg "civicrm_note" or "civicrm_note mynote". * @param array|string $fullTextFields list of field names * @param string $queryText - * @return string SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'" + * @return string + * SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'" */ public function matchText($table, $fullTextFields, $queryText) { $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; @@ -327,7 +330,8 @@ GROUP BY {$tableValues['id']} /** * @param int|array $limit - * @return string SQL + * @return string + * SQL * @see CRM_Contact_Form_Search_Custom_FullText::toLimit */ public function toLimit($limit) { @@ -346,7 +350,8 @@ GROUP BY {$tableValues['id']} /** * @param array|int $limit - * @return array (0 => $limit, 1 => $offset) + * @return array + * (0 => $limit, 1 => $offset) */ public function parseLimitOffset($limit) { if (is_scalar($limit)) { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Activity.php b/CRM/Contact/Form/Search/Custom/FullText/Activity.php index 53a8f1527d..b191a24265 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Activity.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Activity.php @@ -58,7 +58,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_ /** * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Search/Custom/FullText/Case.php b/CRM/Contact/Form/Search/Custom/FullText/Case.php index 056e6a59c8..8237368b90 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Case.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Case.php @@ -59,7 +59,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Sear /** * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php index b94d6d83a6..16cb175662 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php @@ -58,7 +58,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_S /** * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php index 0f750e1ea6..9f7bfdb2d5 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php @@ -62,7 +62,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_F * * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php index c47cdba514..341df71ea4 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php @@ -62,7 +62,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For * * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index b710466076..ecc0d7297d 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -62,7 +62,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo * * @param string $queryText * @param string $entityIDTableName - * @return array list tables/queries (for runQueries) + * @return array + * list tables/queries (for runQueries) */ public function prepareQueries($queryText, $entityIDTableName) { // Note: For available full-text indices, see CRM_Core_InnoDBIndexer diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 636c88c6ed..10852e63da 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -152,7 +152,8 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); @@ -180,7 +181,8 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { * * @param array $params * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($params) { diff --git a/CRM/Contact/Form/Task/AlterPreferences.php b/CRM/Contact/Form/Task/AlterPreferences.php index c634632410..beb116ce8f 100644 --- a/CRM/Contact/Form/Task/AlterPreferences.php +++ b/CRM/Contact/Form/Task/AlterPreferences.php @@ -69,7 +69,8 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index 94fa4a677b..431cecb270 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -94,7 +94,8 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 6cecd9a7b1..ff309d5b18 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -81,7 +81,8 @@ class CRM_Contact_Form_Task_LabelCommon { * @param bool $mergeSameHousehold * UNUSED. * - * @return array of rows for labels + * @return array + * of rows for labels */ public static function getRows($contactIDs, $locationTypeID, $respectDoNotMail, $mergeSameAddress, $mergeSameHousehold) { @@ -244,7 +245,8 @@ class CRM_Contact_Form_Task_LabelCommon { /** * Get array of return properties for address fields required for mailing label - * @return array return properites for address e.g + * @return array + * return properites for address e.g * array ( * - [street_address] => 1, * - [supplemental_address_1] => 1, diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 39cce26571..fa2d670011 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -148,7 +148,8 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { * @param $addBreadCrumb * @param string $type * - * @return string the location of the file we have created + * @return string + * the location of the file we have created */ public static function createMapXML($ids, $locationId, &$page, $addBreadCrumb, $type = 'Contact') { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index 571cf5faa9..af224eeea4 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -139,7 +139,8 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 6cf4017a4a..54313f2765 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -140,7 +140,8 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * * @param CRM_Core_Form $form * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues($form) { $defaults = array(); diff --git a/CRM/Contact/Form/Task/RemoveFromGroup.php b/CRM/Contact/Form/Task/RemoveFromGroup.php index 589f0a113b..c07fb53dc8 100644 --- a/CRM/Contact/Form/Task/RemoveFromGroup.php +++ b/CRM/Contact/Form/Task/RemoveFromGroup.php @@ -59,7 +59,8 @@ class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php index df202c8ac6..3bec47f3b4 100644 --- a/CRM/Contact/Import/Form/DataSource.php +++ b/CRM/Contact/Import/Form/DataSource.php @@ -237,7 +237,8 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index 335e537d35..3d9d87c949 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -623,7 +623,8 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index 3046780685..f895702533 100644 --- a/CRM/Contact/Import/Form/Preview.php +++ b/CRM/Contact/Import/Form/Preview.php @@ -194,7 +194,8 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index d275d0eb92..288ba58ccd 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -533,7 +533,8 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 453070cbd1..a0051d2f9e 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -262,7 +262,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -274,7 +275,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function summary(&$values) { $erroneousField = NULL; @@ -447,7 +449,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * * @param bool $doGeocodeAddress * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values, $doGeocodeAddress = FALSE) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Contact/Page/DedupeFind.php b/CRM/Contact/Page/DedupeFind.php index 6b77d79f69..2acdf69d2d 100644 --- a/CRM/Contact/Page/DedupeFind.php +++ b/CRM/Contact/Page/DedupeFind.php @@ -41,7 +41,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Dedupe_BAO_RuleGroup'; @@ -50,7 +51,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { } @@ -331,7 +333,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string classname of edit form + * @return string + * classname of edit form */ public function editForm() { return 'CRM_Contact_Form_DedupeFind'; @@ -340,7 +343,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page + * @return string + * name of this page */ public function editName() { return 'DedupeFind'; @@ -351,7 +355,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context + * @return string + * user context */ public function userContext($mode = NULL) { return 'civicrm/contact/dedupefind'; diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php index 3359375c3a..73aabfa7e5 100644 --- a/CRM/Contact/Page/DedupeRules.php +++ b/CRM/Contact/Page/DedupeRules.php @@ -45,7 +45,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Dedupe_BAO_RuleGroup'; @@ -54,7 +55,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -182,7 +184,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string classname of edit form + * @return string + * classname of edit form */ public function editForm() { return 'CRM_Contact_Form_DedupeRules'; @@ -191,7 +194,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page + * @return string + * name of this page */ public function editName() { return 'DedupeRules'; @@ -202,7 +206,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context + * @return string + * user context */ public function userContext($mode = NULL) { return 'civicrm/contact/deduperules'; diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index 58d2a9efc6..7776453909 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -149,7 +149,8 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ public static function &links() { diff --git a/CRM/Contact/Page/Task.php b/CRM/Contact/Page/Task.php index 147baf3cb1..6aa5970c21 100644 --- a/CRM/Contact/Page/Task.php +++ b/CRM/Contact/Page/Task.php @@ -45,7 +45,8 @@ class CRM_Contact_Page_Task extends CRM_Core_Page { /** * Returns the page title * - * @return string the title of the page + * @return string + * the title of the page */ public function getTitle() { return "Task Results"; diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index 3e10088eaa..e66a6eafa9 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -257,7 +257,8 @@ class CRM_Contact_Page_View extends CRM_Core_Page { * * @param int $contactId * - * @return array contact fields in fixed order + * @return array + * contact fields in fixed order */ public static function getContactDetails($contactId) { return list($displayName, diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php index 91532a133a..83c2ef243b 100644 --- a/CRM/Contact/Page/View/Note.php +++ b/CRM/Contact/Page/View/Note.php @@ -248,7 +248,8 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * Get action links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ public static function &links() { @@ -288,7 +289,8 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * Get action links for comments * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ public static function &commentLinks() { diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php index 8d68c415b8..7633cdc772 100644 --- a/CRM/Contact/Page/View/Relationship.php +++ b/CRM/Contact/Page/View/Relationship.php @@ -271,7 +271,8 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** * Get action links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ public static function &links() { diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php index 7c3db5361b..98edf3b279 100644 --- a/CRM/Contact/Page/View/UserDashBoard.php +++ b/CRM/Contact/Page/View/UserDashBoard.php @@ -213,7 +213,8 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { /** * Get action links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ static diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 57a4e30437..4ccc9c8fc8 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -330,7 +330,8 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { $headers = NULL; @@ -481,7 +482,8 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { // Use count from cache during paging/sorting @@ -509,7 +511,8 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $config = CRM_Core_Config::singleton(); @@ -1079,7 +1082,8 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * @param array( reference) $formValues submitted formValues * - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -1094,7 +1098,8 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Contact Search'); @@ -1104,7 +1109,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * Get colunmn headers for search selector * * - * @return array $_columnHeaders + * @return array */ private static function &_getColumnHeaders() { if (!isset(self::$_columnHeaders)) { diff --git a/CRM/Contact/Selector/Controller.php b/CRM/Contact/Selector/Controller.php index ac9fe00b98..90620c1e3c 100644 --- a/CRM/Contact/Selector/Controller.php +++ b/CRM/Contact/Selector/Controller.php @@ -37,7 +37,8 @@ class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller { * Default function for qill, if needed to be implemented, we * expect the subclass to do it * - * @return string the status message + * @return string + * the status message */ /** * @return string diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index 6d955299af..641ffa8dec 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -228,7 +228,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { $columns = $this->_search->columns(); @@ -258,7 +259,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_search->count(); @@ -278,7 +280,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { @@ -379,7 +382,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * @param array( reference) $formValues submitted formValues * - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ public function getQILL() { return NULL; @@ -398,7 +402,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Custom Search'); diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index f4d212a8e1..7a3deca013 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -91,7 +91,8 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Contact/Task.php b/CRM/Contact/Task.php index 6a9204ea0b..4a7ac57eea 100644 --- a/CRM/Contact/Task.php +++ b/CRM/Contact/Task.php @@ -279,7 +279,8 @@ class CRM_Contact_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &taskTitles() { @@ -316,7 +317,8 @@ class CRM_Contact_Task { * @param bool $deletedContacts * Are these tasks for operating on deleted contacts?. * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) { self::initTasks(); @@ -357,7 +359,8 @@ class CRM_Contact_Task { /** * These tasks get added based on the context the user is in * - * @return array the set of optional tasks for a group of contacts + * @return array + * the set of optional tasks for a group of contacts * @static */ public static function &optionalTaskTitle() { diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 2b7b79d7be..f065901e59 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -559,7 +559,8 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param string $contactType * @param bool $status * - * @return array array of importable Fields + * @return array + * array of importable Fields * @static */ public static function &importableFields($contactType = 'Individual', $status = TRUE) { @@ -849,7 +850,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * * @param int $id * - * @return boolean true if duplicate, false otherwise + * @return boolean + * true if duplicate, false otherwise * static */ public static function checkDuplicate($input, &$duplicates, $id = NULL) { @@ -919,7 +921,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * @param bool $addExtraFields * True if special fields needs to be added. * - * @return array the list of contribution fields + * @return array + * the list of contribution fields * @static */ public static function getContributionFields($addExtraFields = TRUE) { @@ -1154,7 +1157,8 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id * @param array $params * An assoc array of name/value pairs. * - * @return array contribution id if success else NULL + * @return array + * contribution id if success else NULL * static */ public static function checkDuplicateIds($params) { @@ -1186,7 +1190,8 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id * @param string $componentIds * Component ids. * - * @return array associated array + * @return array + * associated array * * @static */ @@ -1840,7 +1845,8 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ * @param int $contributorId * Contributor id. * - * @return array $ids containing organization id and individual id + * @return array + * containing organization id and individual id */ public static function getOnbehalfIds($contributionId, $contributorId = NULL) { @@ -2137,7 +2143,8 @@ WHERE contribution_id = %1 "; * Distinguishes between whether to send message or return. * message text. We are working towards this function ALWAYS returning message text & calling * function doing emails / pdfs with it - * @return array $messageArray - messages + * @return array + * messages */ /** * @param $input @@ -2279,7 +2286,7 @@ WHERE contribution_id = %1 "; * @param array $ids * The set of ids related to the inpurt. * - * @return array $values + * @return array * * NB don't add direct calls to the function as we intend to change the signature */ @@ -2628,7 +2635,8 @@ WHERE contribution_id = %1 "; * @param int $contributionId * Contribution id. * - * @return string $status contribution status + * @return string + * contribution status * @static */ public static function isSubscriptionCancelled($contributionId) { diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index 9a4d6124bf..79ba2272a0 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -57,7 +57,8 @@ class CRM_Contribute_BAO_Contribution_Utils { * * @throws CRM_Core_Exception * @throws Exception - * @return array associated array + * @return array + * associated array * * @static */ @@ -380,7 +381,8 @@ class CRM_Contribute_BAO_Contribution_Utils { * @param int $param * Year. * - * @return array associated array + * @return array + * associated array * * @static */ @@ -420,7 +422,8 @@ INNER JOIN civicrm_contact AS contact ON ( contact.id = contrib.contact_id ) /** * Get the contribution details by year * - * @return array associated array + * @return array + * associated array * * @static */ @@ -893,7 +896,8 @@ LIMIT 1 * @param float $taxRate * Tax rate of selected financial account for field. * - * @return array array of tax amount + * @return array + * array of tax amount * * @static * diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 8e00461b8f..389aafd036 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -72,7 +72,8 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on success, null otherwise + * @return Object + * DAO object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -717,7 +718,8 @@ WHERE entity_table = 'civicrm_contribution_page' * @param int $contributionPageId * Contribution Page Id. * - * @return boolean true if payment processor supports recurring + * @return boolean + * true if payment processor supports recurring * else false * * @static @@ -742,7 +744,8 @@ WHERE entity_table = 'civicrm_contribution_page' * Get info for all sections enable/disable. * * @param array $contribPageIds - * @return array $info info regarding all sections. + * @return array + * info regarding all sections. * @static */ public static function getSectionInfo($contribPageIds = array()) { @@ -913,7 +916,7 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm * Contribution Page Id. * @param int $userID * Contact id for contributor. - * @return array $pdfHtml + * @return array */ public static function addInvoicePdfToEmail($contributionId, $userID) { $contributionID = array($contributionId); @@ -931,7 +934,8 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm * Helper to determine if the page supports separate membership payments * @param int id form id * - * @return bool isSeparateMembershipPayment + * @return bool + * isSeparateMembershipPayment */ public static function getIsMembershipPayment($id) { $membershipBlocks = civicrm_api3('membership_block', 'get', array('entity_table' => 'civicrm_contribution_page', 'entity_id' => $id, 'sequential' => TRUE)); diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index 5b57460bde..6b639372c7 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -40,7 +40,8 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object activity contact object + * @return object + * activity contact object * */ public static function create(&$params) { @@ -112,7 +113,8 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * @param array $duplicates * (reference ) store ids of duplicate contribs. * - * @return boolean true if duplicate, false otherwise + * @return boolean + * true if duplicate, false otherwise * static */ public static function checkDuplicate($params, &$duplicates) { @@ -182,7 +184,8 @@ SELECT r.payment_processor_id * @param array $ids * (reference ) an array of recurring contribution ids. * - * @return array $totalCount an array of recurring ids count + * @return array + * an array of recurring ids count * static */ public static function getCount(&$ids) { @@ -329,7 +332,8 @@ SELECT r.payment_processor_id * @param int $contactId * Contact ID. * - * @return array list of recurring contribution fields + * @return array + * list of recurring contribution fields * * @static */ diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index f4a9ec69c3..62451a5343 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -47,7 +47,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object soft contribution of object that is added + * @return object + * soft contribution of object that is added * */ public static function add(&$params) { @@ -148,7 +149,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio * @param bool $all * Include PCP data. * - * @return array of soft contribution ids, amounts, and associated contact ids + * @return array + * of soft contribution ids, amounts, and associated contact ids * @static */ public static function getSoftContribution($contributionID, $all = FALSE) { diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 1c567fc505..b8b3334a56 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -76,7 +76,8 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 5839377d7c..35e9f3a4b9 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -77,7 +77,8 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -247,7 +248,8 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { /** * Retrieve premium product and their options * - * @return array product and option arrays + * @return array + * product and option arrays * @static */ public static function getPremiumProductInfo() { diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index c90cffea90..4c8e4c9671 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -47,7 +47,8 @@ class CRM_Contribute_BAO_Query { /** * Function get the import/export fields for contribution * - * @return array self::$_contributionFields associative array of contribution fields + * @return array + * self::$_contributionFields associative array of contribution fields * @static */ public static function &getFields() { diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 2ec1e69198..d57f881996 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -370,7 +370,8 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * @return array of valid processors. The array resembles the DB table but also has 'object' as a key + * @return array + * of valid processors. The array resembles the DB table but also has 'object' as a key * @throws Exception */ public function getValidProcessors() { diff --git a/CRM/Contribute/Form/AdditionalPayment.php b/CRM/Contribute/Form/AdditionalPayment.php index 43b7d059f9..3c955e53cb 100644 --- a/CRM/Contribute/Form/AdditionalPayment.php +++ b/CRM/Contribute/Form/AdditionalPayment.php @@ -153,7 +153,8 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php index bea89c7fe5..c627af535a 100644 --- a/CRM/Contribute/Form/CancelSubscription.php +++ b/CRM/Contribute/Form/CancelSubscription.php @@ -188,7 +188,8 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array('is_notify' => 1); diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index cbb26bb62d..20d768532e 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -236,7 +236,8 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { * the default values are retrieved from the database * * - * @return array defaults + * @return array + * defaults */ public function setDefaultValues() { //some child classes calling setdefaults directly w/o preprocess. diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index d3d437a5bb..699ccfc56d 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -219,7 +219,8 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 666c37582b..7d6b6f85ef 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -198,7 +198,8 @@ class CRM_Contribute_Form_SoftCredit { * @param $errors * @param $self * - * @return array of errors + * @return array + * of errors * @static */ public static function formRule($fields, $errors, $self) { diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 868d333abc..b4fe5fd076 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -210,7 +210,8 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * * @param array $values * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values) { diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index af5d4a2aa3..08dd4aafc5 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -244,7 +244,8 @@ AND {$this->_componentClause}"; * @param array $contactIds * Contact Id. * - * @return array array of common elements + * @return array + * array of common elements * * @static */ diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index 7f8d3bae4e..3a722e2a2c 100644 --- a/CRM/Contribute/Form/Task/PDFLetter.php +++ b/CRM/Contribute/Form/Task/PDFLetter.php @@ -83,7 +83,8 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index 99b6c5f92b..23799c2382 100644 --- a/CRM/Contribute/Form/Task/PDFLetterCommon.php +++ b/CRM/Contribute/Form/Task/PDFLetterCommon.php @@ -215,7 +215,8 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF * @param string $task * @param string $separator * - * @return array: + * @return array + * */ public static function buildContributionArray($groupBy, $form, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator) { $contributions = $contacts = $notSent = array(); diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 10de371790..2f895163dd 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -124,7 +124,8 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index ee4321dc0e..86b42506f6 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -185,7 +185,8 @@ AND co.id IN ( $contribIDs )"; * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index 83b5244c54..a856a81d6a 100644 --- a/CRM/Contribute/Form/UpdateBilling.php +++ b/CRM/Contribute/Form/UpdateBilling.php @@ -135,7 +135,8 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index 53457aa84c..f9d84d3a4a 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -343,7 +343,8 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index 0aa448c89a..c886e59b4d 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -440,7 +440,8 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php index c3fa579c94..cd0d075c47 100644 --- a/CRM/Contribute/Import/Parser/Contribution.php +++ b/CRM/Contribute/Import/Parser/Contribution.php @@ -152,7 +152,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -164,7 +165,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function summary(&$values) { $erroneousField = NULL; @@ -242,7 +244,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values) { // first make sure this is a valid line diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index caa1eeb256..18b9c2f6b3 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -47,7 +47,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array collection of required component settings + * @return array + * collection of required component settings * */ /** @@ -93,7 +94,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { /** * Provides permissions that are unwise for Anonymous Roles to have * - * @return array list of permissions + * @return array + * list of permissions * @see CRM_Component_Info::getPermissions */ /** diff --git a/CRM/Contribute/Page/ManagePremiums.php b/CRM/Contribute/Page/ManagePremiums.php index 698cf559b1..a3d0f3d3e0 100644 --- a/CRM/Contribute/Page/ManagePremiums.php +++ b/CRM/Contribute/Page/ManagePremiums.php @@ -51,7 +51,8 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Contribute_BAO_ManagePremiums'; @@ -60,7 +61,8 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -181,7 +183,8 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Contribute_Form_ManagePremiums'; @@ -190,7 +193,8 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Manage Premiums'; @@ -201,7 +205,8 @@ class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/contribute/managePremiums'; diff --git a/CRM/Contribute/Page/PaymentInfo.php b/CRM/Contribute/Page/PaymentInfo.php index 95cec3c57e..288284ac27 100644 --- a/CRM/Contribute/Page/PaymentInfo.php +++ b/CRM/Contribute/Page/PaymentInfo.php @@ -59,7 +59,8 @@ class CRM_Contribute_Page_PaymentInfo extends CRM_Core_Page { * pages. This typically involves assigning the appropriate * smarty variable :) * - * @return string The content generated by running this page + * @return string + * The content generated by running this page */ /** * @return string diff --git a/CRM/Contribute/Page/Premium.php b/CRM/Contribute/Page/Premium.php index ef361e6eef..e295cbc7f4 100644 --- a/CRM/Contribute/Page/Premium.php +++ b/CRM/Contribute/Page/Premium.php @@ -49,7 +49,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Contribute_BAO_Premium'; @@ -58,7 +59,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -197,7 +199,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Contribute_Form_ContributionPage_Premium'; @@ -206,7 +209,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Configure Premiums'; @@ -217,7 +221,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return CRM_Utils_System::currentPath(); diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index 70b54ac57b..8128236b90 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -120,7 +120,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $id * - * @return array - array reference of all financial types if any + * @return array + * array reference of all financial types if any * @static */ public static function &financialType($id = NULL) { @@ -154,7 +155,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $retrieveColumn * @param string $key * - * @return array - array reference of all financial accounts if any + * @return array + * array reference of all financial accounts if any * @static */ public static function &financialAccount($id = NULL, $financialAccountTypeId = NULL, $retrieveColumn = 'name', $key = 'id') { @@ -208,7 +210,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * Do we want all pages or only active pages. * * - * @return array - array reference of all contribution pages if any + * @return array + * array reference of all contribution pages if any * @static */ public static function &contributionPage($id = NULL, $all = FALSE) { @@ -240,7 +243,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @param string $columnName * - * @return array - array reference of all payment instruments if any + * @return array + * array reference of all payment instruments if any * @static */ public static function &paymentInstrument($columnName = 'label') { @@ -257,7 +261,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * Get all the valid accepted credit cards * * - * @return array - array reference of all payment instruments if any + * @return array + * array reference of all payment instruments if any * @static */ public static function &creditCard() { @@ -269,7 +274,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * * @param int $pageID - * @return array - array of all Premiums if any + * @return array + * array of all Premiums if any * @static */ public static function products($pageID = NULL) { @@ -317,7 +323,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $id * @param string $columnName - * @return array - array reference of all contribution statuses + * @return array + * array reference of all contribution statuses * @static */ public static function &contributionStatus($id = NULL, $columnName = 'label') { @@ -342,7 +349,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @param null $pageType * @param int $id * - * @return array - array reference of all pcp if any + * @return array + * array reference of all pcp if any * @static */ public static function &pcPage($pageType = NULL, $id = NULL) { @@ -374,7 +382,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @static * * @param string $column - * @return array - array reference of all PCP activity statuses + * @return array + * array reference of all PCP activity statuses */ public static function &pcpStatus($column = 'label') { if (NULL === self::$pcpStatus) { @@ -399,7 +408,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $financialTypeId * @param int $relationTypeId - * @return array - array reference of all financial accounts for a Financial type + * @return array + * array reference of all financial accounts for a Financial type */ public static function financialAccountType($financialTypeId, $relationTypeId = NULL) { if (!CRM_Utils_Array::value($financialTypeId, self::$financialTypeAccount)) { @@ -428,7 +438,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * * @param int $id - * @return array - array reference of all batches if any + * @return array + * array reference of all batches if any * @static */ public static function &batch($id = NULL) { diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 4018246014..8a3f10c72f 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -286,7 +286,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -311,7 +312,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { if ($this->_includeSoftCredits) { @@ -426,7 +428,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -444,7 +447,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { self::$_columnHeaders = array( @@ -561,7 +565,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Contribution Search'); diff --git a/CRM/Contribute/StateMachine/Search.php b/CRM/Contribute/StateMachine/Search.php index 4fda2d74b0..6bfc9afd79 100644 --- a/CRM/Contribute/StateMachine/Search.php +++ b/CRM/Contribute/StateMachine/Search.php @@ -77,7 +77,8 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Contribute/Task.php b/CRM/Contribute/Task.php index 663977f547..1a707c61b0 100644 --- a/CRM/Contribute/Task.php +++ b/CRM/Contribute/Task.php @@ -61,7 +61,8 @@ class CRM_Contribute_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -146,7 +147,8 @@ class CRM_Contribute_Task { * These tasks are the core set of task titles * on contributors * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -166,7 +168,8 @@ class CRM_Contribute_Task { * * @param bool $softCreditFiltering * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) { $tasks = array(); @@ -199,7 +202,8 @@ class CRM_Contribute_Task { * * @param int $value * - * @return array the set of tasks for a group of contributors + * @return array + * the set of tasks for a group of contributors * @static */ public static function getTask($value) { diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index 068744b2a8..8e39a3f523 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -114,7 +114,8 @@ class CRM_Core_Action { * @param string $str * The action to be resolved. * - * @return int the action mask corresponding to the input string + * @return int + * the action mask corresponding to the input string * @static */ public static function resolve($str) { @@ -133,7 +134,8 @@ class CRM_Core_Action { * @param mixed $item * Either a single string or an array of strings. * - * @return int the action mask corresponding to the input args + * @return int + * the action mask corresponding to the input args * @static * */ @@ -157,7 +159,8 @@ class CRM_Core_Action { * @param string $item * The input action to process. * - * @return int the action mask corresponding to the input string + * @return int + * the action mask corresponding to the input string * @static * */ @@ -173,7 +176,8 @@ class CRM_Core_Action { * @param int $mask * The action mask. * - * @return string the corresponding action description + * @return string + * the corresponding action description * @static * */ @@ -204,7 +208,8 @@ class CRM_Core_Action { * @param null $objectName * @param int $objectId * - * @return string the html string + * @return string + * the html string * @static */ static function formLink( @@ -315,7 +320,8 @@ class CRM_Core_Action { * @param array $values * The array of values for parameter substitution in the str. * - * @return string the substituted string + * @return string + * the substituted string * @static */ public static function &replace(&$str, &$values) { @@ -330,7 +336,8 @@ class CRM_Core_Action { * * @param string the permission * - * @return int the mask for the above permission + * @return int + * the mask for the above permission * @static */ public static function mask($permissions) { diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 0f878431bd..2b697c8071 100644 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -89,7 +89,8 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { * @param bool $id * Mapping id. * - * @return array associated array of all the drop downs in the form + * @return array + * associated array of all the drop downs in the form * @static */ public static function getSelection($id = NULL) { @@ -322,7 +323,8 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule { * @param null $entityValue * @param int $id * - * @return array (reference) reminder list + * @return array + * (reference) reminder list * @static */ public static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) { @@ -657,7 +659,8 @@ AND cas.entity_value = $id AND * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on success, null otherwise + * @return Object + * DAO object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 7395289bc4..ec898336ed 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -49,7 +49,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * * @param null $entity * - * @return array $blocks array of created address + * @return array + * array of created address * @static */ public static function create(&$params, $fixAddress = TRUE, $entity = NULL) { @@ -141,7 +142,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * True if you need to fix (format) address values. * before inserting in db * - * @return object CRM_Core_BAO_Address object on success, null otherwise + * @return object + * CRM_Core_BAO_Address object on success, null otherwise * @static */ public static function add(&$params, $fixAddress) { @@ -463,7 +465,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * If microformat output is required. * @param int|string $fieldName conditional field name * - * @return array $addresses array with address fields + * @return array + * array with address fields * @static */ public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') { @@ -589,7 +592,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * * @param bool $updateBlankLocInfo * - * @return array the array of adrress data + * @return array + * the array of adrress data * @static */ public static function allAddress($id, $updateBlankLocInfo = FALSE) { @@ -625,7 +629,8 @@ ORDER BY civicrm_address.is_primary DESC, address_id ASC"; * The array containing entity_id and. * entity_table name * - * @return array the array of adrress data + * @return array + * the array of adrress data * @static */ public static function allEntityAddress(&$entityElements) { @@ -659,7 +664,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, /** * Get address sequence * - * @return array of address sequence. + * @return array + * of address sequence. */ public static function addressSequence() { $config = CRM_Core_Config::singleton(); @@ -702,7 +708,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, * @param string Street address including number and apt * @param string Locale - to set locale used to parse address * - * @return array $parseFields parsed fields values. + * @return array + * parsed fields values. * @static */ public static function parseStreetAddress($streetAddress, $locale = NULL) { @@ -837,7 +844,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, * @param array $fields * An array of importable/exportable contact fields. * - * @return array $fields an array of contact fields and only the enabled address options + * @return array + * an array of contact fields and only the enabled address options * @static */ public static function validateAddressOptions($fields) { @@ -1131,7 +1139,7 @@ SELECT is_primary, * @param bool $returnStatus * By default false. * - * @return string $statusMessage + * @return string * @static */ public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) { diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index a0ec8c8086..6fc42383e7 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -56,7 +56,8 @@ class CRM_Core_BAO_Block { * @param array $params * Input parameters to find object. * - * @return array of $block objects. + * @return array + * of $block objects. * @static */ public static function &getValues($blockName, $params) { @@ -102,7 +103,8 @@ class CRM_Core_BAO_Block { * @param string $blockName * Name of the above object. * - * @return array of $block objects. + * @return array + * of $block objects. * @static */ public static function retrieveBlock(&$block, $blockName) { @@ -133,7 +135,8 @@ class CRM_Core_BAO_Block { * @param array $params * Associated array of submitted fields. * - * @return boolean true if the block has data, otherwise false + * @return boolean + * true if the block has data, otherwise false * @static */ public static function dataExists($blockFields, &$params) { @@ -153,7 +156,8 @@ class CRM_Core_BAO_Block { * @param array $params * Associated array of submitted fields. * - * @return boolean true if the block exits, otherwise false + * @return boolean + * true if the block exits, otherwise false * @static */ public static function blockExists($blockName, &$params) { @@ -176,7 +180,8 @@ class CRM_Core_BAO_Block { * @param null $entityElements * @param bool $updateBlankLocInfo * - * @return array $contactBlockIds formatted array of block ids + * @return array + * formatted array of block ids * * @static */ @@ -219,7 +224,8 @@ class CRM_Core_BAO_Block { * @param null $entity * @param int $contactId * - * @return object CRM_Core_BAO_Block object on success, null otherwise + * @return object + * CRM_Core_BAO_Block object on success, null otherwise * @static */ public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) { diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index a359d183d6..6339f9f12f 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -228,7 +228,8 @@ class CRM_Core_BAO_CMSUser { * @param string $mail * Email id for cms user. * - * @return int contact id that has been created + * @return int + * contact id that has been created * @static */ public static function create(&$params, $mail) { diff --git a/CRM/Core/BAO/Cache.php b/CRM/Core/BAO/Cache.php index 195d09e206..31691b1151 100644 --- a/CRM/Core/BAO/Cache.php +++ b/CRM/Core/BAO/Cache.php @@ -61,7 +61,8 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { * @param int $componentID * The optional component ID (so componenets can share the same name space). * - * @return object The data if present in cache, else null + * @return object + * The data if present in cache, else null * @static */ public static function &getItem($group, $path, $componentID = NULL) { @@ -100,7 +101,8 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache { * @param int $componentID * The optional component ID (so componenets can share the same name space). * - * @return object The data if present in cache, else null + * @return object + * The data if present in cache, else null * @static */ public static function &getItems($group, $componentID = NULL) { diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 2de616d0ee..fae2fdf2bc 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -205,7 +205,7 @@ class CRM_Core_BAO_ConfigSetting { * * @param $defaults * - * @return array $defaults + * @return array * @static */ public static function retrieve(&$defaults) { @@ -484,7 +484,8 @@ class CRM_Core_BAO_ConfigSetting { /** * Return likely default settings - * @return array site settings + * @return array + * site settings * -$url, * - $dir Base Directory * - $siteName @@ -660,7 +661,8 @@ WHERE option_group_id = ( * @param string $componentName * Name of the component to be enabled, needs to be valid. * - * @return boolean - true if valid component name and enabling succeeds, else false + * @return boolean + * true if valid component name and enabling succeeds, else false * @static */ public static function enableComponent($componentName) { diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 3878dc9677..c5e7b84ba3 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -68,7 +68,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * * @param NULL * - * @return array Data type => Description + * @return array + * Data type => Description * @static */ public static function &dataType() { @@ -341,7 +342,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -360,7 +362,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $id * Id of field. * - * @return string name + * @return string + * name * * @static * @@ -389,7 +392,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param bool $checkPermission * If false, do not include permissioning clause. * - * @return array $fields - an array of active custom fields. + * @return array + * an array of active custom fields. * * @static */ @@ -612,7 +616,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * * @param bool $withMultiple * - * @return array $fields - + * @return array + * * * @static */ @@ -1130,7 +1135,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $contactID * @param int $fieldID * - * @return string the display value + * @return string + * the display value * * @static */ @@ -1587,7 +1593,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param bool $includeViewOnly * If true, fields marked 'View Only' are included. Required for APIv3. * - * @return array $customFormatted formatted custom field array + * @return array + * formatted custom field array * @static */ static function formatCustomField( @@ -2068,7 +2075,8 @@ WHERE id IN ( %1, %2 ) * @param bool $force * Force the sql to be run again (primarily used for tests). * - * @return array - fatal is fieldID does not exists, else array of tableName, columnName + * @return array + * fatal is fieldID does not exists, else array of tableName, columnName * @static */ public static function getTableColumnGroup($fieldID, $force = FALSE) { @@ -2412,7 +2420,8 @@ WHERE f.id IN ($ids)"; * Custom data submitted. * ie array( 'custom_1' => 'validate me' ); * - * @return array $errors validation errors. + * @return array + * validation errors. * @static */ public static function validateCustomData($params) { diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 95c7c45915..6d8b8e71bb 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -246,7 +246,8 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param bool $is_activeValue we want to set the is_active field. * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -290,7 +291,8 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * * @param int $activityTypeId * - * @return bool TRUE if a group is found or created; FALSE on error + * @return bool + * TRUE if a group is found or created; FALSE on error */ public static function autoCreateByActivityType($activityTypeId) { if (self::hasCustomGroup('Activity', NULL, $activityTypeId)) { @@ -327,7 +329,8 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param bool $fromCache * @param bool $onlySubType * - * @return array $groupTree - array The returned array is keyed by group id and has the custom group table fields + * @return array + * array The returned array is keyed by group id and has the custom group table fields * and a subkey 'fields' holding the specific custom fields. * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data * if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data' @@ -653,7 +656,8 @@ ORDER BY civicrm_custom_group.weight, * * @param bool $getCount * - * @return boolean does this entity have data in this custom table + * @return boolean + * does this entity have data in this custom table */ static public function customGroupDataExistsForEntity($entityID, $table, $getCount = FALSE) { $query = " @@ -874,7 +878,8 @@ ORDER BY civicrm_custom_group.weight, * @param int $id * Id of group. * - * @return string title + * @return string + * title * * @static * @@ -897,7 +902,8 @@ ORDER BY civicrm_custom_group.weight, * * @param null $inSelector * - * @return array $groupTree - array consisting of all group and field details + * @return array + * array consisting of all group and field details * * * @static @@ -1097,7 +1103,7 @@ ORDER BY civicrm_custom_group.weight, * @param string $entityType * What entity are we extending here ?. * - * @return string $tableName + * @return string * * @static * @@ -1246,7 +1252,8 @@ ORDER BY civicrm_custom_group.weight, * @param bool $force * whether to force the deletion, even if there are custom fields. * - * @return boolean false if field exists for this group, true if group gets deleted. + * @return boolean + * false if field exists for this group, true if group gets deleted. * * @static * @@ -1703,7 +1710,8 @@ ORDER BY civicrm_custom_group.weight, * Remove custom fields of a type eg: array("Individual") ;. * * - * @return boolean false if it matches else true + * @return boolean + * false if it matches else true * @static */ public static function checkCustomField($customFieldId, &$removeCustomFieldTypes) { @@ -1814,7 +1822,7 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * Group count by default 1, but can varry for multiple value custom data. * @param object form object * - * @return array $formattedGroupTree + * @return array */ public static function formatGroupTree(&$groupTree, $groupCount = 1, &$form) { $formattedGroupTree = array(); @@ -2213,7 +2221,8 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * @param array $fieldIds * Array of custom field ids. * - * @return array $groupLabels - array consisting of groups and fields labels with ids. + * @return array + * array consisting of groups and fields labels with ids. */ public static function getGroupTitles($fieldIds) { if (!is_array($fieldIds) && empty($fieldIds)) { @@ -2259,7 +2268,8 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT * @param int $gID * Custom group id. * - * @return boolean true if empty otherwise false. + * @return boolean + * true if empty otherwise false. */ public static function isGroupEmpty($gID) { if (!$gID) { @@ -2287,7 +2297,8 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT * @param array $types * Var which should have the list appended. * - * @return array of types. + * @return array + * of types. */ public static function getExtendedObjectTypes(&$types = array()) { static $flag = FALSE, $objTypes = array(); diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 5bb4b39c1d..7eb2998c56 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -68,7 +68,8 @@ class CRM_Core_BAO_CustomOption { * @param bool $inactiveNeededDo we need inactive options ?. * Do we need inactive options ?. * - * @return array $customOption all active options for fieldId + * @return array + * all active options for fieldId * @static */ static function getCustomOption( @@ -119,7 +120,8 @@ class CRM_Core_BAO_CustomOption { * @param string $dataType * the data type of the field (optional). * - * @return string the label to display for this custom field + * @return string + * the label to display for this custom field * @static */ public static function getOptionLabel($fieldId, $value, $htmlType = NULL, $dataType = NULL) { diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index f67e71ac35..e212a0a3ac 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -558,7 +558,8 @@ SELECT label, value * * @param NULL * - * @return array array of strings + * @return array + * array of strings */ public function query() { $this->select(); diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index 8d7561f39a..d11d107200 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -47,7 +47,8 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { * @param string $value * The data to be validated. * - * @return boolean True if the value is of the specified type + * @return boolean + * True if the value is of the specified type * @static */ public static function typecheck($type, $value) { diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index 4ee8074298..55e93630a5 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -389,7 +389,8 @@ class CRM_Core_BAO_CustomValueTable { * * @param bool $formatMultiRecordField * - * @return array $fields Array of custom values for the entity with key=>value + * @return array + * Array of custom values for the entity with key=>value * pairs specified as civicrm_custom_field.id => custom value. * Empty array if no custom values found. * @static diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 7df895acbc..d725b8c3e1 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -63,7 +63,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * @param bool $checkPermission * All or only authorized for the current user. * - * @return array $widgets array of dashlets + * @return array + * array of dashlets * @static */ public static function getDashlets($all = TRUE, $checkPermission = TRUE) { @@ -104,7 +105,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * Provide the dashlets for the contact id. * passed rather than the current user. * - * @return array $dashlets array of dashlets + * @return array + * array of dashlets * @static */ public static function getContactDashlets($flatFormat = FALSE, $contactID = NULL) { @@ -153,7 +155,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * When a user accesses their dashboard for the first time, set up * the default dashlets. * - * @return array of dashboard_id's + * @return array + * of dashboard_id's */ public static function initializeDashlets() { $dashlets = array(); @@ -194,7 +197,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * Comma separated list. * @param string $operator * - * @return boolean true if use has permission else false + * @return boolean + * true if use has permission else false */ public static function checkPermission($permission, $operator) { if ($permission) { @@ -268,7 +272,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * @param int $dashletID * Widget ID. * - * @return array associted array title and content + * @return array + * associted array title and content * @static */ public static function getDashletInfo($dashletID) { @@ -406,7 +411,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * @param array $params * Associated array. * - * @return object $dashlet returns dashlet object + * @return object + * $dashlet returns dashlet object * @static */ public static function addDashlet(&$params) { diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index c474aa5107..c4c7b03b00 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -70,7 +70,8 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return object CRM_Core_DAO_Discount object on success, otherwise null + * @return object + * CRM_Core_DAO_Discount object on success, otherwise null * @static */ public static function add(&$params) { @@ -89,7 +90,8 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { * @param string $entityTable * Entity table to be searched. * - * @return array $optionGroupIDs option group Ids associated with discount + * @return array + * option group Ids associated with discount * */ public static function getOptionGroup($entityId, $entityTable) { @@ -112,7 +114,8 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { * @param string $entityTable * Entity table to be searched. * - * @return integer $dao->id discount id of the set which matches + * @return integer + * $dao->id discount id of the set which matches * the date criteria */ public static function findSet($entityID, $entityTable) { diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index ad04e30ce3..32e2e2da57 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -135,7 +135,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * * @param NULL * - * @return array Location::getValues + * @return array + * Location::getValues */ public function &getLocationValues() { if ($this->_location == NULL) { @@ -158,7 +159,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * @param array $params * @param int $id * - * @return array domain + * @return array + * domain */ public static function edit(&$params, &$id) { $domain = new CRM_Core_DAO_Domain(); @@ -173,7 +175,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * * @param array $params * - * @return array domain + * @return array + * domain */ public static function create($params) { $domain = new CRM_Core_DAO_Domain(); @@ -200,7 +203,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * @param bool $skipFatal * - * @return array name & email for domain + * @return array + * name & email for domain * @throws Exception */ public static function getNameAndEmail($skipFatal = FALSE) { diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index e9d3b1f138..a02b2cb5dc 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -64,7 +64,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_Email object on success, null otherwise + * @return object + * CRM_Core_BAO_Email object on success, null otherwise * @static */ public static function add(&$params) { @@ -132,7 +133,8 @@ WHERE contact_id = {$params['contact_id']} * * @param bool $updateBlankLocInfo * - * @return array the array of email id's + * @return array + * the array of email id's * @static */ public static function allEmails($id, $updateBlankLocInfo = FALSE) { @@ -189,7 +191,8 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; * The array containing entity_id and. * entity_table name * - * @return array the array of email id's + * @return array + * the array of email id's * @static */ public static function allEntityEmails(&$entityElements) { @@ -283,7 +286,8 @@ AND reset_date IS NULL * Build From Email as the combination of all the email ids of the logged in user and * the domain email id * - * @return array an array of email ids + * @return array + * an array of email ids * @static */ public static function getFromEmail() { diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 12593abd3c..98b0eb5013 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -142,7 +142,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param string $entityTable * Name of entity table default:civicrm_contact. * - * @return array (total, added, notAdded) count of enities added to tag + * @return array + * (total, added, notAdded) count of enities added to tag * @static */ public static function addEntitiesToTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') { @@ -187,7 +188,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param string $entityTable * Name of entity table default:civicrm_contact. * - * @return array (total, removed, notRemoved) count of entities removed from tags + * @return array + * (total, removed, notRemoved) count of entities removed from tags * @static */ public static function removeEntitiesFromTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') { @@ -273,7 +275,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param object $tag * An object of a tag. * - * @return array $entityIds array of entity ids + * @return array + * array of entity ids */ public function getEntitiesByTag($tag) { $entityIds = array(); diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index ab1165c369..d66a57b807 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -470,7 +470,8 @@ AND CEF.entity_id = %2"; * @param string $separator * The string separator where to implode the urls. * - * @return array An array with 2 elements. The string and the number of attachments + * @return array + * An array with 2 elements. The string and the number of attachments * @static */ public static function attachmentInfo($entityTable, $entityID, $separator = '
') { diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 2a8e0a3dd6..bd769ca5e6 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -150,7 +150,8 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * To get single trxn id for a entity table i.e last or first. * @param bool $newTrxn * - * @return array $tag array of category id's the contact belongs to. + * @return array + * array of category id's the contact belongs to. * * @static */ @@ -193,7 +194,8 @@ LIMIT 1;"; * @param int $entity_id * Id of the entity usually the contactID. * - * @return array $tag array of catagory id's the contact belongs to. + * @return array + * array of catagory id's the contact belongs to. * * @static */ @@ -216,7 +218,8 @@ WHERE ft.entity_table = 'civicrm_contribution' AND ft.entity_id = %1 * Id of the latest payment. * * - * @return array $payment array of previous payments + * @return array + * array of previous payments * * @static */ @@ -269,7 +272,8 @@ WHERE ef2.financial_trxn_id =%1 * @param string $entity_table * Name of the entity table usually 'civicrm_contact'. * - * @return array $tag array of catagory id's the contact belongs to. + * @return array + * array of catagory id's the contact belongs to. * * @static */ diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index 79374fdfe4..382abb86c4 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -44,7 +44,8 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_IM object on success, null otherwise + * @return object + * CRM_Core_BAO_IM object on success, null otherwise * @static */ public static function add(&$params) { @@ -80,7 +81,8 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { * * @param bool $updateBlankLocInfo * - * @return array the array of im details + * @return array + * the array of im details * @static */ public static function allIMs($id, $updateBlankLocInfo = FALSE) { @@ -131,7 +133,8 @@ ORDER BY * The array containing entity_id and. * entity_table name * - * @return array the array of im details + * @return array + * the array of im details * @static */ public static function allEntityIMs(&$entityElements) { diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 1aad25f0c9..87eb2b47ff 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -91,7 +91,8 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index 16d7145826..f9df000f4c 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -159,7 +159,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of page orientations + * @return array + * array of page orientations * @static */ public static function getPageOrientations() { @@ -175,7 +176,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param string $name * Group name. * - * @return array array of font names + * @return array + * array of font names * @static */ public static function getFontNames($name = 'label_format') { @@ -188,7 +190,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of font sizes + * @return array + * array of font sizes * @static */ public static function getFontSizes() { @@ -205,7 +208,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of measurement units + * @return array + * array of measurement units * @static */ public static function getUnits() { @@ -222,7 +226,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of alignments + * @return array + * array of alignments * @static */ public static function getTextAlignments() { @@ -238,7 +243,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of alignments + * @return array + * array of alignments * @static */ public static function getFontStyles() { @@ -254,7 +260,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param string $name * - * @return int Group ID (null if Group ID doesn't exist) + * @return int + * Group ID (null if Group ID doesn't exist) */ private static function _getGid($name = 'label_format') { if (!isset(self::$_gid[$name]) || !self::$_gid[$name]) { @@ -273,7 +280,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param string $returnURL * URL of page calling this function. * - * @return array (reference) List of Label Formats + * @return array + * (reference) List of Label Formats * @static */ public static function addOrder(&$list, $returnURL) { @@ -289,7 +297,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param string $groupName * Group name of the label format option group. * - * @return array (reference) label format list + * @return array + * (reference) label format list * @static */ public static function &getList($namesOnly = FALSE, $groupName = 'label_format') { @@ -319,7 +328,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param string $groupName * Label format group name. * - * @return array Name/value pairs containing the default Label Format values. + * @return array + * Name/value pairs containing the default Label Format values. * @static */ public static function &getDefaultValues($groupName = 'label_format') { @@ -345,7 +355,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param string $groupName * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getLabelFormat($field, $val, $groupName = 'label_format') { $params = array('is_active' => 1, $field => $val); @@ -364,7 +375,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param int $name * Label format name. Empty = get default label format. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getByName($name) { return self::getLabelFormat('name', $name); @@ -378,7 +390,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * @param string $groupName * Group name. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getById($id, $groupName = 'label_format') { return self::getLabelFormat('id', $id, $groupName); diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 7eb55cd0d8..65ba7ab125 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -54,7 +54,7 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { * * @param null $entity * - * @return array $location + * @return array * @static */ public static function create(&$params, $fixAddress = TRUE, $entity = NULL) { @@ -156,7 +156,8 @@ WHERE e.id = %1"; * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_locBlock object on success, null otherwise + * @return object + * CRM_Core_BAO_locBlock object on success, null otherwise * @static */ public static function addLocBlock(&$params) { @@ -236,7 +237,8 @@ WHERE e.id = %1"; * @param $entityBlock * @param bool $microformat * - * @return array array of objects(CRM_Core_BAO_Location) + * @return array + * array of objects(CRM_Core_BAO_Location) * @static */ public static function &getValues($entityBlock, $microformat = FALSE) { @@ -306,7 +308,8 @@ WHERE e.id = %1"; * @param int $updateLocBlockId * Update location block id. * - * @return int newly created/updated location block id. + * @return int + * newly created/updated location block id. */ public static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) { //get the location info. diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 3144feabf4..8fc79a71a8 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -76,7 +76,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -89,7 +90,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { * * @param NULL * - * @return object The default location type object on success, + * @return object + * The default location type object on success, * null otherwise * @static */ diff --git a/CRM/Core/BAO/Log.php b/CRM/Core/BAO/Log.php index e50ec7c58a..e342a6486b 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -157,7 +157,8 @@ UPDATE civicrm_log * * @param int $contactID * - * @return int count of log records + * @return int + * count of log records * @static */ public static function getContactLogCount($contactID) { @@ -170,7 +171,8 @@ UPDATE civicrm_log * Function for find out whether to use logging schema entries for contact * summary, instead of normal log entries. * - * @return int report id of Contact Logging Report (Summary) / false + * @return int + * report id of Contact Logging Report (Summary) / false * @static */ public static function useLoggingReport() { diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index 93b5ab351b..9d9b552f2b 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -65,7 +65,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Return the domain from the default set of settings * - * @return string default domain + * @return string + * default domain */ public static function defaultDomain() { return self::defaultDAO()->domain; @@ -74,7 +75,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Return the localpart from the default set of settings * - * @return string default localpart + * @return string + * default localpart */ public static function defaultLocalpart() { return self::defaultDAO()->localpart; @@ -83,7 +85,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Return the return path from the default set of settings * - * @return string default return path + * @return string + * default return path */ public static function defaultReturnPath() { return self::defaultDAO()->return_path; @@ -92,7 +95,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Return the "include message ID" flag from the default set of settings. * - * @return boolean default include message ID + * @return boolean + * default include message ID */ public static function includeMessageId() { return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 3b5d659e4a..ae3374a289 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -49,7 +49,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return object CRM_Core_DAO_Mapping object on success, otherwise NULL + * @return object + * CRM_Core_DAO_Mapping object on success, otherwise NULL * @static */ public static function retrieve(&$params, &$defaults) { @@ -100,7 +101,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param array $params * An array of name/value pairs. * - * @return object CRM_Core_DAO_Mapper object on success, otherwise NULL + * @return object + * CRM_Core_DAO_Mapper object on success, otherwise NULL * @static */ public static function add($params) { @@ -117,7 +119,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param string $mappingTypeId * Mapping type id. * - * @return array $mapping array of mapping name + * @return array + * array of mapping name * @static */ public static function getMappings($mappingTypeId) { @@ -139,7 +142,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $mappingId * Mapping id. * - * @return array $mappingFields array of mapping fields + * @return array + * array of mapping fields * @static */ public static function getMappingFields($mappingId) { @@ -214,7 +218,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $smartGroupId * Smart group id. * - * @return array $returnFields associated array of elements + * @return array + * associated array of elements * @static */ public static function getFormattedFields($smartGroupId) { @@ -917,7 +922,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $relationshipTypeId * Related relationship type id. * - * @return array all custom field titles + * @return array + * all custom field titles */ public function getRelationTypeCustomGroupData($relationshipTypeId) { @@ -961,7 +967,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * Row no of the fields. * * - * @return array $returnFields formatted associated array of elements + * @return array + * formatted associated array of elements * @static */ public static function formattedFields(&$params, $row = FALSE) { diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 99466c6d0d..95e4689489 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -69,7 +69,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, NULL otherwise + * @return Object + * DAO object on sucess, NULL otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -310,7 +311,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * @param array $params * A string-keyed array of function params, see function body for details. * - * @return array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates + * @return array + * of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates */ public static function sendTemplate($params) { $defaults = array( diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 53dad5cabc..7c9e19068e 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -52,7 +52,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, NULL otherwise + * @return Object + * DAO object on sucess, NULL otherwise * * @static */ @@ -64,7 +65,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * Get existing / build navigation for CiviCRM Admin Menu * * @static - * @return array associated array + * @return array + * associated array */ public static function getMenus() { $menus = array(); @@ -86,7 +88,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * * @param array associated array of submitted values * - * @return object navigation object + * @return object + * navigation object * @static */ public static function add(&$params) { @@ -154,7 +157,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * @param int $menuID * Menu id. * - * @return int $weight string + * @return int + * $weight string * @static */ public static function calculateWeight($parentID = NULL, $menuID = NULL) { @@ -179,7 +183,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { /** * Get formatted menu list * - * @return array $navigations returns associated array + * @return array + * returns associated array * @static */ public static function getNavigationList() { @@ -272,7 +277,8 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare * @param bool $navigationMenu * True when called for building top navigation menu. * - * @return array $navigationTree nested array of menus + * @return array + * nested array of menus * @static */ public static function buildNavigationTree(&$navigationTree, $parentID, $navigationMenu = TRUE) { @@ -579,7 +585,8 @@ ORDER BY parent_id, weight"; * @param int $contactID * Contact id. * - * @return string $navigation returns navigation html + * @return string + * returns navigation html * @static */ public static function createNavigation($contactID) { @@ -802,7 +809,8 @@ ORDER BY parent_id, weight"; * @param int $navigationID * Navigation id. * - * @return array associated array + * @return array + * associated array * @static */ public static function getNavigationInfo($navigationID) { diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 84f8aa61b6..d3d51138ce 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -50,7 +50,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param int $id * Id of the note to retrieve. * - * @return string the note text or NULL if note not found + * @return string + * the note text or NULL if note not found * * @static */ @@ -64,7 +65,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param int $id * Id of the note to retrieve. * - * @return string the note subject or NULL if note not found + * @return string + * the note subject or NULL if note not found * * @static */ @@ -78,7 +80,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param object $note * Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself. * - * @return boolean TRUE if the note should be displayed, otherwise FALSE + * @return boolean + * TRUE if the note should be displayed, otherwise FALSE * * @static */ @@ -136,7 +139,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param array $ids * (deprecated) associated array with note id - preferably set $params['id']. * - * @return object $note CRM_Core_BAO_Note object + * @return object + * $note CRM_Core_BAO_Note object * @static */ public static function &add(&$params, $ids = array()) { @@ -245,7 +249,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param int $numNotes * The maximum number of notes to return (0 if all). * - * @return object $notes Object of CRM_Core_BAO_Note + * @return object + * $notes Object of CRM_Core_BAO_Note * @static */ public static function &getValues(&$params, &$values, $numNotes = self::MAX_NOTES) { @@ -364,7 +369,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * * @param string $entityTable * - * @return array $viewNote array of note properties + * @return array + * array of note properties * * @static */ @@ -395,7 +401,8 @@ ORDER BY modified_date desc"; * * @param int $contactID * - * @return int $count count of log records + * @return int + * $count count of log records * * @static */ @@ -423,7 +430,8 @@ ORDER BY modified_date desc"; * @param bool $snippet * If TRUE, returned values will be pre-formatted for display in a table of notes. * - * @return array Nested associative array beginning with direct children of given note. + * @return array + * Nested associative array beginning with direct children of given note. * * @static */ @@ -437,7 +445,8 @@ ORDER BY modified_date desc"; * @param int $id * Note ID. * - * @return int $count Number of notes having the give note as parent + * @return int + * $count Number of notes having the give note as parent * * @static */ @@ -469,7 +478,8 @@ ORDER BY modified_date desc"; * @param int $depth * Depth of current iteration within the descendent tree (used for comparison against maxDepth). * - * @return array Nested associative array beginning with direct children of given note. + * @return array + * Nested associative array beginning with direct children of given note. * @static */ private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE, &$tree = array(), $depth = 0) { @@ -533,7 +543,8 @@ ORDER BY modified_date desc"; * @param array $ids * (reference) one-dimensional array to store found descendent ids. * - * @return array $ids One-dimensional array containing ids of all desendent notes + * @return array + * One-dimensional array containing ids of all desendent notes */ public static function getDescendentIds($parentId, &$ids = array()) { // get direct children of given parentId note diff --git a/CRM/Core/BAO/OpenID.php b/CRM/Core/BAO/OpenID.php index feb9f97b51..619aa13e65 100644 --- a/CRM/Core/BAO/OpenID.php +++ b/CRM/Core/BAO/OpenID.php @@ -44,7 +44,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_OpenID object on success, null otherwise + * @return object + * CRM_Core_BAO_OpenID object on success, null otherwise * @static */ public static function add(&$params) { @@ -99,7 +100,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { * * @param bool $updateBlankLocInfo * - * @return array the array of openid's + * @return array + * the array of openid's * @static */ public static function allOpenIDs($id, $updateBlankLocInfo = FALSE) { diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index 3c3000ed9b..c393b3637d 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -70,7 +70,8 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -137,7 +138,8 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { * @param int $optionGroupId * Id of the Option Group. * - * @return String title + * @return String + * title * * @static */ diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 21fd31a6b5..eca85e0233 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -151,7 +151,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -251,7 +252,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param int $activityTypeId * Activity type id. * - * @return array label and description + * @return array + * label and description * @static */ public static function getActivityTypeDetails($activityTypeId) { @@ -274,7 +276,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param int $id * Id of Option Value. * - * @return string title + * @return string + * title * * @static * @@ -449,7 +452,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param int $optionGroupID * The option group for which we want the values from. * - * @return array an array of array of values for this option group + * @return array + * an array of array of values for this option group * @static */ public static function getOptionValuesArray($optionGroupID) { @@ -482,7 +486,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param int $optionGroupID * The option group for which we want the values from. * - * @return array an associative array of label, value pairs + * @return array + * an associative array of label, value pairs * @static */ public static function getOptionValuesAssocArray($optionGroupID) { @@ -501,7 +506,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param string $optionGroupName * The option group name for which we want the values from. * - * @return array an associative array of label, value pairs + * @return array + * an associative array of label, value pairs * @static */ public static function getOptionValuesAssocArrayFromName($optionGroupName) { diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index bfce94cdb8..485dccde17 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -72,7 +72,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * * @param void * - * @return int Group ID (null if Group ID doesn't exist) + * @return int + * Group ID (null if Group ID doesn't exist) */ private static function _getGid() { if (!self::$_gid) { @@ -91,7 +92,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param string $returnURL * URL of page calling this function. * - * @return array (reference) List of Paper Sizes + * @return array + * (reference) List of Paper Sizes * @static */ public static function &addOrder(&$list, $returnURL) { @@ -105,7 +107,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param bool $namesOnly * Return simple list of names. * - * @return array (reference) Paper Size list + * @return array + * (reference) Paper Size list * @static */ public static function &getList($namesOnly = FALSE) { @@ -134,7 +137,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * * @param NULL * - * @return array Name/value pairs containing the default Paper Size values. + * @return array + * Name/value pairs containing the default Paper Size values. * @static */ public static function &getDefaultValues() { @@ -158,7 +162,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param int $val * Field value to search for. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getPaperFormat($field, $val) { $params = array('is_active' => 1, $field => $val); @@ -177,7 +182,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param int $name * Paper Size name. Empty = get default Paper Size. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getByName($name) { return self::getPaperFormat('name', $name); @@ -189,7 +195,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param int $id * Paper Size id. 0 = get default Paper Size. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getById($id) { return self::getPaperFormat('id', $id); diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php index 40e3ca82bc..a858a1dcd1 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -99,7 +99,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of page orientations + * @return array + * array of page orientations */ public static function getPageOrientations() { return array( @@ -113,7 +114,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return array array of measurement units + * @return array + * array of measurement units */ public static function getUnits() { return array( @@ -129,7 +131,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * * @param void * - * @return int Group ID (null if Group ID doesn't exist) + * @return int + * Group ID (null if Group ID doesn't exist) */ private static function _getGid() { if (!self::$_gid) { @@ -162,7 +165,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param bool $namesOnly * Return simple list of names. * - * @return array (reference) PDF Page Format list + * @return array + * (reference) PDF Page Format list * @static */ public static function &getList($namesOnly = FALSE) { @@ -191,7 +195,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * * @param NULL * - * @return array Name/value pairs containing the default PDF Page Format values. + * @return array + * Name/value pairs containing the default PDF Page Format values. * @static */ public static function &getDefaultValues() { @@ -218,7 +223,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param int $val * Field value to search for. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getPdfFormat($field, $val) { $params = array('is_active' => 1, $field => $val); @@ -237,7 +243,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param int $name * PDF Page Format name. Empty = get default PDF Page Format. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getByName($name) { return self::getPdfFormat('name', $name); @@ -249,7 +256,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param int $id * PDF Page Format id. 0 = get default PDF Page Format. * - * @return array $values (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public static function &getById($id) { return self::getPdfFormat('id', $id); diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index a5868e3c10..b6563d059d 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -72,7 +72,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_Phone object on success, null otherwise + * @return object + * CRM_Core_BAO_Phone object on success, null otherwise * @static */ public static function add(&$params) { @@ -96,7 +97,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * * @param array entityBlock input parameters to find object * - * @return array array of phone objects + * @return array + * array of phone objects * @static */ public static function &getValues($entityBlock) { @@ -114,7 +116,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * @param null $type * @param array $filters * - * @return array the array of phone ids which are potential numbers + * @return array + * the array of phone ids which are potential numbers * @static */ public static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array()) { @@ -186,7 +189,8 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; * * @param null $type * - * @return array the array of phone ids which are potential numbers + * @return array + * the array of phone ids which are potential numbers * @static */ public static function allEntityPhones($entityElements, $type = NULL) { diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index efe1ed99ce..26bf706142 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -75,7 +75,8 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 06f98119f5..633656a42d 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -224,7 +224,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function builds a "When" object based on schedule/reminder params * - * @return object When object + * @return object + * When object */ public function generateRecursion() { // return if already generated @@ -315,7 +316,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function iterates through when object criterias and * generates recursive dates based on that * - * @return array array of dates + * @return array + * array of dates */ public function generateRecursiveDates() { $this->generateRecursion(); @@ -403,7 +405,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * * @static * - * @return array an array of child ids + * @return array + * an array of child ids */ static public function getEntitiesForParent($parentId, $entityTable, $includeParent = TRUE, $mode = 3, $initiatorId = NULL) { $entities = array(); @@ -471,7 +474,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * * @static * - * @return array array of connected ids + * @return array + * array of connected ids */ static public function getEntitiesFor($entityId, $entityTable, $includeParent = TRUE, $mode = 3) { $parentId = self::getParentFor($entityId, $entityTable); @@ -493,7 +497,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * * @static * - * @return int unsigned $parentId Parent ID + * @return int + * unsigned $parentId Parent ID */ static public function getParentFor($entityId, $entityTable, $includeParent = TRUE) { if (empty($entityId) || empty($entityTable)) { @@ -951,7 +956,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * @param array $scheduleReminderDetails * Array of repeat criterias saved in civicrm_action_schedule table . * - * @return object When object + * @return object + * When object */ public function getRecursionFromSchedule($scheduleReminderDetails = array()) { $r = new When(); @@ -1059,7 +1065,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * * @static * - * @return object DateTime object which contain time difference + * @return object + * DateTime object which contain time difference */ static public function getInterval($startDate, $endDate) { if ($startDate && $endDate) { diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 7ab3f5778f..af3cbf7bfe 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -79,7 +79,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param int $domainID * @param bool $force * - * @return boolean true if item is already in cache + * @return boolean + * true if item is already in cache * @static */ static function inCache( @@ -529,7 +530,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param bool $createMode * * @throws api_Exception - * @return array $fieldstoset name => value array of the fields to be set (with extraneous removed) + * @return array + * name => value array of the fields to be set (with extraneous removed) */ public static function validateSettingsInput($params, &$fields, $createMode = TRUE) { $group = CRM_Utils_Array::value('group', $params); @@ -635,7 +637,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @param int $domainID * @param null $profile * - * @return array $result - the following information as appropriate for each setting + * @return array + * the following information as appropriate for each setting * - name * - type * - default diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index 475bb5f6ff..e6d1efdf7d 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -49,7 +49,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return object CRM_Core_DAO_Tag object on success, otherwise null + * @return object + * CRM_Core_DAO_Tag object on success, otherwise null * @static */ public static function retrieve(&$params, &$defaults) { @@ -359,7 +360,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * (optional) the array that holds all the db ids - we are moving away from this in bao. * signatures * - * @return object CRM_Core_DAO_Tag object on success, otherwise null + * @return object + * CRM_Core_DAO_Tag object on success, otherwise null * @static */ public static function add(&$params, $ids = array()) { @@ -429,7 +431,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * @param string $entityTable * Entity_table. * - * @return array $tagSets array of tag sets + * @return array + * array of tag sets * @static */ public static function getTagSet($entityTable) { @@ -447,7 +450,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Get the tags that are not children of a tagset. * - * @return array $tags associated array of tag name and id + * @return array + * 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 dd7b25f2a8..4d062734dd 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -67,7 +67,8 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { * @param int $id * Id of uf_form. * - * @return string title + * @return string + * title * * @static * @@ -84,7 +85,8 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -371,7 +373,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param int $UFFieldId * - * @return boolean false if custom field are disabled else true + * @return boolean + * false if custom field are disabled else true * @static */ public static function checkUFStatus($UFFieldId) { @@ -461,7 +464,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * @param array $optional * Array of types those are optional. * - * @return boolean $valid + * @return boolean * @static */ public static function checkValidProfileType($ufGroupId, $required, $optional = NULL) { @@ -578,7 +581,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param bool $skipComponentType * - * @return string profile group_type + * @return string + * profile group_type * @static * * TODO Why is this function in this class? It seems to be about the UFGroup. @@ -602,7 +606,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * True if only pure profiles are required. * @param bool $skipComponentType * - * @return string profile group_type + * @return string + * profile group_type * @static * * TODO Why is this function in this class? It seems to be about the UFGroup. @@ -740,7 +745,7 @@ SELECT ufg.id as id * * @param int $profileID * - * @return boolean $result true/false. + * @return boolean */ public static function checkSearchableORInSelector($profileID) { $result = FALSE; @@ -768,7 +773,8 @@ SELECT id * * @param int $profileID * - * @return void. + * @return void + * */ public function resetInSelectorANDSearchable($profileID) { if (!$profileID) { @@ -801,7 +807,8 @@ SELECT id * Filter to apply to profile fields - expected usage is to only fill based on. * the bottom profile per CRM-13726 * - * @return bool Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118) + * @return bool + * Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118) */ public static function assignAddressField($key, &$profileAddressFields, $profileFilter) { $billing_id = CRM_Core_BAO_LocationType::getBilling(); diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 987b3126e0..b3de37652c 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -56,7 +56,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param array $defaults * (reference) an assoc array to hold the flattened values. * - * @return object CRM_Core_DAO_UFGroup object + * @return object + * CRM_Core_DAO_UFGroup object * @static */ public static function retrieve(&$params, &$defaults) { @@ -69,7 +70,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param int $id * Id of uf_group. * - * @return string contact type + * @return string + * contact type */ public static function getContactType($id) { @@ -101,7 +103,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param int $id * Id of uf_form. * - * @return string title + * @return string + * title * * @static * @@ -118,7 +121,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object CRM_Core_DAO_UFGroup object on success, null otherwise + * @return Object + * CRM_Core_DAO_UFGroup object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -135,7 +139,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * * @param null $ctype * - * @return array the fields that are needed for registration + * @return array + * the fields that are needed for registration * @static */ public static function getRegistrationFields($action, $mode, $ctype = NULL) { @@ -196,7 +201,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param null $restrict * @param bool $skipPermission * @param int $permissionType - * @return array the fields that are listings related + * @return array + * the fields that are listings related * @static */ static function getListingFields( @@ -275,7 +281,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param string $orderBy * @param null $orderProfiles * - * @return array the fields that belong to this ufgroup(s) + * @return array + * the fields that belong to this ufgroup(s) * @static */ static function getFields( @@ -591,7 +598,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param bool $searchable * @param bool $showAll * @param int $visibility - * @return bool TRUE if field is displayable + * @return bool + * TRUE if field is displayable */ protected static function filterUFField($field, $searchable, $showAll, $visibility) { if ($searchable && $field->is_searchable != 1) { @@ -710,7 +718,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * The action of the form. * * @pram boolean $register is this the registrtion form - * @return boolean true if form is valid + * @return boolean + * true if form is valid * @static */ public static function isValid($userID, $title, $register = FALSE, $action = NULL) { @@ -761,7 +770,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param bool $doNotProcess * @param null $ctype * - * @return string the html for the form on success, otherwise empty string + * @return string + * the html for the form on success, otherwise empty string * @static */ static function getEditHTML( @@ -1563,7 +1573,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $status * If set return module other than default modules (User Account/User registration/Profile). * - * @return array $ufGroupJoinRecords + * @return array * * @static */ @@ -1640,7 +1650,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $ufGroupId * If $ufGroupId get update weight or add weight. * - * @return int weight of the UFGroup + * @return int + * weight of the UFGroup * @static */ public static function getWeight($ufGroupId = NULL) { @@ -1676,7 +1687,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Which operation (view, edit, create, etc) to check permission for. * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default * - * @return array $ufGroups array of ufgroups for a module + * @return array + * array of ufgroups for a module * @static */ public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission::VIEW, $returnFields = NULL) { @@ -1748,7 +1760,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Uf group id (profile id). * @param int $contactID * - * @return boolean true or false + * @return boolean + * true or false * @static */ public static function filterUFGroups($ufGroupId, $contactID = NULL) { @@ -2593,7 +2606,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param bool $onlyPure * True if only pure profiles are required. * - * @return array $profiles associative array of profiles + * @return array + * associative array of profiles * @static */ public static function getProfiles($types, $onlyPure = FALSE) { @@ -2623,7 +2637,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param array $optional * Array of types those are optional. * - * @return array $profiles associative array of profiles + * @return array + * associative array of profiles * @static */ public static function getValidProfiles($required, $optional = NULL) { @@ -2655,7 +2670,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param array $required * Array of fields those are required in the profile. * - * @return array $profiles associative array of profiles + * @return array + * associative array of profiles * @static */ public static function checkValidProfile($ufId, $required = NULL) { @@ -2897,7 +2913,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @param int $contactId * - * @return array $data assoicated formatted array + * @return array + * assoicated formatted array * @static */ public static function formatFields($params, $contactId = NULL) { @@ -3032,7 +3049,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $ignoreFieldId * Ignore particular profile field. * - * @return array list of calculated group type + * @return array + * list of calculated group type */ public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { //get the profile fields. @@ -3048,7 +3066,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $ignoreFieldId * Ignore perticular profile field. * - * @return array list of calculated group type + * @return array + * list of calculated group type */ public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { $groupType = $groupTypeValues = $customFieldIds = array(); @@ -3223,7 +3242,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @param bool $isStandalone * - * @return void. + * @return void + * */ public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) { if (!$componentId || @@ -3415,7 +3435,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $profileID * Id of the profile. * - * @return array returns array + * @return array + * returns array * @static */ public static function profileGroups($profileID) { @@ -3437,7 +3458,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param int $contactId * User contact id. * - * @return array $subscribeGroupIds This contains array of groups for subscription + * @return array + * This contains array of groups for subscription */ public static function getDoubleOptInGroupIds(&$params, $contactId = NULL) { $config = CRM_Core_Config::singleton(); @@ -3510,7 +3532,8 @@ SELECT group_id * @param array $profileIds * Associated array of profile ids. * - * @return boolean $mixProfile true if profile is mixed + * @return boolean + * true if profile is mixed * @static */ public static function checkForMixProfiles($profileIds) { @@ -3560,7 +3583,8 @@ SELECT group_id /** * Determine of we show overlay profile or not * - * @return boolean true if profile should be shown else false + * @return boolean + * true if profile should be shown else false * @static */ public static function showOverlayProfile() { @@ -3587,7 +3611,8 @@ SELECT group_id * @param int $profileId * @param string $groupType * - * @return Array group type values + * @return Array + * group type values * @static */ public static function groupTypeValues($profileId, $groupType = NULL) { @@ -3660,7 +3685,8 @@ SELECT group_id /** * Get profiles used for batch entry * - * @return array profileIds profile ids + * @return array + * profileIds profile ids * @static */ public static function getBatchProfiles() { diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index 557e6523b0..3cbe698ea4 100644 --- a/CRM/Core/BAO/UFJoin.php +++ b/CRM/Core/BAO/UFJoin.php @@ -95,7 +95,8 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return int or null + * @return int + * or null * @static */ public static function findJoinEntryId(&$params) { @@ -132,7 +133,8 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return int or null + * @return int + * or null * @static */ public static function findUFGroupId(&$params) { diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index f33d6edfcb..4c63a4d41b 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -496,7 +496,8 @@ AND domain_id = %4 * @param int $ufID * Id of UF for which related contact_id is required. * - * @return int contact_id on success, null otherwise + * @return int + * contact_id on success, null otherwise * @static */ public static function getContactId($ufID) { @@ -520,7 +521,8 @@ AND domain_id = %4 * @param int $contactID * ID of the contact for which related uf_id is required. * - * @return int uf_id of the given contact_id on success, null otherwise + * @return int + * uf_id of the given contact_id on success, null otherwise * @static */ public static function getUFId($contactID) { @@ -550,7 +552,8 @@ AND domain_id = %4 * Get the list of contact_id * * - * @return int contact_id on success, null otherwise + * @return int + * contact_id on success, null otherwise * @static */ public static function getContactIDs() { @@ -569,7 +572,8 @@ AND domain_id = %4 * * @param int $openId * - * @return bool true if allowed to login, false otherwise + * @return bool + * true if allowed to login, false otherwise * @static */ public static function getAllowedToLogin($openId) { @@ -587,7 +591,8 @@ AND domain_id = %4 * have id's (it uses OpenIDs, which go in a different field) * * - * @return int next highest unused value for uf_id + * @return int + * next highest unused value for uf_id * @static */ public static function getNextUfIdValue() { diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index ff08619fd1..c0c29093d0 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -44,7 +44,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_Website object on success, null otherwise + * @return object + * CRM_Core_BAO_Website object on success, null otherwise * @static */ public static function add(&$params) { @@ -163,7 +164,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * * @param bool $updateBlankLocInfo * - * @return array the array of website details + * @return array + * the array of website details * @static */ public static function allWebsites($id, $updateBlankLocInfo = FALSE) { diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index 8fff450e2c..6c0c3a33b3 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -228,7 +228,8 @@ WHERE domain_id = %1 * * @param bool $rebuildEach * Whether to perform rebuild after each individual API call. - * @return array Each item is $params for WordReplacement.create + * @return array + * Each item is $params for WordReplacement.create * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams */ public static function getConfigArraysAsAPIParams($rebuildEach) { diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index d566719541..e055213ee8 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -188,7 +188,8 @@ class CRM_Core_Block { * @param string $property * The desired property. * - * @return string the value of the desired property + * @return string + * the value of the desired property */ public static function getProperty($id, $property) { if (!(self::$_properties)) { @@ -219,7 +220,8 @@ class CRM_Core_Block { /** * Returns the whole $_properties array * - * @return array the $_properties array + * @return array + * the $_properties array */ public static function properties() { if (!(self::$_properties)) { diff --git a/CRM/Core/CodeGen/Main.php b/CRM/Core/CodeGen/Main.php index a395224489..585e386d7d 100644 --- a/CRM/Core/CodeGen/Main.php +++ b/CRM/Core/CodeGen/Main.php @@ -123,7 +123,8 @@ Alternatively you can get a version of CiviCRM that matches your PHP version } /** - * @return array of class names; each class implements CRM_Core_CodeGen_ITask + * @return array + * of class names; each class implements CRM_Core_CodeGen_ITask */ public function getTasks() { $components = array( diff --git a/CRM/Core/CodeGen/Util/File.php b/CRM/Core/CodeGen/Util/File.php index 7b3b80899c..bbc0894a53 100644 --- a/CRM/Core/CodeGen/Util/File.php +++ b/CRM/Core/CodeGen/Util/File.php @@ -81,7 +81,8 @@ class CRM_Core_CodeGen_Util_File { * * @param array $pairs * Each item is an array(0 => $searchBaseDir, 1 => $filePattern). - * @return array of file paths + * @return array + * of file paths */ public static function findManyFiles($pairs) { $files = array(); diff --git a/CRM/Core/Component/Config.php b/CRM/Core/Component/Config.php index c43d242352..31e4d51032 100644 --- a/CRM/Core/Component/Config.php +++ b/CRM/Core/Component/Config.php @@ -45,7 +45,8 @@ abstract class CRM_Core_Component_Config { * @param $config * @param $oldMode * - * @return array collection of component settings + * @return array + * collection of component settings */ public function add($config, $oldMode) { foreach (get_class_vars(get_class($this)) as $key => $value) { diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 17f1288172..a5e1fffe53 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -115,7 +115,8 @@ abstract class CRM_Core_Component_Info { /** * EXPERIMENTAL: Get a list of AngularJS modules * - * @return array list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules) + * @return array + * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules) * @see CRM_Utils_Hook::angularModules */ public function getAngularModules() { @@ -127,7 +128,8 @@ abstract class CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array collection of required component settings + * @return array + * collection of required component settings * */ abstract public function getInfo(); @@ -135,7 +137,8 @@ abstract class CRM_Core_Component_Info { /** * Get a list of entities to register via API * - * @return array list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities) + * @return array + * list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities) * @see CRM_Utils_Hook::managedEntities */ public function getManagedEntities() { @@ -145,7 +148,8 @@ abstract class CRM_Core_Component_Info { /** * Provides permissions that are unwise for Anonymous Roles to have * - * @return array list of permissions + * @return array + * list of permissions * @see CRM_Component_Info::getPermissions */ public function getAnonymousPermissionWarnings() { @@ -171,7 +175,8 @@ abstract class CRM_Core_Component_Info { * * @param CRM_Core_DAO $dao * The item for which we want a reference count. - * @return array each item in the array is an array with keys: + * @return array + * each item in the array is an array with keys: * - name: string, eg "sql:civicrm_email:contact_id" * - type: string, eg "sql" * - count: int, eg "5" if there are 5 email addresses that refer to $dao @@ -225,7 +230,8 @@ abstract class CRM_Core_Component_Info { * Provides information whether given component is currently * marked as enabled in configuration. * - * @return boolean true if component is enabled, false if not + * @return boolean + * true if component is enabled, false if not * */ public function isEnabled() { @@ -309,7 +315,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's advanced search pane's template path. * - * @return string component's advanced search pane's template path + * @return string + * component's advanced search pane's template path * */ public function getAdvancedSearchPaneTemplatePath() { @@ -320,7 +327,8 @@ abstract class CRM_Core_Component_Info { /** * Provides information whether given component uses system wide search. * - * @return boolean true if component needs search integration + * @return boolean + * true if component needs search integration * */ public function usesSearch() { @@ -330,7 +338,8 @@ abstract class CRM_Core_Component_Info { /** * Provides the xml menu files * - * @return array array of menu files + * @return array + * array of menu files * */ public function menuFiles() { @@ -342,7 +351,8 @@ abstract class CRM_Core_Component_Info { * FIXME: It should be protected so the keyword is not * FIXME: accessed from beyond component infrastructure. * - * @return string component keyword + * @return string + * component keyword * */ public function getKeyword() { diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 0e4ff02611..a626a29b52 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -486,7 +486,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * we have two submit buttons, we could have one displayed as a button and * the other as an image, both are of type 'submit'. * - * @return string the name of the button that has been pressed by the user + * @return string + * the name of the button that has been pressed by the user */ public function getButtonName() { $data = &$this->container(); @@ -666,7 +667,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Getter for embedded * - * @return boolean return the embedded value + * @return boolean + * return the embedded value */ public function getEmbedded() { return $this->_embedded; @@ -686,7 +688,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Getter for skipRedirection * - * @return boolean return the skipRedirection value + * @return boolean + * return the skipRedirection value */ public function getSkipRedirection() { return $this->_skipRedirection; @@ -741,7 +744,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Getter for print * - * @return boolean return the print value + * @return boolean + * return the print value */ public function getPrint() { return $this->_print; diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 812bf7fa23..39a41273f5 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -315,7 +315,8 @@ class CRM_Core_DAO extends DB_DataObject { * @param bool $i18nRewrite * Whether to rewrite the query. * - * @return object the current DAO object after the query execution + * @return object + * the current DAO object after the query execution */ public function query($query, $i18nRewrite = TRUE) { // rewrite queries that should use $dbLocale-based views for multi-language installs @@ -400,7 +401,8 @@ class CRM_Core_DAO extends DB_DataObject { * * @static * - * @return array of CRM_Core_Reference_Interface + * @return array + * of CRM_Core_Reference_Interface */ public static function getReferenceColumns() { return array(); @@ -421,7 +423,8 @@ class CRM_Core_DAO extends DB_DataObject { * Get/set an associative array of table columns * * @param array key=>type array - * @return array (associative) + * @return array + * (associative) */ public function table() { $fields = &$this->fields(); @@ -506,7 +509,8 @@ class CRM_Core_DAO extends DB_DataObject { * @param array $params * (reference ) associative array of name/value pairs. * - * @return boolean did we copy all null values into the object + * @return boolean + * did we copy all null values into the object */ public function copyValues(&$params) { $fields = &$this->fields(); @@ -624,7 +628,8 @@ class CRM_Core_DAO extends DB_DataObject { * Field that i'm interested in or null if. * you want the attributes for all DAO text fields * - * @return array assoc array of name => attribute pairs + * @return array + * assoc array of name => attribute pairs * @static */ public static function getAttribute($class, $fieldName = NULL) { @@ -672,7 +677,8 @@ class CRM_Core_DAO extends DB_DataObject { * @param string $fieldName * The name of the field in the DAO. * - * @return boolean true if object exists + * @return boolean + * true if object exists * @static */ public static function objectExists($value, $daoName, $daoID, $fieldName = 'name') { @@ -697,7 +703,8 @@ class CRM_Core_DAO extends DB_DataObject { * @param bool $i18nRewrite * Whether to rewrite the query on multilingual setups. * - * @return boolean true if exists, else false + * @return boolean + * true if exists, else false * @static */ public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) { @@ -782,7 +789,8 @@ LIKE %1 * @param string $tableName * @param string $constraint * - * @return boolean true if constraint exists, false otherwise + * @return boolean + * true if constraint exists, false otherwise * @static */ public static function checkConstraintExists($tableName, $constraint) { @@ -810,7 +818,8 @@ LIKE %1 * * @throws Exception * - * @return boolean true if CONSTRAINT keyword exists, false otherwise + * @return boolean + * true if CONSTRAINT keyword exists, false otherwise */ public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) { $show = array(); @@ -845,7 +854,8 @@ LIKE %1 * @param string $tableName * @param string $columnName * - * @return boolean true if in format, false otherwise + * @return boolean + * true if in format, false otherwise * @static */ public static function checkFKConstraintInFormat($tableName, $columnName) { @@ -874,7 +884,8 @@ LIKE %1 * @param string $columnName * @param string $columnValue * - * @return boolean true if the value is always $columnValue, false otherwise + * @return boolean + * true if the value is always $columnValue, false otherwise * @static */ public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) { @@ -891,7 +902,8 @@ LIKE %1 * @param string $tableName * @param string $columnName * - * @return boolean true if if the value is always NULL, false otherwise + * @return boolean + * true if if the value is always NULL, false otherwise * @static */ public static function checkFieldIsAlwaysNull($tableName, $columnName) { @@ -907,7 +919,8 @@ LIKE %1 * * @param string $tableName * - * @return boolean true if exists, else false + * @return boolean + * true if exists, else false * @static */ public static function checkTableExists($tableName) { @@ -943,7 +956,8 @@ FROM civicrm_domain * @param int $id * Id of the DAO object being searched for. * - * @return object Object of the type of the class that called this function. + * @return object + * Object of the type of the class that called this function. */ public static function findById($id) { $object = new static(); @@ -1018,7 +1032,8 @@ FROM civicrm_domain * @param string $searchColumn * Name of the column you want to search by. * - * @return boolean true if we found and updated the object, else false + * @return boolean + * true if we found and updated the object, else false * @static */ public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') { @@ -1044,7 +1059,8 @@ FROM civicrm_domain * @param string $default * Default sort value. * - * @return string - sortString + * @return string + * sortString * @static */ public static function getSortString($sort, $default = NULL) { @@ -1075,7 +1091,8 @@ FROM civicrm_domain * @param array $returnProperities * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name'). * - * @return object an object of type referenced by daoName + * @return object + * an object of type referenced by daoName * @static */ public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) { @@ -1459,7 +1476,8 @@ SELECT contact_id * @param array $returnProperities * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name'). * - * @return object an object of type referenced by daoName + * @return object + * an object of type referenced by daoName * @static */ public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) { @@ -1537,7 +1555,8 @@ SELECT contact_id * @param array $strings * @param string $default * the value to use if $strings has no elements. - * @return string eg "abc","def","ghi" + * @return string + * eg "abc","def","ghi" */ public static function escapeStrings($strings, $default = NULL) { static $_dao = NULL; @@ -2006,7 +2025,8 @@ SELECT contact_id /** * Find all records which refer to this entity. * - * @return array of objects referencing this + * @return array + * of objects referencing this */ public function findReferences() { $links = self::getReferencesToTable(static::getTableName()); @@ -2029,7 +2049,8 @@ SELECT contact_id } /** - * @return array each item has keys: + * @return array + * each item has keys: * - name: string * - type: string * - count: int @@ -2069,7 +2090,8 @@ SELECT contact_id * @param string $tableName * Table referred to. * - * @return array structure of table and column, listing every table with a + * @return array + * structure of table and column, listing every table with a * foreign key reference to $tableName, and the column where the key appears. */ public static function getReferencesToTable($tableName) { diff --git a/CRM/Core/DAO/permissions.php b/CRM/Core/DAO/permissions.php index 780a17d62a..9054d9695c 100644 --- a/CRM/Core/DAO/permissions.php +++ b/CRM/Core/DAO/permissions.php @@ -34,7 +34,8 @@ * @param $action: (str) api action * @param $params: (array) api params * - * @return array of permissions to check for this entity-action combo + * @return array + * of permissions to check for this entity-action combo */ function _civicrm_api3_permissions($entity, $action, &$params) { $entity = _civicrm_api_get_entity_name_from_camel($entity); diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 0f42fad21f..026a932bd1 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -477,7 +477,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * useful when we die during initialization and permissioning * subsystem is not initialized - CRM-13765 * - * @return string the generated output + * @return string + * the generated output * @static */ public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) { @@ -526,7 +527,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * @param string $comp * Variable name. * - * @return string the generated output + * @return string + * the generated output * * * @static @@ -575,7 +577,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * * @param string $comp * Message to be output. - * @return string format of the backtrace + * @return string + * format of the backtrace * * * @static @@ -688,7 +691,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument. * @param int $maxArgLen * Maximum number of characters to show from each argument string. - * @return string printable plain-text + * @return string + * printable plain-text */ public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { $message = ''; @@ -781,7 +785,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Render an exception as HTML string * * @param Exception $e - * @return string printable HTML text + * @return string + * printable HTML text */ public static function formatHtmlException(Exception $e) { $msg = ''; @@ -816,7 +821,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Write details of an exception to the log * * @param Exception $e - * @return string printable plain text + * @return string + * printable plain text */ public static function formatTextException(Exception $e) { $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n"; @@ -901,7 +907,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { * * @param object $obj * The PEAR_ERROR object. - * @return object $obj + * @return object + * $obj * @static */ public static function nullHandler($obj) { diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php index e1267968c5..5d910474dc 100644 --- a/CRM/Core/FileSearchInterface.php +++ b/CRM/Core/FileSearchInterface.php @@ -13,7 +13,8 @@ interface CRM_Core_FileSearchInterface { * - xparent_id: int - business-entity to which file is attached (directly or indirectly) * @param int $limit * @param int $offset - * @return array each item has keys: + * @return array + * each item has keys: * - file_id: int * - parent_table: string - entity to which file is directly attached * - parent_id: int - entity to which file is directly attached diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 9f5162e239..0cc1b549ad 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -372,7 +372,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ public function setDefaultValues() { @@ -393,7 +394,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Performs the server side validation * @since 1.0 - * @return boolean true if no error found + * @return boolean + * true if no error found * @throws HTML_QuickForm_Error */ public function validate() { diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index d1d37adf15..35ad735a67 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -127,7 +127,8 @@ class CRM_Core_Form_Date { * Additional Operator Selections to add. * @param string $dateFormat * @param bool $displayTime - * @return array Values for Selector + * @return array + * Values for Selector */ static function returnDateRangeSelector( &$form, $fieldName, $count = 1, diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 7a9b4332c7..54d4798b30 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -234,7 +234,8 @@ class CRM_Core_Form_RecurringEntity { * @param array $fields * Posted values of the form . * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values) { diff --git a/CRM/Core/HTMLInputCoder.php b/CRM/Core/HTMLInputCoder.php index 71eb60e5ea..5731ab6a73 100644 --- a/CRM/Core/HTMLInputCoder.php +++ b/CRM/Core/HTMLInputCoder.php @@ -32,7 +32,8 @@ class CRM_Core_HTMLInputCoder { /** * @param string $fldName - * @return bool TRUE if encoding should be skipped for this field + * @return bool + * TRUE if encoding should be skipped for this field */ public static function isSkippedField($fldName) { return CRM_Utils_API_HTMLInputCoder::singleton()->isSkippedField($fldName); diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index 6370f27f67..b2a3706490 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -109,7 +109,8 @@ class CRM_Core_I18n { /** * Returns whether gettext is running natively or using PHP-Gettext. * - * @return bool True if gettext is native + * @return bool + * True if gettext is native */ public function isNative() { return $this->_nativegettext; @@ -121,7 +122,8 @@ class CRM_Core_I18n { * @param bool $justEnabled * whether to return all languages or just the enabled ones. * - * @return array of code/language name mappings + * @return array + * of code/language name mappings */ public static function languages($justEnabled = FALSE) { static $all = NULL; @@ -176,7 +178,8 @@ class CRM_Core_I18n { * source string. * @param mixed arguments, can be passed in an array or through single variables * - * @return string modified string + * @return string + * modified string */ public function strarg($str) { $tr = array(); @@ -215,7 +218,8 @@ class CRM_Core_I18n { * @param array $params * the params of the translation (if any). * - * @return string the translated string + * @return string + * the translated string */ public function crm_translate($text, $params = array()) { if (isset($params['escape'])) { @@ -347,7 +351,8 @@ class CRM_Core_I18n { * @param string $string * this string should be translated. * - * @return string the translated string + * @return string + * the translated string */ public function translate($string) { return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string; @@ -406,7 +411,8 @@ class CRM_Core_I18n { * @param $key * Key of the extension (can be 'civicrm', or 'org.example.foo'). * - * @return Boolean True if the domain was changed for an extension. + * @return Boolean + * True if the domain was changed for an extension. */ public function setGettextDomain($key) { /* No domain changes for en_US */ @@ -475,7 +481,8 @@ class CRM_Core_I18n { /** * Set the LC_TIME locale if it's not set already (for a given language choice). * - * @return string the final LC_TIME that got set + * @return string + * the final LC_TIME that got set */ public static function setLcTime() { static $locales = array(); @@ -499,7 +506,8 @@ class CRM_Core_I18n { * @param $params * Array an array of additional parameters. * - * @return string the translated string + * @return string + * the translated string */ function ts($text, $params = array()) { static $config = NULL; diff --git a/CRM/Core/I18n/Form.php b/CRM/Core/I18n/Form.php index 271a708e6f..06d7246f50 100644 --- a/CRM/Core/I18n/Form.php +++ b/CRM/Core/I18n/Form.php @@ -84,7 +84,8 @@ class CRM_Core_I18n_Form extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ public function setDefaultValues() { diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index 1e7426eaed..10276f0236 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -368,7 +368,8 @@ class CRM_Core_I18n_Schema { * @param string $query * the query for rewrite. * - * @return string the rewritten query + * @return string + * the rewritten query */ public static function rewriteQuery($query) { global $dbLocale; @@ -443,7 +444,8 @@ class CRM_Core_I18n_Schema { * @param string $class * schema structure class to use. * - * @return array array of CREATE INDEX queries + * @return array + * array of CREATE INDEX queries */ private static function createIndexQueries($locale, $table, $class = 'CRM_Core_I18n_SchemaStructure') { $indices =& $class::indices(); @@ -487,7 +489,8 @@ class CRM_Core_I18n_Schema { * @param string $class * schema structure class to use. * - * @return array array of CREATE INDEX queries + * @return array + * array of CREATE INDEX queries */ private static function createViewQuery($locale, $table, &$dao, $class = 'CRM_Core_I18n_SchemaStructure') { $columns =& $class::columns(); diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index cbfea6765a..b71c771a43 100644 --- a/CRM/Core/IDS.php +++ b/CRM/Core/IDS.php @@ -100,7 +100,8 @@ class CRM_Core_IDS { * @param bool $force * Should we recreate it irrespective if it exists or not. * - * @return string the full path to the config file + * @return string + * the full path to the config file * @static */ public static function createConfigFile($force = FALSE) { diff --git a/CRM/Core/InnoDBIndexer.php b/CRM/Core/InnoDBIndexer.php index a2d46e79e9..fa6d928a00 100644 --- a/CRM/Core/InnoDBIndexer.php +++ b/CRM/Core/InnoDBIndexer.php @@ -155,7 +155,8 @@ class CRM_Core_InnoDBIndexer { * Get a list of FTS index names that are currently defined in the database. * * @param string $table - * @return array (string $indexName => string $indexName) + * @return array + * (string $indexName => string $indexName) */ public function findActualFtsIndexNames($table) { $mysqlVersion = CRM_Core_DAO::singleValueQuery('SELECT VERSION()'); @@ -186,7 +187,8 @@ class CRM_Core_InnoDBIndexer { * FTS index. * * @param $table - * @return array (string $indexName => string $sql) + * @return array + * (string $indexName => string $sql) */ public function buildIndexSql($table) { $sqls = array(); // array (string $idxName => string $sql) @@ -203,7 +205,8 @@ class CRM_Core_InnoDBIndexer { * Generate a "DROP INDEX" statement for each existing FTS index * * @param string $table - * @return array (string $idxName => string $sql) + * @return array + * (string $idxName => string $sql) */ public function dropIndexSql($table) { $sqls = array(); diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index 87f31061ab..a7cdfa88b4 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -153,7 +153,8 @@ class CRM_Core_JobManager { * populates class param. * * @param void - * @return array ($id => CRM_Core_ScheduledJob) + * @return array + * ($id => CRM_Core_ScheduledJob) * */ /** diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php index b724685d37..b7ab0805ae 100644 --- a/CRM/Core/Key.php +++ b/CRM/Core/Key.php @@ -40,7 +40,8 @@ class CRM_Core_Key { /** * Generate a private key per session and store in session * - * @return string private key for this session + * @return string + * private key for this session * @static */ public static function privateKey() { @@ -78,7 +79,8 @@ class CRM_Core_Key { * @param bool $addSequence * Should we add a unique sequence number to the end of the key. * - * @return string valid formID + * @return string + * valid formID * @static */ public static function get($name, $addSequence = FALSE) { @@ -101,7 +103,8 @@ class CRM_Core_Key { * @param string $name * @param bool $addSequence * - * @return string $formKey if valid, else null + * @return string + * if valid, else null * @static */ public static function validate($key, $name, $addSequence = FALSE) { diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index a0935dcf28..7a093c07ee 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -325,7 +325,8 @@ class CRM_Core_ManagedEntities { /** * @param $modules * - * @return array indexed by is_active,name + * @return array + * indexed by is_active,name */ protected static function createModuleIndex($modules) { $result = array(); @@ -339,7 +340,8 @@ class CRM_Core_ManagedEntities { * @param $moduleIndex * @param $declarations * - * @return array indexed by module,name + * @return array + * indexed by module,name */ protected static function createDeclarationIndex($moduleIndex, $declarations) { $result = array(); diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index d1a4895492..0ef616d720 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -487,7 +487,8 @@ class CRM_Core_Menu { * @param string $path * Path for which breadcrumb is to be build. * - * @return array The breadcrumb for this path + * @return array + * The breadcrumb for this path * * @static */ diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index da62d5ea6c..5969ae0802 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -112,7 +112,8 @@ class CRM_Core_OptionGroup { * @param string $keyColumnName * the column to use for 'key'. * - * @return array the values as specified by the above params + * @return array + * the values as specified by the above params * @static * @void */ @@ -218,7 +219,8 @@ WHERE v.option_group_id = g.id * @param bool $onlyActive * @param bool $fresh * - * @return array of values as specified by the above params + * @return array + * of values as specified by the above params * @static * @void */ @@ -419,7 +421,8 @@ WHERE v.option_group_id = g.id * * @static * - * @return string the value from the row where is_default = true + * @return string + * the value from the row where is_default = true */ public static function getDefaultValue($groupName) { if (empty($groupName)) { @@ -467,7 +470,8 @@ WHERE v.option_group_id = g.id * * @static * - * @return int the option group ID + * @return int + * the option group ID */ public static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) { self::deleteAssoc($groupName); diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index c0b899f302..b67d01c75d 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -68,7 +68,8 @@ class CRM_Core_OptionValue { * @param array $links * Has links like edit, delete, disable ..etc. * - * @return array of option-values + * @return array + * of option-values * * @static */ @@ -254,7 +255,8 @@ class CRM_Core_OptionValue { * @param string $fieldName * The name of the field in the DAO. * - * @return boolean true if object exists + * @return boolean + * true if object exists * @static */ public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') { @@ -276,7 +278,8 @@ class CRM_Core_OptionValue { * @param string $mode * @param string $contactType * - * @return boolean true if object exists + * @return boolean + * true if object exists * @static */ public static function getFields($mode = '', $contactType = 'Individual') { @@ -384,7 +387,8 @@ class CRM_Core_OptionValue { * @param bool $isActiveDo you want only active option values?. * Do you want only active option values?. * - * @return array of option-values + * @return array + * of option-values * * @static */ diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index 62e13b9970..8bccb11369 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -376,7 +376,8 @@ class CRM_Core_Page { /** * Getter for embedded * - * @return boolean return the embedded value + * @return boolean + * return the embedded value */ public function getEmbedded() { return $this->_embedded; @@ -396,7 +397,8 @@ class CRM_Core_Page { /** * Getter for print * - * @return boolean return the print value + * @return boolean + * return the print value */ public function getPrint() { return $this->_print; diff --git a/CRM/Core/Page/Angular.php b/CRM/Core/Page/Angular.php index ee221d3a82..dcb938f622 100644 --- a/CRM/Core/Page/Angular.php +++ b/CRM/Core/Page/Angular.php @@ -17,7 +17,8 @@ class CRM_Core_Page_Angular extends CRM_Core_Page { * pages. This typically involves assigning the appropriate * smarty variable :) * - * @return string The content generated by running this page + * @return string + * The content generated by running this page */ public function run() { $this->registerResources(CRM_Core_Resources::singleton()); @@ -63,7 +64,8 @@ class CRM_Core_Page_Angular extends CRM_Core_Page { /** * Get a list of AngularJS modules which should be autoloaded * - * @return array (string $name => array('ext' => string $key, 'js' => array $paths, 'css' => array $paths)) + * @return array + * (string $name => array('ext' => string $key, 'js' => array $paths, 'css' => array $paths)) */ public static function getAngularModules() { $angularModules = array(); diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index 81c9902d63..7fe2ba19a1 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -55,7 +55,8 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * An array of action links * - * @return array (reference) + * @return array + * (reference) */ abstract function &links(); @@ -103,7 +104,8 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * @param int $name * The name or title of the object. * - * @return string permission value if permission is granted, else null + * @return string + * permission value if permission is granted, else null */ public function checkPermission($id, $name) { return CRM_Core_Permission::EDIT; diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php index 4550cfd70c..31ad0fc831 100644 --- a/CRM/Core/Page/Redirect.php +++ b/CRM/Core/Page/Redirect.php @@ -29,7 +29,8 @@ class CRM_Core_Page_Redirect extends CRM_Core_Page { * Any parameters passed as part of this page request. * @param bool $absolute * Whether to return an absolute URL. - * @return string URL + * @return string + * URL */ public static function createUrl($requestPath, $requestArgs, $pageArgs, $absolute) { if (empty($pageArgs['url'])) { diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index 840d7f6b40..9a9961a383 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -267,7 +267,8 @@ abstract class CRM_Core_Payment { * 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 + * @return array + * field metadata */ public function getPaymentFormFieldsMetadata() { //@todo convert credit card type into an option value @@ -402,7 +403,8 @@ abstract class CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ abstract function doDirectPayment(&$params); @@ -415,7 +417,8 @@ abstract class CRM_Core_Payment { * * @param $component * - * @return array $params (modified) + * @return array + * (modified) * @throws CRM_Core_Exception */ public function doPayment(&$params, $component) { @@ -435,7 +438,8 @@ abstract class CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ abstract function checkConfig(); diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index a803adb5ad..824265d999 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -80,7 +80,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in a nice formatted array (or an error object) + * @return array + * the result in a nice formatted array (or an error object) */ public function doDirectPayment(&$params) { if (!defined('CURLOPT_SSLCERT')) { @@ -379,7 +380,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { $contribution = new CRM_Contribute_DAO_Contribution(); @@ -393,7 +395,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param string $key * @param string $data * - * @return string the HMAC_MD5 encoding string + * @return string + * the HMAC_MD5 encoding string **/ public function hmac($key, $data) { if (function_exists('mhash')) { @@ -455,7 +458,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Calculate and return the transaction fingerprint * - * @return string fingerprint + * @return string + * fingerprint **/ public function CalculateFP() { $x_tran_key = $this->_getParam('paymentKey'); @@ -475,7 +479,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param string $data * A single CSV line. * - * @return array CSV fields + * @return array + * CSV fields */ public function explode_csv($data) { $data = trim($data); @@ -511,7 +516,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param string $content * XML reply from Authorize.Net. * - * @return array refId, resultCode, code, text, subscriptionId + * @return array + * refId, resultCode, code, text, subscriptionId */ public function _parseArbReturn($content) { $refId = $this->_substring_between($content, '', ''); @@ -587,7 +593,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param string $field * @param mixed $value * - * @return bool false if value is not a scalar, true if successful + * @return bool + * false if value is not a scalar, true if successful */ public function _setParam($field, $value) { if (!is_scalar($value)) { @@ -601,7 +608,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index c7b667412d..1364467027 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -63,7 +63,8 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in a nice formatted array (or an error object) + * @return array + * the result in a nice formatted array (or an error object) */ public function doDirectPayment(&$params) { // Invoke hook_civicrm_paymentProcessor @@ -134,7 +135,8 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { return NULL; diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index 79569fa36e..8e1b720504 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -295,7 +295,8 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { $contribution = new CRM_Contribute_DAO_Contribution(); diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index efc9c46f50..be6fa7689b 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -307,7 +307,8 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { $contribution = new CRM_Contribute_DAO_Contribution(); diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index 5d5f7c760e..0835a4be7b 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -78,7 +78,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $config = CRM_Core_Config::singleton(); @@ -108,7 +109,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index 595b2271c5..2d2a59ef22 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -449,7 +449,8 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} * @param $response * @param $serial * @internal param \xml $xml_response response send by google in xml format - * @return array context of this call (test, module, payment processor id) + * @return array + * context of this call (test, module, payment processor id) * @static */ public function getContext($privateData, $orderNo, $root, $response, $serial) { diff --git a/CRM/Core/Payment/IATS.php b/CRM/Core/Payment/IATS.php index 8c4f9a47fb..dcf3f7a7e4 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -82,7 +82,8 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { @@ -324,7 +325,8 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { * * @internal param string $mode the mode we are operating in (live or test) * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index d86b48da46..a4ba734a62 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -86,7 +86,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { @@ -312,7 +313,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 0c7c73bb30..58ce4cfce5 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -58,7 +58,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { @@ -251,7 +252,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * @param string $field * @param mixed $value * - * @return bool false if value is not a scalar, true if successful + * @return bool + * false if value is not a scalar, true if successful */ public function _setParam($field, $value) { if (!is_scalar($value)) { @@ -265,7 +267,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 84199205af..0074366d06 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -91,7 +91,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) */ public function setExpressCheckOut(&$params) { $args = array(); @@ -135,7 +136,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * @param string $token * The key associated with this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) */ public function getExpressCheckoutDetails($token) { $args = array(); @@ -177,7 +179,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @internal param string $token the key associated with this transaction * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) */ public function doExpressCheckout(&$params) { $args = array(); @@ -295,7 +298,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * Assoc array of input parameters for this transaction. * * @param string $component - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) */ public function doDirectPayment(&$params, $component = 'contribute') { $args = array(); @@ -371,7 +375,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index e098426081..b4ae921d6c 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -57,7 +57,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { @@ -352,7 +353,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { //copied from Eway but not working and not really sure it should! @@ -416,7 +418,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * * @internal param string $mode the mode we are operating in (live or test) * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $errorMsg = array(); diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index cd18cb4dc7..ee7f4b59dc 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -72,7 +72,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * * @internal param string $mode the mode we are operating in (live or test) * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $config = CRM_Core_Config::singleton(); @@ -129,7 +130,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ public function doDirectPayment(&$params) { diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index f500076b99..de4b32457b 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -197,7 +197,8 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { * @param int $orderNo * send by google. * - * @return array context of this call (test, component, payment processor id) + * @return array + * context of this call (test, component, payment processor id) * @static */ public static function getContext($privateData, $orderNo) { diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index a1a10e4fe0..06186d5ec0 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -120,7 +120,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in a nice formatted array (or an error object) + * @return array + * the result in a nice formatted array (or an error object) */ public function doDirectPayment(&$params) { @@ -263,7 +264,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param string $xml * an XML string. * - * @return array An array of the result with following keys: + * @return array + * An array of the result with following keys: */ public function xml_parse_into_assoc($xml) { $input = array(); @@ -433,7 +435,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { $contribution = new CRM_Contribute_DAO_Contribution(); @@ -466,7 +469,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param string $field * @param mixed $value * - * @return bool false if value is not a scalar, true if successful + * @return bool + * false if value is not a scalar, true if successful */ public function _setParam($field, $value) { if (!is_scalar($value)) { @@ -513,7 +517,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * This function checks to see if we have the right config values * - * @return string the error message if any + * @return string + * the error message if any */ public function checkConfig() { $error = array(); diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 1b313e805f..7dca622548 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -412,7 +412,8 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { * @param int $invoiceId * The ID to check. * - * @return bool True if ID exists, else false + * @return bool + * True if ID exists, else false */ public function _checkDupe($invoiceId) { $contribution = new CRM_Contribute_DAO_Contribution(); diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index b917d2af77..9b168cd768 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -73,7 +73,8 @@ class CRM_Core_Permission { /** * Get the current permission of this user * - * @return string the permission of the user (edit or view or null) + * @return string + * the permission of the user (edit or view or null) */ public static function getPermission() { $config = CRM_Core_Config::singleton(); @@ -113,7 +114,8 @@ class CRM_Core_Permission { * array('access CiviEvent', 'access CiviContribute') * ), * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public static function check($permissions) { @@ -161,7 +163,8 @@ class CRM_Core_Permission { * @param array $array * The group/role to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public static function checkGroupRole($array) { @@ -179,7 +182,8 @@ class CRM_Core_Permission { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) { $config = CRM_Core_Config::singleton(); @@ -196,7 +200,8 @@ class CRM_Core_Permission { * * @static * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public static function group($groupType, $excludeHidden = TRUE) { $config = CRM_Core_Config::singleton(); @@ -748,7 +753,8 @@ class CRM_Core_Permission { * @param string $permissionName * Name of the permission we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public static function permissionEmails($permissionName) { $config = CRM_Core_Config::singleton(); @@ -761,7 +767,8 @@ class CRM_Core_Permission { * @param string $roleName * Name of the role we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public static function roleEmails($roleName) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index ba9365e0e3..a5e98cdbc7 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -73,7 +73,8 @@ class CRM_Core_Permission_Base { /** * Get the current permission of this user * - * @return string the permission of the user (edit or view or null) + * @return string + * the permission of the user (edit or view or null) */ public function getPermission() { return CRM_Core_Permission::EDIT; @@ -89,7 +90,8 @@ class CRM_Core_Permission_Base { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public function whereClause($type, &$tables, &$whereTables) { return '( 1 )'; @@ -104,7 +106,8 @@ class CRM_Core_Permission_Base { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) { $this->group(); @@ -120,7 +123,8 @@ class CRM_Core_Permission_Base { * @param bool|\boolen $excludeHidden exclude hidden groups. * * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public function group($groupType = NULL, $excludeHidden = TRUE) { return CRM_Core_PseudoConstant::allGroup($groupType, $excludeHidden); @@ -136,7 +140,8 @@ class CRM_Core_Permission_Base { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public function groupClause($type, &$tables, &$whereTables) { return ' (1) '; @@ -148,7 +153,8 @@ class CRM_Core_Permission_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str) { @@ -161,7 +167,8 @@ class CRM_Core_Permission_Base { * @param array $array * The roles to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function checkGroupRole($array) { @@ -174,7 +181,8 @@ class CRM_Core_Permission_Base { * @param string $permissionName * Name of the permission we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function permissionEmails($permissionName) { CRM_Core_Error::fatal("this function only works in Drupal 6 at the moment"); @@ -186,7 +194,8 @@ class CRM_Core_Permission_Base { * @param string $roleName * Name of the role we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function roleEmails($roleName) { CRM_Core_Error::fatal("this function only works in Drupal 6 at the moment"); @@ -228,7 +237,8 @@ class CRM_Core_Permission_Base { * * @param $module * - * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return Array + * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). * @see CRM_Core_Permission::getCorePermissions */ public static function getModulePermissions($module) { @@ -246,7 +256,8 @@ class CRM_Core_Permission_Base { * Get the permissions defined in the hook_civicrm_permission implementation * in all enabled CiviCRM module extensions. * - * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return Array + * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ public function getAllModulePermissions() { $permissions = array(); diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index dbac73bc57..85f1e91763 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -70,7 +70,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { * * @param int $contactID * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str, $contactID = NULL) { $str = $this->translatePermission($str, 'Drupal', array( @@ -95,7 +96,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { * @param array $array * The roles to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function checkGroupRole($array) { if (function_exists('user_load') && isset($array)) { @@ -136,7 +138,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { * @param string $permissionName * Name of the permission we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function permissionEmails($permissionName) { static $_cache = array(); diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index a195f52ec6..21060df837 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -69,7 +69,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * * @param int $contactID * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str, $contactID = NULL) { $str = $this->translatePermission($str, 'Drupal6', array( @@ -94,7 +95,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * @param array $array * The roles to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function checkGroupRole($array) { @@ -116,7 +118,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * @param string $roleName * Name of the role we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function roleEmails($roleName) { static $_cache = array(); @@ -150,7 +153,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * @param string $permissionName * Name of the permission we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function permissionEmails($permissionName) { static $_cache = array(); @@ -200,7 +204,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * * @param $module * - * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return Array + * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ public static function getModulePermissions($module) { $return_permissions = array(); diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index ac499f1ae7..7d0e9c2971 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -71,7 +71,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * Exclude hidden groups. * * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public function group($groupType = NULL, $excludeHidden = TRUE) { if (!isset($this->_viewPermissionedGroups)) { @@ -143,7 +144,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * @param array $whereTables * (reference) add the tables that are needed for the where clause. * - * @return string the clause to add to the query retrieving viewable groups + * @return string + * the clause to add to the query retrieving viewable groups */ public function groupClause($type, &$tables, &$whereTables) { if (!isset($this->_viewPermissionedGroups)) { @@ -206,7 +208,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** * Get the current permission of this user * - * @return string the permission of the user (edit or view or null) + * @return string + * the permission of the user (edit or view or null) */ public function getPermission() { $this->group(); @@ -256,7 +259,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * @param array $array * The roles to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * */ public function checkGroupRole($array) { @@ -285,7 +289,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * @param string $permissionName * Name of the permission we are interested in. * - * @return string a comma separated list of email addresses + * @return string + * a comma separated list of email addresses */ public function permissionEmails($permissionName) { static $_cache = array(); diff --git a/CRM/Core/Permission/Joomla.php b/CRM/Core/Permission/Joomla.php index 0c87db1fe0..a1fcec6255 100644 --- a/CRM/Core/Permission/Joomla.php +++ b/CRM/Core/Permission/Joomla.php @@ -43,7 +43,8 @@ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str) { $config = CRM_Core_Config::singleton(); @@ -103,7 +104,8 @@ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { * @param array $array * The roles to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public function checkGroupRole($array) { diff --git a/CRM/Core/Permission/Soap.php b/CRM/Core/Permission/Soap.php index c8df36b409..1b35fe8e55 100644 --- a/CRM/Core/Permission/Soap.php +++ b/CRM/Core/Permission/Soap.php @@ -44,7 +44,8 @@ class CRM_Core_Permission_Soap extends CRM_Core_Permission_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str) { diff --git a/CRM/Core/Permission/UnitTests.php b/CRM/Core/Permission/UnitTests.php index 4345800486..904703fc7f 100644 --- a/CRM/Core/Permission/UnitTests.php +++ b/CRM/Core/Permission/UnitTests.php @@ -47,7 +47,8 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str) { if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) { @@ -71,7 +72,8 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { * @param array $whereTables * (reference ) add the tables that are needed for the where clause. * - * @return string the group where clause for this user + * @return string + * the group where clause for this user */ public function whereClause($type, &$tables, &$whereTables) { return '( 1 )'; diff --git a/CRM/Core/Permission/WordPress.php b/CRM/Core/Permission/WordPress.php index 01bbe9e58d..abfdc34456 100644 --- a/CRM/Core/Permission/WordPress.php +++ b/CRM/Core/Permission/WordPress.php @@ -43,7 +43,8 @@ class CRM_Core_Permission_WordPress extends CRM_Core_Permission_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false */ public function check($str) { // Generic cms 'administer users' role tranlates to 'administrator' WordPress role diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index ba5844af16..b4a96af61b 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -630,7 +630,8 @@ class CRM_Core_PseudoConstant { * * @static * - * @return array - array reference of all activity types. + * @return array + * array reference of all activity types. */ public static function &activityType() { $args = func_get_args(); @@ -708,7 +709,8 @@ class CRM_Core_PseudoConstant { * * @param bool $limit * - * @return array - array reference of all State/Provinces. + * @return array + * array reference of all State/Provinces. */ public static function &stateProvince($id = FALSE, $limit = TRUE) { if (($id && !CRM_Utils_Array::value($id, self::$stateProvince)) || !self::$stateProvince || !$id) { @@ -763,7 +765,8 @@ class CRM_Core_PseudoConstant { * * @param bool $limit * - * @return array - array reference of all State/Province abbreviations. + * @return array + * array reference of all State/Province abbreviations. */ public static function &stateProvinceAbbreviation($id = FALSE, $limit = TRUE) { if ($id > 1) { @@ -830,7 +833,8 @@ WHERE id = %1"; * * @param bool $applyLimit * - * @return array - array reference of all countries. + * @return array + * array reference of all countries. */ public static function country($id = FALSE, $applyLimit = TRUE) { if (($id && !CRM_Utils_Array::value($id, self::$country)) || !self::$country || !$id) { @@ -905,7 +909,8 @@ WHERE id = %1"; * * @param bool $id * - * @return array - array reference of all country ISO codes. + * @return array + * array reference of all country ISO codes. */ public static function &countryIsoCode($id = FALSE) { if (!self::$countryIsoCode) { @@ -940,7 +945,8 @@ WHERE id = %1"; * * @static * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public static function &allGroup($groupType = NULL, $excludeHidden = TRUE) { $condition = CRM_Contact_BAO_Group::groupTypeCondition($groupType, $excludeHidden); @@ -999,7 +1005,8 @@ WHERE id = %1"; * * @static * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public static function group($groupType = NULL, $excludeHidden = TRUE) { return CRM_Core_Permission::group($groupType, $excludeHidden); @@ -1032,7 +1039,8 @@ WHERE id = %1"; * @param null $groupType * @param bool $excludeHidden * - * @return array - array reference of all groups. + * @return array + * array reference of all groups. */ public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) { if (!self::$staticGroup) { @@ -1071,7 +1079,8 @@ WHERE id = %1"; * * @static * - * @return array - array reference of all relationship types. + * @return array + * array reference of all relationship types. */ public static function &relationshipType($valueColumnName = 'label', $reset = FALSE) { if (!CRM_Utils_Array::value($valueColumnName, self::$relationshipType) || $reset) { @@ -1109,7 +1118,8 @@ WHERE id = %1"; * so far, we use this for validation only, so there's no point of putting this into the database * * - * @return array - array reference of all currency codes + * @return array + * array reference of all currency codes * @static */ public static function ¤cyCode() { @@ -1400,7 +1410,8 @@ WHERE id = %1"; * * @param bool|int $id - Optional id to return * - * @return array - array reference of all Counties + * @return array + * array reference of all Counties */ public static function &county($id = FALSE) { if (!self::$county) { @@ -1435,7 +1446,8 @@ WHERE id = %1"; * * @param null $additionalCond * - * @return array - array of all payment processors + * @return array + * array of all payment processors */ public static function &paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) { $condition = "is_test = "; @@ -1470,7 +1482,8 @@ WHERE id = %1"; * @param int $id * @param string $return * - * @return array - array of all payment processor types + * @return array + * array of all payment processor types */ public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') { $cacheKey = $id . '_' . $return; @@ -1489,7 +1502,8 @@ WHERE id = %1"; * * @param bool $id * - * @return array - array reference of all World Regions + * @return array + * array reference of all World Regions * @static */ public static function &worldRegion($id = FALSE) { @@ -1520,7 +1534,8 @@ WHERE id = %1"; * * @param string $column * - * @return array - array reference of all activity statuses + * @return array + * array reference of all activity statuses */ public static function &activityStatus($column = 'label') { if (NULL === self::$activityStatus) { @@ -1546,7 +1561,8 @@ WHERE id = %1"; * * @param string $column * - * @return array - array reference of all Visibility levels. + * @return array + * array reference of all Visibility levels. */ public static function &visibility($column = 'label') { if (!isset(self::$visibility)) { @@ -1679,7 +1695,8 @@ ORDER BY name"; * * @param int $stateID * - * @return int the country id that the state belongs to + * @return int + * the country id that the state belongs to * @static */ public static function countryIDForStateID($stateID) { @@ -1709,7 +1726,8 @@ WHERE id = %1 * * @param string $columnName * - * @return array - array reference of all greetings. + * @return array + * array reference of all greetings. */ public static function greeting($filter, $columnName = 'label') { $index = $filter['greeting_type'] . '_' . $columnName; @@ -1755,7 +1773,8 @@ WHERE id = %1 * * @static * - * @return array - array reference of default greetings. + * @return array + * array reference of default greetings. * */ public static function &greetingDefaults() { @@ -1788,7 +1807,8 @@ WHERE id = %1 * * @static * - * @return array - array($fullyQualifiedName => $label) list of extensions + * @return array + * array($fullyQualifiedName => $label) list of extensions */ public static function &getExtensions() { if (!self::$extensions) { @@ -1820,7 +1840,8 @@ WHERE id = %1 * @param int $id * @param null $condition * - * @return array - array reference of all Option Group Name + * @return array + * array reference of all Option Group Name */ public static function accountOptionValues($optionGroupName, $id = NULL, $condition = NULL) { $cacheKey = $optionGroupName . '_' . $condition; @@ -1841,7 +1862,8 @@ WHERE id = %1 * Whether to forcibly reload extensions list from canonical store. * @static * - * @return array - array(array('prefix' => $, 'file' => $)) + * @return array + * array(array('prefix' => $, 'file' => $)) */ public static function getModuleExtensions($fresh = FALSE) { return CRM_Extension_System::singleton()->getMapper()->getActiveModuleFiles($fresh); @@ -1855,7 +1877,8 @@ WHERE id = %1 * * @static * - * @return array - array list of tax rates with the financial type + * @return array + * array list of tax rates with the financial type */ public static function getTaxRates() { if (!self::$taxRates) { diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php index c331707e34..8c02b4e943 100644 --- a/CRM/Core/Reference/Interface.php +++ b/CRM/Core/Reference/Interface.php @@ -30,7 +30,8 @@ interface CRM_Core_Reference_Interface { * * @param CRM_Core_DAO $targetDao * The instance for which we want references. - * @return array a record describing the reference; must include the keys: + * @return array + * a record describing the reference; must include the keys: * - 'type': string (not necessarily unique) * - 'count': int */ diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 97f03f5d84..10e4f40460 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -295,7 +295,8 @@ class CRM_Core_Resources { /** * @param array $settings * @param array $additions - * @return array combination of $settings and $additions + * @return array + * combination of $settings and $additions */ protected function mergeSettings($settings, $additions) { foreach ($additions as $k => $v) { @@ -613,7 +614,8 @@ class CRM_Core_Resources { /** * Create dynamic script for localizing js widgets * - * @return string javascript content + * @return string + * javascript content */ public static function outputLocalizationJS() { CRM_Core_Page_AJAX::setJsHeaders(); @@ -716,7 +718,8 @@ class CRM_Core_Resources { } /** - * @return bool - is this page request an ajax snippet? + * @return bool + * is this page request an ajax snippet? */ public static function isAjaxMode() { return in_array(CRM_Utils_Array::value('snippet', $_REQUEST), array(CRM_Core_Smarty::PRINT_SNIPPET, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON)); diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php index 09fe679c7b..4839aa8464 100644 --- a/CRM/Core/SelectValues.php +++ b/CRM/Core/SelectValues.php @@ -280,7 +280,8 @@ class CRM_Core_SelectValues { * @param null $minOffset * @param null $maxOffset * - * @return array the date array + * @return array + * the date array * @static */ public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL) { @@ -398,7 +399,8 @@ class CRM_Core_SelectValues { /** * Get the Map Provider * - * @return array $map array of map providers + * @return array + * array of map providers * @static */ public static function mapProvider() { @@ -412,7 +414,8 @@ class CRM_Core_SelectValues { /** * Get the Geocoding Providers from available plugins * - * @return array $geo array of geocoder providers + * @return array + * array of geocoder providers * @static */ public static function geoProvider() { @@ -427,7 +430,8 @@ class CRM_Core_SelectValues { * Get the Address Standardization Providers from available * plugins * - * @return array $addr array of address standardization providers + * @return array + * array of address standardization providers * @static */ public static function addressProvider() { diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php index 8e0f2167ba..2ffc53a216 100644 --- a/CRM/Core/Selector/API.php +++ b/CRM/Core/Selector/API.php @@ -65,7 +65,8 @@ interface CRM_Core_Selector_API { * * @param string action the action being performed * - * @return array the elements that can be sorted along with their properties + * @return array + * the elements that can be sorted along with their properties * */ public function &getSortOrder($action); @@ -79,7 +80,8 @@ interface CRM_Core_Selector_API { * @param enum $type * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $type = NULL); @@ -88,7 +90,8 @@ interface CRM_Core_Selector_API { * * @param string action the action being performed * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action * * */ @@ -108,7 +111,8 @@ interface CRM_Core_Selector_API { * @param enum $type * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $type = NULL); @@ -128,7 +132,8 @@ interface CRM_Core_Selector_API { * * @param string type the type of export required: csv/xml/foaf etc * - * @return string the fileName which we will munge to skip spaces and + * @return string + * the fileName which we will munge to skip spaces and * special characters to avoid various browser issues * */ diff --git a/CRM/Core/Selector/Base.php b/CRM/Core/Selector/Base.php index e992759f1a..36fa9fa600 100644 --- a/CRM/Core/Selector/Base.php +++ b/CRM/Core/Selector/Base.php @@ -66,7 +66,8 @@ class CRM_Core_Selector_Base { * @param string match the action to match against * @param string attribute the attribute to return ( name, link, title ) * - * @return string the attribute that matches the action if any + * @return string + * the attribute that matches the action if any * * */ @@ -103,7 +104,8 @@ class CRM_Core_Selector_Base { * @param string $action * The action being performed. * - * @return string template file name + * @return string + * template file name */ public function getTemplateFileName($action = NULL) { return (str_replace('_', DIRECTORY_SEPARATOR, CRM_Utils_System::getClassName($this)) . ".tpl"); @@ -114,7 +116,8 @@ class CRM_Core_Selector_Base { * * @param string action the action being performed * - * @return array the elements that can be sorted along with their properties + * @return array + * the elements that can be sorted along with their properties */ public function &getSortOrder($action) { $columnHeaders = &$this->getColumnHeaders(NULL); diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 8ba8865ccd..74cccbff10 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -260,7 +260,8 @@ class CRM_Core_Selector_Controller { * @param int $reset * Are we being reset. * - * @return boolean if the GET params are different from the session params + * @return boolean + * if the GET params are different from the session params */ public function hasChanged($reset) { @@ -391,7 +392,8 @@ class CRM_Core_Selector_Controller { * * @param CRM_Core_Form $form * - * @return array of rows + * @return array + * of rows */ public function getRows($form) { if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) { @@ -409,7 +411,8 @@ class CRM_Core_Selector_Controller { * Default function for qill, if needed to be implemented, we * expect the subclass to do it * - * @return string the status message + * @return string + * the status message */ public function getQill() { return $this->_object->getQill(); @@ -496,7 +499,8 @@ class CRM_Core_Selector_Controller { /** * Getter for embedded * - * @return boolean return the embedded value + * @return boolean + * return the embedded value */ public function getEmbedded() { return $this->_embedded; @@ -516,7 +520,8 @@ class CRM_Core_Selector_Controller { /** * Getter for print * - * @return boolean return the print value + * @return boolean + * return the print value */ public function getPrint() { return $this->_print; diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 6bc89eb9f2..c84983e2c2 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -411,7 +411,8 @@ class CRM_Core_Session { /** * Pops the top userContext stack * - * @return string the top of the userContext stack (also pops the top element) + * @return string + * the top of the userContext stack (also pops the top element) * */ public function popUserContext() { @@ -423,7 +424,8 @@ class CRM_Core_Session { /** * Reads the top userContext stack * - * @return string the top of the userContext stack + * @return string + * the top of the userContext stack * */ public function readUserContext() { @@ -454,7 +456,8 @@ class CRM_Core_Session { * @param bool $reset * Should we reset the status variable?. * - * @return string the status message if any + * @return string + * the status message if any */ public function getStatus($reset = FALSE) { $this->initialize(); diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index feeb368fa7..887ea1b8e3 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -166,7 +166,8 @@ class CRM_Core_ShowHideBlocks { * @param string $text * @param string $js * - * @return string the formatted html link + * @return string + * the formatted html link */ public static function linkHtml($name, $href, $text, $js) { return '$text"; diff --git a/CRM/Core/Smarty/plugins/block.edit.php b/CRM/Core/Smarty/plugins/block.edit.php index e303ed4375..a39a478a0d 100644 --- a/CRM/Core/Smarty/plugins/block.edit.php +++ b/CRM/Core/Smarty/plugins/block.edit.php @@ -48,7 +48,8 @@ * @param object $smarty * The Smarty object. * - * @return string the string, translated by gettext + * @return string + * the string, translated by gettext */ function smarty_block_edit($params, $text, &$smarty) { $action = $smarty->_tpl_vars['action']; diff --git a/CRM/Core/Smarty/plugins/block.htxt.php b/CRM/Core/Smarty/plugins/block.htxt.php index 17a79e9f4b..a87f7e85b9 100644 --- a/CRM/Core/Smarty/plugins/block.htxt.php +++ b/CRM/Core/Smarty/plugins/block.htxt.php @@ -44,7 +44,8 @@ * @param object $smarty * The Smarty object. * - * @return string the string, translated by gettext + * @return string + * the string, translated by gettext */ function smarty_block_htxt($params, $text, &$smarty) { $id = $params['id']; diff --git a/CRM/Core/Smarty/plugins/block.localize.php b/CRM/Core/Smarty/plugins/block.localize.php index 620bc5b3ce..198df317c7 100644 --- a/CRM/Core/Smarty/plugins/block.localize.php +++ b/CRM/Core/Smarty/plugins/block.localize.php @@ -45,7 +45,8 @@ * @param object $smarty * The Smarty object. * - * @return string multilingualized query + * @return string + * multilingualized query */ function smarty_block_localize($params, $text, &$smarty) { if (!$smarty->_tpl_vars['multilingual']) { diff --git a/CRM/Core/Smarty/plugins/block.serialize.php b/CRM/Core/Smarty/plugins/block.serialize.php index 82568680e7..64a1ad80aa 100644 --- a/CRM/Core/Smarty/plugins/block.serialize.php +++ b/CRM/Core/Smarty/plugins/block.serialize.php @@ -46,7 +46,8 @@ * @param object $smarty * The Smarty object. * - * @return string the string, translated by gettext + * @return string + * the string, translated by gettext */ function smarty_block_serialize($params, $text, &$smarty) { return serialize($text); diff --git a/CRM/Core/Smarty/plugins/block.ts.php b/CRM/Core/Smarty/plugins/block.ts.php index 435d24ab4d..14c535e9f8 100644 --- a/CRM/Core/Smarty/plugins/block.ts.php +++ b/CRM/Core/Smarty/plugins/block.ts.php @@ -47,7 +47,8 @@ * @param object $smarty * The Smarty object. * - * @return string the string, translated by gettext + * @return string + * the string, translated by gettext */ function smarty_block_ts($params, $text, &$smarty) { if (!isset($params['domain'])) { diff --git a/CRM/Core/Smarty/plugins/function.crmKey.php b/CRM/Core/Smarty/plugins/function.crmKey.php index f0af444b03..ea8f01754e 100644 --- a/CRM/Core/Smarty/plugins/function.crmKey.php +++ b/CRM/Core/Smarty/plugins/function.crmKey.php @@ -41,7 +41,8 @@ * @param object $smarty * The Smarty object. * - * @return string the generated key + * @return string + * the generated key */ function smarty_function_crmKey($params, &$smarty) { return diff --git a/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php b/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php index bd0371418b..252cdf08c6 100644 --- a/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php +++ b/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php @@ -41,7 +41,8 @@ * @param object $smarty * The Smarty object. * - * @return string HTML + * @return string + * HTML */ function smarty_function_crmNavigationMenu($params, &$smarty) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/Smarty/plugins/function.docURL.php b/CRM/Core/Smarty/plugins/function.docURL.php index 56848f9ea6..17a0e6057a 100644 --- a/CRM/Core/Smarty/plugins/function.docURL.php +++ b/CRM/Core/Smarty/plugins/function.docURL.php @@ -42,7 +42,8 @@ * @param object $smarty * Reference to the smarty object. * - * @return string HTML code of a link to documentation + * @return string + * HTML code of a link to documentation */ function smarty_function_docURL($params, &$smarty) { if (!isset($smarty)) { diff --git a/CRM/Core/Smarty/plugins/function.help.php b/CRM/Core/Smarty/plugins/function.help.php index 38bcbe97ae..bf93bddf16 100644 --- a/CRM/Core/Smarty/plugins/function.help.php +++ b/CRM/Core/Smarty/plugins/function.help.php @@ -41,7 +41,8 @@ * @param object $smarty * Reference to the smarty object. * - * @return string the help html to be inserted + * @return string + * the help html to be inserted */ function smarty_function_help($params, &$smarty) { if (!isset($params['id']) || !isset($smarty->_tpl_vars['config'])) { diff --git a/CRM/Core/Smarty/plugins/function.sectionTotal.php b/CRM/Core/Smarty/plugins/function.sectionTotal.php index 66caa4a389..11cf42ac95 100644 --- a/CRM/Core/Smarty/plugins/function.sectionTotal.php +++ b/CRM/Core/Smarty/plugins/function.sectionTotal.php @@ -48,7 +48,8 @@ * @param object $smarty * The Smarty object. * - * @return string the string, translated by gettext + * @return string + * the string, translated by gettext */ function smarty_function_sectionTotal($params, &$smarty) { /* section totals are stored in template variable 'sectionTotals', diff --git a/CRM/Core/Smarty/plugins/modifier.crmAddClass.php b/CRM/Core/Smarty/plugins/modifier.crmAddClass.php index 84947ac7b1..eab0a5df6a 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmAddClass.php +++ b/CRM/Core/Smarty/plugins/modifier.crmAddClass.php @@ -41,7 +41,8 @@ * @param string $class * The new class or classes to add (separate with a space). * - * @return string the new modified html string + * @return string + * the new modified html string */ function smarty_modifier_crmAddClass($string, $class) { // Standardize white space diff --git a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php index df7a052ba6..5021647e41 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php +++ b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php @@ -38,7 +38,8 @@ * * @param string $btnName * - * @return string button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh' + * @return string + * button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh' * 'submit', 'done', 'display', 'jump' 'process' */ function smarty_modifier_crmBtnType($btnName) { diff --git a/CRM/Core/Smarty/plugins/modifier.crmDate.php b/CRM/Core/Smarty/plugins/modifier.crmDate.php index 4b103da5bd..ff045b67a6 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmDate.php +++ b/CRM/Core/Smarty/plugins/modifier.crmDate.php @@ -42,7 +42,8 @@ * @param null $dateFormat * @param bool $onlyTime * - * @return string human readable date format | invalid date message + * @return string + * human readable date format | invalid date message */ function smarty_modifier_crmDate($dateString, $dateFormat = NULL, $onlyTime = FALSE) { if ($dateString) { diff --git a/CRM/Core/Smarty/plugins/modifier.crmDelete.php b/CRM/Core/Smarty/plugins/modifier.crmDelete.php index 0db369aed7..e4b5f10f1b 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmDelete.php +++ b/CRM/Core/Smarty/plugins/modifier.crmDelete.php @@ -44,7 +44,8 @@ * @param string $attribute * The attribute to modify. * - * @return string the new modified html string + * @return string + * the new modified html string */ function smarty_modifier_crmDelete($string, $attribute) { static $endOfElement = '/>'; diff --git a/CRM/Core/Smarty/plugins/modifier.crmICalDate.php b/CRM/Core/Smarty/plugins/modifier.crmICalDate.php index d71abb82f2..fb4c8b2f2f 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmICalDate.php +++ b/CRM/Core/Smarty/plugins/modifier.crmICalDate.php @@ -40,7 +40,8 @@ * * @param bool $gdata * - * @return string formatted text + * @return string + * formatted text */ function smarty_modifier_crmICalDate($str, $gdata = FALSE) { return CRM_Utils_ICalendar::formatDate($str, $gdata); diff --git a/CRM/Core/Smarty/plugins/modifier.crmICalText.php b/CRM/Core/Smarty/plugins/modifier.crmICalText.php index 17bd261571..e629e01953 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmICalText.php +++ b/CRM/Core/Smarty/plugins/modifier.crmICalText.php @@ -38,7 +38,8 @@ * * @param string $str * - * @return string formatted text + * @return string + * formatted text */ function smarty_modifier_crmICalText($str) { return CRM_Utils_ICalendar::formatText($str); diff --git a/CRM/Core/Smarty/plugins/modifier.crmInsert.php b/CRM/Core/Smarty/plugins/modifier.crmInsert.php index 8546317cf8..8c8ad73390 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmInsert.php +++ b/CRM/Core/Smarty/plugins/modifier.crmInsert.php @@ -48,7 +48,8 @@ * @param string $insertBefore * The string before which we want this tag inserted. * - * @return string the new modified html string + * @return string + * the new modified html string */ function smarty_modifier_crmInsert($string, $attribute, $value, $insertBefore = '/>') { return str_replace($insertBefore, ' ' . $attribute . '="' . $value . '"' . $insertBefore, $string); diff --git a/CRM/Core/Smarty/plugins/modifier.crmMoney.php b/CRM/Core/Smarty/plugins/modifier.crmMoney.php index eebb65e4ba..227ad3f77e 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmMoney.php +++ b/CRM/Core/Smarty/plugins/modifier.crmMoney.php @@ -44,7 +44,8 @@ * @param null $format * @param bool $onlyNumber * - * @return string formatted monetary amount + * @return string + * formatted monetary amount */ function smarty_modifier_crmMoney($amount, $currency = NULL, $format = NULL, $onlyNumber = FALSE) { return CRM_Utils_Money::format($amount, $currency, $format, $onlyNumber); diff --git a/CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php b/CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php index 8916adea9d..fa810c250d 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php +++ b/CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php @@ -46,7 +46,8 @@ * @param string $thousands_sep * Thousands sep character (if other than ","). * - * @return string the formatted string + * @return string + * the formatted string * * For alternate decimal point and thousands separator, delimit values with single quotes in the template. * EXAMPLE: {$number|crmNumberFormat:2:',':' '} for French notation - 1234.56 becomes 1 234,56 diff --git a/CRM/Core/Smarty/plugins/modifier.crmReplace.php b/CRM/Core/Smarty/plugins/modifier.crmReplace.php index 705e2640de..cd572a89b1 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmReplace.php +++ b/CRM/Core/Smarty/plugins/modifier.crmReplace.php @@ -46,7 +46,8 @@ * @param string $value * The new attribute value. * - * @return string the new modified html string + * @return string + * the new modified html string */ function smarty_modifier_crmReplace($string, $attribute, $value) { // we need to search and replace the string: $attribute=XXX or $attribute="XXX" diff --git a/CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php b/CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php index 5b034d4ffb..76da47c45c 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php +++ b/CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php @@ -40,7 +40,8 @@ * @param string $full * All alternatives as a long string (or some other text). * - * @return string only the first alternative found (or the text without alternatives) + * @return string + * only the first alternative found (or the text without alternatives) */ function smarty_modifier_crmStripAlternatives($full) { return CRM_Utils_String::stripAlternatives($full); diff --git a/CRM/Core/Smarty/plugins/modifier.htmlize.php b/CRM/Core/Smarty/plugins/modifier.htmlize.php index 51f5ab38a3..5b2ae4b2bc 100644 --- a/CRM/Core/Smarty/plugins/modifier.htmlize.php +++ b/CRM/Core/Smarty/plugins/modifier.htmlize.php @@ -39,7 +39,8 @@ * @param string $text * Text to HTML-ize. * - * @return string HTML-ized version of $text + * @return string + * HTML-ized version of $text */ function smarty_modifier_htmlize($text) { $text = preg_replace('@(https?://([-\w\.]+)+(:\d+)?(/([-\w/_\.]*(\?\S+)?)?)?)@', '$1', $text); diff --git a/CRM/Core/Smarty/plugins/modifier.json.php b/CRM/Core/Smarty/plugins/modifier.json.php index f9c5bc2d4f..9e03697dc8 100644 --- a/CRM/Core/Smarty/plugins/modifier.json.php +++ b/CRM/Core/Smarty/plugins/modifier.json.php @@ -40,7 +40,8 @@ * * @param mixed $data * - * @return string JSON + * @return string + * JSON */ function smarty_modifier_json($data) { return json_encode($data); diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index d483956e92..a9bff2481f 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -195,7 +195,8 @@ class CRM_Core_StateMachine { * @param string $name * The state name. * - * @return object the state object + * @return object + * the state object */ public function find($name) { if (array_key_exists($name, $this->_states)) { @@ -209,7 +210,8 @@ class CRM_Core_StateMachine { /** * Return the list of state objects * - * @return array array of states in the state machine + * @return array + * array of states in the state machine */ public function getStates() { return $this->_states; @@ -245,7 +247,8 @@ class CRM_Core_StateMachine { /** * Return the list of form objects * - * @return array array of pages in the state machine + * @return array + * array of pages in the state machine */ public function getPages() { return $this->_pages; diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index b40f7ddb85..de9ea04349 100644 --- a/CRM/Custom/Form/Field.php +++ b/CRM/Custom/Form/Field.php @@ -174,7 +174,8 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = $this->_values; @@ -571,7 +572,8 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { * @param $files * @param $self * - * @return array if errors then list of errors to be posted back to the form, + * @return array + * if errors then list of errors to be posted back to the form, * true otherwise * @static */ diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 245d0a6ca4..87d0a94fe5 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -404,7 +404,8 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = &$this->_defaults; @@ -527,7 +528,8 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { * @param array $list * Array of relationship name. * - * @return array of relationship name. + * @return array + * of relationship name. */ public static function getFormattedList(&$list) { $relName = array(); diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index 30a5d7443b..3405e1249b 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -105,7 +105,8 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = $fieldDefaults = array(); @@ -244,7 +245,8 @@ class CRM_Custom_Form_Option extends CRM_Core_Form { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/Custom/Form/Preview.php b/CRM/Custom/Form/Preview.php index 6f0005ffd7..982369092a 100644 --- a/CRM/Custom/Form/Preview.php +++ b/CRM/Custom/Form/Preview.php @@ -96,7 +96,8 @@ class CRM_Custom_Form_Preview extends CRM_Core_Form { * * @param null * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Custom/Import/Form/MapField.php b/CRM/Custom/Import/Form/MapField.php index 319cac424c..1958eebde7 100644 --- a/CRM/Custom/Import/Form/MapField.php +++ b/CRM/Custom/Import/Form/MapField.php @@ -60,7 +60,8 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index 8b209c8a6c..f378a70445 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -309,7 +309,8 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index b2664de6ff..9e2a3fc204 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -66,7 +66,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -76,7 +77,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing * It is called from both the preview & the import actions * (non-PHPdoc) * @see CRM_Custom_Import_Parser_BaseClass::summary() @@ -129,7 +131,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values) { $response = $this->summary($values); @@ -212,7 +215,7 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * @param int $id * Custom group ID. * - * @return array $importableFields + * @return array * * @static */ diff --git a/CRM/Custom/Page/Field.php b/CRM/Custom/Page/Field.php index 97af1b2a63..e1ded4f394 100644 --- a/CRM/Custom/Page/Field.php +++ b/CRM/Custom/Page/Field.php @@ -64,7 +64,8 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ public function &actionLinks() { if (!isset(self::$_actionLinks)) { diff --git a/CRM/Custom/Page/Group.php b/CRM/Custom/Page/Group.php index 041ed6bc1c..6f777d9d70 100644 --- a/CRM/Custom/Page/Group.php +++ b/CRM/Custom/Page/Group.php @@ -55,7 +55,8 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ public function &actionLinks() { // check if variable _actionsLinks is populated diff --git a/CRM/Custom/Page/Option.php b/CRM/Custom/Page/Option.php index a12afd0f73..3dea06a146 100644 --- a/CRM/Custom/Page/Option.php +++ b/CRM/Custom/Page/Option.php @@ -71,7 +71,8 @@ class CRM_Custom_Page_Option extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ public function &actionLinks() { if (!isset(self::$_actionLinks)) { diff --git a/CRM/Dedupe/BAO/Rule.php b/CRM/Dedupe/BAO/Rule.php index 29a67183be..e513d0c3cc 100644 --- a/CRM/Dedupe/BAO/Rule.php +++ b/CRM/Dedupe/BAO/Rule.php @@ -53,7 +53,8 @@ class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_DAO_Rule { * Return the SQL query for the given rule - either for finding matching * pairs of contacts, or for matching against the $params variable (if set). * - * @return string SQL query performing the search + * @return string + * SQL query performing the search */ public function sql() { if ($this->params && diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 127adce26c..035844f73c 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -60,7 +60,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * @param string $requestedType * The requested contact type. * - * @return array a table-keyed array of field-keyed arrays holding supported fields' titles + * @return array + * a table-keyed array of field-keyed arrays holding supported fields' titles */ public static function &supportedFields($requestedType) { static $fields = NULL; @@ -379,7 +380,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * * @param array $params * - * @return array (rule field => weight) array and threshold associated to rule group + * @return array + * (rule field => weight) array and threshold associated to rule group * @access public */ public static function dedupeRuleFieldsWeight($params) { @@ -434,7 +436,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * * @static * - * @return array id => "nice name" of rule group + * @return array + * id => "nice name" of rule group */ public static function getByType($contactType = NULL) { $dao = new CRM_Dedupe_DAO_RuleGroup(); diff --git a/CRM/Dedupe/Finder.php b/CRM/Dedupe/Finder.php index bde82fa112..451c552667 100644 --- a/CRM/Dedupe/Finder.php +++ b/CRM/Dedupe/Finder.php @@ -48,7 +48,8 @@ class CRM_Dedupe_Finder { * @param array $cids * Contact ids to limit the search to. * - * @return array array of (cid1, cid2, weight) dupe triples + * @return array + * array of (cid1, cid2, weight) dupe triples */ public static function dupes($rgid, $cids = array()) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); @@ -91,7 +92,8 @@ class CRM_Dedupe_Finder { * @param int $ruleGroupID * The id of the dedupe rule we should be using. * - * @return array matching contact ids + * @return array + * matching contact ids */ static function dupesByParams( $params, @@ -147,7 +149,8 @@ class CRM_Dedupe_Finder { * @param int $gid * Contact group id (currently, works only with non-smart groups). * - * @return array array of (cid1, cid2, weight) dupe triples + * @return array + * array of (cid1, cid2, weight) dupe triples */ public static function dupesInGroup($rgid, $gid) { $cids = array_keys(CRM_Contact_BAO_Group::getMember($gid)); @@ -167,7 +170,8 @@ class CRM_Dedupe_Finder { * @param string $ctype * Contact type of the given contact. * - * @return array array of dupe contact_ids + * @return array + * array of dupe contact_ids */ public static function dupesOfContact($cid, $used = 'Unsupervised', $ctype = NULL) { // if not provided, fetch the contact type from the database @@ -209,7 +213,8 @@ class CRM_Dedupe_Finder { * @param string $ctype * Contact type of the given contact. * - * @return array valid $params array for dedupe + * @return array + * valid $params array for dedupe */ public static function formatParams($fields, $ctype) { $flat = array(); diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 2b5198dca2..8d7e2fc558 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -1594,7 +1594,8 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m } /** - * @return array of field names which will be compared, so everything except ID. + * @return array + * of field names which will be compared, so everything except ID. */ public static function getContactFields() { $contactFields = CRM_Contact_DAO_Contact::fields(); diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index bfe9342ac2..f04953b2a6 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -70,7 +70,8 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -323,7 +324,8 @@ WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )"; * * @static * - * @return array Array of event summary values + * @return array + * Array of event summary values */ public static function getEventSummary() { $eventSummary = $eventIds = array(); @@ -597,7 +599,8 @@ $event_summary_limit * Consider counted( is filter role) participant. * * - * @return array array with count of participants for each event based on status/role + * @return array + * array with count of participants for each event based on status/role */ public static function getParticipantCount( $eventId, @@ -729,7 +732,8 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL * @param bool $onlyPublicInclude public events only, default TRUE. * Include public events only, default TRUE. * - * @return array $all array of all the events that are searched + * @return array + * array of all the events that are searched * @static */ static function &getCompleteInfo( @@ -1730,7 +1734,8 @@ WHERE id = $cfID * * @param bool $skipCancel * - * @return array $customProfile array of Additional participant's info OR array of Ids. + * @return array + * array of Additional participant's info OR array of Ids. */ static function buildCustomProfile( $participantId, @@ -1843,7 +1848,8 @@ WHERE id = $cfID /* Function to retrieve all events those having location block set. * - * @return array $events array of all events. + * @return array + * array of all events. */ /** * @return array @@ -1932,7 +1938,8 @@ WHERE ce.loc_block_id = $locBlockId"; * * @param array $values * Key/value event info. - * @return boolean true if allow registration otherwise false + * @return boolean + * true if allow registration otherwise false */ /** * @param $values @@ -1969,7 +1976,7 @@ WHERE ce.loc_block_id = $locBlockId"; * * @param array $params * Key/value participant info. - * @return boolean $alreadyRegistered true/false + * @return boolean */ /** * @param array $params @@ -2003,7 +2010,8 @@ WHERE ce.loc_block_id = $locBlockId"; * @param int $eventId * @param int $type * - * @return string the permission that the user has (or null) + * @return string + * the permission that the user has (or null) * @static */ public static function checkPermission($eventId = NULL, $type = CRM_Core_Permission::VIEW) { @@ -2067,7 +2075,8 @@ WHERE ce.loc_block_id = $locBlockId"; * @param int $eventId * The id of the event. * - * @return array an array of email ids + * @return array + * an array of email ids * @static */ public static function getFromEmailIds($eventId = NULL) { @@ -2103,7 +2112,8 @@ WHERE ce.loc_block_id = $locBlockId"; * @param sting $extraWhereClause * Extra filter on participants. * - * @return int event total seats w/ given criteria. + * @return int + * event total seats w/ given criteria. * @static */ public static function eventTotalSeats($eventId, $extraWhereClause = NULL) { @@ -2149,7 +2159,8 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field * @param int $templateId * Event template id. * - * @return array of custom data defaults. + * @return array + * of custom data defaults. */ public static function getTemplateDefaultValues($templateId) { $defaults = array(); diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 305bb82ca2..941740fa8a 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -496,7 +496,8 @@ SELECT event.event_full_text, * @param bool $considerWaiting * @param bool $considerTestParticipants * - * @return array $optionsCount an array of each option id and total count + * @return array + * an array of each option id and total count * @static */ static function priceSetOptionsCount( @@ -574,7 +575,8 @@ INNER JOIN civicrm_price_field field ON ( value.price_field_id = field.id * @param int $eventId * Event id. * - * @return int $spaces Number of Empty Seats/null. + * @return int + * $spaces Number of Empty Seats/null. * @static */ public static function pendingToConfirmSpaces($eventId) { @@ -623,7 +625,8 @@ GROUP BY participant.event_id * @param bool $status * @param bool $onlyParticipant * - * @return array array of importable Fields + * @return array + * array of importable Fields * @static */ public static function &importableFields($contactType = 'Individual', $status = TRUE, $onlyParticipant = FALSE) { @@ -735,7 +738,8 @@ GROUP BY participant.event_id /** * Combine all the exportable fields from the lower levels object * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields() { @@ -800,7 +804,8 @@ GROUP BY participant.event_id * @param int $participantId * Id of the participant. * - * @return array $name associated array with sort_name and event title + * @return array + * associated array with sort_name and event title * @static */ public static function participantDetails($participantId) { @@ -1021,7 +1026,7 @@ WHERE civicrm_participant.id = {$participantId} * * @param int $oldStatusId * - * @return array $additionalParticipantIds + * @return array * @static */ public static function getAdditionalParticipantIds($primaryParticipantId, $excludeCancel = TRUE, $oldStatusId = NULL) { @@ -1063,7 +1068,7 @@ WHERE civicrm_participant.id = {$participantId} * @param bool $hasLineItems * Do fetch from line items. * - * @return array $feeDetails + * @return array * @static */ public function getFeeDetails($participantIds, $hasLineItems = FALSE) { @@ -1138,7 +1143,8 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * @param int $primaryParticipantID * Id of primary participant record. * - * @return array $additionalParticipants $displayName => $viewUrl + * @return array + * $displayName => $viewUrl * @static */ public static function getAdditionalParticipants($primaryParticipantID) { @@ -1737,7 +1743,8 @@ UPDATE civicrm_participant * * @param int $contactID * - * @return int count of participant records + * @return int + * count of participant records * @static */ public static function getContactParticipantCount($contactID) { @@ -1756,7 +1763,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND * @param bool $excludeCancelled * Exclude cancelled additional participant. * - * @return array $participantsId + * @return array * @static */ public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) { @@ -1788,7 +1795,8 @@ WHERE civicrm_participant.contact_id = {$contactID} AND * @param array $participantIds * An array of additional participant ids. * - * @return array of Urls. + * @return array + * of Urls. * @static */ public static function getAdditionalParticipantUrl($participantIds) { diff --git a/CRM/Event/BAO/ParticipantPayment.php b/CRM/Event/BAO/ParticipantPayment.php index 5d35657d66..6a203bf908 100644 --- a/CRM/Event/BAO/ParticipantPayment.php +++ b/CRM/Event/BAO/ParticipantPayment.php @@ -43,7 +43,8 @@ class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment * @param array $ids * with one values of id for this participantPayment record (for update). * - * @return object the partcipant payment record + * @return object + * the partcipant payment record * @static */ public static function create(&$params, &$ids) { @@ -91,7 +92,8 @@ class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment * @param array $params * Associative array whose values match the record to be deleted. * - * @return boolean true if deleted false otherwise + * @return boolean + * true if deleted false otherwise * @static */ public static function deleteParticipantPayment($params) { diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 729945437e..74b04386cd 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -240,7 +240,8 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { * * @param array $values * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values) { @@ -349,7 +350,8 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { * @param int $templateId * Event template id. * - * @return array of custom data defaults. + * @return array + * of custom data defaults. */ public function templateCustomDataValues($templateId) { $defaults = array(); diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php index bcfa6d288c..1685248f2a 100644 --- a/CRM/Event/Form/ManageEvent/Fee.php +++ b/CRM/Event/Form/ManageEvent/Fee.php @@ -407,7 +407,8 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { * @param array $values * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values) { diff --git a/CRM/Event/Form/ManageEvent/Location.php b/CRM/Event/Form/ManageEvent/Location.php index 077715e18e..a3cff722d2 100644 --- a/CRM/Event/Form/ManageEvent/Location.php +++ b/CRM/Event/Form/ManageEvent/Location.php @@ -141,7 +141,8 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index ef2cc42541..a894ba77b5 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -479,7 +479,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $form) { diff --git a/CRM/Event/Form/Participant.php b/CRM/Event/Form/Participant.php index b6c0c0b4c1..434cbd6d15 100644 --- a/CRM/Event/Form/Participant.php +++ b/CRM/Event/Form/Participant.php @@ -792,7 +792,8 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index dc937c0e95..4f3004024d 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -1027,7 +1027,8 @@ WHERE v.option_group_id = g.id * An array of user submitted params. * * - * @return array $formatted, formatted price set params. + * @return array + * , formatted price set params. */ /** * @param CRM_Core_Form $form @@ -1077,7 +1078,8 @@ WHERE v.option_group_id = g.id * Form object. * * - * @return array $optionsCount, array of each option w/ count total. + * @return array + * , array of each option w/ count total. */ /** * @param $form diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index d5c05caa65..8f202f5c95 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -748,7 +748,8 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R * * @param bool $isButtonJs * - * @return boolean ture on success. + * @return boolean + * ture on success. */ public function isLastParticipant($isButtonJs = FALSE) { $participant = $isButtonJs ? $this->_params[0]['additional_participants'] : $this->_params[0]['additional_participants'] + 1; diff --git a/CRM/Event/Form/Search.php b/CRM/Event/Form/Search.php index ef95c84932..95bab0c8df 100644 --- a/CRM/Event/Form/Search.php +++ b/CRM/Event/Form/Search.php @@ -362,7 +362,8 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Event/Form/Task/AddToGroup.php b/CRM/Event/Form/Task/AddToGroup.php index 82c48c3875..0d390a77d8 100644 --- a/CRM/Event/Form/Task/AddToGroup.php +++ b/CRM/Event/Form/Task/AddToGroup.php @@ -151,7 +151,8 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); @@ -180,7 +181,8 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($params) { diff --git a/CRM/Event/Form/Task/PickProfile.php b/CRM/Event/Form/Task/PickProfile.php index 5b020ab93f..f66a7b2429 100644 --- a/CRM/Event/Form/Task/PickProfile.php +++ b/CRM/Event/Form/Task/PickProfile.php @@ -122,7 +122,8 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index 1d498ce15c..9134670257 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -286,7 +286,8 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index f7c0a6ba22..0cf77ddf37 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -311,7 +311,8 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php index 62da7d43d4..8773b3881c 100644 --- a/CRM/Event/Import/Parser/Participant.php +++ b/CRM/Event/Import/Parser/Participant.php @@ -140,7 +140,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -152,7 +153,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function summary(&$values) { $erroneousField = NULL; @@ -270,7 +272,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values) { diff --git a/CRM/Event/Page/ManageEvent.php b/CRM/Event/Page/ManageEvent.php index 1350a7d648..afd1942865 100644 --- a/CRM/Event/Page/ManageEvent.php +++ b/CRM/Event/Page/ManageEvent.php @@ -59,7 +59,8 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_actionLinks)) { @@ -102,7 +103,8 @@ class CRM_Event_Page_ManageEvent extends CRM_Core_Page { * * @param $enableCart * - * @return array (reference) of tab links + * @return array + * (reference) of tab links */ public static function &tabs($enableCart) { $cacheKey = $enableCart ? 1 : 0; diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index fda9f63e8c..425759b559 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -100,7 +100,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * @param bool $all * @param null $condition * - * @return array - array of all events if any + * @return array + * array of all events if any * @static */ public static function event($id = NULL, $all = FALSE, $condition = NULL) { @@ -137,7 +138,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $retColumn * Tells populate() whether to return 'name' (default) or 'label' values. * - * @return array - array reference of all participant statuses if any + * @return array + * array reference of all participant statuses if any * @static */ public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') { @@ -174,7 +176,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { /** * Return a status-type-keyed array of status classes * - * @return array of status classes, keyed by status type + * @return array + * of status classes, keyed by status type */ public static function &participantStatusClass() { static $statusClasses = NULL; @@ -193,7 +196,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * @param int $id * @param null $cond * - * @return array - array reference of all participant roles if any + * @return array + * array reference of all participant roles if any * @static */ public static function &participantRole($id = NULL, $cond = NULL) { @@ -224,7 +228,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $id * - * @return array - array reference of all participant listings if any + * @return array + * array reference of all participant listings if any * @static */ public static function &participantListing($id = NULL) { @@ -245,7 +250,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * * @param int $id - * @return array - array reference of all event types. + * @return array + * array reference of all event types. * @static */ public static function &eventType($id = NULL) { @@ -266,7 +272,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $id * - * @return array of event id → template title pairs + * @return array + * of event id → template title pairs */ public static function &eventTemplates($id = NULL) { if (!self::$eventTemplates) { @@ -303,7 +310,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * * @param int $id - * @return array - array reference of all pcp if any + * @return array + * array reference of all pcp if any * @static */ public static function &pcPage($id = NULL) { diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 21a61abb84..dfefd6f4d8 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -282,7 +282,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -307,7 +308,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param enum $output * What should the result set include (web/email/csv). * - * @return array rows in the given offset and rowCount + * @return array + * rows in the given offset and rowCount */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -431,7 +433,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * FIXME: the current internationalisation is bad, but should more or less work * on most of "European" languages * - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ public function getQILL() { return $this->_query->qill(); @@ -446,7 +449,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -524,7 +528,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Event Search'); diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php index 8dc470c689..48f516cd47 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -79,7 +79,8 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Event/Task.php b/CRM/Event/Task.php index 5328030121..9621d61e11 100644 --- a/CRM/Event/Task.php +++ b/CRM/Event/Task.php @@ -65,7 +65,8 @@ class CRM_Event_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -153,7 +154,8 @@ class CRM_Event_Task { * These tasks are the core set of task titles * for participants * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -171,7 +173,8 @@ class CRM_Event_Task { /** * These tasks get added based on the context the user is in * - * @return array the set of optional tasks for a group of contacts + * @return array + * the set of optional tasks for a group of contacts * @static */ public static function &optionalTaskTitle() { @@ -187,7 +190,8 @@ class CRM_Event_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -216,7 +220,8 @@ class CRM_Event_Task { * * @param int $value * - * @return array the set of tasks for a group of participants + * @return array + * the set of tasks for a group of participants * @static */ public static function getTask($value) { diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index 0ad4266f68..8d3d513ef5 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -1200,7 +1200,8 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c * @param int $mode * Export mode. * - * @return string name of the file + * @return string + * name of the file */ public static function getExportFileName($output = 'csv', $mode = CRM_Export_Form_Select::CONTACT_EXPORT) { switch ($mode) { diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index b41ed45370..45f9a95a8e 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -112,7 +112,8 @@ class CRM_Export_Form_Map extends CRM_Core_Form { * @param $values * @param int $mappingTypeId * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $values, $mappingTypeId) { diff --git a/CRM/Extension/Browser.php b/CRM/Extension/Browser.php index 24cdd03149..ce632b2052 100644 --- a/CRM/Extension/Browser.php +++ b/CRM/Extension/Browser.php @@ -220,7 +220,8 @@ class CRM_Extension_Browser { * extensions. * * - * @return Array list of extension names + * @return Array + * list of extension names */ private function grabRemoteKeyList() { diff --git a/CRM/Extension/Container/Collection.php b/CRM/Extension/Container/Collection.php index 815789e23a..e3652f70fd 100644 --- a/CRM/Extension/Container/Collection.php +++ b/CRM/Extension/Container/Collection.php @@ -148,7 +148,8 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte * Get a list of all keys in these containers -- and the * name of the container which defines each key. * - * @return array ($key => $containerName) + * @return array + * ($key => $containerName) */ public function getKeysToContainer() { if ($this->cache) { diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php index 75b46517b9..d3f6322bb1 100644 --- a/CRM/Extension/Downloader.php +++ b/CRM/Extension/Downloader.php @@ -59,7 +59,8 @@ class CRM_Extension_Downloader { /** * Determine whether downloading is supported * - * @return array list of error messages; empty if OK + * @return array + * list of error messages; empty if OK */ public function checkRequirements() { $errors = array(); @@ -101,7 +102,8 @@ class CRM_Extension_Downloader { * The name of the extension being installed. * @param string $downloadUrl * URL of a .zip file. - * @return bool TRUE for success + * @return bool + * TRUE for success * @throws CRM_Extension_Exception */ public function download($key, $downloadUrl) { @@ -137,7 +139,8 @@ class CRM_Extension_Downloader { * URL of a .zip file. * @param string $localFile * Path at which to store the .zip file. - * @return boolean Whether the download was successful. + * @return boolean + * Whether the download was successful. */ public function fetch($remoteFile, $localFile) { $result = CRM_Utils_HttpClient::singleton()->fetch($remoteFile, $localFile); diff --git a/CRM/Extension/Manager.php b/CRM/Extension/Manager.php index 3cfca6397c..0eefba9fb6 100644 --- a/CRM/Extension/Manager.php +++ b/CRM/Extension/Manager.php @@ -387,7 +387,8 @@ class CRM_Extension_Manager { * * @param $key * - * @return string constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN) + * @return string + * constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN) */ public function getStatus($key) { $statuses = $this->getStatuses(); @@ -402,7 +403,8 @@ class CRM_Extension_Manager { /** * Determine the status of all extensions * - * @return array ($key => status_constant) + * @return array + * ($key => status_constant) */ public function getStatuses() { if (!is_array($this->statuses)) { @@ -450,7 +452,8 @@ class CRM_Extension_Manager { * @param $key * * @throws CRM_Extension_Exception - * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) + * @return array + * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) */ private function _getInfoTypeHandler($key) { $info = $this->mapper->keyToInfo($key); // throws Exception @@ -468,7 +471,8 @@ class CRM_Extension_Manager { * @param $key * * @throws CRM_Extension_Exception - * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) + * @return array + * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) */ private function _getMissingInfoTypeHandler($key) { $info = $this->createInfoFromDB($key); diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index f34cd08b1d..1926804fbd 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -164,7 +164,8 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { /** * @param string $attr * The attribute used to key the array. - * @return array ($$attr => $id) + * @return array + * ($$attr => $id) */ private function _getAllPaymentProcessorTypes($attr) { $ppt = array(); diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php index cf94324e5b..0a6b59ae4e 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -118,7 +118,8 @@ class CRM_Extension_Mapper { * @param string $clazz * Extension class name. * - * @return string name of extension key + * @return string + * name of extension key */ public function classToKey($clazz) { return str_replace('_', '.', $clazz); @@ -130,7 +131,8 @@ class CRM_Extension_Mapper { * * @param $clazz * - * @return string full path the extension .php file + * @return string + * full path the extension .php file */ public function classToPath($clazz) { $elements = explode('_', $clazz); @@ -145,7 +147,8 @@ class CRM_Extension_Mapper { * @param string $key * A string which might be an extension key. * - * @return boolean true if given string is an extension name + * @return boolean + * true if given string is an extension name */ public function isExtensionKey($key) { // check if the string is an extension name or the class @@ -159,7 +162,8 @@ class CRM_Extension_Mapper { * @param string $clazz * A string which might be an extension class name. * - * @return boolean true if given string is an extension class name + * @return boolean + * true if given string is an extension class name */ public function isExtensionClass($clazz) { @@ -201,7 +205,8 @@ class CRM_Extension_Mapper { * @param string $key * Extension key. * - * @return string name of extension's main class + * @return string + * name of extension's main class */ public function keyToClass($key) { return str_replace('.', '_', $key); @@ -215,7 +220,8 @@ class CRM_Extension_Mapper { * @param string $key * Extension key. * - * @return string path to file containing extension's main class + * @return string + * path to file containing extension's main class */ public function keyToPath($key) { $info = $this->keyToInfo($key); @@ -228,7 +234,8 @@ class CRM_Extension_Mapper { * * @param string $key * Extension key. - * @return string local path of the extension source tree + * @return string + * local path of the extension source tree */ public function keyToBasePath($key) { if ($key == 'civicrm') { @@ -245,7 +252,8 @@ class CRM_Extension_Mapper { * @param string $key * Extension key. * - * @return string url for resources in this extension + * @return string + * url for resources in this extension */ public function keyToUrl($key) { if ($key == 'civicrm') { @@ -266,7 +274,8 @@ class CRM_Extension_Mapper { * * @param bool $fresh * whether to forcibly reload extensions list from canonical store. - * @return array - array(array('prefix' => $, 'file' => $)) + * @return array + * array(array('prefix' => $, 'file' => $)) */ public function getActiveModuleFiles($fresh = FALSE) { $config = CRM_Core_Config::singleton(); @@ -318,7 +327,8 @@ class CRM_Extension_Mapper { /** * Get a list of base URLs for all active modules * - * @return array (string $extKey => string $baseUrl) + * @return array + * (string $extKey => string $baseUrl) */ public function getActiveModuleUrls() { // TODO optimization/caching @@ -351,7 +361,8 @@ class CRM_Extension_Mapper { /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module */ public function getModules() { $result = array(); @@ -371,7 +382,8 @@ class CRM_Extension_Mapper { * @param string $clazz * Extension class name. * - * @return string path to extension's templates directory + * @return string + * path to extension's templates directory */ public function getTemplatePath($clazz) { $path = $this->container->getPath($this->classToKey($clazz)); @@ -392,7 +404,8 @@ class CRM_Extension_Mapper { * @param string $clazz * Extension class name. * - * @return string extension's template name + * @return string + * extension's template name */ public function getTemplateName($clazz) { $info = $this->keyToInfo($this->classToKey($clazz)); diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index a8a15e9fde..50025c8bb5 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -77,7 +77,8 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -191,7 +192,8 @@ WHERE cft.id = %1 * * @param \account|string $accountTypeCode account type code * - * @return integer count + * @return integer + * count * @static */ public static function getARAccounts($financialAccountId, $financialAccountTypeId = NULL, $accountTypeCode = 'ar') { diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index 01a1cc95a6..8fe113f6b2 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -77,7 +77,8 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -168,7 +169,8 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { * fetch financial type having relationship as Income Account is * * - * @return array all financial type with income account is relationship + * @return array + * all financial type with income account is relationship * @static */ public static function getIncomeFinancialType() { diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index adb740cb33..d32fde8ffa 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -122,7 +122,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -135,7 +136,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * * @param NULL * - * @return object The default payment processor object on success, + * @return object + * The default payment processor object on success, * null otherwise * @static */ @@ -183,7 +185,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param string $mode * Payment mode ie test or live. * - * @return array associated array with payment processor related fields + * @return array + * associated array with payment processor related fields * @static */ public static function getPayment($paymentProcessorID, $mode) { @@ -259,7 +262,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param string $mode * Payment mode ie test or live. * - * @return array associated array with payment processor related fields + * @return array + * associated array with payment processor related fields * @static */ public static function buildPayment($dao, $mode) { @@ -341,7 +345,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * * @param array $ids * - * @return array available processors + * @return array + * available processors */ public static function getPaymentProcessors($capabilities = array(), $ids = array()) { $mode = NULL; @@ -395,7 +400,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param string $type * Type of payment information to be retrieved. * - * @return int / array / object based on type + * @return int + * / array / object based on type * @static */ public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') { diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 0108f5e5c9..59a8690c43 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -75,7 +75,8 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -88,7 +89,8 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr * * @param NULL * - * @return object The default payment processor object on success, + * @return object + * The default payment processor object on success, * null otherwise * @static */ diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index 5226064acc..e60ac153c3 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -134,7 +134,8 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { * * @internal param array $fields posted values of the form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { diff --git a/CRM/Financial/Form/FinancialBatch.php b/CRM/Financial/Form/FinancialBatch.php index 5b8cc30436..4e611b9cb9 100644 --- a/CRM/Financial/Form/FinancialBatch.php +++ b/CRM/Financial/Form/FinancialBatch.php @@ -175,7 +175,8 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { @@ -293,7 +294,8 @@ class CRM_Financial_Form_FinancialBatch extends CRM_Contribute_Form { * @param int $userContactID * @param string $actionName * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public function checkPermissions($action, $permissions, $createdID, $userContactID, $actionName) { diff --git a/CRM/Financial/Form/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index 0e0f58151b..3af2b89b48 100644 --- a/CRM/Financial/Form/FinancialTypeAccount.php +++ b/CRM/Financial/Form/FinancialTypeAccount.php @@ -237,7 +237,8 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { * * @internal param array $fields posted values of the form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($values, $files, $self) { diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index 94892e928f..4c86dedcbb 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -49,7 +49,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Batch_BAO_Batch'; @@ -58,7 +59,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { } @@ -66,7 +68,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Financial_Form_FinancialBatch'; @@ -75,7 +78,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return ts('Accounting Batch Processing'); @@ -86,7 +90,8 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return CRM_Utils_System::currentPath(); diff --git a/CRM/Financial/Page/BatchTransaction.php b/CRM/Financial/Page/BatchTransaction.php index 4e5fb2d32b..cb1afa1254 100644 --- a/CRM/Financial/Page/BatchTransaction.php +++ b/CRM/Financial/Page/BatchTransaction.php @@ -52,7 +52,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Batch_BAO_Batch'; @@ -61,7 +62,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -130,7 +132,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Financial_Form_BatchTransaction'; @@ -139,7 +142,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Batch'; @@ -150,7 +154,8 @@ class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/batchtransaction'; diff --git a/CRM/Financial/Page/FinancialAccount.php b/CRM/Financial/Page/FinancialAccount.php index 80e66f871f..096ec2c582 100644 --- a/CRM/Financial/Page/FinancialAccount.php +++ b/CRM/Financial/Page/FinancialAccount.php @@ -50,7 +50,8 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Financial_BAO_FinancialAccount'; @@ -59,7 +60,8 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -168,7 +170,8 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Financial_Form_FinancialAccount'; @@ -177,7 +180,8 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Financial Types'; @@ -188,7 +192,8 @@ class CRM_Financial_Page_FinancialAccount extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/financial/financialAccount'; diff --git a/CRM/Financial/Page/FinancialBatch.php b/CRM/Financial/Page/FinancialBatch.php index cbf0a41fdc..48050b168c 100644 --- a/CRM/Financial/Page/FinancialBatch.php +++ b/CRM/Financial/Page/FinancialBatch.php @@ -49,7 +49,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string classname of BAO. + * @return string + * classname of BAO. */ public function getBAOName() { return 'CRM_Batch_BAO_Batch'; @@ -58,7 +59,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -100,7 +102,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string classname of edit form. + * @return string + * classname of edit form. */ public function editForm() { return 'CRM_Financial_Form_FinancialBatch'; @@ -109,7 +112,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Accounting Batch'; @@ -122,7 +126,8 @@ class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { $context = $this->get("context"); diff --git a/CRM/Financial/Page/FinancialType.php b/CRM/Financial/Page/FinancialType.php index 5903c2ebc5..17884c3af1 100644 --- a/CRM/Financial/Page/FinancialType.php +++ b/CRM/Financial/Page/FinancialType.php @@ -50,7 +50,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Financial_BAO_FinancialType'; @@ -59,7 +60,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -194,7 +196,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Financial_Form_FinancialType'; @@ -203,7 +206,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Financial Types'; @@ -214,7 +218,8 @@ class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/financial/financialType'; diff --git a/CRM/Financial/Page/FinancialTypeAccount.php b/CRM/Financial/Page/FinancialTypeAccount.php index 699215d792..282a1708f2 100644 --- a/CRM/Financial/Page/FinancialTypeAccount.php +++ b/CRM/Financial/Page/FinancialTypeAccount.php @@ -56,7 +56,8 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Financial_BAO_FinancialTypeAccount'; @@ -65,7 +66,8 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 91e54dd471..78ac9e23ea 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -72,7 +72,8 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @param array $values * Output values of the object. * - * @return array $values values + * @return array + * values * @static */ public static function retrieve(&$params, &$values) { diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index 4eba56bb94..c7ed660303 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -55,7 +55,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @param bool $admin * - * @return array Array of event summary values + * @return array + * Array of event summary values */ public static function getGrantSummary($admin = FALSE) { $query = " @@ -93,7 +94,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @static * - * @return array Array of event summary values + * @return array + * Array of event summary values */ public static function getGrantStatusOptGroup() { @@ -117,7 +119,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @param bool $admin * - * @return array Array of grant summary statistics + * @return array + * Array of grant summary statistics */ public static function getGrantStatistics($admin = FALSE) { $grantStatuses = array(); @@ -363,7 +366,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Combine all the exportable fields from the lower levels object * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields() { @@ -421,7 +425,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @param int $contactID * - * @return int count of grant records + * @return int + * count of grant records * @static */ public static function getContactGrantCount($contactID) { diff --git a/CRM/Grant/Form/Search.php b/CRM/Grant/Form/Search.php index e522718b0e..6932a8fbb1 100644 --- a/CRM/Grant/Form/Search.php +++ b/CRM/Grant/Form/Search.php @@ -271,7 +271,8 @@ class CRM_Grant_Form_Search extends CRM_Core_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function &setDefaultValues() { return $this->_formValues; diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 60f17f30bb..669ac6768e 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -246,7 +246,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -271,7 +272,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -331,7 +333,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -349,7 +352,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -420,7 +424,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Grant Search'); diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index 34bb2ce736..a3e55f5440 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -79,7 +79,8 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Grant/Task.php b/CRM/Grant/Task.php index 8ea92e0542..17e56abb6f 100644 --- a/CRM/Grant/Task.php +++ b/CRM/Grant/Task.php @@ -61,7 +61,8 @@ class CRM_Grant_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -103,7 +104,8 @@ class CRM_Grant_Task { /** * These tasks are the core set of task titles * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -121,7 +123,8 @@ class CRM_Grant_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -147,7 +150,8 @@ class CRM_Grant_Task { * * @param int $value * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function getTask($value) { diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php index 8892eae7b1..e112851194 100644 --- a/CRM/Group/Form/Edit.php +++ b/CRM/Group/Form/Edit.php @@ -313,7 +313,8 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { * @param array $fileParams * @param $options * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $fileParams, $options) { @@ -439,7 +440,8 @@ WHERE title = %1 * * @param CRM_Core_Form $form * - * @return array parent groups + * @return array + * parent groups * @static */ public static function buildParentGroups(&$form) { diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index dd148c4094..df6c826064 100644 --- a/CRM/Group/Page/Group.php +++ b/CRM/Group/Page/Group.php @@ -45,7 +45,8 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { /** * Define action links * - * @return array self::$_links array of action links + * @return array + * self::$_links array of action links */ public function &links() { } @@ -107,7 +108,8 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { * @param int $title * Name or title of the object. * - * @return string the permission that the user has (or null) + * @return string + * the permission that the user has (or null) */ public function checkPermission($id, $title) { return CRM_Contact_BAO_Group::checkPermission($id, $title); diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 7563bd302b..f3b420b26e 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -42,7 +42,8 @@ abstract class CRM_Import_DataSource { /** * Provides information about the data source * - * @return array collection of info about this data source + * @return array + * collection of info about this data source * * */ @@ -61,7 +62,8 @@ abstract class CRM_Import_DataSource { * * @param CRM_Core_Form $form * - * @return void (operates directly on form argument) + * @return void + * (operates directly on form argument) */ abstract public function buildQuickForm(&$form); diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 52d5e26e58..3ebad91666 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -39,7 +39,8 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { /** * Provides information about the data source * - * @return array collection of info about this data source + * @return array + * collection of info about this data source * * */ @@ -61,7 +62,8 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { * * @param CRM_Core_Form $form * - * @return void (operates directly on form argument) + * @return void + * (operates directly on form argument) */ public function buildQuickForm(&$form) { $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_CSV'); @@ -114,7 +116,8 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { * @param string $fieldSeparator * Character that seperates the various columns in the file. * - * @return string name of the created table + * @return string + * name of the created table */ private static function _CsvToTable( &$db, diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php index ea1db8fbcc..43abe5609a 100644 --- a/CRM/Import/DataSource/SQL.php +++ b/CRM/Import/DataSource/SQL.php @@ -37,7 +37,8 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { /** * Provides information about the data source * - * @return array collection of info about this data source + * @return array + * collection of info about this data source * * */ @@ -59,7 +60,8 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { * * @param CRM_Core_Form $form * - * @return void (operates directly on form argument) + * @return void + * (operates directly on form argument) */ public function buildQuickForm(&$form) { $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_SQL'); diff --git a/CRM/Import/Parser.php b/CRM/Import/Parser.php index 749ec38478..530e13f564 100644 --- a/CRM/Import/Parser.php +++ b/CRM/Import/Parser.php @@ -269,7 +269,8 @@ abstract class CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference) associative array of name/value pairs + * @return array + * (reference) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Mailing/BAO/BouncePattern.php b/CRM/Mailing/BAO/BouncePattern.php index 45fb02a1c1..6a1018efe4 100644 --- a/CRM/Mailing/BAO/BouncePattern.php +++ b/CRM/Mailing/BAO/BouncePattern.php @@ -77,7 +77,8 @@ class CRM_Mailing_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern { * @param string $message * The message to be matched. * - * @return array Tuple (bounce_type, bounce_reason) + * @return array + * Tuple (bounce_type, bounce_reason) * @static */ public static function &match(&$message) { diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index 0e41abf072..6091bad757 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -70,7 +70,8 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index f55ffd2caa..7381ed024a 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -659,7 +659,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * * @param string $token The token for which we will be doing adata lookup * - * @return array $funcStruct An array that holds the token itself and the type. + * @return array + * An array that holds the token itself and the type. * the type will tell us which function to use for the data lookup * if we need to do a lookup at all */ @@ -767,7 +768,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * that the user has uploaded or declared (if they have dome that) * * - * @return array reference to an assoc array + * @return array + * reference to an assoc array * **/ private function &getTemplates() { @@ -834,7 +836,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * this function needs to have some sort of a body assigned * either text or html for this to have any meaningful impact * - * @return array reference to an assoc array + * @return array + * reference to an assoc array * **/ public function &getTokens() { @@ -867,7 +870,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * Returns the token set for all 3 parts as one set. This allows it to be sent to the * hook in one call and standardizes it across other token workflows * - * @return array reference to an assoc array + * @return array + * reference to an assoc array * **/ public function &getFlattenedTokens() { @@ -1035,7 +1039,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * @param string $email * Destination address. * - * @return array (reference) array array ref that hold array refs to the verp info and urls + * @return array + * (reference) array array ref that hold array refs to the verp info and urls */ public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) { // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders() @@ -1063,7 +1068,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * * @param bool $isForward * - * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers + * @return array + * (reference) array array ref that hold array refs to the verp info, urls, and headers * @access private */ private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) { @@ -1502,7 +1508,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * Return a list of group names for this mailing. Does not work with * prior-mailing targets. * - * @return array Names of groups receiving this mailing + * @return array + * Names of groups receiving this mailing */ public function &getGroupNames() { if (!isset($this->id)) { @@ -1583,7 +1590,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * @param array $params * @param array $ids * - * @return object $mailing The new mailing object + * @return object + * $mailing The new mailing object * @static */ public static function create(&$params, $ids = array()) { @@ -1768,7 +1776,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * * @param bool $isSMS * - * @return array Associative array of reporting data + * @return array + * Associative array of reporting data * @static */ public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) { @@ -2239,7 +2248,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * * @param * - * @return int Count + * @return int + * Count */ public function getCount() { $this->selectAdd(); @@ -2300,7 +2310,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * where the user has access to ALL groups, and hence ALL mailings and return a * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs * - * @return boolean | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty) + * @return boolean + * | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty) * @static */ public static function mailingACLIDs() { @@ -2354,7 +2365,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id * @param null $additionalClause * @param array $additionalParams * - * @return array The rows + * @return array + * The rows */ public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) { $mailing = self::getTableName(); @@ -2687,7 +2699,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id /** * Get the search based mailing Ids * - * @return array $mailingIDs, searched base mailing ids. + * @return array + * , searched base mailing ids. */ public function searchMailingIDs() { $group = CRM_Mailing_DAO_MailingGroup::getTableName(); @@ -2719,7 +2732,8 @@ SELECT $mailing.id as mailing_id * * @param bool $isSMS * - * @return array $report array content/component. + * @return array + * array content/component. * @access public */ public static function getMailingContent(&$report, &$form, $isSMS = FALSE) { @@ -2922,7 +2936,8 @@ AND m.id = %1 * @param array $params * Associated array for params record id. * - * @return array $contactActivities associated array of contact activities + * @return array + * associated array of contact activities */ public static function getContactMailingSelector(&$params) { // format the params @@ -3008,7 +3023,8 @@ AND m.id = %1 * @param array $params * Associated array. * - * @return array of mailings for a contact + * @return array + * of mailings for a contact * * @static */ @@ -3028,7 +3044,8 @@ AND m.id = %1 * @param array $params * Associated array. * - * @return int count of mailings for a contact + * @return int + * count of mailings for a contact * * @static */ diff --git a/CRM/Mailing/BAO/MailingAB.php b/CRM/Mailing/BAO/MailingAB.php index a297aad6d1..c6ba6c22a1 100644 --- a/CRM/Mailing/BAO/MailingAB.php +++ b/CRM/Mailing/BAO/MailingAB.php @@ -54,7 +54,8 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { * @param $params * @param array $ids * - * @return object $mailingab The new mailingab object + * @return object + * $mailingab The new mailingab object * @static */ public static function create(&$params, $ids = array()) { diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index f12e031ccf..b9e83d9f7d 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -866,7 +866,8 @@ AND status IN ( 'Scheduled', 'Running', 'Paused' ) * @param string $status * The status enum. * - * @return string The translated version + * @return string + * The translated version * @static */ public static function status($status) { @@ -888,7 +889,8 @@ AND status IN ( 'Scheduled', 'Running', 'Paused' ) * Return a workflow clause for use in SQL queries, * to only process jobs that are approved. * - * @return string For use in a WHERE clause + * @return string + * For use in a WHERE clause * @static */ public static function workflowClause() { diff --git a/CRM/Mailing/BAO/TrackableURL.php b/CRM/Mailing/BAO/TrackableURL.php index 473fc84c95..68d459b224 100644 --- a/CRM/Mailing/BAO/TrackableURL.php +++ b/CRM/Mailing/BAO/TrackableURL.php @@ -52,7 +52,8 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL { * @param int $queue_id * The queue event id (contact clicking through). * - * @return string $redirect The redirect/tracking url + * @return string + * The redirect/tracking url * @static */ public static function getTrackerURL($url, $mailing_id, $queue_id) { diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index 4435343cb9..fc08f648fa 100755 --- a/CRM/Mailing/Event/BAO/Bounce.php +++ b/CRM/Mailing/Event/BAO/Bounce.php @@ -128,7 +128,8 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { * @param bool $is_distinct * Group by queue ID?. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount($mailing_id, $job_id = NULL, $is_distinct = FALSE, $toDate = NULL) { @@ -188,7 +189,8 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { * @param array $sort * Sort array. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Confirm.php b/CRM/Mailing/Event/BAO/Confirm.php index 99479a200f..68f8cb655c 100644 --- a/CRM/Mailing/Event/BAO/Confirm.php +++ b/CRM/Mailing/Event/BAO/Confirm.php @@ -57,7 +57,8 @@ class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm { * @param string $hash * The hash. * - * @return boolean True on success + * @return boolean + * True on success * @static */ public static function confirm($contact_id, $subscribe_id, $hash) { diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php index f072617d0b..04d1532523 100755 --- a/CRM/Mailing/Event/BAO/Delivered.php +++ b/CRM/Mailing/Event/BAO/Delivered.php @@ -91,7 +91,8 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { * @param bool $is_distinct * Group by queue ID?. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount($mailing_id, $job_id = NULL, $is_distinct = FALSE, $toDate = NULL) { @@ -156,7 +157,8 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { * @param array $sort * Sort array. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Forward.php b/CRM/Mailing/Event/BAO/Forward.php index c0a2b26104..c12916ed8b 100644 --- a/CRM/Mailing/Event/BAO/Forward.php +++ b/CRM/Mailing/Event/BAO/Forward.php @@ -223,7 +223,8 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { * @param bool $is_distinct * Group by queue ID?. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount( @@ -283,7 +284,8 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { * @param array $sort * Sort array. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 3ddef2935e..fc7284f205 100755 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -78,7 +78,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * @param bool $is_distinct * Group by queue ID?. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount( @@ -134,7 +135,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * * @param $mailingIDs * - * @return array Opened count per mailing ID + * @return array + * Opened count per mailing ID * @static */ public static function getMailingTotalCount($mailingIDs) { @@ -174,7 +176,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * @param int $contactID * ID of the contact. * - * @return array Count per mailing ID + * @return array + * Count per mailing ID * @static */ public static function getMailingContactCount($mailingIDs, $contactID) { @@ -226,7 +229,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * * @param int $contact_id * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index b459ff8bfc..90ae82157f 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -65,7 +65,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * * @param array The ids to be hashed * - * @return int The hash + * @return int + * The hash * @static */ public static function hash($params) { @@ -111,7 +112,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * @param int $queue_id * The queue event ID. * - * @return string The email address + * @return string + * The email address * @static */ public static function getEmailAddress($queue_id) { @@ -140,7 +142,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * @param int $job_id * Optional ID of a job to limit results. * - * @return int Number of matching events + * @return int + * Number of matching events * @static */ public static function getTotalCount($mailing_id, $job_id = NULL) { @@ -181,7 +184,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * @param array $sort * Sort array. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( @@ -257,7 +261,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * * @param * - * @return object Mailing BAO + * @return object + * Mailing BAO */ public function &getMailing() { $mailing = new CRM_Mailing_BAO_Mailing(); diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index 7c33b6f6e5..654a05f90a 100644 --- a/CRM/Mailing/Event/BAO/Reply.php +++ b/CRM/Mailing/Event/BAO/Reply.php @@ -313,7 +313,8 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { * @param bool $is_distinct * Group by queue ID?. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount( @@ -373,7 +374,8 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { * @param array $sort * Sort array. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index 7df9029bfc..dc12b8d363 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -306,7 +306,8 @@ SELECT civicrm_email.id as email_id * @param int $subscribe_id * ID of the subscribe event. * - * @return object $domain The domain owning the event + * @return object + * $domain The domain owning the event * @static */ public static function &getDomain($subscribe_id) { @@ -321,7 +322,8 @@ SELECT civicrm_email.id as email_id * @param int $contactID * ContactID if we want an exact match. * - * @return array $groups array of group ids + * @return array + * array of group ids */ public static function getContactGroups($email, $contactID = NULL) { if ($contactID) { diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index dbb19e056a..76af8fe1e7 100755 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -50,7 +50,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * @param int $url_id * The ID of the trackable URL. * - * @return string $url The redirection url, or base url on failure. + * @return string + * The redirection url, or base url on failure. * @static */ public static function track($queue_id, $url_id) { @@ -107,7 +108,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * @param int $url_id * Optional ID of a url to filter on. * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount( @@ -165,7 +167,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * * @param $mailingIDs * - * @return array trackable url count per mailing ID + * @return array + * trackable url count per mailing ID * @static */ public static function getMailingTotalCount($mailingIDs) { @@ -205,7 +208,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * @param int $contactID * ID of the contact. * - * @return array Count per mailing ID + * @return array + * Count per mailing ID * @static */ public static function getMailingContactCount($mailingIDs, $contactID) { @@ -259,7 +263,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * @param int $contact_id * Optional contact ID. * - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index b765a77cc0..79e7d234ee 100755 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -57,7 +57,8 @@ class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscrib * @param string $hash * The hash. * - * @return boolean Was the contact successfully unsubscribed? + * @return boolean + * Was the contact successfully unsubscribed? * @static */ public static function unsub_from_domain($job_id, $queue_id, $hash) { @@ -424,7 +425,8 @@ WHERE email = %2 * * @param null $org_unsubscribe * - * @return int Number of rows in result set + * @return int + * Number of rows in result set * @static */ public static function getTotalCount( @@ -496,7 +498,8 @@ WHERE email = %2 * Sort array. * * @param null $org_unsubscribe - * @return array Result set + * @return array + * Result set * @static */ public static function &getRows( diff --git a/CRM/Mailing/Form/Group.php b/CRM/Mailing/Form/Group.php index 097390ab34..db2d9ac026 100644 --- a/CRM/Mailing/Form/Group.php +++ b/CRM/Mailing/Form/Group.php @@ -543,7 +543,8 @@ class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Mailing/Form/Schedule.php b/CRM/Mailing/Form/Schedule.php index 9df12ba0d6..0e1e252e4d 100644 --- a/CRM/Mailing/Form/Schedule.php +++ b/CRM/Mailing/Form/Schedule.php @@ -195,7 +195,8 @@ class CRM_Mailing_Form_Schedule extends CRM_Core_Form { * @param $files * @param $self * - * @return boolean True if either we deliver immediately, or the + * @return boolean + * True if either we deliver immediately, or the * date is properly set. * @static */ diff --git a/CRM/Mailing/Form/Test.php b/CRM/Mailing/Form/Test.php index faf55cd6b2..bf7cc15dcf 100644 --- a/CRM/Mailing/Form/Test.php +++ b/CRM/Mailing/Form/Test.php @@ -177,7 +177,8 @@ class CRM_Mailing_Form_Test extends CRM_Core_Form { * @param array $self * An current this object. * - * @return boolean true on successful SMTP handoff + * @return boolean + * true on successful SMTP handoff */ public static function testMail($testParams, $files, $self) { $error = NULL; diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php index 0b8e9226cb..8aeb441856 100644 --- a/CRM/Mailing/MailStore.php +++ b/CRM/Mailing/MailStore.php @@ -43,7 +43,8 @@ class CRM_Mailing_MailStore { * Name of the settings set from civimail_mail_settings to use (null for default). * * @throws Exception - * @return object mail store implementation for processing CiviMail-bound emails + * @return object + * mail store implementation for processing CiviMail-bound emails */ public static function getStore($name = NULL) { $dao = new CRM_Core_DAO_MailSettings; @@ -85,7 +86,8 @@ class CRM_Mailing_MailStore { /** * Return all emails in the mail store * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function allMails() { return $this->fetchNext(0); @@ -103,7 +105,8 @@ class CRM_Mailing_MailStore { * @param int $count * Number of messages to fetch (0 to fetch all). * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function fetchNext($count = 1) { if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) { @@ -146,7 +149,8 @@ class CRM_Mailing_MailStore { * Name of the Maildir. * * @throws Exception - * @return string path to the Maildir's cur directory + * @return string + * path to the Maildir's cur directory */ public function maildir($name) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Mailing/MailStore/Localdir.php b/CRM/Mailing/MailStore/Localdir.php index 4aa8da061b..1f46225178 100644 --- a/CRM/Mailing/MailStore/Localdir.php +++ b/CRM/Mailing/MailStore/Localdir.php @@ -63,7 +63,8 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { * @param int $count * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all). * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function fetchNext($count = 0) { $mails = array(); diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php index 9a58bf0184..0c21cd8a41 100644 --- a/CRM/Mailing/MailStore/Maildir.php +++ b/CRM/Mailing/MailStore/Maildir.php @@ -63,7 +63,8 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { * @param int $count * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all). * - * @return array array of ezcMail objects + * @return array + * array of ezcMail objects */ public function fetchNext($count = 0) { $mails = array(); diff --git a/CRM/Mailing/Page/Component.php b/CRM/Mailing/Page/Component.php index 7f7f190754..ba5842afa0 100644 --- a/CRM/Mailing/Page/Component.php +++ b/CRM/Mailing/Page/Component.php @@ -50,7 +50,8 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Mailing_BAO_Component'; @@ -59,7 +60,8 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -88,7 +90,8 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Mailing_Form_Component'; @@ -97,7 +100,8 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Mailing Components'; @@ -108,7 +112,8 @@ class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return CRM_Utils_System::currentPath(); diff --git a/CRM/Mailing/Page/Report.php b/CRM/Mailing/Page/Report.php index cf796a06fb..f379a1c84d 100644 --- a/CRM/Mailing/Page/Report.php +++ b/CRM/Mailing/Page/Report.php @@ -43,7 +43,8 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO + * @return string + * Classname of BAO */ public function getBAOName() { return 'CRM_Mailing_BAO_Mailing'; @@ -75,7 +76,8 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/mailing/report'; diff --git a/CRM/Mailing/PseudoConstant.php b/CRM/Mailing/PseudoConstant.php index 4b73291105..2e254b45e8 100644 --- a/CRM/Mailing/PseudoConstant.php +++ b/CRM/Mailing/PseudoConstant.php @@ -71,7 +71,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * @param $type * The type of component needed. * - * @return array - array reference of all mailing components + * @return array + * array reference of all mailing components * @static */ public static function &component($type = NULL) { @@ -112,7 +113,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * @param $undefined * The value to use if no default is defined. * - * @return integer -The ID of the default mailing component. + * @return integer + * The ID of the default mailing component. * @static */ public static function &defaultComponent($type, $undefined = NULL) { @@ -138,7 +140,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * Get all the mailing templates * * - * @return array - array reference of all mailing templates if any + * @return array + * array reference of all mailing templates if any * @static */ public static function &template() { @@ -154,7 +157,8 @@ class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant { * * @param null $mode * - * @return array - array reference of all mailing templates if any + * @return array + * array reference of all mailing templates if any * @static */ public static function &completed($mode = NULL) { diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index b973623dda..c0c98b1bb4 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -100,7 +100,8 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { $mailing = CRM_Mailing_BAO_Mailing::getTableName(); @@ -185,7 +186,8 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { $job = CRM_Mailing_BAO_MailingJob::getTableName(); @@ -222,7 +224,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { static $actionLinks = NULL; @@ -424,7 +427,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviMail Mailings'); diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index cd1293da8f..deb1889117 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -140,7 +140,8 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { $mailing = CRM_Mailing_BAO_Mailing::getTableName(); @@ -257,7 +258,8 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { switch ($this->_event_type) { @@ -353,7 +355,8 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { switch ($this->_event_type) { @@ -430,7 +433,8 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') {} diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php index d570f14ab3..f59b12a60c 100644 --- a/CRM/Mailing/Selector/Search.php +++ b/CRM/Mailing/Selector/Search.php @@ -249,7 +249,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -274,7 +275,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -328,7 +330,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -346,7 +349,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -408,7 +412,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_ * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Mailing Search'); diff --git a/CRM/Mailing/Task.php b/CRM/Mailing/Task.php index 1c60880a26..d839a0a26d 100644 --- a/CRM/Mailing/Task.php +++ b/CRM/Mailing/Task.php @@ -59,7 +59,8 @@ class CRM_Mailing_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -83,7 +84,8 @@ class CRM_Mailing_Task { * These tasks are the core set of task titles * on mailing recipients * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -96,7 +98,8 @@ class CRM_Mailing_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $task = array(); @@ -109,7 +112,8 @@ class CRM_Mailing_Task { * * @param int $value * - * @return array the set of tasks for a group of mailing recipients + * @return array + * the set of tasks for a group of mailing recipients * @static */ public static function getTask($value) { diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index 0965af07bb..f71013600f 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -451,7 +451,8 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * * @param int $action * - * @return Array array of contact_id of all related contacts. + * @return Array + * array of contact_id of all related contacts. * @static */ public static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action::ADD) { @@ -557,7 +558,8 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * @param int $membershipId * Membership id of values to return. * - * @return array of key value pairs + * @return array + * of key value pairs */ public static function getStatusANDTypeValues($membershipId) { $values = array(); @@ -712,7 +714,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * @param string $status * Active or inactive. * - * @return array $actives array of memberships based on status + * @return array + * array of memberships based on status * @static */ public static function activeMembers($memberships, $status = 'active') { @@ -752,7 +755,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * Thank you page. * @param null $isTest * - * @return bool Is this a separate membership payment + * @return bool + * Is this a separate membership payment * * @static */ @@ -1087,7 +1091,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * Contact type. * @param bool $status * - * @return array array of importable Fields + * @return array + * array of importable Fields * @static */ public static function &importableFields($contactType = 'Individual', $status = TRUE) { @@ -1185,7 +1190,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * @param bool|int $isTest if true, membership is for a test site * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD * - * @return integer the number of members of type $membershipTypeId whose + * @return integer + * the number of members of type $membershipTypeId whose * start_date is between $startDate and $endDate */ //LCD @@ -1671,7 +1677,8 @@ AND civicrm_membership.is_test = %2"; * * @param int membershipId membership id * - * @return int $contributionPageId contribution page id + * @return int + * $contributionPageId contribution page id * @static */ public static function getContributionPageId($membershipID) { @@ -1720,7 +1727,8 @@ SELECT c.contribution_page_id as pageID * * @param null $mode * - * @return array the list of membership fields + * @return array + * the list of membership fields * @static */ public static function getMembershipFields($mode = NULL) { @@ -1937,7 +1945,8 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id * @param int $membershipId * Membsership id. * - * @return boolean true if deleted false otherwise + * @return boolean + * true if deleted false otherwise */ public static function deleteMembershipPayment($membershipId) { @@ -2078,7 +2087,8 @@ FROM civicrm_membership_type * @param int $mid * Membership id. * - * @return string $status contribution status + * @return string + * contribution status * @static */ public static function isSubscriptionCancelled($mid) { @@ -2161,7 +2171,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * Date on which to end counting. * @param bool|int $isTest if true, membership is for a test site * - * @return integer returns the number of members of type $membershipTypeId + * @return integer + * returns the number of members of type $membershipTypeId * whose join_date is before $startDate and * whose start_date is between $startDate and $endDate */ @@ -2683,7 +2694,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * @param int $membershipId * Membership id. * - * @return integer contribution id + * @return integer + * contribution id */ public static function getMembershipContributionId($membershipId) { @@ -2702,7 +2714,7 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * IMPORTANT: * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3. * - * @return array $result + * @return array */ public static function updateAllMembershipStatus() { @@ -3058,7 +3070,8 @@ WHERE civicrm_membership.is_test = 0"; * @param bool $isTest * Mode of payment. * - * @return array of membership type + * @return array + * of membership type * @static */ public static function getContactsCancelledMembership($contactID, $isTest = FALSE) { diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 2fbd000b21..bc20c9318a 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -75,7 +75,8 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index d09f7d7274..3c96443ea1 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -77,7 +77,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -294,7 +295,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * @param int $numRenewTerms * How many membership terms are being added to end date (default is 1). * - * @return array associated array with start date, end date and join date for the membership + * @return array + * associated array with start date, end date and join date for the membership * @static */ public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) { @@ -474,7 +476,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes * - * @return Array array fo the start date, end date and join date of the membership + * @return Array + * array fo the start date, end date and join date of the membership * @static */ public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) { @@ -581,7 +584,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * @param int $orgID * Id of Organization. * - * @return Array array of the details of membership types + * @return Array + * array of the details of membership types * @static */ public static function getMembershipTypesByOrg($orgID) { @@ -601,7 +605,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * * @param array membership types * - * @return Array array of the details of membership types with Member of Contact id + * @return Array + * array of the details of membership types with Member of Contact id * @static */ public static function getMemberOfContactByMemTypes($membershipTypes) { @@ -645,7 +650,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * Funtion to retrieve organization and associated membership * types * - * @return array arrays of organization and membership types + * @return array + * arrays of organization and membership types * * @static */ diff --git a/CRM/Member/Form.php b/CRM/Member/Form.php index 8918b2d30e..55a03716ca 100644 --- a/CRM/Member/Form.php +++ b/CRM/Member/Form.php @@ -85,7 +85,8 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { * the default values are retrieved from the database * * - * @return array defaults + * @return array + * defaults */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index 3af48bb184..8575c6cac0 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -1703,7 +1703,8 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; * @param object $membership * Object. * - * @return boolean true if mail was sent successfully + * @return boolean + * true if mail was sent successfully * @static */ public static function emailReceipt(&$form, &$formValues, &$membership) { diff --git a/CRM/Member/Form/MembershipConfig.php b/CRM/Member/Form/MembershipConfig.php index f044f0b8b1..c7a842525a 100644 --- a/CRM/Member/Form/MembershipConfig.php +++ b/CRM/Member/Form/MembershipConfig.php @@ -63,7 +63,8 @@ class CRM_Member_Form_MembershipConfig extends CRM_Core_Form { * the default values are retrieved from the database * * - * @return array defaults + * @return array + * defaults */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index d052c33068..1478b49d88 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -65,7 +65,8 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { diff --git a/CRM/Member/Form/Task/Label.php b/CRM/Member/Form/Task/Label.php index 41c0a2806e..dbc422669c 100644 --- a/CRM/Member/Form/Task/Label.php +++ b/CRM/Member/Form/Task/Label.php @@ -66,7 +66,8 @@ class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Member/Form/Task/PickProfile.php b/CRM/Member/Form/Task/PickProfile.php index a61c6c2540..b8191bdee5 100644 --- a/CRM/Member/Form/Task/PickProfile.php +++ b/CRM/Member/Form/Task/PickProfile.php @@ -121,7 +121,8 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index 9a6e719285..6696cd199c 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -303,7 +303,8 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index 561710c3bb..67eb3304ef 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -301,7 +301,8 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { /** * Format the field values for input to the api * - * @return array (reference ) associative array of name/value pairs + * @return array + * (reference ) associative array of name/value pairs */ public function &getActiveFieldParams() { $params = array(); diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 590afc3c4b..224c88c760 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -124,7 +124,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function preview(&$values) { return $this->summary($values); @@ -136,7 +137,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function summary(&$values) { $erroneousField = NULL; @@ -252,7 +254,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * @param array $values * The array of values belonging to this line. * - * @return boolean the result of this processing + * @return boolean + * the result of this processing */ public function import($onDuplicate, &$values) { try { @@ -591,7 +594,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * * @param $formatted * - * @return Array formatted containing date values + * @return Array + * formatted containing date values * */ public function formattedDates($calcDates, &$formatted) { diff --git a/CRM/Member/Info.php b/CRM/Member/Info.php index 5b7a9313b0..3dd121129a 100644 --- a/CRM/Member/Info.php +++ b/CRM/Member/Info.php @@ -46,7 +46,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array collection of required component settings + * @return array + * collection of required component settings * */ /** diff --git a/CRM/Member/Page/MembershipStatus.php b/CRM/Member/Page/MembershipStatus.php index 341a8cb14e..9d0e517669 100644 --- a/CRM/Member/Page/MembershipStatus.php +++ b/CRM/Member/Page/MembershipStatus.php @@ -51,7 +51,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Member_BAO_MembershipStatus'; @@ -60,7 +61,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -183,7 +185,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Member_Form_MembershipStatus'; @@ -192,7 +195,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'Membership Status'; @@ -203,7 +207,8 @@ class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/member/membershipStatus'; diff --git a/CRM/Member/Page/MembershipType.php b/CRM/Member/Page/MembershipType.php index ef739c8533..7c654505e2 100644 --- a/CRM/Member/Page/MembershipType.php +++ b/CRM/Member/Page/MembershipType.php @@ -51,7 +51,8 @@ class CRM_Member_Page_MembershipType extends CRM_Core_Page { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index 0fffb1f4c4..a72e52532a 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -460,7 +460,8 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { * @param bool $isCancelSupported * @param bool $isUpdateBilling * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ static function &links( @@ -547,7 +548,8 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * Define action links for membership types of related organization * - * @return array self::$_membershipTypesLinks array of action links + * @return array + * self::$_membershipTypesLinks array of action links */ public static function &membershipTypesLinks() { if (!self::$_membershipTypesLinks) { @@ -595,7 +597,8 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Member_BAO_Membership'; diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index 03415578db..a6331da4ad 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -60,7 +60,8 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * @param int $id * @param bool $force * - * @return array - array reference of all membership types if any + * @return array + * array reference of all membership types if any * @static */ public static function &membershipType($id = NULL, $force = FALSE) { @@ -91,7 +92,8 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $column * @param bool $force * - * @return array - array reference of all membership statuss if any + * @return array + * array reference of all membership statuss if any * @static */ public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE, $allStatus = FALSE) { diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index f2fe879425..b1463e0f06 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -297,7 +297,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -322,7 +323,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { // check if we can process credit card registration @@ -449,7 +451,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -467,7 +470,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -543,7 +547,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Member Search'); diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index 700a1d4173..7fc2a5ab6b 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -77,7 +77,8 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Member/Task.php b/CRM/Member/Task.php index fad45d85e5..8b070b13f8 100644 --- a/CRM/Member/Task.php +++ b/CRM/Member/Task.php @@ -62,7 +62,8 @@ class CRM_Member_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -131,7 +132,8 @@ class CRM_Member_Task { * These tasks are the core set of task titles * on members * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -149,7 +151,8 @@ class CRM_Member_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -177,7 +180,8 @@ class CRM_Member_Task { * * @param int $value * - * @return array the set of tasks for a group of members + * @return array + * the set of tasks for a group of members * @static */ public static function getTask($value) { diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 9dc4926209..faa031215f 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -115,7 +115,8 @@ WHERE civicrm_pcp.contact_id = civicrm_contact.id * * @param int $contactId * - * @return array array of Pcp if found + * @return array + * array of Pcp if found * @static */ public static function getPcpDashboardInfo($contactId) { @@ -258,7 +259,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * * @static * - * @return array $honor + * @return array */ public static function honorRoll($pcpId) { $query = " @@ -283,7 +284,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Get action links * - * @return array (reference) of action links + * @return array + * (reference) of action links * @static */ public static function &pcpLinks() { diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index 1458f31e38..f7eba0cbed 100644 --- a/CRM/PCP/Form/PCP.php +++ b/CRM/PCP/Form/PCP.php @@ -124,7 +124,8 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array(); @@ -194,7 +195,8 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { * @param $files * @param CRM_Core_Form $form * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index e8efea3723..861d7154d6 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -49,7 +49,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_PCP_BAO_PCP'; @@ -58,7 +59,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -358,7 +360,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_PCP_Form_PCP'; @@ -367,7 +370,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return ts('Personal Campaign Page'); @@ -378,7 +382,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/pcp'; diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index ca226f7f81..c095e3b355 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -130,7 +130,8 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * @param array $returnProperties * If you want to return specific fields. * - * @return array associated array of field values + * @return array + * associated array of field values * @static */ public static function &getValues(&$params, &$values, $returnProperties = NULL) { @@ -451,7 +452,8 @@ GROUP BY currency * @param int $honorId * In Honor of Contact ID. * - * @return array return the list of pledge fields + * @return array + * return the list of pledge fields * * @static */ @@ -498,7 +500,8 @@ GROUP BY currency * @param array $params * An assoc array of name/value pairs. * - * @return void. + * @return void + * */ public static function sendAcknowledgment(&$form, $params) { //handle Acknowledgment. @@ -691,7 +694,8 @@ GROUP BY currency /** * Combine all the exportable fields from the lower levels object * - * @return array array of exportable Fields + * @return array + * array of exportable Fields * @static */ public static function &exportableFields() { @@ -758,7 +762,8 @@ GROUP BY currency * @param int $contactID * Contact id. * - * @return array associated array of pledge id(s) + * @return array + * associated array of pledge id(s) * @static */ public static function getContactPledges($contactID) { @@ -802,7 +807,8 @@ GROUP BY currency * * @param int $contactID * - * @return int count of pledge records + * @return int + * count of pledge records * @static */ public static function getContactPledgeCount($contactID) { @@ -1066,7 +1072,8 @@ SELECT pledge.contact_id as contact_id, * Find payments which can be safely canceled. * * @param int $pledgeID - * @return array of int (civicrm_pledge_payment.id) + * @return array + * of int (civicrm_pledge_payment.id) */ public static function findCancelablePayments($pledgeID) { $statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus()); @@ -1093,7 +1100,8 @@ SELECT pledge.contact_id as contact_id, * * @param int $pledgeID * @param int $pledgeStatusID - * @return bool do financial transactions exist for this pledge? + * @return bool + * do financial transactions exist for this pledge? */ public static function pledgeHasFinancialTransactions($pledgeID, $pledgeStatusID) { if (empty($pledgeStatusID)) { @@ -1113,7 +1121,8 @@ SELECT pledge.contact_id as contact_id, * @param int $statusID * Pledge status id. * - * @return bool is it a transactional status? + * @return bool + * is it a transactional status? */ protected static function isTransactedStatus($statusID) { if (!in_array($statusID, self::getNonTransactionalStatus())) { @@ -1124,7 +1133,8 @@ SELECT pledge.contact_id as contact_id, /** * Get array of non transactional statuses - * @return array non transactional status ids + * @return array + * non transactional status ids */ protected static function getNonTransactionalStatus() { $paymentStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); @@ -1133,7 +1143,8 @@ SELECT pledge.contact_id as contact_id, /** * Get array of non transactional statuses - * @return array non transactional status ids + * @return array + * non transactional status ids */ protected static function getTransactionalStatus() { $paymentStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 97f3bb9177..a591549ed9 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -47,7 +47,8 @@ class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment { * @param int $pledgeId * Pledge id. * - * @return array associated array of pledge payment details + * @return array + * associated array of pledge payment details * @static */ public static function getPledgePayments($pledgeId) { @@ -229,7 +230,8 @@ WHERE pledge_id = %1 * * @param int $id * - * @return int pledge payment id + * @return int + * pledge payment id * @static */ public static function del($id) { @@ -341,7 +343,8 @@ WHERE pledge_id = %1 * @param bool $isScriptUpdate * , is function being called from bin script?. * - * @return int $newStatus, updated status id (or 0) + * @return int + * $newStatus, updated status id (or 0) */ static function updatePledgePaymentStatus( $pledgeID, @@ -516,7 +519,8 @@ WHERE civicrm_pledge.id = %2 * * @param array $params * - * @return array $newdate Next scheduled date as an array + * @return array + * Next scheduled date as an array * @static */ public static function calculateBaseScheduleDate(&$params) { @@ -582,7 +586,8 @@ WHERE civicrm_pledge.id = %2 * @param int $pledgeId * Pledge id. * - * @return int $statusId calculated status id of pledge + * @return int + * $statusId calculated status id of pledge * @static */ public static function calculatePledgeStatus($pledgeId) { @@ -694,7 +699,8 @@ WHERE civicrm_pledge_payment.id = {$paymentId} * * @param int $limit * - * @return array associated array of pledge details + * @return array + * associated array of pledge details * @static */ public static function getOldestPledgePayment($pledgeID, $limit = 1) { diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index 2aacb4cacf..852234ae08 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -314,7 +314,8 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php index 45a8fdde89..d8811484b4 100644 --- a/CRM/Pledge/Info.php +++ b/CRM/Pledge/Info.php @@ -45,7 +45,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array collection of required component settings + * @return array + * collection of required component settings */ public function getInfo() { return array( diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index 0c2000c353..c061f1b3b3 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -257,7 +257,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, @@ -282,7 +283,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery($offset, $rowCount, $sort, @@ -366,7 +368,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { } /** - * @return array $qill which contains an array of strings + * @return array + * which contains an array of strings */ // the current internationalisation is bad, but should more or less work @@ -384,7 +387,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -459,7 +463,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('Pledge Search'); diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index 1573b176e9..09b120d805 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -79,7 +79,8 @@ class CRM_Pledge_StateMachine_Search extends CRM_Core_StateMachine { * * @param string $formName * - * @return string the name of the form that will handle the task + * @return string + * the name of the form that will handle the task */ public function taskName($controller, $formName = 'Search') { // total hack, check POST vars and then session to determine stuff diff --git a/CRM/Pledge/Task.php b/CRM/Pledge/Task.php index 5c92bbf409..c6e7b31fab 100644 --- a/CRM/Pledge/Task.php +++ b/CRM/Pledge/Task.php @@ -61,7 +61,8 @@ class CRM_Pledge_Task { * These tasks are the core set of tasks that the user can perform * on a contact / group of contacts * - * @return array the set of tasks for a group of contacts + * @return array + * the set of tasks for a group of contacts * @static */ public static function &tasks() { @@ -100,7 +101,8 @@ class CRM_Pledge_Task { /** * These tasks are the core set of task titles * - * @return array the set of task titles + * @return array + * the set of task titles * @static */ public static function &taskTitles() { @@ -115,7 +117,8 @@ class CRM_Pledge_Task { /** * These tasks get added based on the context the user is in * - * @return array the set of optional tasks for a group of contacts + * @return array + * the set of optional tasks for a group of contacts * @static */ public static function &optionalTaskTitle() { @@ -129,7 +132,8 @@ class CRM_Pledge_Task { * * @param int $permission * - * @return array set of tasks that are valid for the user + * @return array + * set of tasks that are valid for the user */ public static function &permissionedTaskTitles($permission) { $tasks = array(); @@ -156,7 +160,8 @@ class CRM_Pledge_Task { * * @param int $value * - * @return array the set of tasks for a group of pledge holders + * @return array + * the set of tasks for a group of pledge holders * @static */ public static function getTask($value) { diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index b50072f14a..91bdf54c39 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -152,7 +152,8 @@ AND li.entity_id = {$entityId} * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even * when we don't want it's entity-id magix * - * @return array of line items + * @return array + * of line items */ public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL, $isQtyZero = TRUE, $relatedEntity = FALSE, $overrideWhereClause = '') { $whereClause = $fromClause = NULL; diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index 032b8d3997..de0c471419 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -192,7 +192,8 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -213,7 +214,8 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param int $id * Id of field. * - * @return string name + * @return string + * name * * @static * @@ -566,7 +568,8 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param bool $reset * Ignore stored values\. * - * @return array array of options + * @return array + * array of options */ public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE) { static $options = array(); @@ -779,7 +782,8 @@ WHERE id IN (" . implode(',', array_keys($priceFields)) . ')'; * @param string $displayOpt * Tax display setting option. * - * @return string $label tax label for custom field + * @return string + * tax label for custom field * * @static * diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 067b04517c..0c933dd741 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -151,7 +151,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * For order by, default weight. * @param bool|int $isActive is_active, default false * - * @return array $values + * @return array * * @static */ @@ -177,7 +177,8 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param int $id * Id of field option. * - * @return string name + * @return string + * name * * @static * @@ -194,7 +195,8 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 510a4763e9..e5f96fe684 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -102,7 +102,8 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { * * @internal param bool $is_active value we want to set the is_active field * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $isActive) { @@ -115,7 +116,8 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { * * @param string $entity * - * @return array $defaultPriceSet default price set + * @return array + * default price set * * @static * @@ -161,7 +163,8 @@ WHERE ps.name = '{$entityName}' * @param int $id * Id of price set. * - * @return string title + * @return string + * title * * @static * @@ -284,7 +287,8 @@ WHERE ct.id = cp.financial_type_id AND * @param int $id * Price Set id. * - * @return boolean false if fields exist for this set, true if the + * @return boolean + * false if fields exist for this set, true if the * set could be deleted * * @static @@ -441,7 +445,8 @@ WHERE ct.id = cp.financial_type_id AND * Whether or not to include inactive entries. * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute' * - * @return array associative array of id => name + * @return array + * associative array of id => name */ public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) { $query = ' @@ -489,7 +494,8 @@ WHERE ct.id = cp.financial_type_id AND * * @internal param int $setId - price set id whose details are needed * - * @return array $setTree - array consisting of field details + * @return array + * array consisting of field details */ public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) { // create a new tree @@ -1010,7 +1016,7 @@ WHERE id = %1"; * @param CRM_Core_Form $form * @param $defaults * - * @return array $defaults + * @return array */ public static function setDefaultPriceSet(&$form, &$defaults) { if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) { @@ -1082,7 +1088,8 @@ WHERE id = %1"; * @param int $id * Price Set id. * - * @return array of the field ids + * @return array + * of the field ids * * @static */ @@ -1232,7 +1239,8 @@ GROUP BY mt.member_of_contact_id"; * @param int $priceSetId * Price set id. * - * @return int $autoRenewOption ( 0:hide, 1:optional 2:required ) + * @return int + * $autoRenewOption ( 0:hide, 1:optional 2:required ) */ public static function checkAutoRenewForPriceSet($priceSetId) { // auto-renew option should be visible if membership types associated with all the fields has @@ -1280,7 +1288,8 @@ GROUP BY mt.member_of_contact_id"; * @param int $priceSetId * Price set id. * - * @return array associate array of frequency interval and unit + * @return array + * associate array of frequency interval and unit * @static */ public static function getRecurDetails($priceSetId) { @@ -1314,7 +1323,8 @@ GROUP BY mt.member_of_contact_id"; * @param bool $isQuickConfigValue we want to set the is_quick_config field. * Value we want to set the is_quick_config field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsQuickConfig($id, $isQuickConfig) { diff --git a/CRM/Price/Form/Field.php b/CRM/Price/Form/Field.php index c9286ec92d..421d9985ad 100644 --- a/CRM/Price/Form/Field.php +++ b/CRM/Price/Form/Field.php @@ -100,7 +100,8 @@ class CRM_Price_Form_Field extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array(); @@ -390,7 +391,8 @@ class CRM_Price_Form_Field extends CRM_Core_Form { * @param $files * @param CRM_Core_Form $form * - * @return array if errors then list of errors to be posted back to the form, + * @return array + * if errors then list of errors to be posted back to the form, * true otherwise * @static */ diff --git a/CRM/Price/Form/Option.php b/CRM/Price/Form/Option.php index df05f6e7e6..bba1a6748e 100644 --- a/CRM/Price/Form/Option.php +++ b/CRM/Price/Form/Option.php @@ -75,7 +75,8 @@ class CRM_Price_Form_Option extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { if ($this->_action == CRM_Core_Action::DELETE) { @@ -274,7 +275,8 @@ class CRM_Price_Form_Option extends CRM_Core_Form { * @param $files * @param CRM_Core_Form $form * - * @return array if errors then list of errors to be posted back to the form, + * @return array + * if errors then list of errors to be posted back to the form, * true otherwise * @static */ diff --git a/CRM/Price/Form/Preview.php b/CRM/Price/Form/Preview.php index 89c202c74e..dffbba2d82 100644 --- a/CRM/Price/Form/Preview.php +++ b/CRM/Price/Form/Preview.php @@ -93,7 +93,8 @@ class CRM_Price_Form_Preview extends CRM_Core_Form { * * @param null * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index 5bcc4d664e..de01dfa6ba 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -238,7 +238,8 @@ class CRM_Price_Form_Set extends CRM_Core_Form { * * @param null * - * @return array array of default values + * @return array + * array of default values */ public function setDefaultValues() { $defaults = array('is_active' => TRUE); diff --git a/CRM/Price/Page/Field.php b/CRM/Price/Page/Field.php index cc3e045631..c87e338c3c 100644 --- a/CRM/Price/Page/Field.php +++ b/CRM/Price/Page/Field.php @@ -71,7 +71,8 @@ class CRM_Price_Page_Field extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ function &actionLinks() { if (!isset(self::$_actionLinks)) { diff --git a/CRM/Price/Page/Option.php b/CRM/Price/Page/Option.php index a4da057bf9..79be0c9ffb 100644 --- a/CRM/Price/Page/Option.php +++ b/CRM/Price/Page/Option.php @@ -78,7 +78,8 @@ class CRM_Price_Page_Option extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ function &actionLinks() { if (!isset(self::$_actionLinks)) { diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index dc6cf216a7..99fb264c4b 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -55,7 +55,8 @@ class CRM_Price_Page_Set extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array + * array of action links that we need to display for the browse screen */ function &actionLinks() { // check if variable _actionsLinks is populated diff --git a/CRM/Profile/Form/Edit.php b/CRM/Profile/Form/Edit.php index 043d3369cf..43f721b309 100644 --- a/CRM/Profile/Form/Edit.php +++ b/CRM/Profile/Form/Edit.php @@ -313,7 +313,8 @@ SELECT module,is_reserved * This is a first version and will be tweaked over a period of time * * - * @return boolean true if no error found + * @return boolean + * true if no error found */ public function validate() { $errors = parent::validate(); diff --git a/CRM/Profile/Form/Search.php b/CRM/Profile/Form/Search.php index f89d2e173d..772e579d47 100644 --- a/CRM/Profile/Form/Search.php +++ b/CRM/Profile/Form/Search.php @@ -61,7 +61,8 @@ class CRM_Profile_Form_Search extends CRM_Profile_Form { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Profile/Page/Dynamic.php b/CRM/Profile/Page/Dynamic.php index 90d10a41e5..d37a3a266e 100644 --- a/CRM/Profile/Page/Dynamic.php +++ b/CRM/Profile/Page/Dynamic.php @@ -165,7 +165,7 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { /** * Get the action links for this page. * - * @return array $_actionLinks + * @return array * */ public function &actionLinks() { diff --git a/CRM/Profile/Page/MultipleRecordFieldsListing.php b/CRM/Profile/Page/MultipleRecordFieldsListing.php index f06e64eeec..4ad7933086 100644 --- a/CRM/Profile/Page/MultipleRecordFieldsListing.php +++ b/CRM/Profile/Page/MultipleRecordFieldsListing.php @@ -57,7 +57,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return ''; @@ -66,7 +67,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links[$this->_pageViewType])) { @@ -407,7 +409,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string classname of edit form + * @return string + * classname of edit form */ public function editForm() { return ''; @@ -416,7 +419,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page + * @return string + * name of this page */ public function editName() { return ''; @@ -427,7 +431,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context + * @return string + * user context */ public function userContext($mode = NULL) { return ''; diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index e9025d246c..26f81509f8 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -297,7 +297,8 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * @param enum $output * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { static $skipFields = array('group', 'tag'); @@ -387,7 +388,8 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { $additionalWhereClause = 'contact_a.is_deleted = 0'; @@ -437,7 +439,8 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * @param enum $output * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $extraWhereClause = NULL) { @@ -725,7 +728,8 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * @param string $output * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviCRM Profile Listings'); diff --git a/CRM/Queue/BAO/QueueItem.php b/CRM/Queue/BAO/QueueItem.php index 7913e49a94..3e7867a360 100644 --- a/CRM/Queue/BAO/QueueItem.php +++ b/CRM/Queue/BAO/QueueItem.php @@ -43,7 +43,8 @@ class CRM_Queue_BAO_QueueItem extends CRM_Queue_DAO_QueueItem { /** * Ensure that the required SQL table exists * - * @return bool TRUE if table now exists + * @return bool + * TRUE if table now exists */ public static function findCreateTable() { $checkTableSql = "show tables like 'civicrm_queue_item'"; diff --git a/CRM/Queue/Queue.php b/CRM/Queue/Queue.php index d6a0dd15f0..0fe31594a6 100644 --- a/CRM/Queue/Queue.php +++ b/CRM/Queue/Queue.php @@ -114,7 +114,8 @@ abstract class CRM_Queue_Queue { * @param int $lease_time * Seconds. * - * @return object with key 'data' that matches the inputted data + * @return object + * with key 'data' that matches the inputted data */ public abstract function claimItem($lease_time = 3600); @@ -124,7 +125,8 @@ abstract class CRM_Queue_Queue { * @param int $lease_time * Seconds. * - * @return object with key 'data' that matches the inputted data + * @return object + * with key 'data' that matches the inputted data */ public abstract function stealItem($lease_time = 3600); diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php index fdbab12619..e5fb62841a 100644 --- a/CRM/Report/BAO/Hook.php +++ b/CRM/Report/BAO/Hook.php @@ -62,7 +62,8 @@ class CRM_Report_BAO_Hook { /** * Get or build the list of search objects (via hook) * - * @return array of CRM_Report_BAO_Hook_Interface objects + * @return array + * of CRM_Report_BAO_Hook_Interface objects */ public function getSearchQueryObjects() { if ($this->_queryObjects === NULL) { diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 374f1cbc50..1d58bad427 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -859,7 +859,7 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Getter for $_defaultValues - * @return array $_defaultValues + * @return array */ public function getDefaultValues() { return $this->_defaults; @@ -3546,7 +3546,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause * (building the array if it's unset) * - * @return Array $this->_selectedTables + * @return Array + * >_selectedTables */ public function selectedTables() { if (!$this->_selectedTables) { @@ -3609,7 +3610,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * @param bool $filters * @param array $defaults * - * @return array address fields for construct clause + * @return array + * address fields for construct clause */ public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) { $addressFields = array( @@ -3881,7 +3883,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * - prefix Prefix to add to table (in case of more than one instance of the table) * - prefix_label Label to give columns from this phone table instance * - * @return array phone columns definition + * @return array + * phone columns definition */ public function getPhoneColumns($options = array()) { $defaultOptions = array( @@ -3912,7 +3915,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * - prefix Prefix to add to table (in case of more than one instance of the table) * - prefix_label Label to give columns from this address table instance * - * @return array address columns definition + * @return array + * address columns definition */ public function getAddressColumns($options = array()) { $options += array( diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php index f5e4eb2230..4237e76d58 100644 --- a/CRM/Report/Form/Activity.php +++ b/CRM/Report/Form/Activity.php @@ -298,7 +298,8 @@ class CRM_Report_Form_Activity extends CRM_Report_Form { } /** adding address fields with dbAlias for order clause - * @return array address fields + * @return array + * address fields */ public function addressFields($orderBy = FALSE) { $address = parent::addAddressFields(FALSE, TRUE); diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index 18578f611b..8bd288b192 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -706,7 +706,8 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { * - order_by enable these fields for order by * - filters enable these fields for filtering * - defaults - (is this working?) values to pre-populate - * @return array address fields for construct clause + * @return array + * address fields for construct clause */ /** * Get address columns to add to array @@ -715,7 +716,8 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { * - prefix Prefix to add to table (in case of more than one instance of the table) * - prefix_label Label to give columns from this address table instance * - * @return array address columns definition + * @return array + * address columns definition */ /** * @param array $options diff --git a/CRM/Report/Form/Register.php b/CRM/Report/Form/Register.php index 35b752328b..22f8c7a7cf 100644 --- a/CRM/Report/Form/Register.php +++ b/CRM/Report/Form/Register.php @@ -60,7 +60,8 @@ class CRM_Report_Form_Register extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php index 0c5f22ade7..d52b804699 100644 --- a/CRM/Report/Info.php +++ b/CRM/Report/Info.php @@ -46,7 +46,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array collection of required component settings + * @return array + * collection of required component settings * */ /** diff --git a/CRM/Report/Page/InstanceList.php b/CRM/Report/Page/InstanceList.php index 7b872697e5..5296a5fcdc 100644 --- a/CRM/Report/Page/InstanceList.php +++ b/CRM/Report/Page/InstanceList.php @@ -83,7 +83,7 @@ class CRM_Report_Page_InstanceList extends CRM_Core_Page { * Retrieves report instances, optionally filtered by parent report template ($ovID) * or by component ($compID) * - * @return array $rows + * @return array * @static */ public function &info() { diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php index 37dfde714d..5f4afa6981 100644 --- a/CRM/Report/Page/Options.php +++ b/CRM/Report/Page/Options.php @@ -105,7 +105,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_Core_BAO_OptionValue'; @@ -114,7 +115,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -184,7 +186,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_Report_Form_Register'; @@ -193,7 +196,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return self::$_GName; @@ -204,7 +208,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/report/options/' . self::$_gName; diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index 9009f4fab7..4d73153b09 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -363,7 +363,8 @@ WHERE inst.report_id = %1"; * * @param int $instanceId * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public static function isInstanceGroupRoleAllowed($instanceId) { @@ -465,7 +466,8 @@ WHERE inst.report_id = %1"; * @param array $params * All effective report criteria, as in CRM_Report_Form::_params. * - * @return string URL query string + * @return string + * URL query string */ public static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) { static $query_string; diff --git a/CRM/SMS/Form/Group.php b/CRM/SMS/Form/Group.php index d435e8ee95..a14f65b511 100644 --- a/CRM/SMS/Form/Group.php +++ b/CRM/SMS/Form/Group.php @@ -309,7 +309,8 @@ class CRM_SMS_Form_Group extends CRM_Contact_Form_Task { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/SMS/Form/Provider.php b/CRM/SMS/Form/Provider.php index 943363bdf7..7fc2c34dbf 100644 --- a/CRM/SMS/Form/Provider.php +++ b/CRM/SMS/Form/Provider.php @@ -126,7 +126,8 @@ class CRM_SMS_Form_Provider extends CRM_Core_Form { * * access public * - * @return array reference to the array of default values + * @return array + * reference to the array of default values * */ /** diff --git a/CRM/SMS/Form/Schedule.php b/CRM/SMS/Form/Schedule.php index 520f3d653a..b1e5bc3da7 100644 --- a/CRM/SMS/Form/Schedule.php +++ b/CRM/SMS/Form/Schedule.php @@ -120,7 +120,8 @@ class CRM_SMS_Form_Schedule extends CRM_Core_Form { * @param $files * @param $self * - * @return boolean True if either we deliver immediately, or the + * @return boolean + * True if either we deliver immediately, or the * date is properly set. * @static */ diff --git a/CRM/SMS/Page/Provider.php b/CRM/SMS/Page/Provider.php index f59bfa9a65..a3239c36e1 100644 --- a/CRM/SMS/Page/Provider.php +++ b/CRM/SMS/Page/Provider.php @@ -51,7 +51,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Get BAO Name * - * @return string Classname of BAO. + * @return string + * Classname of BAO. */ public function getBAOName() { return 'CRM_SMS_BAO_Provider'; @@ -60,7 +61,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Get action Links * - * @return array (reference) of action links + * @return array + * (reference) of action links */ public function &links() { if (!(self::$_links)) { @@ -162,7 +164,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Get name of edit form * - * @return string Classname of edit form. + * @return string + * Classname of edit form. */ public function editForm() { return 'CRM_SMS_Form_Provider'; @@ -171,7 +174,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { /** * Get edit form name * - * @return string name of this page. + * @return string + * name of this page. */ public function editName() { return 'SMS Provider'; @@ -182,7 +186,8 @@ class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { * * @param null $mode * - * @return string user context. + * @return string + * user context. */ public function userContext($mode = NULL) { return 'civicrm/admin/sms/provider'; diff --git a/CRM/UF/Form/AbstractPreview.php b/CRM/UF/Form/AbstractPreview.php index 62f5a52caf..4ac9b6093e 100644 --- a/CRM/UF/Form/AbstractPreview.php +++ b/CRM/UF/Form/AbstractPreview.php @@ -76,7 +76,8 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form { * Set the default form values * * - * @return array the default array reference + * @return array + * the default array reference */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index 2fa0f8286e..3ac65d89a5 100644 --- a/CRM/UF/Form/Field.php +++ b/CRM/UF/Form/Field.php @@ -617,7 +617,8 @@ class CRM_UF_Form_Field extends CRM_Core_Form { * * @param array $errors * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRuleSubType($fieldType, $groupType, $errors) { @@ -663,7 +664,8 @@ class CRM_UF_Form_Field extends CRM_Core_Form { * @param array $errors * Collect errors. * - * @return Array list of errors to be posted back to the form + * @return Array + * list of errors to be posted back to the form * @static */ public static function formRuleCustomDataExtentColumnValue($customField, $gid, $fieldType, &$errors) { @@ -751,7 +753,8 @@ class CRM_UF_Form_Field extends CRM_Core_Form { * @param $files * @param $self * - * @return array list of errors to be posted back to the form + * @return array + * list of errors to be posted back to the form * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php index 4f65ef5b37..8c68ef5825 100644 --- a/CRM/UF/Page/Field.php +++ b/CRM/UF/Page/Field.php @@ -62,7 +62,7 @@ class CRM_UF_Page_Field extends CRM_Core_Page { /** * Get the action links for this page. * - * @return array $_actionLinks + * @return array * */ function &actionLinks() { diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php index 5867d39433..7351b157a1 100644 --- a/CRM/UF/Page/Group.php +++ b/CRM/UF/Page/Group.php @@ -55,7 +55,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { * * @param * - * @return array $_actionLinks + * @return array * */ public function &actionLinks() { diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php index 73d6f3bf69..dec0300d42 100644 --- a/CRM/UF/Page/ProfileEditor.php +++ b/CRM/UF/Page/ProfileEditor.php @@ -189,7 +189,8 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page { * A string to use in section headers. * @param array $availableFields * List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type']. - * @return array with keys 'sections' and 'schema' + * @return array + * with keys 'sections' and 'schema' * @see js/model/crm.core.js * @see js/model/crm.mappedcore.js */ diff --git a/CRM/Upgrade/Incremental/php/FourFive.php b/CRM/Upgrade/Incremental/php/FourFive.php index 43b5f688a6..0426a7aa78 100644 --- a/CRM/Upgrade/Incremental/php/FourFive.php +++ b/CRM/Upgrade/Incremental/php/FourFive.php @@ -227,7 +227,8 @@ DROP KEY `{$dao->CONSTRAINT_NAME}`"; * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public static function addNameFieldOptions(CRM_Queue_TaskContext $ctx) { $query = "SELECT `value` FROM `civicrm_setting` WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'"; @@ -250,7 +251,8 @@ DROP KEY `{$dao->CONSTRAINT_NAME}`"; * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public static function migrateHonoreeInfo(CRM_Queue_TaskContext $ctx) { $query = "ALTER TABLE `civicrm_uf_join` diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index df9b09e049..c1c0d19bc3 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -516,7 +516,8 @@ AND image_URL IS NOT NULL * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public static function activityContacts(CRM_Queue_TaskContext $ctx) { $upgrade = new CRM_Upgrade_Form(); @@ -624,7 +625,8 @@ WHERE source_contact_id IS NOT NULL"; * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success * @see http://issues.civicrm.org/jira/browse/CRM-13187 */ public static function wordReplacements(CRM_Queue_TaskContext $ctx) { @@ -656,7 +658,8 @@ CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` ( * @param CRM_Queue_TaskContext $ctx * @param $rev * - * @return bool TRUE for success + * @return bool + * TRUE for success * @see http://issues.civicrm.org/jira/browse/CRM-13655 */ public static function wordReplacements_patch(CRM_Queue_TaskContext $ctx, $rev) { @@ -718,7 +721,8 @@ CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` ( * * @param bool $rebuildEach * Whether to perform rebuild after each individual API call. - * @return array Each item is $params for WordReplacement.create + * @return array + * Each item is $params for WordReplacement.create * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams */ public static function getConfigArraysAsAPIParams($rebuildEach) { @@ -814,7 +818,8 @@ CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` ( /** * @param array $params - * @return bool TRUE if $params is valid + * @return bool + * TRUE if $params is valid */ public static function isValidWordReplacement($params) { $result = strlen($params['find_word']) <= self::MAX_WORD_REPLACEMENT_SIZE && strlen($params['replace_word']) <= self::MAX_WORD_REPLACEMENT_SIZE; diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index 95df8d485b..9c249fe053 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -1223,7 +1223,8 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public function task_4_3_x_checkConstraints(CRM_Queue_TaskContext $ctx) { CRM_Core_DAO::executeQuery('ALTER TABLE `civicrm_financial_account` CHANGE `contact_id` `contact_id` INT( 10 ) UNSIGNED NULL DEFAULT NULL'); @@ -1283,7 +1284,8 @@ AND CONSTRAINT_SCHEMA = %1"; * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public function task_4_3_x_checkIndexes(CRM_Queue_TaskContext $ctx) { $query = " @@ -1308,7 +1310,8 @@ ADD INDEX UI_entity_financial_trxn_entity_id (entity_id); * * @param CRM_Queue_TaskContext $ctx * - * @return bool TRUE for success + * @return bool + * TRUE for success */ public static function phoneNumeric(CRM_Queue_TaskContext $ctx) { CRM_Core_DAO::executeQuery(CRM_Contact_BAO_Contact::DROP_STRIP_FUNCTION_43); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index a65e75dddd..753f2be29e 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -178,7 +178,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ @@ -192,7 +193,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param int $id * Id of field. * - * @return string name + * @return string + * name * * @static * @@ -473,7 +475,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param bool $reset * Ignore stored values\. * - * @return array array of options + * @return array + * array of options */ public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE) { static $options = array(); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index b08e10726e..86fec2dc85 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -138,7 +138,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * For order by, default weight. * @param bool|int $isActive is_active, default false * - * @return array $values + * @return array * * @static */ @@ -164,7 +164,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param int $id * Id of field option. * - * @return string name + * @return string + * name * * @static * @@ -181,7 +182,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * * @static */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index 9d696b190c..d69784240a 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -104,7 +104,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * * @param null $isQuick * - * @return array of line items + * @return array + * of line items */ public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) { $selectClause = $whereClause = $fromClause = NULL; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 879d37742f..1af5289936 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -87,7 +87,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ * @param bool $isActive * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsActive($id, $isActive) { @@ -139,7 +140,8 @@ WHERE ps.name = '{$entityName}' * @param int $id * Id of price set. * - * @return string title + * @return string + * title * * @static * @@ -256,7 +258,8 @@ WHERE ct.id = cp.contribution_type_id AND * @param int $id * Price Set id. * - * @return boolean false if fields exist for this set, true if the + * @return boolean + * false if fields exist for this set, true if the * set could be deleted * * @static @@ -413,7 +416,8 @@ WHERE ct.id = cp.contribution_type_id AND * Whether or not to include inactive entries. * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute' * - * @return array associative array of id => name + * @return array + * associative array of id => name */ public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) { $query = " @@ -460,7 +464,8 @@ WHERE ct.id = cp.contribution_type_id AND * @param bool $required * @param bool $validOnly * - * @return array $setTree - array consisting of field details + * @return array + * array consisting of field details */ public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) { // create a new tree @@ -875,7 +880,7 @@ WHERE id = %1"; * @param CRM_Core_Form $form * @param $defaults * - * @return array $defaults + * @return array */ static function setDefaultPriceSet(&$form, &$defaults) { if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) { @@ -902,7 +907,8 @@ WHERE id = %1"; * * @param int id Price Set id * - * @return array of the field ids + * @return array + * of the field ids * * @static */ @@ -1054,7 +1060,8 @@ GROUP BY mt.member_of_contact_id"; * @param int $priceSetId * Price set id. * - * @return int $autoRenewOption ( 0:hide, 1:optional 2:required ) + * @return int + * $autoRenewOption ( 0:hide, 1:optional 2:required ) */ public static function checkAutoRenewForPriceSet($priceSetId) { // auto-renew option should be visible if membership types associated with all the fields has @@ -1102,7 +1109,8 @@ GROUP BY mt.member_of_contact_id"; * @param int $priceSetId * Price set id. * - * @return array associate array of frequency interval and unit + * @return array + * associate array of frequency interval and unit * @static */ public static function getRecurDetails($priceSetId) { @@ -1136,7 +1144,8 @@ GROUP BY mt.member_of_contact_id"; * @param bool $isQuickConfigValue we want to set the is_quick_config field. * Value we want to set the is_quick_config field. * - * @return Object DAO object on sucess, null otherwise + * @return Object + * DAO object on sucess, null otherwise * @static */ public static function setIsQuickConfig($id, $isQuickConfig) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index 38a51720d6..a49246b212 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -396,7 +396,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO /** * returns an array containing the enum fields of the civicrm_price_field table * - * @return array (reference) the array of enum fields + * @return array + * (reference) the array of enum fields */ static function &getEnums() { @@ -413,7 +414,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO * @param string $value * The enum value up for translation. * - * @return string the display value of the enum + * @return string + * the display value of the enum */ public static function tsEnum($field, $value) { diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php index 8e658652e1..112f80a82d 100644 --- a/CRM/Utils/API/AbstractFieldCoder.php +++ b/CRM/Utils/API/AbstractFieldCoder.php @@ -51,7 +51,8 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper { /** * @param string $fldName - * @return bool TRUE if encoding should be skipped for this field + * @return bool + * TRUE if encoding should be skipped for this field */ public function isSkippedField($fldName) { $skipFields = $this->getSkipFields(); diff --git a/CRM/Utils/API/MatchOption.php b/CRM/Utils/API/MatchOption.php index cddeaba0b2..983f723634 100644 --- a/CRM/Utils/API/MatchOption.php +++ b/CRM/Utils/API/MatchOption.php @@ -139,7 +139,8 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { * @param array $createParams * @param array $keys * @param bool $isMandatory - * @return array revised $createParams, including 'id' if known + * @return array + * revised $createParams, including 'id' if known * @throws API_Exception */ public function match($entity, $createParams, $keys, $isMandatory) { @@ -176,7 +177,8 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { * @param array $keys * List of keys to match against. * - * @return array APIv3 $params + * @return array + * APIv3 $params */ public function createGetParams($origParams, $keys) { $params = array('version' => 3); diff --git a/CRM/Utils/Address.php b/CRM/Utils/Address.php index e9e954817e..3044c07445 100644 --- a/CRM/Utils/Address.php +++ b/CRM/Utils/Address.php @@ -51,7 +51,8 @@ class CRM_Utils_Address { * * @param null $tokenFields * - * @return string formatted address string + * @return string + * formatted address string * * @static */ diff --git a/CRM/Utils/Array.php b/CRM/Utils/Array.php index 2318351883..0c76eb7209 100644 --- a/CRM/Utils/Array.php +++ b/CRM/Utils/Array.php @@ -349,7 +349,8 @@ class CRM_Utils_Array { /** * @param $subset * @param $superset - * @return bool TRUE if $subset is a subset of $superset + * @return bool + * TRUE if $subset is a subset of $superset */ public static function isSubset($subset, $superset) { foreach ($subset as $expected) { diff --git a/CRM/Utils/Check.php b/CRM/Utils/Check.php index 0d91df745b..27addc2441 100644 --- a/CRM/Utils/Check.php +++ b/CRM/Utils/Check.php @@ -114,7 +114,8 @@ class CRM_Utils_Check { * We might even expose the results of these checks on the Wordpress * plugin status page or the Drupal admin/reports/status path. * - * @return array of messages + * @return array + * of messages * @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements */ public function checkAll() { diff --git a/CRM/Utils/Check/Security.php b/CRM/Utils/Check/Security.php index 14015d53f3..faf4942418 100644 --- a/CRM/Utils/Check/Security.php +++ b/CRM/Utils/Check/Security.php @@ -80,7 +80,8 @@ class CRM_Utils_Check_Security { * is browseable or visible to search engines; it means it can be * requested directly. * - * @return array of messages + * @return array + * of messages * @see CRM-14091 */ public function checkLogFileIsNotAccessible() { @@ -128,7 +129,8 @@ class CRM_Utils_Check_Security { * Being retrievable doesn't mean the files are browseable or visible * to search engines; it only means they can be requested directly. * - * @return array of messages + * @return array + * of messages * @see CRM-14091 * * @TODO: Test with WordPress, Joomla. @@ -173,7 +175,8 @@ class CRM_Utils_Check_Security { * MAY trigger false positives (if you have files named 'a', 'e' * we'll probably match that). * - * @return array of messages + * @return array + * of messages * @see CRM-14091 * * @TODO: Test with WordPress, Joomla. @@ -286,7 +289,8 @@ class CRM_Utils_Check_Security { * * @param string $targetDir * Local path to a directory. - * @return string a guessed URL for $realDir + * @return string + * a guessed URL for $realDir */ public function guessUrl($targetDir) { $filePathMarker = $this->getFilePathMarker(); diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index 4b258bf71d..80442aaa9b 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -47,7 +47,8 @@ class CRM_Utils_Date { * The seperator to use when formatting the date. * @param int|string $invalidDate what to return if the date is invalid * - * @return string - formatted string for date + * @return string + * formatted string for date * * @static */ @@ -168,7 +169,8 @@ class CRM_Utils_Date { /** * Return abbreviated weekday names according to the locale * - * @return array 0-based array with abbreviated weekday names + * @return array + * 0-based array with abbreviated weekday names * * @static */ @@ -189,7 +191,8 @@ class CRM_Utils_Date { /** * Return full weekday names according to the locale * - * @return array 0-based array with full weekday names + * @return array + * 0-based array with full weekday names * * @static */ @@ -212,7 +215,8 @@ class CRM_Utils_Date { * * @param bool $month * - * @return array 1-based array with abbreviated month names + * @return array + * 1-based array with abbreviated month names * * @static */ @@ -235,7 +239,8 @@ class CRM_Utils_Date { /** * Return full month names according to the locale * - * @return array 1-based array with full month names + * @return array + * 1-based array with full month names * * @static */ @@ -297,7 +302,8 @@ class CRM_Utils_Date { * @param array $dateParts * An array with the desired date parts. * - * @return string the $format-formatted $date + * @return string + * the $format-formatted $date * @static */ public static function customFormat($dateString, $format = NULL, $dateParts = NULL) { @@ -431,7 +437,8 @@ class CRM_Utils_Date { * @param string $mysql * Date/datetime in MySQL format. * - * @return string date/datetime in ISO format + * @return string + * date/datetime in ISO format * @static */ public static function mysqlToIso($mysql) { @@ -474,7 +481,8 @@ class CRM_Utils_Date { * @param string $iso * Date/datetime in ISO format. * - * @return string date/datetime in MySQL format + * @return string + * date/datetime in MySQL format * @static */ public static function isoToMysql($iso) { @@ -727,7 +735,8 @@ class CRM_Utils_Date { * Expected date format( default. * format is 2007-12-21 ) * - * @return string Return the customized todays date (Y-m-d) + * @return string + * Return the customized todays date (Y-m-d) * @static */ public static function getToday($dayParams = NULL, $format = "Y-m-d") { @@ -785,7 +794,8 @@ class CRM_Utils_Date { * @param $from * @param $to * - * @return array start date, end date + * @return array + * start date, end date * @static */ public static function getFromTo($relative, $from, $to) { @@ -809,7 +819,8 @@ class CRM_Utils_Date { * @param date $birthDate * Birth Date. * - * @return int array $results contains years or months + * @return int + * array $results contains years or months * @static */ static public function calculateAge($birthDate) { @@ -873,7 +884,8 @@ class CRM_Utils_Date { * * @param bool $dontCareTime * - * @return array $result contains new date with added interval + * @return array + * contains new date with added interval */ public static function intervalAdd($unit, $interval, $date, $dontCareTime = FALSE) { if (is_array($date)) { @@ -965,7 +977,8 @@ class CRM_Utils_Date { * @param int $unit * Frequency unit like year, month, week etc. * - * @return array $dateRange start date and end date for the relative time frame + * @return array + * start date and end date for the relative time frame * @static */ public static function relativeToAbsolute($relativeTerm, $unit) { @@ -1637,7 +1650,8 @@ class CRM_Utils_Date { * @param int $fyMonth * Fiscal Start Month. * - * @return int $fy Current Fiscl Year + * @return int + * $fy Current Fiscl Year * @static */ public static function calculateFiscalYear($fyDate, $fyMonth) { @@ -1671,7 +1685,8 @@ class CRM_Utils_Date { * @param string $format * Expected return date format.( default is mysql ). * - * @return string $mysqlDate date format that is excepted by mysql + * @return string + * date format that is excepted by mysql */ public static function processDate($date, $time = NULL, $returnNullString = FALSE, $format = 'YmdHis') { $mysqlDate = NULL; @@ -1697,7 +1712,8 @@ class CRM_Utils_Date { * @param null $format * @param null $timeFormat * - * @return array $date and time + * @return array + * and time */ public static function setDateDefaults($mysqlDate = NULL, $formatType = NULL, $format = NULL, $timeFormat = NULL) { // if date is not passed assume it as today @@ -1764,7 +1780,7 @@ class CRM_Utils_Date { * @param string $formatType * Date name e.g. birth. * - * @return string $format + * @return string */ public static function getDateFormat($formatType = NULL) { $format = NULL; diff --git a/CRM/Utils/DeprecatedUtils.php b/CRM/Utils/DeprecatedUtils.php index 58331fe973..ebc41265ea 100644 --- a/CRM/Utils/DeprecatedUtils.php +++ b/CRM/Utils/DeprecatedUtils.php @@ -1121,7 +1121,8 @@ function _civicrm_api3_deprecated_add_formatted_location_blocks(&$values, &$para * * @param $params * - * @return array + * @return array + * */ function _civicrm_api3_deprecated_duplicate_formatted_contact($params) { $id = CRM_Utils_Array::value('id', $params); @@ -1303,7 +1304,8 @@ function _civicrm_api3_deprecated_participant_check_params($params, $checkDuplic * @param string $csType * Contact subtype if exists/passed. * - * @return null on success, error message otherwise + * @return null + * on success, error message otherwise */ function _civicrm_api3_deprecated_contact_check_custom_params($params, $csType = NULL) { empty($csType) ? $onlyParent = TRUE : $onlyParent = FALSE; @@ -1474,7 +1476,8 @@ function _civicrm_api3_deprecated_contact_check_params( * @param $result * @param int $activityTypeID * - * @return array $params + * @return array + * $params */ function _civicrm_api3_deprecated_activity_buildmailparams($result, $activityTypeID) { // get ready for collecting data about activity to be created diff --git a/CRM/Utils/File.php b/CRM/Utils/File.php index a9a5d63844..07c13ba8ef 100644 --- a/CRM/Utils/File.php +++ b/CRM/Utils/File.php @@ -44,7 +44,8 @@ class CRM_Utils_File { * @param string $name * Name of file. * - * @return boolean true if file is ascii + * @return boolean + * true if file is ascii */ public static function isAscii($name) { $fd = fopen($name, "r"); @@ -71,7 +72,8 @@ class CRM_Utils_File { * @param string $name * Name of file. * - * @return boolean true if file is html + * @return boolean + * true if file is html */ public static function isHtml($name) { $fd = fopen($name, "r"); @@ -203,7 +205,8 @@ class CRM_Utils_File { * @param string $name * Name of file. * - * @return boolean whether the file was recoded properly + * @return boolean + * whether the file was recoded properly */ public static function toUtf8($name) { static $config = NULL; @@ -347,7 +350,8 @@ class CRM_Utils_File { * @param string $name * Name of file. * - * @return boolean whether the file can be include()d or require()d + * @return boolean + * whether the file can be include()d or require()d */ public static function isIncludable($name) { $x = @fopen($name, 'r', TRUE); @@ -679,7 +683,8 @@ HTACCESS; * The new location of the directory. * @param bool $verbose * - * @return bool TRUE on success + * @return bool + * TRUE on success */ public static function replaceDir($fromDir, $toDir, $verbose = FALSE) { if (is_dir($toDir)) { diff --git a/CRM/Utils/Geocode/Google.php b/CRM/Utils/Geocode/Google.php index 066905dc1f..2b33e63cc3 100644 --- a/CRM/Utils/Geocode/Google.php +++ b/CRM/Utils/Geocode/Google.php @@ -62,7 +62,8 @@ class CRM_Utils_Geocode_Google { * @param array $values * @param bool $stateName * - * @return boolean true if we modified the address, false otherwise + * @return boolean + * true if we modified the address, false otherwise * @static */ public static function format(&$values, $stateName = FALSE) { diff --git a/CRM/Utils/Geocode/Yahoo.php b/CRM/Utils/Geocode/Yahoo.php index 4d0ad97ed5..8f462a8604 100644 --- a/CRM/Utils/Geocode/Yahoo.php +++ b/CRM/Utils/Geocode/Yahoo.php @@ -65,7 +65,8 @@ class CRM_Utils_Geocode_Yahoo { * @param bool $stateName * This parameter currently has no function. * - * @return boolean true if we modified the address, false otherwise + * @return boolean + * true if we modified the address, false otherwise * @static */ public static function format(&$values, $stateName = FALSE) { diff --git a/CRM/Utils/GlobalStack.php b/CRM/Utils/GlobalStack.php index 571e2e919d..4d10fef21b 100644 --- a/CRM/Utils/GlobalStack.php +++ b/CRM/Utils/GlobalStack.php @@ -79,7 +79,8 @@ class CRM_Utils_GlobalStack { /** * @param array $new * The new, incoming frame. - * @return array frame + * @return array + * frame */ public function createBackup($new) { $frame = array(); diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 9437b9b14f..8eddda2c8c 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -272,7 +272,8 @@ abstract class CRM_Utils_Hook { * @param array $params * The parameters used for object creation / editing. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function pre($op, $objectName, $id, &$params) { $event = new \Civi\Core\Event\PreEvent($op, $objectName, $id, $params); @@ -322,7 +323,8 @@ abstract class CRM_Utils_Hook { * @param array $values * (optional) the values to fill the links. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) { return self::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links'); @@ -336,7 +338,8 @@ abstract class CRM_Utils_Hook { * @param CRM_Core_Form $form * Reference to the form object. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function preProcess($formName, &$form) { return self::singleton() @@ -352,7 +355,8 @@ abstract class CRM_Utils_Hook { * @param CRM_Core_Form $form * Reference to the form object. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function buildForm($formName, &$form) { return self::singleton()->invoke(2, $formName, $form, @@ -370,7 +374,8 @@ abstract class CRM_Utils_Hook { * @param CRM_Core_Form $form * Reference to the form object. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function postProcess($formName, &$form) { return self::singleton()->invoke(2, $formName, $form, @@ -428,7 +433,8 @@ abstract class CRM_Utils_Hook { * @param array $params * The parameters that were sent into the calling function. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function custom($op, $groupID, $entityID, &$params) { return self::singleton() @@ -450,7 +456,8 @@ abstract class CRM_Utils_Hook { * @param string $where * The currrent where clause. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) { return self::singleton() @@ -472,7 +479,8 @@ abstract class CRM_Utils_Hook { * @param array $currentGroups * The set of objects that are currently permissioned for this contact. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) { return self::singleton() @@ -485,7 +493,8 @@ abstract class CRM_Utils_Hook { * @param array $files * The current set of files to process. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function xmlMenu(&$files) { return self::singleton()->invoke(1, $files, @@ -500,7 +509,8 @@ abstract class CRM_Utils_Hook { * @param array $entities * List of pending entities. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function managed(&$entities) { return self::singleton()->invoke(1, $entities, @@ -518,7 +528,8 @@ abstract class CRM_Utils_Hook { * (output parameter) where should the hook content be displayed. * relative to the activity list * - * @return string the html snippet to include in the dashboard + * @return string + * the html snippet to include in the dashboard */ public static function dashboard($contactID, &$contentPlacement = self::DASHBOARD_BELOW) { $retval = self::singleton()->invoke(2, $contactID, $contentPlacement, @@ -973,7 +984,8 @@ abstract class CRM_Utils_Hook { * @param int $caseID * The case ID. * - * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's) + * @return array + * of data to be displayed, where the key is a unique id to be used for styling (div id's) * and the value is an array with keys 'label' and 'value' specifying label/value pairs */ public static function caseSummary($caseID) { @@ -1248,7 +1260,8 @@ abstract class CRM_Utils_Hook { * * @internal param array $seletor the selector object. Allows you access to the context of the search * - * @return void modify the header and values object to pass the data u need + * @return void + * modify the header and values object to pass the data u need */ public static function searchColumns($objectName, &$headers, &$rows, &$selector) { return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector, @@ -1703,7 +1716,8 @@ abstract class CRM_Utils_Hook { * @param array $participant * Array of participant values. * - * @return null the return value is ignored + * @return null + * the return value is ignored */ public static function alterBadge($labelName, &$label, &$format, &$participant) { return self::singleton() @@ -1832,7 +1846,8 @@ abstract class CRM_Utils_Hook { * * @param array $angularModules * List of modules. - * @return null the return value is ignored + * @return null + * the return value is ignored * * @code * function mymod_civicrm_angularModules(&$angularModules) { diff --git a/CRM/Utils/HttpClient.php b/CRM/Utils/HttpClient.php index 59c56eb810..29b27a9ea7 100644 --- a/CRM/Utils/HttpClient.php +++ b/CRM/Utils/HttpClient.php @@ -118,7 +118,8 @@ class CRM_Utils_HttpClient { * * @param string $remoteFile * URL of remote file. - * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) + * @return array + * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) */ public function get($remoteFile) { // Download extension zip file ... @@ -157,7 +158,8 @@ class CRM_Utils_HttpClient { * URL of a .zip file. * @param array $params * - * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) + * @return array + * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) */ public function post($remoteFile, $params) { // Download extension zip file ... @@ -190,7 +192,8 @@ class CRM_Utils_HttpClient { /** * @param string $remoteFile - * @return array (0 => resource, 1 => CA_Config_Curl) + * @return array + * (0 => resource, 1 => CA_Config_Curl) */ protected function createCurl($remoteFile) { require_once 'CA/Config/Curl.php'; diff --git a/CRM/Utils/JS.php b/CRM/Utils/JS.php index 389e8bc486..3183d519b0 100644 --- a/CRM/Utils/JS.php +++ b/CRM/Utils/JS.php @@ -40,7 +40,8 @@ class CRM_Utils_JS { * * @param string $jsCode * Raw Javascript code. - * @return array of translatable strings + * @return array + * of translatable strings */ public static function parseStrings($jsCode) { $strings = array(); diff --git a/CRM/Utils/JSON.php b/CRM/Utils/JSON.php index 79adc942b5..c70e40d1fa 100644 --- a/CRM/Utils/JSON.php +++ b/CRM/Utils/JSON.php @@ -58,7 +58,8 @@ class CRM_Utils_JSON { * @param string $identifier * Identifier for the JSON array. * - * @return string $jsonObject JSON array + * @return string + * JSON array * @static */ public static function encode($params, $identifier = 'id') { diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php index eb6b49db56..b059c3b021 100644 --- a/CRM/Utils/Mail.php +++ b/CRM/Utils/Mail.php @@ -56,7 +56,8 @@ class CRM_Utils_Mail { * (by reference). * * - * @return boolean true if a mail was sent, else false + * @return boolean + * true if a mail was sent, else false */ public static function send(&$params) { $returnPath = CRM_Core_BAO_MailSettings::defaultReturnPath(); @@ -257,7 +258,8 @@ class CRM_Utils_Mail { * @param string $header * The full name + email address string. * - * @return string the plucked email address + * @return string + * the plucked email address * @static */ public static function pluckEmailFromHeader($header) { @@ -272,7 +274,8 @@ class CRM_Utils_Mail { /** * Get the Active outBound email * - * @return boolean true if valid outBound email configuration found, false otherwise + * @return boolean + * true if valid outBound email configuration found, false otherwise * @static */ public static function validOutBoundMail() { @@ -393,7 +396,7 @@ class CRM_Utils_Mail { * @param string $html * @param string $format * - * @return array $attachments + * @return array */ public static function appendPDF($fileName, $html, $format = NULL) { $pdf_filename = CRM_Core_Config::singleton()->templateCompileDir . CRM_Utils_File::makeFileName($fileName); diff --git a/CRM/Utils/Mail/EmailProcessor.php b/CRM/Utils/Mail/EmailProcessor.php index ef11c256cb..0be9b28051 100644 --- a/CRM/Utils/Mail/EmailProcessor.php +++ b/CRM/Utils/Mail/EmailProcessor.php @@ -46,7 +46,8 @@ class CRM_Utils_Mail_EmailProcessor { /** * Process the default mailbox (ie. that is used by civiMail for the bounce) * - * @return boolean always returns true (for the api). at a later stage we should + * @return boolean + * always returns true (for the api). at a later stage we should * fix this to return true on success / false on failure etc */ public static function processBounces() { diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index dbb1965dcc..a186d556eb 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -361,7 +361,8 @@ class CRM_Utils_Migrate_Export { /** * Render the in-memory representation as XML * - * @return string XML + * @return string + * XML */ public function toXML() { $buffer = ''; @@ -435,7 +436,8 @@ class CRM_Utils_Migrate_Export { * Each item is an array(0 => MappedEntityname, 1 => InputFieldName (id-field), 2 => OutputFieldName (name-field), 3 => OptionalPrefix). * @param CRM_Core_DAO $dao * The entity for which we want to prepare mapped fields. - * @return array new fields + * @return array + * new fields */ public function computeMappedFields($mappedFields, $dao) { $keyValues = array(); @@ -541,7 +543,8 @@ class CRM_Utils_Migrate_Export { * @param string $tagName * @param array $keyValues * @throws Exception - * @return string XML + * @return string + * XML */ public function renderKeyValueXML($tagName, $keyValues) { $xml = " <$tagName>"; @@ -560,7 +563,8 @@ class CRM_Utils_Migrate_Export { * @param string $prefix * * @throws Exception - * @return string XML + * @return string + * XML */ public function renderTextTag($name, $value, $prefix = '') { if (!preg_match('/^[a-zA-Z0-9\_]+$/', $name)) { diff --git a/CRM/Utils/Money.php b/CRM/Utils/Money.php index 01a63fdcba..03e7aa813d 100644 --- a/CRM/Utils/Money.php +++ b/CRM/Utils/Money.php @@ -59,7 +59,8 @@ class CRM_Utils_Money { * @param string $valueFormat * The desired monetary value display format (e.g. '%!i'). * - * @return string formatted monetary string + * @return string + * formatted monetary string * * @static */ diff --git a/CRM/Utils/Network.php b/CRM/Utils/Network.php index 791816d1a5..f7999318c8 100644 --- a/CRM/Utils/Network.php +++ b/CRM/Utils/Network.php @@ -47,7 +47,8 @@ class CRM_Utils_Network { * @param float $interval * Seconds to wait in between pollings. * - * @return bool TRUE if service is online + * @return bool + * TRUE if service is online */ public static function waitForServiceStartup($host, $port, $serverStartupTimeOut, $interval = 0.333) { $start = time(); diff --git a/CRM/Utils/OpenFlashChart.php b/CRM/Utils/OpenFlashChart.php index dbeef70de5..6d6f87bdad 100644 --- a/CRM/Utils/OpenFlashChart.php +++ b/CRM/Utils/OpenFlashChart.php @@ -57,7 +57,8 @@ class CRM_Utils_OpenFlashChart { * @param array $params * Assoc array of name/value pairs. * - * @return object $chart object of open flash chart. + * @return object + * $chart object of open flash chart. * @static */ public static function &barChart(&$params) { @@ -187,7 +188,8 @@ class CRM_Utils_OpenFlashChart { * @param array $params * Assoc array of name/value pairs. * - * @return object $chart object of open flash chart. + * @return object + * $chart object of open flash chart. * @static */ public static function &pieChart(&$params) { @@ -251,7 +253,8 @@ class CRM_Utils_OpenFlashChart { * @param array $params * Assoc array of name/value pairs. * - * @return object $chart object of open flash chart. + * @return object + * $chart object of open flash chart. * @static */ public static function &bar_3dChart(&$params) { diff --git a/CRM/Utils/OptionBag.php b/CRM/Utils/OptionBag.php index bf78937323..e63aed86dc 100644 --- a/CRM/Utils/OptionBag.php +++ b/CRM/Utils/OptionBag.php @@ -62,7 +62,8 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { *

. * An offset to check for. *

- * @return boolean true on success or false on failure. + * @return boolean + * true on success or false on failure. *

*

* The return value will be casted to boolean if non-boolean was returned. @@ -132,7 +133,8 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { * (PHP 5 >= 5.1.0)
* Count elements of an object * @link http://php.net/manual/en/countable.count.php - * @return int The custom count as an integer. + * @return int + * The custom count as an integer. *

*

* The return value is cast to an integer. diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 79f8ad962f..4774a6b93e 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -195,7 +195,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * * @param array $params * - * @return int new pageId to display to the user + * @return int + * new pageId to display to the user */ public function getPageID($defaultPageId = 1, &$params) { // POST has higher priority than GET vars @@ -227,7 +228,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * @param int $defaultPageRowCount * The default value if not set. * - * @return int the rowCount value to use + * @return int + * the rowCount value to use * */ public function getPageRowCount($defaultPageRowCount = self::ROWCOUNT) { @@ -249,7 +251,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * * @param void * - * @return array: an array of the pageID and offset + * @return array + * an array of the pageID and offset * * */ diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php index f67e5c9036..7b81d6eb06 100644 --- a/CRM/Utils/PagerAToZ.php +++ b/CRM/Utils/PagerAToZ.php @@ -49,7 +49,8 @@ class CRM_Utils_PagerAToZ { * * @param bool $isDAO * - * @return string The html formatted string + * @return string + * The html formatted string * @static */ public static function getAToZBar(&$query, $sortByCharacter, $isDAO = FALSE) { @@ -60,7 +61,8 @@ class CRM_Utils_PagerAToZ { /** * Return the all the static characters * - * @return array $staticAlphabets is a array of static characters + * @return array + * is a array of static characters * @static */ public static function getStaticCharacters() { @@ -74,7 +76,8 @@ class CRM_Utils_PagerAToZ { * @param $query * @param $isDAO * - * @return array $dynamicAlphabets is a array of dynamic characters + * @return array + * is a array of dynamic characters * @static */ public static function getDynamicCharacters(&$query, $isDAO) { @@ -105,7 +108,8 @@ class CRM_Utils_PagerAToZ { * * @param $isDAO * - * @return array with links + * @return array + * with links * @static */ public static function createLinks(&$query, $sortByCharacter, $isDAO) { diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index f3cbe17590..48e1e50db9 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -55,7 +55,8 @@ class CRM_Utils_PseudoConstant { * * @param $constant * - * @return array - array reference of all relevant constant + * @return array + * array reference of all relevant constant */ public static function getConstant($constant) { $class = self::findConstantClass($constant); @@ -75,7 +76,8 @@ class CRM_Utils_PseudoConstant { * * @param $constant * - * @return array - array reference of all relevant constant + * @return array + * array reference of all relevant constant */ public static function flushConstant($constant) { $class = self::findConstantClass($constant); @@ -118,7 +120,8 @@ class CRM_Utils_PseudoConstant { * * This may be inefficient and should generally be avoided. * - * @return array of string, constant names + * @return array + * of string, constant names */ public static function findConstants() { if (self::$constants === NULL) { @@ -140,7 +143,8 @@ class CRM_Utils_PseudoConstant { * * @param $class * - * @return array of string, constant names + * @return array + * of string, constant names */ public static function findConstantsByClass($class) { $clazz = new ReflectionClass($class); diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php index f4e01c39dd..44def6eb96 100644 --- a/CRM/Utils/REST.php +++ b/CRM/Utils/REST.php @@ -64,7 +64,7 @@ class CRM_Utils_REST { * @param string $var * The string to be echoed. * - * @return string $var + * @return string */ public static function ping($var = NULL) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php index 59e803fb24..df74201a3a 100644 --- a/CRM/Utils/Recent.php +++ b/CRM/Utils/Recent.php @@ -73,7 +73,8 @@ class CRM_Utils_Recent { /** * Return the recently viewed array * - * @return array the recently viewed array + * @return array + * the recently viewed array * @static */ public static function &get() { diff --git a/CRM/Utils/Rule.php b/CRM/Utils/Rule.php index faf3f7e85a..0a409adea1 100644 --- a/CRM/Utils/Rule.php +++ b/CRM/Utils/Rule.php @@ -225,7 +225,8 @@ class CRM_Utils_Rule { * @param bool $monthRequired * Check whether month is mandatory. * - * @return bool true if valid date + * @return bool + * true if valid date * @static */ public static function currentDate($date, $monthRequired = TRUE) { @@ -316,7 +317,8 @@ class CRM_Utils_Rule { * * @param string $date * - * @return bool true if valid date + * @return bool + * true if valid date * @static */ public static function mysqlDate($date) { @@ -557,7 +559,8 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool true if file has been uploaded, false otherwise + * @return bool + * true if file has been uploaded, false otherwise */ public static function asciiFile($elementValue) { if ((isset($elementValue['error']) && $elementValue['error'] == 0) || @@ -573,7 +576,8 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool whether file has been uploaded properly and is now in UTF-8 + * @return bool + * whether file has been uploaded properly and is now in UTF-8 */ public static function utf8File($elementValue) { $success = FALSE; @@ -602,7 +606,8 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool true if file has been uploaded, false otherwise + * @return bool + * true if file has been uploaded, false otherwise */ public static function htmlFile($elementValue) { if ((isset($elementValue['error']) && $elementValue['error'] == 0) || @@ -621,7 +626,8 @@ class CRM_Utils_Rule { * @param array $options * The daoName and fieldName (optional ). * - * @return boolean true if object exists + * @return boolean + * true if object exists * @static */ public static function objectExists($value, $options) { @@ -748,7 +754,8 @@ class CRM_Utils_Rule { * * @param array $date * - * @return bool true if valid date + * @return bool + * true if valid date * @static */ public static function qfDate($date) { diff --git a/CRM/Utils/SQL/Insert.php b/CRM/Utils/SQL/Insert.php index e734a1acde..afa8560aea 100644 --- a/CRM/Utils/SQL/Insert.php +++ b/CRM/Utils/SQL/Insert.php @@ -110,14 +110,16 @@ class CRM_Utils_SQL_Insert { /** * @param string|NULL $value - * @return string SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes) + * @return string + * SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes) */ protected function escapeString($value) { return $value === NULL ? 'NULL' : '"' . CRM_Core_DAO::escapeString($value) . '"'; } /** - * @return string SQL statement + * @return string + * SQL statement */ public function toSQL() { $columns = "`" . implode('`,`', $this->columns) . "`"; diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php index 2e0d82351f..b6db2df801 100644 --- a/CRM/Utils/SQL/Select.php +++ b/CRM/Utils/SQL/Select.php @@ -188,7 +188,8 @@ class CRM_Utils_SQL_Select { * PHP NULL's will be treated as SQL NULL's. The PHP string "null" will be treated as a string. * * @throws CRM_Core_Exception - * @return string SQL expression + * @return string + * SQL expression */ public function interpolate($expr, $args) { if ($args === NULL) { @@ -226,14 +227,16 @@ class CRM_Utils_SQL_Select { /** * @param string|NULL $value - * @return string SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes) + * @return string + * SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes) */ protected function escapeString($value) { return $value === NULL ? 'NULL' : '"' . CRM_Core_DAO::escapeString($value) . '"'; } /** - * @return string SQL statement + * @return string + * SQL statement */ public function toSQL() { if ($this->selects) { diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php index 92e7173dde..50bc968ab6 100644 --- a/CRM/Utils/SoapServer.php +++ b/CRM/Utils/SoapServer.php @@ -73,7 +73,7 @@ class CRM_Utils_SoapServer { * @param string $var * The string to be echoed. * - * @return string $var + * @return string */ public function ping($var) { $session = CRM_Core_Session::singleton(); @@ -123,7 +123,8 @@ class CRM_Utils_SoapServer { * @param bool $loadCMSBootstrap * * @throws SoapFault - * @return string The SOAP Client key + * @return string + * The SOAP Client key * @static */ public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) { diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index dfc53770b7..8701fcb55d 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -149,7 +149,8 @@ class CRM_Utils_Sort { /** * Function returns the string for the order by clause * - * @return string the order by clause + * @return string + * the order by clause */ public function orderBy() { if (empty($this->_vars[$this->_currentSortID])) { @@ -176,7 +177,8 @@ class CRM_Utils_Sort { * @param int $dir * The direction of the sort. * - * @return string the string to append to the url + * @return string + * the string to append to the url * @static */ public static function sortIDValue($index, $dir) { @@ -259,7 +261,8 @@ class CRM_Utils_Sort { /** * Getter for currentSortID * - * @return int returns of the current sort id + * @return int + * returns of the current sort id * @acccess public */ public function getCurrentSortID() { @@ -269,7 +272,8 @@ class CRM_Utils_Sort { /** * Getter for currentSortDirection * - * @return int returns of the current sort direction + * @return int + * returns of the current sort direction * @acccess public */ public function getCurrentSortDirection() { @@ -282,7 +286,8 @@ class CRM_Utils_Sort { * @param $a * @param $b * - * @return int (-1 or 1) + * @return int + * (-1 or 1) */ public static function cmpFunc($a, $b) { $cmp_order = array('weight', 'id', 'title', 'name'); diff --git a/CRM/Utils/String.php b/CRM/Utils/String.php index fcabb6b7d8..a86d859d27 100644 --- a/CRM/Utils/String.php +++ b/CRM/Utils/String.php @@ -83,7 +83,8 @@ class CRM_Utils_String { * Length of valid variables. * * - * @return string returns the manipulated string + * @return string + * returns the manipulated string * @static */ public static function munge($name, $char = '_', $len = 63) { @@ -107,7 +108,8 @@ class CRM_Utils_String { * membership_payment returns MembershipPayment * @param string $string * - * @return string string + * @return string + * string */ public static function convertStringToCamel($string) { $fragments = explode('_', $string); @@ -130,7 +132,8 @@ class CRM_Utils_String { * @param int $len * Length of valid variables. * - * @return string Randomized Variable Name + * @return string + * Randomized Variable Name * @static */ public static function rename($name, $len = 4) { @@ -147,7 +150,8 @@ class CRM_Utils_String { * @param \char|string $char $char the character used to demarcate the componets * * - * @return string the last component + * @return string + * the last component * @static */ public static function getClassName($string, $char = '_') { @@ -210,7 +214,8 @@ class CRM_Utils_String { * @param bool $utf8 * Attempt utf8 match on failure (default yes). * - * @return boolean true if string is ascii + * @return boolean + * true if string is ascii * @static */ public static function isAscii($str, $utf8 = TRUE) { @@ -254,7 +259,8 @@ class CRM_Utils_String { * @param array $regexRules * Regular expression to be matched w/ replacements. * - * @return array $match array of strings w/ corresponding redacted outputs + * @return array + * array of strings w/ corresponding redacted outputs * @static */ public static function regex($str, $regexRules) { @@ -344,7 +350,8 @@ class CRM_Utils_String { * @param string $url2 * The second url to be matched against. * - * @return boolean true if the urls match, else false + * @return boolean + * true if the urls match, else false * @static */ public static function match($url1, $url2) { @@ -438,7 +445,8 @@ class CRM_Utils_String { * @param string $html * The string to be converted. * - * @return string the converted string + * @return string + * the converted string * @static */ public static function htmlToText($html) { @@ -530,7 +538,8 @@ class CRM_Utils_String { * @param string $full * All alternatives as a long string (or some other text). * - * @return string only the first alternative found (or the text without alternatives) + * @return string + * only the first alternative found (or the text without alternatives) */ public static function stripAlternatives($full) { $matches = array(); @@ -553,7 +562,8 @@ class CRM_Utils_String { * @param string $string * Input string to be cleaned. * - * @return string the cleaned string + * @return string + * the cleaned string * @static */ public static function stripSpaces($string) { @@ -571,7 +581,8 @@ class CRM_Utils_String { * @param string $replace * The character to replace it with. * - * @return string the sanitized string + * @return string + * the sanitized string * @static */ static function stripPathChars( @@ -616,7 +627,8 @@ class CRM_Utils_String { * @param string $string * The input string. * - * @return string the cleaned up string + * @return string + * the cleaned up string * @static */ public static function purifyHTML($string) { @@ -678,7 +690,8 @@ class CRM_Utils_String { * E.g. "view all contacts". Syntax: "[prefix:]name". * @param null $defaultPrefix * - * @return array (0 => string|NULL $prefix, 1 => string $value) + * @return array + * (0 => string|NULL $prefix, 1 => string $value) */ public static function parsePrefix($delim, $string, $defaultPrefix = NULL) { $pos = strpos($string, $delim); @@ -700,7 +713,8 @@ class CRM_Utils_String { * @param int $percent * The percentage of the user portion to be masked. * - * @return string returns the masked Email address + * @return string + * returns the masked Email address */ public static function maskEmail($email, $maskChar = '*', $percent = 50) { list($user, $domain) = preg_split("/@/", $email); @@ -725,7 +739,8 @@ class CRM_Utils_String { * @param bool $case * Boolean indicating whether you want the comparison to be case sensitive or not. * - * @return boolean TRUE (string are identical); FALSE (strings are not identical) + * @return boolean + * TRUE (string are identical); FALSE (strings are not identical) */ public static function compareStr($strOne, $strTwo, $case) { if ($case == TRUE) { @@ -760,7 +775,8 @@ class CRM_Utils_String { * * @param string $url * URL with HTML entities. - * @return string URL without HTML entities + * @return string + * URL without HTML entities */ public static function unstupifyUrl($htmlUrl) { return str_replace('&', '&', $htmlUrl); diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 87d439dffa..a8ef90face 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -297,7 +297,8 @@ class CRM_Utils_System { /** * What menu path are we currently on. Called for the primary tpl * - * @return string the current menu path + * @return string + * the current menu path */ public static function currentPath() { $config = CRM_Core_Config::singleton(); @@ -310,7 +311,8 @@ class CRM_Utils_System { * @param array $params * List of parameters. * - * @return string url + * @return string + * url */ public static function crmURL($params) { $p = CRM_Utils_Array::value('p', $params); @@ -1248,7 +1250,8 @@ class CRM_Utils_System { /** * Returns wiki (alternate) documentation URL base. * - * @return string documentation url + * @return string + * documentation url */ public static function getWikiBaseURL() { // FIXME: move this to configuration at some stage @@ -1626,7 +1629,8 @@ class CRM_Utils_System { * * @param string $url * - * @return string $url, clean url + * @return string + * , clean url */ public static function cleanUrl($url) { if (!$url) { @@ -1648,7 +1652,8 @@ class CRM_Utils_System { * @param bool $addLanguagePart * @param bool $removeLanguagePart * - * @return string $url, formatted url. + * @return string + * , formatted url. */ static function languageNegotiationURL( $url, diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index f06d6c3732..e6833116bf 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -167,7 +167,8 @@ abstract class CRM_Utils_System_Base { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public abstract function getLoginURL($destination = ''); @@ -312,7 +313,8 @@ abstract class CRM_Utils_System_Base { /** * Get currently logged in user uf id. * - * @return int $userID logged in user uf id. + * @return int + * $userID logged in user uf id. */ public function getLoggedInUfID() { } @@ -320,7 +322,8 @@ abstract class CRM_Utils_System_Base { /** * Get currently logged in user unique identifier - this tends to be the email address or user name. * - * @return string $userID logged in user unique identifier + * @return string + * logged in user unique identifier */ public function getLoggedInUniqueIdentifier() { } @@ -334,7 +337,8 @@ abstract class CRM_Utils_System_Base { * Note there is already a function getUFId which takes $username as a param - we could add $user * as a second param to it but it seems messy - just overloading it because the name is taken * @param object $user - * @return int $ufid - user ID of UF System + * @return int + * $ufid - user ID of UF System */ public function getBestUFID($user = NULL) { if ($user) { @@ -350,7 +354,8 @@ abstract class CRM_Utils_System_Base { * the function * * @param object $user - * @return string $uniqueIdentifier - unique identifier from the UF System + * @return string + * unique identifier from the UF System */ public function getBestUFUniqueIdentifier($user = NULL) { if ($user) { diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 8797047bf5..fef504d6cb 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -184,7 +184,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * * @param CRM_Core_Form $form * Form object representing the 'current' form - to which the user will be returned. - * @return string $destination destination value for URL + * @return string + * destination value for URL * */ /** @@ -228,7 +229,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { @@ -328,7 +330,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScriptUrl($url, $region) { $params = array('group' => JS_LIBRARY, 'weight' => 10); @@ -357,7 +360,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScript($code, $region) { $params = array('type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10); @@ -384,7 +388,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyleUrl($url, $region) { if ($region != 'html-header') { @@ -407,7 +412,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyle($code, $region) { if ($region != 'html-header') { @@ -436,7 +442,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * @param mix $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form */ public function postURL($action) { if (!empty($action)) { @@ -625,7 +632,8 @@ AND u.status = 1 /** * Get the locale set in the hosting CMS * - * @return string with the locale or null for none + * @return string + * with the locale or null for none */ public function getUFLocale() { // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale @@ -820,7 +828,7 @@ AND u.status = 1 /** * Check is user logged in. * - * @return boolean true/false. + * @return boolean */ public function isUserLoggedIn() { $isloggedIn = FALSE; @@ -834,7 +842,8 @@ AND u.status = 1 /** * Get currently logged in user uf id. * - * @return int $userID logged in user uf id. + * @return int + * $userID logged in user uf id. */ public function getLoggedInUfID() { $ufID = NULL; @@ -856,7 +865,8 @@ AND u.status = 1 * @param bool $addLanguagePart * @param bool $removeLanguagePart * - * @return string $url, formatted url. + * @return string + * , formatted url. * @static */ public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) { @@ -944,7 +954,8 @@ AND u.status = 1 /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module */ public function getModules() { $result = array(); @@ -1001,7 +1012,8 @@ AND u.status = 1 /** * Over-ridable function to get timezone as a string eg. - * @return string Timezone e.g. 'America/Los_Angeles' + * @return string + * Timezone e.g. 'America/Los_Angeles' */ public function getTimeZoneString() { global $user; diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index d3cd66780f..0ef2a08dbd 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -49,7 +49,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param bool $maintenance * For maintenance mode. * - * @return void prints content on stdout + * @return void + * prints content on stdout */ public function theme(&$content, $print = FALSE, $maintenance = FALSE) { // TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary @@ -222,7 +223,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * * @param CRM_Core_Form $form * Form object representing the 'current' form - to which the user will be returned. - * @return string $destination destination value for URL + * @return string + * destination value for URL * */ public function getLoginDestination(&$form) { @@ -339,7 +341,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScriptUrl($url, $region) { // CRM-15450 - D6 doesn't order internal/external links correctly so we can't use drupal_add_js @@ -356,7 +359,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScript($code, $region) { // CRM-15450 - ensure scripts are in correct order @@ -373,7 +377,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyleUrl($url, $region) { if ($region != 'html-header' || !$this->formatResourceUrl($url)) { @@ -393,7 +398,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyle($code, $region) { return FALSE; @@ -417,7 +423,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param mix $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form */ public function postURL($action) { if (!empty($action)) { @@ -566,7 +573,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Get the locale set in the hosting CMS * - * @return string with the locale or null for none + * @return string + * with the locale or null for none */ public function getUFLocale() { // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale @@ -764,7 +772,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Check is user logged in. * - * @return boolean true/false. + * @return boolean */ public function isUserLoggedIn() { $isloggedIn = FALSE; @@ -778,7 +786,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Get currently logged in user uf id. * - * @return int $userID logged in user uf id. + * @return int + * $userID logged in user uf id. */ public function getLoggedInUfID() { $ufID = NULL; @@ -800,7 +809,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param bool $addLanguagePart * @param bool $removeLanguagePart * - * @return string $url, formatted url. + * @return string + * , formatted url. * @static */ public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) { @@ -893,7 +903,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module */ public function getModules() { $result = array(); @@ -910,7 +921,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { @@ -950,7 +962,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** * Over-ridable function to get timezone as a string eg. - * @return string Timezone e.g. 'America/Los_Angeles' + * @return string + * Timezone e.g. 'America/Los_Angeles' */ public function getTimeZoneString() { global $user; diff --git a/CRM/Utils/System/Drupal8.php b/CRM/Utils/System/Drupal8.php index 1793bb9426..6e83b3da0f 100644 --- a/CRM/Utils/System/Drupal8.php +++ b/CRM/Utils/System/Drupal8.php @@ -188,7 +188,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * * @param CRM_Core_Form $form * Form object representing the 'current' form - to which the user will be returned. - * @return string $destination destination value for URL + * @return string + * destination value for URL * */ public function getLoginDestination(&$form) { @@ -227,7 +228,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { @@ -300,7 +302,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScriptUrl($url, $region) { $options = array('group' => JS_LIBRARY, 'weight' => 10); @@ -329,7 +332,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScript($code, $region) { $options = array('type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10); @@ -356,7 +360,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyleUrl($url, $region) { if ($region != 'html-header') { @@ -379,7 +384,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyle($code, $region) { if ($region != 'html-header') { @@ -648,7 +654,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { /** * Get currently logged in user uf id. * - * @return int $userID logged in user uf id. + * @return int + * $userID logged in user uf id. */ public function getLoggedInUfID() { if ($id = \Drupal::currentUser()->id()) { diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index d58979baeb..bc2dea9bac 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -61,7 +61,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { /** * @param string dir base civicrm directory * Return default Site Settings - * @return array array + * @return array + * array * - $url, (Joomla - non admin url) * - $siteName, * - $siteRoot @@ -93,7 +94,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * * @param url (reference) * - * @return bool: TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more + * @return bool + * TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more * efficiently if it is known to be in the drupal site */ public function formatResourceUrl(&$url) { @@ -129,7 +131,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * * @param string $url * Potential resource url based on standard folder assumptions. - * @return string $url with civicrm-core directory appended if not standard civi dir + * @return string + * with civicrm-core directory appended if not standard civi dir */ public function appendCoreDirectoryToResourceBase($url) { global $civicrm_root; @@ -160,7 +163,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * @param bool $forceBackend * a gross joomla hack. * - * @return string an HTML string containing a link to the given path. + * @return string + * an HTML string containing a link to the given path. * */ function url( @@ -247,7 +251,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { /** * Get currently logged in user unique identifier - this tends to be the email address or user name. * - * @return string $userID logged in user unique identifier + * @return string + * logged in user unique identifier */ public function getLoggedInUniqueIdentifier() { global $user; @@ -320,7 +325,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module * */ public function getModules() { @@ -356,7 +362,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * * @param string $url * - * @return string $url, formatted url. + * @return string + * , formatted url. * @static */ public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) { @@ -435,7 +442,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { /** * Get the locale set in the hosting CMS * - * @return string with the locale or null for none + * @return string + * with the locale or null for none * */ public function getUFLocale() { @@ -482,7 +490,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * @param mix $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form */ public function postURL($action) { if (!empty($action)) { diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index 319919910a..109bc1d079 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -271,7 +271,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScriptUrl($url, $region) { return FALSE; @@ -287,7 +288,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScript($code, $region) { return FALSE; @@ -303,7 +305,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyleUrl($url, $region) { if ($region == 'html-header') { @@ -324,7 +327,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyle($code, $region) { if ($region == 'html-header') { @@ -355,7 +359,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * * @param bool $forceBackend * - * @return string an HTML string containing a link to the given path. + * @return string + * an HTML string containing a link to the given path. */ function url( $path = NULL, $query = NULL, $absolute = TRUE, @@ -434,7 +439,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * @param $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form */ public function postURL($action) { if (!empty($action)) { @@ -612,7 +618,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Get the locale set in the hosting CMS * - * @return string the used locale or null for none + * @return string + * the used locale or null for none */ public function getUFLocale() { if (defined('_JEXEC')) { @@ -698,7 +705,7 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Check is user logged in. * - * @return boolean true/false. + * @return boolean */ public function isUserLoggedIn() { $user = JFactory::getUser(); @@ -708,7 +715,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Get currently logged in user uf id. * - * @return int logged in user uf id. + * @return int + * logged in user uf id. */ public function getLoggedInUfID() { $user = JFactory::getUser(); @@ -718,7 +726,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Get currently logged in user unique identifier - this tends to be the email address or user name. * - * @return string $userID logged in user unique identifier + * @return string + * logged in user unique identifier */ public function getLoggedInUniqueIdentifier() { $user = JFactory::getUser(); @@ -748,7 +757,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module */ public function getModules() { $result = array(); @@ -774,7 +784,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { @@ -830,7 +841,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * * @param $dir * - * @return array array + * @return array + * array * - $url, (Joomla - non admin url) * - $siteName, * - $siteRoot diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php index d3df9a2110..4d24cc61df 100644 --- a/CRM/Utils/System/Soap.php +++ b/CRM/Utils/System/Soap.php @@ -65,7 +65,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * @param string $str * The permission to check. * - * @return boolean true if yes, else false + * @return boolean + * true if yes, else false * @static */ public function checkPermission($str) { @@ -110,7 +111,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * @param string $fragment * A fragment identifier (named anchor) to append to the link. * - * @return string an HTML string containing a link to the given path. + * @return string + * an HTML string containing a link to the given path. * */ public function url($path = NULL, $query = NULL, $absolute = TRUE, $fragment = NULL) { @@ -129,7 +131,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * * @param the default action if one is pre-specified * - * @return string the url to post the form + * @return string + * the url to post the form */ public function postURL($action) { return NULL; @@ -154,7 +157,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * @param string $pass * Login password. * - * @return array Result array + * @return array + * Result array */ public function &authenticate($name, $pass) { if (isset(self::$ufClass)) { @@ -184,7 +188,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { /** * Get the locale set in the hosting CMS * - * @return null as the language is set elsewhere + * @return null + * as the language is set elsewhere */ public function getUFLocale() { return NULL; @@ -197,7 +202,8 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * If present, add destination to querystring (works for Drupal only). * * @throws Exception - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { diff --git a/CRM/Utils/System/UnitTests.php b/CRM/Utils/System/UnitTests.php index ed34adf080..2c746d41c1 100644 --- a/CRM/Utils/System/UnitTests.php +++ b/CRM/Utils/System/UnitTests.php @@ -138,7 +138,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { * @param mix $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form */ /** * @param mix $action @@ -169,7 +170,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { * @param bool $forceBackend * a gross joomla hack. * - * @return string an HTML string containing a link to the given path. + * @return string + * an HTML string containing a link to the given path. * */ /** @@ -287,7 +289,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { /** * Get the locale set in the hosting CMS * - * @return string with the locale or null for none + * @return string + * with the locale or null for none */ /** * @return string @@ -299,7 +302,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { /** * Get a list of all installed modules, including enabled and disabled ones * - * @return array CRM_Core_Module + * @return array + * CRM_Core_Module */ /** * @return array @@ -315,7 +319,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { * If present, add destination to querystring (works for Drupal only). * * @throws Exception - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * @static */ public function getLoginURL($destination = '') { @@ -324,7 +329,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { /** * Over-ridable function to get timezone as a string eg. - * @return string Timezone e.g. 'America/Los_Angeles' + * @return string + * Timezone e.g. 'America/Los_Angeles' */ public function getTimeZoneString() { // This class extends Drupal, but we don't want Drupal's behavior; reproduce CRM_Utils_System_Base::getTimeZoneString diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index 73c6f54d90..7da8a9b385 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -180,7 +180,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScriptUrl($url, $region) { return FALSE; @@ -196,7 +197,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addScript($code, $region) { return FALSE; @@ -212,7 +214,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyleUrl($url, $region) { return FALSE; @@ -228,7 +231,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Note: This function is not to be called directly * @see CRM_Core_Region::render() * - * @return bool TRUE if we support this operation in this CMS, FALSE otherwise + * @return bool + * TRUE if we support this operation in this CMS, FALSE otherwise */ public function addStyle($code, $region) { return FALSE; @@ -253,7 +257,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * @param mix $action * The default action if one is pre-specified. * - * @return string the url to post the form + * @return string + * the url to post the form * @static */ public function postURL($action) { @@ -284,7 +289,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * * @param bool $forceBackend * - * @return string an HTML string containing a link to the given path. + * @return string + * an HTML string containing a link to the given path. */ function url( $path = NULL, @@ -467,7 +473,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Get the locale set in the hosting CMS * - * @return string with the locale or null for none + * @return string + * with the locale or null for none */ public function getUFLocale() { // WPML plugin @@ -671,7 +678,7 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Check is user logged in. * - * @return boolean true/false. + * @return boolean */ public function isUserLoggedIn() { $isloggedIn = FALSE; @@ -695,7 +702,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Get currently logged in user uf id. * - * @return int $userID logged in user uf id. + * @return int + * $userID logged in user uf id. */ public function getLoggedInUfID() { $ufID = NULL; @@ -706,7 +714,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Get currently logged in user unique identifier - this tends to be the email address or user name. * - * @return string $userID logged in user unique identifier + * @return string + * logged in user unique identifier */ public function getLoggedInUniqueIdentifier() { $user = $this->getLoggedInUserObject(); @@ -740,7 +749,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * @param string $destination * If present, add destination to querystring (works for Drupal only). * - * @return string - loginURL for the current CMS + * @return string + * loginURL for the current CMS * */ public function getLoginURL($destination = '') { @@ -760,7 +770,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Return the current WordPress version if relevant function exists * - * @return string - version number + * @return string + * version number * */ public function getVersion() { @@ -774,7 +785,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Get timezone as a string - * @return string Timezone e.g. 'America/Los_Angeles' + * @return string + * Timezone e.g. 'America/Los_Angeles' */ public function getTimeZoneString() { return get_option('timezone_string'); diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index 2927be5eae..8eed46b63c 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -151,7 +151,8 @@ class CRM_Utils_Token { * @param string $str * The string to search. * - * @return boolean Was there a match + * @return boolean + * Was there a match * @static */ public static function token_match($type, $var, &$str) { @@ -172,7 +173,8 @@ class CRM_Utils_Token { * * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &token_replace($type, $var, $value, &$str, $escapeSmarty = FALSE) { @@ -193,7 +195,8 @@ class CRM_Utils_Token { * @param string $token_type * A string indicating the the type of token to be used in the expression. * - * @return string regular expression sutiable for using in preg_replace + * @return string + * regular expression sutiable for using in preg_replace * @static */ private static function tokenRegex($token_type) { @@ -206,7 +209,8 @@ class CRM_Utils_Token { * @param string $string * A string that needs to be escaped from smarty parsing. * - * @return string the escaped string + * @return string + * the escaped string * @static */ private static function tokenEscapeSmarty($string) { @@ -227,7 +231,8 @@ class CRM_Utils_Token { * @param null $knownTokens * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceDomainTokens( @@ -327,7 +332,8 @@ class CRM_Utils_Token { * * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceOrgTokens($str, &$org, $html = FALSE, $escapeSmarty = FALSE) { @@ -410,7 +416,8 @@ class CRM_Utils_Token { * @param null $knownTokens * @param bool $escapeSmarty * - * @return string The processed sstring + * @return string + * The processed sstring * @static */ public static function &replaceMailingTokens( @@ -544,7 +551,8 @@ class CRM_Utils_Token { * * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceActionTokens( @@ -637,7 +645,8 @@ class CRM_Utils_Token { * * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceContactTokens( @@ -781,7 +790,8 @@ class CRM_Utils_Token { * * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceHookTokens( @@ -808,7 +818,8 @@ class CRM_Utils_Token { * @param string $tokenHtml * @param array $entity * @param string $entityType - * @return string html parsed through smarty + * @return string + * html parsed through smarty */ public static function parseThroughSmarty($tokenHtml, $entity, $entityType = 'contact') { if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) { @@ -856,7 +867,8 @@ class CRM_Utils_Token { * this routine will remove the extra backslashes and braces * * @param $str ref to the string that will be scanned and modified - * @return void this function works directly on the string that is passed + * @return void + * this function works directly on the string that is passed * @access public * @static */ @@ -879,7 +891,8 @@ class CRM_Utils_Token { * The contact ID. * @param string hash The security hash of the unsub event * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceUnsubscribeTokens( @@ -925,7 +938,8 @@ class CRM_Utils_Token { * The contact ID. * @param string hash The security hash of the resub event * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceResubscribeTokens( @@ -952,7 +966,8 @@ class CRM_Utils_Token { * @param bool $html * Replace tokens with html or plain text. * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceSubscribeTokens($str, $group, $url, $html) { @@ -971,7 +986,8 @@ class CRM_Utils_Token { * @param string $str * The string with tokens to be replaced. * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceSubscribeInviteTokens($str) { @@ -1018,7 +1034,8 @@ class CRM_Utils_Token { * @param bool $html * Replace tokens with html or plain text. * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceWelcomeTokens($str, $group, $html) { @@ -1034,7 +1051,8 @@ class CRM_Utils_Token { * @param string $str * The string to search. * - * @return array Array of tokens that weren't replaced + * @return array + * Array of tokens that weren't replaced * @static */ public static function &unmatchedTokens(&$str) { @@ -1056,7 +1074,8 @@ class CRM_Utils_Token { * @param bool $escapeSmarty * @param bool $returnEmptyToken * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceComponentTokens(&$str, $contact, $components, $escapeSmarty = FALSE, $returnEmptyToken = TRUE) { @@ -1088,7 +1107,8 @@ class CRM_Utils_Token { * @param string $string * The input string to parse for tokens. * - * @return array $tokens array of tokens mentioned in field + * @return array + * array of tokens mentioned in field * @access public * @static */ @@ -1119,7 +1139,8 @@ class CRM_Utils_Token { * Function to determine which values to retrieve to insert into tokens. The heavy resemblance between this function * and getTokens appears to be historical rather than intentional and should be reviewed * @param $string - * @return array fields to pass in as return properties when populating token + * @return array + * fields to pass in as return properties when populating token * */ public static function getReturnProperties(&$string) { @@ -1290,7 +1311,8 @@ class CRM_Utils_Token { * @param string $className * Sent as context to the hook. * @param string $jobID - * @return array contactDetails with hooks swapped out + * @return array + * contactDetails with hooks swapped out */ public function getAnonymousTokenDetails($contactIDs = array( 0), @@ -1499,7 +1521,8 @@ class CRM_Utils_Token { * @param null $knownTokens * @param bool $escapeSmarty * - * @return string The processed string + * @return string + * The processed string * @static */ public static function &replaceUserTokens($str, $knownTokens = NULL, $escapeSmarty = FALSE) { @@ -1585,7 +1608,8 @@ class CRM_Utils_Token { * @param array $knownTokens * Array of tokens present. * @param bool $escapeSmarty - * @return string string with replacements made + * @return string + * string with replacements made */ public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = array(), $escapeSmarty = FALSE) { if (!$knownTokens || empty($knownTokens[$entity])) { @@ -1680,7 +1704,8 @@ class CRM_Utils_Token { * @param array $membership * An api result array for a single membership. * @param bool $escapeSmarty - * @return string token replacement + * @return string + * token replacement */ public static function getMembershipTokenReplacement($token, $membership, $escapeSmarty = FALSE) { $entity = 'membership'; @@ -1764,7 +1789,8 @@ class CRM_Utils_Token { } /** - * @return array: legacy_token => new_token + * @return array + * legacy_token => new_token */ public static function legacyContactTokens() { return array( diff --git a/CRM/Utils/Tree.php b/CRM/Utils/Tree.php index 68034b0e0f..8750a4951f 100644 --- a/CRM/Utils/Tree.php +++ b/CRM/Utils/Tree.php @@ -162,7 +162,8 @@ class CRM_Utils_Tree { * * @param string $name * - * @return array (ref) + * @return array + * (ref) * */ public function &createNode($name) { diff --git a/CRM/Utils/Verp.php b/CRM/Utils/Verp.php index 0571544f1e..9a2e2d6479 100644 --- a/CRM/Utils/Verp.php +++ b/CRM/Utils/Verp.php @@ -69,7 +69,8 @@ class CRM_Utils_Verp { * @param string $recipient * The address of the recipient. * - * @return string The VERP encoded address + * @return string + * The VERP encoded address * @static */ public static function encode($sender, $recipient) { @@ -95,7 +96,8 @@ class CRM_Utils_Verp { * @param string $address * The address to be decoded. * - * @return array The tuple ($sender, $recipient) + * @return array + * The tuple ($sender, $recipient) * @static */ public static function &verpdecode($address) { diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php index a5b1ac963e..3aa2f7372e 100644 --- a/CRM/Utils/Wrapper.php +++ b/CRM/Utils/Wrapper.php @@ -59,7 +59,8 @@ class CRM_Utils_Wrapper { * @param bool addSequence should we add a unique sequence number to the end of the key * @param bool ignoreKey should we not set a qfKey for this controller (for standalone forms) * - * @return void. + * @return void + * */ public function run($formName, $formLabel = NULL, $arguments = NULL) { if (is_array($arguments)) { diff --git a/CRM/Utils/XML.php b/CRM/Utils/XML.php index df9b395aec..ee36f11eca 100644 --- a/CRM/Utils/XML.php +++ b/CRM/Utils/XML.php @@ -38,7 +38,8 @@ class CRM_Utils_XML { * * @param $file * - * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE) + * @return array + * (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE) */ public static function parseFile($file) { $xml = FALSE; // SimpleXMLElement @@ -69,7 +70,8 @@ class CRM_Utils_XML { * * @param $string * - * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE) + * @return array + * (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE) */ public static function parseString($string) { $xml = FALSE; // SimpleXMLElement diff --git a/CRM/Utils/Zip.php b/CRM/Utils/Zip.php index c8929efba4..cf6c90186d 100644 --- a/CRM/Utils/Zip.php +++ b/CRM/Utils/Zip.php @@ -98,7 +98,8 @@ class CRM_Utils_Zip { * @param ZipArchive $zip * @param $expected * - * @return string or FALSE + * @return string + * or FALSE */ static public function guessBasedir(ZipArchive $zip, $expected) { $candidate = FALSE; diff --git a/Civi/API/Kernel.php b/Civi/API/Kernel.php index 0bc3fbd5a8..0ed80a3bcb 100644 --- a/Civi/API/Kernel.php +++ b/Civi/API/Kernel.php @@ -281,7 +281,8 @@ class Kernel { * An unhandled exception. * @param array $apiRequest * The full description of the API request. - * @return array (API response) + * @return array + * (API response) */ public function formatApiException($e, $apiRequest) { $data = $e->getExtraParams(); diff --git a/Civi/API/Provider/ProviderInterface.php b/Civi/API/Provider/ProviderInterface.php index 19cc0b4c85..e17ca8c269 100644 --- a/Civi/API/Provider/ProviderInterface.php +++ b/Civi/API/Provider/ProviderInterface.php @@ -36,7 +36,8 @@ interface ProviderInterface { /** * @param array $apiRequest * The full description of the API request. - * @return array structured response data (per civicrm_api3_create_success) + * @return array + * structured response data (per civicrm_api3_create_success) * @see civicrm_api3_create_success * @throws \API_Exception */ diff --git a/Civi/API/Request.php b/Civi/API/Request.php index a9678d4941..1d5f747402 100644 --- a/Civi/API/Request.php +++ b/Civi/API/Request.php @@ -46,7 +46,8 @@ class Request { * Who knows? ... * * @throws \API_Exception - * @return array the request descriptor; keys: + * @return array + * the request descriptor; keys: * - version: int * - entity: string * - action: string diff --git a/Civi/API/Subscriber/DynamicFKAuthorization.php b/Civi/API/Subscriber/DynamicFKAuthorization.php index cd6ce4e695..e979e93ac7 100644 --- a/Civi/API/Subscriber/DynamicFKAuthorization.php +++ b/Civi/API/Subscriber/DynamicFKAuthorization.php @@ -265,7 +265,8 @@ class DynamicFKAuthorization implements EventSubscriberInterface { /** * @param int $id * e.g. file ID. - * @return array (0 => bool $isValid, 1 => string $entityTable, 2 => int $entityId) + * @return array + * (0 => bool $isValid, 1 => string $entityTable, 2 => int $entityId) */ public function getDelegate($id) { $query = \CRM_Core_DAO::executeQuery($this->lookupDelegateSql, array( diff --git a/Civi/API/Subscriber/TransactionSubscriber.php b/Civi/API/Subscriber/TransactionSubscriber.php index 1dd1b71277..132533c647 100644 --- a/Civi/API/Subscriber/TransactionSubscriber.php +++ b/Civi/API/Subscriber/TransactionSubscriber.php @@ -114,7 +114,8 @@ class TransactionSubscriber implements EventSubscriberInterface { * The API provider responsible for this request. * @param array $apiRequest * The full API request. - * @return bool True if a new nested transaction is required; false if active tx may be used + * @return bool + * True if a new nested transaction is required; false if active tx may be used */ public function isNested($apiProvider, $apiRequest) { if ($this->isForceRollback($apiProvider, $apiRequest)) { diff --git a/Civi/CCase/Analyzer.php b/Civi/CCase/Analyzer.php index 633688a225..f958eb663a 100644 --- a/Civi/CCase/Analyzer.php +++ b/Civi/CCase/Analyzer.php @@ -100,7 +100,8 @@ class Analyzer { /** * Get a list of all activities in the case * - * @return array list of activity records (api/v3 format) + * @return array + * list of activity records (api/v3 format) */ public function getActivities() { if ($this->activities === NULL) { @@ -184,7 +185,8 @@ class Analyzer { * * @param array $keys * List of properties by which to index activities. - * @return array list of activity records (api/v3 format), indexed by $keys + * @return array + * list of activity records (api/v3 format), indexed by $keys */ public function getActivityIndex($keys) { $key = implode(";", $keys); diff --git a/Civi/CiUtil/CSVParser.php b/Civi/CiUtil/CSVParser.php index e09f799295..05893dfda0 100644 --- a/Civi/CiUtil/CSVParser.php +++ b/Civi/CiUtil/CSVParser.php @@ -11,7 +11,8 @@ class CSVParser { * Content; each row in the row csv should start with two cells:. * - cell 0: the test name * - cell 1: the test status - * @return array (string $testName => string $status) + * @return array + * (string $testName => string $status) */ public static function parseResults($csvContent) { $fh = fopen('php://memory', 'r+'); diff --git a/Civi/CiUtil/EnvTestRunner.php b/Civi/CiUtil/EnvTestRunner.php index 35bcfe244a..876c4e010b 100644 --- a/Civi/CiUtil/EnvTestRunner.php +++ b/Civi/CiUtil/EnvTestRunner.php @@ -15,7 +15,8 @@ class EnvTestRunner { /** * @param array $tests - * @return array (string $testName => string $status) + * @return array + * (string $testName => string $status) */ public function run($tests) { $envTests = implode(' ', $tests); diff --git a/Civi/CiUtil/JenkinsParser.php b/Civi/CiUtil/JenkinsParser.php index c99c571091..00d5230db1 100644 --- a/Civi/CiUtil/JenkinsParser.php +++ b/Civi/CiUtil/JenkinsParser.php @@ -8,7 +8,8 @@ class JenkinsParser { /** * @param string $content * Xml data. - * @return array (string $testName => string $status) + * @return array + * (string $testName => string $status) */ public static function parseXmlResults($content) { $xml = simplexml_load_string($content); diff --git a/Civi/CiUtil/PHPUnitParser.php b/Civi/CiUtil/PHPUnitParser.php index 835954623b..4f32db21dc 100644 --- a/Civi/CiUtil/PHPUnitParser.php +++ b/Civi/CiUtil/PHPUnitParser.php @@ -20,7 +20,8 @@ class PHPUnitParser { /** * @param string $content * Json stream. - * @return array (string $testName => string $status) + * @return array + * (string $testName => string $status) */ public static function parseJsonResults($content) { $records = self::parseJsonStream($content); diff --git a/Civi/CiUtil/PHPUnitScanner.php b/Civi/CiUtil/PHPUnitScanner.php index 3f1b4e4c28..45751af58b 100644 --- a/Civi/CiUtil/PHPUnitScanner.php +++ b/Civi/CiUtil/PHPUnitScanner.php @@ -26,7 +26,8 @@ class PHPUnitScanner { } /** - * @return array (string $file => string $class) + * @return array + * (string $file => string $class) */ public static function findTestClasses($paths) { $testClasses = array(); @@ -66,7 +67,8 @@ class PHPUnitScanner { /** * @param array $testClasses - * @return array each element is an array with keys: + * @return array + * each element is an array with keys: * - file: string * - class: string * - method: string diff --git a/Civi/Install/Requirements.php b/Civi/Install/Requirements.php index 3857b3ea5b..14d023e6da 100644 --- a/Civi/Install/Requirements.php +++ b/Civi/Install/Requirements.php @@ -49,7 +49,8 @@ class Requirements { * - file_paths * - db_config * - * @return array An array of check summaries. Each array contains the keys 'title', 'severity', and 'details'. + * @return array + * An array of check summaries. Each array contains the keys 'title', 'severity', and 'details'. */ public function checkAll(array $config) { return array_merge($this->checkSystem($config['file_paths']), $this->checkDatabase($config['db_config'])); diff --git a/api/api.php b/api/api.php index 6c46cb763b..cb044c2a8b 100644 --- a/api/api.php +++ b/api/api.php @@ -59,7 +59,8 @@ function civicrm_api3($entity, $action, $params = array()) { * @todo other output modifiers include contact_type * * @param array $apiRequest - * @return array getfields output + * @return array + * getfields output */ function _civicrm_api3_api_getfields(&$apiRequest) { if (strtolower($apiRequest['action'] == 'getfields')) { @@ -88,7 +89,8 @@ function _civicrm_api3_api_getfields(&$apiRequest) { * * @param $result * - * @return boolean true if error, false otherwise + * @return boolean + * true if error, false otherwise * @static void * @access public */ @@ -157,7 +159,7 @@ function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResu * @param string $entity * Entity name in various formats e.g. Contribution, contribution, * OptionValue, option_value, UFJoin, uf_join. - * @return string $entity + * @return string * Entity name in underscore separated format. * * @fixme Why isn't this called first thing in civicrm_api wrapper? diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 5ffa618b8e..859d4ae9c8 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created acl property values. + * @return array + * of newly created acl property values. * @access public */ function civicrm_api3_acl_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_acl_create($params) { * * @param array $params * - * @return array of retrieved acl property values. + * @return array + * of retrieved acl property values. * @access public */ function civicrm_api3_acl_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_acl_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_acl_delete($params) { diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index caf5954792..4c5554805c 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created acl_role property values. + * @return array + * of newly created acl_role property values. * @access public */ function civicrm_api3_acl_role_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_acl_role_create($params) { * * @param array $params * - * @return array of retrieved acl_role property values. + * @return array + * of retrieved acl_role property values. * @access public */ function civicrm_api3_acl_role_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_acl_role_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_acl_role_delete($params) { diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php index a4269c2eba..721000cc23 100644 --- a/api/v3/ActionSchedule.php +++ b/api/v3/ActionSchedule.php @@ -84,7 +84,8 @@ function _civicrm_api3_action_schedule_create_spec(&$params) { * Array containing id of the action_schedule. * to be deleted * - * @return array API result array + * @return array + * API result array * * @access public */ diff --git a/api/v3/Activity.php b/api/v3/Activity.php index 9f1c58148e..a0cfd6b9fa 100644 --- a/api/v3/Activity.php +++ b/api/v3/Activity.php @@ -47,7 +47,8 @@ * {@getfields activity_create} * * @throws API_Exception - * @return array Array containing 'is_error' to denote success or failure and details of the created activity + * @return array + * Array containing 'is_error' to denote success or failure and details of the created activity * * @example ActivityCreate.php Standard create example * @example Activity/ContactRefCustomField.php Create example including setting a contact reference custom field @@ -255,7 +256,8 @@ function civicrm_api3_activity_get($params) { * @param array $params * API request parameters. * @param array $activities - * @return array new activities list + * @return array + * new activities list */ function _civicrm_api3_activity_get_formatResult($params, $activities) { $returns = CRM_Utils_Array::value('return', $params, array()); @@ -342,7 +344,8 @@ function civicrm_api3_activity_delete($params) { * * @throws API_Exception * @throws Exception - * @return array $error array with errors + * @return array + * array with errors */ function _civicrm_api3_activity_check_params(&$params) { diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index a82270e133..281fbeb1ce 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -45,7 +45,8 @@ * * @param array $params * - * @return array of newly created activity contact records. + * @return array + * of newly created activity contact records. * @access public */ function civicrm_api3_activity_contact_create($params) { @@ -69,7 +70,8 @@ function _civicrm_api3_activity_contact_create_spec(&$params) { * * @param array $params * - * @return array Api Result + * @return array + * Api Result * * @example ActivityContact.php * @access public @@ -86,7 +88,8 @@ function civicrm_api3_activity_contact_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found tags else error + * @return array + * details of found tags else error * * @access public */ diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php index e7aa9f873e..3a272a3e4b 100644 --- a/api/v3/ActivityType.php +++ b/api/v3/ActivityType.php @@ -38,7 +38,8 @@ /** * @deprecated api notice - * @return string to indicate this entire api entity is deprecated + * @return string + * to indicate this entire api entity is deprecated */ function _civicrm_api3_activity_type_deprecation() { return 'The activity_type api is deprecated. Please use the option_value api instead.'; @@ -49,7 +50,8 @@ function _civicrm_api3_activity_type_deprecation() { * * @param array $params * - * @return array $activityTypes activity types keyed by id + * @return array + * activity types keyed by id * @access public * * @example ActivityTypeGet.php @@ -68,7 +70,8 @@ function civicrm_api3_activity_type_get($params) { * Associated array of fields. * $params['option_value_id'] is required for updation of activity type * - * @return array $activityType created / updated activity type + * @return array + * created / updated activity type * * @access public * @@ -109,7 +112,8 @@ function _civicrm_api3_activity_type_create_spec(&$params) { * @param array $params * Array including id of activity_type to delete. - * @return array API result array + * @return array + * API result array * * @access public * diff --git a/api/v3/Address.php b/api/v3/Address.php index 72b23154e2..4ba4d32577 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -45,7 +45,8 @@ * * @param array $params * - * @return array of newly created tag property values. + * @return array + * of newly created tag property values. * @access public */ function civicrm_api3_address_create(&$params) { @@ -131,7 +132,8 @@ function _civicrm_api3_address_get_spec(&$params) { * {@getfields address_delete} * {@example AddressDelete.php 0} * - * @return array api result array + * @return array + * api result array * @access public */ function civicrm_api3_address_delete($params) { @@ -148,7 +150,8 @@ function civicrm_api3_address_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found addresses else error + * @return array + * details of found addresses else error * {@getfields address_get} * @access public */ diff --git a/api/v3/Attachment.php b/api/v3/Attachment.php index 4120bdf62d..6def32ffcc 100644 --- a/api/v3/Attachment.php +++ b/api/v3/Attachment.php @@ -89,7 +89,8 @@ function _civicrm_api3_attachment_create_spec(&$spec) { * Create an attachment * * @param array $params - * @return array of newly created file property values. + * @return array + * of newly created file property values. * @access public * @throws API_Exception validation errors */ @@ -164,7 +165,8 @@ function _civicrm_api3_attachment_get_spec(&$spec) { /** * @param array $params - * @return array per APIv3 + * @return array + * per APIv3 * @throws API_Exception validation errors */ function civicrm_api3_attachment_get($params) { @@ -293,7 +295,8 @@ function __civicrm_api3_attachment_find($params, $id, $file, $entityFile, $isTru /** * @param array $params - * @return array (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent) + * @return array + * (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent) * - array $file: whitelisted fields that can pass through directly to civicrm_file * - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file * - string $name: the printable name @@ -393,7 +396,8 @@ function _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $retur } /** - * @return array list of fields (indexed by name) + * @return array + * list of fields (indexed by name) */ function _civicrm_api3_attachment_getfields() { $fileFields = CRM_Core_DAO_File::fields(); diff --git a/api/v3/Batch.php b/api/v3/Batch.php index ced1fb2b04..8e98a7258d 100644 --- a/api/v3/Batch.php +++ b/api/v3/Batch.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created batch property values. + * @return array + * of newly created batch property values. * @access public */ function civicrm_api3_batch_create($params) { @@ -79,7 +80,8 @@ function _civicrm_api3_batch_create_spec(&$params) { * * @param array $params * - * @return array of retrieved batch property values. + * @return array + * of retrieved batch property values. * @access public */ function civicrm_api3_batch_get($params) { @@ -95,7 +97,8 @@ function civicrm_api3_batch_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_batch_delete($params) { diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php index d1585dfa51..6c35faa089 100644 --- a/api/v3/Campaign.php +++ b/api/v3/Campaign.php @@ -45,7 +45,8 @@ * (reference) Associative array of property. * name/value pairs to insert in new 'campaign' * - * @return array campaign array + * @return array + * campaign array * {@getfields campaign_create} * @access public */ @@ -72,7 +73,8 @@ function _civicrm_api3_campaign_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all campaigns will be returned * - * @return array Array of matching campaigns + * @return array + * Array of matching campaigns * @access public * {@getfields campaign_get} */ @@ -90,7 +92,8 @@ function civicrm_api3_campaign_get($params) { * (reference) array containing id of the group. * to be deleted * - * @return array (reference) returns flag true if successful, error + * @return array + * (reference) returns flag true if successful, error * message otherwise * {@getfields campaign_delete} * @access public diff --git a/api/v3/Case.php b/api/v3/Case.php index 238bd2af79..2c50985f64 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -57,7 +57,8 @@ * 'details' => str // html format * * @throws API_Exception - * @return array api result array + * @return array + * api result array * * @access public * {@getfields case_create} @@ -196,7 +197,8 @@ function _civicrm_api3_case_delete_spec(&$params) { * {@getfields case_get} * * @throws API_Exception - * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found + * @return array + * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found * @access public * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned */ @@ -287,7 +289,8 @@ function civicrm_api3_case_activity_create($params) { /** * @deprecated api notice - * @return array of deprecated actions + * @return array + * of deprecated actions */ function _civicrm_api3_case_deprecation() { return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.'); @@ -306,7 +309,8 @@ function _civicrm_api3_case_deprecation() { * 'contact_id' => int // case client * * @throws API_Exception - * @return array api result array + * @return array + * api result array * * @access public */ @@ -372,7 +376,8 @@ function civicrm_api3_case_update($params) { * 'move_to_trash' => bool (defaults to false) * * @throws API_Exception - * @return boolean: true if success, else false + * @return boolean + * true if success, else false * {@getfields case_delete} * @access public */ @@ -401,7 +406,8 @@ function civicrm_api3_case_delete($params) { * * @param $options * - * @return array case object + * @return array + * case object */ function _civicrm_api3_case_read($caseId, $options) { $return = CRM_Utils_Array::value('return', $options, array()); diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index 739eb700cd..5ce89c943e 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -45,7 +45,8 @@ * {@getfields case_type_create} * * @throws API_Exception - * @return array API result array + * @return array + * API result array * * @static void * @access public @@ -73,7 +74,8 @@ function civicrm_api3_case_type_create($params) { * * @param array $params * - * @return array $caseTypes case types keyed by id + * @return array + * case types keyed by id * @access public */ function civicrm_api3_case_type_get($params) { @@ -113,7 +115,8 @@ function _civicrm_api3_case_type_get_formatResult(&$result) { * @param array $params * Array including id of case_type to delete. - * @return array API result array + * @return array + * API result array * * @access public * diff --git a/api/v3/Constant.php b/api/v3/Constant.php index f9c96b894c..f113c467ca 100644 --- a/api/v3/Constant.php +++ b/api/v3/Constant.php @@ -38,7 +38,8 @@ /** * @deprecated api notice - * @return string to indicate this entire api entity is deprecated + * @return string + * to indicate this entire api entity is deprecated */ function _civicrm_api3_constant_deprecation() { return 'The constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.'; diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 6b597cc564..d5f536664b 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -50,7 +50,8 @@ * @throws API_Exception * @example ContactCreate.php Example of Create Call * - * @return array API Result Array + * @return array + * API Result Array * * @static void * @access public @@ -144,7 +145,8 @@ function _civicrm_api3_contact_create_spec(&$params) { * * @param array input parameters * - * @return array API Result Array + * @return array + * API Result Array * (@getfields contact_get} * @static void * @access public @@ -270,7 +272,8 @@ function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) { * @param array $params * (reference ) input parameters, contact_id element required. * - * @return array API Result Array + * @return array + * API Result Array * @access public * * @example ContactDelete.php @@ -854,7 +857,8 @@ LIMIT 0, {$limit} /** * @deprecated api notice - * @return array of deprecated actions + * @return array + * of deprecated actions */ function _civicrm_api3_contact_deprecation() { return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".'); @@ -873,7 +877,8 @@ function _civicrm_api3_contact_deprecation() { * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.} * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} * - * @return array API Result Array + * @return array + * API Result Array * * @static void * @access public diff --git a/api/v3/ContactType.php b/api/v3/ContactType.php index 1d161a6c10..00f2074628 100644 --- a/api/v3/ContactType.php +++ b/api/v3/ContactType.php @@ -45,7 +45,8 @@ * (reference) Associative array of property. * name/value pairs to insert in new 'contact_type' * - * @return array contact_type array + * @return array + * contact_type array * * @access public */ @@ -73,7 +74,8 @@ function civicrm_api3_contact_type_create($params) { * property_name=>value pairs. If $params is set * as null, all contact_types will be returned * - * @return array Array of matching contact_types + * @return array + * Array of matching contact_types * @access public */ function civicrm_api3_contact_type_get($params) { @@ -91,7 +93,8 @@ function civicrm_api3_contact_type_get($params) { * Array containing id of the group. * to be deleted * - * @return array API Result Array + * @return array + * API Result Array * * @access public */ diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 2e8cee81cc..58022d4d94 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -44,7 +44,8 @@ * (reference ) input parameters. * * @throws API_Exception - * @return array Api result array + * @return array + * Api result array * @static void * @access public * @example ContributionCreate.php @@ -176,7 +177,8 @@ function _civicrm_api3_contribution_create_legacy_support_45(&$params) { * @param array $params * (reference ) input parameters. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public * {@getfields Contribution_delete} @@ -206,7 +208,8 @@ function _civicrm_api3_contribution_delete_spec(&$params) { * @param array $params * (reference ) input parameters. * - * @return array of contributions, if error an array with an error id and error message + * @return array + * of contributions, if error an array with an error id and error message * @static void * @access public * {@getfields Contribution_get} @@ -302,7 +305,8 @@ function _civicrm_api3_contribution_transact_spec(&$params) { * @param array $params * (reference ) input parameters. * - * @return array (reference ) contribution of created or updated record (or a civicrm error) + * @return array + * (reference ) contribution of created or updated record (or a civicrm error) * @static void * @access public * @@ -356,7 +360,8 @@ function civicrm_api3_contribution_transact($params) { * {@getfields Contribution_sendconfirmation} * * @throws Exception - * @return array Api result array + * @return array + * Api result array * @static void * @access public */ @@ -413,7 +418,8 @@ function _civicrm_api3_contribution_sendconfirmation_spec(&$params) { * {@getfields Contribution_completetransaction} * * @throws API_Exception - * @return array Api result array + * @return array + * Api result array * @static void * @access public */ diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php index e8e609919e..e1343d2712 100644 --- a/api/v3/ContributionPage.php +++ b/api/v3/ContributionPage.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'contribution_page' * @example ContributionPageCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields contribution_page_create} * @access public */ @@ -73,7 +74,8 @@ function _civicrm_api3_contribution_page_create_spec(&$params) { * @param array $params * Array of one or more valid property_name=>value pairs. * - * @return array API Result array Array of matching contribution_pages + * @return array + * API Result array Array of matching contribution_pages * {@getfields contribution_page_get} * @access public */ @@ -91,7 +93,8 @@ function civicrm_api3_contribution_page_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result Array + * @return array + * API result Array * {@getfields contribution_page_delete} * @access public */ @@ -109,7 +112,8 @@ function civicrm_api3_contribution_page_delete($params) { * (reference) array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * {@getfields contribution_page_delete} * @access public */ diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php index 042f9b5bf6..5527d35705 100644 --- a/api/v3/ContributionRecur.php +++ b/api/v3/ContributionRecur.php @@ -41,7 +41,8 @@ * name/value pairs to insert in new 'contribution_recur' * @example ContributionRecurCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields contribution_recur_create} * @access public */ @@ -71,7 +72,8 @@ function _civicrm_api3_contribution_recur_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all contribution_recurs will be returned * - * @return array API result Array of matching contribution_recurs + * @return array + * API result Array of matching contribution_recurs * {@getfields contribution_recur_get} * @access public */ @@ -85,7 +87,8 @@ function civicrm_api3_contribution_recur_get($params) { * @param array $params * (reference) array containing id of the recurring contribution. * - * @return boolean returns true is successfully cancelled + * @return boolean + * returns true is successfully cancelled */ function civicrm_api3_contribution_recur_cancel($params) { @@ -103,7 +106,8 @@ function civicrm_api3_contribution_recur_cancel($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * message otherwise * {@getfields contribution_recur_delete} * @access public diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php index 706c446d03..5112d5009a 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -46,7 +46,8 @@ * * @example ContributionSoftCreate.php Standard Create Example //FIXME * - * @return array API result array + * @return array + * API result array * {@getfields contribution_soft_create} * @access public */ @@ -74,7 +75,8 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) { * * @example ContributionSoftDelete.php Standard Delete Example * - * @return boolean | error true if successfull, error otherwise + * @return boolean + * | error true if successfull, error otherwise * {@getfields contribution_soft_delete} * @access public */ @@ -95,7 +97,8 @@ function civicrm_api3_contribution_soft_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result + * @return array + * api result * {@getfields contribution_soft_get} * @access public */ diff --git a/api/v3/Country.php b/api/v3/Country.php index f12d1062b6..6676c1b395 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -46,7 +46,8 @@ require_once 'CRM/Core/DAO/Country.php'; * * @example CountryCreate.php Standard Create Example * - * @return array API result array + * @return array + * API result array * {@getfields country_create} * @access public */ @@ -72,7 +73,8 @@ function _civicrm_api3_country_create_spec(&$params) { * * @example CountryDelete.php Standard Delete Example * - * @return boolean | error true if successfull, error otherwise + * @return boolean + * | error true if successfull, error otherwise * {@getfields country_delete} * @access public */ @@ -91,7 +93,8 @@ function civicrm_api3_country_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array + * api result array * {@getfields country_get} * @access public */ diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index dfad615799..56a416c41d 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -161,7 +161,8 @@ function civicrm_api3_custom_field_get($params) { * @param array $errors * Collect validation errors. * - * @return array Validation errors + * @return array + * Validation errors * @todo remove this function - not in use but need to review functionality before * removing as it might be useful in wrapper layer */ diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index b3a31c92a8..7989e14dbb 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -99,7 +99,8 @@ function _civicrm_api3_custom_group_create_spec(&$params) { * * @param array id of the group to be deleted * - * @return Null if success + * @return Null + * if success * @access public * {@getfields CustomGroup_delete} * @example CustomGroupDelete.php diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index 0b64196ae7..a8f2fd8f8c 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -10,7 +10,8 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -31,7 +32,8 @@ function civicrm_api3_custom_search_get($params) { * * @param array $params * - * @return array of newly created option_value property values. + * @return array + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -70,7 +72,8 @@ function _civicrm_api3_custom_search_create_spec(&$params) { * * {@example ReportTemplateDelete.php 0} * - * @return array Api result + * @return array + * Api result * {@getfields ReportTemplate_create} * @access public */ diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php index 11433166e3..667bd0f26b 100644 --- a/api/v3/CustomValue.php +++ b/api/v3/CustomValue.php @@ -139,7 +139,8 @@ function _civicrm_api3_custom_value_create_spec(&$params) { * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 * * @throws API_Exception - * @return array. + * @return array + * * * @access public */ diff --git a/api/v3/Dashboard.php b/api/v3/Dashboard.php index c2790acade..9e20621ed0 100644 --- a/api/v3/Dashboard.php +++ b/api/v3/Dashboard.php @@ -45,7 +45,8 @@ * Array of property name/value. * pairs for the Dashlet. * - * @return array Array containing 'is_error' to denote success or failure and details of the created activity + * @return array + * Array containing 'is_error' to denote success or failure and details of the created activity * */ function civicrm_api3_dashboard_create($params) { diff --git a/api/v3/Email.php b/api/v3/Email.php index 017c2a1d27..ce1e671d49 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -45,7 +45,8 @@ * * @param array $params * - * @return array API result array + * @return array + * API result array * {@getfields email_create} * @access public */ @@ -74,7 +75,8 @@ function _civicrm_api3_email_create_spec(&$params) { * * @example EmailDelete.php Standard Delete Example * - * @return boolean | error true if successfull, error otherwise + * @return boolean + * | error true if successfull, error otherwise * {@getfields email_delete} * @access public */ @@ -93,7 +95,8 @@ function civicrm_api3_email_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array + * api result array * {@getfields email_get} * @access public */ diff --git a/api/v3/Entity.php b/api/v3/Entity.php index dc48dbfd85..982876b8a5 100644 --- a/api/v3/Entity.php +++ b/api/v3/Entity.php @@ -3,7 +3,8 @@ /** * @deprecated api notice * @param array entities - * @return array of deprecated api entities + * @return array + * of deprecated api entities */ function _civicrm_api3_entity_deprecation($entities) { $deprecated = array(); diff --git a/api/v3/EntityTag.php b/api/v3/EntityTag.php index 09a5ec8328..2914afefbe 100644 --- a/api/v3/EntityTag.php +++ b/api/v3/EntityTag.php @@ -114,7 +114,8 @@ function _civicrm_api3_entity_tag_delete_spec(&$params) { * @param $params * @param string $op * - * @return array + * @return array + * */ function _civicrm_api3_entity_tag_common($params, $op = 'add') { diff --git a/api/v3/Event.php b/api/v3/Event.php index 50be6b1756..7ffd8398b2 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -52,7 +52,8 @@ * Allowed @params array keys are: * {@getfields event_create} * - * @return array API result Array. + * @return array + * API result Array. * @access public */ function civicrm_api3_event_create($params) { @@ -104,7 +105,8 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) { * An associative array of name/value property values of civicrm_event. * {@getfields event_get} * - * @return Array of all found event property values. + * @return Array + * of all found event property values. * @access public * */ @@ -192,7 +194,8 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) { * @param array $paramsArray containing event_id to be deleted. * Array containing event_id to be deleted. * - * @return boolean true if success, error otherwise + * @return boolean + * true if success, error otherwise * @access public * note API has legacy support for 'event_id' * {@getfields event_delete} diff --git a/api/v3/Extension.php b/api/v3/Extension.php index 03e56df720..56ff7786ab 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -48,7 +48,8 @@ define('API_V3_EXTENSION_DELIMITER', ','); * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list * using 'keys' should be more performant than making multiple API calls with 'key' * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionInstall.php @@ -73,7 +74,8 @@ function civicrm_api3_extension_install($params) { /** * Upgrade an extension - runs upgrade_N hooks and system.flush * - * @return array API result + * @return array + * API result * @static void * @access public * @@ -111,7 +113,8 @@ function civicrm_api3_extension_upgrade() { * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list * using 'keys' should be more performant than making multiple API calls with 'key' * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionEnable.php @@ -136,7 +139,8 @@ function civicrm_api3_extension_enable($params) { * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list * using 'keys' should be more performant than making multiple API calls with 'key' * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionDisable.php @@ -162,7 +166,8 @@ function civicrm_api3_extension_disable($params) { * using 'keys' should be more performant than making multiple API calls with 'key' * - removeFiles: bool, whether to remove source tree; default: FALSE * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionUninstall.php @@ -188,7 +193,8 @@ function civicrm_api3_extension_uninstall($params) { * - url: string eg "http://repo.com/myextension-1.0.zip" * * @throws API_Exception - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionDownload.php @@ -239,7 +245,8 @@ function civicrm_api3_extension_download($params) { * - local: bool, whether to rescan local filesystem (default: TRUE) * - remote: bool, whether to rescan remote repository (default: TRUE) * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionRefresh.php @@ -271,7 +278,8 @@ function civicrm_api3_extension_refresh($params) { * * @param array $params * - * @return array API result + * @return array + * API result * @static void * @access public * @example ExtensionGet.php @@ -298,7 +306,8 @@ function civicrm_api3_extension_get($params) { * * @param array $params * API request params with 'key' or 'keys'. - * @return array of extension keys + * @return array + * of extension keys * @throws API_Exception */ function _civicrm_api3_getKeys($params) { diff --git a/api/v3/File.php b/api/v3/File.php index 2640805abb..b854ab447f 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -48,7 +48,8 @@ * @param array $params * An associative array of name/value property values of civicrm_file. * - * @return array of newly created file property values. + * @return array + * of newly created file property values. * @access public */ function civicrm_api3_file_create($params) { @@ -85,7 +86,8 @@ function civicrm_api3_file_create($params) { * @param array $params * An associative array of name/value property values of civicrm_file. * - * @return Array of all found file object property values. + * @return Array + * of all found file object property values. * @access public */ function civicrm_api3_file_get($params) { @@ -102,7 +104,8 @@ function civicrm_api3_file_get($params) { * @param array $paramsAn array of name/value property values of civicrm_file. * An array of name/value property values of civicrm_file. * - * @return array of updated file object property values + * @return array + * of updated file object property values * @access public */ function civicrm_api3_file_update($params) { @@ -133,7 +136,8 @@ function civicrm_api3_file_update($params) { * * @param array $params * - * @return array API result array + * @return array + * API result array * @access public */ function civicrm_api3_file_delete($params) { diff --git a/api/v3/FinancialAccount.php b/api/v3/FinancialAccount.php index 3551cfa113..70d3c1ee48 100644 --- a/api/v3/FinancialAccount.php +++ b/api/v3/FinancialAccount.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created financial_account property values. + * @return array + * of newly created financial_account property values. * @access public */ function civicrm_api3_financial_account_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_financial_account_create($params) { * * @param array $params * - * @return array of retrieved financial_account property values. + * @return array + * of retrieved financial_account property values. * @access public */ function civicrm_api3_financial_account_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_financial_account_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_financial_account_delete($params) { diff --git a/api/v3/FinancialType.php b/api/v3/FinancialType.php index d222363c93..b51c00631e 100644 --- a/api/v3/FinancialType.php +++ b/api/v3/FinancialType.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created financial_type property values. + * @return array + * of newly created financial_type property values. * @access public */ function civicrm_api3_financial_type_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_financial_type_create($params) { * * @param array $params * - * @return array of retrieved financial_type property values. + * @return array + * of retrieved financial_type property values. * @access public */ function civicrm_api3_financial_type_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_financial_type_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_financial_type_delete($params) { diff --git a/api/v3/Generic.php b/api/v3/Generic.php index ee41baa8a8..99e6274bd5 100644 --- a/api/v3/Generic.php +++ b/api/v3/Generic.php @@ -17,7 +17,8 @@ * - version: string * - function: callback (mixed) * - params: array, varies - * @return array API success object + * @return array + * API success object */ function civicrm_api3_generic_getfields($apiRequest) { static $results = array(); @@ -148,7 +149,8 @@ function civicrm_api3_generic_getfields($apiRequest) { * Api request as an array. Keys are. * * @throws API_Exception - * @return integer count of results + * @return integer + * count of results */ function civicrm_api3_generic_getcount($apiRequest) { $apiRequest['params']['options']['is_count'] = TRUE; @@ -168,7 +170,8 @@ function civicrm_api3_generic_getcount($apiRequest) { * @param array $apiRequest * Api request as an array. Keys are. * - * @return integer count of results + * @return integer + * count of results */ function civicrm_api3_generic_getsingle($apiRequest) { // so the first entity is always result['values'][0] @@ -192,7 +195,8 @@ function civicrm_api3_generic_getsingle($apiRequest) { * @param array $apiRequest * Api request as an array. Keys are. * - * @return integer count of results + * @return integer + * count of results */ function civicrm_api3_generic_getvalue($apiRequest) { $apiRequest['params']['sequential'] = 1; @@ -232,7 +236,8 @@ function _civicrm_api3_generic_getrefcount_spec(&$params) { * Api request as an array. * * @throws API_Exception - * @return array API result (int 0 or 1) + * @return array + * API result (int 0 or 1) */ function civicrm_api3_generic_getrefcount($apiRequest) { $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass(); @@ -258,7 +263,8 @@ function civicrm_api3_generic_getrefcount($apiRequest) { * @param array $apiRequest * Api request as an array. Keys are. * - * @return integer count of results + * @return integer + * count of results */ function civicrm_api3_generic_replace($apiRequest) { return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']); @@ -270,7 +276,8 @@ function civicrm_api3_generic_replace($apiRequest) { * @param array $apiRequest * Api request as an array. * - * @return array of results + * @return array + * of results */ function civicrm_api3_generic_getoptions($apiRequest) { // Resolve aliases diff --git a/api/v3/Grant.php b/api/v3/Grant.php index c2023a7616..911660f30c 100644 --- a/api/v3/Grant.php +++ b/api/v3/Grant.php @@ -45,7 +45,8 @@ * Associative array of property. * name/value pairs to insert in new 'grant' * - * @return array grant array + * @return array + * grant array * {@getfields grant_create} * @access public */ @@ -73,7 +74,8 @@ function _civicrm_api3_grant_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all grants will be returned * - * @return array Array of matching grants + * @return array + * Array of matching grants * {@getfields grant_get} * @access public */ @@ -91,7 +93,8 @@ function civicrm_api3_grant_get($params) { * Array containing id of the group. * to be deleted * - * @return array API Result Array + * @return array + * API Result Array * {@getfields grant_delete} * @access public */ diff --git a/api/v3/Group.php b/api/v3/Group.php index 510d1ab1f8..ebb2a850e0 100644 --- a/api/v3/Group.php +++ b/api/v3/Group.php @@ -47,7 +47,8 @@ * Associative array of property. * name/value pairs to insert in new 'group' * - * @return array API result array + * @return array + * API result array * @example GroupCreate.php * {@getfields group_create} * @access public @@ -76,7 +77,8 @@ function _civicrm_api3_group_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all groups will be returned * - * @return array Array of matching groups + * @return array + * Array of matching groups * @example GroupGet.php * {@getfields group_get} * @access public @@ -104,7 +106,8 @@ function civicrm_api3_group_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * @example GroupDelete.php * {@getfields group_delete} * diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index 422b6e4644..f19faf1427 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -49,7 +49,8 @@ * Name value pair of contact information. * {@getfields GroupContact_get} * - * @return array list of groups, given contact subsribed to + * @return array + * list of groups, given contact subsribed to */ function civicrm_api3_group_contact_get($params) { @@ -84,7 +85,8 @@ function civicrm_api3_group_contact_get($params) { * "status" (optional) : one of "Added", "Pending" or "Removed" (default is "Added") * {@example GroupContactCreate.php 0} * - * @return array Information about operation results + * @return array + * Information about operation results * * On success, the return array will be structured as follows: * array( @@ -125,7 +127,8 @@ function civicrm_api3_group_contact_create($params) { * * @param $params * - * @return array + * @return array + * * @deprecated */ function civicrm_api3_group_contact_delete($params) { @@ -243,7 +246,8 @@ function civicrm_api3_group_contact_update_status($params) { /** * @deprecated api notice - * @return array of deprecated actions + * @return array + * of deprecated actions */ function _civicrm_api3_group_contact_deprecation() { return array( diff --git a/api/v3/GroupNesting.php b/api/v3/GroupNesting.php index d886f7aaac..457f2ecef6 100644 --- a/api/v3/GroupNesting.php +++ b/api/v3/GroupNesting.php @@ -44,7 +44,8 @@ * An array containing at least child_group_id or parent_group_id. * {@getfields GroupNesting_get} * - * @return array list of group nesting records + * @return array + * list of group nesting records */ function civicrm_api3_group_nesting_get($params) { @@ -58,7 +59,8 @@ function civicrm_api3_group_nesting_get($params) { * @param array $params * Parameters array - allowed array keys include:. * - * @return array TBD + * @return array + * TBD * {@getfields GroupNesting_create * @todo Work out the return value. */ @@ -90,7 +92,8 @@ function _civicrm_api3_group_nesting_create_spec(&$params) { * Parameters array - allowed array keys include:. * {@getfields GroupNesting_delete} * - * @return array API Success or fail array + * @return array + * API Success or fail array * * @todo Work out the return value. */ diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php index 8d8d2f70bb..33af3d2ae8 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -49,7 +49,8 @@ * {@getfields GroupOrganization_get} * @example GroupOrganizationGet.php * - * @return array list of groups, given contact subsribed to + * @return array + * list of groups, given contact subsribed to */ function civicrm_api3_group_organization_get($params) { return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); @@ -97,7 +98,8 @@ function _civicrm_api3_group_organization_create_spec(&$params) { * @param array $params * With 'id' = ID of the Group Organization to be deleted. * - * @return array API Result + * @return array + * API Result * {@getfields GroupOrganization_delete} * @example GroupOrganizationDelete.php * @access public diff --git a/api/v3/Im.php b/api/v3/Im.php index 9a426e84a0..351dc4ad33 100644 --- a/api/v3/Im.php +++ b/api/v3/Im.php @@ -42,7 +42,8 @@ * * @param array $params * - * @return array of newly created IM property values. + * @return array + * of newly created IM property values. * @access public */ function civicrm_api3_im_create($params) { @@ -66,7 +67,8 @@ function _civicrm_api3_im_create_spec(&$params) { * @param array $params * {@getfields im_delete} * - * @return array API result Array + * @return array + * API result Array * @access public * @todo convert to using Basic delete - BAO function non standard */ @@ -82,7 +84,8 @@ function civicrm_api3_im_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found IM + * @return array + * details of found IM * * @access public */ diff --git a/api/v3/Job.php b/api/v3/Job.php index 77d6225551..61d8ebb774 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -74,7 +74,8 @@ function civicrm_api3_job_create($params) { /** * Retrieve one or more job * @param array input parameters - * @return array api result array + * @return array + * api result array * {@getfields email_get} * @access public */ @@ -87,7 +88,8 @@ function civicrm_api3_job_get($params) { * * @param array $params * - * @return array API Result Array + * @return array + * API Result Array * {@getfields Job_delete} * @static void * @access public @@ -103,7 +105,8 @@ function civicrm_api3_job_delete($params) { * @param array $params * (reference ) input parameters. * - * @return array API Result Array + * @return array + * API Result Array * * @static void * @access public @@ -132,7 +135,8 @@ function _civicrm_api3_job_execute_spec(&$params) { * @param array $params * (reference ) input parameters. * - * @return array API Result Array + * @return array + * API Result Array * {@getfields contact_geocode} * * @static void @@ -175,7 +179,8 @@ function _civicrm_api3_job_geocode_spec(&$params) { * now - the time to use, in YmdHis format * - makes testing a bit simpler since we can simulate past/future time * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public * @@ -225,7 +230,8 @@ function _civicrm_api3_job_send_reminder(&$params) { * instanceId - Integer - the report instance ID * resetVal - Integer - should we reset form state (always true)? * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public * @@ -252,7 +258,8 @@ function civicrm_api3_job_mail_report($params) { * * @param array $params * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static * @access public */ @@ -311,7 +318,8 @@ function _civicrm_api3_job_update_greeting_spec(&$params) { * @param array $params * (reference ) input parameters. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static * @access public * @@ -419,7 +427,8 @@ function civicrm_api3_job_fetch_activities($params) { * @param array $params * (reference ) input parameters. * - * @return array (reference ) array of properties, if error an array with an error id and error message + * @return array + * (reference ) array of properties, if error an array with an error id and error message * @access public */ function civicrm_api3_job_process_participant($params) { @@ -444,7 +453,8 @@ function civicrm_api3_job_process_participant($params) { * @param array $params * Input parameters NOT USED. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public */ @@ -471,7 +481,8 @@ function civicrm_api3_job_process_membership($params) { * @param array $params * (reference ) input parameters. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public */ @@ -499,7 +510,8 @@ function civicrm_api3_job_process_respondent($params) { * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.} * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} * - * @return array API Result Array + * @return array + * API Result Array * * @static void * @access public @@ -563,7 +575,8 @@ function civicrm_api3_job_run_payment_cron($params) { * @param array $params * (reference ) - sends in various config parameters to decide what needs to be cleaned. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public */ diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php index c391436740..6460908d19 100644 --- a/api/v3/LineItem.php +++ b/api/v3/LineItem.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'line_item' * @example LineItemCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields line_item_create} * @access public */ @@ -74,7 +75,8 @@ function _civicrm_api3_line_item_create_spec(&$params) { * Array of one or more valid property_name=>value pairs. If $params is set. * as null, all line_items will be returned (default limit is 25) * - * @return array Array of matching line_items + * @return array + * Array of matching line_items * {@getfields line_item_get} * @access public */ @@ -92,7 +94,8 @@ function civicrm_api3_line_item_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * {@getfields line_item_delete} * @access public */ diff --git a/api/v3/LocBlock.php b/api/v3/LocBlock.php index 1432a3c2da..4cbf6b0e5c 100644 --- a/api/v3/LocBlock.php +++ b/api/v3/LocBlock.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'loc_block' * @example LocBlockCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields loc_block_create} * @access public */ @@ -94,7 +95,8 @@ function civicrm_api3_loc_block_create($params) { * Array of one or more valid property_name=>value pairs. If $params is set. * as null, all loc_blocks will be returned (default limit is 25) * - * @return array Array of matching loc_blocks + * @return array + * Array of matching loc_blocks * {@getfields loc_block_get} * @access public */ @@ -132,7 +134,8 @@ function civicrm_api3_loc_block_get($params) { * @param array $params * Array containing id of the record to be deleted. * - * @return array API result array + * @return array + * API result array * {@getfields loc_block_delete} * @access public */ diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php index aaa1aaa445..10f818739e 100644 --- a/api/v3/LocationType.php +++ b/api/v3/LocationType.php @@ -45,7 +45,8 @@ * * @param array $params * - * @return array API result array + * @return array + * API result array * {@getfields email_create} * @access public */ @@ -77,7 +78,8 @@ function _civicrm_api3_location_type_create_spec(&$params) { * * @example LocationTypeDelete.php Standard Delete Example * - * @return array API result array + * @return array + * API result array * {@getfields LocationType_delete} * @access public */ @@ -96,7 +98,8 @@ function civicrm_api3_location_type_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result + * @return array + * api result * {@getfields LocationType_get} * @access public */ diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php index 6eb567932e..5781b692c8 100644 --- a/api/v3/MailSettings.php +++ b/api/v3/MailSettings.php @@ -42,7 +42,8 @@ * name/value pairs to insert in new 'mail_settings' * @example mail_settingsCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields mail_settings_create} * @access public */ @@ -69,7 +70,8 @@ function _civicrm_api3_mail_settings_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all mail_settings will be returned * - * @return array Array of matching mail_settings + * @return array + * Array of matching mail_settings * {@getfields mail_settings_get} * @access public */ @@ -87,7 +89,8 @@ function civicrm_api3_mail_settings_get($params) { * Array containing id of the group. * to be deleted * - * @return array api result array + * @return array + * api result array * {@getfields mail_settings_delete} * @access public */ diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index f93f458adb..d091e64346 100755 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -47,7 +47,8 @@ * @param array $params * @param array $ids * - * @return array API Success Array + * @return array + * API Success Array */ function civicrm_api3_mailing_create($params, $ids = array()) { if (CRM_Mailing_Info::workflowEnabled()) { @@ -113,7 +114,8 @@ function _civicrm_api3_mailing_create_spec(&$params) { * @param array $params * @param array $ids * - * @return array API Success Array + * @return array + * API Success Array */ function civicrm_api3_mailing_delete($params, $ids = array()) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -237,7 +239,8 @@ function civicrm_api3_mailing_event_confirm($params) { /** * @deprecated api notice - * @return array of deprecated actions + * @return array + * of deprecated actions */ function _civicrm_api3_mailing_deprecation() { return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.'); diff --git a/api/v3/MailingAB.php b/api/v3/MailingAB.php index 065474dc2d..71ae22bb3d 100755 --- a/api/v3/MailingAB.php +++ b/api/v3/MailingAB.php @@ -47,7 +47,8 @@ * @param array $params * @param array $ids * - * @return array API Success Array + * @return array + * API Success Array */ function civicrm_api3_mailing_a_b_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -59,7 +60,8 @@ function civicrm_api3_mailing_a_b_create($params) { * @param array $params * @param array $ids * - * @return array API Success Array + * @return array + * API Success Array */ function civicrm_api3_mailing_a_b_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php index 8e32f42fbf..784f4e13ff 100644 --- a/api/v3/MailingComponent.php +++ b/api/v3/MailingComponent.php @@ -44,7 +44,8 @@ * @param array $params * * @throws API_Exception - * @return array of newly created mailing_component property values. + * @return array + * of newly created mailing_component property values. * @access public */ function civicrm_api3_mailing_component_create($params) { @@ -60,7 +61,8 @@ function civicrm_api3_mailing_component_create($params) { * * @param array $params * - * @return array of retrieved mailing_component property values. + * @return array + * of retrieved mailing_component property values. * @access public */ function civicrm_api3_mailing_component_get($params) { @@ -77,7 +79,8 @@ function civicrm_api3_mailing_component_get($params) { * @param array $params * * @throws API_Exception - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_mailing_component_delete($params) { diff --git a/api/v3/MailingContact.php b/api/v3/MailingContact.php index f807114bff..925b410204 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -45,7 +45,8 @@ * - key: type, value: Delivered | Bounced - optional, defaults to Delivered * - Future extensions will include: Opened, Clicked, Forwarded * - * @return array API result + * @return array + * API result * @static void * @access public * @example CRM/Mailing/BAO/Mailing.php @@ -293,7 +294,8 @@ INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id * - key: type, value: Delivered | Bounced - optional, defaults to Delivered * - Future extensions will include: Opened, Clicked, Forwarded * - * @return array API result + * @return array + * API result * @static void * @access public * @example CRM/Mailing/BAO/Mailing.php diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php index 2e26fd8883..75efbf14e2 100644 --- a/api/v3/MailingEventConfirm.php +++ b/api/v3/MailingEventConfirm.php @@ -45,7 +45,8 @@ * name/value pairs to insert in new 'survey' * * @throws Exception - * @return array api result array + * @return array + * api result array * {@getfields mailing_event_confirm_create} * @access public */ diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index d2d03032f7..f78eb10d90 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -42,7 +42,8 @@ * name/value pairs to insert in new 'survey' * * @throws Exception - * @return array api result array + * @return array + * api result array * {@getfields mailing_event_confirm_create} * @access public */ diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php index 49eb41afe4..e70bb99bdd 100644 --- a/api/v3/MailingEventResubscribe.php +++ b/api/v3/MailingEventResubscribe.php @@ -44,7 +44,8 @@ * Associative array of property. * name/value pairs to insert in new 'survey' * - * @return array api result array + * @return array + * api result array * {@getfields mailing_event_subscribe_create} * @access public */ diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php index 503ea4f259..569593796d 100644 --- a/api/v3/MailingEventSubscribe.php +++ b/api/v3/MailingEventSubscribe.php @@ -45,7 +45,8 @@ * name/value pairs to insert in new 'survey' * * @throws API_Exception - * @return array api result array + * @return array + * api result array * {@getfields mailing_event_subscribe_create} * @access public */ diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php index be867fa208..72d7ec108e 100644 --- a/api/v3/MailingEventUnsubscribe.php +++ b/api/v3/MailingEventUnsubscribe.php @@ -44,7 +44,8 @@ * Associative array of property. * name/value pairs to insert in new 'survey' * - * @return array api result array + * @return array + * api result array * {@getfields mailing_event_unsubscribe_create} * @access public */ diff --git a/api/v3/MailingGroup.php b/api/v3/MailingGroup.php index ded159b714..2970102627 100644 --- a/api/v3/MailingGroup.php +++ b/api/v3/MailingGroup.php @@ -39,7 +39,8 @@ /** * @deprecated api notice - * @return string to indicate this entire api entity is deprecated + * @return string + * to indicate this entire api entity is deprecated */ function _civicrm_api3_mailing_group_deprecation() { return 'The mailing_group api is deprecated. Use the mailing_event apis instead.'; diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php index 1b23fbd70c..02b75e5168 100644 --- a/api/v3/MailingJob.php +++ b/api/v3/MailingJob.php @@ -68,7 +68,8 @@ function _civicrm_api3_mailing_job_create_spec(&$params) { * Array of one or more valid. * @param array $ids * - * @return array API return Array of matching mailing jobs + * @return array + * API return Array of matching mailing jobs * {@getfields mailing_job_get} * @access public */ diff --git a/api/v3/MailingRecipients.php b/api/v3/MailingRecipients.php index 624839872c..f2bef71e8c 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -49,7 +49,8 @@ * Array of one or more valid. * @param array $ids * - * @return array API return Array of matching mailing jobs + * @return array + * API return Array of matching mailing jobs * {@getfields mailing_recipient_get} * @access public */ diff --git a/api/v3/Membership.php b/api/v3/Membership.php index a3ea022217..380a05e421 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -45,7 +45,8 @@ * @param $params * Array array holding id - Id of the contact membership to be deleted. * - * @return array api result + * @return array + * api result * {@getfields membership_delete} * @access public */ @@ -62,7 +63,8 @@ function civicrm_api3_membership_delete($params) { * @param array $params * An associative array of name/value property values of civicrm_membership. * - * @return array of newly created membership property values. + * @return array + * of newly created membership property values. * {@getfields membership_create} * @access public */ @@ -187,7 +189,8 @@ function _civicrm_api3_membership_get_spec(&$params) { * options affecting the desired results; has legacy support * for just passing the contact_id itself as the argument * - * @return Array of all found membership property values. + * @return Array + * of all found membership property values. * @access public * @todo needs some love - basically only a get for a given contact right now * {@getfields membership_get} @@ -237,7 +240,8 @@ function civicrm_api3_membership_get($params) { * @param int $membershipTypeId * @param $activeOnly * - * @return array result for calling function + * @return array + * result for calling function */ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) { // get the membership for the given contact ID @@ -259,7 +263,8 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp * @param $membershipValues * @param int $contactID * - * @return array result for calling function + * @return array + * result for calling function */ function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) { $relationships = array(); diff --git a/api/v3/MembershipBlock.php b/api/v3/MembershipBlock.php index 7ae4337545..f0ad95b490 100644 --- a/api/v3/MembershipBlock.php +++ b/api/v3/MembershipBlock.php @@ -43,7 +43,8 @@ * @param array $params * An associative array of name/value property values of civicrm_membership_block. * - * @return array $result newly created or updated membership type property values. + * @return array + * newly created or updated membership type property values. * @access public * {getfields MembershipBlock_get} */ @@ -73,7 +74,8 @@ function _civicrm_api3_membership_block_create_spec(&$params) { * An associative array of name/value property values of civicrm_membership_block. * {getfields MembershipBlock_get} * - * @return array api result array of all found membership block property values. + * @return array + * api result array of all found membership block property values. * @access public */ function civicrm_api3_membership_block_get($params) { @@ -88,7 +90,8 @@ function civicrm_api3_membership_block_get($params) { * * @param array $params * - * @return array api result array + * @return array + * api result array * @access public * {getfields MembershipBlock_delete} */ diff --git a/api/v3/MembershipPayment.php b/api/v3/MembershipPayment.php index bd1b8f90b8..999c2b89b4 100644 --- a/api/v3/MembershipPayment.php +++ b/api/v3/MembershipPayment.php @@ -42,7 +42,8 @@ * @param array $params * (reference ) input parameters. * - * @return array (reference ) membership_payment_id of created or updated record + * @return array + * (reference ) membership_payment_id of created or updated record * {@getfields MembershipPayment_create} * @example MembershipPaymentCreate.php * @access public @@ -70,7 +71,8 @@ function _civicrm_api3_membership_payment_create_spec(&$params) { * @param array $params * Input parameters. * - * @return array array of properties, if error an array with an error id and error message + * @return array + * array of properties, if error an array with an error id and error message * @example MembershipPaymentGet * {@getfields MembershipPayment_get} * @access public diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index 11211289e7..12de92c8d7 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -45,7 +45,8 @@ * @param array $params * An associative array of name/value property values of civicrm_membership_status. * - * @return array of newly created membership status property values. + * @return array + * of newly created membership status property values. * {@getfields MembershipStatus_create} * @access public */ @@ -61,7 +62,8 @@ function civicrm_api3_membership_status_create($params) { * @param array $params * An associative array of name/value property values of civicrm_membership_status. * - * @return Array of all found membership status property values. + * @return Array + * of all found membership status property values. * {@getfields MembershipStatus_get} * @access public */ @@ -79,7 +81,8 @@ function civicrm_api3_membership_status_get($params) { * An associative array of name/value property values of civicrm_membership_status. * @deprecated - should just use create * - * @return array of updated membership status property values + * @return array + * of updated membership status property values * @access public */ function &civicrm_api3_membership_status_update($params) { @@ -120,7 +123,8 @@ function &civicrm_api3_membership_status_update($params) { * @param array Params array containing 'id' - Id of the membership status to be deleted * {@getfields MembershipStatus_delete} * - * @return array i + * @return array + * i * @access public */ function civicrm_api3_membership_status_delete($params) { @@ -139,7 +143,8 @@ function civicrm_api3_membership_status_delete($params) { * * @throws API_Exception * - * @return Array Array of status id and status name + * @return Array + * Array of status id and status name * @public */ function civicrm_api3_membership_status_calc($membershipParams) { diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php index 0287161634..7a31e1bbfe 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -43,7 +43,8 @@ * @param array $params * An associative array of name/value property values of civicrm_membership_type. * - * @return array $result newly created or updated membership type property values. + * @return array + * newly created or updated membership type property values. * @access public * {getfields MembershipType_get} */ @@ -87,7 +88,8 @@ function _civicrm_api3_membership_type_create_spec(&$params) { * An associative array of name/value property values of civicrm_membership_type. * {getfields MembershipType_get} * - * @return Array of all found membership type property values. + * @return Array + * of all found membership type property values. * @access public */ function civicrm_api3_membership_type_get($params) { @@ -102,7 +104,8 @@ function civicrm_api3_membership_type_get($params) { * * @param array $params * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @access public * {getfields MembershipType_delete} */ diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index 40fa83095e..c2e67ccb48 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -58,7 +58,8 @@ function _civicrm_api3_message_template_create_spec(&$params) { /** * @param array $params * - * @return boolean | error true if successfull, error otherwise + * @return boolean + * | error true if successfull, error otherwise * {@getfields message_template_delete} * @access public */ @@ -83,7 +84,8 @@ function _civicrm_api3_message_template_get_spec(&$params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array + * api result array * {@getfields message_template_get} * @access public */ diff --git a/api/v3/Note.php b/api/v3/Note.php index a9b7cbc773..b938fbc06e 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -51,7 +51,8 @@ * An associative array of name/value property values of civicrm_note. * {@getfields note_create} * - * @return array API result array + * @return array + * API result array * @access public * @example NoteCreate.php Create example * @@ -99,7 +100,8 @@ function civicrm_api3_note_delete($params) { * @param array $params * Input parameters. * - * @return array array of properties, + * @return array + * array of properties, * if error an array with an error id and error message * {@getfields note_get} * @static void @@ -127,7 +129,8 @@ function _civicrm_api3_note_get_spec(&$params) { * @param array $params * Associative array; only required 'id' parameter is used. * - * @return array Nested associative array beginning with direct children of given note. + * @return array + * Nested associative array beginning with direct children of given note. */ function &civicrm_api3_note_tree_get($params) { diff --git a/api/v3/OptionGroup.php b/api/v3/OptionGroup.php index 0f31b174b6..2b18005c73 100644 --- a/api/v3/OptionGroup.php +++ b/api/v3/OptionGroup.php @@ -20,7 +20,8 @@ function civicrm_api3_option_group_get($params) { * (reference) Associative array of property. * name/value pairs to insert in new 'survey' * - * @return array survey array + * @return array + * survey array * * @access public */ @@ -49,7 +50,8 @@ function _civicrm_api3_option_group_create_spec(&$params) { * Array containing id of the group. * to be deleted * - * @return array API Result Array + * @return array + * API Result Array * message otherwise * {@getfields OptionGroup_delete} * @access public diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index c3120527cb..76fee5dd21 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -8,7 +8,8 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -36,7 +37,8 @@ function civicrm_api3_option_value_get($params) { * @param array $params * * @throws API_Exception - * @return array of newly created option_value property values. + * @return array + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -77,7 +79,8 @@ function _civicrm_api3_option_value_create_spec(&$params) { * * {@example OptionValueDelete.php 0} * - * @return array Api result + * @return array + * Api result * {@getfields OptionValue_create} * @access public */ diff --git a/api/v3/Participant.php b/api/v3/Participant.php index 55fb5f60c8..52893a6f03 100644 --- a/api/v3/Participant.php +++ b/api/v3/Participant.php @@ -51,7 +51,8 @@ * @param array $params * An associative array of name/value property values of civicrm_participant. * - * @return array apiresult + * @return array + * apiresult * {@getfields participant_create} * @access public */ @@ -163,7 +164,8 @@ function _civicrm_api3_participant_create_spec(&$params) { * @param array $params * (reference ) input parameters. * - * @return array (reference ) array of properties, if error an array with an error id and error message + * @return array + * (reference ) array of properties, if error an array with an error id and error message * {@getfields participant_get} * @access public */ diff --git a/api/v3/ParticipantPayment.php b/api/v3/ParticipantPayment.php index 10bff1399a..31d8d0c1df 100644 --- a/api/v3/ParticipantPayment.php +++ b/api/v3/ParticipantPayment.php @@ -52,7 +52,8 @@ * @example ParticipantPaymentCreate.php * {@example ParticipantPaymentCreate.php 0} * - * @return array of newly created payment property values. + * @return array + * of newly created payment property values. * {@getfields ParticipantPayment_create} * @access public */ @@ -89,7 +90,8 @@ function _civicrm_api3_participant_payment_create_spec(&$params) { * * @param array $params * - * @return array API result + * @return array + * API result * @example ParticipantPaymentDelete.php * {@getfields ParticipantPayment_delete} * @access public @@ -106,7 +108,8 @@ function civicrm_api3_participant_payment_delete($params) { * @param array $params * Input parameters. * - * @return array array of properties, if error an array with an error id and error message + * @return array + * array of properties, if error an array with an error id and error message * @example ParticipantPaymentGet * {@getfields ParticipantPayment_get} * @access public diff --git a/api/v3/ParticipantStatusType.php b/api/v3/ParticipantStatusType.php index 4b2edc72b8..295bdc97cc 100644 --- a/api/v3/ParticipantStatusType.php +++ b/api/v3/ParticipantStatusType.php @@ -45,7 +45,8 @@ * Associative array of property. * name/value pairs to insert in new 'participant_status' * - * @return array participant_status array + * @return array + * participant_status array * {@getfields ParticipantStatusType_create} * @example ParticipantStatusTypeCreate.php * @access public @@ -62,7 +63,8 @@ function civicrm_api3_participant_status_type_create($params) { * property_name=>value pairs. If $params is set * as null, all participant_statuses will be returned * - * @return array Array of matching participant_statuses + * @return array + * Array of matching participant_statuses * {@getfields ParticipantStatusType_get} * @example ParticipantStatusTypeGet.php * @access public @@ -81,7 +83,8 @@ function civicrm_api3_participant_status_type_get($params) { * (reference) array containing id of the group. * to be deleted * - * @return array api result array + * @return array + * api result array * {@getfields ParticipantStatusType_delete} * @example ParticipantStatusTypeDelete.php * @access public diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index 46735e660b..c842f10ea1 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -42,7 +42,8 @@ * * @param array $params * - * @return array of newly created PaymentProcessor property values. + * @return array + * of newly created PaymentProcessor property values. * @access public */ function civicrm_api3_payment_processor_create($params) { @@ -68,7 +69,8 @@ function _civicrm_api3_payment_processor_create_spec(&$params) { * @param array $params * {@getfields payment_processor_delete} * - * @return array API result Array + * @return array + * API result Array * @access public */ function civicrm_api3_payment_processor_delete($params) { @@ -83,7 +85,8 @@ function civicrm_api3_payment_processor_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found PaymentProcessor + * @return array + * details of found PaymentProcessor * @access public */ function civicrm_api3_payment_processor_get($params) { diff --git a/api/v3/PaymentProcessorType.php b/api/v3/PaymentProcessorType.php index 7370d07030..cba196c112 100644 --- a/api/v3/PaymentProcessorType.php +++ b/api/v3/PaymentProcessorType.php @@ -101,7 +101,8 @@ function civicrm_api3_payment_processor_type_get($params) { * * @param id of payment_processor type $id * - * @return array API Result Array + * @return array + * API Result Array * {@getfields PaymentProcessorType_delete} * @static void * @access public diff --git a/api/v3/Phone.php b/api/v3/Phone.php index 46407c48ad..60749eaf52 100644 --- a/api/v3/Phone.php +++ b/api/v3/Phone.php @@ -45,7 +45,8 @@ * * @param array $params * - * @return array of newly created phone property values. + * @return array + * of newly created phone property values. * @access public */ function civicrm_api3_phone_create($params) { @@ -71,7 +72,8 @@ function _civicrm_api3_phone_create_spec(&$params) { * * @param array $params * - * @return array Api Result + * @return array + * Api Result * {@getfields phone_delete} * @example PhoneDelete.php * @access public diff --git a/api/v3/Phone/Get.php b/api/v3/Phone/Get.php index 4db68b1cd1..4363ee546b 100644 --- a/api/v3/Phone/Get.php +++ b/api/v3/Phone/Get.php @@ -10,7 +10,8 @@ * @param array $params * An associative array of name/value pairs. * - * @return array details of found phones else error + * @return array + * details of found phones else error * @access public * This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php . */ diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php index b4bf07fffe..08bc895769 100644 --- a/api/v3/Pledge.php +++ b/api/v3/Pledge.php @@ -49,7 +49,8 @@ * pairs for the activity. * {@getfields pledge_create} * - * @return array Array containing 'is_error' to denote success or failure and details of the created pledge + * @return array + * Array containing 'is_error' to denote success or failure and details of the created pledge * * @example PledgeCreate.php Standard create example * @@ -68,7 +69,8 @@ function civicrm_api3_pledge_create($params) { * @param array $params * Array included 'pledge_id' of pledge to delete. * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * {@getfields pledge_delete} * @example PledgeDelete.php @@ -129,7 +131,8 @@ function _civicrm_api3_pledge_create_spec(&$params) { * @param array $params * Input parameters. Use interrogate for possible fields. * - * @return array array of pledges, if error an array with an error id and error message + * @return array + * array of pledges, if error an array with an error id and error message * {@getfields pledge_get} * @example PledgeGet.php * @access public diff --git a/api/v3/PledgePayment.php b/api/v3/PledgePayment.php index 2041d47eb2..763f2a5fc9 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -50,7 +50,8 @@ * {@getfields PledgePayment_create} * @example PledgePaymentCreate.php * - * @return array API Result + * @return array + * API Result * @static void * @access public */ @@ -99,7 +100,8 @@ function _civicrm_api3_pledge_payment_create_spec(&$params) { * {@getfields PledgePayment_delete} * @example PledgePaymentDelete.php * - * @return array API result + * @return array + * API result * @static void * @access public */ @@ -121,7 +123,8 @@ function civicrm_api3_pledge_payment_delete($params) { * {@getfields PledgePayment_get} * @example PledgePaymentGet.php * * - * @return array (reference ) array of pledges, if error an array with an error id and error message + * @return array + * (reference ) array of pledges, if error an array with an error id and error message * @static void * @access public */ @@ -148,7 +151,8 @@ function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) { * * @param array $params * - * @return array fields valid for other functions + * @return array + * fields valid for other functions */ function civicrm_api3_pledge_payment_get_spec(&$params) { $params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment"); diff --git a/api/v3/Premium.php b/api/v3/Premium.php index 3278d5f9f8..59831940b7 100644 --- a/api/v3/Premium.php +++ b/api/v3/Premium.php @@ -44,7 +44,8 @@ * @param array $params * * @throws API_Exception - * @return array of newly created premium property values. + * @return array + * of newly created premium property values. * @access public */ function civicrm_api3_premium_create($params) { @@ -60,7 +61,8 @@ function civicrm_api3_premium_create($params) { * * @param array $params * - * @return array of retrieved premium property values. + * @return array + * of retrieved premium property values. * @access public */ function civicrm_api3_premium_get($params) { @@ -77,7 +79,8 @@ function civicrm_api3_premium_get($params) { * @param array $params * * @throws API_Exception - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_premium_delete($params) { diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php index 0e5800cd28..4709a89fcf 100644 --- a/api/v3/PriceField.php +++ b/api/v3/PriceField.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'price_field' * @example PriceFieldCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields price_field_create} * @access public */ @@ -69,7 +70,8 @@ function _civicrm_api3_price_field_create_spec(&$params) { * Array of one or more valid property_name=>value pairs. If $params is set. * as null, all price_fields will be returned (default limit is 25) * - * @return array Array of matching price_fields + * @return array + * Array of matching price_fields * {@getfields price_field_get} * @access public */ @@ -87,7 +89,8 @@ function civicrm_api3_price_field_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * {@getfields price_field_delete} * @access public */ diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php index 2b80d4579c..376eeda161 100644 --- a/api/v3/PriceFieldValue.php +++ b/api/v3/PriceFieldValue.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'price_field_value' * @example PriceFieldValueCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields price_field_value_create} * @access public */ @@ -82,7 +83,8 @@ function _civicrm_api3_price_field_value_create_spec(&$params) { * Array of one or more valid property_name=>value pairs. If $params is set. * as null, all price_field_values will be returned (default limit is 25) * - * @return array Array of matching price_field_values + * @return array + * Array of matching price_field_values * {@getfields price_field_value_get} * @access public */ @@ -100,7 +102,8 @@ function civicrm_api3_price_field_value_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * {@getfields price_field_value_delete} * @access public */ diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php index 66ff4b8f76..1c89358f5b 100644 --- a/api/v3/PriceSet.php +++ b/api/v3/PriceSet.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'price_set' * @example PriceSetCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields price_set_create} * @access public */ @@ -83,7 +84,8 @@ function _civicrm_api3_price_set_create_spec(&$params) { * Array of one or more valid property_name=>value pairs. If $params is set. * as null, all price_sets will be returned (default limit is 25) * - * @return array Array of matching price_sets + * @return array + * Array of matching price_sets * {@getfields price_set_get} * @access public */ @@ -111,7 +113,8 @@ function civicrm_api3_price_set_get($params) { * Array containing id of the group. * to be deleted * - * @return array API result array + * @return array + * API result array * {@getfields price_set_delete} * @access public */ diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php index 22b2b8cbb1..870fe13a29 100644 --- a/api/v3/PrintLabel.php +++ b/api/v3/PrintLabel.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created print_label property values. + * @return array + * of newly created print_label property values. * @access public */ function civicrm_api3_print_label_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_print_label_create($params) { * * @param array $params * - * @return array of retrieved print_label property values. + * @return array + * of retrieved print_label property values. * @access public */ function civicrm_api3_print_label_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_print_label_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_print_label_delete($params) { diff --git a/api/v3/Product.php b/api/v3/Product.php index 4b7cd39d24..7dbd8dbc56 100644 --- a/api/v3/Product.php +++ b/api/v3/Product.php @@ -44,7 +44,8 @@ * @param array $params * * @throws API_Exception - * @return array of newly created product property values. + * @return array + * of newly created product property values. * @access public */ function civicrm_api3_product_create($params) { @@ -60,7 +61,8 @@ function civicrm_api3_product_create($params) { * * @param array $params * - * @return array of retrieved product property values. + * @return array + * of retrieved product property values. * @access public */ function civicrm_api3_product_get($params) { @@ -77,7 +79,8 @@ function civicrm_api3_product_get($params) { * @param array $params * * @throws API_Exception - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_product_delete($params) { diff --git a/api/v3/Profile.php b/api/v3/Profile.php index fb7489d242..d353573d00 100644 --- a/api/v3/Profile.php +++ b/api/v3/Profile.php @@ -156,7 +156,8 @@ function _civicrm_api3_profile_get_spec(&$params) { * @param array $params * * @throws API_Exception - * @return array API result array + * @return array + * API result array */ function civicrm_api3_profile_submit($params) { $profileID = _civicrm_api3_profile_getProfileID($params['profile_id']); @@ -295,7 +296,8 @@ function civicrm_api3_profile_submit($params) { * @param string $fieldName * API field name. * - * @return string BAO Field Name + * @return string + * BAO Field Name */ function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName) { $fieldName = str_replace('url', 'URL', $fieldName); @@ -335,7 +337,8 @@ function _civicrm_api3_profile_submit_spec(&$params, $apirequest) { * Associative array of property name/value. * pairs to update profile field values * - * @return array Updated Contact/ Activity object|CRM_Error + * @return array + * Updated Contact/ Activity object|CRM_Error * * */ @@ -736,7 +739,8 @@ function _civicrm_api3_profile_appendaliases($values, $entity) { /** * @deprecated api notice - * @return array of deprecated actions + * @return array + * of deprecated actions */ function _civicrm_api3_profile_deprecation() { return array( diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 2556d65084..29ddb20e43 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -46,7 +46,8 @@ * @throws API_Exception * @example RelationshipCreate.php Std Create example * - * @return array API Result Array + * @return array + * API Result Array * {@getfields relationship_create} * @static void * @access public @@ -74,7 +75,8 @@ function _civicrm_api3_relationship_create_spec(&$params) { * * @param array $params * - * @return array API Result Array + * @return array + * API Result Array * {@getfields relationship_delete} * @example RelationshipDelete.php Delete Example * @@ -107,7 +109,8 @@ function civicrm_api3_relationship_delete($params) { * - if you pass in contact_id - it just returns all relationships for 'contact_id' * - if you don't pass in contact_id then it does a filter on the relationship table (DAO based search) * - * @return Array API Result Array + * @return Array + * API Result Array * {@getfields relationship_get} * @example RelationshipGet.php * @access public diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index b45e5e0723..fc352bb3e2 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -108,7 +108,8 @@ function civicrm_api3_relationship_type_get($params) { * * @param id of relationship type $id * - * @return array API Result Array + * @return array + * API Result Array * {@getfields RelationshipType_delete} * @static void * @access public diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index 7aa12b5543..959ec3cb41 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -6,7 +6,8 @@ * @param array $params * Input parameters. * - * @return array details of found instances + * @return array + * details of found instances * @access public */ function civicrm_api3_report_instance_get($params) { @@ -18,7 +19,8 @@ function civicrm_api3_report_instance_get($params) { * * @param array $params * - * @return array of newly created report instance property values. + * @return array + * of newly created report instance property values. * @access public */ function civicrm_api3_report_instance_create($params) { @@ -42,7 +44,8 @@ function _civicrm_api3_report_instance_create_spec(&$params) { * * @param array $params * - * @return array Api result + * @return array + * Api result * @access public */ function civicrm_api3_report_instance_delete($params) { diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index 77f42a4b30..a4691c634d 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -10,7 +10,8 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -31,7 +32,8 @@ function civicrm_api3_report_template_get($params) { * * @param array $params * - * @return array of newly created option_value property values. + * @return array + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -72,7 +74,8 @@ function _civicrm_api3_report_template_create_spec(&$params) { * * {@example ReportTemplateDelete.php 0} * - * @return array Api result + * @return array + * Api result * {@getfields ReportTemplate_create} * @access public */ @@ -87,7 +90,8 @@ function civicrm_api3_report_template_delete($params) { * @param array $params * Input parameters. * - * @return array details of found instances + * @return array + * details of found instances * @access public */ function civicrm_api3_report_template_getrows($params) { @@ -164,7 +168,8 @@ function civicrm_api3_report_template_getstatistics($params) { * @param array $params * Input parameters. * - * @return array details of found instances + * @return array + * details of found instances * @access public */ function _civicrm_api3_report_template_getrows_spec(&$params) { diff --git a/api/v3/Setting.php b/api/v3/Setting.php index 5e1a3ee55f..71d283fd56 100644 --- a/api/v3/Setting.php +++ b/api/v3/Setting.php @@ -201,7 +201,8 @@ function _civicrm_api3_setting_fill_spec(&$params) { * name/value pairs + other vars as applicable - see getfields for more * @example SettingCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields setting_create} * @access public */ @@ -237,7 +238,8 @@ function _civicrm_api3_setting_create_spec(&$params) { * Array of one or more valid. * property_name=>value pairs. * - * @return array Array of matching settings + * @return array + * Array of matching settings * {@getfields setting_get} * @access public */ @@ -271,7 +273,8 @@ function _civicrm_api3_setting_get_spec(&$params) { * (reference) Array of one or more valid. * property_name=>value pairs. * - * @return array Array of matching settings + * @return array + * Array of matching settings * {@getfields setting_get} * @access public */ diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 0a44108a0a..73252aeeb3 100644 --- a/api/v3/SmsProvider.php +++ b/api/v3/SmsProvider.php @@ -43,7 +43,8 @@ * * @param array $params * - * @return array of newly created sms_provider property values. + * @return array + * of newly created sms_provider property values. * @access public */ function civicrm_api3_sms_provider_create($params) { @@ -59,7 +60,8 @@ function civicrm_api3_sms_provider_create($params) { * * @param array $params * - * @return array of retrieved sms_provider property values. + * @return array + * of retrieved sms_provider property values. * @access public */ function civicrm_api3_sms_provider_get($params) { @@ -75,7 +77,8 @@ function civicrm_api3_sms_provider_get($params) { * * @param array $params * - * @return array of deleted values. + * @return array + * of deleted values. * @access public */ function civicrm_api3_sms_provider_delete($params) { diff --git a/api/v3/Survey.php b/api/v3/Survey.php index 7aaa65cf98..b757fd812d 100644 --- a/api/v3/Survey.php +++ b/api/v3/Survey.php @@ -43,7 +43,8 @@ * name/value pairs to insert in new 'survey' * @example SurveyCreate.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields survey_create} * @access public */ @@ -70,7 +71,8 @@ function _civicrm_api3_survey_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all surveys will be returned * - * @return array API result Array of matching surveys + * @return array + * API result Array of matching surveys * {@getfields survey_get} * @access public */ @@ -88,7 +90,8 @@ function civicrm_api3_survey_get($params) { * Array containing id of the group. * to be deleted * - * @return array api result array + * @return array + * api result array * {@getfields survey_delete} * @access public */ diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php index 4e8f08217e..81953d0987 100644 --- a/api/v3/SurveyRespondant.php +++ b/api/v3/SurveyRespondant.php @@ -35,7 +35,8 @@ /** * @deprecated api notice - * @return string to indicate this entire api entity is deprecated + * @return string + * to indicate this entire api entity is deprecated */ function _civicrm_api3_survey_respondant_deprecation() { return 'The survey_respondant api is not currently supported.'; @@ -47,7 +48,8 @@ function _civicrm_api3_survey_respondant_deprecation() { * @param array $params * (reference ) input parameters. * - * @return array (reference ) contribution_id of created or updated record + * @return array + * (reference ) contribution_id of created or updated record * @static void * @access public * @deprecated - api currently not supported diff --git a/api/v3/System.php b/api/v3/System.php index d88a1f22a1..5da438e636 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -45,7 +45,8 @@ * - triggers: bool, whether to drop/create SQL triggers; default: FALSE * - session: bool, whether to reset the CiviCRM session data; defaul: FALSE * - * @return boolean true if success, else false + * @return boolean + * true if success, else false * @static void * @access public * @example SystemFlush.php @@ -88,7 +89,8 @@ function _civicrm_api3_system_check_spec(&$spec) { * System.Check API * * @param array $params - * @return array API result descriptor; return items are alert codes/messages + * @return array + * API result descriptor; return items are alert codes/messages * @see civicrm_api3_create_success * @see civicrm_api3_create_error * @throws API_Exception diff --git a/api/v3/Tag.php b/api/v3/Tag.php index f6943046ab..0a4f5048b4 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -44,7 +44,8 @@ * * @param array $params * - * @return array of newly created tag property values. + * @return array + * of newly created tag property values. * {@getfields tag_create} * @access public */ @@ -71,7 +72,8 @@ function _civicrm_api3_tag_create_spec(&$params) { * * @example TagDelete.ph * - * @return array API result array + * @return array + * API result array * {@getfields tag_delete} * @access public */ @@ -90,7 +92,8 @@ function civicrm_api3_tag_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found tags else error + * @return array + * details of found tags else error * {@getfields tag_get} * @access public */ diff --git a/api/v3/UFField.php b/api/v3/UFField.php index 685d87d627..6d1be34e1b 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -45,7 +45,8 @@ * * @throws API_Exception * - * @return array Newly created $ufFieldArray + * @return array + * Newly created $ufFieldArray * * @access public * {@getfields UFField_create} @@ -114,7 +115,8 @@ function civicrm_api3_uf_field_create($params) { * * @param array $params * - * @return array fields valid for other functions + * @return array + * fields valid for other functions */ function _civicrm_api3_uf_field_create_spec(&$params) { $params['option.autoweight'] = array( @@ -135,7 +137,8 @@ function _civicrm_api3_uf_field_create_spec(&$params) { * property_name=>value pairs. If $params is set * as null, all surveys will be returned * - * @return array (reference) Array + * @return array + * (reference) Array * {@getfields UFField_get * @example UFFieldGet.php * @access public diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index 37dc28b788..7872aa6d8d 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -54,7 +54,8 @@ function _civicrm_api3_uf_group_create_spec(&$params) { * @param $params * Array Associative array of property name/value pairs to insert in group. * - * @return array API result array + * @return array + * API result array * {@getfields UFGroup_create} * @example UFGroupCreate.php * @access public @@ -71,7 +72,8 @@ function civicrm_api3_uf_group_create($params) { * property_name=>value pairs. If $params is set * as null, all surveys will be returned * - * @return array Array of matching profiles + * @return array + * Array of matching profiles * {@getfields UFGroup_get} * @example UFGroupGet.php * @access public diff --git a/api/v3/UFJoin.php b/api/v3/UFJoin.php index 43b5ea9ff9..feeffe740f 100644 --- a/api/v3/UFJoin.php +++ b/api/v3/UFJoin.php @@ -43,7 +43,8 @@ * @param array $params * Assoc array of name/value pairs. * - * @return array CRM_Core_DAO_UFJoin Array + * @return array + * CRM_Core_DAO_UFJoin Array * @access public * @example UFJoinCreate.php * {@getfields UFJoin_create} @@ -75,7 +76,8 @@ function _civicrm_api3_uf_join_create_spec(&$params) { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return array $result CiviCRM Result Array or null + * @return array + * CiviCRM Result Array or null * @todo Delete function missing * @access public * {getfields UFJoin_get} diff --git a/api/v3/UFMatch.php b/api/v3/UFMatch.php index d0ccfe9bee..ae89079df8 100644 --- a/api/v3/UFMatch.php +++ b/api/v3/UFMatch.php @@ -42,7 +42,7 @@ * * @param array $params * - * @return array $result + * @return array * @access public * {@getfields UFMatch_get} * @example UFMatchGet.php @@ -60,7 +60,8 @@ function civicrm_api3_uf_match_get($params) { * name/value pairs to insert in new 'survey' * @example UFMatch.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields uf_match_create} * @access public */ @@ -89,7 +90,8 @@ function _civicrm_api3_uf_match_create_spec(&$params) { * name/value pairs to insert in new 'survey' * @example UFMatch.php Std Create example * - * @return array api result array + * @return array + * api result array * {@getfields uf_match_create} * @access public */ diff --git a/api/v3/Website.php b/api/v3/Website.php index 7c21329525..cfaf6cb351 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -46,7 +46,8 @@ * * @param array $params * - * @return array of newly created website property values. + * @return array + * of newly created website property values. * @access public * @todo convert to using basic create - BAO function non-std */ @@ -77,7 +78,8 @@ function _civicrm_api3_website_create_spec(&$params) { * {@getfields website_delete} * @example WebsiteDelete.php Std Delete Example * - * @return array API result Array + * @return array + * API result Array * @access public * @todo convert to using Basic delete - BAO function non standard */ @@ -108,7 +110,8 @@ function civicrm_api3_website_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found websites + * @return array + * details of found websites * * @access public */ diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php index d89793b169..89608f8c55 100644 --- a/api/v3/WordReplacement.php +++ b/api/v3/WordReplacement.php @@ -83,7 +83,8 @@ function _civicrm_api3_word_replacement_create_spec(&$params) { * Array containing id of the word_replacement. * to be deleted * - * @return array api result array + * @return array + * api result array * * @access public */ diff --git a/api/v3/utils.php b/api/v3/utils.php index 76d4fb1580..32562b13d5 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -55,7 +55,8 @@ function _civicrm_api3_initialize() { * @param array $keyoptions * List of required fields options. One of the options is required. * - * @return null or throws error if there the required fields not present + * @return null + * or throws error if there the required fields not present * @ */ function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array()) { @@ -78,7 +79,8 @@ function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions * @param bool $verifyDAO * * @throws API_Exception - * @return null or throws error if there the required fields not present + * @return null + * or throws error if there the required fields not present * * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param */ @@ -136,7 +138,8 @@ function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array() * @param array $data * * @throws API_Exception - * @return array + * @return array + * */ function civicrm_api3_create_error($msg, $data = array()) { $data['is_error'] = 1; @@ -168,7 +171,7 @@ function civicrm_api3_create_error($msg, $data = array()) { * Additional values to be added to top level of result array(. * - this param is currently used for legacy behaviour support * - * @return array $result + * @return array */ function civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) { $result = array(); @@ -413,7 +416,7 @@ function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values) { * @param array $params * @param array $values * - * @return Bool $valueFound + * @return Bool */ function _civicrm_api3_store_values(&$fields, &$params, &$values) { $valueFound = FALSE; @@ -703,7 +706,8 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) { * @param string $action * * @throws API_Exception - * @return array $options options extracted from params + * @return array + * options extracted from params */ function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') { $is_count = FALSE; @@ -1295,7 +1299,8 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { * @param string $bao_name * @param array $params * - * @return array API result array + * @return array + * API result array * @throws API_Exception */ function _civicrm_api3_basic_delete($bao_name, &$params) { diff --git a/tests/extensions/test.extension.manager.paymenttest/main.php b/tests/extensions/test.extension.manager.paymenttest/main.php index 7e65c808a1..b198ce0d8f 100644 --- a/tests/extensions/test.extension.manager.paymenttest/main.php +++ b/tests/extensions/test.extension.manager.paymenttest/main.php @@ -55,7 +55,8 @@ class test_extension_manager_paymenttest extends CRM_Core_Payment { * @param array $params * Assoc array of input parameters for this transaction. * - * @return array the result in an nice formatted array (or an error object) + * @return array + * the result in an nice formatted array (or an error object) * @abstract */ function doDirectPayment(&$params) { diff --git a/tests/phpunit/CRM/Core/BAO/UFFieldTest.php b/tests/phpunit/CRM/Core/BAO/UFFieldTest.php index cbb01a5e3e..278581124a 100644 --- a/tests/phpunit/CRM/Core/BAO/UFFieldTest.php +++ b/tests/phpunit/CRM/Core/BAO/UFFieldTest.php @@ -186,7 +186,8 @@ class CRM_Core_BAO_UFFieldTest extends CiviUnitTestCase { /** * @param array $fields * List of fields to include in the profile. - * @return int field id + * @return int + * field id */ protected function createUFGroup($fields) { $ufGroup = CRM_Core_DAO::createTestObject('CRM_Core_DAO_UFGroup'); diff --git a/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php b/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php index 2b481ce447..c7901b2b96 100644 --- a/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php +++ b/tests/phpunit/CRM/Core/Payment/PayPalProIPNTest.php @@ -168,7 +168,8 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { /** * Get PaymentExpress IPN for a single transaction - * @return array array representing a Paypal IPN POST + * @return array + * array representing a Paypal IPN POST */ public function getPaypalExpressTransactionIPN() { return array( @@ -217,7 +218,8 @@ class CRM_Core_Payment_PayPalProIPNTest extends CiviUnitTestCase { /** * Get IPN results from follow on IPN transactions - * @return array array representing a Paypal IPN POST + * @return array + * array representing a Paypal IPN POST */ public function getSubsequentPaypalExpressTransaction() { return array( diff --git a/tests/phpunit/CRM/Core/Permission/BaseTest.php b/tests/phpunit/CRM/Core/Permission/BaseTest.php index 0cd732520d..d29ec6a49b 100644 --- a/tests/phpunit/CRM/Core/Permission/BaseTest.php +++ b/tests/phpunit/CRM/Core/Permission/BaseTest.php @@ -8,7 +8,8 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class CRM_Core_Permission_BaseTest extends CiviUnitTestCase { /** - * @return array (0 => input to translatePermission, 1 => expected output from translatePermission) + * @return array + * (0 => input to translatePermission, 1 => expected output from translatePermission) */ public function translateData() { $cases = array(); diff --git a/tests/phpunit/CRM/Core/Permission/GenericTest.php b/tests/phpunit/CRM/Core/Permission/GenericTest.php index 4aebdd7eed..dd1efe2ba3 100644 --- a/tests/phpunit/CRM/Core/Permission/GenericTest.php +++ b/tests/phpunit/CRM/Core/Permission/GenericTest.php @@ -8,7 +8,8 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class CRM_Core_Permission_GenericTest extends CiviUnitTestCase { /** - * @return array of CRM_Core_Permission_Base + * @return array + * of CRM_Core_Permission_Base */ public function permissionClasses() { $cases = array(); diff --git a/tests/phpunit/CRM/Core/Permission/JoomlaTest.php b/tests/phpunit/CRM/Core/Permission/JoomlaTest.php index 17b805ca83..da0624e48e 100644 --- a/tests/phpunit/CRM/Core/Permission/JoomlaTest.php +++ b/tests/phpunit/CRM/Core/Permission/JoomlaTest.php @@ -8,7 +8,8 @@ require_once 'CiviTest/CiviUnitTestCase.php'; class CRM_Core_Permission_JoomlaTest extends CiviUnitTestCase { /** - * @return array (0 => input to translatePermission, 1 => expected output from translatePermission) + * @return array + * (0 => input to translatePermission, 1 => expected output from translatePermission) */ public function translateData() { $cases = array(); diff --git a/tests/phpunit/CRM/Core/TransactionTest.php b/tests/phpunit/CRM/Core/TransactionTest.php index a0df74d55e..3154919c13 100644 --- a/tests/phpunit/CRM/Core/TransactionTest.php +++ b/tests/phpunit/CRM/Core/TransactionTest.php @@ -315,7 +315,8 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase { * 'sql-insert'|'bao-create' how to add the example record. * @param string $outcome * 'rollback'|'implicit-commit'|'explicit-commit' how to finish transaction. - * @return int cid + * @return int + * cid */ public function createContactWithTransaction($nesting, $insert, $outcome) { if ($nesting != 'reuse-tx' && $nesting != 'nest-tx') { @@ -369,7 +370,8 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase { * See assertContactsMix. * @param string $outcome * 'rollback'|'implicit-commit'|'explicit-commit' how to finish transaction. - * @return int cid + * @return int + * cid */ public function runBatch($nesting, $callbacks, $existsByOffset, $outcome) { if ($nesting != 'reuse-tx' && $nesting != 'nest-tx') { diff --git a/tests/phpunit/CRM/Utils/versionCheckTest.php b/tests/phpunit/CRM/Utils/versionCheckTest.php index 428ac318da..32c3799fec 100644 --- a/tests/phpunit/CRM/Utils/versionCheckTest.php +++ b/tests/phpunit/CRM/Utils/versionCheckTest.php @@ -114,7 +114,8 @@ class CRM_Utils_versionCheckTest extends CiviUnitTestCase { } /** - * @return array (localVersion, versionInfo, expectedResult) + * @return array + * (localVersion, versionInfo, expectedResult) */ public function newerVersionDataProvider() { $data = array(); @@ -150,7 +151,8 @@ class CRM_Utils_versionCheckTest extends CiviUnitTestCase { } /** - * @return array (localVersion, versionInfo, expectedResult) + * @return array + * (localVersion, versionInfo, expectedResult) */ public function securityUpdateDataProvider() { $data = array(); diff --git a/tests/phpunit/CiviTest/AuthorizeNet.php b/tests/phpunit/CiviTest/AuthorizeNet.php index 9c05fcddd5..82432f9bf5 100644 --- a/tests/phpunit/CiviTest/AuthorizeNet.php +++ b/tests/phpunit/CiviTest/AuthorizeNet.php @@ -37,7 +37,8 @@ class AuthorizeNet extends PHPUnit_Framework_Testcase { * @param int $id * Id of the PayPal Pro payment processor. * to be deleted - * @return boolean true if payment processor deleted, false otherwise + * @return boolean + * true if payment processor deleted, false otherwise * */ public function delete($id) { diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index ee1879b92c..e67be0b40a 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -651,7 +651,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @param string $field * Selector. * @param string $contactType - * @return array of contact attributes (id, names, email) + * @return array + * of contact attributes (id, names, email) */ public function createDialogContact($field = 'contact_id', $contactType = 'Individual') { $selectId = 's2id_' . $this->getAttribute($field . '@id'); @@ -741,7 +742,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @url string url to parse or retrieve current url if null * * @param null $url - * @return array returns an associative array containing any of the various components + * @return array + * returns an associative array containing any of the various components * of the URL that are present. Querystring elements are returned in sub-array (elements.queryString) * http://php.net/manual/en/function.parse-url.php */ @@ -1036,7 +1038,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @param bool $membershipsRequired * @internal param \can $User define pageTitle, hash and rand values for later data verification * - * @return null $pageId of newly created online contribution page. + * @return null + * of newly created online contribution page. */ function webtestAddContributionPage( $hash = NULL, diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index b892ad0449..930f6130b1 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -250,7 +250,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * @param bool $perClass * @param null $object - * @return bool TRUE if the populate logic runs; FALSE if it is skipped + * @return bool + * TRUE if the populate logic runs; FALSE if it is skipped */ protected static function _populateDB($perClass = FALSE, &$object = NULL) { @@ -1065,7 +1066,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * so the distinction between set * up & tested functions is clearer * - * @return array api Result + * @return array + * api Result */ public function createTestEntity() { return $entity = $this->callAPISuccess($this->entity, 'create', $this->params); @@ -1077,7 +1079,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array parameters for civicrm_contact_add api function call * @param int sequence number if creating multiple organizations * - * @return int id of Organisation created + * @return int + * id of Organisation created */ public function organizationCreate($params = array(), $seq = 0) { if (!$params) { @@ -1093,7 +1096,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array parameters for civicrm_contact_add api function call * @param int sequence number if creating multiple individuals * - * @return int id of Individual created + * @return int + * id of Individual created */ public function individualCreate($params = array(), $seq = 0) { $params = array_merge($this->sampleContact('Individual', $seq), $params); @@ -1106,7 +1110,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array parameters for civicrm_contact_add api function call * @param int sequence number if creating multiple households * - * @return int id of Household created + * @return int + * id of Household created */ public function householdCreate($params = array(), $seq = 0) { $params = array_merge($this->sampleContact('Household', $seq), $params); @@ -1119,7 +1124,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param enum contact type: Individual, Organization * @param int sequence number for the values of this type * - * @return array properties of sample contact (ie. $params for API call) + * @return array + * properties of sample contact (ie. $params for API call) */ public function sampleContact($contact_type, $seq = 0) { $samples = array( @@ -1164,7 +1170,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @throws Exception * - * @return int id of Household created + * @return int + * id of Household created */ private function _contactCreate($params) { $result = $this->callAPISuccess('contact', 'create', $params); @@ -1371,7 +1378,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array $params * Array of contact id and event id values. * - * @return int $id of participant created + * @return int + * $id of participant created */ public function participantCreate($params) { if (empty($params['contact_id'])) { @@ -1398,7 +1406,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Create Payment Processor * - * @return object of Payment Processsor + * @return object + * of Payment Processsor */ public function processorCreate() { $processorParams = array( @@ -1420,7 +1429,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Create contribution page * * @param array $params - * @return object of contribution page + * @return object + * of contribution page */ public function contributionPageCreate($params) { $this->_pageParams = array( @@ -1442,7 +1452,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Create Tag * * @param array $params - * @return array result of created tag + * @return array + * result of created tag */ public function tagCreate($params = array()) { $defaults = array( @@ -1488,7 +1499,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param int $cID * Contact_id. * - * @return int id of created contribution + * @return int + * id of created contribution */ public function pledgeCreate($cID) { $params = array( @@ -1534,7 +1546,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param int $trxnID * @param int $paymentInstrumentID * @param bool $isFee - * @return int id of created contribution + * @return int + * id of created contribution */ public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) { $params = array( @@ -1570,7 +1583,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param int $invoiceID * @param int $trxnID - * @return int id of created contribution + * @return int + * id of created contribution */ public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) { $contribParams = array( @@ -1610,7 +1624,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array $params * Name-value pair for an event. * - * @return array $event + * @return array */ public function eventCreate($params = array()) { // if no contact was passed, make up a dummy event creator @@ -1678,7 +1692,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param int $participantID * @param int $contributionID - * @return int $id of created payment + * @return int + * $id of created payment */ public function participantPaymentCreate($participantID, $contributionID = NULL) { //Create Participant Payment record With Values @@ -1707,7 +1722,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Add a Location * * @param int $contactID - * @return int location id of created location + * @return int + * location id of created location */ public function locationAdd($contactID) { $address = array( @@ -1784,7 +1800,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Add a Group * * @param array $params - * @return int groupId of created group + * @return int + * groupId of created group */ public function groupCreate($params = array()) { $params = array_merge(array( @@ -1811,7 +1828,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @params array to add group * * @param array $params - * @return int groupId of created group + * @return int + * groupId of created group */ public function groupContactCreate($groupID, $totalCount = 10) { $params = array('group_id' => $groupID); @@ -1866,7 +1884,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Add a UF Join Entry * * @param array $params - * @return int $id of created UF Join + * @return int + * $id of created UF Join */ public function ufjoinCreate($params = NULL) { if ($params === NULL) { @@ -2096,7 +2115,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param string $filename * $file __FILE__. * - * @return array $ids ids of created objects + * @return array + * ids of created objects */ public function entityCustomGroupWithSingleFieldCreate($function, $filename) { $params = array('title' => $function); @@ -2165,7 +2185,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Create note * * @param int $cId - * @return array $note + * @return array */ public function noteCreate($cId) { $params = array( @@ -2703,7 +2723,7 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) * Generate a temporary folder * * @param string $prefix - * @return string $string + * @return string */ public function createTempDir($prefix = 'test-') { $tempDir = CRM_Utils_File::tempdir($prefix); diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php index 8f0115d469..b43c490db9 100644 --- a/tests/phpunit/CiviTest/Contact.php +++ b/tests/phpunit/CiviTest/Contact.php @@ -10,7 +10,8 @@ class Contact extends CiviUnitTestCase { * * @param array $params * - * @return int $contactID id of created contact + * @return int + * $contactID id of created contact */ public static function create($params) { require_once "CRM/Contact/BAO/Contact.php"; @@ -23,7 +24,8 @@ class Contact extends CiviUnitTestCase { * a contact of type Individual * * @param array $params - * @return int $contactID id of created Individual + * @return int + * $contactID id of created Individual */ public static function createIndividual($params = NULL) { //compose the params, when not passed @@ -87,7 +89,8 @@ class Contact extends CiviUnitTestCase { * * @param int $contactID * Id of the contact to delete. - * @return boolean true if contact deleted, false otherwise + * @return boolean + * true if contact deleted, false otherwise */ public static function delete($contactID) { require_once 'CRM/Contact/BAO/Contact.php'; diff --git a/tests/phpunit/CiviTest/ContributionPage.php b/tests/phpunit/CiviTest/ContributionPage.php index 0787305ef3..3f600ebe8e 100644 --- a/tests/phpunit/CiviTest/ContributionPage.php +++ b/tests/phpunit/CiviTest/ContributionPage.php @@ -44,7 +44,8 @@ class ContributionPage extends PHPUnit_Framework_Testcase { * @param int $contributionPageId * Id of the Contribution Page. * to be deleted - * @return boolean true if Contribution Page deleted, false otherwise + * @return boolean + * true if Contribution Page deleted, false otherwise */ public static function delete($contributionPageId) { require_once "CRM/Contribute/DAO/ContributionPage.php"; diff --git a/tests/phpunit/CiviTest/Custom.php b/tests/phpunit/CiviTest/Custom.php index 73a70de32c..699efaa876 100644 --- a/tests/phpunit/CiviTest/Custom.php +++ b/tests/phpunit/CiviTest/Custom.php @@ -13,7 +13,8 @@ class Custom extends CiviUnitTestCase { * @param null $extends * @param bool $isMultiple * - * @return object of created group + * @return object + * of created group */ public static function createGroup($group, $extends = NULL, $isMultiple = FALSE) { if (empty($group)) { @@ -63,7 +64,8 @@ class Custom extends CiviUnitTestCase { * @deprecated use parent object create fn * @param array $params * @param null $fields - * @return object of created field + * @return object + * of created field */ public static function createField($params, $fields = NULL) { if (empty($params)) { @@ -110,7 +112,8 @@ class Custom extends CiviUnitTestCase { * Helper function to delete custom group * @deprecated use function on parent class * @param object Custom Group to delete - * @return boolean true if Group deleted, false otherwise + * @return boolean + * true if Group deleted, false otherwise */ public static function deleteGroup($params) { require_once 'CRM/Core/BAO/CustomGroup.php'; diff --git a/tests/phpunit/CiviTest/Event.php b/tests/phpunit/CiviTest/Event.php index e29721d0bf..840a49be92 100644 --- a/tests/phpunit/CiviTest/Event.php +++ b/tests/phpunit/CiviTest/Event.php @@ -36,7 +36,8 @@ class Event extends PHPUnit_Framework_Testcase { * Helper function to delete an Event * * @param int $eventId - * @return boolean true if event deleted, false otherwise + * @return boolean + * true if event deleted, false otherwise */ public static function delete($eventId) { return CRM_Event_BAO_Event::del($eventId); diff --git a/tests/phpunit/CiviTest/PCP.php b/tests/phpunit/CiviTest/PCP.php index 5abd17485d..5391b3842a 100644 --- a/tests/phpunit/CiviTest/PCP.php +++ b/tests/phpunit/CiviTest/PCP.php @@ -10,7 +10,8 @@ class PCPBlock extends PHPUnit_Framework_Testcase { * @param int $contributionPageId * Id of the Contribution Page. * to be deleted - * @return array of created pcp block + * @return array + * of created pcp block * */ public function create($contributionPageId) { @@ -94,7 +95,8 @@ class PCPBlock extends PHPUnit_Framework_Testcase { * @param array key value pair * pcpBlockId - id of the PCP Block Id, profileID - id of Supporter Profile * to be deleted - * @return boolean true if success, false otherwise + * @return boolean + * true if success, false otherwise * */ public function delete($params) { diff --git a/tests/phpunit/CiviTest/Participant.php b/tests/phpunit/CiviTest/Participant.php index 6b845b6838..fdb0ffea6d 100644 --- a/tests/phpunit/CiviTest/Participant.php +++ b/tests/phpunit/CiviTest/Participant.php @@ -34,7 +34,8 @@ class Participant extends PHPUnit_Framework_Testcase { * Helper function to delete a participant * * @param int $participantId - * @return boolean true if participant deleted, false otherwise + * @return boolean + * true if participant deleted, false otherwise */ public static function delete($participantId) { require_once 'CRM/Event/BAO/Participant.php'; diff --git a/tests/phpunit/CiviTest/PaypalPro.php b/tests/phpunit/CiviTest/PaypalPro.php index 1ce658b814..b150a26edd 100644 --- a/tests/phpunit/CiviTest/PaypalPro.php +++ b/tests/phpunit/CiviTest/PaypalPro.php @@ -9,7 +9,8 @@ class PaypalPro extends PHPUnit_Framework_Testcase { * Helper function to create * a payment processor of type Paypal Pro * - * @return int $paymentProcessor id of created payment processor@todo this appears not to be working but because it doesn't extend the test class + * @return int + * $paymentProcessor id of created payment processor@todo this appears not to be working but because it doesn't extend the test class * callAPISuccess won't work * I have duplicated this on the main test class as a work around */ @@ -44,7 +45,8 @@ class PaypalPro extends PHPUnit_Framework_Testcase { * @param int $id * Id of the PayPal Pro payment processor. * to be deleted - * @return boolean true if payment processor deleted, false otherwise + * @return boolean + * true if payment processor deleted, false otherwise */ public static function delete($id) { $pp = new CRM_Financial_DAO_PaymentProcessor(); diff --git a/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php b/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php index 83571a1775..9e27ca27ba 100644 --- a/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php @@ -74,7 +74,8 @@ class WebTest_Contribute_UpdatePendingContributionTest extends CiviSeleniumTestC } /** - * @return array of contact details + * @return array + * of contact details */ public function _testOfflineContribution() { // Create a contact to be used as soft creditor diff --git a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php index 5dbf2928d8..38290e4bee 100644 --- a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php @@ -41,7 +41,8 @@ class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { * @param string $downloadDir * Download dir. * - * @return string downloaded file path. + * @return string + * downloaded file path. */ public function downloadCSV($selector, $fileName = 'CiviCRM_Contact_Search.csv', $downloadDir = '/tmp') { // File download path. diff --git a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php index 9f2a544308..bfe9aa3a97 100644 --- a/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Import/ImportCiviSeleniumTestCase.php @@ -435,7 +435,8 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { * @param string $component * Component name. * - * @return string import url + * @return string + * import url */ private function _getImportComponentUrl($component) { $importComponentUrl = array( @@ -523,7 +524,8 @@ class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase { * @param array $rows * @param string $contactType * - * @return array $contactIds imported contact ids + * @return array + * imported contact ids */ public function _getImportedContactIds($rows, $contactType = 'Individual') { $contactIds = array(); diff --git a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php index 4ec33e068d..36c30890c5 100644 --- a/tests/phpunit/WebTest/Import/MatchExternalIdTest.php +++ b/tests/phpunit/WebTest/Import/MatchExternalIdTest.php @@ -239,7 +239,8 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { * @param string $lastName * @param int $externalId * - * @return int external id + * @return int + * external id */ public function _addContact($firstName, $lastName, $externalId) { $this->openCiviPage('contact/add', 'reset=1&ct=Individual'); @@ -266,7 +267,8 @@ class WebTest_Import_MatchExternalIdTest extends ImportCiviSeleniumTestCase { * * @param array $params * - * @return array event details of newly created event + * @return array + * event details of newly created event */ public function _addNewEvent($params = array()) { if (empty($params)) { diff --git a/tests/phpunit/WebTest/Import/ParticipantTest.php b/tests/phpunit/WebTest/Import/ParticipantTest.php index a06ddbf469..9fe59ae662 100644 --- a/tests/phpunit/WebTest/Import/ParticipantTest.php +++ b/tests/phpunit/WebTest/Import/ParticipantTest.php @@ -240,7 +240,8 @@ class WebTest_Import_ParticipantTest extends ImportCiviSeleniumTestCase { * @param array $params * Parameters to create an event. * - * @return array $params event details of newly created event + * @return array + * event details of newly created event */ public function _addNewEvent($params = array()) { diff --git a/tests/phpunit/api/v3/APIStandardsTest.php b/tests/phpunit/api/v3/APIStandardsTest.php index f6ce61eb3d..3fdaaef263 100644 --- a/tests/phpunit/api/v3/APIStandardsTest.php +++ b/tests/phpunit/api/v3/APIStandardsTest.php @@ -124,7 +124,8 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { /** * Get all the files in the API directory for the relevant version which contain API functions - * @return array $files array of php files in the directory excluding helper files + * @return array + * array of php files in the directory excluding helper files */ public function getAllFilesinAPIDir() { $files = array(); @@ -157,7 +158,7 @@ class api_v3_APIStandardsTest extends CiviUnitTestCase { /** * Get all api exposed functions that are expected to conform to standards - * @return array $functionlist + * @return array */ public function getAllAPIStdFunctions() { $functionlist = get_defined_functions(); diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index b3d310cc4c..8e8fdcab12 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -218,7 +218,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { * * @param bool $sequential * - * @return array Entities that cannot be retrieved by ID + * @return array + * Entities that cannot be retrieved by ID */ public static function toBeSkipped_getByID($sequential = FALSE) { return array('MailingContact'); @@ -278,7 +279,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { /** * Generate list of entities to test for get by id functions * @param bool $sequential - * @return array Entities to be skipped + * @return array + * Entities to be skipped */ public static function toBeSkipped_automock($sequential = FALSE) { $entitiesWithoutGet = array('MailingContact', 'EntityTag', 'Participant', 'ParticipantPayment', 'Setting', 'SurveyRespondant', 'MailingRecipients', 'CustomSearch', 'Extension', 'ReportTemplate', 'System'); diff --git a/tests/phpunit/api/v3/UtilsTest.php b/tests/phpunit/api/v3/UtilsTest.php index a4fa635039..e07a0d83f0 100644 --- a/tests/phpunit/api/v3/UtilsTest.php +++ b/tests/phpunit/api/v3/UtilsTest.php @@ -107,7 +107,8 @@ class api_v3_UtilsTest extends CiviUnitTestCase { * * @throws API_Exception * @throws Exception - * @return bool TRUE or FALSE depending on the outcome of the authorization check + * @return bool + * TRUE or FALSE depending on the outcome of the authorization check */ public function runPermissionCheck($entity, $action, $params, $throws = FALSE) { $dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher(); -- 2.25.1