From 3819f101d96db96af5a43d0a21e41b2639c6cb74 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:16:35 +1200 Subject: [PATCH] more comment fixes --- CRM/ACL/API.php | 2 -- CRM/ACL/BAO/ACL.php | 4 ++-- CRM/ACL/BAO/Cache.php | 4 +--- CRM/ACL/BAO/EntityRole.php | 6 ++--- CRM/Activity/BAO/Activity.php | 1 - CRM/Activity/BAO/ActivityAssignment.php | 5 +--- CRM/Activity/BAO/ActivityContact.php | 5 +--- CRM/Activity/BAO/ActivityTarget.php | 5 +--- CRM/Activity/BAO/ICalendar.php | 5 +--- CRM/Activity/Controller/Search.php | 1 - CRM/Activity/Form/ActivityFilter.php | 5 +--- CRM/Activity/Form/ActivityLinks.php | 5 +--- CRM/Activity/Import/Controller.php | 4 +--- CRM/Activity/Import/Field.php | 9 ++----- CRM/Activity/Selector/Activity.php | 5 +--- CRM/Activity/Selector/Search.php | 7 ++---- CRM/Activity/StateMachine/Search.php | 2 -- CRM/Activity/Task.php | 4 +--- CRM/Admin/Form/WordReplacements.php | 1 - CRM/Badge/BAO/Layout.php | 2 -- CRM/Badge/Page/Layout.php | 4 +--- CRM/Batch/Form/Search.php | 4 ++-- CRM/Batch/Page/AJAX.php | 4 +--- CRM/Campaign/Form/Survey.php | 7 +----- CRM/Campaign/Form/Survey/Delete.php | 10 +------- CRM/Campaign/Form/Survey/Main.php | 9 +------ CRM/Campaign/Form/Survey/Questions.php | 14 ++++------- CRM/Campaign/Form/Survey/Results.php | 14 ++++------- CRM/Campaign/Form/SurveyType.php | 12 +--------- CRM/Campaign/Form/Task.php | 11 +-------- CRM/Campaign/Form/Task/Interview.php | 13 ---------- CRM/Campaign/Form/Task/Print.php | 14 +++-------- CRM/Campaign/Form/Task/Release.php | 10 +------- CRM/Campaign/Form/Task/Reserve.php | 15 ++---------- CRM/Campaign/Form/Task/Result.php | 10 +------- CRM/Campaign/Page/SurveyType.php | 11 +-------- CRM/Case/BAO/Case.php | 16 +------------ CRM/Case/BAO/Query.php | 24 ++++++------------- CRM/Case/Form/Activity.php | 16 +++---------- .../Form/Activity/ChangeCaseStartDate.php | 15 ++++-------- CRM/Case/Form/Activity/ChangeCaseStatus.php | 18 +++++--------- CRM/Case/Form/Activity/ChangeCaseType.php | 15 ++++-------- CRM/Case/Form/CaseView.php | 17 +++---------- 43 files changed, 72 insertions(+), 293 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index 3674629ec4..c8434450aa 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_API { diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index ea00a20070..1277fe4c9e 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -44,6 +42,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { static $_fieldKeys = NULL; /** + * Get ACL entity table. + * * @return array|null */ public static function entityTable() { diff --git a/CRM/ACL/BAO/Cache.php b/CRM/ACL/BAO/Cache.php index fa9cd656c1..2ff804ca22 100644 --- a/CRM/ACL/BAO/Cache.php +++ b/CRM/ACL/BAO/Cache.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Access Control Cache + * Access Control Cache. */ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache { diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index 7cbd0850a3..bfe68b49d7 100644 --- a/CRM/ACL/BAO/EntityRole.php +++ b/CRM/ACL/BAO/EntityRole.php @@ -29,17 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Access Control EntityRole + * Access Control EntityRole. */ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { static $_entityTable = NULL; /** + * Get entity table. + * * @return array|null */ public static function entityTable() { diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 4c28eea292..20a66fc1d0 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index f47b2b28e4..be0ead74d4 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is for activity assignment functions - * + * This class is for activity assignment functions. */ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact { diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 6ce714310e..9de897ad60 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is for activity assignment functions - * + * This class is for activity assignment functions. */ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact { diff --git a/CRM/Activity/BAO/ActivityTarget.php b/CRM/Activity/BAO/ActivityTarget.php index a451f5e65c..ba08fba8ca 100644 --- a/CRM/Activity/BAO/ActivityTarget.php +++ b/CRM/Activity/BAO/ActivityTarget.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is for activity assignment functions - * + * This class is for activity assignment functions. */ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact { diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index 85f35a5f56..14582daa7b 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Generate ical invites for activities - * + * Generate ical invites for activities. */ class CRM_Activity_BAO_ICalendar { diff --git a/CRM/Activity/Controller/Search.php b/CRM/Activity/Controller/Search.php index 6d404ad392..a9899a1252 100644 --- a/CRM/Activity/Controller/Search.php +++ b/CRM/Activity/Controller/Search.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Activity/Form/ActivityFilter.php b/CRM/Activity/Form/ActivityFilter.php index 1ba55ce65b..3cdd386232 100644 --- a/CRM/Activity/Form/ActivityFilter.php +++ b/CRM/Activity/Form/ActivityFilter.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Activity Filter - * + * This class generates form components for Activity Filter. */ class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form { public function buildQuickForm() { diff --git a/CRM/Activity/Form/ActivityLinks.php b/CRM/Activity/Form/ActivityLinks.php index 88f8a2547d..07053d4d6d 100644 --- a/CRM/Activity/Form/ActivityLinks.php +++ b/CRM/Activity/Form/ActivityLinks.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Activity Links - * + * This class generates form components for Activity Links. */ class CRM_Activity_Form_ActivityLinks extends CRM_Core_Form { public function buildQuickForm() { diff --git a/CRM/Activity/Import/Controller.php b/CRM/Activity/Import/Controller.php index f86ada89e0..a8686829bf 100644 --- a/CRM/Activity/Import/Controller.php +++ b/CRM/Activity/Import/Controller.php @@ -29,15 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Activity_Import_Controller extends CRM_Core_Controller { /** * Class constructor. * - * @param null $title + * @param string $title * @param bool|int $action * @param bool $modal */ diff --git a/CRM/Activity/Import/Field.php b/CRM/Activity/Import/Field.php index 8b677634c2..036cfdd040 100644 --- a/CRM/Activity/Import/Field.php +++ b/CRM/Activity/Import/Field.php @@ -29,17 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Activity_Import_Field { - /**#@+ - * @var string - */ - /** - * Name of the field + * @var string + * Name of the field */ public $_name; diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 1181f03c1e..dbac346b6e 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is used to retrieve and display activities for a contact - * + * This class is used to retrieve and display activities for a contact. */ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 662afe1448..e2bbf895a8 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.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. + * 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 CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index f6baf0fe1f..0f8eea0c41 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php index 6c15cef550..953e96ae25 100644 --- a/CRM/Activity/Task.php +++ b/CRM/Activity/Task.php @@ -29,12 +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_Activity_Task { const diff --git a/CRM/Admin/Form/WordReplacements.php b/CRM/Admin/Form/WordReplacements.php index dffc7bc37b..070de44dee 100644 --- a/CRM/Admin/Form/WordReplacements.php +++ b/CRM/Admin/Form/WordReplacements.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Admin_Form_WordReplacements extends CRM_Core_Form { protected $_numStrings = 10; diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index d8c405b0d1..b39b54d771 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { diff --git a/CRM/Badge/Page/Layout.php b/CRM/Badge/Page/Layout.php index e122d9258f..492dccd8b2 100644 --- a/CRM/Badge/Page/Layout.php +++ b/CRM/Badge/Page/Layout.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for list page badges + * Page for list page badges. */ class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic { diff --git a/CRM/Batch/Form/Search.php b/CRM/Batch/Form/Search.php index a3d9c21ff0..61ca13475e 100644 --- a/CRM/Batch/Form/Search.php +++ b/CRM/Batch/Form/Search.php @@ -29,11 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Batch_Form_Search extends CRM_Core_Form { /** + * Set default values. + * * @return array */ public function setDefaultValues() { diff --git a/CRM/Batch/Page/AJAX.php b/CRM/Batch/Page/AJAX.php index 3831fe4d98..3bf89bfa10 100644 --- a/CRM/Batch/Page/AJAX.php +++ b/CRM/Batch/Page/AJAX.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class contains functions that are called using AJAX + * This class contains functions that are called using AJAX. */ class CRM_Batch_Page_AJAX { diff --git a/CRM/Campaign/Form/Survey.php b/CRM/Campaign/Form/Survey.php index 8a9a123f8c..7ebc9887f0 100644 --- a/CRM/Campaign/Form/Survey.php +++ b/CRM/Campaign/Form/Survey.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a survey - * + * This class generates form components for processing a survey. */ class CRM_Campaign_Form_Survey extends CRM_Core_Form { @@ -91,8 +88,6 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Campaign/Form/Survey/Delete.php b/CRM/Campaign/Form/Survey/Delete.php index aee73129f6..ac3db7c2c2 100644 --- a/CRM/Campaign/Form/Survey/Delete.php +++ b/CRM/Campaign/Form/Survey/Delete.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is to build the form for deleting a Survey + * This class is to build the form for deleting a Survey. */ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { @@ -55,8 +53,6 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { if (!CRM_Campaign_BAO_Campaign::accessCampaign()) { @@ -73,8 +69,6 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( @@ -93,8 +87,6 @@ class CRM_Campaign_Form_Survey_Delete extends CRM_Core_Form { /** * Process the form when submitted. - * - * @return void */ public function postProcess() { if ($this->_surveyId) { diff --git a/CRM/Campaign/Form/Survey/Main.php b/CRM/Campaign/Form/Survey/Main.php index de31df619c..323664c8fa 100644 --- a/CRM/Campaign/Form/Survey/Main.php +++ b/CRM/Campaign/Form/Survey/Main.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a survey - * + * This class generates form components for processing a survey. */ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { @@ -137,8 +134,6 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -179,8 +174,6 @@ class CRM_Campaign_Form_Survey_Main extends CRM_Campaign_Form_Survey { /** * Process the form. - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Campaign/Form/Survey/Questions.php b/CRM/Campaign/Form/Survey/Questions.php index cd8048830c..d0869b3247 100644 --- a/CRM/Campaign/Form/Survey/Questions.php +++ b/CRM/Campaign/Form/Survey/Questions.php @@ -29,19 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a survey - * + * This class generates form components for processing a survey. */ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { /** - * 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. + * + * Note that in edit/view mode the default values are retrieved from the database. * * @return array * array of default values @@ -64,8 +62,6 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $subTypeId = CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $this->_surveyId, 'activity_type_id'); @@ -102,8 +98,6 @@ class CRM_Campaign_Form_Survey_Questions extends CRM_Campaign_Form_Survey { /** * Process the form. - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index 470bad8de4..728fcf2ecc 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a survey - * + * This class generates form components for processing a survey. */ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { @@ -74,8 +71,9 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { } /** - * 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. + * + * Note that in edit/view mode the default values are retrieved from the database. * * @return array * array of default values @@ -97,8 +95,6 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $optionGroups = CRM_Campaign_BAO_Survey::getResultSets(); @@ -345,8 +341,6 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { /** * Process the form. - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Campaign/Form/SurveyType.php b/CRM/Campaign/Form/SurveyType.php index 2ba88b6a6a..a2dc62db54 100644 --- a/CRM/Campaign/Form/SurveyType.php +++ b/CRM/Campaign/Form/SurveyType.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Option Group - * + * This class generates form components for Option Group. */ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { protected $_gid; @@ -63,8 +60,6 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this); @@ -112,8 +107,6 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -143,9 +136,6 @@ class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index 0ac3114ee7..bb5752067f 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/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_Campaign_Form_Task extends CRM_Core_Form { @@ -76,10 +73,6 @@ class CRM_Campaign_Form_Task extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @param - * - * @return void */ public function preProcess() { $values = $this->controller->exportValues('Search'); @@ -141,8 +134,6 @@ class CRM_Campaign_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/Campaign/Form/Task/Interview.php b/CRM/Campaign/Form/Task/Interview.php index 1a8d4b6007..4247adb697 100755 --- a/CRM/Campaign/Form/Task/Interview.php +++ b/CRM/Campaign/Form/Task/Interview.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -70,8 +68,6 @@ class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_votingTab = $this->get('votingTab'); @@ -281,9 +277,6 @@ WHERE {$clause} /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->assign('surveyTypeId', $this->_surveyTypeId); @@ -387,9 +380,6 @@ WHERE {$clause} /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { //load default data for only contact fields. @@ -442,9 +432,6 @@ WHERE {$clause} /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $buttonName = $this->controller->getButtonName(); diff --git a/CRM/Campaign/Form/Task/Print.php b/CRM/Campaign/Form/Task/Print.php index 2005374d4d..4ede318e25 100755 --- a/CRM/Campaign/Form/Task/Print.php +++ b/CRM/Campaign/Form/Task/Print.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -40,8 +38,6 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preprocess(); @@ -75,12 +71,11 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { } /** - * Build the form object - it consists of + * Build the form object. + * + * It consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search - * - * - * @return void */ public function buildQuickForm() { // @@ -103,9 +98,6 @@ class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { // redirect to the main search page after printing is over diff --git a/CRM/Campaign/Form/Task/Release.php b/CRM/Campaign/Form/Task/Release.php index fe1b4860ae..59abf6d3e2 100644 --- a/CRM/Campaign/Form/Task/Release.php +++ b/CRM/Campaign/Form/Task/Release.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to add contacts for - * voter reservation. + * This class provides the functionality to add contacts for voter reservation. */ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { @@ -64,8 +61,6 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_interviewToRelease = $this->get('interviewToRelease'); @@ -137,9 +132,6 @@ class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index f5596db177..817b67e898 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to add contacts for - * voter reservation. + * This class provides the functionality to add contacts for voter reservation. */ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { @@ -69,8 +66,6 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -158,9 +153,6 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // allow to add contact to either new or existing group. @@ -240,10 +232,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void - */ + */ public function postProcess() { //add reservation. $countVoters = 0; diff --git a/CRM/Campaign/Form/Task/Result.php b/CRM/Campaign/Form/Task/Result.php index ee91ef00af..fcbebf5b47 100755 --- a/CRM/Campaign/Form/Task/Result.php +++ b/CRM/Campaign/Form/Task/Result.php @@ -29,29 +29,21 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Used for displaying results - * - * + * Used for displaying results. */ class CRM_Campaign_Form_Task_Result extends CRM_Campaign_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { } /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index 6c5d60e7c9..a873a40de5 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of Gender + * Page for displaying list of Gender. */ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { @@ -70,8 +68,6 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Obtains the group name from url and sets the title. - * - * @return void */ public function preProcess() { $this->_gName = 'activity_type'; @@ -136,8 +132,6 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -146,9 +140,6 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Browse all options. - * - * - * @return void */ public function browse() { $campaingCompId = CRM_Core_Component::getComponentID('CiviCampaign'); diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 521ba5894d..0d3b5337ca 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -385,8 +383,6 @@ WHERE civicrm_case.id = %1"; * Case id. * @param bool $enable * Action. - * - * @return void */ public static function enableDisableCaseRelationships($caseId, $enable) { $contactIds = self::retrieveContactIdsByCaseId($caseId); @@ -409,8 +405,6 @@ WHERE civicrm_case.id = %1"; * * @param int $activityId * Id of the activity. - * - * @return void */ public static function deleteCaseActivity($activityId) { $case = new CRM_Case_DAO_CaseActivity(); @@ -1447,7 +1441,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param null $attachments * @param int $caseId * - * @return void + * @return null|array */ public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) { if (!$activityId) { @@ -1929,10 +1923,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $relContactId * Case role assignee contactId. * @param int $contactId - * - * @return void - * on success creates activity and case activity - * */ public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) { if (!$caseId || !$relationshipId || empty($relationshipId)) { @@ -2788,8 +2778,6 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Params to be sent to template for sending email. * @param array $activityParams * Info of the activity. - * - * @return void */ public static function buildPermissionLinks(&$tplParams, $activityParams) { $activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'], @@ -3353,8 +3341,6 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Case id. * @param int $contactId * Contact id / new client id. - * - * @return void */ public static function addCaseRelationships($caseId, $contactId) { // get the case role / relationships for the case diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index c0be5a257d..de28c1ad5b 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -29,12 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_BAO_Query { /** + * Get fields. + * * @param bool $excludeActivityFields * * @return array @@ -55,8 +55,6 @@ class CRM_Case_BAO_Query { * Build select for Case. * * @param $query - * - * @return void */ public static function select(&$query) { if (($query->_mode & CRM_Contact_BAO_Query::MODE_CASE) || !empty($query->_returnProperties['case_id'])) { @@ -218,12 +216,9 @@ class CRM_Case_BAO_Query { } /** - * Given a list of conditions in query generate the required - * where clause - * - * @param $query + * Given a list of conditions in query generate the required where clause. * - * @return void + * @param CRM_Case_BAO_Query $query */ public static function where(&$query) { foreach ($query->_params as $id => $values) { @@ -244,10 +239,8 @@ class CRM_Case_BAO_Query { /** * Where clause for a single field. * - * @param $values - * @param $query - * - * @return void + * @param array $values + * @param CRM_Case_BAO_Query s$query */ public static function whereClauseSingle(&$values, &$query) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -656,12 +649,9 @@ case_relation_type.id = case_relationship.relationship_type_id )"; } /** - * Add all the elements shared between case search and advanaced search. - * + * Add all the elements shared between case search and advanced search. * * @param CRM_Core_Form $form - * - * @return void */ public static function buildSearchForm(&$form) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 4dc5365c62..55a6b70d0c 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class create activities for a case - * + * This class create activities for a case. */ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { @@ -62,8 +59,6 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { /** * Build the form object. - * - * @return void */ public function preProcess() { $caseIds = CRM_Utils_Request::retrieve('caseid', 'String', $this); @@ -207,11 +202,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * - * - * @return void + * Set default values for the form. */ public function setDefaultValues() { $this->_defaults = parent::setDefaultValues(); @@ -354,10 +345,9 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { /** * Process the form submission. * - * * @param array $params * - * @return void + * @return array|null */ public function postProcess($params = NULL) { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index d33ac581e8..07889baffb 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for OpenCase Activity - * + * This class generates form components for OpenCase Activity. */ class CRM_Case_Form_Activity_ChangeCaseStartDate { @@ -54,13 +51,13 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database + * Set default values for the form. * + * For edit/view mode the default values are retrieved from the database. * * @param CRM_Core_Form $form * - * @return void + * @return array */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -122,8 +119,6 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'case') { @@ -138,8 +133,6 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * @param CRM_Core_Form $form * @param array $params * @param $activity - * - * @return void */ public static function endPostProcess(&$form, &$params, $activity) { if (!empty($params['start_date'])) { diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index 8af8f0b257..fe0a699e11 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for OpenCase Activity - * + * This class generates form components for OpenCase Activity. */ class CRM_Case_Form_Activity_ChangeCaseStatus { @@ -51,13 +48,14 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database + * Set default values for the form. + * + * For edit/view mode the default values are retrieved from the database. * * * @param CRM_Core_Form $form * - * @return void + * @return array */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -122,8 +120,6 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { $params['id'] = CRM_Utils_Array::value('case_id', $params); @@ -135,9 +131,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @param CRM_Core_Form $form * @param array $params - * @param $activity - * - * @return void + * @param CRM_Activity_BAO_Activity $activity */ public static function endPostProcess(&$form, &$params, $activity) { $groupingValues = CRM_Core_OptionGroup::values('case_status', FALSE, TRUE, FALSE, NULL, 'value'); diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index aa40ad2af5..1d617db5a6 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for OpenCase Activity - * + * This class generates form components for OpenCase Activity. */ class CRM_Case_Form_Activity_ChangeCaseType { @@ -51,13 +48,13 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database + * Set default values for the form. * + * For edit/view mode the default values are retrieved from the database. * * @param CRM_Core_Form $form * - * @return void + * @return array */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -119,8 +116,6 @@ class CRM_Case_Form_Activity_ChangeCaseType { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'case') { @@ -143,8 +138,6 @@ class CRM_Case_Form_Activity_ChangeCaseType { * @param CRM_Core_Form $form * @param array $params * @param $activity - * - * @return void */ public static function endPostProcess(&$form, &$params, $activity) { if (!$form->_caseId) { diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php index 315972c160..1b3b74fcf4 100644 --- a/CRM/Case/Form/CaseView.php +++ b/CRM/Case/Form/CaseView.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates view mode for CiviCase - * + * This class generates view mode for CiviCase. */ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** @@ -46,8 +43,6 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $this->_showRelatedCases = CRM_Utils_Array::value('relatedCases', $_GET); @@ -194,11 +189,9 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database + * Set default values for the form. * - * - * @return void + * @return array; */ public function setDefaultValues() { $defaults = array(); @@ -207,8 +200,6 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //this call is for show related cases. @@ -444,8 +435,6 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); -- 2.25.1