From 3a1617b6ee3a2a02db5d74e3ccded3f8892e6e9a Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:09 -0800 Subject: [PATCH] INFRA-132 - CRM/Pledge - Convert single-line @param to multi-line --- CRM/Pledge/BAO/Pledge.php | 43 +++++++++++++-------- CRM/Pledge/BAO/PledgeBlock.php | 18 ++++++--- CRM/Pledge/BAO/PledgePayment.php | 60 ++++++++++++++++++++---------- CRM/Pledge/Form/Pledge.php | 6 ++- CRM/Pledge/Form/Search.php | 3 +- CRM/Pledge/Form/Task.php | 3 +- CRM/Pledge/Selector/Search.php | 36 ++++++++++++------ CRM/Pledge/StateMachine/Search.php | 3 +- 8 files changed, 114 insertions(+), 58 deletions(-) diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 9e91722c8d..bcea8d81dc 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -56,8 +56,10 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * 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 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_Pledge_BAO_Pledge object * @static @@ -75,7 +77,8 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { /** * Add pledge * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -120,9 +123,12 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { * 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 $returnProperties if you want to return specific fields + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. + * @param array $returnProperties + * If you want to return specific fields. * * @return array associated array of field values * @static @@ -138,7 +144,8 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { /** * Takes an associative array and creates a pledge 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_Pledge_BAO_Pledge object * @static @@ -251,7 +258,8 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { /** * Delete the pledge * - * @param int $id pledge id + * @param int $id + * Pledge id. * * @return mixed * @static @@ -439,7 +447,8 @@ GROUP BY currency /** * Get list of pledges In Honor of contact Ids * - * @param int $honorId In Honor of Contact ID + * @param int $honorId + * In Honor of Contact ID. * * @return array return the list of pledge fields * @@ -483,8 +492,10 @@ GROUP BY currency /** * Send Acknowledgment and create activity. * - * @param CRM_Core_Form $form form object. - * @param array $params an assoc array of name/value pairs. + * @param CRM_Core_Form $form + * Form object. + * @param array $params + * An assoc array of name/value pairs. * * @return void. */ @@ -739,7 +750,8 @@ GROUP BY currency /** * Get pending or in progress pledges * - * @param int $contactID contact id + * @param int $contactID + * Contact id. * * @return array associated array of pledge id(s) * @static @@ -1073,8 +1085,8 @@ SELECT pledge.contact_id as contact_id, * when no transactions have taken place - the editing process currently involves deleting all pledge payments & contributions * & recreating so we want to block that if appropriate * - * @param integer $pledgeID - * @param integer $pledgeStatusID + * @param int $pledgeID + * @param int $pledgeStatusID * @return bool do financial transactions exist for this pledge? */ public static function pledgeHasFinancialTransactions($pledgeID, $pledgeStatusID) { @@ -1092,7 +1104,8 @@ SELECT pledge.contact_id as contact_id, /** * Does this pledge / pledge payment status mean that a financial transaction has taken place? - * @param int $statusID pledge status id + * @param int $statusID + * Pledge status id. * * @return bool is it a transactional status? */ diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 255380b005..95c9952d43 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -48,8 +48,10 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { * 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 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_Pledge_BAO_PledgeBlock object * @static @@ -67,7 +69,8 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Takes an associative array and creates a pledgeBlock 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_Pledge_BAO_PledgeBlock object * @static @@ -91,7 +94,8 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Add pledgeBlock * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -146,7 +150,8 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Delete the pledgeBlock * - * @param int $id pledgeBlock id + * @param int $id + * PledgeBlock id. * * @return mixed|null * @static @@ -172,7 +177,8 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Return Pledge Block info in Contribution Pages * - * @param int $pageID contribution page id + * @param int $pageID + * Contribution page id. * * @return array * @static diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 97dd1267f7..db77eea981 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -44,7 +44,8 @@ class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment { /** * Get pledge payment details * - * @param int $pledgeId pledge id + * @param int $pledgeId + * Pledge id. * * @return array associated array of pledge payment details * @static @@ -163,7 +164,8 @@ WHERE pledge_id = %1 /** * Add pledge payment * - * @param array $params associate array of field + * @param array $params + * Associate array of field. * * @return pledge payment id * @static @@ -205,8 +207,10 @@ WHERE pledge_id = %1 * 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 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_Pledge_BAO_PledgePayment object * @static @@ -251,7 +255,8 @@ WHERE pledge_id = %1 /** * Delete all pledge payments * - * @param int $id pledge id + * @param int $id + * Pledge id. * * @return bool * @static @@ -285,7 +290,8 @@ WHERE pledge_id = %1 /** * On delete contribution record update associated pledge payment and pledge. * - * @param int $contributionID contribution id + * @param int $contributionID + * Contribution id. * * @return bool * @static @@ -322,13 +328,19 @@ WHERE pledge_id = %1 /** * Update Pledge Payment Status * - * @param int $pledgeID , id of pledge - * @param array $paymentIDs , ids of pledge payment(s) to update - * @param int $paymentStatusID , payment status to set - * @param int $pledgeStatusID pledge status to change (if needed) + * @param int $pledgeID + * , id of pledge. + * @param array $paymentIDs + * , ids of pledge payment(s) to update. + * @param int $paymentStatusID + * , payment status to set. + * @param int $pledgeStatusID + * Pledge status to change (if needed). * @param float|int $actualAmount , actual amount being paid - * @param bool $adjustTotalAmount , is amount being paid different from scheduled amount? - * @param bool $isScriptUpdate , is function being called from bin script? + * @param bool $adjustTotalAmount + * , is amount being paid different from scheduled amount?. + * @param bool $isScriptUpdate + * , is function being called from bin script?. * * @return int $newStatus, updated status id (or 0) */ @@ -568,7 +580,8 @@ WHERE civicrm_pledge.id = %2 /** * Calculate the pledge status * - * @param int $pledgeId pledge id + * @param int $pledgeId + * Pledge id. * * @return int $statusId calculated status id of pledge * @static @@ -607,12 +620,17 @@ WHERE civicrm_pledge.id = %2 /** * Update pledge payment table * - * @param int $pledgeId pledge id - * @param int $paymentStatusId payment status id to set - * @param array $paymentIds payment ids to be updated + * @param int $pledgeId + * Pledge id. + * @param int $paymentStatusId + * Payment status id to set. + * @param array $paymentIds + * Payment ids to be updated. * @param float|int $actualAmount , actual amount being paid - * @param int $contributionId , Id of associated contribution when payment is recorded - * @param bool $isScriptUpdate , is function being called from bin script? + * @param int $contributionId + * , Id of associated contribution when payment is recorded. + * @param bool $isScriptUpdate + * , is function being called from bin script?. * * @static */ @@ -653,7 +671,8 @@ WHERE civicrm_pledge_payment.pledge_id = %1 /** * Update pledge payment table when reminder is sent * - * @param int $paymentId payment id + * @param int $paymentId + * Payment id. * * @static */ @@ -670,7 +689,8 @@ WHERE civicrm_pledge_payment.id = {$paymentId} /** * Get oldest pending or in progress pledge payments * - * @param int $pledgeID pledge id + * @param int $pledgeID + * Pledge id. * * @param int $limit * diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index cf6c8d1bf0..a69109c692 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -440,8 +440,10 @@ class CRM_Pledge_Form_Pledge 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/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index 518de50d26..5e2833b174 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -295,7 +295,8 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return void * @static diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 6e342b082b..1704a2af2e 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -149,7 +149,8 @@ class CRM_Pledge_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 $title + * Title of the main button. * @param string $nextType * @param string $backType * @param bool $submitOnce diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index 4a2755c2ff..a976bae0a8 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -135,11 +135,15 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { /** * 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 $additionalClause if the caller wants to further restrict the search (used in participations) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many signers do we want returned + * @param string $additionalClause + * If the caller wants to further restrict the search (used in participations). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many signers do we want returned. * * @param string $context * @@ -267,11 +271,16 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { /** * 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 */ @@ -372,8 +381,10 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { * 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 */ @@ -447,7 +458,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { /** * 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/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index f34a4dc24d..1573b176e9 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -74,7 +74,8 @@ class CRM_Pledge_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