From b6c94f4299662a8de454f3ff7dcf7095d52edb5d Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 22:41:52 +1200 Subject: [PATCH 1/5] 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 04081c98426..cb635d6253d 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -266,9 +251,6 @@ public static function formRule($params) { /** * 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 83048cc688d..ce7d7827eab 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -124,9 +110,6 @@ public static function formRule($params) { /** * 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 2a3379b5c07..b11f41ba5d6 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 @@ public function buildQuickForm() { /** * 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 4b4f8942cba..1b059b0c3fd 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 @@ public function buildQuickForm() { /** * 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 72de0edc18b..eccc9116d05 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 @@ public function &links() { * 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 @@ public function run() { /** * 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 bc9b1abf818..a81537304db 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 @@ public function &links() { * 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 @@ public function run() { /** * Browse all acls. - * - * @return void */ public function browse() { diff --git a/CRM/ACL/Page/EntityRole.php b/CRM/ACL/Page/EntityRole.php index 79724aaecf9..4e737f6d9b5 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 @@ public function &links() { * 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 @@ public function run() { /** * Browse all acls. - * - * @return void */ public function browse() { diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index 046afd02bc9..9ca167066e7 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 @@ public static function select(&$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 @@ public static function where(&$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 @@ public function qill() { /** * 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 a1790f346ac..908f7cef645 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 @@ public function setFields() { /** * Build the form object. - * - * @return void */ public function preProcess() { CRM_Core_Form_RecurringEntity::preProcess('civicrm_activity'); @@ -513,11 +508,9 @@ public function preProcess() { } /** - * 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 5153296bd9d..9f25fbecd0e 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 @@ public function preProcess() { /** * 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 cf8ba69ad0c..1836d3197ea 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 @@ public function preProcess() { /** * 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 371028fc5bc..7a330856f46 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 @@ public function setContactIDs() { * 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 441a0ea5b8e..f95ec55f916 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 @@ public static function formRule($form, $rule) { /** * 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 7c6c2a91d8e..0793f97c872 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 4e3f48c0a63..addd960599a 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 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Delete Activities'), 'done'); @@ -69,9 +62,6 @@ public function buildQuickForm() { /** * 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 981932a517a..6bf8116a6d7 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 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -86,9 +78,6 @@ public function buildQuickForm() { /** * 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 cc14a1685f0..508bb29f1bc 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 @@ public function preProcess() { /** * 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 @@ public function buildQuickForm() { /** * 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 579bb93be51..63e9d65bd03 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 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addElement('checkbox', 'with_contact', ts('With Contact')); @@ -107,9 +100,6 @@ public function buildQuickForm() { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Activity_Form_Task_PickOption', 'formRule')); @@ -136,9 +126,6 @@ public static function formRule($fields) { /** * 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 ff99d7a844e..920cfb2d23a 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 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $types = array('Activity'); @@ -137,9 +130,6 @@ public function buildQuickForm() { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Activity_Form_Task_PickProfile', 'formRule')); @@ -160,9 +150,6 @@ public static function formRule($fields) { /** * 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 73601ff467b..a49fda59510 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 @@ public function preProcess() { } /** - * 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 @@ public function buildQuickForm() { /** * 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 1d5239ea883..27a3c064aaa 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 @@ public static function formRule($form, $rule) { /** * 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 aa35bf565a4..0f12a429bc6 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 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -71,9 +65,6 @@ public function buildQuickForm() { /** * 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 37dc7b098ac..51b036d393a 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 @@ public function preProcess() { /** * 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 73fc897d78c..aa412bb2f36 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 @@ public function buildQuickForm() { /** * 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 20fe0bb3cac..e20f6eecb3e 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 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //to save the current mappings @@ -371,9 +365,8 @@ public static function formRule($fields) { /** * 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 7f4f46139c0..2d0c18d5b7e 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 @@ public function preProcess() { /** * 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 792b64079ca..6631141d185 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 aa4c8e0e786..9dd3c1c0b24 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 @@ public function run( } /** - * 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 @@ public function addField($name, $title, $type = CRM_Utils_Type::T_INT, $headerPa * @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 @@ public function set($store, $mode = self::MODE_SUMMARY) { * @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 2f568f7e864..adbc2abb502 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 @@ public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneTyp } /** - * 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 @@ public function import($onDuplicate, &$values) { } /** - * 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 25148ea0a58..9d5dbbe918b 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 @@ public function edit() { } /** - * 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 @@ public function delete() { /** * 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 1a6c9d33146..b9d5f89a2b0 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 @@ public function listActivities() { } /** - * 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 4c45a371fff..897274d55e3 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 @@ public function setDefaultValues() { /** * 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 fa00057bb64..03dd5e866b4 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 @@ public function buildQuickForm() { /** * 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 ba79ff90931..09f589c871f 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 @@ public static function formRule($fields, $files, $self) { /** * 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 1c852dad03f..df93fbf23bc 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 @@ public function preProcess() { /** * 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { switch ($this->_action) { @@ -173,9 +162,6 @@ public static function formRule($fields, $files, $self) { /** * 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 61a17699eaf..f489aeb1bfd 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 @@ public function preProcess() { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -172,9 +168,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { diff --git a/CRM/Admin/Form/LabelFormats.php b/CRM/Admin/Form/LabelFormats.php index 2acd821200c..59e1a334d69 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 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -180,9 +175,6 @@ public function setDefaultValues() { /** * 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 7192e54b9d4..0646f7957f9 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 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache('CRM_Core_DAO_LocationType'); From ce064e4f6bd0c1df0122a8d9b3793dfb587f9658 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:00:19 +1200 Subject: [PATCH 2/5] further comment fixes --- CRM/ACL/Form/ACLBasic.php | 1 - CRM/Admin/Form/MailSettings.php | 10 ------ CRM/Admin/Form/Mapping.php | 10 +----- CRM/Admin/Form/MessageTemplates.php | 12 +------ CRM/Admin/Form/Navigation.php | 10 +----- CRM/Admin/Form/OptionGroup.php | 10 +----- CRM/Admin/Form/Options.php | 14 +------- CRM/Admin/Form/ParticipantStatusType.php | 7 ++-- CRM/Admin/Form/PaymentProcessor.php | 16 ++------- CRM/Admin/Form/PaymentProcessorType.php | 10 +----- CRM/Admin/Form/PdfFormats.php | 10 +----- CRM/Admin/Form/Persistent.php | 9 +++-- CRM/Admin/Form/Preferences.php | 13 +------ CRM/Admin/Form/Preferences/Address.php | 9 +---- CRM/Admin/Form/Preferences/Contribute.php | 18 ++-------- CRM/Admin/Form/Preferences/Display.php | 7 ---- CRM/Admin/Form/Preferences/Member.php | 7 +--- CRM/Admin/Form/PreferencesDate.php | 10 +----- CRM/Admin/Form/RelationshipType.php | 10 +----- CRM/Admin/Form/ScheduleReminders.php | 10 +----- CRM/Admin/Form/Setting.php | 8 +++-- CRM/Admin/Form/Setting/Component.php | 6 +--- CRM/Admin/Form/Setting/Date.php | 7 +--- CRM/Admin/Form/Setting/Debugging.php | 7 +--- CRM/Admin/Form/Setting/Localization.php | 7 +--- CRM/Admin/Form/Setting/Mail.php | 6 +--- CRM/Admin/Form/Setting/Mapping.php | 12 ++----- CRM/Admin/Form/Setting/Miscellaneous.php | 7 +--- CRM/Admin/Form/Setting/Path.php | 7 +--- CRM/Admin/Form/Setting/Smtp.php | 14 +------- CRM/Admin/Form/Setting/UF.php | 7 +--- .../Form/Setting/UpdateConfigBackend.php | 5 --- CRM/Admin/Form/Setting/Url.php | 7 +--- CRM/Admin/Form/Tag.php | 10 +----- CRM/Admin/Page/AJAX.php | 12 +++---- CRM/Admin/Page/APIExplorer.php | 10 +++--- CRM/Admin/Page/Access.php | 5 ++- CRM/Admin/Page/Admin.php | 6 ++-- CRM/Admin/Page/CKEditorConfig.php | 12 ++++--- CRM/Admin/Page/CMSUser.php | 4 --- CRM/Admin/Page/ConfigTaskList.php | 6 ++-- CRM/Admin/Page/ContactType.php | 10 ++++-- CRM/Admin/Page/EventTemplate.php | 4 --- CRM/Admin/Page/Extensions.php | 9 ----- CRM/Admin/Page/Job.php | 8 +---- CRM/Admin/Page/JobLog.php | 8 +---- CRM/Admin/Page/LabelFormats.php | 6 +--- CRM/Admin/Page/LocationType.php | 4 +-- CRM/Admin/Page/MailSettings.php | 6 +--- CRM/Admin/Page/Mapping.php | 6 +--- CRM/Admin/Page/MessageTemplates.php | 6 +--- CRM/Admin/Page/Navigation.php | 4 +-- CRM/Admin/Page/Options.php | 12 ++----- CRM/Admin/Page/ParticipantStatusType.php | 4 +-- CRM/Admin/Page/PaymentProcessor.php | 8 +---- CRM/Admin/Page/PaymentProcessorType.php | 4 +-- CRM/Admin/Page/PdfFormats.php | 6 +--- CRM/Admin/Page/Persistent.php | 7 ---- CRM/Admin/Page/PreferencesDate.php | 6 +--- CRM/Admin/Page/RelationshipType.php | 4 +-- CRM/Admin/Page/ScheduleReminders.php | 6 +--- CRM/Admin/Page/Setting.php | 6 ++-- CRM/Admin/Page/Tag.php | 4 +-- CRM/Badge/BAO/Badge.php | 10 +----- CRM/Badge/Form/Layout.php | 16 ++------- CRM/Batch/BAO/Batch.php | 7 +--- CRM/Batch/Form/Entry.php | 35 ++++++------------- CRM/Batch/Page/Batch.php | 5 --- CRM/Campaign/BAO/Petition.php | 6 ++-- CRM/Campaign/BAO/Query.php | 8 +---- CRM/Campaign/Form/Campaign.php | 8 +---- CRM/Campaign/Form/Petition/Signature.php | 15 ++------ CRM/Campaign/Form/Search.php | 13 +------ CRM/Campaign/Form/Search/Campaign.php | 9 +---- CRM/Campaign/Form/Search/Petition.php | 9 +---- CRM/Campaign/Form/Search/Survey.php | 9 +---- CRM/Contact/Form/Edit/TagsAndGroups.php | 11 ++---- 77 files changed, 132 insertions(+), 535 deletions(-) diff --git a/CRM/ACL/Form/ACLBasic.php b/CRM/ACL/Form/ACLBasic.php index ce7d7827eab..df58d573c46 100644 --- a/CRM/ACL/Form/ACLBasic.php +++ b/CRM/ACL/Form/ACLBasic.php @@ -30,7 +30,6 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 */ - class CRM_ACL_Form_ACLBasic extends CRM_Admin_Form { /** diff --git a/CRM/Admin/Form/MailSettings.php b/CRM/Admin/Form/MailSettings.php index c76cdc77d08..4365a503c83 100644 --- a/CRM/Admin/Form/MailSettings.php +++ b/CRM/Admin/Form/MailSettings.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -93,9 +89,6 @@ public function buildQuickForm() { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Admin_Form_MailSettings', 'formRule')); @@ -122,9 +115,6 @@ public static function formRule($fields) { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Mapping.php b/CRM/Admin/Form/Mapping.php index 7ba6f0fa630..50284a82950 100644 --- a/CRM/Admin/Form/Mapping.php +++ b/CRM/Admin/Form/Mapping.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Mapping - * + * This class generates form components for Mapping. */ class CRM_Admin_Form_Mapping extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -92,9 +87,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Admin/Form/MessageTemplates.php b/CRM/Admin/Form/MessageTemplates.php index 0e7874440cc..61b1fa25881 100644 --- a/CRM/Admin/Form/MessageTemplates.php +++ b/CRM/Admin/Form/MessageTemplates.php @@ -29,14 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class generates form components for Message templates * used by membership, contributions, event registrations, etc. - * */ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { // which (and whether) mailing workflow this template belongs to @@ -56,10 +53,8 @@ public function preProcess() { /** * Set default values for the form. - * The default values are retrieved from the database. - * * - * @return void + * The default values are retrieved from the database. */ public function setDefaultValues() { $defaults = $this->_values; @@ -110,8 +105,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -202,9 +195,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Navigation.php b/CRM/Admin/Form/Navigation.php index 6c98a0478e4..318e5bfa842 100644 --- a/CRM/Admin/Form/Navigation.php +++ b/CRM/Admin/Form/Navigation.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Navigation - * + * This class generates form components for Navigation. */ class CRM_Admin_Form_Navigation extends CRM_Admin_Form { @@ -46,8 +43,6 @@ class CRM_Admin_Form_Navigation extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -138,9 +133,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Admin/Form/OptionGroup.php b/CRM/Admin/Form/OptionGroup.php index b2839463e9f..df38787996e 100644 --- a/CRM/Admin/Form/OptionGroup.php +++ b/CRM/Admin/Form/OptionGroup.php @@ -29,20 +29,15 @@ * * @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_Admin_Form_OptionGroup extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -102,9 +97,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache(); diff --git a/CRM/Admin/Form/Options.php b/CRM/Admin/Form/Options.php index a546c10e5ec..25db9ff2737 100644 --- a/CRM/Admin/Form/Options.php +++ b/CRM/Admin/Form/Options.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Options - * + * This class generates form components for Options. */ class CRM_Admin_Form_Options extends CRM_Admin_Form { @@ -55,8 +52,6 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { /** * Pre-process - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -115,8 +110,6 @@ public function preProcess() { /** * Set default values for the form. - * - * @return void */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -146,8 +139,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -390,9 +381,6 @@ public static function formRule($fields, $files, $self) { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/ParticipantStatusType.php b/CRM/Admin/Form/ParticipantStatusType.php index bf6f4e7736c..dc7c58aba75 100644 --- a/CRM/Admin/Form/ParticipantStatusType.php +++ b/CRM/Admin/Form/ParticipantStatusType.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Admin_Form_ParticipantStatusType extends CRM_Admin_Form { @@ -41,6 +39,9 @@ public function getDefaultEntity() { return 'ParticipantStatusType'; } + /** + * Build form. + */ public function buildQuickForm() { parent::buildQuickForm(); @@ -71,6 +72,8 @@ public function buildQuickForm() { } /** + * Set default values. + * * @return array */ public function setDefaultValues() { diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index dc9339833ab..e60b390323d 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: PaymentProcessor.php 9702 2007-05-29 23:57:16Z lobo $ - * */ /** - * This class generates form components for Payment Processor - * + * This class generates form components for Payment Processor. */ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { protected $_id = NULL; @@ -165,8 +162,6 @@ public function preProcess() { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -338,9 +333,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return Void */ public function postProcess() { CRM_Utils_System::flushCache('CRM_Financial_DAO_PaymentProcessor'); @@ -367,11 +359,9 @@ public function postProcess() { /** * Save a payment processor. * - * @param $values + * @param array $values * @param int $domainID - * @param $test - * - * @return void + * @param bool $test */ public function updatePaymentProcessor(&$values, $domainID, $test) { $dao = new CRM_Financial_DAO_PaymentProcessor(); diff --git a/CRM/Admin/Form/PaymentProcessorType.php b/CRM/Admin/Form/PaymentProcessorType.php index d53a55326e3..5c4e2e946f3 100644 --- a/CRM/Admin/Form/PaymentProcessorType.php +++ b/CRM/Admin/Form/PaymentProcessorType.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: PaymentProcessorType.php 9702 2007-05-29 23:57:16Z lobo $ - * */ /** - * This class generates form components for Location Type - * + * This class generates form components for Location Type. */ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { protected $_id = NULL; @@ -149,8 +146,6 @@ public function preProcess() { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -206,9 +201,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { CRM_Utils_System::flushCache('CRM_Financial_DAO_PaymentProcessorType'); diff --git a/CRM/Admin/Form/PdfFormats.php b/CRM/Admin/Form/PdfFormats.php index c6f6ef5687a..da53bf5590d 100644 --- a/CRM/Admin/Form/PdfFormats.php +++ b/CRM/Admin/Form/PdfFormats.php @@ -30,13 +30,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for PDF Page Format Settings - * + * This class generates form components for PDF Page Format Settings. */ class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form { @@ -47,8 +44,6 @@ class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -110,9 +105,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Persistent.php b/CRM/Admin/Form/Persistent.php index 3cce900a0b1..cfcdf1b4f71 100644 --- a/CRM/Admin/Form/Persistent.php +++ b/CRM/Admin/Form/Persistent.php @@ -29,15 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * customize the output to meet our specific requirements + * Customize the output to meet our specific requirements. */ class CRM_Admin_Form_Persistent extends CRM_Core_Form { + /** + * Pre-process form. + */ public function preProcess() { $this->_indexID = CRM_Utils_Request::retrieve('id', 'Integer', $this, FALSE); $this->_config = CRM_Utils_Request::retrieve('config', 'Integer', $this, 0); @@ -50,6 +51,8 @@ public function preProcess() { } /** + * Set default values. + * * @return array */ public function setDefaultValues() { diff --git a/CRM/Admin/Form/Preferences.php b/CRM/Admin/Form/Preferences.php index 3d392b2a2d0..ef88e38a5d2 100644 --- a/CRM/Admin/Form/Preferences.php +++ b/CRM/Admin/Form/Preferences.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Base class for settings forms - * + * Base class for settings forms. */ class CRM_Admin_Form_Preferences extends CRM_Core_Form { protected $_system = FALSE; @@ -140,8 +137,6 @@ public function cbsDefaultValues(&$defaults) { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -235,9 +230,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $config = CRM_Core_Config::singleton(); @@ -252,9 +244,6 @@ public function postProcess() { /** * Process the form submission. - * - * - * @return void */ public function postProcessCommon() { foreach ($this->_varNames as $groupName => $groupValues) { diff --git a/CRM/Admin/Form/Preferences/Address.php b/CRM/Admin/Form/Preferences/Address.php index eb6f4ad1877..61617e458fc 100644 --- a/CRM/Admin/Form/Preferences/Address.php +++ b/CRM/Admin/Form/Preferences/Address.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Address Section + * This class generates form components for Address Section. */ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { public function preProcess() { @@ -136,8 +134,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->applyFilter('__ALL__', 'trim'); @@ -180,9 +176,6 @@ public static function formRule($fields) { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action == CRM_Core_Action::VIEW) { diff --git a/CRM/Admin/Form/Preferences/Contribute.php b/CRM/Admin/Form/Preferences/Contribute.php index 29a3ebce3be..d08996cd73e 100644 --- a/CRM/Admin/Form/Preferences/Contribute.php +++ b/CRM/Admin/Form/Preferences/Contribute.php @@ -29,23 +29,18 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for the display preferences - * + * This class generates form components for the display preferences. */ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { protected $_settings = array( 'cvv_backoffice_required' => CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, ); + /** * Process the form submission. - * - * - * @return void */ public function preProcess() { $config = CRM_Core_Config::singleton(); @@ -121,8 +116,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //CRM-16691: Changes made related to settings of 'CVV'. @@ -152,10 +145,8 @@ public function buildQuickForm() { /** * Set default values for the form. - * default values are retrieved from the database - * * - * @return void + * default values are retrieved from the database */ public function setDefaultValues() { $defaults = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings'); @@ -175,9 +166,6 @@ public function setDefaultValues() { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Admin/Form/Preferences/Display.php b/CRM/Admin/Form/Preferences/Display.php index 503582934d4..b164585e704 100644 --- a/CRM/Admin/Form/Preferences/Display.php +++ b/CRM/Admin/Form/Preferences/Display.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: Display.php 45499 2013-02-08 12:31:05Z kurund $ - * */ /** @@ -126,8 +124,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $wysiwyg_options = CRM_Core_OptionGroup::values('wysiwyg_editor', FALSE, FALSE, FALSE, NULL, 'label', TRUE, FALSE, 'name'); @@ -160,9 +156,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action == CRM_Core_Action::VIEW) { diff --git a/CRM/Admin/Form/Preferences/Member.php b/CRM/Admin/Form/Preferences/Member.php index 7a2002fcd16..ad24d2e81d0 100644 --- a/CRM/Admin/Form/Preferences/Member.php +++ b/CRM/Admin/Form/Preferences/Member.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: Display.php 36505 2011-10-03 14:19:56Z lobo $ - * */ /** - * This class generates form components for component preferences - * + * This class generates form components for component preferences. */ class CRM_Admin_Form_Preferences_Member extends CRM_Admin_Form_Preferences { public function preProcess() { @@ -57,8 +54,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); diff --git a/CRM/Admin/Form/PreferencesDate.php b/CRM/Admin/Form/PreferencesDate.php index ec3b413344f..97d6455b862 100644 --- a/CRM/Admin/Form/PreferencesDate.php +++ b/CRM/Admin/Form/PreferencesDate.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_PreferencesDate extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -109,9 +104,6 @@ public static function formRule($fields) { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if (!($this->_action & CRM_Core_Action::UPDATE)) { diff --git a/CRM/Admin/Form/RelationshipType.php b/CRM/Admin/Form/RelationshipType.php index 59ba8b9577b..41d108bf5ba 100644 --- a/CRM/Admin/Form/RelationshipType.php +++ b/CRM/Admin/Form/RelationshipType.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Relationship Type - * + * This class generates form components for Relationship Type. */ class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -135,9 +130,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php index 7c9d82f3189..4e1893e1b4a 100644 --- a/CRM/Admin/Form/ScheduleReminders.php +++ b/CRM/Admin/Form/ScheduleReminders.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Scheduling Reminders - * + * This class generates form components for Scheduling Reminders. */ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { @@ -48,8 +45,6 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -386,9 +381,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php index 0948c65b1a0..3e02107b2c7 100644 --- a/CRM/Admin/Form/Setting.php +++ b/CRM/Admin/Form/Setting.php @@ -29,11 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** - * This class generates form components generic to CiviCRM settings + * This class generates form components generic to CiviCRM settings. */ class CRM_Admin_Form_Setting extends CRM_Core_Form { @@ -167,6 +166,11 @@ public function buildQuickForm() { } } + /** + * Get default entity. + * + * @return string + */ public function getDefaultEntity() { return 'Setting'; } diff --git a/CRM/Admin/Form/Setting/Component.php b/CRM/Admin/Form/Setting/Component.php index 7b1fe225c63..cdcf59be823 100644 --- a/CRM/Admin/Form/Setting/Component.php +++ b/CRM/Admin/Form/Setting/Component.php @@ -29,20 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Component + * This class generates form components for Component. */ class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting { protected $_components; /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Enable Components')); diff --git a/CRM/Admin/Form/Setting/Date.php b/CRM/Admin/Form/Setting/Date.php index 575997e204a..fa068d993df 100644 --- a/CRM/Admin/Form/Setting/Date.php +++ b/CRM/Admin/Form/Setting/Date.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Date Formatting - * + * This class generates form components for Date Formatting. */ class CRM_Admin_Form_Setting_Date extends CRM_Admin_Form_Setting { @@ -48,8 +45,6 @@ class CRM_Admin_Form_Setting_Date extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Date')); diff --git a/CRM/Admin/Form/Setting/Debugging.php b/CRM/Admin/Form/Setting/Debugging.php index b88f2f61372..3c718484bcb 100644 --- a/CRM/Admin/Form/Setting/Debugging.php +++ b/CRM/Admin/Form/Setting/Debugging.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Error Handling and Debugging - * + * This class generates form components for Error Handling and Debugging. */ class CRM_Admin_Form_Setting_Debugging extends CRM_Admin_Form_Setting { @@ -47,8 +44,6 @@ class CRM_Admin_Form_Setting_Debugging extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts(' Settings - Debugging and Error Handling ')); diff --git a/CRM/Admin/Form/Setting/Localization.php b/CRM/Admin/Form/Setting/Localization.php index 75f1c6deaf9..5921e982753 100644 --- a/CRM/Admin/Form/Setting/Localization.php +++ b/CRM/Admin/Form/Setting/Localization.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Localization - * + * This class generates form components for Localization. */ class CRM_Admin_Form_Setting_Localization extends CRM_Admin_Form_Setting { // use this variable to store mappings that we compute in buildForm and also @@ -44,8 +41,6 @@ class CRM_Admin_Form_Setting_Localization extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Admin/Form/Setting/Mail.php b/CRM/Admin/Form/Setting/Mail.php index add51c219ae..e78d5daf4fa 100644 --- a/CRM/Admin/Form/Setting/Mail.php +++ b/CRM/Admin/Form/Setting/Mail.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for CiviMail + * This class generates form components for CiviMail. */ class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting { @@ -44,8 +42,6 @@ class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - CiviMail')); diff --git a/CRM/Admin/Form/Setting/Mapping.php b/CRM/Admin/Form/Setting/Mapping.php index c4c4ebd3d78..4eb31dd7d9a 100644 --- a/CRM/Admin/Form/Setting/Mapping.php +++ b/CRM/Admin/Form/Setting/Mapping.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Mapping and Geocoding - * + * This class generates form components for Mapping and Geocoding. */ class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Mapping and Geocoding Providers')); @@ -85,10 +80,9 @@ public static function formRule($fields) { } /** - * add the rules (mainly global rules) for form. - * All local rules are added near the element + * Add the rules (mainly global rules) for form. * - * @return void + * All local rules are added near the element */ public function addRules() { $this->addFormRule(array('CRM_Admin_Form_Setting_Mapping', 'formRule')); diff --git a/CRM/Admin/Form/Setting/Miscellaneous.php b/CRM/Admin/Form/Setting/Miscellaneous.php index a27a28351e1..1f78d8a22f1 100644 --- a/CRM/Admin/Form/Setting/Miscellaneous.php +++ b/CRM/Admin/Form/Setting/Miscellaneous.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Miscellaneous - * + * This class generates form components for Miscellaneous. */ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting { @@ -68,8 +65,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Misc (Undelete, PDFs, Limits, Logging, Captcha, etc.)')); diff --git a/CRM/Admin/Form/Setting/Path.php b/CRM/Admin/Form/Setting/Path.php index 5e792cd7886..f33b15a57e5 100644 --- a/CRM/Admin/Form/Setting/Path.php +++ b/CRM/Admin/Form/Setting/Path.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for File System Path - * + * This class generates form components for File System Path. */ class CRM_Admin_Form_Setting_Path extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Upload Directories')); diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index 4a7759f0fe3..f0a4174d638 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -29,21 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Smtp Server - * + * This class generates form components for Smtp Server. */ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { protected $_testButtonName; /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -76,9 +71,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // flush caches so we reload details for future requests @@ -243,10 +235,6 @@ public static function formRule($fields) { /** * Set default values for the form. - * default values are retrieved from the database - * - * - * @return void */ public function setDefaultValues() { if (!$this->_defaults) { diff --git a/CRM/Admin/Form/Setting/UF.php b/CRM/Admin/Form/Setting/UF.php index 87fe17b3d65..391a0716783 100644 --- a/CRM/Admin/Form/Setting/UF.php +++ b/CRM/Admin/Form/Setting/UF.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Site Url - * + * This class generates form components for Site Url. */ class CRM_Admin_Form_Setting_UF extends CRM_Admin_Form_Setting { @@ -45,8 +42,6 @@ class CRM_Admin_Form_Setting_UF extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Admin/Form/Setting/UpdateConfigBackend.php b/CRM/Admin/Form/Setting/UpdateConfigBackend.php index 0e71709a7b8..07d612a4e56 100644 --- a/CRM/Admin/Form/Setting/UpdateConfigBackend.php +++ b/CRM/Admin/Form/Setting/UpdateConfigBackend.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class generates form components for Error Handling and Debugging - * */ class CRM_Admin_Form_Setting_UpdateConfigBackend extends CRM_Admin_Form_Setting { protected $_oldBaseDir; @@ -44,8 +41,6 @@ class CRM_Admin_Form_Setting_UpdateConfigBackend extends CRM_Admin_Form_Setting /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Cleanup Caches and Update Paths')); diff --git a/CRM/Admin/Form/Setting/Url.php b/CRM/Admin/Form/Setting/Url.php index 8424127a717..4dbcf9eb49a 100644 --- a/CRM/Admin/Form/Setting/Url.php +++ b/CRM/Admin/Form/Setting/Url.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Site Url - * + * This class generates form components for Site Url. */ class CRM_Admin_Form_Setting_Url extends CRM_Admin_Form_Setting { protected $_settings = array( @@ -44,8 +41,6 @@ class CRM_Admin_Form_Setting_Url extends CRM_Admin_Form_Setting { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Settings - Resource URLs')); diff --git a/CRM/Admin/Form/Tag.php b/CRM/Admin/Form/Tag.php index 207278133bd..af18b37b7f7 100644 --- a/CRM/Admin/Form/Tag.php +++ b/CRM/Admin/Form/Tag.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Tag - * + * This class generates form components for Tag. */ class CRM_Admin_Form_Tag extends CRM_Admin_Form { protected $_isTagSet; @@ -49,8 +46,6 @@ public function getDefaultEntity() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->setPageTitle($this->_isTagSet ? ts('Tag Set') : ts('Tag')); @@ -137,9 +132,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $params = $ids = array(); diff --git a/CRM/Admin/Page/AJAX.php b/CRM/Admin/Page/AJAX.php index c59168c69bc..64cfb8e34b0 100644 --- a/CRM/Admin/Page/AJAX.php +++ b/CRM/Admin/Page/AJAX.php @@ -29,17 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class contains all the function that are called using AJAX + * This class contains all the function that are called using AJAX. */ class CRM_Admin_Page_AJAX { /** - * CRM-12337 Output navigation menu as executable javascript + * CRM-12337 Output navigation menu as executable javascript. + * * @see smarty_function_crmNavigationMenu */ public static function getNavigationMenu() { @@ -62,15 +61,14 @@ public static function getNavigationList() { } /** - * Process drag/move action for menu tree + * Process drag/move action for menu tree. */ public static function menuTree() { CRM_Core_BAO_Navigation::processNavigation($_GET); } /** - * Build status message while. - * enabling/ disabling various objects + * Build status message while enabling/ disabling various objects. */ public static function getStatusMsg() { require_once 'api/v3/utils.php'; diff --git a/CRM/Admin/Page/APIExplorer.php b/CRM/Admin/Page/APIExplorer.php index 705f40df71a..0df6d0c9e2a 100644 --- a/CRM/Admin/Page/APIExplorer.php +++ b/CRM/Admin/Page/APIExplorer.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -39,6 +37,8 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { /** + * Run page. + * * @return string */ public function run() { @@ -73,7 +73,7 @@ public function userContext() { } /** - * AJAX callback to fetch examples + * AJAX callback to fetch examples. */ public static function getExampleFile() { global $civicrm_root; @@ -102,7 +102,7 @@ public static function getExampleFile() { } /** - * Ajax callback to display code docs + * Ajax callback to display code docs. */ public static function getDoc() { // Verify the API handler we're talking to is valid. @@ -126,6 +126,8 @@ public static function getDoc() { } /** + * Get documentation block. + * * @param string $entity * @param string|null $action * @return array|bool diff --git a/CRM/Admin/Page/Access.php b/CRM/Admin/Page/Access.php index dcbd04255af..e7fa0e7bf0d 100644 --- a/CRM/Admin/Page/Access.php +++ b/CRM/Admin/Page/Access.php @@ -29,12 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Dashboard page for managing Access Control + * Dashboard page for managing Access Control. + * * For initial version, this page only contains static links - so this class is empty for now. */ class CRM_Admin_Page_Access extends CRM_Core_Page { diff --git a/CRM/Admin/Page/Admin.php b/CRM/Admin/Page/Admin.php index 2ccf4770e60..d9985c9c08a 100644 --- a/CRM/Admin/Page/Admin.php +++ b/CRM/Admin/Page/Admin.php @@ -29,15 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying Administer CiviCRM Control Panel + * Page for displaying Administer CiviCRM Control Panel. */ class CRM_Admin_Page_Admin extends CRM_Core_Page { /** + * Run page. + * * @return string */ public function run() { diff --git a/CRM/Admin/Page/CKEditorConfig.php b/CRM/Admin/Page/CKEditorConfig.php index bd46f6515db..ad59a2b37b1 100644 --- a/CRM/Admin/Page/CKEditorConfig.php +++ b/CRM/Admin/Page/CKEditorConfig.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for configuring CKEditor options + * Page for configuring CKEditor options. * * Note that while this is implemented as a CRM_Core_Page, it is actually a form. * Because the form needs to be submitted and refreshed via javascrit, it seemed like @@ -55,6 +53,8 @@ class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page { ); /** + * Run page. + * * @return string */ public function run() { @@ -121,6 +121,8 @@ public function save($params) { } /** + * Get CKEditor plugins. + * * @return array */ private function getCKPlugins() { @@ -155,6 +157,8 @@ private function getCKPlugins() { } /** + * Get CK Editor skins. + * * @return array */ private function getCKSkins() { @@ -223,7 +227,7 @@ public static function saveConfigFile($contents) { } /** - * Delete self::CONFIG_FILENAME + * Delete config file. */ public static function deleteConfigFile() { $file = self::getConfigFile(); diff --git a/CRM/Admin/Page/CMSUser.php b/CRM/Admin/Page/CMSUser.php index f276ed75944..6c7b3c56b20 100644 --- a/CRM/Admin/Page/CMSUser.php +++ b/CRM/Admin/Page/CMSUser.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -44,8 +42,6 @@ class CRM_Admin_Page_CMSUser extends CRM_Core_Page { * 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() { //if javascript is enabled diff --git a/CRM/Admin/Page/ConfigTaskList.php b/CRM/Admin/Page/ConfigTaskList.php index b0fa9403244..016fc2dd01a 100644 --- a/CRM/Admin/Page/ConfigTaskList.php +++ b/CRM/Admin/Page/ConfigTaskList.php @@ -29,15 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of site configuration tasks with links to each setting form + * Page for displaying list of site configuration tasks with links to each setting form. */ class CRM_Admin_Page_ConfigTaskList extends CRM_Core_Page { /** + * Run page. + * * @return string */ public function run() { diff --git a/CRM/Admin/Page/ContactType.php b/CRM/Admin/Page/ContactType.php index fb5d6bfc854..9da8ab50b34 100644 --- a/CRM/Admin/Page/ContactType.php +++ b/CRM/Admin/Page/ContactType.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of contact Subtypes + * Page for displaying list of contact Subtypes. */ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { @@ -93,6 +91,9 @@ public function &links() { return self::$_links; } + /** + * Run page. + */ public function run() { $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 0); $this->assign('action', $action); @@ -103,6 +104,9 @@ public function run() { return parent::run(); } + /** + * Browse contact types. + */ public function browse() { $rows = CRM_Contact_BAO_ContactType::contactTypeInfo(TRUE); foreach ($rows as $key => $value) { diff --git a/CRM/Admin/Page/EventTemplate.php b/CRM/Admin/Page/EventTemplate.php index 34e18a05d0d..84a7bcae690 100644 --- a/CRM/Admin/Page/EventTemplate.php +++ b/CRM/Admin/Page/EventTemplate.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -85,8 +83,6 @@ public function &links() { /** * Browse all event templates. - * - * @return void */ public function browse() { //get all event templates. diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php index b2214983617..74644323dc3 100644 --- a/CRM/Admin/Page/Extensions.php +++ b/CRM/Admin/Page/Extensions.php @@ -30,8 +30,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -48,8 +46,6 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Obtains the group name from url and sets the title. - * - * @return void */ public function preProcess() { CRM_Utils_System::setTitle(ts('CiviCRM Extensions')); @@ -117,8 +113,6 @@ public function &links() { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -127,9 +121,6 @@ public function run() { /** * Browse all options. - * - * - * @return void */ public function browse() { $mapper = CRM_Extension_System::singleton()->getMapper(); diff --git a/CRM/Admin/Page/Job.php b/CRM/Admin/Page/Job.php index e2671f80215..750e9dc5787 100644 --- a/CRM/Admin/Page/Job.php +++ b/CRM/Admin/Page/Job.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of jobs + * Page for displaying list of jobs. */ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { @@ -109,8 +107,6 @@ public function &links() { * 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() { // set title and breadcrumb @@ -144,8 +140,6 @@ public function run() { * Browse all jobs. * * @param null $action - * - * @return void */ public function browse($action = NULL) { diff --git a/CRM/Admin/Page/JobLog.php b/CRM/Admin/Page/JobLog.php index 9ad36bcfa29..fd19c181003 100644 --- a/CRM/Admin/Page/JobLog.php +++ b/CRM/Admin/Page/JobLog.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of jobs + * Page for displaying list of jobs. */ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { @@ -71,8 +69,6 @@ public function &links() { * 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() { // set title and breadcrumb @@ -93,8 +89,6 @@ public function run() { * Browse all jobs. * * @param null $action - * - * @return void */ public function browse($action = NULL) { diff --git a/CRM/Admin/Page/LabelFormats.php b/CRM/Admin/Page/LabelFormats.php index c93e6a637ca..e9e8a0ce65f 100644 --- a/CRM/Admin/Page/LabelFormats.php +++ b/CRM/Admin/Page/LabelFormats.php @@ -30,12 +30,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of Label Formats + * Page for displaying list of Label Formats. */ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { @@ -128,8 +126,6 @@ public function userContext($mode = NULL) { * Browse all Label Format settings. * * @param null $action - * - * @return void */ public function browse($action = NULL) { // Get list of configured Label Formats diff --git a/CRM/Admin/Page/LocationType.php b/CRM/Admin/Page/LocationType.php index 91d0067dbe3..ce38c28476e 100644 --- a/CRM/Admin/Page/LocationType.php +++ b/CRM/Admin/Page/LocationType.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of location types + * Page for displaying list of location types. */ class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic { diff --git a/CRM/Admin/Page/MailSettings.php b/CRM/Admin/Page/MailSettings.php index 8778b07e839..2bf6c4893b3 100644 --- a/CRM/Admin/Page/MailSettings.php +++ b/CRM/Admin/Page/MailSettings.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of Mail account settings + * Page for displaying list of Mail account settings. */ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { @@ -87,8 +85,6 @@ public function &links() { /** * Browse all mail settings. - * - * @return void */ public function browse() { //get all mail settings. diff --git a/CRM/Admin/Page/Mapping.php b/CRM/Admin/Page/Mapping.php index 2a474b5d7df..0aa0b2c81b1 100644 --- a/CRM/Admin/Page/Mapping.php +++ b/CRM/Admin/Page/Mapping.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of categories + * Page for displaying list of categories. */ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { @@ -139,8 +137,6 @@ public function deleteForm() { /** * Run the basic page. - * - * @return void */ public function run() { $sort = 'mapping_type asc'; diff --git a/CRM/Admin/Page/MessageTemplates.php b/CRM/Admin/Page/MessageTemplates.php index 665ac43f74b..3a6c203bf43 100644 --- a/CRM/Admin/Page/MessageTemplates.php +++ b/CRM/Admin/Page/MessageTemplates.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of message templates + * Page for displaying list of message templates. */ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { @@ -241,8 +239,6 @@ public function userContext($mode = NULL) { /** * Browse all entities. - * - * @return void */ public function browse() { $action = func_num_args() ? func_get_arg(0) : NULL; diff --git a/CRM/Admin/Page/Navigation.php b/CRM/Admin/Page/Navigation.php index ee21dc34fde..b7a301c1730 100644 --- a/CRM/Admin/Page/Navigation.php +++ b/CRM/Admin/Page/Navigation.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of location types + * Page for displaying list of location types. */ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic { diff --git a/CRM/Admin/Page/Options.php b/CRM/Admin/Page/Options.php index e6c61877ba6..cc9d9b8d10b 100644 --- a/CRM/Admin/Page/Options.php +++ b/CRM/Admin/Page/Options.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_Admin_Page_Options extends CRM_Core_Page_Basic { @@ -77,9 +75,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Obtains the group name from url string or id from $_GET['gid']. - * Sets the title. * - * @return void + * Sets the title. */ public function preProcess() { if (!self::$_gName && !empty($this->urlPath[3])) { @@ -221,8 +218,6 @@ public function &links() { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -231,9 +226,6 @@ public function run() { /** * Browse all options. - * - * - * @return void */ public function browse() { if (!self::$_gName) { diff --git a/CRM/Admin/Page/ParticipantStatusType.php b/CRM/Admin/Page/ParticipantStatusType.php index 9497840e77e..687bba55191 100644 --- a/CRM/Admin/Page/ParticipantStatusType.php +++ b/CRM/Admin/Page/ParticipantStatusType.php @@ -29,14 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Admin_Page_ParticipantStatusType extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** + * Get BAO name. + * * @return string */ public function getBAOName() { diff --git a/CRM/Admin/Page/PaymentProcessor.php b/CRM/Admin/Page/PaymentProcessor.php index 39530a93e5b..d6ee3042b84 100644 --- a/CRM/Admin/Page/PaymentProcessor.php +++ b/CRM/Admin/Page/PaymentProcessor.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of payment processors + * Page for displaying list of payment processors. */ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { @@ -97,8 +95,6 @@ public function &links() { * 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() { // set title and breadcrumb @@ -125,8 +121,6 @@ public function run() { * Browse all payment processors. * * @param null $action - * - * @return void */ public function browse($action = NULL) { // get all custom groups sorted by weight diff --git a/CRM/Admin/Page/PaymentProcessorType.php b/CRM/Admin/Page/PaymentProcessorType.php index b7da659cd53..ef657679148 100644 --- a/CRM/Admin/Page/PaymentProcessorType.php +++ b/CRM/Admin/Page/PaymentProcessorType.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of payment processors + * Page for displaying list of payment processors. */ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic { diff --git a/CRM/Admin/Page/PdfFormats.php b/CRM/Admin/Page/PdfFormats.php index 90299ce86fc..57e9396be53 100644 --- a/CRM/Admin/Page/PdfFormats.php +++ b/CRM/Admin/Page/PdfFormats.php @@ -30,12 +30,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of PDF Page Formats + * Page for displaying list of PDF Page Formats. */ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { @@ -122,8 +120,6 @@ public function userContext($mode = NULL) { * Browse all PDF Page Formats. * * @param null $action - * - * @return void */ public function browse($action = NULL) { // Get list of configured PDF Page Formats diff --git a/CRM/Admin/Page/Persistent.php b/CRM/Admin/Page/Persistent.php index dafe746fd1f..e562780e1b4 100644 --- a/CRM/Admin/Page/Persistent.php +++ b/CRM/Admin/Page/Persistent.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -89,8 +87,6 @@ public function &customizeActionLinks() { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { CRM_Utils_System::setTitle(ts('DB Template Strings')); @@ -100,9 +96,6 @@ public function run() { /** * Browse all options. - * - * - * @return void */ public function browse() { $permission = FALSE; diff --git a/CRM/Admin/Page/PreferencesDate.php b/CRM/Admin/Page/PreferencesDate.php index e58996a2527..698773a5e04 100644 --- a/CRM/Admin/Page/PreferencesDate.php +++ b/CRM/Admin/Page/PreferencesDate.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of location types + * Page for displaying list of location types. */ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { @@ -81,8 +79,6 @@ public function &links() { * 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() { // set title and breadcrumb diff --git a/CRM/Admin/Page/RelationshipType.php b/CRM/Admin/Page/RelationshipType.php index 7bb943f3215..7f35a0c1c63 100644 --- a/CRM/Admin/Page/RelationshipType.php +++ b/CRM/Admin/Page/RelationshipType.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of relationship types + * Page for displaying list of relationship types. */ class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic { diff --git a/CRM/Admin/Page/ScheduleReminders.php b/CRM/Admin/Page/ScheduleReminders.php index f53cbc512f5..90f89f2e3b5 100644 --- a/CRM/Admin/Page/ScheduleReminders.php +++ b/CRM/Admin/Page/ScheduleReminders.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of Reminders + * Page for displaying list of Reminders. */ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { @@ -131,8 +129,6 @@ public function userContext($mode = NULL) { * Browse all Scheduled Reminders settings. * * @param null $action - * - * @return void */ public function browse($action = NULL) { //CRM-16777: Do not permit access to user, for page 'Administer->Communication->Schedule Reminder', diff --git a/CRM/Admin/Page/Setting.php b/CRM/Admin/Page/Setting.php index a86f94b322a..55de3446b84 100644 --- a/CRM/Admin/Page/Setting.php +++ b/CRM/Admin/Page/Setting.php @@ -29,15 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of categories for Settings + * Page for displaying list of categories for Settings. */ class CRM_Admin_Page_Setting extends CRM_Core_Page { /** + * Run page. + * * @return string * @throws Exception */ diff --git a/CRM/Admin/Page/Tag.php b/CRM/Admin/Page/Tag.php index 4e4b1dcd042..6742447ffda 100644 --- a/CRM/Admin/Page/Tag.php +++ b/CRM/Admin/Page/Tag.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying list of categories + * Page for displaying list of categories. */ class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic { diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index 70f179a6f0a..741b357f40a 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -27,12 +27,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Class CRM_Badge_Format_Badge + * Class CRM_Badge_Format_Badge. * * parent class for building name badges */ @@ -49,8 +47,6 @@ class CRM_Badge_BAO_Badge { * Associated array with participant info. * @param array $layoutInfo * Associated array which contains meta data about format/layout. - * - * @return void */ public function createLabels(&$participants, &$layoutInfo) { $this->pdf = new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm'); @@ -365,8 +361,6 @@ public function labelCreator(&$formattedRow, $cellspacing = 0) { * @param string $y * @param null $w * @param null $h - * - * @return void */ public function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) { if (!$x) { @@ -409,8 +403,6 @@ public static function getImageProperties($img, $imgRes = 300, $w = NULL, $h = N * @param array $params * Associated array of submitted values. * @param CRM_Core_Form $form - * - * @return void */ public static function buildBadges(&$params, &$form) { // get name badge layout info diff --git a/CRM/Badge/Form/Layout.php b/CRM/Badge/Form/Layout.php index 5c9a195d88e..6f0fbaa3f51 100644 --- a/CRM/Badge/Form/Layout.php +++ b/CRM/Badge/Form/Layout.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for name badge layout - * + * This class generates form components for name badge layout. */ class CRM_Badge_Form_Layout extends CRM_Admin_Form { @@ -43,8 +40,6 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { if ($this->_action & CRM_Core_Action::DELETE) { @@ -154,11 +149,7 @@ public function buildQuickForm() { } /** - * Set default values for the form. MobileProvider that in edit/view mode - * the default values are retrieved from the database - * - * - * @return void + * Set default values for the form. */ public function setDefaultValues() { if (isset($this->_id)) { @@ -183,9 +174,6 @@ public function setDefaultValues() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index 9861b4bfd60..e6ab88ba1da 100755 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * + * Batch BAO class. */ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { @@ -575,9 +573,6 @@ public static function displayTotals($actual, $expected) { * Associated array of batch ids. * @param string $exportFormat * Export format. - * - * @return void - * */ public static function exportFinancialBatch($batchIds, $exportFormat) { if (empty($batchIds)) { diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index 996a7f26d89..73f5610b807 100755 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality for batch entry for contributions/memberships + * This class provides the functionality for batch entry for contributions/memberships. */ class CRM_Batch_Form_Entry extends CRM_Core_Form { @@ -86,8 +84,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_batchId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE); @@ -114,9 +110,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { if (!$this->_profileId) { @@ -356,9 +349,6 @@ public function cancelAction() { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { if (empty($this->_fields)) { @@ -397,9 +387,6 @@ public function setDefaultValues() { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); @@ -436,8 +423,7 @@ public function postProcess() { * @param array $params * Associated array of submitted values. * - * - * @return void + * @return bool */ private function processContribution(&$params) { $dates = array( @@ -859,9 +845,6 @@ private function processMembership(&$params) { * * @param array $value * Associated array of submitted values. - * - * - * @return void */ private function updateContactInfo(&$value) { $value['preserveDBName'] = $this->_preserveDefault; @@ -875,9 +858,10 @@ private function updateContactInfo(&$value) { } /** - * Function exists purely for unit testing purposes. If you feel tempted to use this in live code - * then it probably means there is some functionality that needs to be moved - * out of the form layer + * Function exists purely for unit testing purposes. + * + * If you feel tempted to use this in live code then it probably means there is some functionality + * that needs to be moved out of the form layer * * @param array $params * @@ -888,9 +872,10 @@ public function testProcessMembership($params) { } /** - * Function exists purely for unit testing purposes. If you feel tempted to use this in live code - * then it probably means there is some functionality that needs to be moved - * out of the form layer + * Function exists purely for unit testing purposes. + * + * If you feel tempted to use this in live code then it probably means there is some functionality + * that needs to be moved out of the form layer. * * @param array $params * diff --git a/CRM/Batch/Page/Batch.php b/CRM/Batch/Page/Batch.php index a7cd8657a4f..932b3c424cf 100644 --- a/CRM/Batch/Page/Batch.php +++ b/CRM/Batch/Page/Batch.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -57,7 +55,6 @@ public function getBAOName() { /** * Get action Links. - * */ public function &links() { } @@ -96,8 +93,6 @@ public function userContext($mode = NULL) { /** * Browse all entities. - * - * @return void */ public function browse() { $status = CRM_Utils_Request::retrieve('status', 'Positive', CRM_Core_DAO::$_nullObject, FALSE, 1); diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index e127d4c245c..c1ac5c01c13 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -29,11 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey { /** + * Class constructor. */ public function __construct() { parent::__construct(); @@ -536,10 +535,9 @@ public static function checkSignature($surveyId, $contactId) { * @param array $params * (reference ) an assoc array of name/value pairs. * - * @param $sendEmailMode + * @param int $sendEmailMode * * @throws Exception - * @return void */ public static function sendEmail($params, $sendEmailMode) { diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 1066794f666..78b653f1b00 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_BAO_Query { //since normal activity clause clause get collides. @@ -65,9 +63,7 @@ public static function &getFields() { /** * If survey, campaign are involved, add the specific fields. * - * @param $query - * - * @return void + * @param CRM_Contact_BAO_Contact $query */ public static function select(&$query) { self::$_applySurveyClause = FALSE; @@ -337,9 +333,7 @@ public static function info(&$tables) { * Add all the elements shared between, * normal voter search and voter listing (GOTV form) * - * * @param CRM_Core_Form $form - * @return void */ public static function buildSearchForm(&$form) { diff --git a/CRM/Campaign/Form/Campaign.php b/CRM/Campaign/Form/Campaign.php index c32e985461a..c9eaaf7076d 100644 --- a/CRM/Campaign/Form/Campaign.php +++ b/CRM/Campaign/Form/Campaign.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a campaign - * + * This class generates form components for processing a campaign. */ class CRM_Campaign_Form_Campaign extends CRM_Core_Form { @@ -294,9 +291,6 @@ public static function formRule($fields, $files, $errors) { /** * Form submission of new/edit campaign is processed. - * - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index 3e0441893ea..b4c9c190232 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing a petition signature - * + * This class generates form components for processing a petition signature. */ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { const EMAIL_THANK = 1, EMAIL_CONFIRM = 2, MODE_CREATE = 4; @@ -232,9 +229,6 @@ public function preProcess() { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { $this->_defaults = array(); @@ -320,8 +314,8 @@ public function buildQuickForm() { * @param $files * @param $errors * - * @return void * @see valid_date + * @return array|bool */ public static function formRule($fields, $files, $errors) { $errors = array(); @@ -331,9 +325,6 @@ public static function formRule($fields, $files, $errors) { /** * Form submission of petition signature. - * - * - * @return void */ public function postProcess() { $tag_name = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CAMPAIGN_PREFERENCES_NAME, @@ -577,8 +568,6 @@ public function postProcess() { * @param int $id * @param string $name * @param bool $viewOnly - * - * @return void */ public function buildCustom($id, $name, $viewOnly = FALSE) { if ($id) { diff --git a/CRM/Campaign/Form/Search.php b/CRM/Campaign/Form/Search.php index 99f053546bd..d223b29d264 100755 --- a/CRM/Campaign/Form/Search.php +++ b/CRM/Campaign/Form/Search.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Files required + * Files required. */ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { @@ -69,8 +67,6 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->_done = FALSE; @@ -193,9 +189,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -250,10 +243,6 @@ public function buildQuickForm() { * done. * The processing consists of using a Selector / Controller framework for getting the * search results. - * - * @param - * - * @return void */ public function postProcess() { if ($this->_done) { diff --git a/CRM/Campaign/Form/Search/Campaign.php b/CRM/Campaign/Form/Search/Campaign.php index e58849f8862..af36fd26456 100755 --- a/CRM/Campaign/Form/Search/Campaign.php +++ b/CRM/Campaign/Form/Search/Campaign.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Files required + * Files required. */ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { @@ -47,8 +45,6 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->_search = CRM_Utils_Array::value('search', $_GET); @@ -70,9 +66,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { if ($this->_search) { diff --git a/CRM/Campaign/Form/Search/Petition.php b/CRM/Campaign/Form/Search/Petition.php index f8eea7218ba..4ca5509444f 100755 --- a/CRM/Campaign/Form/Search/Petition.php +++ b/CRM/Campaign/Form/Search/Petition.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Files required + * Files required. */ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { @@ -47,8 +45,6 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->_search = CRM_Utils_Array::value('search', $_GET); @@ -69,9 +65,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { if ($this->_search) { diff --git a/CRM/Campaign/Form/Search/Survey.php b/CRM/Campaign/Form/Search/Survey.php index ceb4405953d..e1d1bfc045d 100755 --- a/CRM/Campaign/Form/Search/Survey.php +++ b/CRM/Campaign/Form/Search/Survey.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Files required + * Files required. */ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { @@ -47,8 +45,6 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->_search = CRM_Utils_Array::value('search', $_GET); @@ -70,9 +66,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { if ($this->_search) { diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index db0ad58fba3..a8d462468ac 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Edit_TagsAndGroups { @@ -42,8 +40,7 @@ class CRM_Contact_Form_Edit_TagsAndGroups { const GROUP = 1, TAG = 2, ALL = 3; /** - * build form elements. - * params object $form object of the form + * Build form elements. * * @param CRM_Core_Form $form * The form object that we are operating on. @@ -228,8 +225,6 @@ public static function climbtree($form, $tree, &$elements) { * This is used in batch profile(i.e to build multiple blocks). * * @param string $groupElementType - * - * @return void */ public static function setDefaults($id, &$defaults, $type = self::ALL, $fieldName = NULL, $groupElementType = 'checkbox') { $type = (int ) $type; @@ -273,9 +268,7 @@ public static function setDefaults($id, &$defaults, $type = self::ALL, $fieldNam * * * @param CRM_Core_Form $form - * @param $defaults - * - * @return void + * @param array $defaults */ public static function setDefaultValues(&$form, &$defaults) { $contactEditOptions = $form->get('contactEditOptions'); From 3819f101d96db96af5a43d0a21e41b2639c6cb74 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:16:35 +1200 Subject: [PATCH 3/5] 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 3674629ec41..c8434450aa5 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 ea00a200703..1277fe4c9ed 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 fa9cd656c1e..2ff804ca227 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 7cbd0850a39..bfe68b49d73 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 4c28eea2920..20a66fc1d08 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 f47b2b28e45..be0ead74d43 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 6ce714310ee..9de897ad60c 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 a451f5e65cf..ba08fba8ca7 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 85f35a5f564..14582daa7b6 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 6d404ad3922..a9899a12521 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 1ba55ce65bb..3cdd386232a 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 88f8a2547d5..07053d4d6dd 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 f86ada89e02..a8686829bf5 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 8b677634c23..036cfdd0409 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 1181f03c1e0..dbac346b6e7 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 662afe14483..e2bbf895a8b 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 f6baf0fe1f0..0f8eea0c411 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 6c15cef550b..953e96ae258 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 dffc7bc37b2..070de44dee9 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 d8c405b0d1b..b39b54d771a 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 e122d9258fa..492dccd8b26 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 a3d9c21ff0a..61ca13475e0 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 3831fe4d988..3bf89bfa10d 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 8a9a123f8cc..7ebc9887f0d 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 @@ public function preProcess() { /** * 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 aee73129f64..ac3db7c2c23 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 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( @@ -93,8 +87,6 @@ public function buildQuickForm() { /** * 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 de31df619cb..323664c8fa3 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -179,8 +174,6 @@ public function buildQuickForm() { /** * 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 cd8048830c8..d0869b3247d 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 @@ public function setDefaultValues() { /** * 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 @@ public function buildQuickForm() { /** * 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 470bad8de4f..728fcf2ecc3 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 @@ public function preProcess() { } /** - * 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $optionGroups = CRM_Campaign_BAO_Survey::getResultSets(); @@ -345,8 +341,6 @@ public static function formRule($fields, $files, $form) { /** * 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 2ba88b6a6a2..a2dc62db542 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -143,9 +136,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index 0ac3114ee70..bb5752067f7 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 @@ public function setContactIDs() { * 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 1a8d4b60076..4247adb6978 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 @@ public function validateIds() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->assign('surveyTypeId', $this->_surveyTypeId); @@ -387,9 +380,6 @@ public function buildQuickForm() { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { //load default data for only contact fields. @@ -442,9 +432,6 @@ public function setDefaultValues() { /** * 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 2005374d4da..4ede318e252 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 @@ public function preProcess() { } /** - * 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 @@ public function buildQuickForm() { /** * 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 fe1b4860aec..59abf6d3e2f 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 @@ public function preProcess() { /** * 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 f5596db1773..817b67e8988 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 @@ public function validateSurvey() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // allow to add contact to either new or existing group. @@ -240,10 +232,7 @@ public static function formRule($fields, $files, $self) { /** * 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 ee91ef00af2..fcbebf5b471 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 6c5d60e7c99..a873a40de57 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 @@ public function &links() { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -146,9 +140,6 @@ public function run() { /** * 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 521ba5894d4..0d3b5337ca1 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 @@ public static function deleteCase($caseId, $moveToTrash = FALSE) { * Case id. * @param bool $enable * Action. - * - * @return void */ public static function enableDisableCaseRelationships($caseId, $enable) { $contactIds = self::retrieveContactIdsByCaseId($caseId); @@ -409,8 +405,6 @@ public static function enableDisableCaseRelationships($caseId, $enable) { * * @param int $activityId * Id of the activity. - * - * @return void */ public static function deleteCaseActivity($activityId) { $case = new CRM_Case_DAO_CaseActivity(); @@ -1447,7 +1441,7 @@ public static function getRelatedContacts($caseID, $skipDetails = FALSE) { * @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 @@ public static function getCaseActivityDates($caseID, $criteriaParams = array(), * @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 @@ public static function mergeCases( * 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 @@ public static function createCaseViewsQuery($section = 'upcoming') { * 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 c0be5a257d3..de28c1ad5b9 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 @@ public static function &getFields($excludeActivityFields = FALSE) { * 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 @@ public static function select(&$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 @@ public static function where(&$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 @@ public static function tableNames(&$tables) { } /** - * 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 4dc5365c62d..55a6b70d0c2 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 @@ public function preProcess() { } /** - * 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 @@ public static function formRule($fields, $files, $self) { /** * 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 d33ac581e80..07889baffbe 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 @@ public static function preProcess(&$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. * + * 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 @@ public static function formRule($values, $files, $form) { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'case') { @@ -138,8 +133,6 @@ public static function beginPostProcess(&$form, &$params) { * @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 8af8f0b2573..fe0a699e117 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 @@ public static function preProcess(&$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. + * + * 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 @@ public static function formRule($values, $files, $form) { * * @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 @@ public static function beginPostProcess(&$form, &$params) { * * @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 aa40ad2af5c..1d617db5a67 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 @@ public static function preProcess(&$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. * + * 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 @@ public static function formRule($values, $files, $form) { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'case') { @@ -143,8 +138,6 @@ public static function beginPostProcess(&$form, &$params) { * @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 315972c160e..1b3b74fcf4a 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 @@ public function preProcess() { } /** - * 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 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //this call is for show related cases. @@ -444,8 +435,6 @@ public function buildQuickForm() { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); From df371444e65dba73fc16f137ab37ecf08140b650 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:21:38 +1200 Subject: [PATCH 4/5] more comment fixes --- CRM/Bridge/OG/CiviCRM.php | 2 -- CRM/Bridge/OG/Drupal.php | 2 -- CRM/Bridge/OG/Utils.php | 2 -- CRM/Campaign/BAO/Campaign.php | 2 -- CRM/Campaign/BAO/Survey.php | 5 +---- CRM/Campaign/Config.php | 2 -- CRM/Campaign/Controller/Search.php | 2 -- CRM/Campaign/Form/Gotv.php | 1 - CRM/Campaign/Form/Petition.php | 5 +---- CRM/Campaign/Form/Survey/TabHeader.php | 4 ++-- CRM/Campaign/Info.php | 2 -- CRM/Campaign/Page/DashBoard.php | 4 +--- CRM/Campaign/Page/Petition.php | 4 +--- CRM/Campaign/PseudoConstant.php | 2 -- CRM/Campaign/StateMachine/Search.php | 2 -- CRM/Campaign/Task.php | 7 ++----- CRM/Case/Form/Activity/LinkCases.php | 17 ++++------------- CRM/Case/Form/Activity/OpenCase.php | 14 ++------------ CRM/Case/Form/ActivityToCase.php | 9 +-------- CRM/Case/Form/ActivityView.php | 8 +------- CRM/Case/Form/Case.php | 19 +++---------------- CRM/Case/Form/CustomData.php | 12 ------------ CRM/Case/Form/EditClient.php | 11 +---------- CRM/Case/Form/Report.php | 10 +--------- CRM/Case/Form/Search.php | 19 ++++--------------- CRM/Case/Form/Task.php | 11 +---------- CRM/Case/Form/Task/Delete.php | 10 +--------- CRM/Case/Form/Task/Print.php | 14 +++----------- CRM/Case/Form/Task/Restore.php | 14 +------------- 29 files changed, 31 insertions(+), 185 deletions(-) diff --git a/CRM/Bridge/OG/CiviCRM.php b/CRM/Bridge/OG/CiviCRM.php index 1f64a02d1d2..ddaf959d82b 100644 --- a/CRM/Bridge/OG/CiviCRM.php +++ b/CRM/Bridge/OG/CiviCRM.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Bridge_OG_CiviCRM { diff --git a/CRM/Bridge/OG/Drupal.php b/CRM/Bridge/OG/Drupal.php index a0a16755af1..e5557a8626e 100644 --- a/CRM/Bridge/OG/Drupal.php +++ b/CRM/Bridge/OG/Drupal.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Bridge/OG/Utils.php b/CRM/Bridge/OG/Utils.php index db5912771b2..123efc15cb9 100644 --- a/CRM/Bridge/OG/Utils.php +++ b/CRM/Bridge/OG/Utils.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Bridge_OG_Utils { const aclEnabled = 1, syncFromCiviCRM = 1; diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 20932af7f24..dd793c9b508 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index f554c528167..a7097e70416 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ -require_once 'CRM/Campaign/DAO/Survey.php'; /** - * Class CRM_Campaign_BAO_Survey + * Class CRM_Campaign_BAO_Survey. */ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { diff --git a/CRM/Campaign/Config.php b/CRM/Campaign/Config.php index 14f23f13d4c..eee02200ac7 100644 --- a/CRM/Campaign/Config.php +++ b/CRM/Campaign/Config.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Config extends CRM_Core_Component_Config { } diff --git a/CRM/Campaign/Controller/Search.php b/CRM/Campaign/Controller/Search.php index f77413a3ae3..a12cd942c04 100755 --- a/CRM/Campaign/Controller/Search.php +++ b/CRM/Campaign/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/Form/Gotv.php b/CRM/Campaign/Form/Gotv.php index e7b3e1d6503..f6c4c936569 100755 --- a/CRM/Campaign/Form/Gotv.php +++ b/CRM/Campaign/Form/Gotv.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index 59c7cad45f9..6931a7917fb 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for adding a petition - * + * This class generates form components for adding a petition. */ class CRM_Campaign_Form_Petition extends CRM_Core_Form { diff --git a/CRM/Campaign/Form/Survey/TabHeader.php b/CRM/Campaign/Form/Survey/TabHeader.php index 9b4d90ffd75..2e1bc7b3cc0 100644 --- a/CRM/Campaign/Form/Survey/TabHeader.php +++ b/CRM/Campaign/Form/Survey/TabHeader.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -39,6 +37,8 @@ class CRM_Campaign_Form_Survey_TabHeader { /** + * Build tab header. + * * @param CRM_Core_Form $form * * @return array diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index 08fb4eeb865..8f3c74f0eb9 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Info extends CRM_Core_Component_Info { diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index 1a4835842a3..d455035c113 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying Campaigns + * Page for displaying Campaigns. */ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { diff --git a/CRM/Campaign/Page/Petition.php b/CRM/Campaign/Page/Petition.php index f6465c5ae7c..55d316c8cdf 100644 --- a/CRM/Campaign/Page/Petition.php +++ b/CRM/Campaign/Page/Petition.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying Petition Signatures + * Page for displaying Petition Signatures. */ class CRM_Campaign_Page_Petition extends CRM_Core_Page { public function browse() { diff --git a/CRM/Campaign/PseudoConstant.php b/CRM/Campaign/PseudoConstant.php index b19360165bc..31b20f7dc09 100755 --- a/CRM/Campaign/PseudoConstant.php +++ b/CRM/Campaign/PseudoConstant.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index e1fc69438d8..a544c9ade11 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Campaign/Task.php b/CRM/Campaign/Task.php index dff92989e82..914c2df17f8 100755 --- a/CRM/Campaign/Task.php +++ b/CRM/Campaign/Task.php @@ -29,15 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * class to represent the actions that can be performed on a - * group of voters. - * used by the search forms + * class to represent the actions that can be performed on a group of voters. * + * Used by the search forms. */ class CRM_Campaign_Task { const INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4; diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 598bd4637da..25880a8f156 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.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_LinkCases { /** @@ -70,13 +67,11 @@ public static function preProcess(&$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. * * @param CRM_Core_Form $form * - * @return void + * @return array */ public static function setDefaultValues(&$form) { return $defaults = array(); @@ -125,8 +120,6 @@ public static function formRule($values, $files, $form) { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { } @@ -137,9 +130,7 @@ public static function beginPostProcess(&$form, &$params) { * * @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) { $activityId = $activity->id; diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index b6145248e33..d78d32617ec 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.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_OpenCase { @@ -94,8 +91,6 @@ public static function preProcess(&$form) { * * * @param CRM_Core_Form $form - * - * @return void */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -216,8 +211,6 @@ public static function buildQuickForm(&$form) { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'caseActivity') { @@ -272,11 +265,8 @@ public static function formRule($fields, $files, $form) { /** * Process the form submission. * - * - * @param $form + * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function endPostProcess(&$form, &$params) { if ($form->_context == 'caseActivity') { diff --git a/CRM/Case/Form/ActivityToCase.php b/CRM/Case/Form/ActivityToCase.php index ca074845c5e..5ce068eff39 100644 --- a/CRM/Case/Form/ActivityToCase.php +++ b/CRM/Case/Form/ActivityToCase.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for building activity to a case - * + * This class generates form components for building activity to a case. */ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_activityId = CRM_Utils_Request::retrieve('activityId', 'Positive', CRM_Core_DAO::$_nullObject); @@ -90,8 +85,6 @@ public function setDefaultValues() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->add('text', 'file_on_case_unclosed_case_id', ts('Select Case'), array('class' => 'huge'), TRUE); diff --git a/CRM/Case/Form/ActivityView.php b/CRM/Case/Form/ActivityView.php index c63eb154bcf..c8aff71e14b 100644 --- a/CRM/Case/Form/ActivityView.php +++ b/CRM/Case/Form/ActivityView.php @@ -29,21 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class does pre processing for viewing an activity or their revisions - * + * This class does pre processing for viewing an activity or their revisions. */ class CRM_Case_Form_ActivityView extends CRM_Core_Form { /** * Process the view. - * - * - * @return void */ public function preProcess() { $contactID = CRM_Utils_Request::retrieve('cid', 'Integer', $this, TRUE); diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index 44399b0f0ac..22b9875ebc0 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for case activity - * + * This class generates form components for case activity. */ class CRM_Case_Form_Case extends CRM_Core_Form { @@ -88,8 +85,6 @@ class CRM_Case_Form_Case extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function preProcess() { @@ -196,11 +191,7 @@ public function preProcess() { } /** - * 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() { if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { @@ -289,8 +280,7 @@ public function buildQuickForm() { /** * Add local and global form rules. * - * - * @return void + * @return bool */ public function addRules() { if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { @@ -319,9 +309,6 @@ public static function formRule($values, $files, $form) { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Case/Form/CustomData.php b/CRM/Case/Form/CustomData.php index f108562e5f3..83eaabb9888 100644 --- a/CRM/Case/Form/CustomData.php +++ b/CRM/Case/Form/CustomData.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -39,7 +37,6 @@ * It delegates the work to lower level subclasses and integrates the changes * back in. It also uses a lot of functionality with the CRM API's, so any change * made here could potentially affect the API etc. Be careful, be aware, use unit tests. - * */ class CRM_Case_Form_CustomData extends CRM_Core_Form { @@ -68,10 +65,6 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { * Pre processing work done here. * * gets session variables for table name, id of entity in table, type of entity and stores them. - * - * @param - * - * @return void */ public function preProcess() { $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE); @@ -108,8 +101,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { // make this form an upload since we dont know if the custom data injected dynamically @@ -130,9 +121,6 @@ public function buildQuickForm() { /** * Process the user submitted custom data values. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); diff --git a/CRM/Case/Form/EditClient.php b/CRM/Case/Form/EditClient.php index 07d110036d3..650d3d6b3cd 100644 --- a/CRM/Case/Form/EditClient.php +++ b/CRM/Case/Form/EditClient.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class assigns the current case to another client - * + * This class assigns the current case to another client. */ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE); @@ -78,8 +73,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addEntityRef('reassign_contact_id', ts('Select Contact'), array('create' => TRUE), TRUE); @@ -120,8 +113,6 @@ public static function formRule($vals, $rule, $form) { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); diff --git a/CRM/Case/Form/Report.php b/CRM/Case/Form/Report.php index 3ed4790ee4b..7bfe64f2f14 100644 --- a/CRM/Case/Form/Report.php +++ b/CRM/Case/Form/Report.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for case report - * + * This class generates form components for case report. */ class CRM_Case_Form_Report extends CRM_Core_Form { @@ -58,8 +55,6 @@ class CRM_Case_Form_Report extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function preProcess() { $this->_caseID = CRM_Utils_Request::retrieve('caseid', 'Integer', $this, TRUE); @@ -120,9 +115,6 @@ public function buildQuickForm() { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 3f243345958..50450942b8c 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This file is for Case search + * This file is for Case search. */ class CRM_Case_Form_Search extends CRM_Core_Form_Search { @@ -66,8 +64,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Search'); @@ -165,9 +161,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -212,10 +205,6 @@ public function buildQuickForm() { * done. * The processing consists of using a Selector / Controller framework for getting the * search results. - * - * @param - * - * @return void */ public function postProcess() { if ($this->_done) { @@ -308,10 +297,10 @@ public function postProcess() { } /** - * add the rules (mainly global rules) for form. + * Add the rules (mainly global rules) for form. + * * All local rules are added near the element * - * @return void * @see valid_date */ public function addRules() { @@ -324,7 +313,7 @@ public function addRules() { * @param array $fields * Posted values of the form. * - * @return void + * @return array|bool */ public static function formRule($fields) { $errors = array(); diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index e8c2a7adbcc..71570e58384 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates task actions for CiviEvent - * + * This class generates task actions for CiviEvent. */ class CRM_Case_Form_Task extends CRM_Core_Form { @@ -69,10 +66,6 @@ class CRM_Case_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); @@ -158,8 +151,6 @@ public function setContactIDs() { * 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/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index 5d79638836e..e517db79a34 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to delete a group of - * case records. This class provides functionality for the actual - * deletion. + * This class provides the functionality to delete a group of case records. */ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { @@ -67,8 +63,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Delete Cases'), 'done'); @@ -76,8 +70,6 @@ public function buildQuickForm() { /** * Process the form after the input has been submitted and validated. - * - * @return void */ public function postProcess() { $deleted = $failed = 0; diff --git a/CRM/Case/Form/Task/Print.php b/CRM/Case/Form/Task/Print.php index 57926f54809..1477e5ffd66 100644 --- a/CRM/Case/Form/Task/Print.php +++ b/CRM/Case/Form/Task/Print.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preprocess(); @@ -67,12 +63,11 @@ public function preProcess() { } /** - * 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() { // @@ -95,9 +90,6 @@ public function buildQuickForm() { /** * 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/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index dfbb74a40d4..ec3e5a632e7 100644 --- a/CRM/Case/Form/Task/Restore.php +++ b/CRM/Case/Form/Task/Restore.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to restore a group of - * participations. This class provides functionality for the actual - * deletion. + * This class provides the functionality to restore a group of participations. */ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { @@ -50,8 +46,6 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -59,9 +53,6 @@ public function preProcess() { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Restore Cases'), 'done'); @@ -69,9 +60,6 @@ public function buildQuickForm() { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $restoredCases = $failed = 0; From 67d192996ffd7c3c352e1374e084dc70b6a823a8 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:35:34 +1200 Subject: [PATCH 5/5] more comment fixes --- CRM/Campaign/Form/Task/Reserve.php | 5 ++--- CRM/Campaign/Page/Petition/Confirm.php | 2 -- CRM/Campaign/Page/Petition/ThankYou.php | 4 ++-- CRM/Campaign/Page/Vote.php | 2 -- CRM/Campaign/Selector/Search.php | 7 +------ CRM/Case/BAO/Case.php | 5 ++--- CRM/Case/BAO/CaseType.php | 5 +---- CRM/Case/BAO/Query.php | 2 +- CRM/Case/Config.php | 2 -- CRM/Case/Controller/Search.php | 2 -- CRM/Case/Form/Activity.php | 2 -- CRM/Case/Form/Task/Result.php | 10 +-------- CRM/Case/Form/Task/SearchTaskHookSample.php | 6 ------ CRM/Case/Info.php | 2 -- CRM/Case/Page/CaseDetails.php | 7 +++---- CRM/Case/Page/DashBoard.php | 9 +++----- CRM/Case/Page/Tab.php | 11 ++-------- CRM/Case/PseudoConstant.php | 3 --- CRM/Case/Selector/Search.php | 7 +------ CRM/Case/StateMachine/Search.php | 2 -- CRM/Case/Task.php | 6 ++---- CRM/Case/XMLProcessor.php | 2 -- CRM/Case/XMLProcessor/Process.php | 6 +++--- CRM/Case/XMLProcessor/Report.php | 2 -- CRM/Case/XMLProcessor/Settings.php | 8 +++---- CRM/Case/XMLRepository.php | 1 - CRM/Contact/BAO/Contact.php | 1 - CRM/Contact/BAO/Contact/Location.php | 4 +--- CRM/Contact/BAO/Contact/Optimizer.php | 8 +++---- CRM/Contact/BAO/Contact/Permission.php | 4 ---- CRM/Contact/BAO/Contact/Utils.php | 12 ++--------- CRM/Contact/BAO/ContactType.php | 6 ++---- CRM/Contact/BAO/DashboardContact.php | 1 - CRM/Contact/BAO/Group.php | 12 +++++------ CRM/Contact/BAO/GroupContact.php | 7 ------- CRM/Contact/BAO/GroupContactCache.php | 9 +++----- CRM/Contact/BAO/GroupNesting.php | 9 -------- CRM/Contact/BAO/GroupNestingCache.php | 8 +++++-- CRM/Contact/BAO/GroupOrganization.php | 4 ---- CRM/Contact/BAO/Household.php | 4 +--- CRM/Contact/BAO/Individual.php | 10 +++------ CRM/Contact/BAO/ProximityQuery.php | 8 +++---- CRM/Contact/BAO/Query.php | 23 +++++++-------------- 43 files changed, 67 insertions(+), 183 deletions(-) diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index 817b67e8988..14b0e9d735d 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -37,9 +37,8 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** - * Survet id` - * * @var int + * Survey id. */ protected $_surveyId; @@ -232,7 +231,7 @@ public static function formRule($fields, $files, $self) { /** * Process the form after the input has been submitted and validated. - */ + */ public function postProcess() { //add reservation. $countVoters = 0; diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index b36d0693c5b..cf5e0209362 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { /** diff --git a/CRM/Campaign/Page/Petition/ThankYou.php b/CRM/Campaign/Page/Petition/ThankYou.php index ed0575c935c..6c27ba2bc05 100644 --- a/CRM/Campaign/Page/Petition/ThankYou.php +++ b/CRM/Campaign/Page/Petition/ThankYou.php @@ -29,11 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Page_Petition_ThankYou extends CRM_Core_Page { /** + * Run page. + * * @return string */ public function run() { diff --git a/CRM/Campaign/Page/Vote.php b/CRM/Campaign/Page/Vote.php index b1d83e1d868..5c9ea35959e 100644 --- a/CRM/Campaign/Page/Vote.php +++ b/CRM/Campaign/Page/Vote.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index a0151c66cf0..bc9dc5e176f 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -29,15 +29,10 @@ * * @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. */ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 0d3b5337ca1..33f89bbb8e2 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -33,7 +33,6 @@ /** * This class contains the functions for Case Management. - * */ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { @@ -1441,11 +1440,11 @@ public static function getRelatedContacts($caseID, $skipDetails = FALSE) { * @param null $attachments * @param int $caseId * - * @return null|array + * @return bool |array */ public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) { if (!$activityId) { - return; + return FALSE; } $tplParams = $activityInfo = array(); diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 5d0f1fdd28e..889a9c1a657 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class contains the functions for Case Type management - * + * This class contains the functions for Case Type management. */ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index de28c1ad5b9..e7a2c7a84f1 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -240,7 +240,7 @@ public static function where(&$query) { * Where clause for a single field. * * @param array $values - * @param CRM_Case_BAO_Query s$query + * @param CRM_Case_BAO_Query $query */ public static function whereClauseSingle(&$values, &$query) { list($name, $op, $value, $grouping, $wildcard) = $values; diff --git a/CRM/Case/Config.php b/CRM/Case/Config.php index c0337fbcea1..c01f995e49c 100644 --- a/CRM/Case/Config.php +++ b/CRM/Case/Config.php @@ -33,8 +33,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Config extends CRM_Core_Component_Config { } diff --git a/CRM/Case/Controller/Search.php b/CRM/Case/Controller/Search.php index 64610630b08..c997926d427 100644 --- a/CRM/Case/Controller/Search.php +++ b/CRM/Case/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 55a6b70d0c2..ac997bc85aa 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -346,8 +346,6 @@ public static function formRule($fields, $files, $self) { * Process the form submission. * * @param array $params - * - * @return array|null */ public function postProcess($params = NULL) { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Case/Form/Task/Result.php b/CRM/Case/Form/Task/Result.php index 7ca73bb548e..fdc52f5cd87 100644 --- a/CRM/Case/Form/Task/Result.php +++ b/CRM/Case/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_Case_Form_Task_Result extends CRM_Case_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/Case/Form/Task/SearchTaskHookSample.php b/CRM/Case/Form/Task/SearchTaskHookSample.php index 02ed6d60f39..78a42f4e20c 100644 --- a/CRM/Case/Form/Task/SearchTaskHookSample.php +++ b/CRM/Case/Form/Task/SearchTaskHookSample.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Case_Form_Task_SearchTaskHookSample extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -74,8 +70,6 @@ public function preProcess() { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index 6ebde5ec4f8..0c91d9a59cb 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Info extends CRM_Core_Component_Info { diff --git a/CRM/Case/Page/CaseDetails.php b/CRM/Case/Page/CaseDetails.php index 2555ab6ff95..df9471e764a 100644 --- a/CRM/Case/Page/CaseDetails.php +++ b/CRM/Case/Page/CaseDetails.php @@ -29,14 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Page_CaseDetails extends CRM_Core_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. + * + * It decides the which action has to be taken for the page. * * @return null */ diff --git a/CRM/Case/Page/DashBoard.php b/CRM/Case/Page/DashBoard.php index 80a5e6cbe87..b22da4aba7d 100644 --- a/CRM/Case/Page/DashBoard.php +++ b/CRM/Case/Page/DashBoard.php @@ -29,22 +29,19 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This page is for Case Dashboard + * This page is for Case Dashboard. */ class CRM_Case_Page_DashBoard extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * 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() { //check for civicase access. diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php index 80faee59494..512b50b6776 100644 --- a/CRM/Case/Page/Tab.php +++ b/CRM/Case/Page/Tab.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class handle case related functions - * + * This class handle case related functions. */ class CRM_Case_Page_Tab extends CRM_Core_Page { @@ -97,8 +94,6 @@ public function preProcess() { /** * View details of a case. - * - * @return void */ public function view() { $controller = new CRM_Core_Controller_Simple( @@ -137,9 +132,7 @@ public function view() { } /** - * called when action is browse. - * - * @return void + * Called when action is browse. */ public function browse() { diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 3cb4fad1838..d40fa669dd7 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class holds all the Pseudo constants that are specific for CiviCase. - * */ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 6acf462fffb..283b36d8278 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -29,15 +29,10 @@ * * @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. */ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 246a8f18538..9fda0907b3e 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Case/Task.php b/CRM/Case/Task.php index cbef459dfe0..42603ae426a 100644 --- a/CRM/Case/Task.php +++ b/CRM/Case/Task.php @@ -29,14 +29,12 @@ * * @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_Case_Task { const DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4; diff --git a/CRM/Case/XMLProcessor.php b/CRM/Case/XMLProcessor.php index 48e60d46751..ab60bf19ba9 100644 --- a/CRM/Case/XMLProcessor.php +++ b/CRM/Case/XMLProcessor.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor { diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index 7ca2a03f9ed..b97411828aa 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -29,12 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** - * @param $caseType + * Run. + * + * @param string $caseType * @param array $params * * @return bool diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 99c7f98c44f..5f68f1f1dbd 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { diff --git a/CRM/Case/XMLProcessor/Settings.php b/CRM/Case/XMLProcessor/Settings.php index 61465e61ac2..a9ea2d5a6f5 100644 --- a/CRM/Case/XMLProcessor/Settings.php +++ b/CRM/Case/XMLProcessor/Settings.php @@ -29,19 +29,19 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor { private $_settings = array(); /** - * Input: The base filename without the .xml extension - * Output: An array of settings. + * Run. + * * @param string $filename + * The base filename without the .xml extension * * @return array + * An array of settings. */ public function run($filename = 'settings') { $xml = $this->retrieve($filename); diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php index 42309337ff8..d8169b7359b 100644 --- a/CRM/Case/XMLRepository.php +++ b/CRM/Case/XMLRepository.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ * * The XMLRepository is responsible for loading XML for case-types. * It includes any bulk operations that apply across the list of all XML diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 6cfb4af7c98..d2f4889e5c3 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 47154bd3d4b..df696802eb5 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Location { /** - * Get the display name, primary email, location type and location id of a contact + * Get the display name, primary email, location type and location id of a contact. * * @param int $id * Id of the contact. diff --git a/CRM/Contact/BAO/Contact/Optimizer.php b/CRM/Contact/BAO/Contact/Optimizer.php index f9a5e51cc63..7b29de360d0 100644 --- a/CRM/Contact/BAO/Contact/Optimizer.php +++ b/CRM/Contact/BAO/Contact/Optimizer.php @@ -29,13 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Optimizer { /** - * @param $newValues - * @param $oldValues + * Edit function. + * + * @param array $newValues + * @param array $oldValues */ public static function edit(&$newValues, &$oldValues) { // still need to do more work on this diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 5525c081ab8..2bd730008a8 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Permission { @@ -87,8 +85,6 @@ public static function allow($id, $type = CRM_Core_Permission::VIEW) { * @param int|string $type the type of operation (view|edit) * @param bool $force * Should we force a recompute. - * - * @return void */ public static function cache($userID, $type = CRM_Core_Permission::VIEW, $force = FALSE) { static $_processed = array(); diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index b5d8b596f4c..66de04582cb 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Utils { /** - * Given a contact type, get the contact image + * Given a contact type, get the contact image. * * @param string $contactType * Contact type. @@ -811,8 +809,6 @@ public static function contactDetails($componentIds, $componentName, $returnProp * * @param array $address * This is associated array which contains submitted form values. - * - * @return void */ public static function processSharedAddress(&$address) { if (!is_array($address)) { @@ -908,8 +904,6 @@ public static function getAddressShareContactNames(&$addresses) { * * @param $contactID * The contactID that was edited / deleted. - * - * @return void */ public static function clearContactCaches($contactID = NULL) { // clear acl cache if any. @@ -1122,11 +1116,9 @@ public static function defaultGreeting($contactType, $greetingType) { * @param string $templateString * The greeting template string with contact tokens + Smarty syntax. * - * @param $contactDetails + * @param array $contactDetails * @param int $contactID * @param string $className - * - * @return void */ public static function processGreetingTemplate(&$templateString, $contactDetails, $contactID, $className) { CRM_Utils_Token::replaceGreetingTokens($templateString, $contactDetails, $contactID, $className, TRUE); diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index e9a9c4e6b1b..15ad7309d19 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { @@ -894,7 +892,7 @@ public static function deleteCustomSetForSubtypeMigration( * @param array $subtypes * List of subtypes related to which entry is to be removed. * - * @return void + * @return bool */ public static function deleteCustomRowsOfSubtype($gID, $subtypes = array()) { if (!$gID or empty($subtypes)) { @@ -932,7 +930,7 @@ public static function deleteCustomRowsOfSubtype($gID, $subtypes = array()) { * @param int $entityID * Entity id. * - * @return void + * @return null|string */ public static function deleteCustomRowsForEntityID($customTable, $entityID) { $customTable = CRM_Utils_Type::escape($customTable, 'String'); diff --git a/CRM/Contact/BAO/DashboardContact.php b/CRM/Contact/BAO/DashboardContact.php index 46d2c9859a3..c3b034c80e1 100644 --- a/CRM/Contact/BAO/DashboardContact.php +++ b/CRM/Contact/BAO/DashboardContact.php @@ -28,7 +28,6 @@ /** * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contact_BAO_DashboardContact extends CRM_Contact_DAO_DashboardContact { } diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 55e5b41a4f1..e9e7056f8cb 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -65,11 +63,11 @@ public static function retrieve(&$params, &$defaults) { } /** - * Delete the group and all the object that connect to - * this group. Incredibly destructive + * Delete the group and all the object that connect to this group. * - * @param int $id - * Group id. + * Incredibly destructive. + * + * @param int $id Group id. */ public static function discard($id) { CRM_Utils_Hook::pre('delete', 'Group', $id, CRM_Core_DAO::$_nullArray); diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index da7ebc36040..7306a4c0d0b 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { @@ -514,8 +512,6 @@ public static function getGroupId($groupContactID) { * * @param bool $visibility * @param string $method - * - * @return void */ public static function create(&$params, $contactId, $visibility = FALSE, $method = 'Admin') { $contactIds = array(); @@ -602,9 +598,6 @@ public static function isContactInGroup($contactID, $groupID) { * @see CRM_Dedupe_Merger::cpTables() * * TODO: use the 3rd $sqls param to append sql statements rather than executing them here - * - * @return void - * */ public static function mergeGroupContact($mainContactId, $otherContactId) { $params = array( diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 347e6888a23..d3fbd76136e 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -29,16 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCache { static $_alreadyLoaded = array(); /** - * Check to see if we have cache entries for this group - * if not, regenerate, else return + * Check to see if we have cache entries for this group. + * + * If not, regenerate, else return. * * @param $groupIDs * Of group that we are checking against. @@ -284,8 +283,6 @@ public static function updateCacheTime($groupID, $processed) { * the groupID to delete cache entries, NULL for all groups. * @param bool $onceOnly * run the function exactly once for all groups. - * - * @return void */ public static function remove($groupID = NULL, $onceOnly = TRUE) { static $invoked = FALSE; diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 045da9e888e..209afb79ff5 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -30,8 +30,6 @@ * * @package CRM * @copyright U.S. PIRG 2007 - * $Id$ - * */ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implements Iterator { @@ -287,9 +285,6 @@ public function _getNextSiblingGroup(&$group) { * Id of the group to add the child to. * @param int $childID * Id of the new child group. - * - * - * @return void */ public static function add($parentID, $childID) { // TODO: Add checks here to make sure invalid nests can't be created @@ -307,8 +302,6 @@ public static function add($parentID, $childID) { * The id of the group to remove the child from. * @param $childID * The id of the child group being removed. - * - * @return void */ public static function remove($parentID, $childID) { $dao = new CRM_Contact_DAO_GroupNesting(); @@ -323,8 +316,6 @@ public static function remove($parentID, $childID) { * * @param int $childID * The id of the child group being removed. - * - * @return void */ public static function removeAllParentForChild($childID) { $dao = new CRM_Contact_DAO_GroupNesting(); diff --git a/CRM/Contact/BAO/GroupNestingCache.php b/CRM/Contact/BAO/GroupNestingCache.php index bb1198f51b9..632277794e8 100644 --- a/CRM/Contact/BAO/GroupNestingCache.php +++ b/CRM/Contact/BAO/GroupNestingCache.php @@ -29,10 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupNestingCache { + + /** + * Update cache. + * + * @throws \Exception + */ static public function update() { // lets build the tree in memory first diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 9b4d2972534..89ad08170c2 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization { @@ -72,8 +70,6 @@ public static function add(&$params) { * (reference ) an assoc array of name/value pairs. * @param array $formatedValues * (reference ) an assoc array of name/value pairs. - * - * @return void */ public static function formatValues(&$params, &$formatedValues) { if (!empty($params['group_organization'])) { diff --git a/CRM/Contact/BAO/Household.php b/CRM/Contact/BAO/Household.php index 571f730195b..e37ec0f0096 100644 --- a/CRM/Contact/BAO/Household.php +++ b/CRM/Contact/BAO/Household.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact { /** - * This is a contructor of the class. + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 00d5d482e6d..578fec08f5d 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -29,17 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Class contains functions for individual contact type + * Class contains functions for individual contact type. */ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** - * This is a contructor of the class. + * Class constructor. */ public function __construct() { } @@ -351,14 +349,12 @@ public static function format(&$params, &$contact) { } /** - * Regenerates display_name for contacts with given prefixes/suffixes + * Regenerates display_name for contacts with given prefixes/suffixes. * * @param array $ids * The array with the prefix/suffix id governing which contacts to regenerate. * @param int $action * The action describing whether prefix/suffix was UPDATED or DELETED. - * - * @return void */ public static function updateDisplayNames(&$ids, $action) { // get the proper field name (prefix_id or suffix_id) and its value diff --git a/CRM/Contact/BAO/ProximityQuery.php b/CRM/Contact/BAO/ProximityQuery.php index dbe5cbe0966..ca7451899c9 100644 --- a/CRM/Contact/BAO/ProximityQuery.php +++ b/CRM/Contact/BAO/ProximityQuery.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_ProximityQuery { @@ -254,11 +252,13 @@ public static function where($latitude, $longitude, $distance, $tablePrefix = 'c } /** - * @param $query + * Process form. + * + * @param CRM_Contact_BAO_Query $query * @param array $values * + * @return null * @throws Exception - * @return void */ public static function process(&$query, &$values) { list($name, $op, $distance, $grouping, $wildcard) = $values; diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 30bcb57642a..4276c04053c 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -463,8 +461,6 @@ public function __construct( /** * Function which actually does all the work for the constructor. - * - * @return void */ public function initialize() { $this->_select = array(); @@ -504,12 +500,14 @@ public function initialize() { $this->openedSearchPanes(TRUE); } + /** + * Fix and handle contact deletion nicely. + * + * this code is primarily for search builder use case where different clauses can specify if they want deleted. + * + * CRM-11971 + */ public function buildParamsLookup() { - // first fix and handle contact deletion nicely - // this code is primarily for search builder use case - // where different clauses can specify if they want deleted - // contacts or not - // CRM-11971 $trashParamExists = FALSE; $paramByGroup = array(); foreach ($this->_params as $k => $param) { @@ -568,10 +566,7 @@ public function buildParamsLookup() { } /** - * Some composite fields do not appear in the fields array - * hack to make them part of the query - * - * @return void + * Some composite fields do not appear in the fields array hack to make them part of the query. */ public function addSpecialFields() { static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name'); @@ -589,8 +584,6 @@ public function addSpecialFields() { * clauses. Note that since the where clause introduces new * tables, the initial attempt also retrieves all variables used * in the params list - * - * @return void */ public function selectClause() {