From 4c78d3019b6b77806cf04df6a05c28785e564ce1 Mon Sep 17 00:00:00 2001 From: Alexander Ebert Date: Wed, 21 Jun 2017 12:17:51 +0200 Subject: [PATCH] Added some missing comments and minor cleanup --- .../data/contact/option/ContactOptionAction.class.php | 5 ++--- wcfsetup/install/files/lib/form/ContactForm.class.php | 11 +++++++++++ .../lib/system/option/ContactOptionHandler.class.php | 8 ++++++++ .../lib/system/option/CustomOptionHandler.class.php | 10 ++++++++-- 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php b/wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php index 5686bfe526..88e09db585 100644 --- a/wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php +++ b/wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php @@ -2,12 +2,11 @@ namespace wcf\data\contact\option; use wcf\data\contact\recipient\ContactRecipient; use wcf\data\custom\option\CustomOptionAction; -use wcf\system\email\Email; -use wcf\system\email\Mailbox; use wcf\system\email\mime\MimePartFacade; use wcf\system\email\mime\RecipientAwareTextMimePart; +use wcf\system\email\Email; +use wcf\system\email\Mailbox; use wcf\system\language\LanguageFactory; -use wcf\system\mail\Mail; use wcf\system\option\ContactOptionHandler; /** diff --git a/wcfsetup/install/files/lib/form/ContactForm.class.php b/wcfsetup/install/files/lib/form/ContactForm.class.php index 5860646331..746cabf532 100644 --- a/wcfsetup/install/files/lib/form/ContactForm.class.php +++ b/wcfsetup/install/files/lib/form/ContactForm.class.php @@ -20,8 +20,16 @@ use wcf\util\StringUtil; * @package WoltLabSuite\Core\Form */ class ContactForm extends AbstractCaptchaForm { + /** + * sender email address + * @var string + */ public $email = ''; + /** + * sender name + * @var string + */ public $name = ''; /** @@ -63,6 +71,9 @@ class ContactForm extends AbstractCaptchaForm { } } + /** + * @inheritDoc + */ public function readFormParameters() { parent::readFormParameters(); diff --git a/wcfsetup/install/files/lib/system/option/ContactOptionHandler.class.php b/wcfsetup/install/files/lib/system/option/ContactOptionHandler.class.php index b49dac862d..ac77347a91 100644 --- a/wcfsetup/install/files/lib/system/option/ContactOptionHandler.class.php +++ b/wcfsetup/install/files/lib/system/option/ContactOptionHandler.class.php @@ -2,6 +2,14 @@ namespace wcf\system\option; use wcf\system\cache\builder\ContactOptionCacheBuilder; +/** + * Option handler implementation for the contact form. + * + * @author Alexander Ebert + * @copyright 2001-2017 WoltLab GmbH + * @license GNU Lesser General Public License + * @package WoltLabSuite\Core\System\Option + */ class ContactOptionHandler extends CustomOptionHandler { /** * @inheritDoc diff --git a/wcfsetup/install/files/lib/system/option/CustomOptionHandler.class.php b/wcfsetup/install/files/lib/system/option/CustomOptionHandler.class.php index 948b331755..38d8b37fb1 100644 --- a/wcfsetup/install/files/lib/system/option/CustomOptionHandler.class.php +++ b/wcfsetup/install/files/lib/system/option/CustomOptionHandler.class.php @@ -5,14 +5,20 @@ use wcf\data\option\Option; use wcf\system\exception\NotImplementedException; use wcf\system\exception\UserInputException; +/** + * Default implementation for custom option handling. + * + * @author Alexander Ebert + * @copyright 2001-2017 WoltLab GmbH + * @license GNU Lesser General Public License + * @package WoltLabSuite\Core\System\Option + */ abstract class CustomOptionHandler extends OptionHandler { /** * Gets all options and option categories from cache. */ protected function readCache() { throw new NotImplementedException(); - - $this->cachedOptions = FileOptionCacheBuilder::getInstance()->getData(); } /** -- 2.20.1