From 07f8d1626144f8f311240f1c1dde1f70f12f1c4d Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Tue, 26 May 2015 16:02:03 +1200 Subject: [PATCH] minor phpcs updates --- CRM/Contribute/Form/AbstractEditPayment.php | 2 +- CRM/Contribute/Form/AdditionalInfo.php | 2 -- CRM/Contribute/Form/AdditionalPayment.php | 4 +--- CRM/Contribute/Form/Contribution/ThankYou.php | 2 -- CRM/Contribute/Form/ContributionPage.php | 4 +--- CRM/Contribute/Form/ContributionPage/AddProduct.php | 7 +------ CRM/Contribute/Form/ContributionPage/Amount.php | 2 -- CRM/Contribute/Form/ContributionPage/Custom.php | 2 -- CRM/Contribute/Form/ContributionPage/Delete.php | 4 ---- CRM/Contribute/Form/ContributionPage/Premium.php | 7 +------ CRM/Contribute/Form/ContributionPage/Settings.php | 4 ---- CRM/Contribute/Form/ContributionPage/TabHeader.php | 4 +--- CRM/Contribute/Form/ContributionPage/ThankYou.php | 4 +--- CRM/Contribute/Form/ContributionPage/Widget.php | 2 -- CRM/Contribute/Form/ManagePremiums.php | 5 +---- CRM/Contribute/Form/SoftCredit.php | 4 +--- CRM/Contribute/Form/Task/Batch.php | 4 +--- CRM/Contribute/Form/Task/Delete.php | 8 +++----- CRM/Contribute/Form/Task/Email.php | 5 +---- CRM/Contribute/Form/Task/Invoice.php | 1 - CRM/Contribute/Form/Task/PDF.php | 3 --- CRM/Contribute/Form/Task/PDFLetter.php | 5 +---- CRM/Contribute/Form/Task/PDFLetterCommon.php | 3 --- CRM/Contribute/Form/Task/PickProfile.php | 4 +--- CRM/Contribute/Form/Task/Print.php | 4 +--- CRM/Contribute/Form/Task/Result.php | 6 ------ CRM/Contribute/Form/Task/SearchTaskHookSample.php | 2 -- CRM/Contribute/Form/Task/Status.php | 1 - 28 files changed, 17 insertions(+), 88 deletions(-) diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index f7cc453199..84bd43fac1 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -577,7 +577,7 @@ LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co } /** - * @param $submittedValues + * @param array $submittedValues * * @return mixed */ diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index ec8246020f..dab9329c83 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_AdditionalInfo { diff --git a/CRM/Contribute/Form/AdditionalPayment.php b/CRM/Contribute/Form/AdditionalPayment.php index ff5d5ea764..1ae7a5d275 100644 --- a/CRM/Contribute/Form/AdditionalPayment.php +++ b/CRM/Contribute/Form/AdditionalPayment.php @@ -34,9 +34,7 @@ */ /** - * This form records additional payments needed when - * event/contribution is partially paid - * + * This form records additional payments needed when event/contribution is partially paid. */ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_AbstractEditPayment { public $_contributeMode = 'direct'; diff --git a/CRM/Contribute/Form/Contribution/ThankYou.php b/CRM/Contribute/Form/Contribution/ThankYou.php index 07973821ab..9a78797924 100644 --- a/CRM/Contribute/Form/Contribution/ThankYou.php +++ b/CRM/Contribute/Form/Contribution/ThankYou.php @@ -45,8 +45,6 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index 200c6d0b11..be559ae91a 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form to process actions on the group aspect of Custom Data + * Contribution Page form. */ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { diff --git a/CRM/Contribute/Form/ContributionPage/AddProduct.php b/CRM/Contribute/Form/ContributionPage/AddProduct.php index 5b8a0ddd43..8964769daa 100644 --- a/CRM/Contribute/Form/ContributionPage/AddProduct.php +++ b/CRM/Contribute/Form/ContributionPage/AddProduct.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -43,10 +41,7 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For protected $_pid; /** - * Pre process the form. - * - * - * @return void + * Pre process the form. */ public function preProcess() { parent::preProcess(); diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index c180d10ac7..64f2e03add 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index ff76aaaa46..dc53fff2d3 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contribute/Form/ContributionPage/Delete.php b/CRM/Contribute/Form/ContributionPage/Delete.php index a21c8a312b..6525d6d7b9 100644 --- a/CRM/Contribute/Form/ContributionPage/Delete.php +++ b/CRM/Contribute/Form/ContributionPage/Delete.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -104,8 +102,6 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co /** * Process the form when submitted. - * - * @return void */ public function postProcess() { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index 47c3b001a6..5c843ee07f 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -29,21 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form to process actions on Premiums + * Form to process actions on Premiums. */ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_ContributionPage { /** * Set default values for the form. Note that in edit/view mode * the default values are retrieved from the database - * - * - * @return void */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index a9dbc7541f..9e62e59f4e 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -29,15 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ContributionPage { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); diff --git a/CRM/Contribute/Form/ContributionPage/TabHeader.php b/CRM/Contribute/Form/ContributionPage/TabHeader.php index 39e712c898..408c81d019 100644 --- a/CRM/Contribute/Form/ContributionPage/TabHeader.php +++ b/CRM/Contribute/Form/ContributionPage/TabHeader.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Helper class to build navigation links + * Helper class to build navigation links. */ class CRM_Contribute_Form_ContributionPage_TabHeader { /** diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index 31a9185aa5..a110510d6c 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form to configure thank-you messages and receipting features for an online contribution page + * Form to configure thank-you messages and receipting features for an online contribution page. */ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ContributionPage { diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index e404cd185b..63a9a752c7 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_ContributionPage { protected $_colors; diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 9441995a60..e6d76a77d3 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -40,10 +40,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { /** - * Pre process the form. - * - * - * @return void + * Pre process the form. */ public function preProcess() { parent::preProcess(); diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index cfaca3e08f..bdf05ba55c 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class build form elements for select existing or create new soft block + * This class build form elements for select existing or create new soft block. */ class CRM_Contribute_Form_SoftCredit { diff --git a/CRM/Contribute/Form/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index 3bfb76a318..48bb6376ce 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality for batch profile update for contributions + * This class provides the functionality for batch profile update for contributions. */ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index deaf7cfcfb..4cdfcd76ad 100644 --- a/CRM/Contribute/Form/Task/Delete.php +++ b/CRM/Contribute/Form/Task/Delete.php @@ -29,14 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to delete a group of - * contributions. This class provides functionality for the actual - * deletion. + * This class provides the functionality to delete a group of contributions. + * + * This class provides functionality for the actual deletion. */ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index 27993a5edd..7e7d5ca7bf 100644 --- a/CRM/Contribute/Form/Task/Email.php +++ b/CRM/Contribute/Form/Task/Email.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: Email.php 45499 2013-02-08 12:31:05Z kurund $ - * */ /** - * This class provides the functionality to email a group of - * contacts. + * This class provides the functionality to email a group of contacts. */ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 774d555f4b..58e927eded 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * */ /** diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index 12b611428d..a4b02f6801 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -102,9 +102,6 @@ AND {$this->_componentClause}"; /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index 5c05b70060..7dbf5fbcf1 100644 --- a/CRM/Contribute/Form/Task/PDFLetter.php +++ b/CRM/Contribute/Form/Task/PDFLetter.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to create PDF letter for a group of - * contacts or a single contact. + * This class provides the functionality to create PDF letter for a group of contacts or a single contact. */ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php index d95aed8cf4..9e36d0db25 100644 --- a/CRM/Contribute/Form/Task/PDFLetterCommon.php +++ b/CRM/Contribute/Form/Task/PDFLetterCommon.php @@ -9,10 +9,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDF /** * Process the form after the input has been submitted and validated. * - * * @param CRM_Contribute_Form_Task $form - * - * @return void */ public static function postProcess(&$form) { list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self::processMessageTemplate($form); diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 71b2bc3c14..acbaea1ea7 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality for batch profile update for contribution + * This class provides the functionality for batch profile update for contributions. */ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/Print.php b/CRM/Contribute/Form/Task/Print.php index e5a4067ae7..800a8e9082 100644 --- a/CRM/Contribute/Form/Task/Print.php +++ b/CRM/Contribute/Form/Task/Print.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to print contribution records + * This class provides the functionality to print contribution records. */ class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task { diff --git a/CRM/Contribute/Form/Task/Result.php b/CRM/Contribute/Form/Task/Result.php index 72428d2117..bfedf76612 100644 --- a/CRM/Contribute/Form/Task/Result.php +++ b/CRM/Contribute/Form/Task/Result.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Used for displaying results - * - * */ class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task { @@ -50,8 +46,6 @@ class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Contribute/Form/Task/SearchTaskHookSample.php b/CRM/Contribute/Form/Task/SearchTaskHookSample.php index 99a1c34930..c745ae78b3 100644 --- a/CRM/Contribute/Form/Task/SearchTaskHookSample.php +++ b/CRM/Contribute/Form/Task/SearchTaskHookSample.php @@ -28,8 +28,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index 67e7e8c20e..5d8d4d26a5 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * */ /** -- 2.25.1