From b6c94f4299662a8de454f3ff7dcf7095d52edb5d Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 22:41:52 +1200 Subject: [PATCH] fixes to comment blocks --- CRM/ACL/Form/ACL.php | 18 ------------------ CRM/ACL/Form/ACLBasic.php | 17 ----------------- CRM/ACL/Form/EntityRole.php | 15 --------------- CRM/ACL/Form/WordPress/Permissions.php | 6 ------ CRM/ACL/Page/ACL.php | 14 -------------- CRM/ACL/Page/ACLBasic.php | 14 -------------- CRM/ACL/Page/EntityRole.php | 14 -------------- CRM/Activity/BAO/Query.php | 15 ++++----------- CRM/Activity/Form/Activity.php | 13 +++---------- CRM/Activity/Form/ActivityView.php | 9 +-------- CRM/Activity/Form/Search.php | 13 +------------ CRM/Activity/Form/Task.php | 13 +++---------- CRM/Activity/Form/Task/AddToTag.php | 8 -------- CRM/Activity/Form/Task/Batch.php | 4 ---- CRM/Activity/Form/Task/Delete.php | 10 ---------- CRM/Activity/Form/Task/Email.php | 13 +------------ CRM/Activity/Form/Task/FileOnCase.php | 13 ------------- CRM/Activity/Form/Task/PickOption.php | 15 +-------------- CRM/Activity/Form/Task/PickProfile.php | 15 +-------------- CRM/Activity/Form/Task/Print.php | 16 ++++------------ CRM/Activity/Form/Task/RemoveFromTag.php | 10 +--------- CRM/Activity/Form/Task/SMS.php | 11 +---------- .../Form/Task/SearchTaskHookSample.php | 6 ------ CRM/Activity/Import/Form/DataSource.php | 8 +------- CRM/Activity/Import/Form/MapField.php | 11 ++--------- CRM/Activity/Import/Form/Preview.php | 10 ++-------- CRM/Activity/Import/Form/Summary.php | 6 +----- CRM/Activity/Import/Parser.php | 11 +---------- CRM/Activity/Import/Parser/Activity.php | 16 +++++----------- CRM/Activity/Page/Tab.php | 14 +++----------- CRM/Activity/Page/UserDashboard.php | 9 +++------ CRM/Admin/Form.php | 6 +----- CRM/Admin/Form/CMSUser.php | 8 -------- CRM/Admin/Form/ContactType.php | 10 +--------- CRM/Admin/Form/Extensions.php | 18 ++---------------- CRM/Admin/Form/Job.php | 9 +-------- CRM/Admin/Form/LabelFormats.php | 10 +--------- CRM/Admin/Form/LocationType.php | 10 +--------- 38 files changed, 46 insertions(+), 392 deletions(-) diff --git a/CRM/ACL/Form/ACL.php b/CRM/ACL/Form/ACL.php index 04081c9842..cb635d6253 100644 --- a/CRM/ACL/Form/ACL.php +++ b/CRM/ACL/Form/ACL.php @@ -29,24 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_Form_ACL extends CRM_Admin_Form { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -113,8 +100,6 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -266,9 +251,6 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // note this also resets any ACL cache diff --git a/CRM/ACL/Form/ACLBasic.php b/CRM/ACL/Form/ACLBasic.php index 83048cc688..ce7d7827ea 100644 --- a/CRM/ACL/Form/ACLBasic.php +++ b/CRM/ACL/Form/ACLBasic.php @@ -29,24 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ class CRM_ACL_Form_ACLBasic extends CRM_Admin_Form { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { $defaults = array(); @@ -75,8 +63,6 @@ SELECT object_table /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -124,9 +110,6 @@ SELECT object_table /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_ACL_BAO_Cache::resetCache(); diff --git a/CRM/ACL/Form/EntityRole.php b/CRM/ACL/Form/EntityRole.php index 2a3379b5c0..b11f41ba5d 100644 --- a/CRM/ACL/Form/EntityRole.php +++ b/CRM/ACL/Form/EntityRole.php @@ -29,23 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -70,9 +58,6 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_ACL_BAO_Cache::resetCache(); diff --git a/CRM/ACL/Form/WordPress/Permissions.php b/CRM/ACL/Form/WordPress/Permissions.php index 4b4f8942cb..1b059b0c3f 100644 --- a/CRM/ACL/Form/WordPress/Permissions.php +++ b/CRM/ACL/Form/WordPress/Permissions.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -40,8 +38,6 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -107,8 +103,6 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { /** * Process the form submission. - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); diff --git a/CRM/ACL/Page/ACL.php b/CRM/ACL/Page/ACL.php index 72de0edc18..eccc9116d0 100644 --- a/CRM/ACL/Page/ACL.php +++ b/CRM/ACL/Page/ACL.php @@ -29,16 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { @@ -103,8 +93,6 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // get the requested action @@ -154,8 +142,6 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { /** * Browse all acls. - * - * @return void */ public function browse() { // get all acl's sorted by weight diff --git a/CRM/ACL/Page/ACLBasic.php b/CRM/ACL/Page/ACLBasic.php index bc9b1abf81..a81537304d 100644 --- a/CRM/ACL/Page/ACLBasic.php +++ b/CRM/ACL/Page/ACLBasic.php @@ -29,16 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { @@ -91,8 +81,6 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // get the requested action @@ -130,8 +118,6 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { /** * Browse all acls. - * - * @return void */ public function browse() { diff --git a/CRM/ACL/Page/EntityRole.php b/CRM/ACL/Page/EntityRole.php index 79724aaecf..4e737f6d9b 100644 --- a/CRM/ACL/Page/EntityRole.php +++ b/CRM/ACL/Page/EntityRole.php @@ -29,16 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { @@ -103,8 +93,6 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // get the requested action @@ -151,8 +139,6 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Browse all acls. - * - * @return void */ public function browse() { diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index 046afd02bc..9ca167066e 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -29,14 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Activity_BAO_Query { /** * Build select for Case. * - * @param $query + * @param CRM_Contact_BAO_Query $query */ public static function select(&$query) { if (!empty($query->_returnProperties['activity_id'])) { @@ -156,12 +155,9 @@ class CRM_Activity_BAO_Query { } /** - * Given a list of conditions in query generate the required. - * where clause + * Given a list of conditions in query generate the required where clause. * * @param $query - * - * @return void */ public static function where(&$query) { foreach (array_keys($query->_params) as $id) { @@ -178,9 +174,8 @@ class CRM_Activity_BAO_Query { /** * Where clause for a single field. * - * @param $values - * @param $query - * @return void + * @param array $values + * @param CRM_Contact_BAO_Query $query */ public static function whereClauseSingle(&$values, &$query) { list($name, $op, $value, $grouping) = $values; @@ -409,9 +404,7 @@ class CRM_Activity_BAO_Query { /** * Add all the elements shared between case activity search and advanced search. * - * * @param CRM_Core_Form $form - * @return void */ public static function buildSearchForm(&$form) { $activityOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE); diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index a1790f346a..908f7cef64 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Activity - * + * This class generates form components for Activity. */ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { @@ -221,8 +218,6 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { /** * Build the form object. - * - * @return void */ public function preProcess() { CRM_Core_Form_RecurringEntity::preProcess('civicrm_activity'); @@ -513,11 +508,9 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { } /** - * 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 + * For edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { diff --git a/CRM/Activity/Form/ActivityView.php b/CRM/Activity/Form/ActivityView.php index 5153296bd9..9f25fbecd0 100644 --- a/CRM/Activity/Form/ActivityView.php +++ b/CRM/Activity/Form/ActivityView.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class handle activity view mode - * + * This class handle activity view mode. */ class CRM_Activity_Form_ActivityView extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { //get the activity values @@ -117,8 +112,6 @@ class CRM_Activity_Form_ActivityView extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Activity/Form/Search.php b/CRM/Activity/Form/Search.php index cf8ba69ad0..1836d3197e 100644 --- a/CRM/Activity/Form/Search.php +++ b/CRM/Activity/Form/Search.php @@ -29,16 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * Files required */ /** - * This file is for activity search + * This file is for activity search. */ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { @@ -77,8 +71,6 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Search'); @@ -158,9 +150,6 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index 371028fc5b..7a330856f4 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Class for activity task actions - * + * Class for activity task actions. */ class CRM_Activity_Form_Task extends CRM_Core_Form { @@ -76,16 +73,14 @@ class CRM_Activity_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); } /** + * Common pre-process function. + * * @param CRM_Core_Form $form * @param bool $useTable */ @@ -194,8 +189,6 @@ WHERE activity_id IN ( $IDs ) AND * 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/Activity/Form/Task/AddToTag.php b/CRM/Activity/Form/Task/AddToTag.php index 441a0ea5b8..f95ec55f91 100644 --- a/CRM/Activity/Form/Task/AddToTag.php +++ b/CRM/Activity/Form/Task/AddToTag.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -56,9 +54,6 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // add select for tag @@ -95,9 +90,6 @@ class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { //get the submitted values in an array diff --git a/CRM/Activity/Form/Task/Batch.php b/CRM/Activity/Form/Task/Batch.php index 7c6c2a91d8..0793f97c87 100755 --- a/CRM/Activity/Form/Task/Batch.php +++ b/CRM/Activity/Form/Task/Batch.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -57,8 +55,6 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { /* diff --git a/CRM/Activity/Form/Task/Delete.php b/CRM/Activity/Form/Task/Delete.php index 4e3f48c0a6..addd960599 100755 --- a/CRM/Activity/Form/Task/Delete.php +++ b/CRM/Activity/Form/Task/Delete.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -50,8 +48,6 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -59,9 +55,6 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Delete Activities'), 'done'); @@ -69,9 +62,6 @@ class CRM_Activity_Form_Task_Delete extends CRM_Activity_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/Activity/Form/Task/Email.php b/CRM/Activity/Form/Task/Email.php index 981932a517..6bf8116a6d 100644 --- a/CRM/Activity/Form/Task/Email.php +++ b/CRM/Activity/Form/Task/Email.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: Email.php 26615 2010-03-21 21:05:35Z 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_Activity_Form_Task_Email extends CRM_Activity_Form_Task { @@ -58,8 +55,6 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this); @@ -73,9 +68,6 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -86,9 +78,6 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_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/Activity/Form/Task/FileOnCase.php b/CRM/Activity/Form/Task/FileOnCase.php index cc14a1685f..508bb29f1b 100644 --- a/CRM/Activity/Form/Task/FileOnCase.php +++ b/CRM/Activity/Form/Task/FileOnCase.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -57,8 +55,6 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -70,9 +66,6 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->add('text', 'unclosed_case_id', ts('Select Case'), array('class' => 'huge'), TRUE); @@ -81,18 +74,12 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { } /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $formparams = $this->exportValues(); diff --git a/CRM/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index 579bb93be5..63e9d65bd0 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to email a group of contacts + * This class provides the functionality to email a group of contacts. */ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { @@ -62,8 +60,6 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { /* @@ -93,9 +89,6 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addElement('checkbox', 'with_contact', ts('With Contact')); @@ -107,9 +100,6 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Activity_Form_Task_PickOption', 'formRule')); @@ -136,9 +126,6 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { // Clear any formRule errors from Email form in case they came back here via Cancel button diff --git a/CRM/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index ff99d7a844..920cfb2d23 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/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 Activity + * This class provides the functionality for batch profile update for Activity. */ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { @@ -57,8 +55,6 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { /* @@ -89,9 +85,6 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $types = array('Activity'); @@ -137,9 +130,6 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Activity_Form_Task_PickProfile', 'formRule')); @@ -160,9 +150,6 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_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/Activity/Form/Task/Print.php b/CRM/Activity/Form/Task/Print.php index 73601ff467..a49fda5951 100644 --- a/CRM/Activity/Form/Task/Print.php +++ b/CRM/Activity/Form/Task/Print.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to print activity records + * This class provides the functionality to print activity records. */ class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preprocess(); @@ -66,12 +62,11 @@ class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task { } /** - * Build the form object - it consists of + * Build the form object. + * + * Consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search - * - * - * @return void */ public function buildQuickForm() { // @@ -94,9 +89,6 @@ class CRM_Activity_Form_Task_Print extends CRM_Activity_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/Activity/Form/Task/RemoveFromTag.php b/CRM/Activity/Form/Task/RemoveFromTag.php index 1d5239ea88..27a3c064aa 100644 --- a/CRM/Activity/Form/Task/RemoveFromTag.php +++ b/CRM/Activity/Form/Task/RemoveFromTag.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -53,10 +51,7 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { protected $_tags; /** - * Build the form object - * - * - * @return void + * Build the form object. */ public function buildQuickForm() { // add select for tag @@ -91,9 +86,6 @@ class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { //get the submitted values in an array diff --git a/CRM/Activity/Form/Task/SMS.php b/CRM/Activity/Form/Task/SMS.php index aa35bf565a..0f12a429bc 100644 --- a/CRM/Activity/Form/Task/SMS.php +++ b/CRM/Activity/Form/Task/SMS.php @@ -26,8 +26,7 @@ */ /** - * This class provides the functionality to sms a group of - * contacts. + * This class provides the functionality to sms a group of contacts. */ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { @@ -48,8 +47,6 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -59,9 +56,6 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -71,9 +65,6 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { CRM_Contact_Form_Task_SMSCommon::postProcess($this); diff --git a/CRM/Activity/Form/Task/SearchTaskHookSample.php b/CRM/Activity/Form/Task/SearchTaskHookSample.php index 37dc7b098a..51b036d393 100644 --- a/CRM/Activity/Form/Task/SearchTaskHookSample.php +++ b/CRM/Activity/Form/Task/SearchTaskHookSample.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Activity_Form_Task_SearchTaskHookSample extends CRM_Activity_Form_Task /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -81,8 +77,6 @@ INNER JOIN civicrm_contact ct ON ( ac.contact_id = ct.id ) /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Activity/Import/Form/DataSource.php b/CRM/Activity/Import/Form/DataSource.php index 73fc897d78..aa412bb2f3 100644 --- a/CRM/Activity/Import/Form/DataSource.php +++ b/CRM/Activity/Import/Form/DataSource.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class gets the name of the file to upload + * This class gets the name of the file to upload. */ class CRM_Activity_Import_Form_DataSource extends CRM_Import_Form_DataSource { @@ -44,8 +42,6 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Import_Form_DataSource { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -69,8 +65,6 @@ class CRM_Activity_Import_Form_DataSource extends CRM_Import_Form_DataSource { /** * Process the uploaded file. - * - * @return void */ public function postProcess() { $this->storeFormValues(array( diff --git a/CRM/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index 20fe0bb3ca..e20f6eecb3 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -29,20 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class gets the name of the file to upload + * This class gets the name of the file to upload. */ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $this->_mapperFields = $this->get('fields'); @@ -82,8 +78,6 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //to save the current mappings @@ -371,9 +365,8 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Process the mapped fields and map it into the uploaded file. - * preview the file and extract some summary statistics * - * @return void + * Preview the file and extract some summary statistics */ public function postProcess() { $params = $this->controller->exportValues('MapField'); diff --git a/CRM/Activity/Import/Form/Preview.php b/CRM/Activity/Import/Form/Preview.php index 7f4f46139c..2d0c18d5b7 100644 --- a/CRM/Activity/Import/Form/Preview.php +++ b/CRM/Activity/Import/Form/Preview.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class previews the uploaded file and returns summary - * statistics + * This class previews the uploaded file and returns summary statistics. */ class CRM_Activity_Import_Form_Preview extends CRM_Import_Form_Preview { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $skipColumnHeader = $this->controller->exportValue('DataSource', 'skipColumnHeader'); @@ -107,9 +102,8 @@ class CRM_Activity_Import_Form_Preview extends CRM_Import_Form_Preview { /** * Process the mapped fields and map it into the uploaded file. - * preview the file and extract some summary statistics * - * @return void + * Preview the file and extract some summary statistics */ public function postProcess() { $fileName = $this->controller->exportValue('DataSource', 'uploadFile'); diff --git a/CRM/Activity/Import/Form/Summary.php b/CRM/Activity/Import/Form/Summary.php index 792b64079c..6631141d18 100644 --- a/CRM/Activity/Import/Form/Summary.php +++ b/CRM/Activity/Import/Form/Summary.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class summarizes the import results + * This class summarizes the import results. */ class CRM_Activity_Import_Form_Summary extends CRM_Import_Form_Summary { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { // set the error message path to display diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index aa4c8e0e78..9dd3c1c0b2 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { @@ -275,12 +273,9 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { } /** - * Given a list of the importable field keys that the user has selected - * set the active fields array to this list + * Given a list of the importable field keys that the user has selected set the active fields array to this list. * * @param array $fieldKeys - * - * @return void */ public function setActiveFields($fieldKeys) { $this->_activeFieldCount = count($fieldKeys); @@ -343,8 +338,6 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { * @param CRM_Core_Session $store * * @param int $mode - * - * @return void */ public function set($store, $mode = self::MODE_SUMMARY) { $store->set('fileSize', $this->_fileSize); @@ -387,8 +380,6 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { * @param string $fileName * @param array $header * @param array $data - * - * @return void */ public static function exportCSV($fileName, $header, $data) { $output = array(); diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php index 2f568f7e86..adbc2abb50 100644 --- a/CRM/Activity/Import/Parser/Activity.php +++ b/CRM/Activity/Import/Parser/Activity.php @@ -29,14 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ -require_once 'api/api.php'; /** - * class to parse activity csv files + * Class to parse activity csv files. */ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { @@ -56,7 +53,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { /** * Class constructor. - * @param $mapperKeys + * + * @param array $mapperKeys * @param null $mapperLocType * @param null $mapperPhoneType */ @@ -66,9 +64,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * The initializer code, called before the processing - * - * @return void + * The initializer code, called before the processing. */ public function init() { $activityContact = CRM_Activity_BAO_ActivityContact::import(); @@ -398,9 +394,7 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser { } /** - * The initializer code, called before the processing - * - * @return void + * The initializer code, called before the processing. */ public function fini() { } diff --git a/CRM/Activity/Page/Tab.php b/CRM/Activity/Page/Tab.php index 25148ea0a5..9d5dbbe918 100644 --- a/CRM/Activity/Page/Tab.php +++ b/CRM/Activity/Page/Tab.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Main page for viewing activities - * + * Main page for viewing activities, */ class CRM_Activity_Page_Tab extends CRM_Core_Page { /** * Browse all activities for a particular contact. - * - * @return void */ public function browse() { $this->assign('admin', FALSE); @@ -116,10 +111,9 @@ class CRM_Activity_Page_Tab 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() { $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE); @@ -158,8 +152,6 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page { /** * Perform actions and display for activities. - * - * @return void */ public function run() { $context = CRM_Utils_Request::retrieve('context', 'String', $this); diff --git a/CRM/Activity/Page/UserDashboard.php b/CRM/Activity/Page/UserDashboard.php index 1a6c9d3314..b9d5f89a2b 100644 --- a/CRM/Activity/Page/UserDashboard.php +++ b/CRM/Activity/Page/UserDashboard.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is for building event(participation) block on user dashboard + * This class is for building event(participation) block on user dashboard. */ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { @@ -66,10 +64,9 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoar } /** - * 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() { parent::preProcess(); diff --git a/CRM/Admin/Form.php b/CRM/Admin/Form.php index 4c45a371ff..897274d55e 100644 --- a/CRM/Admin/Form.php +++ b/CRM/Admin/Form.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Base class for admin forms + * Base class for admin forms. */ class CRM_Admin_Form extends CRM_Core_Form { @@ -113,8 +111,6 @@ class CRM_Admin_Form extends CRM_Core_Form { /** * Add standard buttons. - * - * @return void */ public function buildQuickForm() { if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) { diff --git a/CRM/Admin/Form/CMSUser.php b/CRM/Admin/Form/CMSUser.php index fa00057bb6..03dd5e866b 100644 --- a/CRM/Admin/Form/CMSUser.php +++ b/CRM/Admin/Form/CMSUser.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class generates form components for Synchronizing CMS Users - * */ class CRM_Admin_Form_CMSUser extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -62,9 +57,6 @@ class CRM_Admin_Form_CMSUser extends CRM_Core_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Core_BAO_CMSUser::synchronize(); diff --git a/CRM/Admin/Form/ContactType.php b/CRM/Admin/Form/ContactType.php index ba79ff9093..09f589c871 100644 --- a/CRM/Admin/Form/ContactType.php +++ b/CRM/Admin/Form/ContactType.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for ContactSub Type - * + * This class generates form components for ContactSub Type. */ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -118,9 +113,6 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache(); diff --git a/CRM/Admin/Form/Extensions.php b/CRM/Admin/Form/Extensions.php index 1c852dad03..df93fbf23b 100644 --- a/CRM/Admin/Form/Extensions.php +++ b/CRM/Admin/Form/Extensions.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Extensions - * + * This class generates form components for Extensions. */ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** - * For pre-processing - * - * @return void + * Form pre-processing. */ public function preProcess() { parent::preProcess(); @@ -84,10 +79,6 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** * Set default values for the form. - * the default values are retrieved from the database - * - * - * @return void */ public function setDefaultValues() { $defaults = array(); @@ -96,8 +87,6 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { switch ($this->_action) { @@ -173,9 +162,6 @@ class CRM_Admin_Form_Extensions extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache(); diff --git a/CRM/Admin/Form/Job.php b/CRM/Admin/Form/Job.php index 61a17699ea..f489aeb1bf 100644 --- a/CRM/Admin/Form/Job.php +++ b/CRM/Admin/Form/Job.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: $ - * */ /** - * + * Class for configuring jobs. */ class CRM_Admin_Form_Job extends CRM_Admin_Form { protected $_id = NULL; @@ -65,8 +63,6 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -172,9 +168,6 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { diff --git a/CRM/Admin/Form/LabelFormats.php b/CRM/Admin/Form/LabelFormats.php index 2acd821200..59e1a334d6 100644 --- a/CRM/Admin/Form/LabelFormats.php +++ b/CRM/Admin/Form/LabelFormats.php @@ -30,13 +30,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Label Format Settings - * + * This class generates form components for Label Format Settings. */ class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { @@ -62,8 +59,6 @@ class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -180,9 +175,6 @@ class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/LocationType.php b/CRM/Admin/Form/LocationType.php index 7192e54b9d..0646f7957f 100644 --- a/CRM/Admin/Form/LocationType.php +++ b/CRM/Admin/Form/LocationType.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Location Type - * + * This class generates form components for Location Type. */ class CRM_Admin_Form_LocationType extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -89,9 +84,6 @@ class CRM_Admin_Form_LocationType extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache('CRM_Core_DAO_LocationType'); -- 2.25.1