From 72b3a70c5e7890c69dd70bf00092e1217c5f15b7 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sat, 10 Jan 2015 14:27:30 -0500 Subject: [PATCH] INFRA-132 - Docblock @param and @return tag fixes --- CRM/ACL/BAO/ACL.php | 3 +- CRM/Activity/BAO/Activity.php | 8 ++-- CRM/Activity/Form/Activity.php | 3 +- CRM/Admin/Form/ContactType.php | 3 +- CRM/Admin/Form/Extensions.php | 3 +- CRM/Admin/Form/ScheduleReminders.php | 3 +- CRM/Admin/Form/Setting/Component.php | 3 +- CRM/Admin/Form/Setting/Mapping.php | 3 +- CRM/Admin/Form/Setting/Miscellaneous.php | 3 +- CRM/Batch/BAO/Batch.php | 24 ++++++------ CRM/Campaign/BAO/Campaign.php | 3 +- CRM/Campaign/BAO/Survey.php | 3 +- CRM/Case/BAO/Case.php | 27 +++++++------ CRM/Case/BAO/CaseType.php | 3 +- CRM/Case/Form/Activity.php | 3 +- CRM/Case/XMLRepository.php | 3 +- CRM/Contact/BAO/Contact.php | 12 ++++-- CRM/Contact/BAO/Contact/Location.php | 3 +- CRM/Contact/BAO/Contact/Utils.php | 5 ++- CRM/Contact/BAO/ContactType.php | 4 +- CRM/Contact/BAO/Group.php | 8 ++-- CRM/Contact/BAO/GroupOrganization.php | 3 +- CRM/Contact/BAO/Query.php | 5 ++- CRM/Contact/BAO/Relationship.php | 3 +- CRM/Contact/Form/Contact.php | 9 +++-- CRM/Contact/Form/Edit/Address.php | 3 +- .../Form/Edit/CommunicationPreferences.php | 3 +- CRM/Contact/Form/Edit/Household.php | 3 +- CRM/Contact/Form/Edit/Lock.php | 3 +- CRM/Contact/Form/Inline/Lock.php | 3 +- CRM/Contact/Form/Relationship.php | 3 +- CRM/Contact/Form/Task/Batch.php | 3 +- CRM/Contact/Form/Task/Delete.php | 3 +- CRM/Contact/Form/Task/EmailCommon.php | 3 +- CRM/Contact/Form/Task/PDFLetterCommon.php | 3 +- CRM/Contact/Form/Task/ProximityCommon.php | 3 +- CRM/Contact/Form/Task/SMSCommon.php | 3 +- CRM/Contact/Page/CustomSearch.php | 3 +- CRM/Contact/Page/SavedSearch.php | 3 +- CRM/Contribute/BAO/Contribution.php | 12 ++++-- CRM/Contribute/BAO/ContributionPage.php | 2 +- CRM/Contribute/Form/Contribution.php | 3 +- CRM/Contribute/Form/Contribution/Confirm.php | 2 - CRM/Contribute/Form/Contribution/Main.php | 3 +- .../Form/ContributionPage/Amount.php | 3 +- .../Form/ContributionPage/Custom.php | 3 +- .../Form/ContributionPage/Premium.php | 3 +- .../Form/ContributionPage/ThankYou.php | 3 +- .../Form/ContributionPage/Widget.php | 3 +- CRM/Contribute/Form/ManagePremiums.php | 6 ++- CRM/Contribute/Form/UpdateBilling.php | 3 +- CRM/Contribute/Info.php | 15 ++++--- CRM/Core/BAO/ActionLog.php | 2 +- CRM/Core/BAO/Address.php | 3 +- CRM/Core/BAO/CMSUser.php | 12 +++--- CRM/Core/BAO/CustomField.php | 5 ++- CRM/Core/BAO/CustomGroup.php | 3 -- CRM/Core/BAO/CustomValue.php | 8 ++-- CRM/Core/BAO/CustomValueTable.php | 5 +-- CRM/Core/BAO/Dashboard.php | 2 - CRM/Core/BAO/Domain.php | 2 +- CRM/Core/BAO/File.php | 3 +- CRM/Core/BAO/Mapping.php | 3 +- CRM/Core/BAO/Navigation.php | 3 +- CRM/Core/BAO/Note.php | 3 +- CRM/Core/BAO/RecurringEntity.php | 6 +-- CRM/Core/BAO/SchemaHandler.php | 3 +- CRM/Core/BAO/Setting.php | 3 +- CRM/Core/BAO/UFField.php | 6 ++- CRM/Core/BAO/UFGroup.php | 10 ++--- CRM/Core/BAO/UFMatch.php | 6 +-- CRM/Core/BAO/Website.php | 1 - CRM/Core/BAO/WordReplacement.php | 6 +-- CRM/Core/CodeGen/Config.php | 3 +- CRM/Core/CommunityMessages.php | 3 +- CRM/Core/Component/Info.php | 39 ++++++++++++------- CRM/Core/Config.php | 3 +- CRM/Core/DAO.php | 15 ++++--- CRM/Core/Form.php | 2 +- CRM/Core/Form/Tag.php | 1 - CRM/Core/JobManager.php | 3 +- CRM/Core/ManagedEntities.php | 10 +++-- CRM/Core/Payment/AuthorizeNet.php | 3 +- CRM/Core/Payment/BaseIPN.php | 4 +- CRM/Core/Payment/PayJunction.php | 3 +- CRM/Core/Payment/PayPalProIPN.php | 6 ++- CRM/Core/Payment/Realex.php | 3 +- CRM/Core/Permission/Base.php | 3 +- CRM/Core/PseudoConstant.php | 5 ++- CRM/Core/Report/Excel.php | 3 +- CRM/Core/Resources.php | 3 +- CRM/Core/Session.php | 3 +- CRM/Core/State.php | 6 ++- CRM/Custom/Form/Group.php | 3 +- CRM/Dashlet/Page/Blog.php | 3 +- CRM/Dedupe/BAO/Rule.php | 3 +- CRM/Event/BAO/Event.php | 3 +- CRM/Event/BAO/Participant.php | 9 +++-- CRM/Event/Form/ManageEvent/Registration.php | 3 +- CRM/Event/Form/Registration.php | 11 ++++-- .../Registration/AdditionalParticipant.php | 3 +- CRM/Event/Form/Registration/Register.php | 3 +- CRM/Export/Form/Select.php | 3 +- CRM/Extension/Downloader.php | 3 +- CRM/Financial/BAO/FinancialAccount.php | 16 ++++---- CRM/Friend/BAO/Friend.php | 3 +- CRM/Friend/Form.php | 3 +- CRM/Mailing/BAO/Mailing.php | 2 - CRM/Mailing/BAO/Spool.php | 23 +++++------ CRM/Mailing/Event/BAO/Queue.php | 3 +- CRM/Mailing/Event/BAO/Reply.php | 3 +- CRM/Mailing/Event/BAO/Resubscribe.php | 3 +- CRM/Mailing/Event/BAO/Subscribe.php | 6 ++- CRM/Mailing/Event/BAO/Unsubscribe.php | 3 +- CRM/Mailing/Form/Component.php | 3 +- CRM/Mailing/Form/Upload.php | 3 +- CRM/Member/BAO/Membership.php | 17 ++++---- CRM/Member/Form/Membership.php | 3 +- CRM/Member/Form/MembershipBlock.php | 3 +- CRM/Member/Form/MembershipRenewal.php | 3 +- CRM/Member/Form/MembershipType.php | 3 +- CRM/Member/Form/MembershipView.php | 3 +- CRM/Member/Info.php | 15 ++++--- CRM/PCP/BAO/PCP.php | 6 ++- CRM/PCP/Form/Campaign.php | 3 +- CRM/PCP/Form/Contribute.php | 3 +- CRM/PCP/Form/Event.php | 3 +- CRM/PCP/Form/PCPAccount.php | 3 +- CRM/Pledge/BAO/PledgePayment.php | 19 +++++---- CRM/Pledge/Form/Pledge.php | 3 +- CRM/Pledge/Info.php | 15 ++++--- CRM/Price/BAO/LineItem.php | 3 +- CRM/Price/BAO/PriceSet.php | 11 +++--- CRM/Price/Form/Set.php | 3 +- CRM/Profile/Form.php | 3 +- CRM/Profile/Form/Dynamic.php | 3 +- CRM/Report/BAO/ReportInstance.php | 3 +- CRM/Report/Info.php | 18 ++++++--- CRM/SMS/Form/Upload.php | 3 +- CRM/UF/Form/Group.php | 3 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 18 +++++---- CRM/Utils/Cache/Interface.php | 3 +- CRM/Utils/Date.php | 6 ++- CRM/Utils/DeprecatedUtils.php | 10 +++-- CRM/Utils/Hook.php | 9 +++-- CRM/Utils/ICalendar.php | 6 ++- CRM/Utils/JSON.php | 3 +- CRM/Utils/OptionBag.php | 6 ++- CRM/Utils/PseudoConstant.php | 3 +- CRM/Utils/REST.php | 3 +- CRM/Utils/Sort.php | 2 +- CRM/Utils/String.php | 3 +- CRM/Utils/System.php | 3 +- CRM/Utils/System/Base.php | 6 ++- CRM/Utils/System/Drupal.php | 7 ++-- CRM/Utils/System/Drupal6.php | 9 ++--- CRM/Utils/System/Drupal8.php | 9 ++--- CRM/Utils/System/DrupalBase.php | 6 ++- CRM/Utils/System/Joomla.php | 15 +++---- CRM/Utils/System/UnitTests.php | 5 +-- CRM/Utils/System/WordPress.php | 17 ++++---- CRM/Utils/Token.php | 7 ++-- Civi/CiUtil/Command/AntagonistCommand.php | 15 +++---- Civi/CiUtil/PHPUnitParser.php | 3 +- api/Wrapper.php | 12 +++--- api/v3/Acl.php | 6 +-- api/v3/AclRole.php | 6 +-- api/v3/ActionSchedule.php | 2 +- api/v3/Activity.php | 6 +-- api/v3/ActivityContact.php | 6 +-- api/v3/ActivityType.php | 8 ++-- api/v3/Address.php | 6 +-- api/v3/Attachment.php | 8 ++-- api/v3/Batch.php | 6 +-- api/v3/Campaign.php | 6 +-- api/v3/Case.php | 12 +++--- api/v3/CaseType.php | 6 +-- api/v3/Constant.php | 2 +- api/v3/Contact.php | 10 ++--- api/v3/ContactType.php | 6 +-- api/v3/Contribution.php | 12 +++--- api/v3/ContributionPage.php | 8 ++-- api/v3/ContributionRecur.php | 8 ++-- api/v3/ContributionSoft.php | 6 +-- api/v3/Country.php | 6 +-- api/v3/CustomGroup.php | 4 +- api/v3/CustomSearch.php | 6 +-- api/v3/CustomValue.php | 2 +- api/v3/Dashboard.php | 2 +- api/v3/Email.php | 6 +-- api/v3/Entity.php | 2 +- api/v3/EntityTag.php | 4 +- api/v3/Event.php | 6 +-- api/v3/Extension.php | 18 ++++----- api/v3/File.php | 8 ++-- api/v3/FinancialAccount.php | 6 +-- api/v3/FinancialType.php | 6 +-- api/v3/Generic.php | 16 ++++---- api/v3/Generic/Getactions.php | 2 +- api/v3/Generic/Getlist.php | 2 +- api/v3/Generic/Setvalue.php | 2 +- api/v3/Grant.php | 6 +-- api/v3/Group.php | 6 +-- api/v3/GroupContact.php | 14 +++---- api/v3/GroupNesting.php | 6 +-- api/v3/GroupOrganization.php | 4 +- api/v3/Im.php | 6 +-- api/v3/Job.php | 38 +++++++++--------- api/v3/LineItem.php | 6 +-- api/v3/LocBlock.php | 6 +-- api/v3/LocationType.php | 6 +-- api/v3/MailSettings.php | 6 +-- api/v3/Mailing.php | 6 +-- api/v3/MailingAB.php | 4 +- api/v3/MailingComponent.php | 6 +-- api/v3/MailingContact.php | 4 +- api/v3/MailingEventConfirm.php | 2 +- api/v3/MailingEventQueue.php | 2 +- api/v3/MailingEventResubscribe.php | 2 +- api/v3/MailingEventSubscribe.php | 2 +- api/v3/MailingEventUnsubscribe.php | 2 +- api/v3/MailingGroup.php | 2 +- api/v3/MailingJob.php | 2 +- api/v3/MailingRecipients.php | 2 +- api/v3/Membership.php | 10 ++--- api/v3/MembershipBlock.php | 6 +-- api/v3/MembershipPayment.php | 4 +- api/v3/MembershipStatus.php | 10 ++--- api/v3/MembershipType.php | 6 +-- api/v3/MessageTemplate.php | 4 +- api/v3/Note.php | 6 +-- api/v3/OptionGroup.php | 4 +- api/v3/OptionValue.php | 6 +-- api/v3/Participant.php | 4 +- api/v3/ParticipantPayment.php | 6 +-- api/v3/ParticipantStatusType.php | 6 +-- api/v3/PaymentProcessor.php | 6 +-- api/v3/PaymentProcessorType.php | 4 +- api/v3/Phone.php | 4 +- api/v3/Phone/Get.php | 2 +- api/v3/Pledge.php | 6 +-- api/v3/PledgePayment.php | 8 ++-- api/v3/Premium.php | 6 +-- api/v3/PriceField.php | 6 +-- api/v3/PriceFieldValue.php | 6 +-- api/v3/PriceSet.php | 6 +-- api/v3/PrintLabel.php | 6 +-- api/v3/Product.php | 6 +-- api/v3/Profile.php | 12 +++--- api/v3/Relationship.php | 6 +-- api/v3/RelationshipType.php | 4 +- api/v3/ReportInstance.php | 6 +-- api/v3/ReportTemplate.php | 10 ++--- api/v3/Setting.php | 6 +-- api/v3/SmsProvider.php | 6 +-- api/v3/Survey.php | 6 +-- api/v3/SurveyRespondant.php | 4 +- api/v3/System.php | 4 +- api/v3/Tag.php | 6 +-- api/v3/UFField.php | 8 ++-- api/v3/UFGroup.php | 6 +-- api/v3/UFJoin.php | 4 +- api/v3/UFMatch.php | 4 +- api/v3/Website.php | 6 +-- api/v3/WordReplacement.php | 2 +- api/v3/utils.php | 13 ++++--- tests/phpunit/CRM/Core/ResourcesTest.php | 6 +-- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 11 +++--- tests/phpunit/CiviTest/CiviTestSuite.php | 6 +-- tests/phpunit/CiviTest/Contact.php | 6 ++- tests/phpunit/CiviTest/ContributionPage.php | 3 +- tests/phpunit/CiviTest/Event.php | 3 +- tests/phpunit/CiviTest/Participant.php | 3 +- tests/phpunit/Utils.php | 10 ++--- 274 files changed, 897 insertions(+), 695 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index c4aed716cd..aafedb4b31 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -328,7 +328,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * @param array $tables * Tables that will be needed in the FROM. * - * @return string|null - WHERE-style clause to filter results, + * @return string|null + * WHERE-style clause to filter results, * or null if $table or $id is null * @static */ diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 02bda6fb35..016e0ebaf6 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -144,7 +144,6 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { * Delete the activity * * @param array $params - * Associated array. * @param bool $moveToTrash * * @return void @@ -1513,7 +1512,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * The activity ID that tracks the message. * @param int $userID * - * @return mixed true on success or PEAR_Error object + * @return bool|PEAR_Error + * true on success or PEAR_Error object * @static */ static function sendSMSMessage( @@ -2108,7 +2108,8 @@ AND cl.modified_id = c.id * Activity id. * @param string $crmDir * - * @return string|bool if file exists returns $activityTypeFile activity filename otherwise false. + * @return string|bool + * if file exists returns $activityTypeFile activity filename otherwise false. * * @static */ @@ -2140,7 +2141,6 @@ AND cl.modified_id = c.id * Restore the activity * * @param array $params - * Associated array. * * @return void */ diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index bbecf8f4dc..b10b90cb23 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -828,7 +828,8 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { * The uploaded files if any. * @param $self * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Admin/Form/ContactType.php b/CRM/Admin/Form/ContactType.php index bf6a2f4d39..b8597e961b 100644 --- a/CRM/Admin/Form/ContactType.php +++ b/CRM/Admin/Form/ContactType.php @@ -90,7 +90,8 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { * @param $files * @param $self * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Admin/Form/Extensions.php b/CRM/Admin/Form/Extensions.php index 9f786e3106..c7d142ea70 100644 --- a/CRM/Admin/Form/Extensions.php +++ b/CRM/Admin/Form/Extensions.php @@ -157,7 +157,8 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { * @param array $self * This object. * - * @return true if no errors, else an array of errors + * @return bool|array + * true if no errors, else an array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php index ffef831dcb..2db0d71dde 100644 --- a/CRM/Admin/Form/ScheduleReminders.php +++ b/CRM/Admin/Form/ScheduleReminders.php @@ -268,7 +268,8 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { * @param array $fields * The input form values. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Admin/Form/Setting/Component.php b/CRM/Admin/Form/Setting/Component.php index f68b7fbca3..61326fb8a3 100644 --- a/CRM/Admin/Form/Setting/Component.php +++ b/CRM/Admin/Form/Setting/Component.php @@ -74,7 +74,8 @@ class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting { * @param array $options * Additional user data. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $options) { diff --git a/CRM/Admin/Form/Setting/Mapping.php b/CRM/Admin/Form/Setting/Mapping.php index f0e8d00fbd..c5e7ad2966 100644 --- a/CRM/Admin/Form/Setting/Mapping.php +++ b/CRM/Admin/Form/Setting/Mapping.php @@ -63,7 +63,8 @@ class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting { * @param array $fields * The input form values. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields) { diff --git a/CRM/Admin/Form/Setting/Miscellaneous.php b/CRM/Admin/Form/Setting/Miscellaneous.php index a078bc8963..4bff04c95f 100644 --- a/CRM/Admin/Form/Setting/Miscellaneous.php +++ b/CRM/Admin/Form/Setting/Miscellaneous.php @@ -126,7 +126,8 @@ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting { * @param array $options * Additional user data. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $options) { diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index 2b37cc3c33..b4779c6e4b 100755 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -53,7 +53,6 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * Create a new batch * * @param array $params - * Associated array. * @param array $ids * Associated array of ids. * @param string $context @@ -131,7 +130,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Generate batch name * - * @return batch name + * @return string + * batch name * @static */ public static function generateBatchName() { @@ -142,9 +142,9 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Create entity batch entry + * * @param array $params - * Associated array. - * @return batch array + * @return array */ public static function addBatchEntity(&$params) { $entityBatch = new CRM_Batch_DAO_EntityBatch(); @@ -156,7 +156,6 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Remove entries from entity batch * @param array $params - * Associated array. * @return CRM_Batch_DAO_EntityBatch */ public static function removeBatchEntity($params) { @@ -172,7 +171,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * @param int $batchId * Batch id. * - * @return void + * @return bool */ public static function deleteBatch($batchId) { // delete entry from batch table @@ -506,8 +505,7 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * Get batch list * * @return array - * array of all batches - * excluding batches with data entry in progress + * all batches excluding batches with data entry in progress */ public static function getBatches() { $dataEntryStatusId = CRM_Core_OptionGroup::getValue('batch_status', 'Data Entry', 'name'); @@ -553,8 +551,10 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Format markup for comparing two totals * - * @param $actual : calculated total - * @param $expected : user-entered total + * @param $actual + * calculated total + * @param $expected + * user-entered total * @return array */ public static function displayTotals($actual, $expected) { @@ -643,11 +643,11 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * * @param int $entityID * @param array $returnValues - * @param null $notPresent + * @param bool $notPresent * @param array $params * @param bool $getCount * - * @return Object + * @return CRM_Core_DAO */ public static function getBatchFinancialItems($entityID, $returnValues, $notPresent = NULL, $params = NULL, $getCount = FALSE) { if (!$getCount) { diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index a573d57c9e..72d6c717d3 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -153,7 +153,8 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * @param bool $appendDatesToTitle * @param bool $forceAll * - * @return mixed $campaigns a set of campaigns. + * @return mixed + * $campaigns a set of campaigns. * @access public */ public static function getCampaigns( diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index db05a07475..888a96cc27 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -808,7 +808,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * @param int $surveyId * @param bool $enclosedInUL * @param string $extraULName - * @return array|string $url array of permissioned links + * @return array|string + * $url array of permissioned links * @static */ public static function buildPermissionLinks($surveyId, $enclosedInUL = FALSE, $extraULName = 'more') { diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 408eef5d96..0631dc5bbb 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -1599,7 +1599,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $file * Email sent. * - * @return array|void $activity object of newly creted activity via email + * @return array|void + * $activity object of newly creted activity via email * @access public */ public static function recordActivityViaEmail($file) { @@ -1763,7 +1764,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $caseId * Id of the case to restore. * - * @return true if success. + * @return bool * @static */ public static function restoreCase($caseId) { @@ -1861,9 +1862,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param array $criteriaParams * Given criteria. * @param bool $latestDate - * If set newest or oldest date is selceted. + * If set newest or oldest date is selected. * - * @return returns case activities due dates + * @return array + * case activities due dates * * @static */ @@ -2059,7 +2061,7 @@ SELECT civicrm_contact.id as casemanager_id, * @param bool $excludeDeleted * * @return array - * of case and related data keyed on case id + * case and related data keyed on case id */ public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) { //params from ajax call. @@ -2187,7 +2189,7 @@ LEFT JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case * @param bool $excludeDeleted * Do not include deleted cases. * - * @return an array of cases. + * @return array */ public static function getContactCases($contactId, $excludeDeleted = TRUE) { $cases = array(); @@ -2230,7 +2232,7 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas * @param bool $excludeDeleted * Do not include deleted cases. * - * @return an array of related cases. + * @return array */ public static function getRelatedCases($mainCaseId, $contactId, $excludeDeleted = TRUE) { //FIXME : do check for permissions. @@ -3151,7 +3153,6 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Get all the case type ids currently in use * - * * @return array */ public static function getUsedCaseType() { @@ -3176,7 +3177,6 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Get all the case status ids currently in use * - * * @return array */ public static function getUsedCaseStatuses() { @@ -3197,6 +3197,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Get all the encounter medium ids currently in use + * * @return array */ public static function getUsedEncounterMediums() { @@ -3267,6 +3268,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Used during case component enablement and during ugprade + * + * @return bool */ public static function createCaseViews() { $errorScope = CRM_Core_TemporaryErrorScope::ignoreException(); @@ -3301,6 +3304,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Helper function, also used by the upgrade in case of error + * + * @return string */ public static function createCaseViewsQuery($section = 'upcoming') { $sql = ""; @@ -3398,9 +3403,9 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * * @param string $fieldName * @param string $context - * : @see CRM_Core_DAO::buildOptionsContext. + * @see CRM_Core_DAO::buildOptionsContext. * @param array $props - * : whatever is known about this dao object. + * Whatever is known about this dao object. * * @return Array|bool */ diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 71ddd9cc6e..ed332e294d 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -359,7 +359,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * Determine if the case-type has *both* DB and file-based definitions. * * @param int $caseTypeId - * @return bool|null TRUE if there are *both* DB and file-based definitions + * @return bool|null + * TRUE if there are *both* DB and file-based definitions */ public static function isForked($caseTypeId) { $caseTypeName = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name', 'id', TRUE); diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index f470d46bf6..cddb9da2de 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -361,7 +361,8 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { * The uploaded files if any. * @param $self * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php index b2111ec8ea..25eccaee8f 100644 --- a/CRM/Case/XMLRepository.php +++ b/CRM/Case/XMLRepository.php @@ -138,7 +138,8 @@ class CRM_Case_XMLRepository { /** * @param string $caseType - * @return null|string file path + * @return null|string + * file path */ public function findXmlFile($caseType) { // first check custom templates directory diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index ef699fa0c2..6553d54779 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -520,7 +520,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] * - entity_table: string, eg "civicrm_contact" * - entity_id: int - * @return array|NULL NULL if unavailable, or an array. array has keys: + * @return array|NULL + * NULL if unavailable, or an array. array has keys: * - path: string * - query: string * - title: string @@ -743,7 +744,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); * @param int $id * Id of the contact. * - * @return null|string display name of the contact if found + * @return null|string + * display name of the contact if found * @static */ public static function displayName($id) { @@ -2558,7 +2560,8 @@ AND civicrm_openid.is_primary = 1"; * @param string $tableName * Optional tableName if component is custom group. * - * @return total number of count of occurence in database + * @return int + * total number in database * @static */ public static function getCountComponent($component, $contactId, $tableName = NULL) { @@ -3114,7 +3117,8 @@ AND civicrm_openid.is_primary = 1"; * @param int $contactId * Contact id. * - * @return display name |null the found display name or null. + * @return string|null + * the found display name or null. * @static */ public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index d32bbf829f..e0fee6624b 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -125,7 +125,8 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id ) * @param int $locationTypeID * @param bool $imageUrlOnly * - * @return null|string display name of the contact if found + * @return null|string + * display name of the contact if found * @static */ public static function &getMapInfo($ids, $locationTypeID = NULL, $imageUrlOnly = FALSE) { diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index c7068f3b36..17754049aa 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -120,7 +120,8 @@ class CRM_Contact_BAO_Contact_Utils { * @param array $contactIds * Array of contact ids. * - * @return boolen true or false true if mix contact array else fale + * @return bool + * true if mix contact array else false * * @static */ @@ -259,7 +260,7 @@ WHERE id IN ( $idString ) * Contact id. * * @return int - * $locationCount max locations for the contact + * max locations for the contact * @static */ public static function maxLocations($contactId) { diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 74fc006e6d..5bfef30213 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -241,12 +241,12 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * retrieve subtype pairs with name as 'subtype-name' and 'label' as value * * @param array $contactType - * .. * @param bool $all * @param string $labelPrefix * @param bool $ignoreCache * - * @return list of subtypes with name as 'subtype-name' and 'label' as value + * @return array + * list of subtypes with name as 'subtype-name' and 'label' as value * @static */ public static function subTypePairs($contactType = NULL, $all = FALSE, $labelPrefix = '- ', $ignoreCache = FALSE) { diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index f991b47a89..0b09fd747b 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -351,7 +351,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $params * Associative array of parameters. * - * @return object|NULL The new group BAO (if created) + * @return CRM_Contact_BAO_Group|NULL + * The new group BAO (if created) * @static */ public static function &create(&$params) { @@ -533,7 +534,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $params * Associative array of parameters. * - * @return object|NULL The new group BAO (if created) + * @return CRM_Contact_BAO_Group|NULL + * The new group BAO (if created) * @static */ public static function createSmartGroup(&$params) { @@ -563,7 +565,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param bool $isActive * Value we want to set the is_active field. * - * @return Object + * @return CRM_Core_DAO * DAO object on sucess, NULL otherwise * @static */ diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 755105611f..be5bf524ac 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -145,7 +145,8 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio * @param int $groupOrganizationID * Group organization id that needs to be deleted. * - * @return mixed|null $results no of deleted group organization on success, false otherwise + * @return int|null + * no of deleted group organization on success, false otherwise * @access public */ public static function deleteGroupOrganization($groupOrganizationID) { diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 8933683827..34b8b4befa 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -5470,8 +5470,9 @@ AND displayRelType.is_active = 1 * @param string $dataType * The dataType we should check for the values, default integer. * - * @return bool|array if string does not match the patter - * array of numeric values if string does match the pattern + * @return bool|array + * false if string does not match the pattern + * array of numeric values if string does match the pattern * @static */ public static function parseSearchBuilderString($string, $dataType = 'Integer') { diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index fc4cfc78cc..719695e69d 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -1699,7 +1699,8 @@ AND cc.sort_name LIKE '%$name%'"; /** * Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired. * - * @return True on success, false if error is encountered. + * @return bool + * True on success, false if error is encountered. */ public static function disableExpiredRelationships() { $query = "SELECT id FROM civicrm_relationship WHERE is_active = 1 AND end_date < CURDATE()"; diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 19d52d4cf3..2b9d536322 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -1317,7 +1317,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $parseResult * An array of address blk instance and its status. * - * @return null|string $statusMsg string status message for all address blocks. + * @return null|string + * $statusMsg string status message for all address blocks. * @static */ public static function parseAddressStatusMsg($parseResult) { @@ -1349,7 +1350,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param int $number * number to convert in to ordinal number. * - * @return ordinal number for given number. + * @return string + * ordinal number for given number. * @static */ public static function ordinalNumber($number) { @@ -1386,7 +1388,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $deceasedParams * having contact id and deceased value. * - * @return null|string $updateMembershipMsg string status message for updated membership. + * @return null|string + * $updateMembershipMsg string status message for updated membership. */ public function updateMembershipStatus($deceasedParams) { $updateMembershipMsg = NULL; diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index c7aa121d1e..9702e7aeea 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -279,7 +279,8 @@ class CRM_Contact_Form_Edit_Address { * @param $files * @param $self * - * @return array|bool if no errors + * @return array|bool + * if no errors * * @static */ diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 7c88999b4d..8fe1f5d158 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -140,7 +140,8 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { * The uploaded files if any. * @param $self * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 814bb907a7..c65f064766 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -87,7 +87,8 @@ class CRM_Contact_Form_Edit_Household { * Unused. * @param int $contactID * - * @return array|bool $error + * @return array|bool + * $error * @static */ public static function formRule($fields, $files, $contactID = NULL) { diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index 0f6fe5861b..cc90e00866 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -60,7 +60,8 @@ class CRM_Contact_Form_Edit_Lock { * The uploaded files if any. * @param int $contactID * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $contactID = NULL) { diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 5ee0681d0c..253c373b5a 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -71,7 +71,8 @@ class CRM_Contact_Form_Inline_Lock { * The uploaded files if any. * @param int $contactID * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $contactID = NULL) { diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php index dbd0edf5b7..a32f421a64 100644 --- a/CRM/Contact/Form/Relationship.php +++ b/CRM/Contact/Form/Relationship.php @@ -559,7 +559,8 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function dateRule($params) { diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index 75f10ff0f8..cb53f82820 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -199,7 +199,8 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { * @param array $fields * The input form values. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields) { diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index 2c85b7e38a..d705aa93c5 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -188,7 +188,8 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { * @param object $self * Form object. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index 9907ea8f58..06a8da3243 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -326,7 +326,8 @@ class CRM_Contact_Form_Task_EmailCommon { * @param array $self * Additional values form 'this'. * - * @return TRUE if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors */ public static function formRule($fields, $dontCare, $self) { $errors = array(); diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index b6a6b55c51..439fd17f74 100644 --- a/CRM/Contact/Form/Task/PDFLetterCommon.php +++ b/CRM/Contact/Form/Task/PDFLetterCommon.php @@ -241,7 +241,8 @@ class CRM_Contact_Form_Task_PDFLetterCommon { * * @param CRM_Core_Form $form * - * @return array( $categories, $html_message, $messageToken, $returnProperties ) + * @return array + * [$categories, $html_message, $messageToken, $returnProperties] */ static protected function processMessageTemplate(&$form) { $formValues = $form->controller->exportValues($form->getName()); diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index fea9dbe3af..f44e083f6d 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -114,7 +114,8 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * The uploaded files if any. * @param CRM_Core_Form $form * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 23aa32eb7a..226eb2503c 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -310,7 +310,8 @@ class CRM_Contact_Form_Task_SMSCommon { * @param array $self * Additional values form 'this'. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors */ public static function formRule($fields, $dontCare, $self) { $errors = array(); diff --git a/CRM/Contact/Page/CustomSearch.php b/CRM/Contact/Page/CustomSearch.php index d48774d05d..001bfeb775 100644 --- a/CRM/Contact/Page/CustomSearch.php +++ b/CRM/Contact/Page/CustomSearch.php @@ -79,7 +79,8 @@ ORDER By v.weight /** * Browse all custom searches. * - * @return content of the parents run method + * @return mixed + * content of the parents run method */ public function browse() { $rows = self::info(); diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index ca861385a5..8e0da75bff 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -73,7 +73,8 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { /** * Browse all saved searches. * - * @return content of the parents run method + * @return mixed + * content of the parents run method */ public function browse() { $rows = array(); diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 6d83725bef..3b62110e10 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -771,7 +771,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * * @param int $id * - * @return mixed|null $results no of deleted Contribution on success, false otherwise + * @return mixed|null + * $results no of deleted Contribution on success, false otherwise * @access public * @static */ @@ -1018,7 +1019,8 @@ GROUP BY p.id * @param int $honorId * In Honor of Contact ID. * - * @return return the list of contribution fields + * @return array + * list of contribution fields * * @static */ @@ -1056,7 +1058,8 @@ GROUP BY p.id * @param int $id * Id of the contribution. * - * @return null|string sort name of the contact if found + * @return null|string + * sort name of the contact if found * @static */ public static function sortName($id) { @@ -1254,7 +1257,8 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont * An associated array. * @param int $billingLocationTypeID * - * @return address id + * @return int + * address id * @static */ public static function createAddress(&$params, $billingLocationTypeID) { diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 77729652e3..5745ad5e35 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -623,7 +623,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio * @param int $id * The contribution page id to copy. * - * @return the copy object + * @return CRM_Contribute_DAO_ContributionPage * @static */ public static function copy($id) { diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 7f762ea420..ba2456d79d 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -942,7 +942,8 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index 790b23d291..70a894aaba 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -1738,7 +1738,6 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * This is used by contribution and also event pcps * * @param array $params - * Associated array. * @param object $contribution * Contribution object. * @@ -1778,7 +1777,6 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * @param CRM_Core_Form $page * Form object. * @param array $params - * Associated array. * * @return array * @static diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index b15df4ed90..26c79c0637 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -731,7 +731,8 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index 67b20df3ea..8ff6172cc5 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -283,7 +283,8 @@ SELECT id * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 189390b43a..7da86bd7ab 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -172,7 +172,8 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co * @param $files * @param int $contributionPageId * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $contributionPageId) { diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index bcfb797af6..50c4ade490 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -114,7 +114,8 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C * @param array $params * (ref.) an assoc array of name/value pairs. * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params) { diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index 27a35df7ff..9404da1f83 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -99,7 +99,8 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ * @param array $options * Additional user data. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $options) { diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index fd9cb7b4b8..d562b2eb79 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -226,7 +226,8 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 569683da34..fbe83b9eaf 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -216,7 +216,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { * * @param $files * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files) { @@ -368,7 +369,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { * @param $width * @param $height * - * @return Path to image + * @return string + * Path to image */ private function _resizeImage($filename, $resizedName, $width, $height) { // figure out the new filename diff --git a/CRM/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index 6e12590737..9e7004efc0 100644 --- a/CRM/Contribute/Form/UpdateBilling.php +++ b/CRM/Contribute/Form/UpdateBilling.php @@ -227,7 +227,8 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index 3523be5165..b8054e989a 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -74,7 +74,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * * @param bool $getAllUnconditionally * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ /** * @param bool $getAllUnconditionally @@ -111,7 +112,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -131,7 +133,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -150,7 +153,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * Provides information about advanced search pane * offered by this component. * - * @return array|null collection of required pane settings, + * @return array|null + * collection of required pane settings, * null if no element offered */ /** @@ -170,7 +174,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array|null collection of activity types + * @return array|null + * collection of activity types */ /** * @return array|null diff --git a/CRM/Core/BAO/ActionLog.php b/CRM/Core/BAO/ActionLog.php index 649061455c..a3740e591c 100644 --- a/CRM/Core/BAO/ActionLog.php +++ b/CRM/Core/BAO/ActionLog.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_ActionLog extends CRM_Core_DAO_ActionLog { * * @param array $params * - * @return actionLog array + * @return array */ public static function create($params) { $actionLog = new CRM_Core_DAO_ActionLog(); diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 27edbc01cd..4789b739a6 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -927,7 +927,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, * @param int $addressId * Address id. * - * @return count of contacts that use this shared address + * @return int + * count of contacts that use this shared address * @static */ public static function checkContactSharedAddress($addressId) { diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index a69e086e23..11fc59dad2 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -226,7 +226,6 @@ class CRM_Core_BAO_CMSUser { * Create CMS user using Profile * * @param array $params - * Associated array. * @param string $mail * Email id for cms user. * @@ -263,7 +262,8 @@ class CRM_Core_BAO_CMSUser { * True if the profile field has email(primary). * @param \const|int $action * - * @return FALSE|void WTF + * @return FALSE|void + * WTF * * @static */ @@ -421,12 +421,14 @@ class CRM_Core_BAO_CMSUser { } /** - * Check if a cms user already exists. + * @deprecated + * This function is not used anywhere * - * @param array $contactArray of contact-details. + * @param array $contact * Array of contact-details. * - * @return uid if user exists, false otherwise + * @return int|bool + * uid if user exists, false otherwise * * @static */ diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 5f0db6eacc..6e1ad55002 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -684,7 +684,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * The key to parse. * * @param bool $all - * @return int|null The id (if exists) + * @return int|null + * The id (if exists) * @static */ public static function getKeyID($key, $all = FALSE) { @@ -2112,7 +2113,7 @@ AND cf.id = %1"; * for inactive fields : CRM-5369 * * - * @return mixed $customOptionGroup + * @return mixed * @static */ public static function &customOptionGroup($includeFieldIds = NULL) { diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 5e4bb8c301..4bd9725590 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -1815,7 +1815,6 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * Function returns formatted groupTree, sothat form can be easily build in template * * @param array $groupTree - * Associated array. * @param int $groupCount * Group count by default 1, but can varry for multiple value custom data. * @param object form object @@ -1889,7 +1888,6 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * @param CRM_Core_Form $form * Page object. * @param array $groupTree - * Associated array. * @param bool $returnCount * True if customValue count needs to be returned. * @param int $gID @@ -1982,7 +1980,6 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * @param array $values * Associated array of custom values. * @param array $field - * Associated array. * @param bool $dncOptionPerLine * True if optionPerLine should not be consider. * diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index 0ae0c30f47..8d79caf6db 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -125,7 +125,8 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { * @param string $type * The civicrm type string. * - * @return the mysql data store placeholder + * @return string|null + * the mysql data store placeholder * @static */ public static function typeToField($type) { @@ -163,7 +164,8 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { /** - * @param $formValues + * @param array $formValues + * @return null */ public static function fixFieldValueOfTypeMemo(&$formValues) { if (empty($formValues)) { @@ -192,7 +194,7 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { } /** - * Delet option value give an option value and custom group id + * Delete option value give an option value and custom group id * * @param int $customValueID * Custom value ID. diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index 69f2106e6b..3dc36b3bf5 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -254,11 +254,10 @@ class CRM_Core_BAO_CustomValueTable { * Given a field return the mysql data type associated with it * * @param string $type - * The civicrm type string. - * * @param int $maxLength * - * @return the mysql data store placeholder + * @return string + * the mysql data store placeholder * @static */ public static function fieldToSQLType($type, $maxLength = 255) { diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 5cc3ee4218..48cee4cde8 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -347,7 +347,6 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * Save changes made by use to the Dashlet * * @param array $columns - * Associated array. * * @param int $contactID * @@ -416,7 +415,6 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * Add dashlets * * @param array $params - * Associated array. * * @return object * $dashlet returns dashlet object diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index e0e432e5aa..685cb648c3 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -68,7 +68,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * * @param null $reset * - * @return null|object CRM_Core_BAO_Domain + * @return CRM_Core_BAO_Domain|null * @static */ public static function &getDomain($reset = NULL) { diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index 14121a1807..312ad5429e 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -659,7 +659,8 @@ AND CEF.entity_id = %2"; * @param int $entityID * The id of the object in the above entityTable. * - * @return array|NULL list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL + * @return array|NULL + * list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL * * @static */ diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 3f1c33bc1f..30975386bb 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -964,7 +964,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $customfieldId * Related file id. * - * @return null|string $customGroupName all custom group names + * @return null|string + * $customGroupName all custom group names * @static */ public static function getCustomGroupName($customfieldId) { diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 274fa2080a..a6dcd01850 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -334,7 +334,8 @@ ORDER BY parent_id, weight"; * @param bool $navigationMenu * True when called for building top navigation menu. * - * @return returns html or json object + * @return string + * html or json string * @static */ public static function buildNavigation($json = FALSE, $navigationMenu = TRUE) { diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 4a70cf516c..8df2a67a70 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -294,7 +294,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param bool $showStatus * Do we need to set status or not. * - * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise + * @return int|NULL + * no of deleted notes on success, null otherwise * @access public * @static */ diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 9fd18cf64f..8ae0cf69c5 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -789,13 +789,13 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function deletes main entity and related linked entities from recurring-entity table * * @param int $entityId - * Entity id . + * Entity id * @param string $entityTable - * Name of the entity table . + * Name of the entity table * * @static * - * @return boolean|object Returns either boolean value or CRM_Core_DAO_RecurringEntity object + * @return boolean|CRM_Core_DAO_RecurringEntity */ static public function delEntity($entityId, $entityTable, $isDelLinkedEntities = FALSE) { if (empty($entityId) || empty($entityTable)) { diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 2969bfab3a..dad408318d 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -66,7 +66,8 @@ class CRM_Core_BAO_SchemaHandler { * * @param array $params * - * @return TRUE if successfully created, FALSE otherwise + * @return bool + * TRUE if successfully created, FALSE otherwise * * @static */ diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 185274762d..0665028422 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -217,7 +217,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * @param int $domainID * - * @return mixed The data if present in the setting table, else null + * @return mixed + * The data if present in the setting table, else null * @static */ static function getItem( diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index e9a005ad33..70a85c2f52 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -508,7 +508,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param int $ufGroupId * - * @return true for mix profile else false + * @return bool + * true for mix profile else false * @static */ public static function checkProfileType($ufGroupId) { @@ -707,7 +708,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param $ctype * - * @return true for mix profile group else false + * @return bool + * true for mix profile group else false * @static */ public static function checkProfileGroupType($ctype) { diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index d45ea03520..6d02ca8e8f 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -918,7 +918,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * The current contact id (hence excluded from matching). * @param string $contactType * - * @return int|null contact_id if found, null otherwise + * @return int|null + * contact_id if found, null otherwise * @static */ public static function findContact(&$params, $id = NULL, $contactType = 'Individual') { @@ -2706,10 +2707,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Get default value for Register. * - * @param $fields - * @param $defaults + * @param array $fields + * @param array $defaults * - * @return mixed $defaults + * @return array * @static */ public static function setRegisterDefaults(&$fields, &$defaults) { @@ -2906,7 +2907,6 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Format fields for dupe Contact Matching * * @param array $params - * Associated array. * * @param int $contactId * diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index b3aa1ce8ee..6c2cb5476f 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -184,11 +184,11 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * The name of the user framework. * @param int $status * Returns the status if user created or already exits (used for CMS sync). - * - * @param null $ctype + * @param string $ctype + * contact type * @param bool $isLogin * - * @return the ufmatch object that was found or created + * @return CRM_Core_DAO_UFMatch|bool * @static */ public static function &synchronizeUFMatch(&$user, $userKey, $uniqId, $uf, $status = NULL, $ctype = NULL, $isLogin = FALSE) { diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index 868382130e..41f2abf850 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -64,7 +64,6 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * Process website * * @param array $params - * Associated array. * @param int $contactID * Contact id. * diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index fa182559ef..0cfe09abd4 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -71,7 +71,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * * @param null $reset * - * @return null|object CRM_Core_BAO_WordRepalcement + * @return null|CRM_Core_BAO_WordRepalcement * @static */ public static function getWordReplacement($reset = NULL) { @@ -93,7 +93,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * @param array $params * @param int $id * - * @return WordReplacement array + * @return array */ public static function edit(&$params, &$id) { $wordReplacement = new CRM_Core_DAO_WordReplacement(); @@ -111,7 +111,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * * @param array $params * - * @return WordReplacement array + * @return array */ public static function create($params) { if (array_key_exists("domain_id", $params) === FALSE) { diff --git a/CRM/Core/CodeGen/Config.php b/CRM/Core/CodeGen/Config.php index 82b87dad28..2f0627a195 100644 --- a/CRM/Core/CodeGen/Config.php +++ b/CRM/Core/CodeGen/Config.php @@ -45,7 +45,8 @@ class CRM_Core_CodeGen_Config extends CRM_Core_CodeGen_BaseTask { /** * @param string $cms * "drupal"|"wordpress". - * @return null|string path to config template + * @return null|string + * path to config template */ public function findConfigTemplate($cms) { $candidates = array(); diff --git a/CRM/Core/CommunityMessages.php b/CRM/Core/CommunityMessages.php index fb71592b1e..a9b7a0648d 100644 --- a/CRM/Core/CommunityMessages.php +++ b/CRM/Core/CommunityMessages.php @@ -129,7 +129,8 @@ class CRM_Core_CommunityMessages { /** * Download document from URL and parse as JSON * - * @return NULL|array parsed JSON + * @return NULL|array + * parsed JSON */ public function fetchDocument() { list($status, $json) = $this->client->get($this->getRenderedUrl()); diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 9145675271..a7548f46fc 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -164,7 +164,8 @@ abstract class CRM_Core_Component_Info { * * @param bool $getAllUnconditionally * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ abstract public function getPermissions($getAllUnconditionally = FALSE); @@ -187,7 +188,8 @@ abstract class CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ abstract public function getUserDashboardElement(); @@ -196,7 +198,8 @@ abstract class CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ abstract public function registerTab(); @@ -205,7 +208,8 @@ abstract class CRM_Core_Component_Info { * Provides information about advanced search pane * offered by this component. * - * @return array|null collection of required pane settings, + * @return array|null + * collection of required pane settings, * null if no element offered */ abstract public function registerAdvancedSearchPane(); @@ -216,7 +220,8 @@ abstract class CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array|null collection of activity types + * @return array|null + * collection of activity types */ abstract public function getActivityTypes(); @@ -238,7 +243,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's configuration object. * - * @return mixed component's configuration object + * @return mixed + * component's configuration object */ public function getConfigObject() { return $this->_instantiate(self::COMPONENT_CONFIG_CLASS); @@ -247,7 +253,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's menu definition object. * - * @return mixed component's menu definition object + * @return mixed + * component's menu definition object */ public function getMenuObject() { return $this->_instantiate(self::COMPONENT_MENU_CLASS); @@ -256,7 +263,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's invocation object. * - * @return mixed component's invocation object + * @return mixed + * component's invocation object */ public function getInvokeObject() { return $this->_instantiate(self::COMPONENT_INVOKE_CLASS); @@ -265,7 +273,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's BAO Query object. * - * @return mixed component's BAO Query object + * @return mixed + * component's BAO Query object */ public function getBAOQueryObject() { return $this->_instantiate(self::COMPONENT_BAO_QUERY_CLASS); @@ -282,7 +291,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's user dashboard page object. * - * @return mixed component's User Dashboard applet object + * @return mixed + * component's User Dashboard applet object */ public function getUserDashboardObject() { return $this->_instantiate(self::COMPONENT_USERDASHBOARD_CLASS); @@ -291,7 +301,8 @@ abstract class CRM_Core_Component_Info { /** * Provides component's contact record tab object. * - * @return mixed component's contact record tab object + * @return mixed + * component's contact record tab object */ public function getTabObject() { return $this->_instantiate(self::COMPONENT_TAB_CLASS); @@ -343,7 +354,8 @@ abstract class CRM_Core_Component_Info { /** * Helper for figuring out menu XML file location. * - * @return mixed component's element as class instance + * @return mixed + * component's element as class instance */ private function _getMenuXMLPath() { global $civicrm_root; @@ -356,7 +368,8 @@ abstract class CRM_Core_Component_Info { * * @param $cl * - * @return mixed component's element as class instance + * @return mixed + * component's element as class instance */ private function _instantiate($cl) { $className = $this->namespace . '_' . $cl; diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index 049fdbc87a..3060cc137e 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -618,7 +618,8 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { * @param string $driver * 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory(). * @param array $params - * @return Mail (More specifically, a class which implements the "send()" function) + * @return object + * More specifically, a class which implements the "send()" function */ public static function _createMailer($driver, $params) { if ($driver == 'CRM_Mailing_BAO_Spool') { diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index a51e857b5c..91bcb93651 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -573,7 +573,8 @@ class CRM_Core_DAO extends DB_DataObject { * @param array $field * The field under task. * - * @return array|null the attributes for the object + * @return array|null + * the attributes for the object * @static */ public static function makeAttribute($field) { @@ -980,7 +981,8 @@ FROM civicrm_domain * @param bool $force * Skip use of the cache. * - * @return string|null Value of $returnColumn in the retrieved record + * @return string|null + * Value of $returnColumn in the retrieved record * @static */ public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) { @@ -1191,7 +1193,8 @@ FROM civicrm_domain * @param array $params * @param bool $abort * @param bool $i18nRewrite - * @return string|null the result of the query if any + * @return string|null + * the result of the query if any * * @static */ @@ -1323,7 +1326,8 @@ FROM civicrm_domain * getting copied * * - * @return (reference ) the newly created copy of the object + * @return CRM_Core_DAO + * the newly created copy of the object */ static function ©Generic($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) { $object = new $daoName(); @@ -2244,7 +2248,8 @@ SELECT contact_id * preferable to not double-banger the return context next refactor of this - but keeping the attention * in one place has some advantages as we try to extend this format * - * @return NULL|string|array a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL + * @return NULL|string|array + * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL * depending on whether it is supported as yet */ public static function createSQLFilter($fieldName, $filter, $type, $alias = NULL, $returnSanitisedArray = FALSE) { diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index b1dd6f1d32..acaa44971f 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -1566,7 +1566,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * - cid from the url if the caller has ACL permission to view * - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?) * - * @return mixed NULL|integer + * @return NULL|integer */ public function getContactID() { $tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this); diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index b3b637972f..77bb8736a3 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -126,7 +126,6 @@ class CRM_Core_Form_Tag { * Save entity tags when it is not save used AJAX * * @param array $params - * Associated array. * @param int $entityId * Entity id, eg: contact id, activity id, case id, file id. * @param string $entityTable diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index 7445d4c51d..739156bdbf 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -215,7 +215,8 @@ class CRM_Core_JobManager { /* * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ /** * @param $message diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index 08f909d10b..b19c280016 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -72,7 +72,8 @@ class CRM_Core_ManagedEntities { /** * Read the managed entity * - * @return array|NULL API representation, or NULL if the entity does not exist + * @return array|NULL + * API representation, or NULL if the entity does not exist */ public function get($moduleName, $name) { $dao = new CRM_Core_DAO_Managed(); @@ -366,7 +367,8 @@ class CRM_Core_ManagedEntities { /** * @param $declarations * - * @return mixed string on error, or FALSE + * @return string|bool + * string on error, or FALSE */ protected static function validate($declarations) { foreach ($declarations as $declare) { @@ -382,9 +384,9 @@ class CRM_Core_ManagedEntities { } /** - * @param $declarations + * @param array $declarations * - * @return mixed + * @return array */ protected static function cleanDeclarations($declarations) { foreach ($declarations as $name => &$declare) { diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index eedf98ed35..c521cdca62 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -558,7 +558,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * The field. * * @param bool $xmlSafe - * @return mixed value of the field, or empty string if the field is + * @return mixed + * value of the field, or empty string if the field is * not set */ public function _getParam($field, $xmlSafe = FALSE) { diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 53e7b01a11..29e7d40a5b 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -791,8 +791,8 @@ LIMIT 1;"; * Update contribution status - this is only called from one place in the code & * it is unclear whether it is a function on the way in or on the way out * - * @param unknown_type $params - * @return void|Ambigous + * @param array $params + * @return void|int */ public function updateContributionStatus(&$params) { // get minimum required values. diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 8218141b9c..251343dd79 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -214,7 +214,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * @param string $field * The field. * - * @return mixed value of the field, or empty string if the field is + * @return mixed + * value of the field, or empty string if the field is * not set */ public function _getParam($field) { diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index be6bfb3eaf..382eef25fa 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -143,7 +143,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { * Abort if empty. * * @throws CRM_Core_Exception - * @return Ambigous + * @return mixed */ public function retrieve($name, $type, $location = 'POST', $abort = TRUE) { $value = CRM_Utils_Type::validate( @@ -389,7 +389,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { * (with the input parameters) & call this & all will be done * * @todo the references to POST throughout this class need to be removed - * @return void|boolean|Ambigous + * @return void|boolean */ public function main() { CRM_Core_Error::debug_var('GET', $_GET, TRUE, TRUE); @@ -473,6 +473,7 @@ INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contr * @param $input * @param $ids * + * @return bool * @throws CRM_Core_Exception */ public function getInput(&$input, &$ids) { @@ -577,6 +578,7 @@ INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contr /** * Function check if transaction already exists * @param string $trxn_id + * @return bool|void */ public function transactionExists($trxn_id) { if (CRM_Core_DAO::singleValueQuery("SELECT count(*) FROM civicrm_contribution WHERE trxn_id = %1", diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index 90c6f85b93..a9b113a674 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -449,7 +449,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * @param string $field * The field. * - * @return mixed value of the field, or empty string if the field is + * @return mixed + * value of the field, or empty string if the field is * not set */ public function _getParam($field) { diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index 4f1ed1f767..55335c1418 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -50,7 +50,8 @@ class CRM_Core_Permission_Base { * Array($portableName => $nativeName). * * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset" - * @return NULL|string a permission name + * @return NULL|string + * a permission name */ public function translatePermission($perm, $nativePrefix, $map) { list ($civiPrefix, $name) = CRM_Utils_String::parsePrefix(':', $perm, NULL); diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 33b0222681..6e127276a8 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -230,7 +230,8 @@ class CRM_Core_PseudoConstant { * - fresh boolean ignore cache entries and go back to DB * @param string $context : Context string * - * @return Array|bool - array on success, FALSE on error. + * @return Array|bool + * array on success, FALSE on error. * * @static */ @@ -976,7 +977,7 @@ WHERE id = %1"; * * @param bool $styledLabels * - * @return mixed - instance of CRM_Contact_BAO_GroupNesting + * @return CRM_Contact_BAO_GroupNesting */ public static function &groupIterator($styledLabels = FALSE) { if (!self::$groupIterator) { diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index 83aeaa1584..d69f5ad091 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -48,7 +48,8 @@ class CRM_Core_Report_Excel { * * @param bool $outputHeader * - * @return mixed empty if output is printed, else output + * @return mixed + * empty if output is printed, else output * * @static */ diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 7c361855c0..a2162a5e0c 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -435,7 +435,8 @@ class CRM_Core_Resources { * @param string $file * file path -- relative to the extension base dir. * - * @return bool|string (string|bool), full file path or FALSE if not found + * @return bool|string + * full file path or FALSE if not found */ public function getPath($ext, $file) { // TODO consider caching results diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 458fe56cdf..d2b48de03e 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -557,7 +557,8 @@ class CRM_Core_Session { /** * Retrieve contact id of the logged in user - * @return integer|NULL contact ID of logged in user + * @return integer|NULL + * contact ID of logged in user */ public static function getLoggedInContactID() { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Core/State.php b/CRM/Core/State.php index b6641fa47c..8b003a0895 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -110,7 +110,8 @@ class CRM_Core_State { * * @param object the CRM_Core_Form element under consideration * - * @return mixed does a jump to the back state + * @return mixed + * does a jump to the back state */ public function handleBackState(&$page) { if ($this->_type & self::START) { @@ -127,7 +128,8 @@ class CRM_Core_State { * * @param object the CRM_Core_Form element under consideration * - * @return mixed does a jump to the nextstate + * @return mixed + * does a jump to the nextstate */ public function handleNextState(&$page) { if ($this->_type & self::FINISH) { diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 26d651981d..30e7edef92 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -114,7 +114,8 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Dashlet/Page/Blog.php b/CRM/Dashlet/Page/Blog.php index be8b462feb..60069a94fd 100644 --- a/CRM/Dashlet/Page/Blog.php +++ b/CRM/Dashlet/Page/Blog.php @@ -100,7 +100,8 @@ class CRM_Dashlet_Page_Blog extends CRM_Core_Page { * * @param $url * - * @return array|NULL array of blog items; or NULL if not available + * @return array|NULL + * array of blog items; or NULL if not available */ public function _getFeed($url) { $httpClient = new CRM_Utils_HttpClient(self::CHECK_TIMEOUT); diff --git a/CRM/Dedupe/BAO/Rule.php b/CRM/Dedupe/BAO/Rule.php index 767d715e29..37c9a941b9 100644 --- a/CRM/Dedupe/BAO/Rule.php +++ b/CRM/Dedupe/BAO/Rule.php @@ -190,7 +190,8 @@ class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_DAO_Rule { * * @param array contains the rule group property to identify rule group * - * @return rule fields array associated to rule group + * @return array + * rule fields array associated to rule group */ public static function dedupeRuleFields($params) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 0a6fba66a2..48d98b4931 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -655,7 +655,8 @@ $event_summary_limit * @param int $id * For which we want map info. * - * @return null|string title of the event + * @return null|string + * title of the event * @static */ public static function &getMapInfo(&$id) { diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index ca1a28299d..76c084bc57 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -351,7 +351,8 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * @param bool $returnWaitingCount * @param bool $considerTestParticipant * - * @return bool|int|null|string 1. false => If event having some empty spaces. + * @return bool|int|null|string + * 1. false => If event having some empty spaces. * @static */ static function eventFull( @@ -1693,7 +1694,8 @@ UPDATE civicrm_participant * * @param int $participantId * - * @return true if participant is primary + * @return bool + * true if participant is primary */ public static function isPrimaryParticipant($participantId) { @@ -1716,7 +1718,8 @@ UPDATE civicrm_participant * @param int $newStatusId * New status. * - * @return true if allowed + * @return bool + * true if allowed */ public static function getValidAdditionalIds($participantId, $oldStatusId, $newStatusId) { diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 7714a34d6d..49008bc097 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -366,7 +366,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Create initializers for addprofileSelector * - * @return array( 'allowCoreTypes' => array(), 'allowSubTypes' => array(), 'profileEntities' => array() ) + * @return array + * ['allowCoreTypes' => array, 'allowSubTypes' => array, 'profileEntities' => array] **/ public static function getProfileSelectorTypes() { $configs = array( diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index e58bfb6c5d..ee8791049c 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -1198,9 +1198,11 @@ WHERE v.option_group_id = g.id /** * Validate price set submitted params for price option limit, * as well as user should select at least one price field option. - * @param unknown_type $form - * @param unknown_type $params - * @return multitype:|Ambigous + * + * @param CRM_Core_Form $form + * @param array $params + * + * @return array */ public static function validatePriceSet(&$form, $params) { $errors = array(); @@ -1335,8 +1337,9 @@ WHERE v.option_group_id = g.id return $errors; } - // set the first participant ID if not set, CRM-10032 /** + * set the first participant ID if not set, CRM-10032 + * * @param int $participantID */ public function processFirstParticipant($participantID) { diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index e69ae49be0..ba3f06d2df 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -384,7 +384,8 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 25ab5a0bb6..21e8dcb405 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -809,7 +809,8 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * @param $self * * - * @return TRUE if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Export/Form/Select.php b/CRM/Export/Form/Select.php index d6352d5fa6..708de8b58a 100644 --- a/CRM/Export/Form/Select.php +++ b/CRM/Export/Form/Select.php @@ -346,7 +346,8 @@ FROM {$this->_componentTable} * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ static public function formRule($params, $files, $self) { diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php index a3c31d7a46..6610b13ae7 100644 --- a/CRM/Extension/Downloader.php +++ b/CRM/Extension/Downloader.php @@ -160,7 +160,8 @@ class CRM_Extension_Downloader { * The name of the extension being installed; this usually matches the basedir in the .zip. * @param string $zipFile * The local path to a .zip file. - * @return string|FALSE zip file path + * @return string|FALSE + * zip file path */ public function extractFiles($key, $zipFile) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 017efe54cf..8af6227699 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -55,7 +55,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_FinancialAccount object + * @return CRM_Financial_BAO_FinancialAccount * @static */ public static function retrieve(&$params, &$defaults) { @@ -76,8 +76,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 CRM_Core_DAO|null + * DAO object on success, null otherwise * @static */ public static function setIsActive($id, $is_active) { @@ -93,7 +93,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco * Reference array contains the id. * * @static - * @return object + * @return CRM_Financial_DAO_FinancialAccount */ public static function add(&$params, &$ids = array()) { if (empty($params['id'])) { @@ -158,11 +158,10 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco /** * Get accounting code for a financial type with account relation Income Account is * - * @financialTypeId int Financial Type Id - * * @param int $financialTypeId * - * @return accounting code + * @return int + * accounting code * @static */ public static function getAccountingCode($financialTypeId) { @@ -189,7 +188,8 @@ WHERE cft.id = %1 * @param $financialAccountTypeId * Financial account type id. * - * @param \account|string $accountTypeCode account type code + * @param string $accountTypeCode + * account type code * * @return integer * count diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 933bf930cc..9714fd410f 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -273,7 +273,8 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @param array $defaults * (reference) the default values. * - * @return booelan whether anything was found + * @return booelan + * whether anything was found */ public static function getValues(&$defaults) { if (empty($defaults)) { diff --git a/CRM/Friend/Form.php b/CRM/Friend/Form.php index 4ae16be265..cd35fd6470 100644 --- a/CRM/Friend/Form.php +++ b/CRM/Friend/Form.php @@ -231,7 +231,8 @@ class CRM_Friend_Form extends CRM_Core_Form { * * @param array $fields * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($fields) { diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 99d8c4b26e..f03282d24c 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -3055,7 +3055,6 @@ AND m.id = %1 * Retrieve contact mailing * * @param array $params - * Associated array. * * @return array * of mailings for a contact @@ -3076,7 +3075,6 @@ AND m.id = %1 * Retrieve contact mailing count * * @param array $params - * Associated array. * * @return int * count of mailings for a contact diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php index 9da14d2198..5519ac9aa1 100644 --- a/CRM/Mailing/BAO/Spool.php +++ b/CRM/Mailing/BAO/Spool.php @@ -44,25 +44,22 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool { /** * Store Mails into Spool table. * - * @param $recipient + * @param string|array $recipient + * Either a comma-seperated list of recipients + * (RFC822 compliant), or an array of recipients, + * each RFC822 valid. This may contain recipients not + * specified in the headers, for Bcc:, resending + * messages, etc. * @param array $headers - * The string of headers to send with the mail. + * The array of headers to send with the mail. * * @param string $body - * The full text of the message body, including any. - * Mime parts, etc. + * The full text of the message body, including any mime parts, etc. * * @param int $job_id * - * @internal param mixed $recipients Either a comma-seperated list of recipients - * (RFC822 compliant), or an array of recipients, - * each RFC822 valid. This may contain recipients not - * specified in the headers, for Bcc:, resending - * messages, etc. - * - * @return mixed Returns true on success, or a CRM_Eore_Error - * containing a descriptive error message on - * failure. + * @return bool|CRM_Core_Error + * true if successful */ public function send($recipient, $headers, $body, $job_id = NULL) { $headerStr = array(); diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index c4002d4088..9bbf11c01d 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -89,7 +89,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * @param string $hash * The hash to validate against. * - * @return object|null The queue event if verified, or null + * @return object|null + * The queue event if verified, or null * @static */ public static function &verify($job_id, $queue_id, $hash) { diff --git a/CRM/Mailing/Event/BAO/Reply.php b/CRM/Mailing/Event/BAO/Reply.php index 654a05f90a..536cec33e4 100644 --- a/CRM/Mailing/Event/BAO/Reply.php +++ b/CRM/Mailing/Event/BAO/Reply.php @@ -62,7 +62,8 @@ class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply { * * @param null $replyto * - * @return object|null The mailing object, or null on failure + * @return object|null + * The mailing object, or null on failure * @static */ public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) { diff --git a/CRM/Mailing/Event/BAO/Resubscribe.php b/CRM/Mailing/Event/BAO/Resubscribe.php index 2954c98e2b..4c3258f2a9 100644 --- a/CRM/Mailing/Event/BAO/Resubscribe.php +++ b/CRM/Mailing/Event/BAO/Resubscribe.php @@ -50,7 +50,8 @@ class CRM_Mailing_Event_BAO_Resubscribe { * @param string $hash * The hash. * - * @return array|null $groups Array of all groups to which the contact was added, or null if the queue event could not be found. + * @return array|null + * $groups Array of all groups to which the contact was added, or null if the queue event could not be found. * @static */ public static function &resub_to_mailing($job_id, $queue_id, $hash) { diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index f851c3e56e..1639439bab 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -62,7 +62,8 @@ class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe { * during event registration. * @param string $context * - * @return int|null $se_id The id of the subscription event, null on failure + * @return int|null + * $se_id The id of the subscription event, null on failure * @static */ public static function &subscribe($group_id, $email, $contactId = NULL, $context = NULL) { @@ -185,7 +186,8 @@ SELECT civicrm_email.id as email_id * @param string $hash * Hash to verify. * - * @return object|null The subscribe event object, or null on failure + * @return object|null + * The subscribe event object, or null on failure * @static */ public static function &verify($contact_id, $subscribe_id, $hash) { diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index 66fea75093..88fe0e16d5 100755 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -126,7 +126,8 @@ WHERE email = %2 * @param bool $return * If true return the list of groups. * - * @return array|null $groups Array of all groups from which the contact was removed, or null if the queue event could not be found. + * @return array|null + * $groups Array of all groups from which the contact was removed, or null if the queue event could not be found. * @static */ public static function &unsub_from_mailing($job_id, $queue_id, $hash, $return = FALSE) { diff --git a/CRM/Mailing/Form/Component.php b/CRM/Mailing/Form/Component.php index c689d4c832..ac9e3432c3 100644 --- a/CRM/Mailing/Form/Component.php +++ b/CRM/Mailing/Form/Component.php @@ -158,7 +158,8 @@ class CRM_Mailing_Form_Component extends CRM_Core_Form { * @param $files * @param $options * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function dataRule($params, $files, $options) { diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index 2bb94e4def..ccafccc2bf 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -512,7 +512,8 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index a5bff70466..9ce358c3a3 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -1251,8 +1251,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * @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 returns the number of members of type $membershipTypeId as of - * $date. + * @return int + * the number of members of type $membershipTypeId as of $date. */ public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) { if (!CRM_Utils_Rule::date($date)) { @@ -1751,7 +1751,8 @@ SELECT c.contribution_page_id as pageID * @param int $id * Id of the membership. * - * @return null|string sort name of the contact if found + * @return null|string + * sort name of the contact if found * @static */ public static function sortName($id) { @@ -1775,7 +1776,8 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id * @param CRM_Core_DAO $dao * Membership object. * - * @return null|array array of memberships if created + * @return null|array + * array of memberships if created * @static */ public static function createRelatedMemberships(&$params, &$dao, $reset = FALSE) { @@ -2119,9 +2121,10 @@ LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id ) * Date on which to end counting. * @param bool|int $isTest if true, membership is for a test site * - * @return returns the number of members of type $membershipTypeId - * whose join_date is between $startDate and $endDate and - * whose start_date is between $startDate and $endDate + * @return int + * the number of members of type $membershipTypeId + * whose join_date is between $startDate and $endDate and + * whose start_date is between $startDate and $endDate */ public static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) { $testClause = 'membership.is_test = 1'; diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index 88706734c7..f57003c308 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -747,7 +747,8 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; * @param $self * * @throws CiviCRM_API3_Exception - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index 7505d76a60..a7173a70ce 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -223,7 +223,8 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa * @param $files * @param int $contributionPageId * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $contributionPageId = NULL) { diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php index aa12c2d5b6..3d08cffe98 100644 --- a/CRM/Member/Form/MembershipRenewal.php +++ b/CRM/Member/Form/MembershipRenewal.php @@ -463,7 +463,8 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; * @param array $params * (ref.) an assoc array of name/value pairs. * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params) { diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php index 9b686c6c96..a885d2d6e9 100644 --- a/CRM/Member/Form/MembershipType.php +++ b/CRM/Member/Form/MembershipType.php @@ -215,7 +215,8 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { * @param array $params * (ref.) an assoc array of name/value pairs. * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params) { diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index 94b9cca7c6..340ee64a1c 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -50,7 +50,8 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { /** * Add context information at the end of a link * - * @return text extra query parameters + * @return string + * extra query parameters */ public function addContext() { $extra = ''; diff --git a/CRM/Member/Info.php b/CRM/Member/Info.php index a5650a3440..32672bf103 100644 --- a/CRM/Member/Info.php +++ b/CRM/Member/Info.php @@ -74,7 +74,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * * @param bool $getAllUnconditionally * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ /** * @param bool $getAllUnconditionally @@ -94,7 +95,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -117,7 +119,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -136,7 +139,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * Provides information about advanced search pane * offered by this component. * - * @return array|null collection of required pane settings, + * @return array|null + * collection of required pane settings, * null if no element offered */ /** @@ -156,7 +160,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array|null collection of activity types + * @return array|null + * collection of activity types */ /** * @return array|null diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 0f0ca1f846..18d4108a1f 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -94,7 +94,8 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { * @param int $id * Id for the PCP. * - * @return null|string Dispaly name of the contact if found + * @return null|string + * Dispaly name of the contact if found * @static */ public static function displayName($id) { @@ -236,7 +237,8 @@ ORDER BY target_entity_type, target_entity_id * * @static * - * @return total amount + * @return total + * amount */ public static function thermoMeter($pcpId) { $query = " diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 676837fbea..d8c46c9108 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -155,7 +155,8 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index 1e950dd71c..4a354def57 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -105,7 +105,8 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index 2b02239dee..d22eff1e2e 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -140,7 +140,8 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 1697067653..a6900e2c9f 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -228,7 +228,8 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index d5255fa9ed..43b3ef893b 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -168,7 +168,8 @@ WHERE pledge_id = %1 * @param array $params * Associate array of field. * - * @return pledge payment id + * @return int + * pledge payment id * @static */ public static function add($params) { @@ -557,13 +558,17 @@ WHERE civicrm_pledge.id = %2 /** * Calculate next scheduled pledge payment date. Function calculates next pledge payment date. * - * @param array params - must include frequency unit & frequency interval - * @param int paymentNo number of payment in sequence (e.g. 1 for first calculated payment (treat initial payment as 0) - * @param datestring basePaymentDate - date to calculate payments from. This would normally be the - * first day of the pledge (default) & is calculated off the 'scheduled date' param. Returned date will - * be equal to basePaymentDate normalised to fit the 'pledge pattern' + number of installments + * @param array $params + * must include frequency unit & frequency interval + * @param int $paymentNo + * number of payment in sequence (e.g. 1 for first calculated payment (treat initial payment as 0) + * @param string $basePaymentDate + * date to calculate payments from. This would normally be the + * first day of the pledge (default) & is calculated off the 'scheduled date' param. Returned date will + * be equal to basePaymentDate normalised to fit the 'pledge pattern' + number of installments * - * @return formatted date + * @return string + * formatted date */ public static function calculateNextScheduledDate(&$params, $paymentNo, $basePaymentDate = NULL) { if (!$basePaymentDate) { diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index f05166f4be..c93c8b3b4e 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -457,7 +457,8 @@ class CRM_Pledge_Form_Pledge extends CRM_Core_Form { * @param $self * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php index 3d6b71f0ab..6edfd588ef 100644 --- a/CRM/Pledge/Info.php +++ b/CRM/Pledge/Info.php @@ -70,7 +70,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * * @param bool $getAllUnconditionally * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ /** * @param bool $getAllUnconditionally @@ -90,7 +91,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -111,7 +113,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -130,7 +133,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * Provides information about advanced search pane * offered by this component. * - * @return array|null collection of required pane settings, + * @return array|null + * collection of required pane settings, * null if no element offered */ /** @@ -150,7 +154,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array|null collection of activity types + * @return array|null + * collection of activity types */ /** * @return array|null diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index 0c1312a7cc..011ac7e70f 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -540,7 +540,8 @@ AND li.entity_id = {$entityId} * @param array $lineItemId * An assoc array of lineItem. * - * @return tax rate + * @return number|void + * tax rate * * @static */ diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 5f37574076..40e5bb9f02 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -375,7 +375,8 @@ WHERE ct.id = cp.financial_type_id AND * @param null $isQuickConfig * @param null $setName * - * @return integer|false price_set_id, or false if none found + * @return integer|false + * price_set_id, or false if none found */ public static function getFor($entityTable, $entityId, $usedFor = NULL, $isQuickConfig = NULL, &$setName = NULL) { if (!$entityTable || !$entityId) { @@ -412,7 +413,8 @@ WHERE ct.id = cp.financial_type_id AND * array may contain either option id or * price field id * - * @return integer|NULL price set id on success, null otherwise + * @return integer|NULL + * price set id on success, null otherwise * @static */ public static function getSetId(&$params) { @@ -1105,13 +1107,12 @@ WHERE id = %1"; } /** - * make a copy of a price set, including - * all the fields + * Copy a price set, including all the fields * * @param int $id * The price set id to copy. * - * @return the copy object + * @return CRM_Price_DAO_PriceSet * @static */ public static function copy($id) { diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index 7f57e50e06..61506cde4e 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -89,7 +89,8 @@ class CRM_Price_Form_Set extends CRM_Core_Form { * @param array $options * Additional user data. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $options) { diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php index e68ad1e87d..f4bd4bcf5e 100644 --- a/CRM/Profile/Form.php +++ b/CRM/Profile/Form.php @@ -886,7 +886,8 @@ class CRM_Profile_Form extends CRM_Core_Form { * @param CRM_Core_Form $form * The form object. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index 441fb3d3a8..17e851af1d 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -100,7 +100,8 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { * @param CRM_Core_Form $form * * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $form) { diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 06e370d181..88ea2377c2 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -231,7 +231,8 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * * @param int $id * - * @return mixed $results no of deleted Instance on success, false otherwise + * @return mixed + * $results no of deleted Instance on success, false otherwise * @access public */ public static function del($id = NULL) { diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php index c1303681be..5d461d9957 100644 --- a/CRM/Report/Info.php +++ b/CRM/Report/Info.php @@ -74,7 +74,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * * @param bool $getAllUnconditionally * - * @return array|null collection of permissions, null if none + * @return array|null + * collection of permissions, null if none */ /** * @param bool $getAllUnconditionally @@ -91,7 +92,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -105,7 +107,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { /** * Provides component's user dashboard page object. * - * @return mixed component's User Dashboard applet object + * @return mixed + * component's User Dashboard applet object */ /** * @return mixed @@ -120,7 +123,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * Provides information about user dashboard element * offered by this component. * - * @return array|null collection of required dashboard settings, + * @return array|null + * collection of required dashboard settings, * null if no element offered */ /** @@ -136,7 +140,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * Provides information about advanced search pane * offered by this component. * - * @return array|null collection of required pane settings, + * @return array|null + * collection of required pane settings, * null if no element offered */ /** @@ -154,7 +159,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { * Needs to be implemented in component's information * class. * - * @return array|null collection of activity types + * @return array|null + * collection of activity types */ /** * @return array|null diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index 54d4e8116e..4449e468ca 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -299,7 +299,8 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { * @param $files * @param $self * - * @return mixed true or array of errors + * @return bool|array + * mixed true or array of errors * @static */ public static function formRule($params, $files, $self) { diff --git a/CRM/UF/Form/Group.php b/CRM/UF/Form/Group.php index 99571012a1..da6fbd15aa 100644 --- a/CRM/UF/Form/Group.php +++ b/CRM/UF/Form/Group.php @@ -294,7 +294,8 @@ class CRM_UF_Form_Group extends CRM_Core_Form { * @param array $self * Current form object. * - * @return true if no errors, else array of errors + * @return bool|array + * true if no errors, else array of errors * @static */ public static function formRule($fields, $files, $self) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 03d41a8ba8..fa7a38142a 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -101,7 +101,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ * * @param string $entity * - * @return id $priceSetID + * @return int + * priceSetID * * @static */ @@ -346,7 +347,8 @@ WHERE ct.id = cp.contribution_type_id AND * @param null $isQuickConfig * @param null $setName * - * @return integer|false price_set_id, or false if none found + * @return integer|false + * price_set_id, or false if none found */ public static function getFor($entityTable, $entityId, $usedFor = NULL, $isQuickConfig = NULL, &$setName = NULL) { if (!$entityTable || !$entityId) { @@ -380,10 +382,11 @@ WHERE ct.id = cp.contribution_type_id AND * * @param array $params * (reference) an assoc array of name/value pairs. - * array may contain either option id or - * price field id + * array may contain either option id or + * price field id * - * @return price set id on success, null otherwise + * @return int|null + * price set id on success, null otherwise * @static */ public static function getSetId(&$params) { @@ -923,13 +926,12 @@ WHERE id = %1"; } /** - * make a copy of a price set, including - * all the fields + * Copy a price set, including all the fields * * @param int $id * The price set id to copy. * - * @return the copy object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field * @static */ static function copy($id) { diff --git a/CRM/Utils/Cache/Interface.php b/CRM/Utils/Cache/Interface.php index d59eee27c9..8b7e99e300 100644 --- a/CRM/Utils/Cache/Interface.php +++ b/CRM/Utils/Cache/Interface.php @@ -47,7 +47,8 @@ interface CRM_Utils_Cache_Interface { * Get a value from the cache * * @param string $key - * @return mixed NULL if $key has not been previously set + * @return mixed + * NULL if $key has not been previously set */ public function get($key); diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index 929d57c52b..a189bff952 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -763,7 +763,8 @@ class CRM_Utils_Date { * @param date $endDate * End date for the range. * - * @return true todays date is in the given date range + * @return bool + * true if today's date is in the given date range * @static */ public static function getRange($startDate, $endDate) { @@ -1805,7 +1806,8 @@ class CRM_Utils_Date { * @param int $offset * the offset from the current time in seconds. * - * @return the time in UTC + * @return string + * the time in UTC * @static */ public static function getUTCTime($offset = 0) { diff --git a/CRM/Utils/DeprecatedUtils.php b/CRM/Utils/DeprecatedUtils.php index 73a8859300..d34ee9876f 100644 --- a/CRM/Utils/DeprecatedUtils.php +++ b/CRM/Utils/DeprecatedUtils.php @@ -1128,7 +1128,7 @@ function _civicrm_api3_deprecated_add_formatted_location_blocks(&$values, &$para /** * - * @param $params + * @param array $params * * @return array * @@ -1232,7 +1232,8 @@ function _civicrm_api3_deprecated_validate_formatted_contact(&$params) { * @param array $params * @param $onDuplicate * - * @return array|bool + * @return array|bool + * */ function _civicrm_api3_deprecated_create_participant_formatted($params, $onDuplicate) { require_once 'CRM/Event/Import/Parser.php'; @@ -1249,11 +1250,12 @@ function _civicrm_api3_deprecated_create_participant_formatted($params, $onDupli /** * - * @param $params + * @param array $params * * @param bool $checkDuplicate * - * @return array|bool + * @return array|bool + * */ function _civicrm_api3_deprecated_participant_check_params($params, $checkDuplicate = FALSE) { diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 2a1eaca598..b127c58956 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -295,7 +295,8 @@ abstract class CRM_Utils_Hook { * @param object $objectRef * The reference to the object if available. * - * @return mixed based on op. pre-hooks return a boolean or + * @return mixed + * based on op. pre-hooks return a boolean or * an error message which aborts the operation */ public static function post($op, $objectName, $objectId, &$objectRef) { @@ -394,7 +395,8 @@ abstract class CRM_Utils_Hook { * @param array &$files the FILES parameters as sent in by POST * @param array &$form the form object * - * @return mixed formRule hooks return a boolean or + * @return mixed + * formRule hooks return a boolean or * an array of error messages which display a QF Error */ public static function validate($formName, &$fields, &$files, &$form) { @@ -413,7 +415,8 @@ abstract class CRM_Utils_Hook { * @param array &$form the form object * @param array &$errors the array of errors. * - * @return mixed formRule hooks return a boolean or + * @return mixed + * formRule hooks return a boolean or * an array of error messages which display a QF Error */ public static function validateForm($formName, &$fields, &$files, &$form, &$errors) { diff --git a/CRM/Utils/ICalendar.php b/CRM/Utils/ICalendar.php index d4dfe043de..53230169a4 100644 --- a/CRM/Utils/ICalendar.php +++ b/CRM/Utils/ICalendar.php @@ -48,7 +48,8 @@ class CRM_Utils_ICalendar { * @param $text * Text to escape. * - * @return Escaped text + * @return string + * Escaped text */ public static function formatText($text) { $text = strip_tags($text); @@ -69,7 +70,8 @@ class CRM_Utils_ICalendar { * * @param bool $gdata * - * @return Escaped date + * @return string + * Escaped date */ public static function formatDate($date, $gdata = FALSE) { diff --git a/CRM/Utils/JSON.php b/CRM/Utils/JSON.php index 0fdbc7a01b..c099c7f171 100644 --- a/CRM/Utils/JSON.php +++ b/CRM/Utils/JSON.php @@ -85,7 +85,8 @@ class CRM_Utils_JSON { * @param array $selectorElements * Selector rows. * - * @return json encode string + * @return string + * json encoded string */ public static function encodeSelector(&$params, $page, $total, $selectorElements) { $json = ""; diff --git a/CRM/Utils/OptionBag.php b/CRM/Utils/OptionBag.php index e63aed86dc..64b317ceda 100644 --- a/CRM/Utils/OptionBag.php +++ b/CRM/Utils/OptionBag.php @@ -80,7 +80,8 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { *

. * The offset to retrieve. *

- * @return mixed Can return all value types. + * @return mixed + * Can return all value types. */ public function offsetGet($offset) { return $this->data[$offset]; @@ -122,7 +123,8 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { * (PHP 5 >= 5.0.0)
* Retrieve an external iterator * @link http://php.net/manual/en/iteratoraggregate.getiterator.php - * @return Traversable An instance of an object implementing Iterator or + * @return Traversable + * An instance of an object implementing Iterator or * Traversable */ public function getIterator() { diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index 48e1e50db9..8587f14ff3 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -100,7 +100,8 @@ class CRM_Utils_PseudoConstant { * @param string $constant * Constant-name. * - * @return string|NULL class-name + * @return string|NULL + * class-name */ public static function findConstantClass($constant) { if (self::$constants !== NULL && isset(self::$constants[$constant])) { diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php index 3dac69f0a9..5ecf2ae45d 100644 --- a/CRM/Utils/REST.php +++ b/CRM/Utils/REST.php @@ -660,7 +660,8 @@ class CRM_Utils_REST { } /** - * @return array|NULL NULL if execution should proceed; array if the response is already known + * @return array|NULL + * NULL if execution should proceed; array if the response is already known */ public function loadCMSBootstrap() { $requestParams = CRM_Utils_Request::exportValues(); diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index 978bbbb5a0..d993c69de1 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -191,7 +191,7 @@ class CRM_Utils_Sort { * @param string $defaultSortOrder * The sort order to use by default. * - * @return returns null if $url- (sort url) is not found + * @return void */ public function initSortID($defaultSortOrder) { $url = CRM_Utils_Array::value(self::SORT_ID, $_GET, $defaultSortOrder); diff --git a/CRM/Utils/String.php b/CRM/Utils/String.php index c10aa00e05..8e8b1f9651 100644 --- a/CRM/Utils/String.php +++ b/CRM/Utils/String.php @@ -375,7 +375,8 @@ class CRM_Utils_String { * @param mix $query * This is basically url. * - * @return mix $v returns civicrm url (eg: civicrm/contact/search/...) + * @return mix + * $v returns civicrm url (eg: civicrm/contact/search/...) * @static */ public static function extractURLVarValue($query) { diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 6a2671d7c0..7500f357cf 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -1838,7 +1838,8 @@ class CRM_Utils_System { * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] * - entity_table: string, eg "civicrm_contact" * - entity_id: int - * @return array|NULL NULL if unavailable, or an array. array has keys: + * @return array|NULL + * NULL if unavailable, or an array. array has keys: * - path: string * - query: array * - title: string diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index 57d64d9c47..4d0f995dd8 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -294,7 +294,8 @@ abstract class CRM_Utils_System_Base { * Get Unique Identifier from UserFramework system (CMS) * @param object $user * Object as described by the User Framework. - * @return mixed $uniqueIdentifer Unique identifier from the user Framework system + * @return mixed + * $uniqueIdentifer Unique identifier from the user Framework system */ public function getUniqueIdentifierFromUserObject($user) { } @@ -303,7 +304,8 @@ abstract class CRM_Utils_System_Base { * Get User ID from UserFramework system (CMS) * @param object $user * Object as described by the User Framework. - * @return mixed + * @return mixed + * */ public function getUserIDFromUserObject($user) { } diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 7d3f289a0d..ad429b150b 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -42,11 +42,11 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Create a user in Drupal. * * @param array $params - * Associated array. * @param string $mail * Email id for cms user. * - * @return uid if user exists, false otherwise + * @return int|bool + * uid if user exists, false otherwise */ public function createUser(&$params, $mail) { $form_state = form_state_defaults(); @@ -462,7 +462,8 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Load cms bootstrap?. * @param NULL|string $realPath filename of script * - * @return mixed false if no auth + * @return mixed + * false if no auth * array( * contactID, ufID, unique string ) if success */ diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index 82a99e1cec..14f6f2f30c 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -79,11 +79,11 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Create a user in Drupal. * * @param array $params - * Associated array. * @param string $mail * Email id for cms user. * - * @return uid if user exists, false otherwise + * @return int|bool + * uid if user exists, false otherwise */ public function createUser(&$params, $mail) { $form_state = array(); @@ -443,9 +443,8 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Load cms bootstrap?. * @param NULL|string $realPath filename of script * - * @return mixed false if no auth - * array( - * contactID, ufID, unique string ) if success + * @return array|bool + * [contactID, ufID, uniqueString] if success else false if no auth */ public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) { //@todo this 'PEAR-y' stuff is only required when bookstrap is not being loaded which is rare diff --git a/CRM/Utils/System/Drupal8.php b/CRM/Utils/System/Drupal8.php index 1b1a87abbc..494bc73ccf 100644 --- a/CRM/Utils/System/Drupal8.php +++ b/CRM/Utils/System/Drupal8.php @@ -42,11 +42,11 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Create a user in Drupal. * * @param array $params - * Associated array. * @param string $mail * Email id for cms user. * - * @return uid if user exists, false otherwise + * @return int|bool + * uid if user exists, false otherwise */ public function createUser(&$params, $mail) { $user = \Drupal::currentUser(); @@ -480,9 +480,8 @@ class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase { * Load cms bootstrap?. * @param NULL|string $realPath filename of script * - * @return mixed false if no auth - * array( - * contactID, ufID, unique string ) if success + * @return array|bool + * [contactID, ufID, uniqueString] if success else false if no auth * * This always bootstraps Drupal */ diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index 9361ab29f3..98cbf5352f 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -230,7 +230,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * Get User ID from UserFramework system (Drupal) * @param object $user * Object as described by the CMS. - * @return mixed + * @return mixed + * */ public function getUserIDFromUserObject($user) { return !empty($user->uid) ? $user->uid : NULL; @@ -240,7 +241,8 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * Get Unique Identifier from UserFramework system (CMS) * @param object $user * Object as described by the User Framework. - * @return mixed $uniqueIdentifer Unique identifier from the user Framework system + * @return mixed + * $uniqueIdentifer Unique identifier from the user Framework system */ public function getUniqueIdentifierFromUserObject($user) { return empty($user->mail) ? NULL : $user->mail; diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index 234f3bc6d8..ad04fd5206 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -53,11 +53,11 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Create a user of Joomla. * * @param array $params - * Associated array. * @param string $mail * Email id for cms user. * - * @return uid if user exists, false otherwise + * @return int|bool + * uid if user exists, false otherwise */ public function createUser(&$params, $mail) { $baseDir = JPATH_SITE; @@ -475,9 +475,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * @param bool $loadCMSBootstrap * load cms bootstrap?. * - * @return mixed false if no auth - * array( - * contactID, ufID, unique string ) if success + * @return array|bool + * [contactID, ufID, uniqueString] if success else false if no auth */ public function authenticate($name, $password, $loadCMSBootstrap = FALSE) { require_once 'DB.php'; @@ -734,7 +733,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Get User ID from UserFramework system (Joomla) * @param object $user * Object as described by the CMS. - * @return mixed + * @return mixed + * */ public function getUserIDFromUserObject($user) { return !empty($user->id) ? $user->id : NULL; @@ -744,7 +744,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Get Unique Identifier from UserFramework system (CMS) * @param object $user * Object as described by the User Framework. - * @return mixed $uniqueIdentifer Unique identifier from the user Framework system + * @return mixed + * $uniqueIdentifer Unique identifier from the user Framework system */ public function getUniqueIdentifierFromUserObject($user) { return ($user->guest) ? NULL : $user->email; diff --git a/CRM/Utils/System/UnitTests.php b/CRM/Utils/System/UnitTests.php index f2513e5293..3d62a2abec 100644 --- a/CRM/Utils/System/UnitTests.php +++ b/CRM/Utils/System/UnitTests.php @@ -73,9 +73,8 @@ class CRM_Utils_System_UnitTests extends CRM_Utils_System_Drupal { * Load cms bootstrap?. * @param NULL|string $realPath filename of script * - * @return mixed false if no auth - * array( - * contactID, ufID, unique string ) if success + * @return array|bool + * [contactID, ufID, uniqueString] if success else false if no auth */ /** * @param string $name diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index 7ffe19b30b..0350a9dc45 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -406,9 +406,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * @param bool $loadCMSBootstrap * @param null $realPath * - * @return mixed false if no auth - * array( - * contactID, ufID, unique string ) if success + * @return array|bool + * [contactID, ufID, uniqueString] if success else false if no auth * @static */ public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) { @@ -544,10 +543,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Determine the location of the CMS root. * - * @return string|NULL local file system path to CMS root, or NULL if it cannot be determined - */ - /** - * @return NULL|string + * @return string|NULL + * local file system path to CMS root, or NULL if it cannot be determined */ public function cmsRootPath() { $cmsRoot = $valid = NULL; @@ -727,7 +724,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Get User ID from UserFramework system (Joomla) * @param object $user * Object as described by the CMS. - * @return mixed + * + * @return int|null */ public function getUserIDFromUserObject($user) { return !empty($user->ID) ? $user->ID : NULL; @@ -737,7 +735,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { * Get Unique Identifier from UserFramework system (CMS) * @param object $user * Object as described by the User Framework. - * @return mixed $uniqueIdentifer Unique identifier from the user Framework system + * @return int|null + * Unique identifier from the user Framework system */ public function getUniqueIdentifierFromUserObject($user) { return empty($user->user_email) ? NULL : $user->user_email; diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index eb03666221..f6f60ab92d 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -96,8 +96,9 @@ class CRM_Utils_Token { * @param string $str * The message. * - * @return true|array true if all required tokens are found, - * else an array of the missing tokens + * @return bool|array + * true if all required tokens are found, + * else an array of the missing tokens * @static */ public static function requiredTokens(&$str) { @@ -1648,7 +1649,7 @@ class CRM_Utils_Token { * @param string $knownTokens * @param bool|string $escapeSmarty * - * @return unknown|Ambigous |mixed + * @return mixed */ public static function replaceContributionTokens($str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) { $key = 'contribution'; diff --git a/Civi/CiUtil/Command/AntagonistCommand.php b/Civi/CiUtil/Command/AntagonistCommand.php index 5d6e7bbe54..5c970cba79 100644 --- a/Civi/CiUtil/Command/AntagonistCommand.php +++ b/Civi/CiUtil/Command/AntagonistCommand.php @@ -30,13 +30,14 @@ class AntagonistCommand { * E.g. "MyTest::testFoo". * @param array $candidateTests * List of strings (e.g. "MyTest::testFoo"). - * @return array|null array contains keys: - * - antagonist: array - * - file: string - * - class: string - * - method: string - * - expectedResults: array - * - actualResults: array + * @return array|null + * array contains keys: + * - antagonist: array + * - file: string + * - class: string + * - method: string + * - expectedResults: array + * - actualResults: array */ public static function findAntagonist($target, $candidateTests) { //$phpUnit = new \Civi\CiUtil\EnvTestRunner('./scripts/phpunit', 'EnvTests'); diff --git a/Civi/CiUtil/PHPUnitParser.php b/Civi/CiUtil/PHPUnitParser.php index 4f32db21dc..06e0ec02aa 100644 --- a/Civi/CiUtil/PHPUnitParser.php +++ b/Civi/CiUtil/PHPUnitParser.php @@ -8,7 +8,8 @@ class PHPUnitParser { /** * @param string $content * Phpunit streaming JSON. - * @return array(string "$class::$func" => $status) + * @return array + * ["$class::$func" => $status] */ protected static function parseJsonStream($content) { $content = '[' diff --git a/api/Wrapper.php b/api/Wrapper.php index 5693e7153c..07e38f0181 100644 --- a/api/Wrapper.php +++ b/api/Wrapper.php @@ -6,17 +6,19 @@ interface API_Wrapper { /** - * @param $apiRequest + * @param array $apiRequest * - * @return modified $apiRequest + * @return array + * modified $apiRequest */ function fromApiInput($apiRequest); /** - * @param $apiRequest - * @param $result + * @param array $apiRequest + * @param array $result * - * @return modified $result + * @return array + * modified $result */ function toApiOutput($apiRequest, $result); } diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 859d4ae9c8..c2f629f826 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created acl property values. + * of newly created acl property values. * @access public */ function civicrm_api3_acl_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_acl_create($params) { * @param array $params * * @return array - * of retrieved acl property values. + * of retrieved acl property values. * @access public */ function civicrm_api3_acl_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_acl_get($params) { * @param array $params * * @return array - * of deleted values. + * of deleted values. * @access public */ function civicrm_api3_acl_delete($params) { diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index 4c5554805c..b86af8fe07 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created acl_role property values. + * of newly created acl_role property values. * @access public */ function civicrm_api3_acl_role_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_acl_role_create($params) { * @param array $params * * @return array - * of retrieved acl_role property values. + * of retrieved acl_role property values. * @access public */ function civicrm_api3_acl_role_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_acl_role_get($params) { * @param array $params * * @return array - * of deleted values. + * 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 721000cc23..e53721ced6 100644 --- a/api/v3/ActionSchedule.php +++ b/api/v3/ActionSchedule.php @@ -85,7 +85,7 @@ function _civicrm_api3_action_schedule_create_spec(&$params) { * to be deleted * * @return array - * API result array + * API result array * * @access public */ diff --git a/api/v3/Activity.php b/api/v3/Activity.php index a0cfd6b9fa..0709d6ea01 100644 --- a/api/v3/Activity.php +++ b/api/v3/Activity.php @@ -48,7 +48,7 @@ * * @throws API_Exception * @return array - * Array containing 'is_error' to denote success or failure and details of the created activity + * 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 @@ -257,7 +257,7 @@ function civicrm_api3_activity_get($params) { * API request parameters. * @param array $activities * @return array - * new activities list + * new activities list */ function _civicrm_api3_activity_get_formatResult($params, $activities) { $returns = CRM_Utils_Array::value('return', $params, array()); @@ -345,7 +345,7 @@ function civicrm_api3_activity_delete($params) { * @throws API_Exception * @throws Exception * @return array - * array with errors + * array with errors */ function _civicrm_api3_activity_check_params(&$params) { diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index 281fbeb1ce..d37ef93185 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -46,7 +46,7 @@ * @param array $params * * @return array - * of newly created activity contact records. + * of newly created activity contact records. * @access public */ function civicrm_api3_activity_contact_create($params) { @@ -71,7 +71,7 @@ function _civicrm_api3_activity_contact_create_spec(&$params) { * @param array $params * * @return array - * Api Result + * Api Result * * @example ActivityContact.php * @access public @@ -89,7 +89,7 @@ function civicrm_api3_activity_contact_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found tags else error + * details of found tags else error * * @access public */ diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php index 3a272a3e4b..a139f3b253 100644 --- a/api/v3/ActivityType.php +++ b/api/v3/ActivityType.php @@ -39,7 +39,7 @@ /** * @deprecated api notice * @return string - * to indicate this entire api entity is deprecated + * 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.'; @@ -51,7 +51,7 @@ function _civicrm_api3_activity_type_deprecation() { * @param array $params * * @return array - * activity types keyed by id + * activity types keyed by id * @access public * * @example ActivityTypeGet.php @@ -71,7 +71,7 @@ function civicrm_api3_activity_type_get($params) { * $params['option_value_id'] is required for updation of activity type * * @return array - * created / updated activity type + * created / updated activity type * * @access public * @@ -113,7 +113,7 @@ function _civicrm_api3_activity_type_create_spec(&$params) { * Array including id of activity_type to delete. * @return array - * API result array + * API result array * * @access public * diff --git a/api/v3/Address.php b/api/v3/Address.php index 4ba4d32577..d965dda803 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -46,7 +46,7 @@ * @param array $params * * @return array - * of newly created tag property values. + * of newly created tag property values. * @access public */ function civicrm_api3_address_create(&$params) { @@ -133,7 +133,7 @@ function _civicrm_api3_address_get_spec(&$params) { * {@example AddressDelete.php 0} * * @return array - * api result array + * api result array * @access public */ function civicrm_api3_address_delete($params) { @@ -151,7 +151,7 @@ function civicrm_api3_address_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found addresses else error + * details of found addresses else error * {@getfields address_get} * @access public */ diff --git a/api/v3/Attachment.php b/api/v3/Attachment.php index 6def32ffcc..8ff8fba0da 100644 --- a/api/v3/Attachment.php +++ b/api/v3/Attachment.php @@ -90,7 +90,7 @@ function _civicrm_api3_attachment_create_spec(&$spec) { * * @param array $params * @return array - * of newly created file property values. + * of newly created file property values. * @access public * @throws API_Exception validation errors */ @@ -166,7 +166,7 @@ function _civicrm_api3_attachment_get_spec(&$spec) { /** * @param array $params * @return array - * per APIv3 + * per APIv3 * @throws API_Exception validation errors */ function civicrm_api3_attachment_get($params) { @@ -296,7 +296,7 @@ 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) + * (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 @@ -397,7 +397,7 @@ function _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $retur /** * @return array - * list of fields (indexed by name) + * 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 8e98a7258d..bf4d674a75 100644 --- a/api/v3/Batch.php +++ b/api/v3/Batch.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created batch property values. + * of newly created batch property values. * @access public */ function civicrm_api3_batch_create($params) { @@ -81,7 +81,7 @@ function _civicrm_api3_batch_create_spec(&$params) { * @param array $params * * @return array - * of retrieved batch property values. + * of retrieved batch property values. * @access public */ function civicrm_api3_batch_get($params) { @@ -98,7 +98,7 @@ function civicrm_api3_batch_get($params) { * @param array $params * * @return array - * of deleted values. + * of deleted values. * @access public */ function civicrm_api3_batch_delete($params) { diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php index 6c35faa089..a9b9aa6d8f 100644 --- a/api/v3/Campaign.php +++ b/api/v3/Campaign.php @@ -46,7 +46,7 @@ * name/value pairs to insert in new 'campaign' * * @return array - * campaign array + * campaign array * {@getfields campaign_create} * @access public */ @@ -74,7 +74,7 @@ function _civicrm_api3_campaign_create_spec(&$params) { * as null, all campaigns will be returned * * @return array - * Array of matching campaigns + * Array of matching campaigns * @access public * {@getfields campaign_get} */ @@ -93,7 +93,7 @@ function civicrm_api3_campaign_get($params) { * to be deleted * * @return array - * (reference) returns flag true if successful, error + * (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 2c50985f64..351a848627 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -58,7 +58,7 @@ * * @throws API_Exception * @return array - * api result array + * api result array * * @access public * {@getfields case_create} @@ -198,7 +198,7 @@ function _civicrm_api3_case_delete_spec(&$params) { * * @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 + * (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 */ @@ -290,7 +290,7 @@ function civicrm_api3_case_activity_create($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * of deprecated actions */ function _civicrm_api3_case_deprecation() { return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.'); @@ -310,7 +310,7 @@ function _civicrm_api3_case_deprecation() { * * @throws API_Exception * @return array - * api result array + * api result array * * @access public */ @@ -377,7 +377,7 @@ function civicrm_api3_case_update($params) { * * @throws API_Exception * @return boolean - * true if success, else false + * true if success, else false * {@getfields case_delete} * @access public */ @@ -407,7 +407,7 @@ function civicrm_api3_case_delete($params) { * @param $options * * @return array - * case object + * 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 5ce89c943e..139b852d3e 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -46,7 +46,7 @@ * * @throws API_Exception * @return array - * API result array + * API result array * * @static void * @access public @@ -75,7 +75,7 @@ function civicrm_api3_case_type_create($params) { * @param array $params * * @return array - * case types keyed by id + * case types keyed by id * @access public */ function civicrm_api3_case_type_get($params) { @@ -116,7 +116,7 @@ function _civicrm_api3_case_type_get_formatResult(&$result) { * Array including id of case_type to delete. * @return array - * API result array + * API result array * * @access public * diff --git a/api/v3/Constant.php b/api/v3/Constant.php index f113c467ca..5270ca68dc 100644 --- a/api/v3/Constant.php +++ b/api/v3/Constant.php @@ -39,7 +39,7 @@ /** * @deprecated api notice * @return string - * to indicate this entire api entity is deprecated + * 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 d96f1dd9ce..fb619c9d76 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -51,7 +51,7 @@ * @example ContactCreate.php Example of Create Call * * @return array - * API Result Array + * API Result Array * * @static void * @access public @@ -146,7 +146,7 @@ function _civicrm_api3_contact_create_spec(&$params) { * @param array input parameters * * @return array - * API Result Array + * API Result Array * (@getfields contact_get} * @static void * @access public @@ -273,7 +273,7 @@ function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) { * (reference ) input parameters, contact_id element required. * * @return array - * API Result Array + * API Result Array * @access public * * @example ContactDelete.php @@ -857,7 +857,7 @@ LIMIT 0, {$limit} /** * @deprecated api notice * @return array - * of deprecated actions + * of deprecated actions */ function _civicrm_api3_contact_deprecation() { return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".'); @@ -877,7 +877,7 @@ function _civicrm_api3_contact_deprecation() { * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} * * @return array - * API Result Array + * API Result Array * * @static void * @access public diff --git a/api/v3/ContactType.php b/api/v3/ContactType.php index 00f2074628..aaabf1972e 100644 --- a/api/v3/ContactType.php +++ b/api/v3/ContactType.php @@ -46,7 +46,7 @@ * name/value pairs to insert in new 'contact_type' * * @return array - * contact_type array + * contact_type array * * @access public */ @@ -75,7 +75,7 @@ function civicrm_api3_contact_type_create($params) { * as null, all contact_types will be returned * * @return array - * Array of matching contact_types + * Array of matching contact_types * @access public */ function civicrm_api3_contact_type_get($params) { @@ -94,7 +94,7 @@ function civicrm_api3_contact_type_get($params) { * to be deleted * * @return array - * API Result Array + * API Result Array * * @access public */ diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 58022d4d94..3826f96b0b 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -45,7 +45,7 @@ * * @throws API_Exception * @return array - * Api result array + * Api result array * @static void * @access public * @example ContributionCreate.php @@ -178,7 +178,7 @@ function _civicrm_api3_contribution_create_legacy_support_45(&$params) { * (reference ) input parameters. * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public * {@getfields Contribution_delete} @@ -209,7 +209,7 @@ function _civicrm_api3_contribution_delete_spec(&$params) { * (reference ) input parameters. * * @return array - * of contributions, if error an array with an error id and error message + * of contributions, if error an array with an error id and error message * @static void * @access public * {@getfields Contribution_get} @@ -306,7 +306,7 @@ function _civicrm_api3_contribution_transact_spec(&$params) { * (reference ) input parameters. * * @return array - * (reference ) contribution of created or updated record (or a civicrm error) + * (reference ) contribution of created or updated record (or a civicrm error) * @static void * @access public * @@ -361,7 +361,7 @@ function civicrm_api3_contribution_transact($params) { * * @throws Exception * @return array - * Api result array + * Api result array * @static void * @access public */ @@ -419,7 +419,7 @@ function _civicrm_api3_contribution_sendconfirmation_spec(&$params) { * * @throws API_Exception * @return array - * Api result array + * Api result array * @static void * @access public */ diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php index e1343d2712..c2c54fdf6c 100644 --- a/api/v3/ContributionPage.php +++ b/api/v3/ContributionPage.php @@ -44,7 +44,7 @@ * @example ContributionPageCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields contribution_page_create} * @access public */ @@ -75,7 +75,7 @@ function _civicrm_api3_contribution_page_create_spec(&$params) { * Array of one or more valid property_name=>value pairs. * * @return array - * API Result array Array of matching contribution_pages + * API Result array Array of matching contribution_pages * {@getfields contribution_page_get} * @access public */ @@ -94,7 +94,7 @@ function civicrm_api3_contribution_page_get($params) { * to be deleted * * @return array - * API result Array + * API result Array * {@getfields contribution_page_delete} * @access public */ @@ -113,7 +113,7 @@ function civicrm_api3_contribution_page_delete($params) { * to be deleted * * @return array - * API result array + * API result array * {@getfields contribution_page_delete} * @access public */ diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php index 5527d35705..17345ccd4e 100644 --- a/api/v3/ContributionRecur.php +++ b/api/v3/ContributionRecur.php @@ -42,7 +42,7 @@ * @example ContributionRecurCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields contribution_recur_create} * @access public */ @@ -73,7 +73,7 @@ function _civicrm_api3_contribution_recur_create_spec(&$params) { * as null, all contribution_recurs will be returned * * @return array - * API result Array of matching contribution_recurs + * API result Array of matching contribution_recurs * {@getfields contribution_recur_get} * @access public */ @@ -88,7 +88,7 @@ function civicrm_api3_contribution_recur_get($params) { * (reference) array containing id of the recurring contribution. * * @return boolean - * returns true is successfully cancelled + * returns true is successfully cancelled */ function civicrm_api3_contribution_recur_cancel($params) { @@ -107,7 +107,7 @@ function civicrm_api3_contribution_recur_cancel($params) { * to be deleted * * @return array - * API result 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 5112d5009a..8d159beb3a 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -47,7 +47,7 @@ * @example ContributionSoftCreate.php Standard Create Example //FIXME * * @return array - * API result array + * API result array * {@getfields contribution_soft_create} * @access public */ @@ -76,7 +76,7 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) { * @example ContributionSoftDelete.php Standard Delete Example * * @return boolean - * | error true if successfull, error otherwise + * | error true if successfull, error otherwise * {@getfields contribution_soft_delete} * @access public */ @@ -98,7 +98,7 @@ function civicrm_api3_contribution_soft_delete($params) { * An associative array of name/value pairs. * * @return array - * api result + * api result * {@getfields contribution_soft_get} * @access public */ diff --git a/api/v3/Country.php b/api/v3/Country.php index 6676c1b395..524c7d97f3 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -47,7 +47,7 @@ require_once 'CRM/Core/DAO/Country.php'; * @example CountryCreate.php Standard Create Example * * @return array - * API result array + * API result array * {@getfields country_create} * @access public */ @@ -74,7 +74,7 @@ function _civicrm_api3_country_create_spec(&$params) { * @example CountryDelete.php Standard Delete Example * * @return boolean - * | error true if successfull, error otherwise + * | error true if successfull, error otherwise * {@getfields country_delete} * @access public */ @@ -94,7 +94,7 @@ function civicrm_api3_country_delete($params) { * An associative array of name/value pairs. * * @return array - * api result array + * api result array * {@getfields country_get} * @access public */ diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index 7989e14dbb..23f89ace2e 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -60,7 +60,7 @@ * Array Associative array of property name/value pairs to insert in group. * {@getfields CustomGroup_create} * - * @return Newly create custom_group object + * @return array * @todo $params['extends'] is array format - is that std compatible * @access public */ @@ -100,7 +100,7 @@ function _civicrm_api3_custom_group_create_spec(&$params) { * @param array id of the group to be deleted * * @return Null - * if success + * if success * @access public * {@getfields CustomGroup_delete} * @example CustomGroupDelete.php diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index a8f2fd8f8c..3d91e79642 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -11,7 +11,7 @@ * @example OptionValueGet.php * * @return array - * details of found Option Values + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -33,7 +33,7 @@ function civicrm_api3_custom_search_get($params) { * @param array $params * * @return array - * of newly created option_value property values. + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -73,7 +73,7 @@ function _civicrm_api3_custom_search_create_spec(&$params) { * {@example ReportTemplateDelete.php 0} * * @return array - * Api result + * Api result * {@getfields ReportTemplate_create} * @access public */ diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php index 667bd0f26b..afd2a74dbe 100644 --- a/api/v3/CustomValue.php +++ b/api/v3/CustomValue.php @@ -140,7 +140,7 @@ function _civicrm_api3_custom_value_create_spec(&$params) { * * @throws API_Exception * @return array - * + * * * @access public */ diff --git a/api/v3/Dashboard.php b/api/v3/Dashboard.php index 9e20621ed0..9762626fc3 100644 --- a/api/v3/Dashboard.php +++ b/api/v3/Dashboard.php @@ -46,7 +46,7 @@ * pairs for the Dashlet. * * @return array - * Array containing 'is_error' to denote success or failure and details of the created activity + * 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 ce1e671d49..1fd7849635 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -46,7 +46,7 @@ * @param array $params * * @return array - * API result array + * API result array * {@getfields email_create} * @access public */ @@ -76,7 +76,7 @@ function _civicrm_api3_email_create_spec(&$params) { * @example EmailDelete.php Standard Delete Example * * @return boolean - * | error true if successfull, error otherwise + * | error true if successfull, error otherwise * {@getfields email_delete} * @access public */ @@ -96,7 +96,7 @@ function civicrm_api3_email_delete($params) { * An associative array of name/value pairs. * * @return array - * api result array + * api result array * {@getfields email_get} * @access public */ diff --git a/api/v3/Entity.php b/api/v3/Entity.php index 982876b8a5..cfc64b5994 100644 --- a/api/v3/Entity.php +++ b/api/v3/Entity.php @@ -4,7 +4,7 @@ * @deprecated api notice * @param array entities * @return array - * of deprecated api entities + * 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 2914afefbe..37a4769885 100644 --- a/api/v3/EntityTag.php +++ b/api/v3/EntityTag.php @@ -111,11 +111,11 @@ function _civicrm_api3_entity_tag_delete_spec(&$params) { /** * - * @param $params + * @param array $params * @param string $op * * @return array - * + * */ function _civicrm_api3_entity_tag_common($params, $op = 'add') { diff --git a/api/v3/Event.php b/api/v3/Event.php index 7ffd8398b2..80059928c9 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -53,7 +53,7 @@ * {@getfields event_create} * * @return array - * API result Array. + * API result Array. * @access public */ function civicrm_api3_event_create($params) { @@ -106,7 +106,7 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) { * {@getfields event_get} * * @return Array - * of all found event property values. + * of all found event property values. * @access public * */ @@ -195,7 +195,7 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) { * Array containing event_id to be deleted. * * @return boolean - * true if success, error otherwise + * 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 56ff7786ab..7415dab7da 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -49,7 +49,7 @@ define('API_V3_EXTENSION_DELIMITER', ','); * using 'keys' should be more performant than making multiple API calls with 'key' * * @return array - * API result + * API result * @static void * @access public * @example ExtensionInstall.php @@ -75,7 +75,7 @@ function civicrm_api3_extension_install($params) { * Upgrade an extension - runs upgrade_N hooks and system.flush * * @return array - * API result + * API result * @static void * @access public * @@ -114,7 +114,7 @@ function civicrm_api3_extension_upgrade() { * using 'keys' should be more performant than making multiple API calls with 'key' * * @return array - * API result + * API result * @static void * @access public * @example ExtensionEnable.php @@ -140,7 +140,7 @@ function civicrm_api3_extension_enable($params) { * using 'keys' should be more performant than making multiple API calls with 'key' * * @return array - * API result + * API result * @static void * @access public * @example ExtensionDisable.php @@ -167,7 +167,7 @@ function civicrm_api3_extension_disable($params) { * - removeFiles: bool, whether to remove source tree; default: FALSE * * @return array - * API result + * API result * @static void * @access public * @example ExtensionUninstall.php @@ -194,7 +194,7 @@ function civicrm_api3_extension_uninstall($params) { * * @throws API_Exception * @return array - * API result + * API result * @static void * @access public * @example ExtensionDownload.php @@ -246,7 +246,7 @@ function civicrm_api3_extension_download($params) { * - remote: bool, whether to rescan remote repository (default: TRUE) * * @return array - * API result + * API result * @static void * @access public * @example ExtensionRefresh.php @@ -279,7 +279,7 @@ function civicrm_api3_extension_refresh($params) { * @param array $params * * @return array - * API result + * API result * @static void * @access public * @example ExtensionGet.php @@ -307,7 +307,7 @@ function civicrm_api3_extension_get($params) { * @param array $params * API request params with 'key' or 'keys'. * @return array - * of extension keys + * of extension keys * @throws API_Exception */ function _civicrm_api3_getKeys($params) { diff --git a/api/v3/File.php b/api/v3/File.php index b854ab447f..992b6ab92c 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -49,7 +49,7 @@ * An associative array of name/value property values of civicrm_file. * * @return array - * of newly created file property values. + * of newly created file property values. * @access public */ function civicrm_api3_file_create($params) { @@ -87,7 +87,7 @@ function civicrm_api3_file_create($params) { * An associative array of name/value property values of civicrm_file. * * @return Array - * of all found file object property values. + * of all found file object property values. * @access public */ function civicrm_api3_file_get($params) { @@ -105,7 +105,7 @@ function civicrm_api3_file_get($params) { * An array of name/value property values of civicrm_file. * * @return array - * of updated file object property values + * of updated file object property values * @access public */ function civicrm_api3_file_update($params) { @@ -137,7 +137,7 @@ function civicrm_api3_file_update($params) { * @param array $params * * @return array - * API result 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 70d3c1ee48..217b5a73b0 100644 --- a/api/v3/FinancialAccount.php +++ b/api/v3/FinancialAccount.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created financial_account property values. + * of newly created financial_account property values. * @access public */ function civicrm_api3_financial_account_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_financial_account_create($params) { * @param array $params * * @return array - * of retrieved financial_account property values. + * of retrieved financial_account property values. * @access public */ function civicrm_api3_financial_account_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_financial_account_get($params) { * @param array $params * * @return array - * of deleted values. + * 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 b51c00631e..77f4294730 100644 --- a/api/v3/FinancialType.php +++ b/api/v3/FinancialType.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created financial_type property values. + * of newly created financial_type property values. * @access public */ function civicrm_api3_financial_type_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_financial_type_create($params) { * @param array $params * * @return array - * of retrieved financial_type property values. + * of retrieved financial_type property values. * @access public */ function civicrm_api3_financial_type_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_financial_type_get($params) { * @param array $params * * @return array - * of deleted values. + * 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 7f2ed076bb..aca852d020 100644 --- a/api/v3/Generic.php +++ b/api/v3/Generic.php @@ -18,7 +18,7 @@ * - function: callback (mixed) * - params: array, varies * @return array - * API success object + * API success object */ function civicrm_api3_generic_getfields($apiRequest) { static $results = array(); @@ -151,7 +151,7 @@ function civicrm_api3_generic_getfields($apiRequest) { * * @throws API_Exception * @return integer - * count of results + * count of results */ function civicrm_api3_generic_getcount($apiRequest) { $apiRequest['params']['options']['is_count'] = TRUE; @@ -172,7 +172,7 @@ function civicrm_api3_generic_getcount($apiRequest) { * Api request as an array. Keys are. * * @return integer - * count of results + * count of results */ function civicrm_api3_generic_getsingle($apiRequest) { // so the first entity is always result['values'][0] @@ -197,7 +197,7 @@ function civicrm_api3_generic_getsingle($apiRequest) { * Api request as an array. Keys are. * * @return integer - * count of results + * count of results */ function civicrm_api3_generic_getvalue($apiRequest) { $apiRequest['params']['sequential'] = 1; @@ -238,7 +238,7 @@ function _civicrm_api3_generic_getrefcount_spec(&$params) { * * @throws API_Exception * @return array - * API result (int 0 or 1) + * API result (int 0 or 1) */ function civicrm_api3_generic_getrefcount($apiRequest) { $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass(); @@ -265,7 +265,7 @@ function civicrm_api3_generic_getrefcount($apiRequest) { * Api request as an array. Keys are. * * @return integer - * count of results + * count of results */ function civicrm_api3_generic_replace($apiRequest) { return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']); @@ -278,7 +278,7 @@ function civicrm_api3_generic_replace($apiRequest) { * Api request as an array. * * @return array - * of results + * of results */ function civicrm_api3_generic_getoptions($apiRequest) { // Resolve aliases @@ -316,7 +316,7 @@ function civicrm_api3_generic_getoptions($apiRequest) { * * @param array $metadata * The array of metadata that will form the result of the getfields function. - * @param $apiRequest + * @param array $apiRequest * @param string $fieldname * Field currently being processed. * @param array $fieldSpec diff --git a/api/v3/Generic/Getactions.php b/api/v3/Generic/Getactions.php index 2b3a7eac71..8a04787d36 100644 --- a/api/v3/Generic/Getactions.php +++ b/api/v3/Generic/Getactions.php @@ -27,7 +27,7 @@ */ /** - * @param $apiRequest + * @param array $apiRequest * * @return array * @throws API_Exception diff --git a/api/v3/Generic/Getlist.php b/api/v3/Generic/Getlist.php index 028b6fc7db..84113607dc 100644 --- a/api/v3/Generic/Getlist.php +++ b/api/v3/Generic/Getlist.php @@ -28,7 +28,7 @@ /** * Generic api wrapper used for quicksearch and autocomplete * - * @param $apiRequest + * @param array $apiRequest * Array. * @return mixed */ diff --git a/api/v3/Generic/Setvalue.php b/api/v3/Generic/Setvalue.php index 249abba758..ce58034bc4 100644 --- a/api/v3/Generic/Setvalue.php +++ b/api/v3/Generic/Setvalue.php @@ -2,7 +2,7 @@ /** * params must contain at least id=xx & {one of the fields from getfields}=value * - * @param $apiRequest + * @param array $apiRequest * * @throws API_Exception * @return array diff --git a/api/v3/Grant.php b/api/v3/Grant.php index 1ba1c95618..aae2dffcae 100644 --- a/api/v3/Grant.php +++ b/api/v3/Grant.php @@ -46,7 +46,7 @@ * name/value pairs to insert in new 'grant' * * @return array - * grant array + * grant array * {@getfields grant_create} * @access public */ @@ -75,7 +75,7 @@ function _civicrm_api3_grant_create_spec(&$params) { * as null, all grants will be returned * * @return array - * Array of matching grants + * Array of matching grants * {@getfields grant_get} * @access public */ @@ -94,7 +94,7 @@ function civicrm_api3_grant_get($params) { * to be deleted * * @return array - * API Result Array + * API Result Array * {@getfields grant_delete} * @access public */ diff --git a/api/v3/Group.php b/api/v3/Group.php index 57837c0638..e2efd23da7 100644 --- a/api/v3/Group.php +++ b/api/v3/Group.php @@ -48,7 +48,7 @@ * name/value pairs to insert in new 'group' * * @return array - * API result array + * API result array * @example GroupCreate.php * {@getfields group_create} * @access public @@ -78,7 +78,7 @@ function _civicrm_api3_group_create_spec(&$params) { * as null, all groups will be returned * * @return array - * Array of matching groups + * Array of matching groups * @example GroupGet.php * {@getfields group_get} * @access public @@ -107,7 +107,7 @@ function civicrm_api3_group_get($params) { * to be deleted * * @return array - * API result array + * API result array * @example GroupDelete.php * {@getfields group_delete} * diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index 5917500355..5d7e680706 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -50,7 +50,7 @@ * {@getfields GroupContact_get} * * @return array - * list of groups, given contact subsribed to + * list of groups, given contact subsribed to */ function civicrm_api3_group_contact_get($params) { @@ -86,7 +86,7 @@ function civicrm_api3_group_contact_get($params) { * {@example GroupContactCreate.php 0} * * @return array - * Information about operation results + * Information about operation results * * On success, the return array will be structured as follows: * array( @@ -125,10 +125,10 @@ function civicrm_api3_group_contact_create($params) { /** * - * @param $params + * @param array $params * * @return array - * + * * @deprecated */ function civicrm_api3_group_contact_delete($params) { @@ -147,9 +147,9 @@ function _civicrm_api3_group_contact_delete_spec(&$params) { /** * - * @param $params + * @param array $params * - * @return array|int + * @return array|int * @deprecated */ function civicrm_api3_group_contact_pending($params) { @@ -247,7 +247,7 @@ function civicrm_api3_group_contact_update_status($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * of deprecated actions */ function _civicrm_api3_group_contact_deprecation() { return array( diff --git a/api/v3/GroupNesting.php b/api/v3/GroupNesting.php index 358957e0eb..498bd0dfc1 100644 --- a/api/v3/GroupNesting.php +++ b/api/v3/GroupNesting.php @@ -45,7 +45,7 @@ * {@getfields GroupNesting_get} * * @return array - * list of group nesting records + * list of group nesting records */ function civicrm_api3_group_nesting_get($params) { @@ -60,7 +60,7 @@ function civicrm_api3_group_nesting_get($params) { * Parameters array - allowed array keys include:. * * @return array - * TBD + * TBD * {@getfields GroupNesting_create * @todo Work out the return value. */ @@ -93,7 +93,7 @@ function _civicrm_api3_group_nesting_create_spec(&$params) { * {@getfields GroupNesting_delete} * * @return array - * API Success or fail 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 f94c712189..b450dcd17e 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -50,7 +50,7 @@ * @example GroupOrganizationGet.php * * @return array - * list of groups, given contact subsribed to + * list of groups, given contact subsribed to */ function civicrm_api3_group_organization_get($params) { return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); @@ -99,7 +99,7 @@ function _civicrm_api3_group_organization_create_spec(&$params) { * With 'id' = ID of the Group Organization to be deleted. * * @return array - * API Result + * API Result * {@getfields GroupOrganization_delete} * @example GroupOrganizationDelete.php * @access public diff --git a/api/v3/Im.php b/api/v3/Im.php index 68a9170264..8b03d4fdb2 100644 --- a/api/v3/Im.php +++ b/api/v3/Im.php @@ -43,7 +43,7 @@ * @param array $params * * @return array - * of newly created IM property values. + * of newly created IM property values. * @access public */ function civicrm_api3_im_create($params) { @@ -68,7 +68,7 @@ function _civicrm_api3_im_create_spec(&$params) { * {@getfields im_delete} * * @return array - * API result Array + * API result Array * @access public * @todo convert to using Basic delete - BAO function non standard */ @@ -85,7 +85,7 @@ function civicrm_api3_im_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found IM + * details of found IM * * @access public */ diff --git a/api/v3/Job.php b/api/v3/Job.php index 61d8ebb774..e617841c6c 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -62,7 +62,7 @@ function _civicrm_api3_job_create_spec(&$params) { * @param array $params * Associative array of property name/value pairs to insert in new job. * - * @return success or error + * @return array * {@getfields Job_create} * @access public * {@schema Core/Job.xml} @@ -75,7 +75,7 @@ function civicrm_api3_job_create($params) { * Retrieve one or more job * @param array input parameters * @return array - * api result array + * api result array * {@getfields email_get} * @access public */ @@ -89,7 +89,7 @@ function civicrm_api3_job_get($params) { * @param array $params * * @return array - * API Result Array + * API Result Array * {@getfields Job_delete} * @static void * @access public @@ -106,7 +106,7 @@ function civicrm_api3_job_delete($params) { * (reference ) input parameters. * * @return array - * API Result Array + * API Result Array * * @static void * @access public @@ -136,7 +136,7 @@ function _civicrm_api3_job_execute_spec(&$params) { * (reference ) input parameters. * * @return array - * API Result Array + * API Result Array * {@getfields contact_geocode} * * @static void @@ -180,7 +180,7 @@ function _civicrm_api3_job_geocode_spec(&$params) { * - makes testing a bit simpler since we can simulate past/future time * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public * @@ -231,7 +231,7 @@ function _civicrm_api3_job_send_reminder(&$params) { * resetVal - Integer - should we reset form state (always true)? * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public * @@ -259,7 +259,7 @@ function civicrm_api3_job_mail_report($params) { * @param array $params * * @return boolean - * true if success, else false + * true if success, else false * @static * @access public */ @@ -294,11 +294,11 @@ function civicrm_api3_job_update_greeting($params) { /** * Adjust Metadata for Get action -* -* The metadata is used for setting defaults, documentation & validation -* @param array $params -* Array or parameters determined by getfields. -*/ + * + * The metadata is used for setting defaults, documentation & validation + * @param array $params + * Array or parameters determined by getfields. + */ function _civicrm_api3_job_update_greeting_spec(&$params) { $params['ct'] = array( 'api.required' => 1, @@ -319,7 +319,7 @@ function _civicrm_api3_job_update_greeting_spec(&$params) { * (reference ) input parameters. * * @return boolean - * true if success, else false + * true if success, else false * @static * @access public * @@ -428,7 +428,7 @@ function civicrm_api3_job_fetch_activities($params) { * (reference ) input parameters. * * @return array - * (reference ) array of properties, if error an array with an error id and error message + * array of properties, if error an array with an error id and error message * @access public */ function civicrm_api3_job_process_participant($params) { @@ -454,7 +454,7 @@ function civicrm_api3_job_process_participant($params) { * Input parameters NOT USED. * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public */ @@ -482,7 +482,7 @@ function civicrm_api3_job_process_membership($params) { * (reference ) input parameters. * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public */ @@ -511,7 +511,7 @@ function civicrm_api3_job_process_respondent($params) { * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} * * @return array - * API Result Array + * API Result Array * * @static void * @access public @@ -576,7 +576,7 @@ function civicrm_api3_job_run_payment_cron($params) { * (reference ) - sends in various config parameters to decide what needs to be cleaned. * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public */ diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php index 6460908d19..466ca955f4 100644 --- a/api/v3/LineItem.php +++ b/api/v3/LineItem.php @@ -44,7 +44,7 @@ * @example LineItemCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields line_item_create} * @access public */ @@ -76,7 +76,7 @@ function _civicrm_api3_line_item_create_spec(&$params) { * as null, all line_items will be returned (default limit is 25) * * @return array - * Array of matching line_items + * Array of matching line_items * {@getfields line_item_get} * @access public */ @@ -95,7 +95,7 @@ function civicrm_api3_line_item_get($params) { * to be deleted * * @return array - * API result array + * API result array * {@getfields line_item_delete} * @access public */ diff --git a/api/v3/LocBlock.php b/api/v3/LocBlock.php index 4cbf6b0e5c..e357b831b2 100644 --- a/api/v3/LocBlock.php +++ b/api/v3/LocBlock.php @@ -44,7 +44,7 @@ * @example LocBlockCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields loc_block_create} * @access public */ @@ -96,7 +96,7 @@ function civicrm_api3_loc_block_create($params) { * as null, all loc_blocks will be returned (default limit is 25) * * @return array - * Array of matching loc_blocks + * Array of matching loc_blocks * {@getfields loc_block_get} * @access public */ @@ -135,7 +135,7 @@ function civicrm_api3_loc_block_get($params) { * Array containing id of the record to be deleted. * * @return array - * API result array + * API result array * {@getfields loc_block_delete} * @access public */ diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php index db44762d2c..b6eac2dd34 100644 --- a/api/v3/LocationType.php +++ b/api/v3/LocationType.php @@ -46,7 +46,7 @@ * @param array $params * * @return array - * API result array + * API result array * {@getfields email_create} * @access public */ @@ -79,7 +79,7 @@ function _civicrm_api3_location_type_create_spec(&$params) { * @example LocationTypeDelete.php Standard Delete Example * * @return array - * API result array + * API result array * {@getfields LocationType_delete} * @access public */ @@ -99,7 +99,7 @@ function civicrm_api3_location_type_delete($params) { * An associative array of name/value pairs. * * @return array - * api result + * api result * {@getfields LocationType_get} * @access public */ diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php index c8c34ee073..c6d7ff44c5 100644 --- a/api/v3/MailSettings.php +++ b/api/v3/MailSettings.php @@ -43,7 +43,7 @@ * @example mail_settingsCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields mail_settings_create} * @access public */ @@ -71,7 +71,7 @@ function _civicrm_api3_mail_settings_create_spec(&$params) { * as null, all mail_settings will be returned * * @return array - * Array of matching mail_settings + * Array of matching mail_settings * {@getfields mail_settings_get} * @access public */ @@ -90,7 +90,7 @@ function civicrm_api3_mail_settings_get($params) { * to be deleted * * @return array - * api result array + * api result array * {@getfields mail_settings_delete} * @access public */ diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index bc27bf1d91..b551c8c7d3 100755 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -48,7 +48,7 @@ * @param array $ids * * @return array - * API Success Array + * API Success Array */ function civicrm_api3_mailing_create($params, $ids = array()) { if (CRM_Mailing_Info::workflowEnabled()) { @@ -117,7 +117,7 @@ function _civicrm_api3_mailing_create_spec(&$params) { * @param array $ids * * @return array - * API Success Array + * API Success Array */ function civicrm_api3_mailing_delete($params, $ids = array()) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -242,7 +242,7 @@ function civicrm_api3_mailing_event_confirm($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * 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 fbbe48d492..9a7250fd9f 100755 --- a/api/v3/MailingAB.php +++ b/api/v3/MailingAB.php @@ -48,7 +48,7 @@ * @param array $ids * * @return array - * API Success Array + * API Success Array */ function civicrm_api3_mailing_a_b_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -61,7 +61,7 @@ function civicrm_api3_mailing_a_b_create($params) { * @param array $ids * * @return array - * API Success 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 784f4e13ff..91046a7a3e 100644 --- a/api/v3/MailingComponent.php +++ b/api/v3/MailingComponent.php @@ -45,7 +45,7 @@ * * @throws API_Exception * @return array - * of newly created mailing_component property values. + * of newly created mailing_component property values. * @access public */ function civicrm_api3_mailing_component_create($params) { @@ -62,7 +62,7 @@ function civicrm_api3_mailing_component_create($params) { * @param array $params * * @return array - * of retrieved mailing_component property values. + * of retrieved mailing_component property values. * @access public */ function civicrm_api3_mailing_component_get($params) { @@ -80,7 +80,7 @@ function civicrm_api3_mailing_component_get($params) { * * @throws API_Exception * @return array - * of deleted values. + * 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 925b410204..69b504532d 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -46,7 +46,7 @@ * - Future extensions will include: Opened, Clicked, Forwarded * * @return array - * API result + * API result * @static void * @access public * @example CRM/Mailing/BAO/Mailing.php @@ -295,7 +295,7 @@ INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id * - Future extensions will include: Opened, Clicked, Forwarded * * @return array - * API result + * 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 6f45668e0f..32281b684f 100644 --- a/api/v3/MailingEventConfirm.php +++ b/api/v3/MailingEventConfirm.php @@ -46,7 +46,7 @@ * * @throws Exception * @return array - * api result array + * api result array * {@getfields mailing_event_confirm_create} * @access public */ diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index f78eb10d90..7c7b681f26 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -43,7 +43,7 @@ * * @throws Exception * @return array - * api result array + * api result array * {@getfields mailing_event_confirm_create} * @access public */ diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php index 59c79976fd..07edb38c8f 100644 --- a/api/v3/MailingEventResubscribe.php +++ b/api/v3/MailingEventResubscribe.php @@ -45,7 +45,7 @@ * name/value pairs to insert in new 'survey' * * @return array - * api result array + * api result array * {@getfields mailing_event_subscribe_create} * @access public */ diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php index 405f0ac416..3403e66a55 100644 --- a/api/v3/MailingEventSubscribe.php +++ b/api/v3/MailingEventSubscribe.php @@ -46,7 +46,7 @@ * * @throws API_Exception * @return array - * api result array + * api result array * {@getfields mailing_event_subscribe_create} * @access public */ diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php index 7ce0d47030..675510489c 100644 --- a/api/v3/MailingEventUnsubscribe.php +++ b/api/v3/MailingEventUnsubscribe.php @@ -45,7 +45,7 @@ * name/value pairs to insert in new 'survey' * * @return array - * api result array + * api result array * {@getfields mailing_event_unsubscribe_create} * @access public */ diff --git a/api/v3/MailingGroup.php b/api/v3/MailingGroup.php index 2970102627..b24f8f86ab 100644 --- a/api/v3/MailingGroup.php +++ b/api/v3/MailingGroup.php @@ -40,7 +40,7 @@ /** * @deprecated api notice * @return string - * to indicate this entire api entity is deprecated + * 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 fd2ffb956e..8aee61694c 100644 --- a/api/v3/MailingJob.php +++ b/api/v3/MailingJob.php @@ -69,7 +69,7 @@ function _civicrm_api3_mailing_job_create_spec(&$params) { * @param array $ids * * @return array - * API return Array of matching mailing jobs + * 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 f2bef71e8c..37fdc90b29 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -50,7 +50,7 @@ * @param array $ids * * @return array - * API return Array of matching mailing jobs + * 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 380a05e421..04452a6773 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -46,7 +46,7 @@ * Array array holding id - Id of the contact membership to be deleted. * * @return array - * api result + * api result * {@getfields membership_delete} * @access public */ @@ -64,7 +64,7 @@ function civicrm_api3_membership_delete($params) { * An associative array of name/value property values of civicrm_membership. * * @return array - * of newly created membership property values. + * of newly created membership property values. * {@getfields membership_create} * @access public */ @@ -190,7 +190,7 @@ function _civicrm_api3_membership_get_spec(&$params) { * for just passing the contact_id itself as the argument * * @return Array - * of all found membership property values. + * 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} @@ -241,7 +241,7 @@ function civicrm_api3_membership_get($params) { * @param $activeOnly * * @return array - * result for calling function + * result for calling function */ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) { // get the membership for the given contact ID @@ -264,7 +264,7 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp * @param int $contactID * * @return array - * result for calling function + * 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 e48d6cb8a0..3bc8fb3161 100644 --- a/api/v3/MembershipBlock.php +++ b/api/v3/MembershipBlock.php @@ -44,7 +44,7 @@ * An associative array of name/value property values of civicrm_membership_block. * * @return array - * newly created or updated membership type property values. + * newly created or updated membership type property values. * @access public * {getfields MembershipBlock_get} */ @@ -75,7 +75,7 @@ function _civicrm_api3_membership_block_create_spec(&$params) { * {getfields MembershipBlock_get} * * @return array - * api result array of all found membership block property values. + * api result array of all found membership block property values. * @access public */ function civicrm_api3_membership_block_get($params) { @@ -91,7 +91,7 @@ function civicrm_api3_membership_block_get($params) { * @param array $params * * @return array - * api result array + * api result array * @access public * {getfields MembershipBlock_delete} */ diff --git a/api/v3/MembershipPayment.php b/api/v3/MembershipPayment.php index 3d3909bc2f..c91ab350ad 100644 --- a/api/v3/MembershipPayment.php +++ b/api/v3/MembershipPayment.php @@ -43,7 +43,7 @@ * (reference ) input parameters. * * @return array - * (reference ) membership_payment_id of created or updated record + * (reference ) membership_payment_id of created or updated record * {@getfields MembershipPayment_create} * @example MembershipPaymentCreate.php * @access public @@ -72,7 +72,7 @@ function _civicrm_api3_membership_payment_create_spec(&$params) { * Input parameters. * * @return array - * array of properties, if error an array with an error id and error message + * 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 f2059219ee..f9a9dbe4e9 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -46,7 +46,7 @@ * An associative array of name/value property values of civicrm_membership_status. * * @return array - * of newly created membership status property values. + * of newly created membership status property values. * {@getfields MembershipStatus_create} * @access public */ @@ -63,7 +63,7 @@ function civicrm_api3_membership_status_create($params) { * An associative array of name/value property values of civicrm_membership_status. * * @return Array - * of all found membership status property values. + * of all found membership status property values. * {@getfields MembershipStatus_get} * @access public */ @@ -82,7 +82,7 @@ function civicrm_api3_membership_status_get($params) { * @deprecated - should just use create * * @return array - * of updated membership status property values + * of updated membership status property values * @access public */ function &civicrm_api3_membership_status_update($params) { @@ -124,7 +124,7 @@ function &civicrm_api3_membership_status_update($params) { * {@getfields MembershipStatus_delete} * * @return array - * i + * i * @access public */ function civicrm_api3_membership_status_delete($params) { @@ -144,7 +144,7 @@ function civicrm_api3_membership_status_delete($params) { * @throws API_Exception * * @return Array - * Array of status id and status name + * 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 7a31e1bbfe..b8ac452fb4 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -44,7 +44,7 @@ * An associative array of name/value property values of civicrm_membership_type. * * @return array - * newly created or updated membership type property values. + * newly created or updated membership type property values. * @access public * {getfields MembershipType_get} */ @@ -89,7 +89,7 @@ function _civicrm_api3_membership_type_create_spec(&$params) { * {getfields MembershipType_get} * * @return Array - * of all found membership type property values. + * of all found membership type property values. * @access public */ function civicrm_api3_membership_type_get($params) { @@ -105,7 +105,7 @@ function civicrm_api3_membership_type_get($params) { * @param array $params * * @return boolean - * true if success, else false + * true if success, else false * @access public * {getfields MembershipType_delete} */ diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index c2e67ccb48..150f99d782 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -59,7 +59,7 @@ function _civicrm_api3_message_template_create_spec(&$params) { * @param array $params * * @return boolean - * | error true if successfull, error otherwise + * | error true if successfull, error otherwise * {@getfields message_template_delete} * @access public */ @@ -85,7 +85,7 @@ function _civicrm_api3_message_template_get_spec(&$params) { * An associative array of name/value pairs. * * @return array - * api result array + * api result array * {@getfields message_template_get} * @access public */ diff --git a/api/v3/Note.php b/api/v3/Note.php index b938fbc06e..663c429785 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -52,7 +52,7 @@ * {@getfields note_create} * * @return array - * API result array + * API result array * @access public * @example NoteCreate.php Create example * @@ -101,7 +101,7 @@ function civicrm_api3_note_delete($params) { * Input parameters. * * @return array - * array of properties, + * array of properties, * if error an array with an error id and error message * {@getfields note_get} * @static void @@ -130,7 +130,7 @@ function _civicrm_api3_note_get_spec(&$params) { * Associative array; only required 'id' parameter is used. * * @return array - * Nested associative array beginning with direct children of given note. + * 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 2b18005c73..fbd1c79ad5 100644 --- a/api/v3/OptionGroup.php +++ b/api/v3/OptionGroup.php @@ -21,7 +21,7 @@ function civicrm_api3_option_group_get($params) { * name/value pairs to insert in new 'survey' * * @return array - * survey array + * survey array * * @access public */ @@ -51,7 +51,7 @@ function _civicrm_api3_option_group_create_spec(&$params) { * to be deleted * * @return array - * API Result Array + * API Result Array * message otherwise * {@getfields OptionGroup_delete} * @access public diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index 76fee5dd21..cc80aecf0f 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -9,7 +9,7 @@ * @example OptionValueGet.php * * @return array - * details of found Option Values + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -38,7 +38,7 @@ function civicrm_api3_option_value_get($params) { * * @throws API_Exception * @return array - * of newly created option_value property values. + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -80,7 +80,7 @@ function _civicrm_api3_option_value_create_spec(&$params) { * {@example OptionValueDelete.php 0} * * @return array - * Api result + * Api result * {@getfields OptionValue_create} * @access public */ diff --git a/api/v3/Participant.php b/api/v3/Participant.php index 52893a6f03..14f55c8934 100644 --- a/api/v3/Participant.php +++ b/api/v3/Participant.php @@ -52,7 +52,7 @@ * An associative array of name/value property values of civicrm_participant. * * @return array - * apiresult + * apiresult * {@getfields participant_create} * @access public */ @@ -165,7 +165,7 @@ function _civicrm_api3_participant_create_spec(&$params) { * (reference ) input parameters. * * @return array - * (reference ) array of properties, if error an array with an error id and error message + * (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 31d8d0c1df..76ccc6782f 100644 --- a/api/v3/ParticipantPayment.php +++ b/api/v3/ParticipantPayment.php @@ -53,7 +53,7 @@ * {@example ParticipantPaymentCreate.php 0} * * @return array - * of newly created payment property values. + * of newly created payment property values. * {@getfields ParticipantPayment_create} * @access public */ @@ -91,7 +91,7 @@ function _civicrm_api3_participant_payment_create_spec(&$params) { * @param array $params * * @return array - * API result + * API result * @example ParticipantPaymentDelete.php * {@getfields ParticipantPayment_delete} * @access public @@ -109,7 +109,7 @@ function civicrm_api3_participant_payment_delete($params) { * Input parameters. * * @return array - * array of properties, if error an array with an error id and error message + * 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 295bdc97cc..2dc676ea47 100644 --- a/api/v3/ParticipantStatusType.php +++ b/api/v3/ParticipantStatusType.php @@ -46,7 +46,7 @@ * name/value pairs to insert in new 'participant_status' * * @return array - * participant_status array + * participant_status array * {@getfields ParticipantStatusType_create} * @example ParticipantStatusTypeCreate.php * @access public @@ -64,7 +64,7 @@ function civicrm_api3_participant_status_type_create($params) { * as null, all participant_statuses will be returned * * @return array - * Array of matching participant_statuses + * Array of matching participant_statuses * {@getfields ParticipantStatusType_get} * @example ParticipantStatusTypeGet.php * @access public @@ -84,7 +84,7 @@ function civicrm_api3_participant_status_type_get($params) { * to be deleted * * @return array - * api result 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 c842f10ea1..4b95d99021 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -43,7 +43,7 @@ * @param array $params * * @return array - * of newly created PaymentProcessor property values. + * of newly created PaymentProcessor property values. * @access public */ function civicrm_api3_payment_processor_create($params) { @@ -70,7 +70,7 @@ function _civicrm_api3_payment_processor_create_spec(&$params) { * {@getfields payment_processor_delete} * * @return array - * API result Array + * API result Array * @access public */ function civicrm_api3_payment_processor_delete($params) { @@ -86,7 +86,7 @@ function civicrm_api3_payment_processor_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found PaymentProcessor + * 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 cba196c112..28a6b1a4f2 100644 --- a/api/v3/PaymentProcessorType.php +++ b/api/v3/PaymentProcessorType.php @@ -47,7 +47,7 @@ * @param array $params * Associative array of property name/value pairs to insert in new payment_processor type. * - * @return Newly created PaymentProcessor_type object + * @return array * {@getfields PaymentProcessorType_create} * @access public * {@schema Core/PaymentProcessorType.xml} @@ -102,7 +102,7 @@ function civicrm_api3_payment_processor_type_get($params) { * @param id of payment_processor type $id * * @return array - * API Result Array + * API Result Array * {@getfields PaymentProcessorType_delete} * @static void * @access public diff --git a/api/v3/Phone.php b/api/v3/Phone.php index 60749eaf52..92ff78bd57 100644 --- a/api/v3/Phone.php +++ b/api/v3/Phone.php @@ -46,7 +46,7 @@ * @param array $params * * @return array - * of newly created phone property values. + * of newly created phone property values. * @access public */ function civicrm_api3_phone_create($params) { @@ -73,7 +73,7 @@ function _civicrm_api3_phone_create_spec(&$params) { * @param array $params * * @return array - * Api Result + * 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 4363ee546b..4b5eec5e5f 100644 --- a/api/v3/Phone/Get.php +++ b/api/v3/Phone/Get.php @@ -11,7 +11,7 @@ * An associative array of name/value pairs. * * @return array - * details of found phones else error + * 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 08bc895769..0f00e791e2 100644 --- a/api/v3/Pledge.php +++ b/api/v3/Pledge.php @@ -50,7 +50,7 @@ * {@getfields pledge_create} * * @return array - * Array containing 'is_error' to denote success or failure and details of the created pledge + * Array containing 'is_error' to denote success or failure and details of the created pledge * * @example PledgeCreate.php Standard create example * @@ -70,7 +70,7 @@ function civicrm_api3_pledge_create($params) { * Array included 'pledge_id' of pledge to delete. * * @return boolean - * true if success, else false + * true if success, else false * @static void * {@getfields pledge_delete} * @example PledgeDelete.php @@ -132,7 +132,7 @@ function _civicrm_api3_pledge_create_spec(&$params) { * Input parameters. Use interrogate for possible fields. * * @return array - * array of pledges, if error an array with an error id and error message + * 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 763f2a5fc9..a7e2a3ce7e 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -51,7 +51,7 @@ * @example PledgePaymentCreate.php * * @return array - * API Result + * API Result * @static void * @access public */ @@ -101,7 +101,7 @@ function _civicrm_api3_pledge_payment_create_spec(&$params) { * @example PledgePaymentDelete.php * * @return array - * API result + * API result * @static void * @access public */ @@ -124,7 +124,7 @@ function civicrm_api3_pledge_payment_delete($params) { * @example PledgePaymentGet.php * * * @return array - * (reference ) array of pledges, if error an array with an error id and error message + * (reference ) array of pledges, if error an array with an error id and error message * @static void * @access public */ @@ -152,7 +152,7 @@ function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) { * @param array $params * * @return array - * fields valid for other functions + * 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 59831940b7..b3d0eab946 100644 --- a/api/v3/Premium.php +++ b/api/v3/Premium.php @@ -45,7 +45,7 @@ * * @throws API_Exception * @return array - * of newly created premium property values. + * of newly created premium property values. * @access public */ function civicrm_api3_premium_create($params) { @@ -62,7 +62,7 @@ function civicrm_api3_premium_create($params) { * @param array $params * * @return array - * of retrieved premium property values. + * of retrieved premium property values. * @access public */ function civicrm_api3_premium_get($params) { @@ -80,7 +80,7 @@ function civicrm_api3_premium_get($params) { * * @throws API_Exception * @return array - * of deleted values. + * of deleted values. * @access public */ function civicrm_api3_premium_delete($params) { diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php index 4709a89fcf..d7dd42d2af 100644 --- a/api/v3/PriceField.php +++ b/api/v3/PriceField.php @@ -44,7 +44,7 @@ * @example PriceFieldCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields price_field_create} * @access public */ @@ -71,7 +71,7 @@ function _civicrm_api3_price_field_create_spec(&$params) { * as null, all price_fields will be returned (default limit is 25) * * @return array - * Array of matching price_fields + * Array of matching price_fields * {@getfields price_field_get} * @access public */ @@ -90,7 +90,7 @@ function civicrm_api3_price_field_get($params) { * to be deleted * * @return array - * API result array + * API result array * {@getfields price_field_delete} * @access public */ diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php index 376eeda161..f52967e1b3 100644 --- a/api/v3/PriceFieldValue.php +++ b/api/v3/PriceFieldValue.php @@ -44,7 +44,7 @@ * @example PriceFieldValueCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields price_field_value_create} * @access public */ @@ -84,7 +84,7 @@ function _civicrm_api3_price_field_value_create_spec(&$params) { * as null, all price_field_values will be returned (default limit is 25) * * @return array - * Array of matching price_field_values + * Array of matching price_field_values * {@getfields price_field_value_get} * @access public */ @@ -103,7 +103,7 @@ function civicrm_api3_price_field_value_get($params) { * to be deleted * * @return array - * API result array + * API result array * {@getfields price_field_value_delete} * @access public */ diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php index 1c89358f5b..326648cd81 100644 --- a/api/v3/PriceSet.php +++ b/api/v3/PriceSet.php @@ -44,7 +44,7 @@ * @example PriceSetCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields price_set_create} * @access public */ @@ -85,7 +85,7 @@ function _civicrm_api3_price_set_create_spec(&$params) { * as null, all price_sets will be returned (default limit is 25) * * @return array - * Array of matching price_sets + * Array of matching price_sets * {@getfields price_set_get} * @access public */ @@ -114,7 +114,7 @@ function civicrm_api3_price_set_get($params) { * to be deleted * * @return array - * API result array + * API result array * {@getfields price_set_delete} * @access public */ diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php index 870fe13a29..1803116fbb 100644 --- a/api/v3/PrintLabel.php +++ b/api/v3/PrintLabel.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created print_label property values. + * of newly created print_label property values. * @access public */ function civicrm_api3_print_label_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_print_label_create($params) { * @param array $params * * @return array - * of retrieved print_label property values. + * of retrieved print_label property values. * @access public */ function civicrm_api3_print_label_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_print_label_get($params) { * @param array $params * * @return array - * of deleted values. + * 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 7dbd8dbc56..d60658c8cd 100644 --- a/api/v3/Product.php +++ b/api/v3/Product.php @@ -45,7 +45,7 @@ * * @throws API_Exception * @return array - * of newly created product property values. + * of newly created product property values. * @access public */ function civicrm_api3_product_create($params) { @@ -62,7 +62,7 @@ function civicrm_api3_product_create($params) { * @param array $params * * @return array - * of retrieved product property values. + * of retrieved product property values. * @access public */ function civicrm_api3_product_get($params) { @@ -80,7 +80,7 @@ function civicrm_api3_product_get($params) { * * @throws API_Exception * @return array - * of deleted values. + * of deleted values. * @access public */ function civicrm_api3_product_delete($params) { diff --git a/api/v3/Profile.php b/api/v3/Profile.php index d353573d00..d482624ade 100644 --- a/api/v3/Profile.php +++ b/api/v3/Profile.php @@ -44,7 +44,7 @@ * pairs to get profile field values * * @throws API_Exception - * @return Profile field values|CRM_Error + * @return array|CRM_Error * * NOTE this api is not standard & since it is tested we need to honour that * but the correct behaviour is for it to return an id indexed array as this supports @@ -157,7 +157,7 @@ function _civicrm_api3_profile_get_spec(&$params) { * * @throws API_Exception * @return array - * API result array + * API result array */ function civicrm_api3_profile_submit($params) { $profileID = _civicrm_api3_profile_getProfileID($params['profile_id']); @@ -297,7 +297,7 @@ function civicrm_api3_profile_submit($params) { * API field name. * * @return string - * BAO Field Name + * BAO Field Name */ function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName) { $fieldName = str_replace('url', 'URL', $fieldName); @@ -338,7 +338,7 @@ function _civicrm_api3_profile_submit_spec(&$params, $apirequest) { * pairs to update profile field values * * @return array - * Updated Contact/ Activity object|CRM_Error + * Updated Contact/ Activity object|CRM_Error * * */ @@ -355,7 +355,7 @@ function civicrm_api3_profile_set($params) { * pairs to profile field values * * @throws API_Exception - * @return formatted profile field values|CRM_Error + * @return array|CRM_Error * * @todo add example * @todo add test cases @@ -740,7 +740,7 @@ function _civicrm_api3_profile_appendaliases($values, $entity) { /** * @deprecated api notice * @return array - * of deprecated actions + * of deprecated actions */ function _civicrm_api3_profile_deprecation() { return array( diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 29ddb20e43..5a36bc3534 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -47,7 +47,7 @@ * @example RelationshipCreate.php Std Create example * * @return array - * API Result Array + * API Result Array * {@getfields relationship_create} * @static void * @access public @@ -76,7 +76,7 @@ function _civicrm_api3_relationship_create_spec(&$params) { * @param array $params * * @return array - * API Result Array + * API Result Array * {@getfields relationship_delete} * @example RelationshipDelete.php Delete Example * @@ -110,7 +110,7 @@ function civicrm_api3_relationship_delete($params) { * - 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 + * API Result Array * {@getfields relationship_get} * @example RelationshipGet.php * @access public diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index fc352bb3e2..e7c7d08783 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -42,7 +42,7 @@ * @param array $params * Associative array of property name/value pairs to insert in new relationship type. * - * @return Newly created Relationship_type object + * @return array * {@getfields RelationshipType_create} * @access public * {@schema Contact/RelationshipType.xml} @@ -109,7 +109,7 @@ function civicrm_api3_relationship_type_get($params) { * @param id of relationship type $id * * @return array - * API Result Array + * API Result Array * {@getfields RelationshipType_delete} * @static void * @access public diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index 959ec3cb41..e378719777 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -7,7 +7,7 @@ * Input parameters. * * @return array - * details of found instances + * details of found instances * @access public */ function civicrm_api3_report_instance_get($params) { @@ -20,7 +20,7 @@ function civicrm_api3_report_instance_get($params) { * @param array $params * * @return array - * of newly created report instance property values. + * of newly created report instance property values. * @access public */ function civicrm_api3_report_instance_create($params) { @@ -45,7 +45,7 @@ function _civicrm_api3_report_instance_create_spec(&$params) { * @param array $params * * @return array - * Api result + * Api result * @access public */ function civicrm_api3_report_instance_delete($params) { diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index a4691c634d..0d85291061 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -11,7 +11,7 @@ * @example OptionValueGet.php * * @return array - * details of found Option Values + * details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -33,7 +33,7 @@ function civicrm_api3_report_template_get($params) { * @param array $params * * @return array - * of newly created option_value property values. + * of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ @@ -75,7 +75,7 @@ function _civicrm_api3_report_template_create_spec(&$params) { * {@example ReportTemplateDelete.php 0} * * @return array - * Api result + * Api result * {@getfields ReportTemplate_create} * @access public */ @@ -91,7 +91,7 @@ function civicrm_api3_report_template_delete($params) { * Input parameters. * * @return array - * details of found instances + * details of found instances * @access public */ function civicrm_api3_report_template_getrows($params) { @@ -169,7 +169,7 @@ function civicrm_api3_report_template_getstatistics($params) { * Input parameters. * * @return array - * details of found instances + * 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 71d283fd56..ba35cdd866 100644 --- a/api/v3/Setting.php +++ b/api/v3/Setting.php @@ -202,7 +202,7 @@ function _civicrm_api3_setting_fill_spec(&$params) { * @example SettingCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields setting_create} * @access public */ @@ -239,7 +239,7 @@ function _civicrm_api3_setting_create_spec(&$params) { * property_name=>value pairs. * * @return array - * Array of matching settings + * Array of matching settings * {@getfields setting_get} * @access public */ @@ -274,7 +274,7 @@ function _civicrm_api3_setting_get_spec(&$params) { * property_name=>value pairs. * * @return array - * Array of matching settings + * Array of matching settings * {@getfields setting_get} * @access public */ diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 73252aeeb3..4b235c1914 100644 --- a/api/v3/SmsProvider.php +++ b/api/v3/SmsProvider.php @@ -44,7 +44,7 @@ * @param array $params * * @return array - * of newly created sms_provider property values. + * of newly created sms_provider property values. * @access public */ function civicrm_api3_sms_provider_create($params) { @@ -61,7 +61,7 @@ function civicrm_api3_sms_provider_create($params) { * @param array $params * * @return array - * of retrieved sms_provider property values. + * of retrieved sms_provider property values. * @access public */ function civicrm_api3_sms_provider_get($params) { @@ -78,7 +78,7 @@ function civicrm_api3_sms_provider_get($params) { * @param array $params * * @return array - * of deleted values. + * 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 b757fd812d..2a9334a5d2 100644 --- a/api/v3/Survey.php +++ b/api/v3/Survey.php @@ -44,7 +44,7 @@ * @example SurveyCreate.php Std Create example * * @return array - * api result array + * api result array * {@getfields survey_create} * @access public */ @@ -72,7 +72,7 @@ function _civicrm_api3_survey_create_spec(&$params) { * as null, all surveys will be returned * * @return array - * API result Array of matching surveys + * API result Array of matching surveys * {@getfields survey_get} * @access public */ @@ -91,7 +91,7 @@ function civicrm_api3_survey_get($params) { * to be deleted * * @return array - * api result array + * api result array * {@getfields survey_delete} * @access public */ diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php index 81953d0987..c6993b2c1b 100644 --- a/api/v3/SurveyRespondant.php +++ b/api/v3/SurveyRespondant.php @@ -36,7 +36,7 @@ /** * @deprecated api notice * @return string - * to indicate this entire api entity is deprecated + * to indicate this entire api entity is deprecated */ function _civicrm_api3_survey_respondant_deprecation() { return 'The survey_respondant api is not currently supported.'; @@ -49,7 +49,7 @@ function _civicrm_api3_survey_respondant_deprecation() { * (reference ) input parameters. * * @return array - * (reference ) contribution_id of created or updated record + * (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 5da438e636..a256b6080b 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -46,7 +46,7 @@ * - session: bool, whether to reset the CiviCRM session data; defaul: FALSE * * @return boolean - * true if success, else false + * true if success, else false * @static void * @access public * @example SystemFlush.php @@ -90,7 +90,7 @@ function _civicrm_api3_system_check_spec(&$spec) { * * @param array $params * @return array - * API result descriptor; return items are alert codes/messages + * 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 0a4f5048b4..c6c2d6c33e 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -45,7 +45,7 @@ * @param array $params * * @return array - * of newly created tag property values. + * of newly created tag property values. * {@getfields tag_create} * @access public */ @@ -73,7 +73,7 @@ function _civicrm_api3_tag_create_spec(&$params) { * @example TagDelete.ph * * @return array - * API result array + * API result array * {@getfields tag_delete} * @access public */ @@ -93,7 +93,7 @@ function civicrm_api3_tag_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found tags else error + * details of found tags else error * {@getfields tag_get} * @access public */ diff --git a/api/v3/UFField.php b/api/v3/UFField.php index 6d1be34e1b..c6c53a0aab 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -46,7 +46,7 @@ * @throws API_Exception * * @return array - * Newly created $ufFieldArray + * Newly created $ufFieldArray * * @access public * {@getfields UFField_create} @@ -116,7 +116,7 @@ function civicrm_api3_uf_field_create($params) { * @param array $params * * @return array - * fields valid for other functions + * fields valid for other functions */ function _civicrm_api3_uf_field_create_spec(&$params) { $params['option.autoweight'] = array( @@ -138,7 +138,7 @@ function _civicrm_api3_uf_field_create_spec(&$params) { * as null, all surveys will be returned * * @return array - * (reference) Array + * (reference) Array * {@getfields UFField_get * @example UFFieldGet.php * @access public @@ -154,7 +154,7 @@ function civicrm_api3_uf_field_get($params) { * * @throws API_Exception * - * @return true on successful delete or return error + * @return array * * @access public * {@getfields UFField_delete} diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index 7872aa6d8d..490ac54bf4 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -55,7 +55,7 @@ function _civicrm_api3_uf_group_create_spec(&$params) { * Array Associative array of property name/value pairs to insert in group. * * @return array - * API result array + * API result array * {@getfields UFGroup_create} * @example UFGroupCreate.php * @access public @@ -73,7 +73,7 @@ function civicrm_api3_uf_group_create($params) { * as null, all surveys will be returned * * @return array - * Array of matching profiles + * Array of matching profiles * {@getfields UFGroup_get} * @example UFGroupGet.php * @access public @@ -89,7 +89,7 @@ function civicrm_api3_uf_group_get($params) { * @param array $params * * - * @return true on successful delete or return error + * @return array * @access public * {@getfields UFGroup_delete} * @example UFGroupDelete.php diff --git a/api/v3/UFJoin.php b/api/v3/UFJoin.php index feeffe740f..3b763b8635 100644 --- a/api/v3/UFJoin.php +++ b/api/v3/UFJoin.php @@ -44,7 +44,7 @@ * Assoc array of name/value pairs. * * @return array - * CRM_Core_DAO_UFJoin Array + * CRM_Core_DAO_UFJoin Array * @access public * @example UFJoinCreate.php * {@getfields UFJoin_create} @@ -77,7 +77,7 @@ function _civicrm_api3_uf_join_create_spec(&$params) { * (reference) an assoc array of name/value pairs. * * @return array - * CiviCRM Result Array or null + * 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 ae89079df8..e8c4b1bcdd 100644 --- a/api/v3/UFMatch.php +++ b/api/v3/UFMatch.php @@ -61,7 +61,7 @@ function civicrm_api3_uf_match_get($params) { * @example UFMatch.php Std Create example * * @return array - * api result array + * api result array * {@getfields uf_match_create} * @access public */ @@ -91,7 +91,7 @@ function _civicrm_api3_uf_match_create_spec(&$params) { * @example UFMatch.php Std Create example * * @return array - * api result array + * api result array * {@getfields uf_match_create} * @access public */ diff --git a/api/v3/Website.php b/api/v3/Website.php index cfaf6cb351..cd209119e6 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -47,7 +47,7 @@ * @param array $params * * @return array - * of newly created website property values. + * of newly created website property values. * @access public * @todo convert to using basic create - BAO function non-std */ @@ -79,7 +79,7 @@ function _civicrm_api3_website_create_spec(&$params) { * @example WebsiteDelete.php Std Delete Example * * @return array - * API result Array + * API result Array * @access public * @todo convert to using Basic delete - BAO function non standard */ @@ -111,7 +111,7 @@ function civicrm_api3_website_delete($params) { * An associative array of name/value pairs. * * @return array - * details of found websites + * details of found websites * * @access public */ diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php index 89608f8c55..afa1334d16 100644 --- a/api/v3/WordReplacement.php +++ b/api/v3/WordReplacement.php @@ -84,7 +84,7 @@ function _civicrm_api3_word_replacement_create_spec(&$params) { * to be deleted * * @return array - * api result array + * api result array * * @access public */ diff --git a/api/v3/utils.php b/api/v3/utils.php index 32562b13d5..ef6aac769b 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -56,7 +56,7 @@ function _civicrm_api3_initialize() { * List of required fields options. One of the options is required. * * @return null - * or throws error if there the required fields not present + * or throws error if there the required fields not present * @ */ function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array()) { @@ -80,7 +80,7 @@ function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions * * @throws API_Exception * @return null - * or throws error if there the required fields not present + * or throws error if there the required fields not present * * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param */ @@ -139,7 +139,7 @@ function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array() * * @throws API_Exception * @return array - * + * */ function civicrm_api3_create_error($msg, $data = array()) { $data['is_error'] = 1; @@ -707,7 +707,7 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) { * * @throws API_Exception * @return array - * options extracted from params + * options extracted from params */ function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') { $is_count = FALSE; @@ -1300,7 +1300,7 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { * @param array $params * * @return array - * API result array + * API result array * @throws API_Exception */ function _civicrm_api3_basic_delete($bao_name, &$params) { @@ -2000,7 +2000,8 @@ function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldN * @param $fieldName * : any variation of a field's name (name, unique_name, api.alias). * - * @return bool|string (string|bool) fieldName or FALSE if the field does not exist + * @return bool|string + * fieldName or FALSE if the field does not exist */ function _civicrm_api3_api_resolve_alias($entity, $fieldName) { if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) { diff --git a/tests/phpunit/CRM/Core/ResourcesTest.php b/tests/phpunit/CRM/Core/ResourcesTest.php index 6e9da350d3..397a24be54 100644 --- a/tests/phpunit/CRM/Core/ResourcesTest.php +++ b/tests/phpunit/CRM/Core/ResourcesTest.php @@ -283,10 +283,10 @@ class CRM_Core_ResourcesTest extends CiviUnitTestCase { /** * @param CRM_Utils_Cache_Interface $cache - * @param null $cacheKey + * @param string $cacheKey * - * @internal param string $appendPathGarbage - * @return array(string $basedir, CRM_Extension_Container_Interface, CRM_Extension_Mapper) + * @return array + * [string $basedir, CRM_Extension_Container_Interface, CRM_Extension_Mapper] */ public function _createMapper(CRM_Utils_Cache_Interface $cache = NULL, $cacheKey = NULL) { $basedir = rtrim($this->createTempDir('ext-'), '/'); diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index 30fa7d25bc..87b40a937f 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -421,10 +421,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * Contact’s last name. * @param mixed $email * Contact’s email (when string) or random email (when true) or no email (when null). + * @param string $contactSubtype * - * @param null $contactSubtype - * - * @return mixed either a string with the (either generated or provided) email or null (if no email) + * @return string|null + * either a string with the (either generated or provided) email or null (if no email) */ public function webtestAddContact($fname = 'Anthony', $lname = 'Anderson', $email = NULL, $contactSubtype = NULL) { $args = 'reset=1&ct=Individual'; @@ -956,9 +956,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * Create new relationship type w/ user specified params or default. * * @param array $params - * of required params. + * array of required params. * - * @return an array of saved params values. + * @return array + * array of saved params values. */ public function webtestAddRelationshipType($params = array()) { $this->openCiviPage("admin/reltype", "reset=1&action=add"); diff --git a/tests/phpunit/CiviTest/CiviTestSuite.php b/tests/phpunit/CiviTest/CiviTestSuite.php index d5fe148beb..de3e081ad2 100644 --- a/tests/phpunit/CiviTest/CiviTestSuite.php +++ b/tests/phpunit/CiviTest/CiviTestSuite.php @@ -101,12 +101,12 @@ class CiviTestSuite extends PHPUnit_Framework_TestSuite { * Add all test classes *Test and all test suites *Tests in subdirectories * * @param PHPUnit_Framework_TestSuite $suite + * Test suite object to add tests to * @param $myfile * @param SplFileInfo $dirInfo + * object to scan * - * @internal param $ &object Test suite object to add tests to - * @internal param \Directory $object to scan - * @return Test suite has been updated + * @return void */ protected function addAllTests( PHPUnit_Framework_TestSuite &$suite, diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php index b43c490db9..efcd1ec687 100644 --- a/tests/phpunit/CiviTest/Contact.php +++ b/tests/phpunit/CiviTest/Contact.php @@ -47,7 +47,8 @@ class Contact extends CiviUnitTestCase { * a contact of type Household * * @param array $params - * @return mixed $contactID id of created Household + * @return int + * id of created Household */ public static function createHousehold($params = NULL) { //compose the params, when not passed @@ -68,7 +69,8 @@ class Contact extends CiviUnitTestCase { * a contact of type Organisation * * @param array $params - * @return mixed $contactID id of created Organisation + * @return int + * id of created Organisation */ public static function createOrganisation($params = NULL) { //compose the params, when not passed diff --git a/tests/phpunit/CiviTest/ContributionPage.php b/tests/phpunit/CiviTest/ContributionPage.php index 3f600ebe8e..c97d995bc0 100644 --- a/tests/phpunit/CiviTest/ContributionPage.php +++ b/tests/phpunit/CiviTest/ContributionPage.php @@ -10,7 +10,8 @@ class ContributionPage extends PHPUnit_Framework_Testcase { * * @param int $id * - * @return mixed $contributionPage id of created Contribution Page + * @return int + * id of created Contribution Page */ public static function create($id = NULL) { require_once "CRM/Contribute/BAO/ContributionPage.php"; diff --git a/tests/phpunit/CiviTest/Event.php b/tests/phpunit/CiviTest/Event.php index 840a49be92..bd393f36c5 100644 --- a/tests/phpunit/CiviTest/Event.php +++ b/tests/phpunit/CiviTest/Event.php @@ -10,7 +10,8 @@ class Event extends PHPUnit_Framework_Testcase { * * @param int $contactId * - * @return mixed $event id of created Event + * @return int + * id of created Event */ public static function create($contactId) { require_once "CRM/Event/BAO/Event.php"; diff --git a/tests/phpunit/CiviTest/Participant.php b/tests/phpunit/CiviTest/Participant.php index fdb0ffea6d..e9ab99183c 100644 --- a/tests/phpunit/CiviTest/Participant.php +++ b/tests/phpunit/CiviTest/Participant.php @@ -10,7 +10,8 @@ class Participant extends PHPUnit_Framework_Testcase { * @param int $contactId * @param int $eventId * - * @return mixed $participant id of created Participant + * @return int + * id of created Participant */ public static function create($contactId, $eventId) { $params = array( diff --git a/tests/phpunit/Utils.php b/tests/phpunit/Utils.php index e1168f64fa..51ac65e77d 100644 --- a/tests/phpunit/Utils.php +++ b/tests/phpunit/Utils.php @@ -59,12 +59,12 @@ class Utils { } /** - * Prepare and execute a query + * Prepare and execute a query * - * If the query fails, output a diagnostic message - * @param string Query to run - * @return mixed PDOStatement => Results of the query - * false => Query failed + * If the query fails, output a diagnostic message + * @param string $query + * Query to run + * @return bool */ public function do_query($query) { // echo "do_query($query)\n"; -- 2.25.1