From ce064e4f6bd0c1df0122a8d9b3793dfb587f9658 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:00:19 +1200 Subject: [PATCH] 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 ce7d7827ea..df58d573c4 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 c76cdc77d0..4365a503c8 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 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Admin_Form_MailSettings', 'formRule')); @@ -122,9 +115,6 @@ class CRM_Admin_Form_MailSettings extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Mapping.php b/CRM/Admin/Form/Mapping.php index 7ba6f0fa63..50284a8295 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 @@ class CRM_Admin_Form_Mapping extends CRM_Admin_Form { /** * 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 0e7874440c..61b1fa2588 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 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { /** * 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 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -202,9 +195,6 @@ class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Navigation.php b/CRM/Admin/Form/Navigation.php index 6c98a0478e..318e5bfa84 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 @@ class CRM_Admin_Form_Navigation extends CRM_Admin_Form { /** * 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 b2839463e9..df38787996 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 @@ class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form { /** * 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 a546c10e5e..25db9ff273 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 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { /** * Set default values for the form. - * - * @return void */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -146,8 +139,6 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -390,9 +381,6 @@ class CRM_Admin_Form_Options extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/ParticipantStatusType.php b/CRM/Admin/Form/ParticipantStatusType.php index bf6f4e7736..dc7c58aba7 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 @@ class CRM_Admin_Form_ParticipantStatusType extends CRM_Admin_Form { return 'ParticipantStatusType'; } + /** + * Build form. + */ public function buildQuickForm() { parent::buildQuickForm(); @@ -71,6 +72,8 @@ class CRM_Admin_Form_ParticipantStatusType extends CRM_Admin_Form { } /** + * Set default values. + * * @return array */ public function setDefaultValues() { diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index dc9339833a..e60b390323 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 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -338,9 +333,6 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return Void */ public function postProcess() { CRM_Utils_System::flushCache('CRM_Financial_DAO_PaymentProcessor'); @@ -367,11 +359,9 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { /** * 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 d53a55326e..5c4e2e946f 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 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { * Build the form object. * * @param bool $check - * - * @return void */ public function buildQuickForm($check = FALSE) { parent::buildQuickForm(); @@ -206,9 +201,6 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form { /** * 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 c6f6ef5687..da53bf5590 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 @@ class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Persistent.php b/CRM/Admin/Form/Persistent.php index 3cce900a0b..cfcdf1b4f7 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 @@ class CRM_Admin_Form_Persistent extends CRM_Core_Form { } /** + * Set default values. + * * @return array */ public function setDefaultValues() { diff --git a/CRM/Admin/Form/Preferences.php b/CRM/Admin/Form/Preferences.php index 3d392b2a2d..ef88e38a5d 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 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -235,9 +230,6 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $config = CRM_Core_Config::singleton(); @@ -252,9 +244,6 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { /** * 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 eb6f4ad187..61617e458f 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 @@ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->applyFilter('__ALL__', 'trim'); @@ -180,9 +176,6 @@ class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences { /** * 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 29a3ebce3b..d08996cd73 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 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //CRM-16691: Changes made related to settings of 'CVV'. @@ -152,10 +145,8 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { /** * 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 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { /** * 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 503582934d..b164585e70 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 @@ class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences { /** * 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 @@ class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences { /** * 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 7a2002fcd1..ad24d2e81d 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 @@ class CRM_Admin_Form_Preferences_Member extends CRM_Admin_Form_Preferences { /** * 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 ec3b413344..97d6455b86 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 @@ class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form { /** * 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 59ba8b9577..41d108bf5b 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 @@ class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php index 7c9d82f318..4e1893e1b4 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 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { if ($this->_action & CRM_Core_Action::DELETE) { diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php index 0948c65b1a..3e02107b2c 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 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { } } + /** + * 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 7b1fe225c6..cdcf59be82 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 575997e204..fa068d993d 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 b88f2f6137..3c718484bc 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 75f1c6deaf..5921e98275 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 add51c219a..e78d5daf4f 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 c4c4ebd3d7..4eb31dd7d9 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 @@ class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting { } /** - * 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 a27a28351e..1f78d8a22f 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 @@ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting { /** * 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 5e792cd788..f33b15a57e 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 4a7759f0fe..f0a4174d63 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 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // flush caches so we reload details for future requests @@ -243,10 +235,6 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { /** * 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 87fe17b3d6..391a071678 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 0e71709a7b..07d612a4e5 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 8424127a71..4dbcf9eb49 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 207278133b..af18b37b7f 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 @@ class CRM_Admin_Form_Tag extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->setPageTitle($this->_isTagSet ? ts('Tag Set') : ts('Tag')); @@ -137,9 +132,6 @@ class CRM_Admin_Form_Tag extends CRM_Admin_Form { /** * 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 c59168c69b..64cfb8e34b 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 @@ class CRM_Admin_Page_AJAX { } /** - * 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 705f40df71..0df6d0c9e2 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 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { } /** - * AJAX callback to fetch examples + * AJAX callback to fetch examples. */ public static function getExampleFile() { global $civicrm_root; @@ -102,7 +102,7 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { } /** - * 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 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { } /** + * 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 dcbd04255a..e7fa0e7bf0 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 2ccf4770e6..d9985c9c08 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 bd46f6515d..ad59a2b37b 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 @@ class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page { } /** + * Get CKEditor plugins. + * * @return array */ private function getCKPlugins() { @@ -155,6 +157,8 @@ class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page { } /** + * Get CK Editor skins. + * * @return array */ private function getCKSkins() { @@ -223,7 +227,7 @@ class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page { } /** - * 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 f276ed7594..6c7b3c56b2 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 b0fa940324..016fc2dd01 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 fb5d6bfc85..9da8ab50b3 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 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { 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 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic { 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 34e18a05d0..84a7bcae69 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 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic { /** * 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 b221498361..74644323dc 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 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -127,9 +121,6 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic { /** * 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 e2671f8021..750e9dc578 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 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // set title and breadcrumb @@ -144,8 +140,6 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { * 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 9ad36bcfa2..fd19c18100 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 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // set title and breadcrumb @@ -93,8 +89,6 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic { * 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 c93e6a637c..e9e8a0ce65 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 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic { * 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 91d0067dbe..ce38c28476 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 8778b07e83..2bf6c4893b 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 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic { /** * 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 2a474b5d7d..0aa0b2c81b 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 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic { /** * 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 665ac43f74..3a6c203bf4 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 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * 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 ee21dc34fd..b7a301c173 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 e6c61877ba..cc9d9b8d10 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 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * Run the basic page (run essentially starts execution for that page). - * - * @return void */ public function run() { $this->preProcess(); @@ -231,9 +226,6 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * 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 9497840e77..687bba5519 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 39530a93e5..d6ee3042b8 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 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // set title and breadcrumb @@ -125,8 +121,6 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { * 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 b7da659cd5..ef65767914 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 90299ce86f..57e9396be5 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 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic { * 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 dafe746fd1..e562780e1b 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 @@ class CRM_Admin_Page_Persistent extends CRM_Core_Page { /** * 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 @@ class CRM_Admin_Page_Persistent extends CRM_Core_Page { /** * 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 e58996a252..698773a5e0 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 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic { * This method is called after the page is created. It checks for the * type of action and executes that action. * Finally it calls the parent's run method. - * - * @return void */ public function run() { // set title and breadcrumb diff --git a/CRM/Admin/Page/RelationshipType.php b/CRM/Admin/Page/RelationshipType.php index 7bb943f321..7f35a0c1c6 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 f53cbc512f..90f89f2e3b 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 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { * 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 a86f94b322..55de3446b8 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 4e4b1dcd04..6742447ffd 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 70f179a6f0..741b357f40 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 @@ class CRM_Badge_BAO_Badge { * @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 @@ class CRM_Badge_BAO_Badge { * @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 5c9a195d88..6f0fbaa3f5 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 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { } /** - * 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 @@ class CRM_Badge_Form_Layout extends CRM_Admin_Form { /** * 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 9861b4bfd6..e6ab88ba1d 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 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * 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 996a7f26d8..73f5610b80 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 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { if (!$this->_profileId) { @@ -356,9 +349,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { if (empty($this->_fields)) { @@ -397,9 +387,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * 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 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { * @param array $params * Associated array of submitted values. * - * - * @return void + * @return bool */ private function processContribution(&$params) { $dates = array( @@ -859,9 +845,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { * * @param array $value * Associated array of submitted values. - * - * - * @return void */ private function updateContactInfo(&$value) { $value['preserveDBName'] = $this->_preserveDefault; @@ -875,9 +858,10 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * 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 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { } /** - * 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 a7cd8657a4..932b3c424c 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 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get action Links. - * */ public function &links() { } @@ -96,8 +93,6 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * 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 e127d4c245..c1ac5c01c1 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 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * @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 1066794f66..78b653f1b0 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 @@ class CRM_Campaign_BAO_Query { /** * 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 @@ civicrm_activity_assignment.record_type_id = $assigneeID ) "; * 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 c32e985461..c9eaaf7076 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 @@ class CRM_Campaign_Form_Campaign extends CRM_Core_Form { /** * 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 3e0441893e..b4c9c19023 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 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { $this->_defaults = array(); @@ -320,8 +314,8 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { * @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 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { /** * 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 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { * @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 99f053546b..d223b29d26 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 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -250,10 +243,6 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { * 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 e58849f886..af36fd2645 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 @@ class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form { /** * 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 f8eea7218b..4ca5509444 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 @@ class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form { /** * 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 ceb4405953..e1d1bfc045 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 @@ class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form { /** * 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 db0ad58fba..a8d462468a 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 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * 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 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * * * @param CRM_Core_Form $form - * @param $defaults - * - * @return void + * @param array $defaults */ public static function setDefaultValues(&$form, &$defaults) { $contactEditOptions = $form->get('contactEditOptions'); -- 2.25.1