From 95cdcc0fa3fd48931f1953c0181140b85b7078bf Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Wed, 2 Sep 2015 14:33:38 +1200 Subject: [PATCH] comment fixes --- CRM/Contact/Page/Inline/CustomData.php | 7 +------ CRM/Contact/Page/Inline/Demographics.php | 7 +------ CRM/Contact/Page/Inline/Email.php | 7 +------ CRM/Contact/Page/Inline/IM.php | 7 +------ CRM/Contact/Page/Inline/OpenID.php | 7 +------ CRM/Contact/Page/Inline/Phone.php | 7 +------ CRM/Contact/Page/Inline/Website.php | 7 +------ CRM/Contact/Page/SavedSearch.php | 7 ------- CRM/Contact/Page/Task.php | 6 ++---- CRM/Contact/Page/View.php | 8 ++------ CRM/Contact/Page/View/ContactSmartGroup.php | 2 -- CRM/Contact/Page/View/GroupContact.php | 5 +---- CRM/Contact/Page/View/Log.php | 4 +--- CRM/Contact/Page/View/Note.php | 7 ------- CRM/Contact/Page/View/Print.php | 10 ++-------- CRM/Contact/Page/View/Relationship.php | 4 ---- CRM/Contact/Page/View/Summary.php | 17 ++++------------- CRM/Contact/Page/View/Sunlight.php | 6 +----- CRM/Contact/Page/View/Tag.php | 6 +----- CRM/Contact/Page/View/UserDashBoard.php | 13 ++----------- .../Page/View/UserDashBoard/GroupContact.php | 11 +++-------- CRM/Contact/Page/View/Useradd.php | 7 +------ CRM/Contact/Page/View/Vcard.php | 12 ++++-------- CRM/Contact/Selector.php | 9 ++------- CRM/Contact/Selector/Controller.php | 10 +++------- CRM/Contact/StateMachine/Search.php | 2 -- CRM/Contact/Task.php | 6 +----- CRM/Contribute/BAO/Contribution/Utils.php | 1 - CRM/Contribute/BAO/ContributionSoft.php | 2 -- CRM/Contribute/BAO/ManagePremiums.php | 2 -- CRM/Contribute/BAO/Premium.php | 2 -- CRM/Contribute/BAO/Query.php | 4 ---- CRM/Contribute/BAO/Widget.php | 3 +-- CRM/Contribute/Config.php | 2 -- CRM/Contribute/Controller/Contribution.php | 2 -- CRM/Contribute/Controller/ContributionPage.php | 1 - CRM/Contribute/Controller/Search.php | 2 -- CRM/Contribute/Form.php | 9 ++------- CRM/Contribute/Form/AdditionalInfo.php | 12 +----------- CRM/Contribute/Form/AdditionalPayment.php | 4 +--- CRM/Contribute/Form/CancelSubscription.php | 12 +----------- CRM/Contribute/Form/Contribution/OnBehalfOf.php | 4 ---- CRM/Contribute/Form/Contribution/ThankYou.php | 6 +----- CRM/Contribute/Form/ContributionCharts.php | 8 -------- CRM/Contribute/Form/ContributionPage.php | 6 ------ .../Form/ContributionPage/AddProduct.php | 10 ++-------- CRM/Contribute/Form/ContributionPage/Amount.php | 4 ---- CRM/Contribute/Form/ContributionPage/Custom.php | 10 ++-------- CRM/Contribute/Form/ContributionPage/Delete.php | 6 +----- .../Form/ContributionPage/Premium.php | 7 +------ .../Form/ContributionPage/Settings.php | 10 +--------- .../Form/ContributionPage/ThankYou.php | 10 ++-------- CRM/Contribute/Form/ContributionPage/Widget.php | 8 +------- CRM/Contribute/Form/ContributionView.php | 9 +-------- CRM/Contribute/Form/ManagePremiums.php | 16 ++-------------- CRM/Contribute/Form/SearchContribution.php | 5 ----- CRM/Contribute/Form/SoftCredit.php | 5 +---- CRM/Contribute/Form/Task.php | 11 +---------- CRM/Contribute/Form/Task/Batch.php | 11 ----------- CRM/Contribute/Form/Task/Delete.php | 8 -------- CRM/Contribute/Form/Task/Email.php | 8 -------- CRM/Contribute/Form/Task/Invoice.php | 11 +---------- CRM/Contribute/Form/Task/PDF.php | 5 ----- CRM/Contribute/Form/Task/PDFLetter.php | 8 -------- CRM/Contribute/Form/Task/PickProfile.php | 2 -- 65 files changed, 60 insertions(+), 387 deletions(-) diff --git a/CRM/Contact/Page/Inline/CustomData.php b/CRM/Contact/Page/Inline/CustomData.php index 31385a1b52..98374a2f8c 100644 --- a/CRM/Contact/Page/Inline/CustomData.php +++ b/CRM/Contact/Page/Inline/CustomData.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This page displays custom data during inline edit - * + * This page displays custom data during inline edit. */ class CRM_Contact_Page_Inline_CustomData extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_CustomData extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/Demographics.php b/CRM/Contact/Page/Inline/Demographics.php index 8cb6cabeed..af8b06b224 100644 --- a/CRM/Contact/Page/Inline/Demographics.php +++ b/CRM/Contact/Page/Inline/Demographics.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details of demographics - * + * Dummy page for details of demographics. */ class CRM_Contact_Page_Inline_Demographics extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_Demographics extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/Email.php b/CRM/Contact/Page/Inline/Email.php index aec1dd0869..efcace3c35 100644 --- a/CRM/Contact/Page/Inline/Email.php +++ b/CRM/Contact/Page/Inline/Email.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details of Email - * + * Dummy page for details of Email. */ class CRM_Contact_Page_Inline_Email extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_Email extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/IM.php b/CRM/Contact/Page/Inline/IM.php index 5cb3dc4091..d7e6736a4c 100644 --- a/CRM/Contact/Page/Inline/IM.php +++ b/CRM/Contact/Page/Inline/IM.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details for IM - * + * Dummy page for details for IM. */ class CRM_Contact_Page_Inline_IM extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_IM extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/OpenID.php b/CRM/Contact/Page/Inline/OpenID.php index d48b8ac949..72ab101432 100644 --- a/CRM/Contact/Page/Inline/OpenID.php +++ b/CRM/Contact/Page/Inline/OpenID.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details for OpenID - * + * Dummy page for details for OpenID. */ class CRM_Contact_Page_Inline_OpenID extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_OpenID extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/Phone.php b/CRM/Contact/Page/Inline/Phone.php index 20282a8e72..6a3388cdef 100644 --- a/CRM/Contact/Page/Inline/Phone.php +++ b/CRM/Contact/Page/Inline/Phone.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details of Phone - * + * Dummy page for details of Phone. */ class CRM_Contact_Page_Inline_Phone extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_Phone extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/Inline/Website.php b/CRM/Contact/Page/Inline/Website.php index ec8d660375..bea1d498ef 100644 --- a/CRM/Contact/Page/Inline/Website.php +++ b/CRM/Contact/Page/Inline/Website.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dummy page for details of website - * + * Dummy page for details of website. */ class CRM_Contact_Page_Inline_Website extends CRM_Core_Page { @@ -43,8 +40,6 @@ class CRM_Contact_Page_Inline_Website extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { // get the emails for this contact diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index 92cad7fcb9..54091dcf86 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing all Saved searches. - * */ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { @@ -51,8 +48,6 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { * * @param int $id * Id of saved search. - * - * @return void */ public function delete($id) { // first delete the group associated with this saved search @@ -124,8 +119,6 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { /** * Run this page (figure out the action needed and perform it). - * - * @return void */ public function run() { $action = CRM_Utils_Request::retrieve('action', 'String', diff --git a/CRM/Contact/Page/Task.php b/CRM/Contact/Page/Task.php index ee01876652..7b740caa58 100644 --- a/CRM/Contact/Page/Task.php +++ b/CRM/Contact/Page/Task.php @@ -29,16 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This is a dummy class that does nothing at the moment. - * the template is used primarily for displaying result page + * + * The template is used primarily for displaying result page * of tasks performed on contacts. Contacts are searched/selected * and then subjected to Tasks/Actions. - * */ class CRM_Contact_Page_Task extends CRM_Core_Page { diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index 6a1038143f..449c0c2f04 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing contact. - * */ class CRM_Contact_Page_View extends CRM_Core_Page { @@ -68,10 +65,9 @@ class CRM_Contact_Page_View extends CRM_Core_Page { protected $_permission; /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function preProcess() { // process url params diff --git a/CRM/Contact/Page/View/ContactSmartGroup.php b/CRM/Contact/Page/View/ContactSmartGroup.php index 26e82a2bbf..314dea2f19 100644 --- a/CRM/Contact/Page/View/ContactSmartGroup.php +++ b/CRM/Contact/Page/View/ContactSmartGroup.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page { diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index a96f225ffb..d5a2bf45f0 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -29,14 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** - * called when action is browse. - * + * Called when action is browse. */ public function browse() { diff --git a/CRM/Contact/Page/View/Log.php b/CRM/Contact/Page/View/Log.php index 75801615fd..38e7a0ca42 100644 --- a/CRM/Contact/Page/View/Log.php +++ b/CRM/Contact/Page/View/Log.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_Log extends CRM_Core_Page { /** - * called when action is browse. + * Called when action is browse. * * @return null */ diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php index 98375fb741..ffc3657c4b 100644 --- a/CRM/Contact/Page/View/Note.php +++ b/CRM/Contact/Page/View/Note.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing Notes. - * */ class CRM_Contact_Page_View_Note extends CRM_Core_Page { @@ -55,8 +52,6 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * View details of a note. - * - * @return void */ public function view() { $note = new CRM_Core_DAO_Note(); @@ -233,8 +228,6 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * Delete the note object from the db. - * - * @return void */ public function delete() { CRM_Core_BAO_Note::del($this->_id); diff --git a/CRM/Contact/Page/View/Print.php b/CRM/Contact/Page/View/Print.php index 6d0b463063..202568ebcb 100644 --- a/CRM/Contact/Page/View/Print.php +++ b/CRM/Contact/Page/View/Print.php @@ -29,21 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing contact. - * */ class CRM_Contact_Page_View_Print extends CRM_Contact_Page_View_Summary { /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function run() { $this->_print = CRM_Core_Smarty::PRINT_PAGE; @@ -57,8 +53,6 @@ class CRM_Contact_Page_View_Print extends CRM_Contact_Page_View_Summary { /** * View summary details of a contact. - * - * @return void */ public function view() { $params = array(); diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php index d440f36c6c..7e53a60ddb 100644 --- a/CRM/Contact/Page/View/Relationship.php +++ b/CRM/Contact/Page/View/Relationship.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { @@ -53,8 +51,6 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** * View details of a relationship. - * - * @return void */ public function view() { $viewRelationship = CRM_Contact_BAO_Relationship::getRelationship($this->_contactId, NULL, NULL, NULL, $this->_id); diff --git a/CRM/Contact/Page/View/Summary.php b/CRM/Contact/Page/View/Summary.php index 95090a21ca..1744d8f591 100644 --- a/CRM/Contact/Page/View/Summary.php +++ b/CRM/Contact/Page/View/Summary.php @@ -29,21 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing contact. - * */ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function preProcess() { parent::preProcess(); @@ -85,10 +81,9 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { } /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function run() { $this->preProcess(); @@ -105,8 +100,6 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { /** * Edit name and address of a contact. - * - * @return void */ public function edit() { // set the userContext stack @@ -122,8 +115,6 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { /** * View summary details of a contact. - * - * @return void */ public function view() { // Add js for tabs, in-place editing, and jstree for tags diff --git a/CRM/Contact/Page/View/Sunlight.php b/CRM/Contact/Page/View/Sunlight.php index 8fabcce832..add1aa6afc 100644 --- a/CRM/Contact/Page/View/Sunlight.php +++ b/CRM/Contact/Page/View/Sunlight.php @@ -29,15 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View { /** - * called when action is browse. - * - * @return void + * Called when action is browse. */ public function browse() { // get the primary city, state and zip for the contact diff --git a/CRM/Contact/Page/View/Tag.php b/CRM/Contact/Page/View/Tag.php index 89c7bfe6af..f15688b889 100644 --- a/CRM/Contact/Page/View/Tag.php +++ b/CRM/Contact/Page/View/Tag.php @@ -29,15 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_Tag extends CRM_Core_Page { /** - * called when action is browse. - * - * @return void + * Called when action is browse. */ public function browse() { $controller = new CRM_Core_Controller_Simple('CRM_Tag_Form_Tag', ts('Contact Tags'), $this->_action); diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php index 2c45bc7961..c14196073a 100644 --- a/CRM/Contact/Page/View/UserDashBoard.php +++ b/CRM/Contact/Page/View/UserDashBoard.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * CMS User Dashboard * This class is used to build User Dashboard - * */ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { public $_contactId = NULL; @@ -87,10 +83,9 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { } /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function preProcess() { if (!$this->_contactId) { @@ -109,8 +104,6 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { /** * Build user dashboard. - * - * @return void */ public function buildUserDashBoard() { //build component selectors @@ -200,8 +193,6 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page { /** * Perform actions and display for user dashboard. - * - * @return void */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php index 67562fc095..11f8c09eb2 100644 --- a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php +++ b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php @@ -29,15 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_View_UserDashBoard { /** - * called when action is browse. - * - * @return void + * Called when action is browse. */ public function browse() { $count = CRM_Contact_BAO_GroupContact::getContactGroup( @@ -127,10 +123,9 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ } /** - * the main function that is called when the page loads, - * it decides the which action has to be taken for the page. + * The main function that is called when the page loads. * - * @return void + * It decides the which action has to be taken for the page. */ public function run() { $this->edit(); diff --git a/CRM/Contact/Page/View/Useradd.php b/CRM/Contact/Page/View/Useradd.php index e4cf8f6b66..c8d1da566e 100755 --- a/CRM/Contact/Page/View/Useradd.php +++ b/CRM/Contact/Page/View/Useradd.php @@ -28,13 +28,10 @@ /** * * @package CRM - * $Id$ - * */ /** - * Dummy page for details of Email - * + * Dummy page for details of Email. */ class CRM_Contact_Page_View_Useradd extends CRM_Core_Page { @@ -42,8 +39,6 @@ class CRM_Contact_Page_View_Useradd extends CRM_Core_Page { * Run the page. * * This method is called after the page is created. - * - * @return void */ public function run() { $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Task_Useradd', diff --git a/CRM/Contact/Page/View/Vcard.php b/CRM/Contact/Page/View/Vcard.php index 3a4d7aa8e5..c7cad12c2a 100644 --- a/CRM/Contact/Page/View/Vcard.php +++ b/CRM/Contact/Page/View/Vcard.php @@ -29,24 +29,20 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ require_once 'Contact/Vcard/Build.php'; /** - * vCard export class - * + * vCard export class. */ class CRM_Contact_Page_View_Vcard extends CRM_Contact_Page_View { /** - * Heart of the vCard data assignment process. The runner gets all the meta - * data for the contact and calls the writeVcard method to output the vCard - * to the user. + * Heart of the vCard data assignment process. * - * @return void + * The runner gets all the metadata for the contact and calls the writeVcard method to output the vCard + * to the user. */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 7bd1562f29..636f7ddf40 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -29,15 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is used to retrieve and display a range of - * contacts that match the given criteria (specifically for - * results of advanced search options. + * Class is to retrieve and display a range of contacts that match the given criteria. * + * It is specifically for results of advanced search options. */ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { @@ -1072,8 +1069,6 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * @param CRM_Utils_Sort $sort * @param string $cacheKey * Cache key. - * - * @return void */ public function rebuildPreNextCache($start, $end, $sort, $cacheKey) { // generate full SQL diff --git a/CRM/Contact/Selector/Controller.php b/CRM/Contact/Selector/Controller.php index e5bcd90216..816a854b9e 100644 --- a/CRM/Contact/Selector/Controller.php +++ b/CRM/Contact/Selector/Controller.php @@ -29,20 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller { /** - * Default function for qill, if needed to be implemented, we - * expect the subclass to do it + * Default function for qill. + * + * If needed to be implemented, we expect the subclass to do it * * @return string * the status message */ - /** - * @return string - */ public function getQill() { return $this->_object->getQILL(); } diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index 06774acdb9..45aee4c3a2 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Contact/Task.php b/CRM/Contact/Task.php index 7b676063c2..b175d8f076 100644 --- a/CRM/Contact/Task.php +++ b/CRM/Contact/Task.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * class to represent the actions that can be performed on a group of contacts - * used by the search forms - * + * Class to represent the actions that can be performed on a group of contacts used by the search forms. */ class CRM_Contact_Task { const diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php index b5643ff411..16c713a557 100644 --- a/CRM/Contribute/BAO/Contribution/Utils.php +++ b/CRM/Contribute/BAO/Contribution/Utils.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contribute_BAO_Contribution_Utils { diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index 1fe24c5166..2dddf4c008 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft { diff --git a/CRM/Contribute/BAO/ManagePremiums.php b/CRM/Contribute/BAO/ManagePremiums.php index 63eb9dc979..448bab6422 100644 --- a/CRM/Contribute/BAO/ManagePremiums.php +++ b/CRM/Contribute/BAO/ManagePremiums.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product { diff --git a/CRM/Contribute/BAO/Premium.php b/CRM/Contribute/BAO/Premium.php index 595fd7f6bc..7387fa45f0 100644 --- a/CRM/Contribute/BAO/Premium.php +++ b/CRM/Contribute/BAO/Premium.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium { diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index 8836a34c6b..71d9519d0f 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contribute_BAO_Query { @@ -863,10 +862,7 @@ class CRM_Contribute_BAO_Query { /** * Add all the elements shared between contribute search and advnaced search. * - * * @param CRM_Core_Form $form - * - * @return void */ public static function buildSearchForm(&$form) { diff --git a/CRM/Contribute/BAO/Widget.php b/CRM/Contribute/BAO/Widget.php index f71555987c..c7456707fc 100644 --- a/CRM/Contribute/BAO/Widget.php +++ b/CRM/Contribute/BAO/Widget.php @@ -29,11 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** - * Class to retrieve information about a contribution page + * Class to retrieve information about a contribution page. */ class CRM_Contribute_BAO_Widget extends CRM_Contribute_DAO_Widget { diff --git a/CRM/Contribute/Config.php b/CRM/Contribute/Config.php index 8f35c380ee..aaecca8ccc 100644 --- a/CRM/Contribute/Config.php +++ b/CRM/Contribute/Config.php @@ -33,8 +33,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Config extends CRM_Core_Component_Config { } diff --git a/CRM/Contribute/Controller/Contribution.php b/CRM/Contribute/Controller/Contribution.php index 8d8dfea184..a3914e3817 100644 --- a/CRM/Contribute/Controller/Contribution.php +++ b/CRM/Contribute/Controller/Contribution.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contribute/Controller/ContributionPage.php b/CRM/Contribute/Controller/ContributionPage.php index 5c3eda1161..b87aa8c065 100644 --- a/CRM/Contribute/Controller/ContributionPage.php +++ b/CRM/Contribute/Controller/ContributionPage.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Contribute/Controller/Search.php b/CRM/Contribute/Controller/Search.php index eae0c9cb0a..da2c749f61 100644 --- a/CRM/Contribute/Controller/Search.php +++ b/CRM/Contribute/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contribute/Form.php b/CRM/Contribute/Form.php index 36d3785169..43e7529971 100644 --- a/CRM/Contribute/Form.php +++ b/CRM/Contribute/Form.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components generic to Contribution admin - * + * This class generates form components generic to Contribution admin. */ class CRM_Contribute_Form extends CRM_Admin_Form { /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * * @return array */ diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 64082cab62..ffe5793052 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -88,10 +88,7 @@ class CRM_Contribute_Form_AdditionalInfo { /** * Build the form object for Additional Details. * - * * @param CRM_Core_Form $form - * - * @return void */ public static function buildAdditionalDetail(&$form) { //Additional information section @@ -175,10 +172,7 @@ class CRM_Contribute_Form_AdditionalInfo { * * Build the form object for PaymentReminders Information. * - * * @param CRM_Core_Form $form - * - * @return void */ public static function buildPaymentReminders(&$form) { //PaymentReminders section @@ -258,8 +252,6 @@ class CRM_Contribute_Form_AdditionalInfo { * @param int $contactID * @param int $contributionID * @param int $contributionNoteID - * - * @return void */ public static function processNote($params, $contactID, $contributionID, $contributionNoteID = NULL) { //process note @@ -280,11 +272,9 @@ class CRM_Contribute_Form_AdditionalInfo { /** * Process the Common data. * - * * @param array $params - * @param $formatted + * @param array $formatted * @param CRM_Core_Form $form - * @return void */ public static function postProcessCommon(&$params, &$formatted, &$form) { $fields = array( diff --git a/CRM/Contribute/Form/AdditionalPayment.php b/CRM/Contribute/Form/AdditionalPayment.php index 30e22ce717..e802fd2f11 100644 --- a/CRM/Contribute/Form/AdditionalPayment.php +++ b/CRM/Contribute/Form/AdditionalPayment.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -40,7 +38,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract public $_contributeMode = 'direct'; /** - * Related component whose financial payment is being processed + * Related component whose financial payment is being processed. * * @var string */ diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php index 787f62a343..2dc9ef4c9a 100644 --- a/CRM/Contribute/Form/CancelSubscription.php +++ b/CRM/Contribute/Form/CancelSubscription.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides support for canceling recurring subscriptions - * + * This class provides support for canceling recurring subscriptions. */ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { protected $_paymentProcessorObj = NULL; @@ -54,8 +51,6 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE); @@ -132,8 +127,6 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { // Determine if we can cancel recurring contribution via API with this processor @@ -196,9 +189,6 @@ class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $status = $message = NULL; diff --git a/CRM/Contribute/Form/Contribution/OnBehalfOf.php b/CRM/Contribute/Form/Contribution/OnBehalfOf.php index b676e62b37..7a87c60884 100644 --- a/CRM/Contribute/Form/Contribution/OnBehalfOf.php +++ b/CRM/Contribute/Form/Contribution/OnBehalfOf.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_Contribution_OnBehalfOf { @@ -38,8 +36,6 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf { * Set variables up before form is built. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Contribute/Form/Contribution/ThankYou.php b/CRM/Contribute/Form/Contribution/ThankYou.php index 89cdcd8275..abe880aef8 100644 --- a/CRM/Contribute/Form/Contribution/ThankYou.php +++ b/CRM/Contribute/Form/Contribution/ThankYou.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form for thank-you / success page - 3rd step of online contribution process + * Form for thank-you / success page - 3rd step of online contribution process. */ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_ContributionBase { @@ -87,8 +85,6 @@ class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_Cont /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->assignToTemplate(); diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php index 17d50d48bb..f5868f59c4 100644 --- a/CRM/Contribute/Form/ContributionCharts.php +++ b/CRM/Contribute/Form/ContributionCharts.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { @@ -63,9 +61,6 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //p3 = Three dimensional pie chart. @@ -99,9 +94,6 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php index 76b8125b8d..3c08ea6338 100644 --- a/CRM/Contribute/Form/ContributionPage.php +++ b/CRM/Contribute/Form/ContributionPage.php @@ -89,8 +89,6 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { // current contribution page id @@ -153,8 +151,6 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->applyFilter('__ALL__', 'trim'); @@ -356,8 +352,6 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form { /** * Process the form. - * - * @return void */ public function postProcess() { $pageId = $this->get('id'); diff --git a/CRM/Contribute/Form/ContributionPage/AddProduct.php b/CRM/Contribute/Form/ContributionPage/AddProduct.php index d20fad99e9..5236b04f9b 100644 --- a/CRM/Contribute/Form/ContributionPage/AddProduct.php +++ b/CRM/Contribute/Form/ContributionPage/AddProduct.php @@ -63,11 +63,9 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database + * Set default values for the form. * - * - * @return void + * Note that in edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { $defaults = array(); @@ -107,8 +105,6 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $urlParams = 'civicrm/admin/contribute/premium'; @@ -224,8 +220,6 @@ class CRM_Contribute_Form_ContributionPage_AddProduct extends CRM_Contribute_For /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php index edac8f8904..2b12b55fd8 100644 --- a/CRM/Contribute/Form/ContributionPage/Amount.php +++ b/CRM/Contribute/Form/ContributionPage/Amount.php @@ -50,8 +50,6 @@ class CRM_Contribute_Form_ContributionPage_Amount extends CRM_Contribute_Form_Co /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -415,8 +413,6 @@ SELECT id /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/Custom.php b/CRM/Contribute/Form/ContributionPage/Custom.php index 9b20383535..36c6bd4952 100644 --- a/CRM/Contribute/Form/ContributionPage/Custom.php +++ b/CRM/Contribute/Form/ContributionPage/Custom.php @@ -37,8 +37,6 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -81,11 +79,9 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * - * @return void + * Note that in edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -104,8 +100,6 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/Delete.php b/CRM/Contribute/Form/ContributionPage/Delete.php index 956505002d..ae7d9aa685 100644 --- a/CRM/Contribute/Form/ContributionPage/Delete.php +++ b/CRM/Contribute/Form/ContributionPage/Delete.php @@ -32,7 +32,7 @@ */ /** - * This class is to build the form for Deleting Group + * This class is to build the form for Deleting Group. */ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_ContributionPage { @@ -50,8 +50,6 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { //Check if there are contributions related to Contribution Page @@ -74,8 +72,6 @@ class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_Co /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->_title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title'); diff --git a/CRM/Contribute/Form/ContributionPage/Premium.php b/CRM/Contribute/Form/ContributionPage/Premium.php index 895c329cb4..e5f7d5ae5c 100644 --- a/CRM/Contribute/Form/ContributionPage/Premium.php +++ b/CRM/Contribute/Form/ContributionPage/Premium.php @@ -37,8 +37,7 @@ 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 + * Set default values for the form. */ public function setDefaultValues() { $defaults = array(); @@ -54,8 +53,6 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Premium'); @@ -122,8 +119,6 @@ class CRM_Contribute_Form_ContributionPage_Premium extends CRM_Contribute_Form_C /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/Settings.php b/CRM/Contribute/Form/ContributionPage/Settings.php index a96613fca4..448645e660 100644 --- a/CRM/Contribute/Form/ContributionPage/Settings.php +++ b/CRM/Contribute/Form/ContributionPage/Settings.php @@ -40,11 +40,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * - * - * @return void + * Set default values for the form. */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -100,8 +96,6 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -294,8 +288,6 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/ThankYou.php b/CRM/Contribute/Form/ContributionPage/ThankYou.php index 7a87174b44..5f22ef4ae9 100644 --- a/CRM/Contribute/Form/ContributionPage/ThankYou.php +++ b/CRM/Contribute/Form/ContributionPage/ThankYou.php @@ -37,11 +37,9 @@ class CRM_Contribute_Form_ContributionPage_ThankYou 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 + * Set default values for the form. * - * - * @return void + * Note that in edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { return parent::setDefaultValues(); @@ -49,8 +47,6 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->registerRule('emailList', 'callback', 'emailList', 'CRM_Utils_Rule'); @@ -106,8 +102,6 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Contribute/Form/ContributionPage/Widget.php b/CRM/Contribute/Form/ContributionPage/Widget.php index 08a1b23ebc..1b84182c64 100644 --- a/CRM/Contribute/Form/ContributionPage/Widget.php +++ b/CRM/Contribute/Form/ContributionPage/Widget.php @@ -141,13 +141,7 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * - * - * @return void - */ - /** + * Set default values for the form. */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contribute/Form/ContributionView.php b/CRM/Contribute/Form/ContributionView.php index 21ee933419..988a6a423c 100644 --- a/CRM/Contribute/Form/ContributionView.php +++ b/CRM/Contribute/Form/ContributionView.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Payment-Instrument - * + * This class generates form components for Payment-Instrument. */ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $id = $this->get('id'); @@ -204,8 +199,6 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index bac2af38c6..35bcb9e09a 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Premiums - * + * This class generates form components for Premiums. */ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { @@ -47,11 +44,7 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { } /** - * Set default values for the form. Manage Premiums that in edit/view mode - * the default values are retrieved from the database - * - * - * @return void + * Set default values for the form. */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -83,8 +76,6 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -273,9 +264,6 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { diff --git a/CRM/Contribute/Form/SearchContribution.php b/CRM/Contribute/Form/SearchContribution.php index 4743cf8e84..b828bc6434 100644 --- a/CRM/Contribute/Form/SearchContribution.php +++ b/CRM/Contribute/Form/SearchContribution.php @@ -29,16 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contribute_Form_SearchContribution extends CRM_Core_Form { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'title'); diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php index 35eab138c2..7561df91bb 100644 --- a/CRM/Contribute/Form/SoftCredit.php +++ b/CRM/Contribute/Form/SoftCredit.php @@ -40,8 +40,6 @@ class CRM_Contribute_Form_SoftCredit { * Set variables up before form is built. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { $contriDAO = new CRM_Contribute_DAO_Contribution(); @@ -63,13 +61,12 @@ class CRM_Contribute_Form_SoftCredit { } } - /** * Function used to build form element for soft credit block. * * @param CRM_Core_Form $form * - * @return void + * @return \CRM_Core_Form */ public static function buildQuickForm(&$form) { if (!empty($form->_honor_block_is_active)) { diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index 16ed6ad545..423c67437a 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for relationship - * + * This class generates form components for relationship. */ class CRM_Contribute_Form_Task extends CRM_Core_Form { @@ -90,10 +87,6 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @param - * - * @return void */ public function preProcess() { self::preProcessCommon($this); @@ -206,8 +199,6 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form { * Button type for the form after processing. * @param string $backType * @param bool $submitOnce - * - * @return void */ public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { $this->addButtons(array( diff --git a/CRM/Contribute/Form/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index 139a760647..1832a45950 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -55,8 +55,6 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { // initialize the task and row fields @@ -80,9 +78,6 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $ufGroupId = $this->get('ufGroupId'); @@ -183,9 +178,6 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { if (empty($this->_fields)) { @@ -203,9 +195,6 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index f14ba2b8eb..222eba1a96 100644 --- a/CRM/Contribute/Form/Task/Delete.php +++ b/CRM/Contribute/Form/Task/Delete.php @@ -48,8 +48,6 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { //check for delete @@ -61,9 +59,6 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Delete Contributions'), 'done'); @@ -71,9 +66,6 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $deleted = $failed = 0; diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index af21b8491e..e2db75182a 100644 --- a/CRM/Contribute/Form/Task/Email.php +++ b/CRM/Contribute/Form/Task/Email.php @@ -55,8 +55,6 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this); @@ -70,9 +68,6 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -83,9 +78,6 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { CRM_Contact_Form_Task_EmailCommon::postProcess($this); diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 9d1a984a55..2baabaebb0 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -66,8 +66,6 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE); @@ -138,9 +136,6 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $session = CRM_Core_Session::singleton(); @@ -222,9 +217,6 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); @@ -232,8 +224,7 @@ 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 + * Process the PDf and email with activity and attachment on click of Print Invoices. * * @param array $contribIDs * Contribution Id. diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index 00f9692061..44db260955 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -49,8 +49,6 @@ class CRM_Contribute_Form_Task_PDF extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $id = CRM_Utils_Request::retrieve('id', 'Positive', @@ -143,9 +141,6 @@ AND {$this->_componentClause}"; /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { // get all the details needed to generate a receipt diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php index c7ec8f94dc..5b403005b6 100644 --- a/CRM/Contribute/Form/Task/PDFLetter.php +++ b/CRM/Contribute/Form/Task/PDFLetter.php @@ -49,8 +49,6 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->skipOnHold = $this->skipDeceased = FALSE; @@ -102,9 +100,6 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -159,9 +154,6 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { CRM_Contribute_Form_Task_PDFLetterCommon::postProcess($this); diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 04ac76834a..2e2f03d626 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -55,8 +55,6 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { // initialize the task and row fields -- 2.25.1