From 014c401480a8cd183dde0da723d792b8b6f5ac68 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Contribute - Convert single-line @param to multi-line --- CRM/Contribute/BAO/Contribution.php | 158 ++++++++++++------ CRM/Contribute/BAO/Contribution/Utils.php | 27 ++- CRM/Contribute/BAO/ContributionPage.php | 66 +++++--- CRM/Contribute/BAO/ContributionRecur.php | 24 ++- CRM/Contribute/BAO/ContributionSoft.php | 20 ++- CRM/Contribute/BAO/ManagePremiums.php | 18 +- CRM/Contribute/BAO/Premium.php | 12 +- CRM/Contribute/BAO/Query.php | 15 +- CRM/Contribute/Form/AbstractEditPayment.php | 9 +- CRM/Contribute/Form/AdditionalInfo.php | 3 +- CRM/Contribute/Form/Contribution.php | 9 +- CRM/Contribute/Form/Contribution/Confirm.php | 34 ++-- CRM/Contribute/Form/Contribution/Main.php | 6 +- .../Form/ContributionPage/Amount.php | 6 +- .../Form/ContributionPage/Custom.php | 3 +- .../Form/ContributionPage/Premium.php | 3 +- .../Form/ContributionPage/Settings.php | 3 +- .../Form/ContributionPage/ThankYou.php | 9 +- .../Form/ContributionPage/Widget.php | 3 +- CRM/Contribute/Form/ManagePremiums.php | 3 +- CRM/Contribute/Form/SoftCredit.php | 3 +- CRM/Contribute/Form/Task.php | 6 +- CRM/Contribute/Form/Task/Invoice.php | 27 ++- CRM/Contribute/Form/Task/PDF.php | 9 +- CRM/Contribute/Form/Task/PDFLetterCommon.php | 10 +- CRM/Contribute/Form/Task/PickProfile.php | 3 +- CRM/Contribute/Form/Task/Status.php | 3 +- CRM/Contribute/Form/UpdateBilling.php | 6 +- CRM/Contribute/Import/Form/MapField.php | 3 +- CRM/Contribute/Import/Parser.php | 6 +- CRM/Contribute/Import/Parser/Contribution.php | 15 +- CRM/Contribute/PseudoConstant.php | 6 +- CRM/Contribute/Selector/Search.php | 36 ++-- CRM/Contribute/StateMachine/Search.php | 3 +- 34 files changed, 372 insertions(+), 195 deletions(-) diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 9b90b51fb1..f7e99576d7 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -88,8 +88,10 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * contribution object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $ids + * The array that holds all the db ids. * * @return CRM_Contribute_BAO_Contribution object * @static @@ -217,9 +219,12 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object - * @param array $ids the array that holds all the db ids + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. + * @param array $ids + * The array that holds all the db ids. * * @return CRM_Contribute_BAO_Contribution|null the found object or null * @static @@ -288,8 +293,10 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { /** * Takes an associative array and creates a contribution object * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $ids + * The array that holds all the db ids. * * @return CRM_Contribute_BAO_Contribution object * @static @@ -476,8 +483,10 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { /** * Get the values for pseudoconstants for name->value and reverse. * - * @param array $defaults (reference) the default values, some of which need to be resolved. - * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name) + * @param array $defaults + * (reference) the default values, some of which need to be resolved. + * @param bool $reverse + * True if we want to resolve the values in the reverse direction (value -> name). * * @return void * @static @@ -524,10 +533,13 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * full featured over a period of time. This is the inverse function of * create. It also stores all the retrieved values in the default array * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the name / value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the name / value pairs. * in a hierarchical manner - * @param array $ids (reference) the array that holds all the db ids + * @param array $ids + * (reference) the array that holds all the db ids. * * @return CRM_Contribute_BAO_Contribution object * @static @@ -826,8 +838,10 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta /** * Check if there is a contribution with the same trxn_id or invoice_id * - * @param array $input an assoc array of name/value pairs - * @param array $duplicates (reference ) store ids of duplicate contribs + * @param array $input + * An assoc array of name/value pairs. + * @param array $duplicates + * (reference ) store ids of duplicate contribs. * * @param int $id * @@ -881,7 +895,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * contribution_product object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contribute_BAO_ContributionProduct object * @static @@ -897,7 +912,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * For now we only allow custom contribution fields to be in * profile * - * @param boolean $addExtraFields true if special fields needs to be added + * @param bool $addExtraFields + * True if special fields needs to be added. * * @return array the list of contribution fields * @static @@ -993,7 +1009,8 @@ GROUP BY p.id /** * Get list of contribution In Honor of contact Ids * - * @param int $honorId In Honor of Contact ID + * @param int $honorId + * In Honor of Contact ID. * * @return return the list of contribution fields * @@ -1030,7 +1047,8 @@ GROUP BY p.id /** * Get the sort name of a contact for a particular contribution * - * @param int $id id of the contribution + * @param int $id + * Id of the contribution. * * @return null|string sort name of the contact if found * @static @@ -1129,7 +1147,8 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id * Check if there is a contribution with the params passed in. * Used for trxn_id,invoice_id and contribution_id * - * @param array $params an assoc array of name/value pairs + * @param array $params + * An assoc array of name/value pairs. * * @return array contribution id if success else NULL * static @@ -1158,8 +1177,10 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id /** * Get the contribution details for component export * - * @param int $exportMode export mode - * @param string $componentIds component ids + * @param int $exportMode + * Export mode. + * @param string $componentIds + * Component ids. * * @return array associated array * @@ -1221,7 +1242,8 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont /** * Create address associated with contribution record. * - * @param array $params an associated array + * @param array $params + * An associated array. * @param int $billingLocationTypeID * * @return address id @@ -1301,8 +1323,10 @@ WHERE $condition * This function check online pending contribution associated w/ * Online Event Registration or Online Membership signup. * - * @param int $componentId participant/membership id. - * @param string $componentName Event/Membership. + * @param int $componentId + * Participant/membership id. + * @param string $componentName + * Event/Membership. * * @return $contributionId pending contribution id. * @static @@ -1796,8 +1820,10 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ /** * Get individual id for onbehalf contribution * - * @param int $contributionId contribution id - * @param int $contributorId contributor id + * @param int $contributionId + * Contribution id. + * @param int $contributorId + * Contributor id. * * @return array $ids containing organization id and individual id */ @@ -1905,10 +1931,14 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac * In the first instance we are just moving functionality from BASEIpn - * see http://issues.civicrm.org/jira/browse/CRM-9996 * - * @param array $input Input as delivered from Payment Processor - * @param array $ids Ids as Loaded by Payment Processor - * @param boolean $required Is Payment processor / contribution page required - * @param boolean $loadAll - load all related objects - even where id not passed in? (allows API to call this) + * @param array $input + * Input as delivered from Payment Processor. + * @param array $ids + * Ids as Loaded by Payment Processor. + * @param bool $required + * 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 */ /** @@ -2078,14 +2108,18 @@ WHERE contribution_id = %1 "; /* * Create array of message information - ie. return html version, txt version, to field * - * @param array $input incoming information + * @param array $input + * Incoming information. * - 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 IDs of related objects - * @param array $values any values that may have already been compiled by calling process + * @param array $ids + * IDs of related objects. + * @param array $values + * Any values that may have already been compiled by calling process. * This is augmented by values 'gathered' by gatherMessageValues - * @param bool $returnMessageText distinguishes between whether to send message or return + * @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 $messageArray - messages @@ -2225,8 +2259,10 @@ WHERE contribution_id = %1 "; * 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 $ids the set of ids related to the inpurt + * @param array $input + * Input into function (probably from payment processor). + * @param array $ids + * The set of ids related to the inpurt. * * @return array $values * @@ -2349,7 +2385,8 @@ WHERE contribution_id = %1 "; * * @param $values * @param $input - * @param $template CRM_Core_SMARTY + * @param $template + * CRM_Core_SMARTY. * @param bool $recur * @param bool $returnMessageText * @@ -2535,7 +2572,8 @@ WHERE contribution_id = %1 "; * Check whether payment processor supports * cancellation of contribution subscription * - * @param int $contributionId contribution id + * @param int $contributionId + * Contribution id. * * @param bool $isNotCancelled * @@ -2567,7 +2605,8 @@ WHERE contribution_id = %1 "; /** * Check whether subscription is already cancelled * - * @param int $contributionId contribution id + * @param int $contributionId + * Contribution id. * * @return string $status contribution status * @static @@ -2590,7 +2629,8 @@ WHERE contribution_id = %1 "; /** * Create all financial accounts entry * - * @param array $params contribution object, line item array and params for trxn + * @param array $params + * Contribution object, line item array and params for trxn. * * * @param array $financialTrxnValues @@ -2876,9 +2916,11 @@ WHERE contribution_id = %1 "; /** * Update all financial accounts entry * - * @param array $params contribution object, line item array and params for trxn + * @param array $params + * Contribution object, line item array and params for trxn. * - * @param string $context update scenarios + * @param string $context + * Update scenarios. * * @param null $skipTrxn * @@ -3042,11 +3084,14 @@ WHERE contribution_id = %1 "; /** * Check status validation on update of a contribution * - * @param array $values previous form values before submit + * @param array $values + * Previous form values before submit. * - * @param array $fields the input form values + * @param array $fields + * The input form values. * - * @param array $errors list of errors + * @param array $errors + * List of errors. * * @return bool * @static @@ -3077,7 +3122,8 @@ WHERE contribution_id = %1 "; * * CRM-12155 * - * @param integer $contactId contact id + * @param int $contactId + * Contact id. * * @static */ @@ -3094,9 +3140,11 @@ WHERE contribution_id = %1 "; * Get options for a given contribution field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context : @see CRM_Core_DAO::buildOptionsContext - * @param Array $props : whatever is known about this dao object + * @param string $fieldName + * @param string $context + * : @see CRM_Core_DAO::buildOptionsContext. + * @param array $props + * : whatever is known about this dao object. * * @return Array|bool */ @@ -3132,7 +3180,8 @@ WHERE contribution_id = %1 "; * * CRM-13231 * - * @param integer $financialTypeId Financial Type id + * @param int $financialTypeId + * Financial Type id. * * @param string $relationName * @@ -3153,9 +3202,12 @@ WHERE contribution_id = %1 "; /* * Function to record additional payment for partial and refund contributions * - * @param integer $contributionId : is the invoice contribution id (got created after processing participant payment) - * @param array $trxnData : 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 + * @param int $contributionId + * : is the invoice contribution id (got created after processing participant payment). + * @param array $trxnData + * : 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. */ /** * @param int $contributionId diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index 36fce7a8c0..1595e684b7 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -37,15 +37,21 @@ class CRM_Contribute_BAO_Contribution_Utils { /** * Process payment after confirmation * - * @param CRM_Core_Form $form form object - * @param array $paymentParams array with payment related key + * @param CRM_Core_Form $form + * Form object. + * @param array $paymentParams + * Array with payment related key. * value pairs - * @param array $premiumParams array with premium related key + * @param array $premiumParams + * Array with premium related key. * value pairs - * @param int $contactID contact id - * @param int $contributionTypeId financial type id + * @param int $contactID + * Contact id. + * @param int $contributionTypeId + * Financial type id. * @param int|string $component component id - * @param array $fieldTypes presumably relates to custom field types - used when building data for sendMail + * @param array $fieldTypes + * Presumably relates to custom field types - used when building data for sendMail. * @param $isTest * @param $isPayLater * @@ -371,7 +377,8 @@ class CRM_Contribute_BAO_Contribution_Utils { * Get the contribution details by month * of the year * - * @param int $param year + * @param int $param + * Year. * * @return array associated array * @@ -880,8 +887,10 @@ LIMIT 1 /** * Calculate the tax amount based on given tax rate. * - * @param float $amount amount of field. - * @param float $taxRate tax rate of selected financial account for field. + * @param float $amount + * Amount of field. + * @param float $taxRate + * Tax rate of selected financial account for field. * * @return array array of tax amount * diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index 2cb13c00a7..58212b82ba 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -41,7 +41,8 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Takes an associative array and creates a contribution page object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contribute_DAO_ContributionPage object * @static @@ -66,8 +67,10 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on success, null otherwise * @static @@ -110,10 +113,14 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Send the emails * - * @param int $contactID contact id - * @param array $values associated array of fields - * @param boolean $isTest if in test mode - * @param boolean $returnMessageText return the message text instead of sending the mail + * @param int $contactID + * Contact id. + * @param array $values + * Associated array of fields. + * @param bool $isTest + * If in test mode. + * @param bool $returnMessageText + * Return the message text instead of sending the mail. * * @param null $fieldTypes * @@ -456,10 +463,14 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Send the emails for Recurring Contribution Notication * - * @param string $type txnType - * @param int $contactID contact id for contributor - * @param int $pageID contribution page id - * @param object $recur object of recurring contribution table + * @param string $type + * TxnType. + * @param int $contactID + * Contact id for contributor. + * @param int $pageID + * Contribution page id. + * @param object $recur + * Object of recurring contribution table. * @param bool|object $autoRenewMembership is it a auto renew membership. * * @return void @@ -553,11 +564,14 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Add the custom fields for contribution page (ie profile) * - * @param int $gid uf group id + * @param int $gid + * Uf group id. * @param string $name - * @param int $cid contact id + * @param int $cid + * Contact id. * @param $template - * @param array $params params to build component whereclause + * @param array $params + * Params to build component whereclause. * * @param null $fieldTypes * @@ -605,7 +619,8 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio * This function is to make a copy of a contribution page, including * all the blocks in the page * - * @param int $id the contribution page id to copy + * @param int $id + * The contribution page id to copy. * * @return the copy object * @static @@ -699,7 +714,8 @@ WHERE entity_table = 'civicrm_contribution_page' * Check if contribution page contains payment * processor that supports recurring payment * - * @param int $contributionPageId Contribution Page Id + * @param int $contributionPageId + * Contribution Page Id. * * @return boolean true if payment processor supports recurring * else false @@ -798,9 +814,9 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm * Get options for a given field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param string $fieldName + * @param string $context: @see CRM_Core_DAO::buildOptionsContext + * @param array $props: whatever is known about this dao object * * @return array|bool */ @@ -819,8 +835,8 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm /** * Get or Set multilingually affected honor params for processing module_data or setting default values. * - * @param Array|String $params: Array when we need to format it according to language state or String as a json encode - * @param Boolean $setDefault: If yes then returns array to used for setting default value afterward + * @param array|String $params: Array when we need to format it according to language state or String as a json encode + * @param bool $setDefault: If yes then returns array to used for setting default value afterward * * @return array|string */ @@ -892,8 +908,10 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm /** * Generate html for pdf in confirmation receipt email attachment - * @param int $contributionId Contribution Page Id - * @param int $userID contact id for contributor + * @param int $contributionId + * Contribution Page Id. + * @param int $userID + * Contact id for contributor. * @return array $pdfHtml */ public static function addInvoicePdfToEmail($contributionId, $userID) { @@ -910,7 +928,7 @@ LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm /** * Helper to determine if the page supports separate membership payments - * @param integer id form id + * @param int id form id * * @return bool isSeparateMembershipPayment */ diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index fed004ad8e..4d0e12f272 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -37,7 +37,8 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi /** * Create recurring contribution * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object activity contact object * @@ -53,7 +54,8 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi * contribution object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contribute_BAO_Contribution object * @static @@ -105,8 +107,10 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi /** * Check if there is a recurring contribution with the same trxn_id or invoice_id * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $duplicates (reference ) store ids of duplicate contribs + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $duplicates + * (reference ) store ids of duplicate contribs. * * @return boolean true if duplicate, false otherwise * static @@ -175,7 +179,8 @@ SELECT r.payment_processor_id /** * Get the number of installment done/completed for each recurring contribution * - * @param array $ids (reference ) an array of recurring contribution ids + * @param array $ids + * (reference ) an array of recurring contribution ids. * * @return array $totalCount an array of recurring ids count * static @@ -222,8 +227,10 @@ SELECT r.payment_processor_id /** * Cancel Recurring contribution. * - * @param integer $recurId recur contribution id. - * @param array $objects an array of objects that is to be cancelled like + * @param int $recurId + * Recur contribution id. + * @param array $objects + * An array of objects that is to be cancelled like. * contribution, membership, event. At least contribution object is a must. * * @param array $activityParams @@ -319,7 +326,8 @@ SELECT r.payment_processor_id /** * Get list of recurring contribution of contact Ids * - * @param int $contactId Contact ID + * @param int $contactId + * Contact ID. * * @return array list of recurring contribution fields * diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index 053ad18b3a..3e9fab2164 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -44,7 +44,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Add contribution soft credit record * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object soft contribution of object that is added * @@ -64,8 +65,10 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contribute_BAO_ContributionSoft object * @static @@ -141,7 +144,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio * Retrieve soft contributions for contribution record. * * @param int $contributionID - * @param boolean $all include PCP data + * @param bool $all + * Include PCP data. * * @return array of soft contribution ids, amounts, and associated contact ids * @static @@ -231,9 +235,11 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio /** * Function to retrieve the list of soft contributions for given contact. * - * @param int $contact_id contact id - * @param int $isTest - * @param string $filter additional filter criteria, later used in where clause + * @param int $contact_id + * Contact id. + * @param int $isTest + * @param string $filter + * Additional filter criteria, later used in where clause. * * @return array * @static diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 7d6c7ce86d..990ac820a8 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -49,8 +49,10 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contribute_BAO_ManagePremium object * @static @@ -69,8 +71,10 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -87,8 +91,10 @@ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { /** * add the financial types * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 0dbb04851d..e2e5d837ea 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -51,8 +51,10 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contribute_BAO_ManagePremium object * @static @@ -70,8 +72,10 @@ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index 5df96403ac..80c9c9e803 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -1128,11 +1128,16 @@ class CRM_Contribute_BAO_Query { /** * Add the where for dates * - * @param array $values array of query values - * @param object $query the query object - * @param string $name query field that is set - * @param string $field name of field to be set - * @param string $title title of the field + * @param array $values + * Array of query values. + * @param object $query + * The query object. + * @param string $name + * Query field that is set. + * @param string $field + * Name of field to be set. + * @param string $title + * Title of the field. * * @return bool */ diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 9164234e80..9fbe5bbd88 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -238,7 +238,8 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { } /** - * @param string $type eg 'Contribution' + * @param string $type + * Eg 'Contribution'. * @param string $subType * @param int $entityId */ @@ -275,9 +276,9 @@ WHERE contribution_id = {$id} /** * This function process contribution related objects. * - * @param integer $contributionId - * @param integer $statusId - * @param integer|null $previousStatusId + * @param int $contributionId + * @param int $statusId + * @param int|null $previousStatusId * * @return null|string */ diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index c9ea411012..b2cfb7da5b 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -333,7 +333,8 @@ class CRM_Contribute_Form_AdditionalInfo { * @form object of Contribution form. * * @param CRM_Core_Form $form - * @param array $params (reference ) an assoc array of name/value pairs. + * @param array $params + * (reference ) an assoc array of name/value pairs. * @$ccContribution boolen, is it credit card contribution. * @param bool $ccContribution * diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 57b4e4f67a..c0b17546c3 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -929,8 +929,10 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * @@ -1507,7 +1509,8 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP /** * @param $submittedValues * @param $config - * @param $session CRM_Core_Session + * @param $session + * CRM_Core_Session. * @param $lineItem * * @throws CRM_Core_Exception diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index f44d42ce95..7519e69342 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -57,7 +57,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * Set the parameters to be passed to contribution create function * * @param array $params - * @param integer $contactID + * @param int $contactID * @param int $financialTypeID * @param $online * @param int $contributionPageId @@ -1184,7 +1184,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * @param CRM_Core_Form $form * @param array $params * @param array $result - * @param integer $contactID + * @param int $contactID * @param CRM_Financial_DAO_FinancialType $financialType * @param bool $pending * @param bool $online @@ -1507,7 +1507,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * * @param CRM_Core_Form $form * @param array $params - * @param integer $contactID + * @param int $contactID * @param string $contributionType * @param bool $online * @@ -1593,11 +1593,14 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * Add on behalf of organization and it's location * - * @param $behalfOrganization array array of organization info - * @param $contactID int individual contact id. One + * @param $behalfOrganization + * Array array of organization info. + * @param $contactID + * Int individual contact id. One. * who is doing the process of signup / contribution. * - * @param $values array form values array + * @param $values + * Array form values array. * @param array $params * @param null $fields * @@ -1703,8 +1706,10 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * Function used to save pcp / soft credit entry * This is used by contribution and also event pcps * - * @param array $params associated array - * @param object $contribution contribution object + * @param array $params + * Associated array. + * @param object $contribution + * Contribution object. * * @static */ @@ -1735,8 +1740,10 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * Function used to se pcp related defaults / params * This is used by contribution and also event pcps * - * @param CRM_Core_Form $page form object - * @param array $params associated array + * @param CRM_Core_Form $page + * Form object. + * @param array $params + * Associated array. * * @return array * @static @@ -1767,11 +1774,12 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * @param array $membershipParams - * @param integer $contactID + * @param int $contactID * @param array $customFieldsFormatted * @param array $fieldTypes * @param array $premiumParams - * @param array $membershipLineItems line items specifically relating to memberships + * @param array $membershipLineItems + * Line items specifically relating to memberships. * @param $isPayLater */ public function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems, $isPayLater) { @@ -1817,7 +1825,7 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr * transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferPayment style) * * - * @param integer $formID + * @param int $formID * @param bool $amountBlockActiveOnForm * * @return bool diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index 48085c0093..5bdaa227b6 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -720,8 +720,10 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index c4ca9dc14f..76d74b36c4 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -271,8 +271,10 @@ SELECT id /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 5909fbcf0f..a89c32cd30 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -160,7 +160,8 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co /** * Global form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * * @param $files * @param int $contributionPageId diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index cc1022f0cd..d057483c7a 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -111,7 +111,8 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @return mixed true or array of errors * @static diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index fb174ee3c0..630a90bdd5 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -213,7 +213,8 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ /** * Global validation rules for the form * - * @param array $values posted values of the form + * @param array $values + * Posted values of the form. * * @param $files * @param $self diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index 3b64cadabd..5e0204c1b1 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -92,9 +92,12 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. + * @param array $options + * Additional user data. * * @return true if no errors, else array of errors * @static diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index ec2e2d8ed6..bff6ddcd4f 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -207,7 +207,8 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * @param $self diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 6c2ef7c4dc..a764bc62d0 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -204,7 +204,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { /** * Function for validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index cd87120ed2..e252cb9290 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -192,7 +192,8 @@ class CRM_Contribute_Form_SoftCredit { /** * Global form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * * @param $errors * @param $self diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index 117a00c2d7..4d2108d75f 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -199,8 +199,10 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { * Simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * - * @param string $title title of the main button - * @param string $nextType button type for the form after processing + * @param string $title + * Title of the main button. + * @param string $nextType + * Button type for the form after processing. * @param string $backType * @param bool $submitOnce * diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 4b1fde72a4..90d2c0ab12 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -239,10 +239,14 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * process the PDf and email with activity and attachment * on click of Print Invoices * - * @param array $contribIDs Contribution Id - * @param array $params associated array of submitted values - * @param array $contactIds Contact Id - * @param CRM_Core_Form $form form object + * @param array $contribIDs + * Contribution Id. + * @param array $params + * Associated array of submitted values. + * @param array $contactIds + * Contact Id. + * @param CRM_Core_Form $form + * Form object. * @static * */ @@ -578,10 +582,14 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * This function is use for adding activity for * Email Invoice and the PDF Invoice * - * @param string $subject Activity subject - * @param array $contactIds Contact Id - * @param string $fileName gives the location with name of the file - * @param array $params for invoices + * @param string $subject + * Activity subject. + * @param array $contactIds + * Contact Id. + * @param string $fileName + * Gives the location with name of the file. + * @param array $params + * For invoices. * * @static */ @@ -625,7 +633,8 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * This function is use for creating the Invoice file in upload folder * for attachment * - * @param $html content for pdf in html format + * @param $html + * Content for pdf in html format. * * return $fileName of file which is in pdf format * diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index a7b626f170..db37118246 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -237,9 +237,12 @@ AND {$this->_componentClause}"; * Declaration of common variables for Invoice and PDF * * - * @param array $contribIds Contribution Id - * @param array $params parameter for pdf or email invoices - * @param array $contactIds Contact Id + * @param array $contribIds + * Contribution Id. + * @param array $params + * Parameter for pdf or email invoices. + * @param array $contactIds + * Contact Id. * * @return array array of common elements * diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index 74950e7393..624ff8b29d 100644 --- a/CRM/Contribute/Form/Task/PDFLetterCommon.php +++ b/CRM/Contribute/Form/Task/PDFLetterCommon.php @@ -177,8 +177,10 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF * @param array $contribution * @param array $messageToken * @param array $categories - * @param bool $grouped Does this letter represent more than one contribution - * @param string $separator What is the preferred letter separator + * @param bool $grouped + * Does this letter represent more than one contribution. + * @param string $separator + * What is the preferred letter separator. * @return string */ private static function resolveTokens($html_message, $contact, $contribution, $messageToken, $categories, $grouped, $separator) { @@ -207,8 +209,8 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF * @param string $groupBy * @param CRM_Contribute_Form_Task $form * @param array $returnProperties - * @param boolean $skipOnHold - * @param boolean $skipDeceased + * @param bool $skipOnHold + * @param bool $skipDeceased * @param array $messageToken * @param string $task * @param string $separator diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 7c445c92ba..9294417d0f 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -121,7 +121,8 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @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/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index 27ee307755..d6c68770a1 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -183,7 +183,8 @@ AND co.id IN ( $contribIDs )"; /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @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/Contribute/Form/UpdateBilling.php b/CRM/Contribute/Form/UpdateBilling.php index 503c40f776..07b8d5b3f4 100644 --- a/CRM/Contribute/Form/UpdateBilling.php +++ b/CRM/Contribute/Form/UpdateBilling.php @@ -214,8 +214,10 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index 59853055f2..c4d92a95fc 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -337,7 +337,8 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @param $files * @param $self diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index d7deb54ea1..a1b2e32fa6 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -599,7 +599,8 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { /** * Determines the file extension based on error code * - * @param int $type error code constant + * @param int $type + * Error code constant. * * @return string */ @@ -632,7 +633,8 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { /** * Determines the file name based on error code * - * @param int $type error code constant + * @param int $type + * Error code constant. * * @return string */ diff --git a/CRM/Contribute/Import/Parser/Contribution.php b/CRM/Contribute/Import/Parser/Contribution.php index b7c728cf9a..73b1823701 100644 --- a/CRM/Contribute/Import/Parser/Contribution.php +++ b/CRM/Contribute/Import/Parser/Contribution.php @@ -137,7 +137,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa /** * Handle the values in mapField mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean */ @@ -148,7 +149,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa /** * Handle the values in preview mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -159,7 +161,8 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa /** * Handle the values in summary mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -234,8 +237,10 @@ class CRM_Contribute_Import_Parser_Contribution extends CRM_Contribute_Import_Pa /** * Handle the values in import mode * - * @param int $onDuplicate the code for what action to take on duplicates - * @param array $values the array of values belonging to this line + * @param int $onDuplicate + * The code for what action to take on duplicates. + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index 47a3cb917d..d75461b928 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -202,8 +202,10 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * Get all the contribution pages * - * @param integer $id id of the contribution page - * @param boolean $all do we want all pages or only active pages + * @param int $id + * Id of the contribution page. + * @param bool $all + * Do we want all pages or only active pages. * * * @return array - array reference of all contribution pages if any diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index 153963e8a5..28728157d1 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -151,11 +151,15 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C /** * Class constructor * - * @param array $queryParams array of parameters for query + * @param array $queryParams + * Array of parameters for query. * @param \const|int $action - action of search basic or advanced. - * @param string $contributionClause if the caller wants to further restrict the search (used in contributions) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many contributions do we want returned + * @param string $contributionClause + * If the caller wants to further restrict the search (used in contributions). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many contributions do we want returned. * * @param string $context * @param null $compContext @@ -294,11 +298,16 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -429,8 +438,10 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -546,7 +557,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Contribute/StateMachine/Search.php b/CRM/Contribute/StateMachine/Search.php index 39f570dc05..4fda2d74b0 100644 --- a/CRM/Contribute/StateMachine/Search.php +++ b/CRM/Contribute/StateMachine/Search.php @@ -72,7 +72,8 @@ class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine { * to avoid using conditional state machine, much more efficient * and simpler * - * @param CRM_Core_Controller $controller the controller object + * @param CRM_Core_Controller $controller + * The controller object. * * @param string $formName * -- 2.25.1