Add "wysiwyg" form option type

Author: BurntimeX

com.woltlab.wcf/objectType.xml

@@ -157,6 +157,10 @@
 			<definitionname>com.woltlab.wcf.message</definitionname>
 			<disallowedBBCodesPermission>user.signature.disallowedBBCodes</disallowedBBCodesPermission>
 		</type>
+		<type>
+			<name>com.woltlab.wcf.genericFormOption</name>
+			<definitionname>com.woltlab.wcf.message</definitionname>
+		</type>
 		<type>
 			<name>com.woltlab.wcf.user.signature</name>
 			<definitionname>com.woltlab.wcf.attachment.objectType</definitionname>

wcfsetup/install/files/lib/system/form/option/FormOptionHandler.class.php

@@ -52,6 +52,7 @@ private function getDefaultFormOptions(): array
                 new TextFormOption(),
                 new TextareaFormOption(),
                 new UrlFormOption(),
+                new WysiwygFormOption(),
             ] as $defaultOption
         ) {
             $options[$defaultOption->getId()] = $defaultOption;

wcfsetup/install/files/lib/system/form/option/WysiwygFormOption.class.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace wcf\system\form\option;
+
+use wcf\data\DatabaseObjectList;
+use wcf\system\form\builder\field\TextFormField;
+use wcf\system\form\builder\field\wysiwyg\WysiwygFormField;
+use wcf\system\form\option\formatter\WysiwygFormatter;
+use wcf\system\form\option\formatter\WysiwygPlainTextFormatter;
+use wcf\system\WCF;
+
+/**
+ * Implementation of a form option using the WYSIWYG editor.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+class WysiwygFormOption extends AbstractFormOption
+{
+    #[\Override]
+    public function getId(): string
+    {
+        return 'wysiwyg';
+    }
+
+    #[\Override]
+    public function getFilterFormField(string $id, array $configurationData = []): TextFormField
+    {
+        return TextFormField::create($id);
+    }
+
+    #[\Override]
+    public function getFormField(string $id, array $configurationData = []): WysiwygFormField
+    {
+        return WysiwygFormField::create($id)
+            ->objectType('com.woltlab.wcf.genericFormOption');
+    }
+
+    #[\Override]
+    public function getConfigurationFormFields(): array
+    {
+        return ['required'];
+    }
+
+    #[\Override]
+    public function applyFilter(DatabaseObjectList $list, string $columnName, mixed $value): void
+    {
+        $list->getConditionBuilder()->add("{$columnName} LIKE ?", ['%' . WCF::getDB()->escapeLikeValue($value) . '%']);
+    }
+
+    #[\Override]
+    public function getFormatter(): WysiwygFormatter
+    {
+        return new WysiwygFormatter();
+    }
+
+    #[\Override]
+    public function getPlainTextFormatter(): WysiwygPlainTextFormatter
+    {
+        return new WysiwygPlainTextFormatter();
+    }
+}

wcfsetup/install/files/lib/system/form/option/formatter/WysiwygFormatter.class.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace wcf\system\form\option\formatter;
+
+use wcf\system\html\output\HtmlOutputProcessor;
+
+/**
+ * Formatter for wysiwyg form options.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+final class WysiwygFormatter implements IFormOptionFormatter
+{
+    #[\Override]
+    public function format(string $value, int $languageID, array $configurationData): string
+    {
+        $processor = new HtmlOutputProcessor();
+        $processor->process($value, 'com.woltlab.wcf.genericFormOption', 0, true, $languageID);
+
+        return $processor->getHtml();
+    }
+}

wcfsetup/install/files/lib/system/form/option/formatter/WysiwygPlainTextFormatter.class.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace wcf\system\form\option\formatter;
+
+use wcf\system\html\output\HtmlOutputProcessor;
+
+/**
+ * Plain text version of the formatter for wysiwyg form options.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+final class WysiwygPlainTextFormatter implements IFormOptionFormatter
+{
+    #[\Override]
+    public function format(string $value, int $languageID, array $configurationData): string
+    {
+        $processor = new HtmlOutputProcessor();
+        $processor->setOutputType('text/plain');
+        $processor->process($value, 'com.woltlab.wcf.genericFormOption', 0, true, $languageID);
+
+        return $processor->getHtml();
+    }
+}

wcfsetup/install/lang/de.xml

@@ -4129,6 +4129,7 @@ Dateianhänge:
 		<item name="wcf.form.option.textarea"><![CDATA[Mehrzeiliger Text]]></item>
 		<item name="wcf.form.option.sourceCode"><![CDATA[Quellcode]]></item>
 		<item name="wcf.form.option.url"><![CDATA[Link]]></item>
+		<item name="wcf.form.option.wysiwyg"><![CDATA[Wysiwyg]]></item>
 		<item name="wcf.form.option.shared.currency"><![CDATA[Währung]]></item>
 		<item name="wcf.form.option.shared.defaultValue"><![CDATA[Standardwert]]></item>
 		<item name="wcf.form.option.shared.maxLength"><![CDATA[Maximale Textlänge]]></item>

wcfsetup/install/lang/en.xml

@@ -4075,6 +4075,7 @@ Attachments:
 		<item name="wcf.form.option.textarea"><![CDATA[Multiline text]]></item>
 		<item name="wcf.form.option.sourceCode"><![CDATA[Source code]]></item>
 		<item name="wcf.form.option.url"><![CDATA[Link]]></item>
+		<item name="wcf.form.option.wysiwyg"><![CDATA[Wysiwyg]]></item>
 		<item name="wcf.form.option.shared.currency"><![CDATA[Currency]]></item>
 		<item name="wcf.form.option.shared.defaultValue"><![CDATA[Default Value]]></item>
 		<item name="wcf.form.option.shared.maxLength"><![CDATA[Maximum Text Length]]></item>