From 16b10e64496e4854eb267a21aa33e961bec6ecba Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 11 Jan 2015 13:25:12 -0500 Subject: [PATCH] INFRA-132 - Docblock formatting fixes --- CRM/ACL/BAO/ACL.php | 2 +- CRM/Activity/BAO/Activity.php | 4 +- CRM/Badge/BAO/Layout.php | 3 +- CRM/Campaign/BAO/Campaign.php | 2 +- CRM/Campaign/BAO/Survey.php | 2 +- CRM/Case/BAO/Case.php | 8 +- CRM/Case/BAO/CaseType.php | 6 +- CRM/Case/PseudoConstant.php | 4 +- CRM/Contact/BAO/Contact.php | 26 +++---- CRM/Contact/BAO/Contact/Location.php | 2 +- CRM/Contact/BAO/ContactType.php | 21 +++--- CRM/Contact/BAO/Group.php | 10 +-- CRM/Contact/BAO/GroupContact.php | 6 +- CRM/Contact/BAO/Individual.php | 2 +- CRM/Contact/BAO/Query/Hook.php | 2 +- CRM/Contact/BAO/Relationship.php | 12 +-- CRM/Contact/BAO/RelationshipType.php | 2 +- CRM/Contact/Form/Task/LabelCommon.php | 23 +++--- CRM/Contact/Import/Parser/Contact.php | 2 +- CRM/Contribute/BAO/Contribution.php | 74 +++++++------------ CRM/Contribute/BAO/Contribution/Utils.php | 4 +- CRM/Contribute/BAO/ContributionPage.php | 4 +- CRM/Contribute/BAO/ContributionRecur.php | 6 +- CRM/Contribute/BAO/ContributionSoft.php | 4 +- CRM/Contribute/BAO/ManagePremiums.php | 2 +- CRM/Contribute/BAO/Premium.php | 2 +- CRM/Contribute/Form/AbstractEditPayment.php | 2 +- CRM/Contribute/Form/Contribution/Confirm.php | 2 +- CRM/Contribute/Form/SoftCredit.php | 2 +- CRM/Core/BAO/ActionSchedule.php | 3 +- CRM/Core/BAO/Address.php | 8 +- CRM/Core/BAO/Block.php | 4 +- CRM/Core/BAO/ConfigSetting.php | 8 +- CRM/Core/BAO/CustomField.php | 11 +-- CRM/Core/BAO/CustomGroup.php | 21 +++--- CRM/Core/BAO/CustomOption.php | 5 +- CRM/Core/BAO/Dashboard.php | 6 +- CRM/Core/BAO/Domain.php | 2 +- CRM/Core/BAO/Email.php | 2 +- CRM/Core/BAO/EntityTag.php | 8 +- CRM/Core/BAO/Extension.php | 3 +- CRM/Core/BAO/FinancialTrxn.php | 4 +- CRM/Core/BAO/IM.php | 2 +- CRM/Core/BAO/Job.php | 3 +- CRM/Core/BAO/LabelFormat.php | 2 +- CRM/Core/BAO/LocationType.php | 3 +- CRM/Core/BAO/MailSettings.php | 7 +- CRM/Core/BAO/MessageTemplate.php | 4 +- CRM/Core/BAO/Navigation.php | 3 +- CRM/Core/BAO/OptionGroup.php | 2 +- CRM/Core/BAO/OptionValue.php | 2 +- CRM/Core/BAO/PaperSize.php | 2 +- CRM/Core/BAO/PdfFormat.php | 2 +- CRM/Core/BAO/Persistent.php | 2 +- CRM/Core/BAO/Phone.php | 2 +- CRM/Core/BAO/PreferencesDate.php | 3 +- CRM/Core/BAO/UFField.php | 6 +- CRM/Core/BAO/UFGroup.php | 2 +- CRM/Core/BAO/UFJoin.php | 2 +- CRM/Core/BAO/WordReplacement.php | 2 +- CRM/Core/CodeGen/Main.php | 2 +- CRM/Core/CodeGen/Util/File.php | 2 +- CRM/Core/Controller.php | 2 +- CRM/Core/DAO.php | 25 ++++--- CRM/Core/DAO/permissions.php | 2 +- CRM/Core/Exception.php | 2 +- CRM/Core/FileSearchInterface.php | 20 ++--- CRM/Core/Form.php | 30 ++++---- CRM/Core/Form/RecurringEntity.php | 4 +- CRM/Core/I18n.php | 4 +- CRM/Core/OptionGroup.php | 2 +- CRM/Core/OptionValue.php | 4 +- CRM/Core/Payment.php | 3 +- CRM/Core/Payment/AuthorizeNet.php | 2 +- CRM/Core/Payment/BaseIPN.php | 2 +- CRM/Core/Payment/PayJunction.php | 2 +- CRM/Core/Payment/PayPalProIPN.php | 6 +- CRM/Core/Payment/Realex.php | 2 +- CRM/Core/Permission.php | 2 +- CRM/Core/Permission/Base.php | 8 +- CRM/Core/Permission/Drupal6.php | 4 +- CRM/Core/Reference/Dynamic.php | 3 +- CRM/Core/Reference/Interface.php | 4 +- CRM/Core/Selector/Controller.php | 2 +- CRM/Core/Session.php | 8 +- CRM/Core/Smarty/plugins/block.crmRegion.php | 2 +- CRM/Core/Smarty/plugins/block.crmScope.php | 2 +- CRM/Core/Smarty/plugins/block.edit.php | 2 +- CRM/Core/Smarty/plugins/block.htxt.php | 2 +- CRM/Core/Smarty/plugins/block.localize.php | 2 +- CRM/Core/Smarty/plugins/block.serialize.php | 2 +- CRM/Core/Smarty/plugins/block.ts.php | 2 +- .../Smarty/plugins/function.crmCrudLink.php | 14 ++-- CRM/Core/Smarty/plugins/function.crmKey.php | 2 +- .../plugins/function.crmNavigationMenu.php | 2 +- .../Smarty/plugins/function.crmResURL.php | 10 +-- .../Smarty/plugins/function.crmScript.php | 16 ++-- .../Smarty/plugins/function.crmSigner.php | 4 +- CRM/Core/Smarty/plugins/function.crmStyle.php | 16 ++-- CRM/Core/Smarty/plugins/function.docURL.php | 2 +- CRM/Core/Smarty/plugins/function.help.php | 2 +- .../Smarty/plugins/function.isValueChange.php | 2 +- .../Smarty/plugins/function.sectionTotal.php | 22 +++--- .../function.simpleActivityContacts.php | 16 ++-- CRM/Core/Smarty/resources/String.php | 6 +- CRM/Core/StateMachine.php | 3 +- CRM/Custom/Form/Group.php | 2 +- CRM/Custom/Import/Parser/Api.php | 4 +- CRM/Dedupe/Merger.php | 2 +- CRM/Event/BAO/Event.php | 4 +- CRM/Event/BAO/Participant.php | 14 ++-- CRM/Event/Form/ManageEvent/EventInfo.php | 2 +- CRM/Event/Form/ManageEvent/Repeat.php | 2 +- CRM/Event/Form/Task/AddToGroup.php | 2 +- CRM/Event/PseudoConstant.php | 4 +- CRM/Financial/BAO/FinancialItem.php | 4 +- CRM/Financial/BAO/FinancialType.php | 2 +- CRM/Financial/BAO/FinancialTypeAccount.php | 2 +- CRM/Financial/BAO/PaymentProcessor.php | 29 ++++---- CRM/Financial/BAO/PaymentProcessorType.php | 3 +- CRM/Financial/Form/FinancialAccount.php | 5 +- CRM/Financial/Form/FinancialTypeAccount.php | 5 +- CRM/Friend/BAO/Friend.php | 6 +- CRM/Grant/BAO/Grant.php | 2 +- CRM/Import/Parser.php | 4 +- CRM/Mailing/BAO/Component.php | 4 +- CRM/Mailing/BAO/Mailing.php | 2 +- CRM/Mailing/BAO/MailingAB.php | 2 +- CRM/Mailing/Event/BAO/Queue.php | 3 +- CRM/Mailing/Event/BAO/Subscribe.php | 4 +- CRM/Member/BAO/Membership.php | 10 +-- CRM/Member/BAO/MembershipStatus.php | 4 +- CRM/Member/BAO/MembershipType.php | 2 +- CRM/Pledge/BAO/Pledge.php | 6 +- CRM/Pledge/BAO/PledgeBlock.php | 4 +- CRM/Pledge/BAO/PledgePayment.php | 2 +- CRM/Price/BAO/LineItem.php | 12 +-- CRM/Price/BAO/PriceField.php | 6 +- CRM/Price/BAO/PriceFieldValue.php | 6 +- CRM/Price/BAO/PriceSet.php | 8 +- CRM/Report/BAO/Hook.php | 2 +- CRM/Report/BAO/ReportInstance.php | 4 +- CRM/Report/Form.php | 8 +- CRM/Report/Form/Extended.php | 4 +- CRM/Upgrade/Incremental/php/FourFour.php | 3 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 6 +- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 6 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 8 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 8 +- CRM/Utils/Check.php | 2 +- CRM/Utils/Check/Security.php | 6 +- CRM/Utils/Date.php | 2 +- CRM/Utils/Hook.php | 21 +++--- CRM/Utils/Hook/UnitTests.php | 2 +- CRM/Utils/JS.php | 2 +- CRM/Utils/PseudoConstant.php | 4 +- CRM/Utils/System.php | 14 ++-- CRM/Utils/System/DrupalBase.php | 2 +- CRM/Utils/Token.php | 2 +- CRM/Utils/Weight.php | 13 ++-- Civi/CiUtil/PHPUnitScanner.php | 3 +- Civi/Install/Requirements.php | 2 +- api/v3/Acl.php | 6 +- api/v3/AclRole.php | 6 +- api/v3/ActivityContact.php | 2 +- api/v3/Address.php | 2 +- api/v3/Attachment.php | 4 +- api/v3/Batch.php | 6 +- api/v3/Case.php | 2 +- api/v3/Contact.php | 4 +- api/v3/Contribution.php | 4 +- api/v3/CustomField.php | 4 +- api/v3/CustomGroup.php | 4 +- api/v3/CustomSearch.php | 2 +- api/v3/CustomValue.php | 59 +++++++-------- api/v3/Entity.php | 2 +- api/v3/Event.php | 10 +-- api/v3/Extension.php | 2 +- api/v3/File.php | 8 +- api/v3/FinancialAccount.php | 6 +- api/v3/FinancialType.php | 6 +- api/v3/Generic.php | 12 +-- api/v3/Generic/Update.php | 12 +-- api/v3/GroupContact.php | 2 +- api/v3/GroupOrganization.php | 2 +- api/v3/Im.php | 2 +- api/v3/LineItem.php | 4 +- api/v3/LocBlock.php | 2 +- api/v3/Mailing.php | 6 +- api/v3/MailingAB.php | 4 - api/v3/MailingComponent.php | 6 +- api/v3/MailingJob.php | 4 - api/v3/MailingRecipients.php | 4 - api/v3/Membership.php | 8 +- api/v3/MembershipStatus.php | 8 +- api/v3/MembershipType.php | 4 +- api/v3/Note.php | 6 +- api/v3/OptionValue.php | 2 +- api/v3/Participant.php | 4 - api/v3/ParticipantPayment.php | 6 +- api/v3/PaymentProcessor.php | 2 +- api/v3/Phone.php | 2 +- api/v3/Premium.php | 6 +- api/v3/PriceField.php | 4 +- api/v3/PriceFieldValue.php | 4 +- api/v3/PriceSet.php | 4 +- api/v3/PrintLabel.php | 6 +- api/v3/Product.php | 6 +- api/v3/Profile.php | 2 +- api/v3/ReportInstance.php | 2 +- api/v3/ReportTemplate.php | 2 +- api/v3/SmsProvider.php | 6 +- api/v3/Tag.php | 2 +- api/v3/UFField.php | 2 +- api/v3/UFGroup.php | 4 +- api/v3/Website.php | 2 +- api/v3/WordReplacement.php | 2 +- api/v3/utils.php | 17 +++-- .../main.php | 4 +- .../CRM/Core/BAO/ActionScheduleTest.php | 14 +--- .../CRM/Core/Permission/GenericTest.php | 2 +- .../Subscriber/DynamicFKAuthorizationTest.php | 4 +- tests/phpunit/CiviTest/AuthorizeNet.php | 2 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 14 ++-- tests/phpunit/CiviTest/CiviUnitTestCase.php | 67 ++++++++++------- tests/phpunit/CiviTest/ContributionPage.php | 2 +- tests/phpunit/CiviTest/PCP.php | 4 +- tests/phpunit/CiviTest/PaypalPro.php | 2 +- .../UpdatePendingContributionTest.php | 2 +- tests/phpunit/api/v3/ContributionPageTest.php | 8 +- 230 files changed, 675 insertions(+), 714 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index aafedb4b31..284b2bae30 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -330,7 +330,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * * @return string|null * WHERE-style clause to filter results, - * or null if $table or $id is null + * or null if $table or $id is null * @static */ public static function getClause($table, $id, &$tables) { diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 016e0ebaf6..b5a435d4ad 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -78,7 +78,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Activity_DAO_Activity object + * @return CRM_Activity_DAO_Activity */ public static function retrieve(&$params, &$defaults) { $activity = new CRM_Activity_DAO_Activity(); @@ -907,7 +907,7 @@ ORDER BY fixed_sort_order * component related activities w/ core activity retrieve process. * * @return array - * of component id and name. + * Array of component id and name. * @static **/ public static function activityComponents() { diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 9d393b524e..7da955a1c9 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -51,7 +51,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_PrintLabel object on success, null otherwise + * @return CRM_Core_DAO_PrintLabel|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 72d6c717d3..4513a35e11 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -44,7 +44,7 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Campaign_DAO_Campaign object + * @return CRM_Campaign_DAO_Campaign * @static */ public static function create(&$params) { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 888a96cc27..6e22770067 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -79,7 +79,7 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { * * @param array $params * - * @return CRM_Survey_DAO_Survey object + * @return CRM_Survey_DAO_Survey * @static */ public static function create(&$params) { diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 0631dc5bbb..8ced021457 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -73,7 +73,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Case_BAO_Case object + * @return CRM_Case_BAO_Case * @static */ public static function add(&$params) { @@ -115,7 +115,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Case_BAO_Case object + * @return CRM_Case_BAO_Case * @static */ public static function &create(&$params) { @@ -259,7 +259,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param array $ids * (reference) the array that holds all the db ids. * - * @return CRM_Case_BAO_Case object + * @return CRM_Case_BAO_Case * @static */ public static function retrieve(&$params, &$defaults, &$ids) { @@ -1037,7 +1037,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param null $type * * @return array - * of case activities + * Array of case activities * * @static */ diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index ed332e294d..e946624237 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -59,7 +59,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * * @throws CRM_Core_Exception * - * @return CRM_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType * @static */ public static function add(&$params) { @@ -274,7 +274,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType * @static */ public static function &create(&$params) { @@ -318,7 +318,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * (reference ) an assoc array to hold the name / value pairs. * in a hierarchical manner * - * @return CRM_Case_BAO_CaseType object + * @return CRM_Case_BAO_CaseType * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 7d44e4f393..871593773a 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -191,13 +191,13 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { } /** - * Get all Activty types for the CiviCase component + * Get all Activity types for the CiviCase component * * The static array activityType is returned * * @param bool $indexName * True return activity name in array. - * key else activity id as array key. + * key else activity id as array key. * * @param bool $all * diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 6553d54779..998f7cbd46 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -110,7 +110,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @static */ public static function add(&$params) { @@ -276,7 +276,7 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * @param bool $skipDelete * * @throws Exception - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @static */ public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) { @@ -517,14 +517,12 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * @param array $crudLinkSpec * With keys:. - * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] - * - entity_table: string, eg "civicrm_contact" - * - entity_id: int + * - 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: - * - path: string - * - query: string - * - title: string + * NULL if unavailable, or + * [path: string, query: string, title: string] * @see CRM_Utils_System::createDefaultCrudLink */ public function createDefaultCrudLink($crudLinkSpec) { @@ -696,7 +694,7 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); * @param bool $microformat * For location in microformat. * - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @static */ public static function &retrieve(&$params, &$defaults, $microformat = FALSE) { @@ -1788,7 +1786,7 @@ WHERE civicrm_contact.id = %1 "; * Id of the contact. * * @return array - * of display_name, email if found, do_not_email or (null,null,null) + * Array of display_name, email if found, do_not_email or (null,null,null) * @static */ public static function getContactDetails($id) { @@ -2845,7 +2843,7 @@ AND civicrm_openid.is_primary = 1"; * @param int $contactId * * @return array - * of context menu for logged in user. + * Array of context menu for logged in user. * @static */ public static function contextMenu($contactId = NULL) { @@ -3314,9 +3312,9 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * * @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/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index e0fee6624b..a585cc856c 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -44,7 +44,7 @@ class CRM_Contact_BAO_Contact_Location { * @param int $locationTypeID * * @return array - * of display_name, email, location type and location id if found, or (null,null,null, null) + * Array of display_name, email, location type and location id if found, or (null,null,null, null) * @static */ public static function getEmailDetails($id, $isPrimary = TRUE, $locationTypeID = NULL) { diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 479fe7cca5..6ebda66cf3 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -42,7 +42,8 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contact_BAO_ContactType object on success, null otherwise + * @return CRM_Contact_BAO_ContactType|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { @@ -72,7 +73,7 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { * @param bool $all * * @return array - * of basic contact types information. + * Array of basic contact types information. * @static */ public static function &basicTypeInfo($all = FALSE) { @@ -119,7 +120,7 @@ WHERE parent_id IS NULL * @param bool $all * * @return array - * of basic contact types + * Array of basic contact types * @static */ public static function basicTypes($all = FALSE) { @@ -153,7 +154,7 @@ WHERE parent_id IS NULL * @param bool $reset * * @return array - * of sub type information + * Array of sub type information * @static */ public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) { @@ -223,8 +224,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param bool $ignoreCache * * @return array - * of all subtypes OR list of subtypes associated to - * a given basic contact type + * all subtypes OR list of subtypes associated to + * a given basic contact type * @static */ public static function subTypes($contactType = NULL, $all = FALSE, $columnName = 'name', $ignoreCache = FALSE) { @@ -266,7 +267,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param bool $all * * @return array - * of basic types + all subtypes. + * Array of basic types + all subtypes. * @static */ public static function contactTypes($all = FALSE) { @@ -281,7 +282,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param bool $reset * * @return array - * of basic types + all subtypes. + * Array of basic types + all subtypes. * @static */ public static function contactTypeInfo($all = FALSE, $reset = FALSE) { @@ -342,7 +343,7 @@ WHERE type.name IS NOT NULL * @param null $delimiter * * @return array - * of basictypes with name as 'built-in name' and 'label' as value + * Array of basictypes with name as 'built-in name' and 'label' as value * @static */ public static function contactTypePairs($all = FALSE, $typeName = NULL, $delimiter = NULL) { @@ -514,7 +515,7 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; * @param bool $ignoreCache * * @return array - * of suppressed subTypes. + * Array of suppressed subTypes. * @static */ public static function suppressSubTypes(&$subTypes, $ignoreCache = FALSE) { diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 0b09fd747b..bc008a1d09 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -53,7 +53,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contact_BAO_Group object + * @return CRM_Contact_BAO_Group * @static */ public static function retrieve(&$params, &$defaults) { @@ -236,7 +236,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * @param NULL $rowCount * * @return array - * of group objects. + * Array of group objects. * * * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and @@ -565,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 CRM_Core_DAO + * @return CRM_Core_DAO|null * DAO object on sucess, NULL otherwise * @static */ @@ -726,8 +726,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * * @return array * associated array of group list - * -rp = rowcount - * -page= offset + * -rp = rowcount + * -page= offset * @todo there seems little reason for the small number of functions that call this to pass in * params that then need to be translated in this function since they are coding them when calling */ diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index fd717dbb50..7823126291 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -51,7 +51,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Contact_BAO_Group object + * @return CRM_Contact_BAO_Group * @static */ public static function add(&$params) { @@ -808,9 +808,9 @@ AND contact_id IN ( $contactStr ) * * @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/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 4d6394edfa..8c43a2ed14 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -52,7 +52,7 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { * @param array $contact * Contact object. * - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @static */ public static function format(&$params, &$contact) { diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index a47bdb6a5d..6cca8c1acd 100644 --- a/CRM/Contact/BAO/Query/Hook.php +++ b/CRM/Contact/BAO/Query/Hook.php @@ -61,7 +61,7 @@ class CRM_Contact_BAO_Query_Hook { * Get or build the list of search objects (via hook) * * @return array - * of CRM_Contact_BAO_Query_Interface objects + * Array of CRM_Contact_BAO_Query_Interface objects */ public function getSearchQueryObjects() { if ($this->_queryObjects === NULL) { diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 719695e69d..fe56dd3d9f 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -47,7 +47,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * and this is new in 4.6 * All existing calls have been changed to createMultiple except the api call - however, it is recommended * that you call that as the end to end testing here is based on the api & refactoring may still be done - * @param $params + * @param array $params * @return \CRM_Contact_BAO_Relationship * @throws \CRM_Core_Exception */ @@ -78,10 +78,10 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * (reference ) an assoc array of name/value pairs. * @param array $ids * The array that holds all the db ids. - * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer + * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer * "we are moving away from the $ids param " * - * @return CRM_Contact_BAO_Relationship object + * @return CRM_Contact_BAO_Relationship * @static */ public static function createMultiple(&$params, $ids = array()) { @@ -304,7 +304,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Resolve passed in contact IDs to contact_id_a & contact_id_b - * @param $params + * @param array $params * @param array $ids * @param null $contactID * @throws \CRM_Core_Exception @@ -1584,7 +1584,7 @@ WHERE id IN ( {$contacts} ) * * @param int $contactID * contact id whose employers. - * are to be found. + * are to be found. * @param string $name * employers sort name. * @@ -1615,7 +1615,7 @@ WHERE id IN ( {$contacts} ) * @static * * @return array - * of contacts + * Array of contacts */ public static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) { $contacts = array(); diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index 11f1c93979..da43573c7d 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -49,7 +49,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contact_BAO_RelationshipType object + * @return CRM_Contact_BAO_RelationshipType * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 77b009a42e..70d787e59d 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -82,7 +82,7 @@ class CRM_Contact_Form_Task_LabelCommon { * UNUSED. * * @return array - * of rows for labels + * Array of rows for labels */ public static function getRows($contactIDs, $locationTypeID, $respectDoNotMail, $mergeSameAddress, $mergeSameHousehold) { @@ -253,13 +253,10 @@ class CRM_Contact_Form_Task_LabelCommon { /** * Get array of return properties for address fields required for mailing label + * * @return array - * return properites for address e.g - * array ( - * - [street_address] => 1, - * - [supplemental_address_1] => 1, - * - [supplemental_address_2] => 1 - * ) + * return properties for address e.g + * [street_address => 1, supplemental_address_1 => 1, supplemental_address_2 => 1] */ public static function getAddressReturnProperties() { $mailingFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, @@ -277,8 +274,8 @@ class CRM_Contact_Form_Task_LabelCommon { /** * Get token list from mailing format & contacts - * @param unknown_type $contacts - * @return unknown + * @param array $contacts + * @return array */ public static function getTokenData(&$contacts) { $mailingFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, @@ -307,12 +304,12 @@ class CRM_Contact_Form_Task_LabelCommon { } /** - * @param $rows + * @param array $rows * * @return array */ public function mergeSameHousehold(&$rows) { - # group selected contacts by type + // group selected contacts by type $individuals = array(); $households = array(); foreach ($rows as $contact_id => $row) { @@ -324,7 +321,7 @@ class CRM_Contact_Form_Task_LabelCommon { } } - # exclude individuals belonging to selected households + // exclude individuals belonging to selected households foreach ($households as $household_id => $row) { $dao = new CRM_Contact_DAO_Relationship(); $dao->contact_id_b = $household_id; @@ -337,7 +334,7 @@ class CRM_Contact_Form_Task_LabelCommon { } } - # merge back individuals and households + // merge back individuals and households $rows = array_merge($individuals, $households); return $rows; } diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 5b163576ac..4b0b4e5387 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -1695,7 +1695,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * * @param array $params * reference to an array containing all the. - * values for import + * values for import * @param int $onDuplicate * @param int $cid * contact id. diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 3b62110e10..8e17252c2b 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -92,7 +92,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param array $ids * The array that holds all the db ids. * - * @return CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution * @static */ public static function add(&$params, $ids = array()) { @@ -297,7 +297,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param array $ids * The array that holds all the db ids. * - * @return CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution * @static */ public static function create(&$params, $ids = array()) { @@ -540,7 +540,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * @param array $ids * (reference) the array that holds all the db ids. * - * @return CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution * @static */ public static function retrieve(&$params, &$defaults, &$ids) { @@ -846,13 +846,12 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * @param array $input * An assoc array of name/value pairs. * @param array $duplicates - * (reference ) store ids of duplicate contribs. - * + * (reference) store ids of duplicate contribs. * @param int $id * * @return boolean * true if duplicate, false otherwise - * static + * @static */ public static function checkDuplicate($input, &$duplicates, $id = NULL) { if (!$id) { @@ -902,9 +901,9 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * pairs * * @param array $params - * (reference ) an assoc array of name/value pairs. + * (reference) an assoc array of name/value pairs. * - * @return CRM_Contribute_BAO_ContributionProduct object + * @return CRM_Contribute_DAO_ContributionProduct * @static */ public static function addPremium(&$params) { @@ -1161,7 +1160,7 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id * * @return array * contribution id if success else NULL - * static + * @static */ public static function checkDuplicateIds($params) { $dao = new CRM_Contribute_DAO_Contribution(); @@ -1254,7 +1253,6 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont * Create address associated with contribution record. * * @param array $params - * An associated array. * @param int $billingLocationTypeID * * @return int @@ -1340,7 +1338,8 @@ WHERE $condition * @param string $componentName * Event/Membership. * - * @return $contributionId pending contribution id. + * @return int + * pending contribution id. * @static */ public static function checkOnlinePendingContribution($componentId, $componentName) { @@ -1395,7 +1394,7 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ } /** - * This function update contribution as well as related objects. + * Update contribution as well as related objects. */ public static function transitionComponents($params, $processContributionObject = FALSE) { // get minimum required values. @@ -1751,7 +1750,7 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ } /** - * This function returns all contribution related object ids. + * Returns all contribution related object ids. */ public static function getComponentDetails($contributionId) { $componentDetails = $pledgePayment = array(); @@ -1949,11 +1948,13 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac ); } - /* + /** * Load objects relations to contribution object * Objects are stored in the $_relatedObjects property * In the first instance we are just moving functionality from BASEIpn - - * see http://issues.civicrm.org/jira/browse/CRM-9996 + * @see http://issues.civicrm.org/jira/browse/CRM-9996 + * + * Note that the unit test for the BaseIPN class tests this function * * @param array $input * Input as delivered from Payment Processor. @@ -1963,13 +1964,6 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac * Is Payment processor / contribution page required. * @param bool $loadAll * Load all related objects - even where id not passed in? (allows API to call this). - * Note that the unit test for the BaseIPN class tests this function - */ - /** - * @param $input - * @param $ids - * @param bool $required - * @param bool $loadAll * * @return bool * @throws Exception @@ -2129,12 +2123,12 @@ WHERE contribution_id = %1 "; return TRUE; } - /* + /** * Create array of message information - ie. return html version, txt version, to field * * @param array $input * Incoming information. - * - is_recur - should this be treated as recurring (not sure why you wouldn't + * - is_recur - should this be treated as recurring (not sure why you wouldn't * just check presence of recur object but maintaining legacy approach * to be careful) * @param array $ids @@ -2142,20 +2136,14 @@ WHERE contribution_id = %1 "; * @param array $values * Any values that may have already been compiled by calling process. * This is augmented by values 'gathered' by gatherMessageValues + * @param bool $recur * @param bool $returnMessageText * Distinguishes between whether to send message or return. * message text. We are working towards this function ALWAYS returning message text & calling * function doing emails / pdfs with it + * * @return array * messages - */ - /** - * @param $input - * @param $ids - * @param $values - * @param bool $recur - * @param bool $returnMessageText - * * @throws Exception */ public function composeMessageArray(&$input, &$ids, &$values, $recur = FALSE, $returnMessageText = TRUE) { @@ -2279,26 +2267,18 @@ WHERE contribution_id = %1 "; } } - /* + /** * Gather values for contribution mail - this function has been created * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function * Values related to the contribution in question are gathered * * @param array $input * Input into function (probably from payment processor). + * @param array $values * @param array $ids - * The set of ids related to the inpurt. + * The set of ids related to the input. * * @return array - * - * NB don't add direct calls to the function as we intend to change the signature - */ - /** - * @param $input - * @param $values - * @param array $ids - * - * @return mixed */ public function _gatherMessageValues($input, &$values, $ids = array()) { // set display address of contributor @@ -3195,9 +3175,9 @@ WHERE contribution_id = %1 "; * * @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 */ @@ -3257,9 +3237,9 @@ WHERE contribution_id = %1 "; * Function to record additional payment for partial and refund contributions * * @param int $contributionId - * : is the invoice contribution id (got created after processing participant payment). + * is the invoice contribution id (got created after processing participant payment). * @param array $trxnData - * : to take user provided input of transaction details. + * to take user provided input of transaction details. * @param string $paymentType * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments. */ diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index 1d9b7a5527..2d427e8fa8 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -41,10 +41,10 @@ class CRM_Contribute_BAO_Contribution_Utils { * Form object. * @param array $paymentParams * Array with payment related key. - * value pairs + * value pairs * @param array $premiumParams * Array with premium related key. - * value pairs + * value pairs * @param int $contactID * Contact id. * @param int $contributionTypeId diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 5745ad5e35..1a13287d36 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -44,7 +44,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Contribute_DAO_ContributionPage object + * @return CRM_Contribute_DAO_ContributionPage * @static */ public static function &create(&$params) { @@ -720,7 +720,7 @@ WHERE entity_table = 'civicrm_contribution_page' * * @return boolean * true if payment processor supports recurring - * else false + * else false * * @static */ diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index ccfef2f84e..35abe09e93 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -57,7 +57,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution * @static * @todo move hook calls / extended logic to create - requires changing calls to call create not add */ @@ -114,7 +114,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * * @return boolean * true if duplicate, false otherwise - * static + * @static */ public static function checkDuplicate($params, &$duplicates) { $id = CRM_Utils_Array::value('id', $params); @@ -185,7 +185,7 @@ SELECT r.payment_processor_id * * @return array * an array of recurring ids count - * static + * @static */ public static function getCount(&$ids) { $recurID = implode(',', $ids); diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index e654b31857..03f443f54c 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -70,7 +70,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_ContributionSoft object + * @return CRM_Contribute_BAO_ContributionSoft * @static */ public static function retrieve(&$params, &$defaults) { @@ -150,7 +150,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio * Include PCP data. * * @return array - * of soft contribution ids, amounts, and associated contact ids + * Array of soft contribution ids, amounts, and associated contact ids * @static */ public static function getSoftContribution($contributionID, $all = FALSE) { diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index b8b3334a56..77236132fb 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -54,7 +54,7 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_ManagePremium object + * @return CRM_Contribute_BAO_ManagePremium * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 35e9f3a4b9..d338d30cb9 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -56,7 +56,7 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_ManagePremium object + * @return CRM_Contribute_BAO_ManagePremium * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index f515b9ab05..b7ed01b83e 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -371,7 +371,7 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co /** * @return array - * of valid processors. The array resembles the DB table but also has 'object' as a key + * Array of valid processors. The array resembles the DB table but also has 'object' as a key * @throws Exception */ public function getValidProcessors() { diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index 70a894aaba..33f632bb0b 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -1628,7 +1628,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * array of organization info. * @param int $contactID * individual contact id. One. - * who is doing the process of signup / contribution. + * who is doing the process of signup / contribution. * * @param array $values * form values array. diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 1068c45260..fdded7ee50 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -203,7 +203,7 @@ class CRM_Contribute_Form_SoftCredit { * @param $self * * @return array - * of errors + * Array of errors * @static */ public static function formRule($fields, $errors, $self) { diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index db0f7be77b..8f59642a54 100644 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -616,7 +616,8 @@ AND cas.entity_value = $id AND * @param array $values * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_ActionSchedule object on success, null otherwise + * @return CRM_Core_DAO_ActionSchedule|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$values) { diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 4789b739a6..662b62175d 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -642,7 +642,7 @@ ORDER BY civicrm_address.is_primary DESC, address_id ASC"; * * @param array $entityElements * The array containing entity_id and. - * entity_table name + * entity_table name * * @return array * the array of adrress data @@ -680,7 +680,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, * Get address sequence * * @return array - * of address sequence. + * Array of address sequence. */ public static function addressSequence() { $config = CRM_Core_Config::singleton(); @@ -1262,9 +1262,9 @@ SELECT is_primary, * * @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/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 72043e6528..e1753e6d79 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -57,7 +57,7 @@ class CRM_Core_BAO_Block { * Input parameters to find object. * * @return array - * of $block objects. + * Array of $block objects. * @static */ public static function &getValues($blockName, $params) { @@ -104,7 +104,7 @@ class CRM_Core_BAO_Block { * Name of the above object. * * @return array - * of $block objects. + * Array of $block objects. * @static */ public static function retrieveBlock(&$block, $blockName) { diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index fae2fdf2bc..f29952bdba 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -486,10 +486,10 @@ class CRM_Core_BAO_ConfigSetting { * Return likely default settings * @return array * site settings - * -$url, - * - $dir Base Directory - * - $siteName - * - $siteRoot + * - $url + * - $dir Base Directory + * - $siteName + * - $siteRoot */ public static function getBestGuessSettings() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 6e1ad55002..2d910bd981 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -131,7 +131,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Core_DAO_CustomField object + * @return CRM_Core_DAO_CustomField * @static */ public static function create(&$params) { @@ -327,7 +327,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_CustomField object + * @return CRM_Core_DAO_CustomField * @static */ public static function retrieve(&$params, &$defaults) { @@ -710,7 +710,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $fieldID * The custom field ID. * - * @return CRM_Core_DAO_CustomField $field the field object + * @return CRM_Core_DAO_CustomField + * $field the field object * @static * public */ @@ -2107,7 +2108,7 @@ AND cf.id = %1"; * * @param array $includeFieldIds * Ids of custom fields for which. - * option groups must be included. + * option groups must be included. * * Currently this is required in the cases where option groups are to be included * for inactive fields : CRM-5369 @@ -2416,7 +2417,7 @@ WHERE f.id IN ($ids)"; * * @param array $params * Custom data submitted. - * ie array( 'custom_1' => 'validate me' ); + * ie array( 'custom_1' => 'validate me' ); * * @return array * validation errors. diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 4bd9725590..f4aacdee5c 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -54,7 +54,7 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Core_DAO_CustomGroup object + * @return CRM_Core_DAO_CustomGroup * @static */ public static function create(&$params) { @@ -231,7 +231,7 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_CustomGroup object + * @return CRM_Core_DAO_CustomGroup * @static */ public static function retrieve(&$params, &$defaults) { @@ -330,15 +330,14 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param bool $onlySubType * * @return array - * array The returned array is keyed by group id and has the custom group table fields - * and a subkey 'fields' holding the specific custom fields. - * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data - * if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data' + * The returned array is keyed by group id and has the custom group table fields + * and a subkey 'fields' holding the specific custom fields. + * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data + * if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data' * * @todo - review this - It also returns an array called 'info' with tables, select, from, where keys - * The reason for the info array in unclear and it could be determined from parsing the group tree after creation - * With caching the performance impact would be small & the function would be cleaner - * + * The reason for the info array in unclear and it could be determined from parsing the group tree after creation + * With caching the performance impact would be small & the function would be cleaner * * @static */ @@ -740,7 +739,7 @@ ORDER BY civicrm_custom_group.weight, * @param string $query * @param array $includedTables * Tables to include - required because the function (for historical reasons). - * iterates through the group tree + * iterates through the group tree */ static public function buildTreeEntityDataFromQuery(&$groupTree, $query, $includedTables) { $dao = CRM_Core_DAO::executeQuery($query); @@ -2293,7 +2292,7 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT * Var which should have the list appended. * * @return array - * of types. + * Array of types. */ public static function getExtendedObjectTypes(&$types = array()) { static $flag = FALSE, $objTypes = array(); diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 7dd9eb4dcc..e91613b812 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -47,7 +47,7 @@ class CRM_Core_BAO_CustomOption { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_CustomOption object + * @return CRM_Core_BAO_CustomOption * @static */ public static function retrieve(&$params, &$defaults) { @@ -173,7 +173,8 @@ WHERE id = %1 /** * Delete Option * - * param $optionId integer option id + * @param $optionId integer + * option id * * @static */ diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 48cee4cde8..31bf6680b5 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -99,11 +99,11 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * * @param bool $flatFormat * This is true if you want simple associated. - * array of all the contact's dashlets whether or not they are enabled. + * array of all the contact's dashlets whether or not they are enabled. * * @param int $contactID * Provide the dashlets for the contact id. - * passed rather than the current user. + * passed rather than the current user. * * @return array * array of dashlets @@ -156,7 +156,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * the default dashlets. * * @return array - * of dashboard_id's + * Array of dashboard_id's */ public static function initializeDashlets() { $dashlets = array(); diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 685cb648c3..94d0af354c 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -56,7 +56,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_Domain object + * @return CRM_Core_DAO_Domain * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index d81621b0da..7b459fbfe5 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -189,7 +189,7 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; * * @param array $entityElements * The array containing entity_id and. - * entity_table name + * entity_table name * * @return array * the array of email id's diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index a43d0978d7..058dc1473a 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -74,7 +74,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_EntityTag object + * @return CRM_Core_BAO_EntityTag * @static */ public static function add(&$params) { @@ -118,7 +118,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_EntityTag object + * @return CRM_Core_BAO_EntityTag * @static */ public static function del(&$params) { @@ -401,9 +401,9 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * * @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/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index 09155244de..c6f90cf24b 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -47,7 +47,8 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_LocationType object on success, null otherwise + * @return CRM_Core_BAO_LocationType|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index e0c039b543..213299567d 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -53,7 +53,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * @param string $trxnEntityTable * Entity_table. * - * @return CRM_Core_BAO_FinancialTrxn object + * @return CRM_Core_BAO_FinancialTrxn * @static */ public static function create(&$params, $trxnEntityTable = NULL) { @@ -125,7 +125,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index 86d13f7581..5656bd703b 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -131,7 +131,7 @@ ORDER BY * * @param array $entityElements * The array containing entity_id and. - * entity_table name + * entity_table name * * @return array * the array of im details diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 87eb2b47ff..57f6d00aec 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -70,7 +70,8 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_Job object on success, null otherwise + * @return CRM_Core_DAO_Job|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index 33ab43de2a..d828eab3c2 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -441,7 +441,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * * @param string $groupName * - * @return CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue * @static */ public static function retrieve(&$params, &$values, $groupName = 'label_format') { diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 8fc79a71a8..004133f732 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -55,7 +55,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_LocaationType object on success, null otherwise + * @return CRM_Core_BAO_LocaationType|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index 6a42745d86..f9d1a5001a 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -47,7 +47,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * * @param bool $reset * - * @return CRM_Core_BAO_MailSettings DAO with the default mail settings set + * @return CRM_Core_BAO_MailSettings + * DAO with the default mail settings set */ public static function defaultDAO($reset = FALSE) { static $mailSettings = array(); @@ -117,7 +118,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_MailSettings object + * @return CRM_Core_BAO_MailSettings * @static */ public static function retrieve(&$params, &$defaults) { @@ -174,7 +175,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_MailSettings object + * @return CRM_Core_BAO_MailSettings * @static */ public static function create(&$params) { diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index d8ba0e6065..10101d6d66 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -48,7 +48,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_MessageTemplate object + * @return CRM_Core_BAO_MessageTemplate * @static */ public static function retrieve(&$params, &$defaults) { @@ -315,7 +315,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * A string-keyed array of function params, see function body for details. * * @return array - * of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates + * Array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates */ public static function sendTemplate($params) { $defaults = array( diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index a6dcd01850..8382350686 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -133,7 +133,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_Navigation object on success, NULL otherwise + * @return CRM_Core_BAO_Navigation|null + * object on success, NULL otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index c393b3637d..c03ed0e4df 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -49,7 +49,7 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_OptionGroup object + * @return CRM_Core_BAO_OptionGroup * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 6824ae8474..3eb2b944a8 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -132,7 +132,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_OptionValue object + * @return CRM_Core_BAO_OptionValue * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index ca7405b224..f63c8dabb4 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -244,7 +244,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * @param array $values * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue * @static */ public static function retrieve(&$params, &$values) { diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php index 4162f3bd37..dfe69b9373 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -305,7 +305,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * @param array $values * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_OptionValue object + * @return CRM_Core_DAO_OptionValue * @static */ public static function retrieve(&$params, &$values) { diff --git a/CRM/Core/BAO/Persistent.php b/CRM/Core/BAO/Persistent.php index 229d726540..818cb78e11 100644 --- a/CRM/Core/BAO/Persistent.php +++ b/CRM/Core/BAO/Persistent.php @@ -42,7 +42,7 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_Persistent object + * @return CRM_Core_BAO_Persistent * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 534a55a330..e36771c5da 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -185,7 +185,7 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; * * @param array $entityElements * The array containing entity_id and. - * entity_table name + * entity_table name * * @param null $type * diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index 26bf706142..5157b0a361 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -54,7 +54,8 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_PreferencesDate object on success, null otherwise + * @return CRM_Core_BAO_PreferencesDate|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 70a85c2f52..7659094aac 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -54,7 +54,7 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_UFField object + * @return CRM_Core_BAO_UFField * @static */ public static function retrieve(&$params, &$defaults) { @@ -203,7 +203,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * @param array $ids * Array containing the id. * - * @return CRM_Core_BAO_UFField object + * @return CRM_Core_BAO_UFField * * @static */ @@ -803,7 +803,7 @@ SELECT id * Array of profile fields that relate to address fields. * @param array $profileFilter * Filter to apply to profile fields - expected usage is to only fill based on. - * the bottom profile per CRM-13726 + * the bottom profile per CRM-13726 * * @return bool * Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118) diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 6d02ca8e8f..74d81d7d40 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -1617,7 +1617,7 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_UFJoin object + * @return CRM_Core_BAO_UFJoin * @static */ public static function addUFJoin(&$params) { diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index 47fbdd8551..b795fe56be 100644 --- a/CRM/Core/BAO/UFJoin.php +++ b/CRM/Core/BAO/UFJoin.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Core_DAO_UFJoin object + * @return CRM_Core_DAO_UFJoin * @static */ public static function &create($params) { diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index 0cfe09abd4..0a27a81855 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -58,7 +58,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_WordRepalcement object + * @return CRM_Core_DAO_WordRepalcement * @static */ diff --git a/CRM/Core/CodeGen/Main.php b/CRM/Core/CodeGen/Main.php index dc47ad99fc..530a28adbd 100644 --- a/CRM/Core/CodeGen/Main.php +++ b/CRM/Core/CodeGen/Main.php @@ -123,7 +123,7 @@ Alternatively you can get a version of CiviCRM that matches your PHP version /** * @return array - * of class names; each class implements CRM_Core_CodeGen_ITask + * Array of class names; each class implements CRM_Core_CodeGen_ITask */ public function getTasks() { $components = array( diff --git a/CRM/Core/CodeGen/Util/File.php b/CRM/Core/CodeGen/Util/File.php index bbc0894a53..7dd0b0c648 100644 --- a/CRM/Core/CodeGen/Util/File.php +++ b/CRM/Core/CodeGen/Util/File.php @@ -82,7 +82,7 @@ class CRM_Core_CodeGen_Util_File { * @param array $pairs * Each item is an array(0 => $searchBaseDir, 1 => $filePattern). * @return array - * of file paths + * Array of file paths */ public static function findManyFiles($pairs) { $files = array(); diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 6bcc5661a0..1cb6fceffa 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -534,7 +534,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Get the variable from the form scope * * @param string $name - * : name of the variable. + * name of the variable. * * * @return mixed diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 91bcb93651..76bb21db1b 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -400,7 +400,7 @@ class CRM_Core_DAO extends DB_DataObject { * @static * * @return array - * of CRM_Core_Reference_Interface + * Array of CRM_Core_Reference_Interface */ public static function getReferenceColumns() { return array(); @@ -1144,7 +1144,8 @@ FROM civicrm_domain * @param bool $i18nRewrite * @param bool $trapException * - * @return CRM_Core_DAO object that holds the results of the query + * @return CRM_Core_DAO + * object that holds the results of the query * @static */ static function &executeQuery( @@ -2031,7 +2032,7 @@ SELECT contact_id * Find all records which refer to this entity. * * @return array - * of objects referencing this + * Array of objects referencing this */ public function findReferences() { $links = self::getReferencesToTable(static::getTableName()); @@ -2056,11 +2057,11 @@ SELECT contact_id /** * @return array * each item has keys: - * - name: string - * - type: string - * - count: int - * - table: string|null SQL table name - * - key: string|null SQL column name + * - name: string + * - type: string + * - count: int + * - table: string|null SQL table name + * - key: string|null SQL column name */ public function getReferenceCounts() { $links = self::getReferencesToTable(static::getTableName()); @@ -2097,7 +2098,7 @@ SELECT contact_id * * @return array * structure of table and column, listing every table with a - * foreign key reference to $tableName, and the column where the key appears. + * foreign key reference to $tableName, and the column where the key appears. */ public static function getReferencesToTable($tableName) { $refsFound = array(); @@ -2143,9 +2144,9 @@ SELECT contact_id * * @param string $fieldName * @param string $context - * : @see CRM_Core_DAO::buildOptionsContext. + * @see CRM_Core_DAO::buildOptionsContext. * @param array $props - * : whatever is known about this bao object. + * whatever is known about this bao object. * * @return Array|bool */ @@ -2237,7 +2238,7 @@ SELECT contact_id * alternative field name ('as') @todo- not actually used. * @param bool $returnSanitisedArray * Return a sanitised array instead of a clause. - * this is primarily so we can add filters @ the api level to the Query object based fields + * this is primarily so we can add filters @ the api level to the Query object based fields * * @throws Exception * diff --git a/CRM/Core/DAO/permissions.php b/CRM/Core/DAO/permissions.php index 6df46c033a..207d0d3b7d 100644 --- a/CRM/Core/DAO/permissions.php +++ b/CRM/Core/DAO/permissions.php @@ -35,7 +35,7 @@ * @param $params : (array) api params * * @return array - * of permissions to check for this entity-action combo + * Array of permissions to check for this entity-action combo */ function _civicrm_api3_permissions($entity, $action, &$params) { $entity = _civicrm_api_get_entity_name_from_camel($entity); diff --git a/CRM/Core/Exception.php b/CRM/Core/Exception.php index 4d12f3aba9..7be50c964a 100644 --- a/CRM/Core/Exception.php +++ b/CRM/Core/Exception.php @@ -34,7 +34,7 @@ * The human friendly error message. * @param string $error_code * A computer friendly error code. By convention, no space (but underscore allowed). - * ex: mandatory_missing, duplicate, invalid_format + * ex: mandatory_missing, duplicate, invalid_format * @param array $data * Extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data. */ diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php index 274f2b019e..3e793a5c37 100644 --- a/CRM/Core/FileSearchInterface.php +++ b/CRM/Core/FileSearchInterface.php @@ -7,20 +7,20 @@ interface CRM_Core_FileSearchInterface { /** * @param array $query * Any of the following:. - * - text: string, plain text to search for - * - parent_table: string - entity to which file is directly attached - * - parent_id: int - entity to which file is directly attached - * - xparent_table: string - business-entity to which file is attached (directly or indirectly) - * - xparent_id: int - business-entity to which file is attached (directly or indirectly) + * - text: string, plain text to search for + * - parent_table: string - entity to which file is directly attached + * - parent_id: int - entity to which file is directly attached + * - xparent_table: string - business-entity to which file is attached (directly or indirectly) + * - xparent_id: int - business-entity to which file is attached (directly or indirectly) * @param int $limit * @param int $offset * @return array * each item has keys: - * - file_id: int - * - parent_table: string - entity to which file is directly attached - * - parent_id: int - entity to which file is directly attached - * - xparent_table: string - business-entity to which file is attached (directly or indirectly) - * - xparent_id: int - business-entity to which file is attached (directly or indirectly) + * - file_id: int + * - parent_table: string - entity to which file is directly attached + * - parent_id: int - entity to which file is directly attached + * - xparent_table: string - business-entity to which file is attached (directly or indirectly) + * - xparent_id: int - business-entity to which file is attached (directly or indirectly) */ public function search($query, $limit = self::DEFAULT_SEARCH_LIMIT, $offset = self::DEFAULT_SEARCH_OFFSET); } diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index acaa44971f..b62ce0277a 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -1440,17 +1440,17 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * @param string $label * @param array $props * Mix of html and widget properties, including:. - * - select - params to give to select2 widget - * - entity - defaults to contact - * - create - can the user create a new entity on-the-fly? + * - select - params to give to select2 widget + * - entity - defaults to contact + * - create - can the user create a new entity on-the-fly? * Set to TRUE if entity is contact and you want the default profiles, * or pass in your own set of links. @see CRM_Core_BAO_UFGroup::getCreateLinks for format * note that permissions are checked automatically - * - api - array of settings for the getlist api wrapper + * - api - array of settings for the getlist api wrapper * note that it accepts a 'params' setting which will be passed to the underlying api - * - placeholder - string - * - multiple - bool - * - class, etc. - other html properties + * - placeholder - string + * - multiple - bool + * - class, etc. - other html properties * @param bool $required * * @return HTML_QuickForm_Element @@ -1559,12 +1559,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Get contact if for a form object. Prioritise - * - cid in URL if 0 (on behalf on someoneelse) + * - cid in URL if 0 (on behalf on someoneelse) * (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - * - logged in user id if it matches the one in the cid in the URL - * - contact id validated from a checksum from a checksum - * - 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?) + * - logged in user id if it matches the one in the cid in the URL + * - contact id validated from a checksum from a checksum + * - 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 NULL|integer */ @@ -1637,9 +1637,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Ids of profiles that are on the form (to be autofilled). * @param array $autoCompleteField * - * - name_field - * - id_field - * - url (for ajax lookup) + * - name_field + * - id_field + * - url (for ajax lookup) * * @todo add data attributes so we can deal with multiple instances on a form */ diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 11d11270ef..3683e5a5f3 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -110,7 +110,7 @@ class CRM_Core_Form_RecurringEntity { * the default values are retrieved from the database * * - * @return None + * @return array */ public static function setDefaultValues() { $defaults = array(); @@ -322,7 +322,7 @@ class CRM_Core_Form_RecurringEntity { * Process the form submission * * - * @return None + * @return void */ public static function postProcess($params = array(), $type, $linkedEntities = array()) { //Check entity_id not present in params take it from class variable diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index 825b00ca72..2b532c53c3 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -123,7 +123,7 @@ class CRM_Core_I18n { * whether to return all languages or just the enabled ones. * * @return array - * of code/language name mappings + * Array of code/language name mappings */ public static function languages($justEnabled = FALSE) { static $all = NULL; @@ -503,7 +503,7 @@ class CRM_Core_I18n { * * @param $text * String string for translating. - * @param $params + * @param array $params * Array an array of additional parameters. * * @return string diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index aeb793693f..6c4eeef754 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -219,7 +219,7 @@ WHERE v.option_group_id = g.id * @param bool $fresh * * @return array - * of values as specified by the above params + * Array of values as specified by the above params * @static * @void */ diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index 09b71d7b0c..a0bad747ed 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -69,7 +69,7 @@ class CRM_Core_OptionValue { * Has links like edit, delete, disable ..etc. * * @return array - * of option-values + * Array of option-values * * @static */ @@ -392,7 +392,7 @@ class CRM_Core_OptionValue { * Do you want only active option values?. * * @return array - * of option-values + * Array of option-values * * @static */ diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index 10fe9c1608..163971fd19 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -184,7 +184,8 @@ abstract class CRM_Core_Payment { /** * Getter for payment form that is using the processor * @deprecated - * @return CRM_Core_Form A form object + * @return CRM_Core_Form + * A form object */ public function getForm() { return $this->_paymentForm; diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index c521cdca62..25d5f298b3 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -560,7 +560,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param bool $xmlSafe * @return mixed * value of the field, or empty string if the field is - * not set + * not set */ public function _getParam($field, $xmlSafe = FALSE) { $value = CRM_Utils_Array::value($field, $this->_params, ''); diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 29e7d40a5b..1ce44b3061 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -743,7 +743,7 @@ LIMIT 1;"; * Is it part of a recurring contribution. * @param bool $returnMessageText * Should text be returned instead of sent. This. - * is because the function is also used to generate pdfs + * is because the function is also used to generate pdfs * * @return array */ diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 251343dd79..e9f78a0270 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -216,7 +216,7 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * * @return mixed * value of the field, or empty string if the field is - * not set + * not set */ public function _getParam($field) { if (isset($this->_params[$field])) { diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index 382eef25fa..96d45ccf23 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -75,15 +75,15 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { } /** - * Function exists to get the values from the rp_invoice_id string + * get the values from the rp_invoice_id string * * @param string $name * E.g. i, values are stored in the string with letter codes. * @param bool $abort - * Fatal if not found?. + * Throw exception if not found * * @throws CRM_Core_Exception - * @return unknown + * @return mixed */ public function getValue($name, $abort = TRUE) { if ($abort && empty($this->_invoiceData[$name])) { diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index a9b113a674..24ba592571 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -451,7 +451,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * * @return mixed * value of the field, or empty string if the field is - * not set + * not set */ public function _getParam($field) { if (isset($this->_params[$field])) { diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 9b168cd768..0218a5bc06 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -85,7 +85,7 @@ class CRM_Core_Permission { * Given a permission string or array, check for access requirements * @param mixed $permissions * The permission to check as an array or string -see examples. - * arrays + * arrays * * Ex 1 * diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index 55335c1418..515a8992df 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -239,8 +239,8 @@ class CRM_Core_Permission_Base { * * @param $module * - * @return Array - * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return array + * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). * @see CRM_Core_Permission::getCorePermissions */ public static function getModulePermissions($module) { @@ -258,8 +258,8 @@ class CRM_Core_Permission_Base { * Get the permissions defined in the hook_civicrm_permission implementation * in all enabled CiviCRM module extensions. * - * @return Array - * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return array + * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ public function getAllModulePermissions() { $permissions = array(); diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index 21060df837..396d195ade 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -204,8 +204,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * * @param $module * - * @return Array - * of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). + * @return array + * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ public static function getModulePermissions($module) { $return_permissions = array(); diff --git a/CRM/Core/Reference/Dynamic.php b/CRM/Core/Reference/Dynamic.php index eaa88057c5..3f8f6d6c1b 100644 --- a/CRM/Core/Reference/Dynamic.php +++ b/CRM/Core/Reference/Dynamic.php @@ -21,7 +21,8 @@ class CRM_Core_Reference_Dynamic extends CRM_Core_Reference_Basic { * * @param CRM_Core_DAO $targetDao * The instance for which we want references. - * @return CRM_Core_DAO a query-handle (like the result of CRM_Core_DAO::executeQuery) + * @return CRM_Core_DAO + * a query-handle (like the result of CRM_Core_DAO::executeQuery) */ public function findReferences($targetDao) { $refColumn = $this->getReferenceKey(); diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php index 8c02b4e943..371981a3a5 100644 --- a/CRM/Core/Reference/Interface.php +++ b/CRM/Core/Reference/Interface.php @@ -32,8 +32,8 @@ interface CRM_Core_Reference_Interface { * The instance for which we want references. * @return array * a record describing the reference; must include the keys: - * - 'type': string (not necessarily unique) - * - 'count': int + * - 'type': string (not necessarily unique) + * - 'count': int */ public function getReferenceCount($targetDao); } diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 457d4cac31..3d29005437 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -392,7 +392,7 @@ class CRM_Core_Selector_Controller { * @param CRM_Core_Form $form * * @return array - * of rows + * Array of rows */ public function getRows($form) { if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) { diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index d2b48de03e..2f6746a5bc 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -262,9 +262,9 @@ class CRM_Core_Session { * * * @param string $name - * : name of the variable. + * name of the variable. * @param string $prefix - * : adds another level of scope to the session. + * adds another level of scope to the session. * * @return mixed */ @@ -327,9 +327,9 @@ class CRM_Core_Session { * * * @param string $name - * : name of the timer. + * name of the timer. * @param int $expire - * : expiry time (in seconds). + * expiry time (in seconds). * * @return mixed */ diff --git a/CRM/Core/Smarty/plugins/block.crmRegion.php b/CRM/Core/Smarty/plugins/block.crmRegion.php index d871b37d17..8ef43c0319 100644 --- a/CRM/Core/Smarty/plugins/block.crmRegion.php +++ b/CRM/Core/Smarty/plugins/block.crmRegion.php @@ -9,7 +9,7 @@ * Must define 'name'. * @param string $content * Default content. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @param $repeat diff --git a/CRM/Core/Smarty/plugins/block.crmScope.php b/CRM/Core/Smarty/plugins/block.crmScope.php index 91fac036e9..66bb8bcb4f 100644 --- a/CRM/Core/Smarty/plugins/block.crmScope.php +++ b/CRM/Core/Smarty/plugins/block.crmScope.php @@ -19,7 +19,7 @@ * Must define 'name'. * @param string $content * Default content. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @param $repeat diff --git a/CRM/Core/Smarty/plugins/block.edit.php b/CRM/Core/Smarty/plugins/block.edit.php index 851e724b94..3f1f21ebb0 100644 --- a/CRM/Core/Smarty/plugins/block.edit.php +++ b/CRM/Core/Smarty/plugins/block.edit.php @@ -45,7 +45,7 @@ * Template call's parameters. * @param string $text * {edit} block contents from the template. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/block.htxt.php b/CRM/Core/Smarty/plugins/block.htxt.php index d228479aee..226b9e17d1 100644 --- a/CRM/Core/Smarty/plugins/block.htxt.php +++ b/CRM/Core/Smarty/plugins/block.htxt.php @@ -41,7 +41,7 @@ * Template call's parameters. * @param string $text * {ts} block contents from the template. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/block.localize.php b/CRM/Core/Smarty/plugins/block.localize.php index 8e0bed30bc..293c9763c9 100644 --- a/CRM/Core/Smarty/plugins/block.localize.php +++ b/CRM/Core/Smarty/plugins/block.localize.php @@ -42,7 +42,7 @@ * Template call's parameters. * @param string $text * {ts} block contents from the template. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/block.serialize.php b/CRM/Core/Smarty/plugins/block.serialize.php index 1092629b18..d9fa5ab94e 100644 --- a/CRM/Core/Smarty/plugins/block.serialize.php +++ b/CRM/Core/Smarty/plugins/block.serialize.php @@ -43,7 +43,7 @@ * Template call's parameters. * @param string $text * {serialize} block contents from the template. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/block.ts.php b/CRM/Core/Smarty/plugins/block.ts.php index 092363eda2..fdea800b1f 100644 --- a/CRM/Core/Smarty/plugins/block.ts.php +++ b/CRM/Core/Smarty/plugins/block.ts.php @@ -44,7 +44,7 @@ * Template call's parameters. * @param string $text * {ts} block contents from the template. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/function.crmCrudLink.php b/CRM/Core/Smarty/plugins/function.crmCrudLink.php index 07b2cdaf95..5493b021ee 100644 --- a/CRM/Core/Smarty/plugins/function.crmCrudLink.php +++ b/CRM/Core/Smarty/plugins/function.crmCrudLink.php @@ -36,13 +36,13 @@ /** * Dynamically construct a link based on an entity-type and entity-id. * - * @param $params - * Array with keys:. - * - table: string - * - id: int - * - action: string, 'VIEW' or 'UPDATE' [default: VIEW] - * - title: string [optionally override default title] - * @param $smarty + * @param array $params + * Array with keys: + * - table: string + * - id: int + * - action: string, 'VIEW' or 'UPDATE' [default: VIEW] + * - title: string [optionally override default title] + * @param CRM_Core_Smarty $smarty * * @return string */ diff --git a/CRM/Core/Smarty/plugins/function.crmKey.php b/CRM/Core/Smarty/plugins/function.crmKey.php index 47d2e40a56..9ce692164c 100644 --- a/CRM/Core/Smarty/plugins/function.crmKey.php +++ b/CRM/Core/Smarty/plugins/function.crmKey.php @@ -38,7 +38,7 @@ * * @param string $params * Params of the {crmKey} call, with the ‘name’ key holding the name of the key. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php b/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php index b5bfba1315..a9b7354e39 100644 --- a/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php +++ b/CRM/Core/Smarty/plugins/function.crmNavigationMenu.php @@ -38,7 +38,7 @@ * * @param array $params * - is_default: bool, true if this is normal/default instance of the menu (which may be subject to CIVICRM_DISABLE_DEFAULT_MENU) - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/function.crmResURL.php b/CRM/Core/Smarty/plugins/function.crmResURL.php index dfeae38457..d18397f5dc 100644 --- a/CRM/Core/Smarty/plugins/function.crmResURL.php +++ b/CRM/Core/Smarty/plugins/function.crmResURL.php @@ -36,11 +36,11 @@ /** * Determine the URL of a resource file * - * @param $params - * Array with keys:. - * - ext: string, extension name. see CRM_Core_Resources::getUrl - * - file: string, relative file path. see CRM_Core_Resources::getUrl - * @param $smarty + * @param array $params + * Array with keys: + * - ext: string, extension name. see CRM_Core_Resources::getUrl + * - file: string, relative file path. see CRM_Core_Resources::getUrl + * @param CRM_Core_Smarty $smarty * * @return string */ diff --git a/CRM/Core/Smarty/plugins/function.crmScript.php b/CRM/Core/Smarty/plugins/function.crmScript.php index 952b0b21d5..683b42929f 100644 --- a/CRM/Core/Smarty/plugins/function.crmScript.php +++ b/CRM/Core/Smarty/plugins/function.crmScript.php @@ -36,14 +36,14 @@ /** * Add a Javascript file to a specific part of the page * - * @param $params - * Array with keys:. - * - ext: string, extension name. see CRM_Core_Resources::addScriptFile - * - file: string, relative file path. see CRM_Core_Resources::addScriptFile - * - url: string. see CRM_Core_Resources::addScriptURL - * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) - * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') - * @param $smarty + * @param array $params + * Array with keys: + * - ext: string, extension name. see CRM_Core_Resources::addScriptFile + * - file: string, relative file path. see CRM_Core_Resources::addScriptFile + * - url: string. see CRM_Core_Resources::addScriptURL + * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) + * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') + * @param CRM_Core_Smarty $smarty * * @throws Exception */ diff --git a/CRM/Core/Smarty/plugins/function.crmSigner.php b/CRM/Core/Smarty/plugins/function.crmSigner.php index 7cd7e5e7a4..80e38bc691 100644 --- a/CRM/Core/Smarty/plugins/function.crmSigner.php +++ b/CRM/Core/Smarty/plugins/function.crmSigner.php @@ -41,8 +41,8 @@ * var urlParams = ts={$mySig.ts}&extra={$mySig.extra}&sig={$mySig.signature} * {endcode} * - * @param $params - * Array with keys:. + * @param array $params + * Array with keys: * - var: string, a smarty variable to generate * - ts: int, the current time (if omitted, autogenerated) * - any other vars are put into the signature (sorted) diff --git a/CRM/Core/Smarty/plugins/function.crmStyle.php b/CRM/Core/Smarty/plugins/function.crmStyle.php index 4a98660b67..a71b9e5a22 100644 --- a/CRM/Core/Smarty/plugins/function.crmStyle.php +++ b/CRM/Core/Smarty/plugins/function.crmStyle.php @@ -36,14 +36,14 @@ /** * Add a stylesheet to a specific part of the page * - * @param $params - * Array with keys:. - * - ext: string, extension name. see CRM_Core_Resources::addStyleFile - * - file: string, relative file path. see CRM_Core_Resources::addStyleFile - * - url: string. see CRM_Core_Resources::addStyleURL - * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) - * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') - * @param $smarty + * @param array $params + * Array with keys: + * - ext: string, extension name. see CRM_Core_Resources::addStyleFile + * - file: string, relative file path. see CRM_Core_Resources::addStyleFile + * - url: string. see CRM_Core_Resources::addStyleURL + * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) + * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') + * @param CRM_Core_Smarty $smarty * * @throws Exception */ diff --git a/CRM/Core/Smarty/plugins/function.docURL.php b/CRM/Core/Smarty/plugins/function.docURL.php index 84d9bbc050..4b0d785be5 100644 --- a/CRM/Core/Smarty/plugins/function.docURL.php +++ b/CRM/Core/Smarty/plugins/function.docURL.php @@ -39,7 +39,7 @@ * * @param array $params * The function params. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * Reference to the smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/function.help.php b/CRM/Core/Smarty/plugins/function.help.php index fce651c236..45a7473c4d 100644 --- a/CRM/Core/Smarty/plugins/function.help.php +++ b/CRM/Core/Smarty/plugins/function.help.php @@ -38,7 +38,7 @@ * * @param array $params * The function params. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * Reference to the smarty object. * * @return string diff --git a/CRM/Core/Smarty/plugins/function.isValueChange.php b/CRM/Core/Smarty/plugins/function.isValueChange.php index 2e484bc2ea..4d0f78af95 100644 --- a/CRM/Core/Smarty/plugins/function.isValueChange.php +++ b/CRM/Core/Smarty/plugins/function.isValueChange.php @@ -47,7 +47,7 @@ * * @param array $params * Template call's parameters. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return NULL diff --git a/CRM/Core/Smarty/plugins/function.sectionTotal.php b/CRM/Core/Smarty/plugins/function.sectionTotal.php index 9d1e03fdc3..edd9f5efe8 100644 --- a/CRM/Core/Smarty/plugins/function.sectionTotal.php +++ b/CRM/Core/Smarty/plugins/function.sectionTotal.php @@ -28,7 +28,7 @@ /** * CiviCRM's Smarty report section totals plugin * - * Prints the correct report section total based on the given key and order in the section heirarchy + * Prints the correct report section total based on the given key and order in the section hierarchy * * @package CRM * @author Allen Shaw @@ -37,7 +37,7 @@ */ /** - * Smarty block function for printintg the correct report section total + * Smarty block function for printing the correct report section total * * Smarty param: string $key value of the current section column * Smarty param: int $depth the depth of the current section @@ -45,7 +45,7 @@ * * @param array $params * Template call's parameters. - * @param object $smarty + * @param CRM_Core_Smarty $smarty * The Smarty object. * * @return string @@ -53,14 +53,14 @@ */ function smarty_function_sectionTotal($params, &$smarty) { /* section totals are stored in template variable 'sectionTotals', - * which is a two-dimensional array keyed to a string which is a delimited - * concatenation (using CRM_Core_DAO::VALUE_SEPARATOR) of ordered permutations - * of section header values, e.g., - * 'foo' => 10, - * 'foo[VALUE_SEAPARATOR]bar' => 5, - * 'foo[VALUE_SEAPARATOR]bar2' => 5 - * Note: This array is created and assigned to the template in CRM_Report_Form::sectionTotals() - */ + * which is a two-dimensional array keyed to a string which is a delimited + * concatenation (using CRM_Core_DAO::VALUE_SEPARATOR) of ordered permutations + * of section header values, e.g., + * 'foo' => 10, + * 'foo[VALUE_SEAPARATOR]bar' => 5, + * 'foo[VALUE_SEAPARATOR]bar2' => 5 + * Note: This array is created and assigned to the template in CRM_Report_Form::sectionTotals() + */ static $sectionValues = array(); diff --git a/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php b/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php index 59459c5e4a..701e8c473d 100644 --- a/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php +++ b/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php @@ -11,16 +11,16 @@ * Note: This will perform like a dog, but who cares -- at most, we deal with O(100) iterations * as part of a background task. * - * @param $params - * , array with keys:. - * - activity_id: int, required - * - target_var: string, optional; name of a variable which will store the first/only target contact; default "target" - * - assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee" - * - return: string, optional; comma-separated list of fields to return for each contact + * @param array $params + * , Array with keys: + * - activity_id: int, required + * - target_var: string, optional; name of a variable which will store the first/only target contact; default "target" + * - assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee" + * - return: string, optional; comma-separated list of fields to return for each contact * - * @param $smarty + * @param CRM_Core_Smarty $smarty * - * @return empty + * @return string */ function smarty_function_simpleActivityContacts($params, &$smarty) { if (empty($params['activity_id'])) { diff --git a/CRM/Core/Smarty/resources/String.php b/CRM/Core/Smarty/resources/String.php index efa177eaa8..0a17977667 100644 --- a/CRM/Core/Smarty/resources/String.php +++ b/CRM/Core/Smarty/resources/String.php @@ -40,7 +40,7 @@ function civicrm_smarty_resource_string_get_template($tpl_name, &$tpl_source, &$ /** * @param string $tpl_name * @param $tpl_timestamp - * @param $smarty_obj + * @param CRM_Core_Smarty $smarty_obj * * @return bool */ @@ -51,7 +51,7 @@ function civicrm_smarty_resource_string_get_timestamp($tpl_name, &$tpl_timestamp /** * @param string $tpl_name - * @param $smarty_obj + * @param CRM_Core_Smarty $smarty_obj * * @return bool */ @@ -61,7 +61,7 @@ function civicrm_smarty_resource_string_get_secure($tpl_name, &$smarty_obj) { /** * @param string $tpl_name - * @param $smarty_obj + * @param CRM_Core_Smarty $smarty_obj */ function civicrm_smarty_resource_string_get_trusted($tpl_name, &$smarty_obj) { diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index ed0886fc1f..8b0abce1cb 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -223,7 +223,8 @@ class CRM_Core_StateMachine { * @param string $name * Name of page. * - * @return CRM_Core_State state object matching the name + * @return CRM_Core_State + * state object matching the name */ public function &getState($name) { if (isset($this->_states[$name])) { diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 30e7edef92..133430c4b2 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -533,7 +533,7 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { * Array of relationship name. * * @return array - * of relationship name. + * Array of relationship name. */ public static function getFormattedList(&$list) { $relName = array(); diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index b5bf3d615d..a996ff586a 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -84,8 +84,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { * * @return boolean * the result of this processing - * It is called from both the preview & the import actions - * (non-PHPdoc) + * It is called from both the preview & the import actions + * * @see CRM_Custom_Import_Parser_BaseClass::summary() */ public function summary(&$values) { diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 3d0da9030f..ac198e9cde 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -1610,7 +1610,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * @return array - * of field names which will be compared, so everything except ID. + * Array of field names which will be compared, so everything except ID. */ public static function getContactFields() { $contactFields = CRM_Contact_DAO_Contact::fields(); diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 48d98b4931..a254a9f342 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -49,7 +49,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Event_BAO_ManageEvent object + * @return CRM_Event_BAO_ManageEvent * @static */ public static function retrieve(&$params, &$defaults) { @@ -2159,7 +2159,7 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field * Event template id. * * @return array - * of custom data defaults. + * Array of custom data defaults. */ public static function getTemplateDefaultValues($templateId) { $defaults = array(); diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 76c084bc57..0a7c0f149a 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -83,7 +83,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Event_BAO_Participant object + * @return CRM_Event_BAO_Participant * @static */ public static function &add(&$params) { @@ -189,7 +189,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Event_BAO_Participant object + * @return CRM_Event_BAO_Participant * @static */ public static function create(&$params) { @@ -942,9 +942,9 @@ WHERE civicrm_participant.id = {$participantId} * (reference ) an assoc array of name/value pairs. * @param array $input * An assosiative array of name /value pairs. - * from other function + * from other function * - * @return CRM_Contribute_BAO_Contribution object + * @return CRM_Contribute_BAO_Contribution * @static */ public static function checkDuplicate($input, &$duplicates) { @@ -1798,7 +1798,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND * An array of additional participant ids. * * @return array - * of Urls. + * Array of Urls. * @static */ public static function getAdditionalParticipantUrl($participantIds) { @@ -2201,9 +2201,9 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI * * @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/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 86a0bc70c6..f55382e811 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -351,7 +351,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { * Event template id. * * @return array - * of custom data defaults. + * Array of custom data defaults. */ public function templateCustomDataValues($templateId) { $defaults = array(); diff --git a/CRM/Event/Form/ManageEvent/Repeat.php b/CRM/Event/Form/ManageEvent/Repeat.php index b418855348..483780df91 100644 --- a/CRM/Event/Form/ManageEvent/Repeat.php +++ b/CRM/Event/Form/ManageEvent/Repeat.php @@ -77,7 +77,7 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { * the default values are retrieved from the database * * - * @return None + * @return void */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Event/Form/Task/AddToGroup.php b/CRM/Event/Form/Task/AddToGroup.php index 9660e63565..03379946b8 100644 --- a/CRM/Event/Form/Task/AddToGroup.php +++ b/CRM/Event/Form/Task/AddToGroup.php @@ -202,7 +202,7 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { * Process the form after the input has been submitted and validated * * - * @return None + * @return void */ public function postProcess() { $params = $this->controller->exportValues(); diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index ad2e89c26c..b906f79b0f 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -177,7 +177,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * Return a status-type-keyed array of status classes * * @return array - * of status classes, keyed by status type + * Array of status classes, keyed by status type */ public static function &participantStatusClass() { static $statusClasses = NULL; @@ -273,7 +273,7 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * @param int $id * * @return array - * of event id → template title pairs + * Array of event id → template title pairs */ public static function &eventTemplates($id = NULL) { if (!self::$eventTemplates) { diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index 6b2d0d38ac..20ab61f778 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -49,7 +49,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_FinancialItem object + * @return CRM_Contribute_BAO_FinancialItem * @static */ public static function retrieve(&$params, &$defaults) { @@ -188,7 +188,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Core_BAO_FinancialTrxn object + * @return CRM_Core_BAO_FinancialTrxn * @static */ public static function createEntityTrxn($params) { diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index 69a6fc7ef0..e838ba48d9 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -55,7 +55,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 05d30add3c..d2ceab977e 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -58,7 +58,7 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin * * @param array $allValues * - * @return CRM_Contribute_BAO_ContributionType object + * @return CRM_Contribute_BAO_ContributionType * @static */ public static function retrieve(&$params, &$defaults, &$allValues = array()) { diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 2558a78435..d029da7106 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -101,7 +101,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Financial_DAO_PaymentProcessor object on success, null otherwise + * @return CRM_Financial_DAO_PaymentProcessor|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { @@ -122,8 +123,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param bool $is_active * Value we want to set the is_active field. * - * @return Object - * DAO object on sucess, null otherwise + * @return CRM_Financial_DAO_PaymentProcessor|null + * DAO object on success, null otherwise * * @static */ @@ -136,9 +137,9 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * * @param NULL * - * @return object + * @return CRM_Financial_DAO_PaymentProcessor|null * The default payment processor object on success, - * null otherwise + * null otherwise * @static */ public static function &getDefault() { @@ -151,7 +152,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Function to delete payment processor + * Delete payment processor * * @param int $paymentProcessorID * @@ -242,7 +243,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * Compare 2 payment processors to see which should go first based on is_default * (sort function for sortDefaultFirst) * @param array $processor1 - * @param array_type $processor2 + * @param array $processor2 * @return number */ public static function defaultComparison($processor1, $processor2) { @@ -353,12 +354,11 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * arguably this could go on the pseudoconstant class * * @param array $capabilities - * capabilities of processor e.g - * - BackOffice - * - TestMode - * - LiveMode - * - FutureStartDate - * include test processors (we want to phase this out in favour of the testMode Capability) + * capabilities of processor e.g + * - BackOffice + * - TestMode + * - LiveMode + * - FutureStartDate * * @param array $ids * @@ -417,8 +417,7 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @param string $type * Type of payment information to be retrieved. * - * @return int - * / array / object based on type + * @return int|array|object * @static */ public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') { diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 59a8690c43..b4b200cf40 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -54,7 +54,8 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_LocaationType object on success, null otherwise + * @return CRM_Core_BAO_LocaationType|null + * object on success, null otherwise * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Financial/Form/FinancialAccount.php b/CRM/Financial/Form/FinancialAccount.php index e1a7bf2f13..b9de52db6e 100644 --- a/CRM/Financial/Form/FinancialAccount.php +++ b/CRM/Financial/Form/FinancialAccount.php @@ -133,12 +133,11 @@ class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form { /** * Global validation rules for the form * - * @param $values + * @param array $values + * posted values of the form * @param $files * @param $self * - * @internal param array $fields posted values of the form - * * @return array * list of errors to be posted back to the form * @static diff --git a/CRM/Financial/Form/FinancialTypeAccount.php b/CRM/Financial/Form/FinancialTypeAccount.php index f1d1e64515..4aa650f3c1 100644 --- a/CRM/Financial/Form/FinancialTypeAccount.php +++ b/CRM/Financial/Form/FinancialTypeAccount.php @@ -232,12 +232,11 @@ class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form { /** * Global validation rules for the form * - * @param $values + * @param array $values + * posted values of the form * @param $files * @param $self * - * @internal param array $fields posted values of the form - * * @return array * list of errors to be posted back to the form * @static diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 9714fd410f..1dfac93403 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -54,7 +54,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Friend_BAO_Friend object + * @return CRM_Friend_BAO_Friend * @static */ public static function add(&$params) { @@ -93,7 +93,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @static */ public static function create(&$params) { @@ -343,7 +343,7 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Friend_BAO_Friend object + * @return CRM_Friend_BAO_Friend * @static */ public static function addTellAFriend(&$params) { diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index 8049eda709..ee33e30a07 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -134,7 +134,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Grant_BAO_ManageGrant object + * @return CRM_Grant_BAO_ManageGrant * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Import/Parser.php b/CRM/Import/Parser.php index 5bcb8fb99d..1d00c41023 100644 --- a/CRM/Import/Parser.php +++ b/CRM/Import/Parser.php @@ -234,9 +234,9 @@ abstract class CRM_Import_Parser { * Set and validate field values * * @param array $elements - * : array. + * array. * @param $erroneousField - * : reference. + * reference. * * @return int */ diff --git a/CRM/Mailing/BAO/Component.php b/CRM/Mailing/BAO/Component.php index 6091bad757..eb182b8260 100644 --- a/CRM/Mailing/BAO/Component.php +++ b/CRM/Mailing/BAO/Component.php @@ -49,7 +49,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_BAO_LocaationType object + * @return CRM_Core_BAO_LocaationType * @static */ public static function retrieve(&$params, &$defaults) { @@ -86,7 +86,7 @@ class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { * @param array $ids * (deprecated) the array that holds all the db ids. * - * @return CRM_Mailing_BAO_Component object + * @return CRM_Mailing_BAO_Component * * @static */ diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index f03282d24c..5035d67e7a 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -3057,7 +3057,7 @@ AND m.id = %1 * @param array $params * * @return array - * of mailings for a contact + * Array of mailings for a contact * * @static */ diff --git a/CRM/Mailing/BAO/MailingAB.php b/CRM/Mailing/BAO/MailingAB.php index caf86088c3..b8492ebccb 100644 --- a/CRM/Mailing/BAO/MailingAB.php +++ b/CRM/Mailing/BAO/MailingAB.php @@ -51,7 +51,7 @@ class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB { * @params array $params * Form values. * - * @param $params + * @param array $params * @param array $ids * * @return object diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index 9bbf11c01d..5b13e1592e 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -47,7 +47,8 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { * @param array $params * Values of the new EventQueue. * - * @return CRM_Mailing_Event_BAO_Queue The new EventQueue + * @return CRM_Mailing_Event_BAO_Queue + * The new EventQueue * @static */ public static function create($params) { diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index 1639439bab..7bd479d7ad 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -376,8 +376,8 @@ SELECT civicrm_email.id as email_id * The list of email. * @param int $contactId * Currently used during event registration/contribution. - * Specifically to avoid linking group to wrong duplicate contact - * during event registration. + * Specifically to avoid linking group to wrong duplicate contact + * during event registration. * @param string $context * * @return void diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index 9ce358c3a3..5edbfefe08 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -69,7 +69,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * @param array $ids * The array that holds all the db ids. * - * @return CRM_Member_BAO_Membership object + * @return CRM_Member_BAO_Membership * @static */ public static function add(&$params, $ids = array()) { @@ -238,7 +238,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * * @throws CRM_Core_Exception * - * @return CRM_Member_BAO_Membership object + * @return CRM_Member_BAO_Membership * @static */ public static function create(&$params, &$ids, $skipRedirect = FALSE, $activityType = 'Membership Signup') { @@ -519,7 +519,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * (reference ) an assoc array to hold the name / value pairs. * in a hierarchical manner * - * @return CRM_Member_BAO_Membership object + * @return CRM_Member_BAO_Membership * @static */ public static function retrieve(&$params, &$defaults) { @@ -558,7 +558,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * Membership id of values to return. * * @return array - * of key value pairs + * Array of key value pairs */ public static function getStatusANDTypeValues($membershipId) { $values = array(); @@ -3073,7 +3073,7 @@ WHERE civicrm_membership.is_test = 0"; * Mode of payment. * * @return array - * of membership type + * Array of membership type * @static */ public static function getContactsCancelledMembership($contactID, $isTest = FALSE) { diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 1bf4317e09..954e440150 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -54,7 +54,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Member_BAO_MembershipStatus object + * @return CRM_Member_BAO_MembershipStatus * @static */ public static function retrieve(&$params, &$defaults) { @@ -91,7 +91,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * (reference ) an assoc array of name/value pairs. * * @throws Exception - * @return CRM_Member_BAO_MembershipStatus object + * @return CRM_Member_BAO_MembershipStatus * @static */ public static function create($params) { diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index 110a6e91d0..0ffc195fa1 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -56,7 +56,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Member_BAO_MembershipType object + * @return CRM_Member_BAO_MembershipType * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 4726b23a79..b1b55d7001 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -61,7 +61,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Pledge_BAO_Pledge object + * @return CRM_Pledge_BAO_Pledge * @static */ public static function retrieve(&$params, &$defaults) { @@ -148,7 +148,7 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Pledge_BAO_Pledge object + * @return CRM_Pledge_BAO_Pledge * @static */ public static function &create(&$params) { @@ -1093,7 +1093,7 @@ SELECT pledge.contact_id as contact_id, * * @param int $pledgeID * @return array - * of int (civicrm_pledge_payment.id) + * Array of int (civicrm_pledge_payment.id) */ public static function findCancelablePayments($pledgeID) { $statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus()); diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 0dacaee5a1..ba801fb8a7 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -53,7 +53,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Pledge_BAO_PledgeBlock object + * @return CRM_Pledge_BAO_PledgeBlock * @static */ public static function retrieve(&$params, &$defaults) { @@ -72,7 +72,7 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Pledge_BAO_PledgeBlock object + * @return CRM_Pledge_BAO_PledgeBlock * @static */ public static function &create(&$params) { diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 43b3ef893b..b6239cb8f4 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -213,7 +213,7 @@ WHERE pledge_id = %1 * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Pledge_BAO_PledgePayment object + * @return CRM_Pledge_BAO_PledgePayment * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index 011ac7e70f..b1078fac7a 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -51,7 +51,7 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Price_DAO_LineItem object + * @return CRM_Price_DAO_LineItem * @static */ public static function create(&$params) { @@ -95,7 +95,7 @@ class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Price_BAO_LineItem object + * @return CRM_Price_BAO_LineItem * @static */ public static function retrieve(&$params, &$defaults) { @@ -149,11 +149,11 @@ AND li.entity_id = {$entityId} * * @param string $overrideWhereClause * E.g "WHERE contribution id = 7 " per the getLineItemsByContributionID wrapper. - * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even - * when we don't want it's entity-id magix + * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even + * when we don't want it's entity-id magix * * @return array - * of line items + * Array of line items */ public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL, $isQtyZero = TRUE, $relatedEntity = FALSE, $overrideWhereClause = '') { $whereClause = $fromClause = NULL; @@ -273,7 +273,7 @@ AND li.entity_id = {$entityId} * to the price set used for particular event * @param array $values * Reference to the values array(. - * this is + * this is * lineItem array) * * @return void diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index cf92e3d4cf..a0fee57978 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -51,7 +51,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Price_BAO_PriceField object + * @return CRM_Price_BAO_PriceField * @static */ public static function add(&$params) { @@ -75,7 +75,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Price_DAO_PriceField object + * @return CRM_Price_DAO_PriceField * @static */ public static function create(&$params) { @@ -177,7 +177,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Price_DAO_PriceField object + * @return CRM_Price_DAO_PriceField * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 3acc7f2f28..ee92370a02 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -47,7 +47,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param $ids * - * @return CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue * @static */ public static function add(&$params, $ids = array()) { @@ -76,7 +76,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param $ids * - * @return CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue * @static */ public static function create(&$params, $ids = array()) { @@ -133,7 +133,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Price_DAO_PriceFieldValue object + * @return CRM_Price_DAO_PriceFieldValue * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 40e5bb9f02..166355e3db 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -60,7 +60,7 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Price_DAO_PriceSet object + * @return CRM_Price_DAO_PriceSet * @static */ public static function create(&$params) { @@ -86,7 +86,7 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Price_DAO_PriceSet object + * @return CRM_Price_DAO_PriceSet * @static */ public static function retrieve(&$params, &$defaults) { @@ -287,7 +287,7 @@ WHERE ct.id = cp.financial_type_id AND * * @return boolean * false if fields exist for this set, true if the - * set could be deleted + * set could be deleted * * @static */ @@ -1092,7 +1092,7 @@ WHERE id = %1"; * Price Set id. * * @return array - * of the field ids + * Array of the field ids * * @static */ diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php index 8301e91f17..2e538fae60 100644 --- a/CRM/Report/BAO/Hook.php +++ b/CRM/Report/BAO/Hook.php @@ -62,7 +62,7 @@ class CRM_Report_BAO_Hook { * Get or build the list of search objects (via hook) * * @return array - * of CRM_Report_BAO_Hook_Interface objects + * Array of CRM_Report_BAO_Hook_Interface objects */ public function getSearchQueryObjects() { if ($this->_queryObjects === NULL) { diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 88ea2377c2..5bc25593eb 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -45,7 +45,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Report_DAO_ReportInstance object + * @return CRM_Report_DAO_ReportInstance * @static */ public static function add(&$params) { @@ -128,7 +128,7 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Report_BAO_ReportInstance object + * @return CRM_Report_BAO_ReportInstance * @static */ public static function &create(&$params) { diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index d7c9cf6506..70b027e27f 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -3888,8 +3888,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * Get phone columns to add to array * * @param array $options - * - prefix Prefix to add to table (in case of more than one instance of the table) - * - prefix_label Label to give columns from this phone table instance + * - prefix Prefix to add to table (in case of more than one instance of the table) + * - prefix_label Label to give columns from this phone table instance * * @return array * phone columns definition @@ -3920,8 +3920,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * Get address columns to add to array * * @param array $options - * - prefix Prefix to add to table (in case of more than one instance of the table) - * - prefix_label Label to give columns from this address table instance + * - prefix Prefix to add to table (in case of more than one instance of the table) + * - prefix_label Label to give columns from this address table instance * * @return array * address columns definition diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index 10d0c36ac2..c38422d8b1 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -711,8 +711,8 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { * Get address columns to add to array * * @param array $options - * - prefix Prefix to add to table (in case of more than one instance of the table) - * - prefix_label Label to give columns from this address table instance + * - prefix Prefix to add to table (in case of more than one instance of the table) + * - prefix_label Label to give columns from this address table instance * * @return array * address columns definition diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index 0d7898140c..6d304608c7 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -482,7 +482,8 @@ ALTER TABLE civicrm_dashboard /** * @param int $startId * @param int $endId - * @return CRM_Core_DAO columns include "id" and "image_URL" + * @return CRM_Core_DAO + * columns include "id" and "image_URL" */ public static function findContactImageUrls($startId, $endId) { $sql = " diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 12c22c939d..81b6fe6215 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -51,7 +51,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field * @static */ public static function &add(&$params) { @@ -75,7 +75,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field * @static */ public static function create(&$params) { @@ -163,7 +163,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index 3285fe9acb..9ef15d9ba1 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -47,7 +47,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param $ids * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue * @static */ public static function &add(&$params, $ids) { @@ -76,7 +76,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * * @param $ids * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue * @static */ public static function create(&$params, $ids) { @@ -120,7 +120,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue * @static */ public static function retrieve(&$params, &$defaults) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index a182e5c74a..1a5c6d6592 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -51,7 +51,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem * @static */ public static function create(&$params) { @@ -80,7 +80,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object + * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem * @static */ public static function retrieve(&$params, &$defaults) { @@ -105,7 +105,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * @param null $isQuick * * @return array - * of line items + * Array of line items */ public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) { $selectClause = $whereClause = $fromClause = NULL; @@ -183,7 +183,7 @@ WHERE %2.id = %1"; * to the price set used for particular event * @param array $values * Reference to the values array(. - * this is + * this is * lineItem array) * * @return void diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index fa7a38142a..c2e3465ac7 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -52,7 +52,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ * @param array $params * (reference) an assoc array of name/value pairs. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set * @static */ public static function create(&$params) { @@ -72,7 +72,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object + * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set * @static */ public static function retrieve(&$params, &$defaults) { @@ -259,7 +259,7 @@ WHERE ct.id = cp.contribution_type_id AND * * @return boolean * false if fields exist for this set, true if the - * set could be deleted + * set could be deleted * * @static */ @@ -911,7 +911,7 @@ WHERE id = %1"; * @param int id Price Set id * * @return array - * of the field ids + * Array of the field ids * * @static */ diff --git a/CRM/Utils/Check.php b/CRM/Utils/Check.php index 27addc2441..b246598894 100644 --- a/CRM/Utils/Check.php +++ b/CRM/Utils/Check.php @@ -115,7 +115,7 @@ class CRM_Utils_Check { * plugin status page or the Drupal admin/reports/status path. * * @return array - * of messages + * Array of messages * @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements */ public function checkAll() { diff --git a/CRM/Utils/Check/Security.php b/CRM/Utils/Check/Security.php index 9875a9ffbd..bc77749d37 100644 --- a/CRM/Utils/Check/Security.php +++ b/CRM/Utils/Check/Security.php @@ -81,7 +81,7 @@ class CRM_Utils_Check_Security { * requested directly. * * @return array - * of messages + * Array of messages * @see CRM-14091 */ public function checkLogFileIsNotAccessible() { @@ -130,7 +130,7 @@ class CRM_Utils_Check_Security { * to search engines; it only means they can be requested directly. * * @return array - * of messages + * Array of messages * @see CRM-14091 * * @TODO: Test with WordPress, Joomla. @@ -176,7 +176,7 @@ class CRM_Utils_Check_Security { * we'll probably match that). * * @return array - * of messages + * Array of messages * @see CRM-14091 * * @TODO: Test with WordPress, Joomla. diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php index a189bff952..d4ada62568 100644 --- a/CRM/Utils/Date.php +++ b/CRM/Utils/Date.php @@ -944,7 +944,7 @@ class CRM_Utils_Date { * * @param $format * Given format ( eg 'M Y', 'Y M' ). - * return array of qfMapping and date parts for date format. + * return array of qfMapping and date parts for date format. * * @return array|null|string */ diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index b127c58956..1d9505990f 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -573,7 +573,7 @@ abstract class CRM_Utils_Hook { * @param CRM_Core_DAO $dao * The item for which we want a reference count. * @param array $refCounts - * Each item in the array is an array with keys:. + * Each item in the array is an Array with keys: * - name: string, eg "sql:civicrm_email:contact_id" * - type: string, eg "sql" * - count: int, eg "5" if there are 5 email addresses that refer to $dao @@ -943,7 +943,7 @@ abstract class CRM_Utils_Hook { * * @param array $params * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html, - * returnPath, replyTo, headers, attachments (array) + * returnPath, replyTo, headers, attachments (array) * @param string $context * The context in which the hook is being invoked, eg 'civimail'. * @@ -988,8 +988,8 @@ abstract class CRM_Utils_Hook { * The case ID. * * @return array - * of data to be displayed, where the key is a unique id to be used for styling (div id's) - * and the value is an array with keys 'label' and 'value' specifying label/value pairs + * Array of data to be displayed, where the key is a unique id to be used for styling (div id's) + * and the value is an array with keys 'label' and 'value' specifying label/value pairs */ public static function caseSummary($caseID) { return self::singleton()->invoke(1, $caseID, @@ -1259,9 +1259,8 @@ abstract class CRM_Utils_Hook { * activity, campaign, case, contact, contribution, event, grant, membership, and pledge * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order ) * @param array &$rows the list of values, an associate array with fields that are displayed for that component - * @param $selector - * - * @internal param array $seletor the selector object. Allows you access to the context of the search + * @param array $selector + * the selector object. Allows you access to the context of the search * * @return void * modify the header and values object to pass the data u need @@ -1892,10 +1891,10 @@ abstract class CRM_Utils_Hook { * @param CRM_Core_DAO $bao * @param array $link * To define the link, add these keys to $link:. - * - title: string - * - path: string - * - query: array - * - url: string (used in lieu of "path"/"query") + * - title: string + * - path: string + * - query: array + * - url: string (used in lieu of "path"/"query") * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false * @return mixed */ diff --git a/CRM/Utils/Hook/UnitTests.php b/CRM/Utils/Hook/UnitTests.php index da5ee49a0b..a74a08525c 100644 --- a/CRM/Utils/Hook/UnitTests.php +++ b/CRM/Utils/Hook/UnitTests.php @@ -66,7 +66,7 @@ class CRM_Utils_Hook_UnitTests extends CRM_Utils_Hook { * Hook name, e.g civicrm_pre. * @param array $callable * Function to call ie array(class, method). - * eg. array($this, mymethod) + * eg. array($this, mymethod) */ public function setHook($hook, $callable) { $this->adhocHooks[$hook] = $callable; diff --git a/CRM/Utils/JS.php b/CRM/Utils/JS.php index 3183d519b0..ad6b425d22 100644 --- a/CRM/Utils/JS.php +++ b/CRM/Utils/JS.php @@ -41,7 +41,7 @@ class CRM_Utils_JS { * @param string $jsCode * Raw Javascript code. * @return array - * of translatable strings + * Array of translatable strings */ public static function parseStrings($jsCode) { $strings = array(); diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index 8587f14ff3..143d79bbc9 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -122,7 +122,7 @@ class CRM_Utils_PseudoConstant { * This may be inefficient and should generally be avoided. * * @return array - * of string, constant names + * Array of string, constant names */ public static function findConstants() { if (self::$constants === NULL) { @@ -145,7 +145,7 @@ class CRM_Utils_PseudoConstant { * @param $class * * @return array - * of string, constant names + * Array of string, constant names */ public static function findConstantsByClass($class) { $clazz = new ReflectionClass($class); diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 7500f357cf..c252acecba 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -1835,15 +1835,15 @@ class CRM_Utils_System { * * @param array $crudLinkSpec * With keys:. - * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] - * - entity_table: string, eg "civicrm_contact" - * - entity_id: int + * - 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: - * - path: string - * - query: array - * - title: string - * - url: string + * - path: string + * - query: array + * - title: string + * - url: string */ public static function createDefaultCrudLink($crudLinkSpec) { $crudLinkSpec['action'] = CRM_Utils_Array::value('action', $crudLinkSpec, CRM_Core_Action::VIEW); diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index 98cbf5352f..32c841ec4c 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -96,7 +96,7 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { * * @return bool * TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more - * efficiently if it is known to be in the drupal site + * efficiently if it is known to be in the drupal site */ public function formatResourceUrl(&$url) { $internal = FALSE; diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index f6f60ab92d..77bc831b09 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -1310,7 +1310,7 @@ class CRM_Utils_Token { * * @param array $contactIDs * This should always be array(0) or its not anonymous - left to keep signature same. - * as main fn + * as main fn * @param string $returnProperties * @param bool $skipOnHold * @param bool $skipDeceased diff --git a/CRM/Utils/Weight.php b/CRM/Utils/Weight.php index a7213b6337..aebc9a9695 100644 --- a/CRM/Utils/Weight.php +++ b/CRM/Utils/Weight.php @@ -47,7 +47,7 @@ class CRM_Utils_Weight { * Field => value to be used in the WHERE. * @param string $weightField * Field which contains the weight value,. - * defaults to 'weight' + * defaults to 'weight' * * @return bool */ @@ -94,7 +94,7 @@ class CRM_Utils_Weight { * Field => value to be used in the WHERE. * @param string $weightField * Field which contains the weight value,. - * defaults to 'weight' + * defaults to 'weight' * * @return bool */ @@ -131,7 +131,7 @@ class CRM_Utils_Weight { * Field => value to be used in the WHERE. * @param string $weightField * Field which contains the weight value,. - * defaults to 'weight' + * defaults to 'weight' * * @return int */ @@ -239,7 +239,7 @@ class CRM_Utils_Weight { * Field => value to be used in the WHERE. * @param string $weightField * Field which contains the weight value,. - * defaults to 'weight' + * defaults to 'weight' * * @return integer */ @@ -262,7 +262,7 @@ class CRM_Utils_Weight { * Field => value to be used in the WHERE. * @param string $weightField * Field which contains the weight value,. - * defaults to 'weight' + * defaults to 'weight' * * @return integer */ @@ -288,7 +288,8 @@ class CRM_Utils_Weight { * * @param null $groupBy * - * @return CRM_Core_DAO objet that holds the results of the query + * @return CRM_Core_DAO + * objet that holds the results of the query */ static function &query( $queryType, diff --git a/Civi/CiUtil/PHPUnitScanner.php b/Civi/CiUtil/PHPUnitScanner.php index 6b25edab37..d534bc7e2f 100644 --- a/Civi/CiUtil/PHPUnitScanner.php +++ b/Civi/CiUtil/PHPUnitScanner.php @@ -67,7 +67,8 @@ class PHPUnitScanner { } /** - * @param array $testClasses + * @param array $paths + * * @return array * each element is an array with keys: * - file: string diff --git a/Civi/Install/Requirements.php b/Civi/Install/Requirements.php index 3cb0da52e4..68c95cc4b1 100644 --- a/Civi/Install/Requirements.php +++ b/Civi/Install/Requirements.php @@ -85,7 +85,7 @@ class Requirements { * @param array $db_config * An array with keys: * - host (with optional port specified eg. localhost:12345) - * = database (name of database to select) + * - database (name of database to select) * - username * - password * diff --git a/api/v3/Acl.php b/api/v3/Acl.php index c2f629f826..39e3d7ee9d 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_acl_delete($params) { diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index b86af8fe07..4e9d782825 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_acl_role_delete($params) { diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index d37ef93185..c9fbd613eb 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. + * Array of newly created activity contact records. * @access public */ function civicrm_api3_activity_contact_create($params) { diff --git a/api/v3/Address.php b/api/v3/Address.php index d965dda803..b6520d9f83 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. + * Array of newly created tag property values. * @access public */ function civicrm_api3_address_create(&$params) { diff --git a/api/v3/Attachment.php b/api/v3/Attachment.php index 8ff8fba0da..041b996115 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. + * Array of newly created file property values. * @access public * @throws API_Exception validation errors */ @@ -190,7 +190,7 @@ function _civicrm_api3_attachment_delete_spec(&$spec) { } /** - * @param $params + * @param array $params * @return array * @throws API_Exception */ diff --git a/api/v3/Batch.php b/api/v3/Batch.php index bf4d674a75..5165cb90dd 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_batch_delete($params) { diff --git a/api/v3/Case.php b/api/v3/Case.php index 351a848627..4be69dba1c 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -290,7 +290,7 @@ function civicrm_api3_case_activity_create($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * Array of deprecated actions */ function _civicrm_api3_case_deprecation() { return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.'); diff --git a/api/v3/Contact.php b/api/v3/Contact.php index fb619c9d76..00aeb2b169 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -413,7 +413,7 @@ function _civicrm_api3_contact_check_params(&$params, $dupeCheck = TRUE, $dupeEr * @param int $contactID * If present the contact with that ID is updated. * - * @return CRM_Contact_BAO_Contact object + * @return CRM_Contact_BAO_Contact * @access public * @static */ @@ -857,7 +857,7 @@ LIMIT 0, {$limit} /** * @deprecated api notice * @return array - * of deprecated actions + * Array of deprecated actions */ function _civicrm_api3_contact_deprecation() { return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".'); diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 3826f96b0b..8a0923f9ea 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -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 + * Array of contributions, if error an array with an error id and error message * @static void * @access public * {@getfields Contribution_get} @@ -270,7 +270,7 @@ function _civicrm_api3_contribution_get_spec(&$params) { * * @param array $params * Associative array of property name/value. - * pairs to insert in new contact. + * pairs to insert in new contact. * @param array $values * The reformatted properties that we can use internally. * ' diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index 3a73c916d3..9932b0a8f2 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -42,7 +42,7 @@ * function after deletion so that the field is available for us (getfields manages date conversion * among other things * - * @param $params + * @param array $params * Array Associative array of property name/value pairs to create new custom field. * * @return array @@ -103,7 +103,7 @@ function _civicrm_api3_custom_field_create_spec(&$params) { /** * Use this API to delete an existing custom group field. * - * @param $params + * @param array $params * Array id of the field to be deleted. * * @return array diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index 23f89ace2e..2bee48edfd 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -43,7 +43,7 @@ * * @param array $params * An associative array used in construction. - * retrieval of the object + * retrieval of the object * @todo missing get function * * @@ -56,7 +56,7 @@ * See the CRM Data Model for custom_group property definitions * $params['class_name'] is a required field, class being extended. * - * @param $params + * @param array $params * Array Associative array of property name/value pairs to insert in group. * {@getfields CustomGroup_create} * diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index 3d91e79642..7d4bd8e6fe 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -33,7 +33,7 @@ function civicrm_api3_custom_search_get($params) { * @param array $params * * @return array - * of newly created option_value property values. + * Array of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php index afd2a74dbe..cbd236f06c 100644 --- a/api/v3/CustomValue.php +++ b/api/v3/CustomValue.php @@ -36,38 +36,35 @@ * @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $ */ -/** - * Files required for this package - */ - /** * Sets custom values for an entity. * - * - * @param $params + * @param array $params * Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID. - * for example: - * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using - * 'entity_id' => 123, - * // (omitting :id) inserts or updates a field in a single-valued group - * 'custom_6' => 'foo', - * // custom_24 is checkbox or multiselect, so pass items as an array - * 'custom_24' => array('bar', 'baz'), - * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 - * 'custom_33:5' => value, - * // inserts new record in multi-valued group - * 'custom_33:-1' => value, - * // inserts another new record in multi-valued group - * 'custom_33:-2' => value, - * // you can use group_name:field_name instead of ID - * 'custom_some_group:my_field => 'myinfo', - * // updates record ID 8 in my_other_field in multi-valued some_big_group - * 'custom_some_big_group:my_other_field:8 => 'myinfo', + * + * @example + * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using + * 'entity_id' => 123, + * // (omitting :id) inserts or updates a field in a single-valued group + * 'custom_6' => 'foo', + * // custom_24 is checkbox or multiselect, so pass items as an array + * 'custom_24' => array('bar', 'baz'), + * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 + * 'custom_33:5' => value, + * // inserts new record in multi-valued group + * 'custom_33:-1' => value, + * // inserts another new record in multi-valued group + * 'custom_33:-2' => value, + * // you can use group_name:field_name instead of ID + * 'custom_some_group:my_field => 'myinfo', + * // updates record ID 8 in my_other_field in multi-valued some_big_group + * 'custom_some_big_group:my_other_field:8 => 'myinfo', * * * @throws Exception - * @return array('values' => TRUE) or array('is_error' => 1, 'error_message' => 'what went wrong') + * @return array + * ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong'] * * @access public */ @@ -129,14 +126,14 @@ function _civicrm_api3_custom_value_create_spec(&$params) { /** * Use this API to get existing custom values for an entity. * - * @param $params + * @param array $params * Array specifying the entity_id. - * Optionally include entity_type param, i.e. 'entity_type' => 'Activity' - * If no entity_type is supplied, it will be determined based on the fields you request. - * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed. - * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned) - * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 - * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 + * Optionally include entity_type param, i.e. 'entity_type' => 'Activity' + * If no entity_type is supplied, it will be determined based on the fields you request. + * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed. + * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned) + * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 + * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 * * @throws API_Exception * @return array diff --git a/api/v3/Entity.php b/api/v3/Entity.php index cfc64b5994..1346b66aa0 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 + * Array of deprecated api entities */ function _civicrm_api3_entity_deprecation($entities) { $deprecated = array(); diff --git a/api/v3/Event.php b/api/v3/Event.php index 80059928c9..3c536acb2e 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -38,10 +38,6 @@ * */ -/** - * Files required for this package - */ - /** * Create a Event * @@ -49,7 +45,7 @@ * * @param array $params * Input parameters. - * Allowed @params array keys are: + * Allowed @params array keys are: * {@getfields event_create} * * @return array @@ -105,8 +101,8 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) { * An associative array of name/value property values of civicrm_event. * {@getfields event_get} * - * @return Array - * of all found event property values. + * @return array + * Array of all found event property values. * @access public * */ diff --git a/api/v3/Extension.php b/api/v3/Extension.php index 7415dab7da..3d59825453 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.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 + * Array of extension keys * @throws API_Exception */ function _civicrm_api3_getKeys($params) { diff --git a/api/v3/File.php b/api/v3/File.php index 992b6ab92c..7230bf9182 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. + * Array of newly created file property values. * @access public */ function civicrm_api3_file_create($params) { @@ -86,8 +86,8 @@ function civicrm_api3_file_create($params) { * @param array $params * An associative array of name/value property values of civicrm_file. * - * @return Array - * of all found file object property values. + * @return array + * Array 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 + * Array of updated file object property values * @access public */ function civicrm_api3_file_update($params) { diff --git a/api/v3/FinancialAccount.php b/api/v3/FinancialAccount.php index 217b5a73b0..0b21ea27cf 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_financial_account_delete($params) { diff --git a/api/v3/FinancialType.php b/api/v3/FinancialType.php index 77f4294730..212b15691f 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_financial_type_delete($params) { diff --git a/api/v3/Generic.php b/api/v3/Generic.php index aca852d020..7a6e998610 100644 --- a/api/v3/Generic.php +++ b/api/v3/Generic.php @@ -12,11 +12,11 @@ * * @param array $apiRequest * Api request as an array. Keys are. - * - entity: string - * - action: string - * - version: string - * - function: callback (mixed) - * - params: array, varies + * - entity: string + * - action: string + * - version: string + * - function: callback (mixed) + * - params: array, varies * @return array * API success object */ @@ -278,7 +278,7 @@ function civicrm_api3_generic_replace($apiRequest) { * Api request as an array. * * @return array - * of results + * Array of results */ function civicrm_api3_generic_getoptions($apiRequest) { // Resolve aliases diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php index 2a3d1ceaee..b9bbff4ba1 100644 --- a/api/v3/Generic/Update.php +++ b/api/v3/Generic/Update.php @@ -36,12 +36,12 @@ * and call 'create' to save the revised entity. * * @param array $apiRequest - * Array with keys:. - * - entity: string - * - action: string - * - version: string - * - function: callback (mixed) - * - params: array, varies + * Array with keys: + * - entity: string + * - action: string + * - version: string + * - function: callback (mixed) + * - params: array, varies * * @return array|int|mixed */ diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index 5d7e680706..fc66123908 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -247,7 +247,7 @@ function civicrm_api3_group_contact_update_status($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * Array of deprecated actions */ function _civicrm_api3_group_contact_deprecation() { return array( diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php index b450dcd17e..d0b4b420cb 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -60,7 +60,7 @@ function civicrm_api3_group_organization_get($params) { * @example GroupOrganizationCreate.php * {@getfields GroupOrganization_create} * - * @param $params + * @param array $params * Array. * * @return array diff --git a/api/v3/Im.php b/api/v3/Im.php index 8b03d4fdb2..8d4efa936e 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. + * Array of newly created IM property values. * @access public */ function civicrm_api3_im_create($params) { diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php index 466ca955f4..135ce9c353 100644 --- a/api/v3/LineItem.php +++ b/api/v3/LineItem.php @@ -73,7 +73,7 @@ function _civicrm_api3_line_item_create_spec(&$params) { * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. - * as null, all line_items will be returned (default limit is 25) + * as null, all line_items will be returned (default limit is 25) * * @return array * Array of matching line_items @@ -92,7 +92,7 @@ function civicrm_api3_line_item_get($params) { * * @param array $params * Array containing id of the group. - * to be deleted + * to be deleted * * @return array * API result array diff --git a/api/v3/LocBlock.php b/api/v3/LocBlock.php index e357b831b2..a6f15c6ab7 100644 --- a/api/v3/LocBlock.php +++ b/api/v3/LocBlock.php @@ -93,7 +93,7 @@ function civicrm_api3_loc_block_create($params) { * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. - * as null, all loc_blocks will be returned (default limit is 25) + * as null, all loc_blocks will be returned (default limit is 25) * * @return array * Array of matching loc_blocks diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index b551c8c7d3..98198cad43 100755 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Handle a create event. * @@ -242,7 +238,7 @@ function civicrm_api3_mailing_event_confirm($params) { /** * @deprecated api notice * @return array - * of deprecated actions + * Array of deprecated actions */ function _civicrm_api3_mailing_deprecation() { return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.'); diff --git a/api/v3/MailingAB.php b/api/v3/MailingAB.php index 9a7250fd9f..b6a1bfbfcd 100755 --- a/api/v3/MailingAB.php +++ b/api/v3/MailingAB.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Handle a create mailing ab testing * diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php index 91046a7a3e..671c390fc7 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_mailing_component_delete($params) { diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php index 8aee61694c..6d0a73ab46 100644 --- a/api/v3/MailingJob.php +++ b/api/v3/MailingJob.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Handle creation of a Mailing Job for a Mailing. */ diff --git a/api/v3/MailingRecipients.php b/api/v3/MailingRecipients.php index 37fdc90b29..0d4e8c89f9 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Returns array of Mailing Recipients diff --git a/api/v3/Membership.php b/api/v3/Membership.php index 04452a6773..66cc816856 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -42,7 +42,7 @@ * * This API is used for deleting a contact membership * - * @param $params + * @param array $params * Array array holding id - Id of the contact membership to be deleted. * * @return array @@ -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. + * Array of newly created membership property values. * {@getfields membership_create} * @access public */ @@ -189,8 +189,8 @@ function _civicrm_api3_membership_get_spec(&$params) { * options affecting the desired results; has legacy support * for just passing the contact_id itself as the argument * - * @return Array - * of all found membership property values. + * @return array + * Array of all found membership property values. * @access public * @todo needs some love - basically only a get for a given contact right now * {@getfields membership_get} diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index f9a9dbe4e9..20b3f62491 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. + * Array of newly created membership status property values. * {@getfields MembershipStatus_create} * @access public */ @@ -62,8 +62,8 @@ function civicrm_api3_membership_status_create($params) { * @param array $params * An associative array of name/value property values of civicrm_membership_status. * - * @return Array - * of all found membership status property values. + * @return array + * Array 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 + * Array of updated membership status property values * @access public */ function &civicrm_api3_membership_status_update($params) { diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php index b8ac452fb4..bde3d84fb6 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -88,8 +88,8 @@ function _civicrm_api3_membership_type_create_spec(&$params) { * An associative array of name/value property values of civicrm_membership_type. * {getfields MembershipType_get} * - * @return Array - * of all found membership type property values. + * @return array + * Array of all found membership type property values. * @access public */ function civicrm_api3_membership_type_get($params) { diff --git a/api/v3/Note.php b/api/v3/Note.php index 663c429785..e8aad30f1e 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Create Note * @@ -102,7 +98,7 @@ function civicrm_api3_note_delete($params) { * * @return array * array of properties, - * if error an array with an error id and error message + * if error an array with an error id and error message * {@getfields note_get} * @static void * @access public diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index cc80aecf0f..e78fe76f61 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -38,7 +38,7 @@ function civicrm_api3_option_value_get($params) { * * @throws API_Exception * @return array - * of newly created option_value property values. + * Array of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ diff --git a/api/v3/Participant.php b/api/v3/Participant.php index 14f55c8934..3620497fd5 100644 --- a/api/v3/Participant.php +++ b/api/v3/Participant.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Create an Event Participant * diff --git a/api/v3/ParticipantPayment.php b/api/v3/ParticipantPayment.php index 76ccc6782f..a925ad080d 100644 --- a/api/v3/ParticipantPayment.php +++ b/api/v3/ParticipantPayment.php @@ -37,10 +37,6 @@ * */ -/** - * Files required for this package - */ - /** * Create a Event Participant Payment * @@ -53,7 +49,7 @@ * {@example ParticipantPaymentCreate.php 0} * * @return array - * of newly created payment property values. + * Array of newly created payment property values. * {@getfields ParticipantPayment_create} * @access public */ diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index 4b95d99021..41fc0dfc67 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. + * Array of newly created PaymentProcessor property values. * @access public */ function civicrm_api3_payment_processor_create($params) { diff --git a/api/v3/Phone.php b/api/v3/Phone.php index 92ff78bd57..5b64093b5e 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. + * Array of newly created phone property values. * @access public */ function civicrm_api3_phone_create($params) { diff --git a/api/v3/Premium.php b/api/v3/Premium.php index b3d0eab946..89826298d6 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_premium_delete($params) { diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php index d7dd42d2af..02634f38bf 100644 --- a/api/v3/PriceField.php +++ b/api/v3/PriceField.php @@ -68,7 +68,7 @@ function _civicrm_api3_price_field_create_spec(&$params) { * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. - * as null, all price_fields will be returned (default limit is 25) + * as null, all price_fields will be returned (default limit is 25) * * @return array * Array of matching price_fields @@ -87,7 +87,7 @@ function civicrm_api3_price_field_get($params) { * * @param array $params * Array containing id of the group. - * to be deleted + * to be deleted * * @return array * API result array diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php index f52967e1b3..9c701e3a61 100644 --- a/api/v3/PriceFieldValue.php +++ b/api/v3/PriceFieldValue.php @@ -81,7 +81,7 @@ function _civicrm_api3_price_field_value_create_spec(&$params) { * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. - * as null, all price_field_values will be returned (default limit is 25) + * as null, all price_field_values will be returned (default limit is 25) * * @return array * Array of matching price_field_values @@ -100,7 +100,7 @@ function civicrm_api3_price_field_value_get($params) { * * @param array $params * Array containing id of the group. - * to be deleted + * to be deleted * * @return array * API result array diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php index 326648cd81..887f7ad833 100644 --- a/api/v3/PriceSet.php +++ b/api/v3/PriceSet.php @@ -82,7 +82,7 @@ function _civicrm_api3_price_set_create_spec(&$params) { * * @param array $params * Array of one or more valid property_name=>value pairs. If $params is set. - * as null, all price_sets will be returned (default limit is 25) + * as null, all price_sets will be returned (default limit is 25) * * @return array * Array of matching price_sets @@ -111,7 +111,7 @@ function civicrm_api3_price_set_get($params) { * * @param array $params * Array containing id of the group. - * to be deleted + * to be deleted * * @return array * API result array diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php index 1803116fbb..b174e2d0af 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_print_label_delete($params) { diff --git a/api/v3/Product.php b/api/v3/Product.php index d60658c8cd..3b8e7a2de2 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_product_delete($params) { diff --git a/api/v3/Profile.php b/api/v3/Profile.php index d482624ade..d9984bc160 100644 --- a/api/v3/Profile.php +++ b/api/v3/Profile.php @@ -740,7 +740,7 @@ function _civicrm_api3_profile_appendaliases($values, $entity) { /** * @deprecated api notice * @return array - * of deprecated actions + * Array of deprecated actions */ function _civicrm_api3_profile_deprecation() { return array( diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index e378719777..5031af7caf 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -20,7 +20,7 @@ function civicrm_api3_report_instance_get($params) { * @param array $params * * @return array - * of newly created report instance property values. + * Array of newly created report instance property values. * @access public */ function civicrm_api3_report_instance_create($params) { diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index 0d85291061..7df1de3359 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -33,7 +33,7 @@ function civicrm_api3_report_template_get($params) { * @param array $params * * @return array - * of newly created option_value property values. + * Array of newly created option_value property values. * {@getfields OptionValue_create} * @access public */ diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 4b235c1914..df7bd1ef1e 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. + * Array 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. + * Array 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. + * Array of deleted values. * @access public */ function civicrm_api3_sms_provider_delete($params) { diff --git a/api/v3/Tag.php b/api/v3/Tag.php index c6c2d6c33e..92ef857b7f 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. + * Array of newly created tag property values. * {@getfields tag_create} * @access public */ diff --git a/api/v3/UFField.php b/api/v3/UFField.php index c6c53a0aab..696276367a 100644 --- a/api/v3/UFField.php +++ b/api/v3/UFField.php @@ -40,7 +40,7 @@ /** * Defines 'uf field' within a group. * - * @param $params + * @param array $params * Array Associative array of property name/value pairs to create new uf field. * * @throws API_Exception diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php index 490ac54bf4..ec5a081d84 100644 --- a/api/v3/UFGroup.php +++ b/api/v3/UFGroup.php @@ -38,7 +38,7 @@ */ /** - * Files required for this package + * @param array $params */ function _civicrm_api3_uf_group_create_spec(&$params) { $session = CRM_Core_Session::singleton(); @@ -51,7 +51,7 @@ function _civicrm_api3_uf_group_create_spec(&$params) { /** * Use this API to create a new group. See the CRM Data Model for uf_group property definitions * - * @param $params + * @param array $params * Array Associative array of property name/value pairs to insert in group. * * @return array diff --git a/api/v3/Website.php b/api/v3/Website.php index cd209119e6..af6a35eed4 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. + * Array of newly created website property values. * @access public * @todo convert to using basic create - BAO function non-std */ diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php index afa1334d16..a9ed8a65e4 100644 --- a/api/v3/WordReplacement.php +++ b/api/v3/WordReplacement.php @@ -81,7 +81,7 @@ function _civicrm_api3_word_replacement_create_spec(&$params) { * * @param array $params * Array containing id of the word_replacement. - * to be deleted + * to be deleted * * @return array * api result array diff --git a/api/v3/utils.php b/api/v3/utils.php index ef6aac769b..fbb1bf945a 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -286,8 +286,8 @@ function _civicrm_api3_load_DAO($entity) { * return the DAO of the function or Entity * @param string $name * Either a function of the api (civicrm_{entity}_create or the entity name. - * return the DAO name to manipulate this function - * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" + * return the DAO name to manipulate this function + * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" * @return mixed|string */ function _civicrm_api3_get_DAO($name) { @@ -354,8 +354,8 @@ function _civicrm_api3_get_DAO($name) { * return the DAO of the function or Entity * @param string $name * Is either a function of the api (civicrm_{entity}_create or the entity name. - * return the DAO name to manipulate this function - * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" + * return the DAO name to manipulate this function + * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact" * @return mixed */ function _civicrm_api3_get_BAO($name) { @@ -542,7 +542,8 @@ function _civicrm_api3_get_using_query_object($entity, $params, $additional_opti * @param array $params * @param string $mode * @param string $entity - * @return CRM_Core_DAO query object + * @return CRM_Core_DAO + * query object */ function _civicrm_api3_get_query_object($params, $mode, $entity) { $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get'); @@ -700,7 +701,7 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) { * Params array as passed into civicrm_api. * @param bool $queryObject * Is this supporting a queryobject api (e.g contact) - if so we support more options. - * for legacy report & return a unique fields array + * for legacy report & return a unique fields array * * @param string $entity * @param string $action @@ -1996,9 +1997,9 @@ function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldN * Returns the canonical name of a field * * @param $entity - * : api entity name (string should already be standardized - no camelCase). + * api entity name (string should already be standardized - no camelCase). * @param $fieldName - * : any variation of a field's name (name, unique_name, api.alias). + * any variation of a field's name (name, unique_name, api.alias). * * @return bool|string * fieldName or FALSE if the field does not exist diff --git a/tests/extensions/test.extension.manager.searchtest/main.php b/tests/extensions/test.extension.manager.searchtest/main.php index 0bcaa1afe1..ac956e1112 100644 --- a/tests/extensions/test.extension.manager.searchtest/main.php +++ b/tests/extensions/test.extension.manager.searchtest/main.php @@ -49,8 +49,8 @@ class test_extension_manager_searchtest extends CRM_Contact_Form_Search_Custom_B * Get a list of summary data points * * @return mixed; NULL or array with keys: - * - summary: string - * - total: numeric + * - summary: string + * - total: numeric */ function summary() { return NULL; diff --git a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php index 11cb0b0dd1..a762f5b3c7 100644 --- a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php +++ b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php @@ -850,11 +850,10 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase { /** * Run a series of cron jobs and make an assertion about email deliveries * - * @param $cronRuns - * - * @internal param array $jobSchedule specifying when to run cron and what messages to expect; each item is an array with keys: - * - time: string, e.g. '2012-06-15 21:00:01' - * - recipients: array(array(string)), list of email addresses which should receive messages + * @param array $cronRuns + * array specifying when to run cron and what messages to expect; each item is an array with keys: + * - time: string, e.g. '2012-06-15 21:00:01' + * - recipients: array(array(string)), list of email addresses which should receive messages */ public function assertCronRuns($cronRuns) { foreach ($cronRuns as $cronRun) { @@ -865,11 +864,6 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase { } } - //////////////////////////////// - //////////////////////////////// - //////////////////////////////// - //////////////////////////////// - /** * @var array(DAO_Name => array(int)) List of items to garbage-collect during tearDown */ diff --git a/tests/phpunit/CRM/Core/Permission/GenericTest.php b/tests/phpunit/CRM/Core/Permission/GenericTest.php index dd1efe2ba3..e36fb5ae6d 100644 --- a/tests/phpunit/CRM/Core/Permission/GenericTest.php +++ b/tests/phpunit/CRM/Core/Permission/GenericTest.php @@ -9,7 +9,7 @@ class CRM_Core_Permission_GenericTest extends CiviUnitTestCase { /** * @return array - * of CRM_Core_Permission_Base + * Array of CRM_Core_Permission_Base */ public function permissionClasses() { $cases = array(); diff --git a/tests/phpunit/Civi/API/Subscriber/DynamicFKAuthorizationTest.php b/tests/phpunit/Civi/API/Subscriber/DynamicFKAuthorizationTest.php index 53933117b7..124d08f0bb 100644 --- a/tests/phpunit/Civi/API/Subscriber/DynamicFKAuthorizationTest.php +++ b/tests/phpunit/Civi/API/Subscriber/DynamicFKAuthorizationTest.php @@ -168,7 +168,7 @@ class DynamicFKAuthorizationTest extends \CiviUnitTestCase { /** * @param $entity * @param $action - * @param $params + * @param array $params * @dataProvider okDataProvider */ public function testOk($entity, $action, $params) { @@ -187,7 +187,7 @@ class DynamicFKAuthorizationTest extends \CiviUnitTestCase { /** * @param $entity * @param $action - * @param $params + * @param array $params * @dataProvider badDataProvider */ public function testBad($entity, $action, $params, $expectedError) { diff --git a/tests/phpunit/CiviTest/AuthorizeNet.php b/tests/phpunit/CiviTest/AuthorizeNet.php index b8f9557693..e0c46fbca4 100644 --- a/tests/phpunit/CiviTest/AuthorizeNet.php +++ b/tests/phpunit/CiviTest/AuthorizeNet.php @@ -36,7 +36,7 @@ class AuthorizeNet extends PHPUnit_Framework_Testcase { * payment processor * @param int $id * Id of the PayPal Pro payment processor. - * to be deleted + * to be deleted * @return boolean * true if payment processor deleted, false otherwise */ diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index 87b40a937f..c8e8556c0d 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -120,13 +120,13 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { /** * @param array $cookies - * Each item is an array with keys:. - * - name: string - * - value: string; note that RFC's don't define particular encoding scheme, so + * Each item is an Array with keys: + * - name: string + * - value: string; note that RFC's don't define particular encoding scheme, so * you must pick one yourself and pre-encode; does not allow values with * commas, semicolons, or whitespace - * - path: string; default: '/' - * - max_age: int; default: 1 week (7*24*60*60) + * - path: string; default: '/' + * - max_age: int; default: 1 week (7*24*60*60) */ protected function setCookies($cookies) { foreach ($cookies as $cookie) { @@ -652,7 +652,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * Selector. * @param string $contactType * @return array - * of contact attributes (id, names, email) + * Array of contact attributes (id, names, email) */ public function createDialogContact($field = 'contact_id', $contactType = 'Individual') { $selectId = 's2id_' . $this->getAttribute($field . '@id'); @@ -2105,7 +2105,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * * @param array $customSets * Custom sets i.e entity wise sets want to be created and checked. - * e.g $customSets = array(array('entity' => 'Contribution', 'subEntity' => 'Donation', + * e.g $customSets = array(array('entity' => 'Contribution', 'subEntity' => 'Donation', * 'triggerElement' => $triggerElement)) * array $triggerElement: the element which is responsible for custom group to load * diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 12f4e98906..b57671daee 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -884,7 +884,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } /** - * This function exists to wrap api functions + * wrap api functions * so we can ensure they succeed & throw exceptions without litterering the test with checks * * @param string $entity @@ -929,12 +929,12 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array $params * @param string $type * Per http://php.net/manual/en/function.gettype.php possible types. - * - boolean - * - integer - * - double - * - string - * - array - * - object + * - boolean + * - integer + * - double + * - string + * - array + * - object * * @return array|int */ @@ -964,12 +964,12 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array $params * @param array $checkAgainst * Array to compare result against. - * - boolean - * - integer - * - double - * - string - * - array - * - object + * - boolean + * - integer + * - double + * - string + * - array + * - object * * @throws Exception * @return array|int @@ -1076,8 +1076,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Generic function to create Organisation, to be used in test cases * - * @param array parameters for civicrm_contact_add api function call - * @param int sequence number if creating multiple organizations + * @param array $params + * parameters for civicrm_contact_add api function call + * @param int $seq + * sequence number if creating multiple organizations * * @return int * id of Organisation created @@ -1093,8 +1095,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Generic function to create Individual, to be used in test cases * - * @param array parameters for civicrm_contact_add api function call - * @param int sequence number if creating multiple individuals + * @param array $params + * parameters for civicrm_contact_add api function call + * @param int $seq + * sequence number if creating multiple individuals * * @return int * id of Individual created @@ -1107,8 +1111,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Generic function to create Household, to be used in test cases * - * @param array parameters for civicrm_contact_add api function call - * @param int sequence number if creating multiple households + * @param array $params + * parameters for civicrm_contact_add api function call + * @param int $seq + * sequence number if creating multiple households * * @return int * id of Household created @@ -1121,8 +1127,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Helper function for getting sample contact properties * - * @param enum contact type: Individual, Organization - * @param int sequence number for the values of this type + * @param string $contact_type + * enum contact type: Individual, Organization + * @param int $seq + * sequence number for the values of this type * * @return array * properties of sample contact (ie. $params for API call) @@ -1406,8 +1414,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Create Payment Processor * - * @return object - * of Payment Processsor + * @return CRM_Financial_DAO_PaymentProcessor + * instance of Payment Processsor */ public function processorCreate() { $processorParams = array( @@ -1429,8 +1437,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Create contribution page * * @param array $params - * @return object - * of contribution page + * @return array + * Array of contribution page */ public function contributionPageCreate($params) { $this->_pageParams = array( @@ -1471,6 +1479,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @param int $tagId * Id of the tag to be deleted. + * + * @return int */ public function tagDelete($tagId) { require_once 'api/api.php'; @@ -1541,11 +1551,11 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Contact_id. * @param int $cTypeID * Id of financial type. - * * @param int $invoiceID * @param int $trxnID * @param int $paymentInstrumentID * @param bool $isFee + * * @return int * id of created contribution */ @@ -1580,9 +1590,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param array $params * @param int $financialType * Id of financial type. - * * @param int $invoiceID * @param int $trxnID + * * @return int * id of created contribution */ @@ -1764,7 +1774,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Add a Location Type * * @param array $params - * @return CRM_Core_DAO_LocationType location id of created location + * @return CRM_Core_DAO_LocationType + * location id of created location */ public function locationTypeCreate($params = NULL) { if ($params === NULL) { diff --git a/tests/phpunit/CiviTest/ContributionPage.php b/tests/phpunit/CiviTest/ContributionPage.php index c97d995bc0..a9b1f81a95 100644 --- a/tests/phpunit/CiviTest/ContributionPage.php +++ b/tests/phpunit/CiviTest/ContributionPage.php @@ -44,7 +44,7 @@ class ContributionPage extends PHPUnit_Framework_Testcase { * * @param int $contributionPageId * Id of the Contribution Page. - * to be deleted + * to be deleted * @return boolean * true if Contribution Page deleted, false otherwise */ diff --git a/tests/phpunit/CiviTest/PCP.php b/tests/phpunit/CiviTest/PCP.php index 93558d914f..e1ab14fea4 100644 --- a/tests/phpunit/CiviTest/PCP.php +++ b/tests/phpunit/CiviTest/PCP.php @@ -9,9 +9,9 @@ class PCPBlock extends PHPUnit_Framework_Testcase { * * @param int $contributionPageId * Id of the Contribution Page. - * to be deleted + * to be deleted * @return array - * of created pcp block + * Array of created pcp block */ public function create($contributionPageId) { $profileParams = array( diff --git a/tests/phpunit/CiviTest/PaypalPro.php b/tests/phpunit/CiviTest/PaypalPro.php index b150a26edd..1a9ce0a411 100644 --- a/tests/phpunit/CiviTest/PaypalPro.php +++ b/tests/phpunit/CiviTest/PaypalPro.php @@ -44,7 +44,7 @@ class PaypalPro extends PHPUnit_Framework_Testcase { * payment processor * @param int $id * Id of the PayPal Pro payment processor. - * to be deleted + * to be deleted * @return boolean * true if payment processor deleted, false otherwise */ diff --git a/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php b/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php index 9e27ca27ba..a24ef13051 100644 --- a/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/UpdatePendingContributionTest.php @@ -75,7 +75,7 @@ class WebTest_Contribute_UpdatePendingContributionTest extends CiviSeleniumTestC /** * @return array - * of contact details + * Array of contact details */ public function _testOfflineContribution() { // Create a contact to be used as soft creditor diff --git a/tests/phpunit/api/v3/ContributionPageTest.php b/tests/phpunit/api/v3/ContributionPageTest.php index edc3642002..11692b6931 100644 --- a/tests/phpunit/api/v3/ContributionPageTest.php +++ b/tests/phpunit/api/v3/ContributionPageTest.php @@ -51,10 +51,10 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase { /** * @var array - * - contribution_page - * - price_set - * - price_field - * - price_field_value + * - contribution_page + * - price_set + * - price_field + * - price_field_value */ protected $_ids = array(); -- 2.25.1