some class comments

mutec · mutec · commit 1538de6b115b · 2022-07-27T12:43:15.000+02:00
diff --git a/files/lib/system/form/builder/container/MCAttachmentFormContainer.class.php b/files/lib/system/form/builder/container/MCAttachmentFormContainer.class.php
@@ -11,6 +11,12 @@
 use wcf\system\exception\SystemException;
 use wcf\system\form\builder\field\MCAttachmentFormField;
 
+/**
+ * Container providing the possiblity to upload attachmetns without the need of an wysiwyg-editor
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCAttachmentFormContainer extends FormContainer
 {
     /**
diff --git a/files/lib/system/form/builder/container/MCDummyFormContainer.class.php b/files/lib/system/form/builder/container/MCDummyFormContainer.class.php
@@ -4,6 +4,12 @@
 
 use wcf\system\WCF;
 
+/**
+ * Container without own code; representing it's children only
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCDummyFormContainer extends FormContainer
 {
     /**
diff --git a/files/lib/system/form/builder/container/wysiwyg/MCI18nWysiwygFormContainer.class.php b/files/lib/system/form/builder/container/wysiwyg/MCI18nWysiwygFormContainer.class.php
@@ -13,6 +13,12 @@
 use wcf\system\form\builder\field\wysiwyg\WysiwygAttachmentFormField;
 use wcf\system\Regex;
 
+/**
+ * i18n implementation of WysiwygFormContainer
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCI18nWysiwygFormContainer extends WysiwygFormContainer
 {
     /**
diff --git a/files/lib/system/form/builder/data/processor/MCPrefixedFormDataProcessor.class.php b/files/lib/system/form/builder/data/processor/MCPrefixedFormDataProcessor.class.php
@@ -10,6 +10,12 @@
 use wcf\system\form\builder\IFormDocument;
 use wcf\system\form\builder\IFormNode;
 
+/**
+ * Container grouping it's children's data into an array
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCPrefixedFormDataProcessor extends AbstractFormDataProcessor
 {
     /**
diff --git a/files/lib/system/form/builder/field/MCAttachmentFormField.class.php b/files/lib/system/form/builder/field/MCAttachmentFormField.class.php
@@ -8,6 +8,12 @@
 use wcf\system\WCF;
 use wcf\util\StringUtil;
 
+/**
+ * i18n implementation of WysiwygFormContainer
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCAttachmentFormField extends AbstractFormField
 {
     /**
diff --git a/files/lib/system/form/builder/field/MCBadgeColorFormField.class.php b/files/lib/system/form/builder/field/MCBadgeColorFormField.class.php
@@ -6,6 +6,12 @@
 use wcf\system\form\builder\IFormNode;
 use wcf\util\StringUtil;
 
+/**
+ * Form field providing a badge-color selection with live preview
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCBadgeColorFormField extends AbstractFormField implements
     IAutoFocusFormField,
     IImmutableFormField,
diff --git a/files/lib/system/form/builder/field/MCEmptySingleSelectionFormField.class.php b/files/lib/system/form/builder/field/MCEmptySingleSelectionFormField.class.php
@@ -4,6 +4,12 @@
 
 use wcf\system\WCF;
 
+/**
+ * Implementation of SingleSelectionFormField supporting "noSelection" as option without the need to add it manually
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCEmptySingleSelectionFormField extends SingleSelectionFormField
 {
     /**
diff --git a/files/lib/system/form/builder/field/MCNullableUrlFormField.class.php b/files/lib/system/form/builder/field/MCNullableUrlFormField.class.php
@@ -2,6 +2,12 @@
 
 namespace wcf\system\form\builder\field;
 
+/**
+ * Implementation of UrlFormField, but nullable
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCNullableUrlFormField extends UrlFormField implements INullableFormField
 {
     use TNullableFormField;
diff --git a/files/lib/system/form/builder/field/MCPasswordFormField.class.php b/files/lib/system/form/builder/field/MCPasswordFormField.class.php
@@ -11,13 +11,11 @@
 use wcf\util\StringUtil;
 
 /**
- * Implementation of a form field for single-line text values.
+ * Implementation of a form field for passwords.
  *
- * @author    Matthias Schmidt
+ * @author       Matthias Schmidt, Florian Gail
  * @copyright    2001-2019 WoltLab GmbH
- * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package    WoltLabSuite\Core\System\Form\Builder\Field
- * @since    5.2
+ * @license      GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  */
 class MCPasswordFormField extends AbstractFormField implements
     IAutoFocusFormField,
diff --git a/files/lib/system/form/builder/field/MCPreviewedUploadFormField.class.php b/files/lib/system/form/builder/field/MCPreviewedUploadFormField.class.php
@@ -6,12 +6,11 @@
  * Implementation of a form field for to uploads.
  * This extension supports UploadFile-objects and strings for file-locations.
  *
- * @author  Joshua Ruesweg, Florian Gail
- * @copyright   2001-2019 WoltLab GmbH
- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package WoltLabSuite\Core\System\Form\Builder\Field
- * @since   5.2
- * @deprecated use \wcf\system\form\builder\field\UploadFormField instead
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @deprecated  use \wcf\system\form\builder\field\UploadFormField instead
+ * @package     WoltLabSuite\Core\System\Form\Builder\Field
  */
 class MCPreviewedUploadFormField extends UploadFormField
 {
diff --git a/files/lib/system/form/builder/field/MCTextDisplayFormField.class.php b/files/lib/system/form/builder/field/MCTextDisplayFormField.class.php
@@ -3,13 +3,10 @@
 namespace wcf\system\form\builder\field;
 
 /**
- * Implementation of a form field for single-line text values.
+ * Shows the field's label and a given text instead of an input
  *
- * @author    Matthias Schmidt
- * @copyright    2001-2019 WoltLab GmbH
- * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package    WoltLabSuite\Core\System\Form\Builder\Field
- * @since    5.2
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
  */
 class MCTextDisplayFormField extends AbstractFormField
 {
diff --git a/files/lib/system/form/builder/field/MCTextFormField.class.php b/files/lib/system/form/builder/field/MCTextFormField.class.php
@@ -2,6 +2,12 @@
 
 namespace wcf\system\form\builder\field;
 
+/**
+ * Implementation of TextFormField, but nullable
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCTextFormField extends TextFormField implements INullableFormField
 {
     use TNullableFormField;
diff --git a/files/lib/system/form/builder/field/dependency/MCItemListFormFieldDependency.class.php b/files/lib/system/form/builder/field/dependency/MCItemListFormFieldDependency.class.php
@@ -5,6 +5,12 @@
 use BadMethodCallException;
 use InvalidArgumentException;
 
+/**
+ * Dependency handling UiItemList-based fields as requirement.
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCItemListFormFieldDependency extends AbstractFormFieldDependency
 {
     /**
diff --git a/files/lib/system/form/builder/field/dependency/MCNumericFormFieldDependency.class.php b/files/lib/system/form/builder/field/dependency/MCNumericFormFieldDependency.class.php
@@ -4,6 +4,12 @@
 
 use InvalidArgumentException;
 
+/**
+ * Dependency handling numeric form fields using several operators.
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCNumericFormFieldDependency extends AbstractFormFieldDependency
 {
     /**
diff --git a/files/lib/system/form/builder/field/wysiwyg/MCI18nWysiwygFormField.class.php b/files/lib/system/form/builder/field/wysiwyg/MCI18nWysiwygFormField.class.php
@@ -23,6 +23,12 @@
 use wcf\util\ArrayUtil;
 use wcf\util\StringUtil;
 
+/**
+ * i18n implementation of WysiwygFormField
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCI18nWysiwygFormField extends WysiwygFormField implements II18nFormField
 {
     /**
diff --git a/files/lib/system/form/builder/field/wysiwyg/MCWysiwygAttachmentFormField.class.php b/files/lib/system/form/builder/field/wysiwyg/MCWysiwygAttachmentFormField.class.php
@@ -10,6 +10,12 @@
 use wcf\system\WCF;
 use wcf\util\StringUtil;
 
+/**
+ * A better implementation of the attachment field in WysiwygContainers
+ *
+ * @author      Florian Gail
+ * @copyright   Florian Gail; 2018 - 2022; <https://www.mysterycode.de>
+ */
 class MCWysiwygAttachmentFormField extends AbstractFormField
 {
     use TWysiwygFormNode;
