From ed5dd492643be5788ca3bb203a73f6278ec2ef9a Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:08 -0800 Subject: [PATCH] INFRA-132 - CRM/Financial - Convert single-line @param to multi-line --- CRM/Financial/BAO/FinancialAccount.php | 24 ++++++++----- CRM/Financial/BAO/FinancialItem.php | 38 ++++++++++++++------- CRM/Financial/BAO/FinancialType.php | 18 ++++++---- CRM/Financial/BAO/FinancialTypeAccount.php | 18 ++++++---- CRM/Financial/BAO/PaymentProcessor.php | 33 ++++++++++++------ CRM/Financial/BAO/PaymentProcessorType.php | 18 ++++++---- CRM/Financial/Page/FinancialTypeAccount.php | 3 +- 7 files changed, 101 insertions(+), 51 deletions(-) diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php index 9a163c5c03..7b550766ea 100644 --- a/CRM/Financial/BAO/FinancialAccount.php +++ b/CRM/Financial/BAO/FinancialAccount.php @@ -51,8 +51,10 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco /** * 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_FinancialAccount object * @static @@ -70,8 +72,10 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco /** * 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 @@ -83,8 +87,10 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco /** * 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 * @return object @@ -177,9 +183,11 @@ WHERE cft.id = %1 /** * Get AR account * - * @param $financialAccountId financial account id + * @param $financialAccountId + * Financial account id. * - * @param $financialAccountTypeId financial account type id + * @param $financialAccountTypeId + * Financial account type id. * * @param \account|string $accountTypeCode account type code * diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index a96409be46..1c1df72439 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -45,8 +45,10 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * 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_FinancialItem object * @static @@ -64,9 +66,11 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * Add the financial items and financial trxn * - * @param object $lineItem line item object - * @param object $contribution contribution object - * @param boolean $taxTrxnID + * @param object $lineItem + * Line item object. + * @param object $contribution + * Contribution object. + * @param bool $taxTrxnID * * @static * @return void @@ -127,9 +131,12 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * Create the financial Items and financial enity trxn * - * @param array $params associated array to create financial items - * @param array $ids financial item ids - * @param array $trxnIds financial item ids + * @param array $params + * Associated array to create financial items. + * @param array $ids + * Financial item ids. + * @param array $trxnIds + * Financial item ids. * * @static * @return object @@ -177,7 +184,8 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * Takes an associative array and creates a entity financial transaction 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_Core_BAO_FinancialTrxn object * @static @@ -192,8 +200,10 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** * Retrive entity financial trxn details * - * @param array $params (reference ) an assoc array of name/value pairs - * @param bool $maxId to retrive max id + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param bool $maxId + * To retrive max id. * * @return array * @static @@ -229,9 +239,11 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * * CRM-12929 * - * @param array $contactIds an array contact id's + * @param array $contactIds + * An array contact id's. * - * @param array $error error to display + * @param array $error + * Error to display. * * @return array * @static diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index c86c7a2854..061e3b3ae3 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -51,8 +51,10 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { /** * 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_ContributionType object * @static @@ -70,8 +72,10 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { /** * 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 @@ -83,8 +87,10 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { /** * 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 * @return object diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 9001f6635f..d6f9faa0c1 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -52,8 +52,10 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin /** * 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. * * @param array $allValues * @@ -74,8 +76,10 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin /** * 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 * @return object @@ -162,7 +166,8 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin * * @param string $entityTable * - * @param string $columnName Column to fetch + * @param string $columnName + * Column to fetch. * * @return null|string * @static @@ -186,7 +191,8 @@ AND entity_id = %2"; /** * Financial Account for payment instrument * - * @param int $paymentInstrumentValue payment instrument value + * @param int $paymentInstrumentValue + * Payment instrument value. * * @return array|null|string * @static diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index c606efb868..1d33f68f3f 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -46,7 +46,8 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Create Payment Processor * - * @param array $params parameters for Processor entity + * @param array $params + * Parameters for Processor entity. * * @return CRM_Financial_DAO_PaymentProcessor * @throws Exception @@ -96,8 +97,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * retrieves the relevant objects. 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 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_Financial_DAO_PaymentProcessor object on success, null otherwise * @static @@ -115,8 +118,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * 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 * @@ -174,8 +179,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Get the payment processor details * - * @param int $paymentProcessorID payment processor id - * @param string $mode payment mode ie test or live + * @param int $paymentProcessorID + * Payment processor id. + * @param string $mode + * Payment mode ie test or live. * * @return array associated array with payment processor related fields * @static @@ -248,8 +255,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Build payment processor details * - * @param object $dao payment processor object - * @param string $mode payment mode ie test or live + * @param object $dao + * Payment processor object. + * @param string $mode + * Payment mode ie test or live. * * @return array associated array with payment processor related fields * @static @@ -382,8 +391,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * Retrieve payment processor id / info/ object based on component-id. * * @param int $entityID - * @param string $component component - * @param string $type type of payment information to be retrieved + * @param string $component + * Component. + * @param string $type + * Type of payment information to be retrieved. * * @return int / array / object based on type * @static diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index cae630b5db..1335d0be69 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -49,8 +49,10 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr /** * 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_Core_BAO_LocaationType object on success, null otherwise * @static @@ -68,8 +70,10 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr /** * 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 * @@ -100,7 +104,8 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr /** * Add the payment-processor type in the db * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @throws Exception * @return CRM_Financial_DAO_PaymentProcessorType @@ -168,7 +173,8 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr /** * Delete payment processor * - * @param int $paymentProcessorTypeId ID of the processor to be deleted. + * @param int $paymentProcessorTypeId + * ID of the processor to be deleted. * * @return bool * @static diff --git a/CRM/Financial/Page/FinancialTypeAccount.php b/CRM/Financial/Page/FinancialTypeAccount.php index a3d265bc4b..aa90c652c8 100644 --- a/CRM/Financial/Page/FinancialTypeAccount.php +++ b/CRM/Financial/Page/FinancialTypeAccount.php @@ -200,7 +200,8 @@ class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page { * editing would involved modifying existing financial Account Type + adding data * to new financial Account Type. * - * @param string $action the action to be invoked + * @param string $action + * The action to be invoked. * * @return void */ -- 2.25.1