feat(templates): add support for checkboxes in template filler

Signed-off-by: Elizabeth Danzberger <lizzy7128@tutanota.de>

6 files changed, 146 insertions, 16 deletions

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index b786dcca658..89b25bd8278 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -438,7 +438,10 @@ return array(
     'OCP\\Files\\Storage\\IWriteStreamStorage' => $baseDir . '/lib/public/Files/Storage/IWriteStreamStorage.php',
     'OCP\\Files\\Template\\BeforeGetTemplatesEvent' => $baseDir . '/lib/public/Files/Template/BeforeGetTemplatesEvent.php',
     'OCP\\Files\\Template\\Field' => $baseDir . '/lib/public/Files/Template/Field.php',
+    'OCP\\Files\\Template\\FieldFactory' => $baseDir . '/lib/public/Files/Template/FieldFactory.php',
     'OCP\\Files\\Template\\FieldType' => $baseDir . '/lib/public/Files/Template/FieldType.php',
+    'OCP\\Files\\Template\\Fields\\CheckBoxField' => $baseDir . '/lib/public/Files/Template/Fields/CheckBoxField.php',
+    'OCP\\Files\\Template\\Fields\\RichTextField' => $baseDir . '/lib/public/Files/Template/Fields/RichTextField.php',
     'OCP\\Files\\Template\\FileCreatedFromTemplateEvent' => $baseDir . '/lib/public/Files/Template/FileCreatedFromTemplateEvent.php',
     'OCP\\Files\\Template\\ICustomTemplateProvider' => $baseDir . '/lib/public/Files/Template/ICustomTemplateProvider.php',
     'OCP\\Files\\Template\\ITemplateManager' => $baseDir . '/lib/public/Files/Template/ITemplateManager.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 28c48ac6a76..3b3597d9b8c 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -471,7 +471,10 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Files\\Storage\\IWriteStreamStorage' => __DIR__ . '/../../..' . '/lib/public/Files/Storage/IWriteStreamStorage.php',
         'OCP\\Files\\Template\\BeforeGetTemplatesEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Template/BeforeGetTemplatesEvent.php',
         'OCP\\Files\\Template\\Field' => __DIR__ . '/../../..' . '/lib/public/Files/Template/Field.php',
+        'OCP\\Files\\Template\\FieldFactory' => __DIR__ . '/../../..' . '/lib/public/Files/Template/FieldFactory.php',
         'OCP\\Files\\Template\\FieldType' => __DIR__ . '/../../..' . '/lib/public/Files/Template/FieldType.php',
+        'OCP\\Files\\Template\\Fields\\CheckBoxField' => __DIR__ . '/../../..' . '/lib/public/Files/Template/Fields/CheckBoxField.php',
+        'OCP\\Files\\Template\\Fields\\RichTextField' => __DIR__ . '/../../..' . '/lib/public/Files/Template/Fields/RichTextField.php',
         'OCP\\Files\\Template\\FileCreatedFromTemplateEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Template/FileCreatedFromTemplateEvent.php',
         'OCP\\Files\\Template\\ICustomTemplateProvider' => __DIR__ . '/../../..' . '/lib/public/Files/Template/ICustomTemplateProvider.php',
         'OCP\\Files\\Template\\ITemplateManager' => __DIR__ . '/../../..' . '/lib/public/Files/Template/ITemplateManager.php',
diff --git a/lib/public/Files/Template/Field.php b/lib/public/Files/Template/Field.php
index 9a847d29ce0..dd65ef857ea 100644
--- a/lib/public/Files/Template/Field.php
+++ b/lib/public/Files/Template/Field.php
@@ -12,37 +12,35 @@ namespace OCP\Files\Template;
 /**
  * @since 30.0.0
  */
-class Field implements \JsonSerializable {
-	private string $index;
-	private string $content;
-	private FieldType $type;
-	private ?string $alias;
-	private ?int $id;
-	private ?string $tag;
+abstract class Field implements \JsonSerializable {
+	public ?string $alias = null;
+	public ?string $tag = null;
+	public ?int $id = null;
 
 	/**
 	 * @since 30.0.0
 	 */
-	public function __construct(string $index, string $content, FieldType $type, ?string $alias = null, ?int $id = null, ?string $tag = null) {
-		$this->index = $index;
-		$this->alias = $alias;
-		$this->type = $type;
-		$this->id = $id;
-		$this->tag = $tag;
-		$this->content = $content;
+	public function __construct(
+		private string $index,
+		private FieldType $type
+	) {
 	}
 
 	/**
 	 * @since 30.0.0
 	 */
+	abstract public function setValue(mixed $value): void;
+
+	/**
+	 * @since 30.0.0
+	 */
 	public function jsonSerialize(): array {
 		return [
 			'index' => $this->index,
-			'content' => $this->content,
 			'type' => $this->type->value,
 			'alias' => $this->alias,
-			'id' => $this->id,
 			'tag' => $this->tag,
+			'id' => $this->id,
 		];
 	}
 }
diff --git a/lib/public/Files/Template/FieldFactory.php b/lib/public/Files/Template/FieldFactory.php
new file mode 100644
index 00000000000..4c0fff6b46f
--- /dev/null
+++ b/lib/public/Files/Template/FieldFactory.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Files\Template;
+
+use OCP\Files\Template\Fields\CheckBoxField;
+use OCP\Files\Template\Fields\RichTextField;
+
+/**
+ * @since 30.0.0
+ */
+class FieldFactory {
+	/**
+	 * @since 30.0.0
+	 */
+	public static function createField(
+		string $index,
+		FieldType $type
+	): Field {
+		return match ($type) {
+			FieldType::RichText => new RichTextField($index, $type),
+			FieldType::CheckBox => new CheckBoxField($index, $type),
+			default => throw new InvalidFieldTypeException(),
+		};
+	}
+}
diff --git a/lib/public/Files/Template/Fields/CheckBoxField.php b/lib/public/Files/Template/Fields/CheckBoxField.php
new file mode 100644
index 00000000000..48ccb04336a
--- /dev/null
+++ b/lib/public/Files/Template/Fields/CheckBoxField.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Files\Template\Fields;
+
+use OCP\Files\Template\Field;
+use OCP\Files\Template\FieldType;
+
+/**
+ * @since 30.0.0
+ */
+class CheckBoxField extends Field {
+	private bool $checked = false;
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function __construct(string $index, FieldType $type) {
+		parent::__construct($index, $type);
+	}
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function setValue(mixed $value): void {
+		if (!is_bool($value)) {
+			throw new \Exception('Invalid value for checkbox field type');
+		}
+
+		$this->checked = $value;
+	}
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function jsonSerialize(): array {
+		$jsonProperties = parent::jsonSerialize();
+
+		return array_merge($jsonProperties, ['checked' => $this->checked]);
+	}
+}
diff --git a/lib/public/Files/Template/Fields/RichTextField.php b/lib/public/Files/Template/Fields/RichTextField.php
new file mode 100644
index 00000000000..14539bc9dbd
--- /dev/null
+++ b/lib/public/Files/Template/Fields/RichTextField.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Files\Template\Fields;
+
+use OCP\Files\Template\Field;
+use OCP\Files\Template\FieldType;
+
+/**
+ * @since 30.0.0
+ */
+class RichTextField extends Field {
+	private string $content = '';
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function __construct(string $index, FieldType $type) {
+		parent::__construct($index, $type);
+	}
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function setValue(mixed $value): void {
+		if (!is_string($value)) {
+			throw new \Exception('Invalid value for rich-text field type');
+		}
+
+		$this->content = $value;
+	}
+
+	/**
+	 * @since 30.0.0
+	 */
+	public function jsonSerialize(): array {
+		$jsonProperties = parent::jsonSerialize();
+
+		return array_merge($jsonProperties, ['content' => $this->content]);
+	}
+}