first steps

first steps

Author: bastianallgeier

src/Form/Field/BlocksField.php

@@ -11,6 +11,7 @@
 use Kirby\Data\Json;
 use Kirby\Exception\InvalidArgumentException;
 use Kirby\Exception\NotFoundException;
+use Kirby\Form\Fields;
 use Kirby\Form\FieldClass;
 use Kirby\Form\Form;
 use Kirby\Form\Mixin\EmptyState;
@@ -25,29 +26,60 @@ class BlocksField extends FieldClass
 	use Max;
 	use Min;
 
+	/**
+	 * Defines the allowed block types in the blocks field. See below.
+	 */
 	protected Fieldsets $fieldsets;
 	protected array $forms;
+
+	/**
+	 * Group name to identify all block fields that can share blocks via drag & drop
+	 */
 	protected string|null $group;
+
+	/**
+	 * Saves pretty printed JSON in text files
+	 */
 	protected bool $pretty;
 	protected mixed $value = [];
 
 	public function __construct(
-		string|array|null $empty = null,
-		string|array|null $fieldsets = null,
+		bool $autofocus = false,
+		array $default = [],
+		bool $disabled = false,
+		array|string|null $empty = null,
+		array|string|null $fieldsets = null,
+		array|string|null $help = null,
 		string|null $group = null,
+		array|string|null $label = null,
+		ModelWithContent|null $model = null,
+		string|null $name = null,
 		int|null $max = null,
 		int|null $min = null,
 		bool $pretty = false,
-		...$props
+		bool $required = false,
+		Fields|null $siblings = null,
+		bool $translate = true,
+		array $when = [],
+		string|null $width = '1/1',
 	) {
-		$this->setFieldsets(
-			$fieldsets,
-			$props['model'] ?? App::instance()->site()
+		parent::__construct(
+			autofocus: $autofocus,
+			default: $default,
+			disabled: $disabled,
+			help: $help,
+			label: $label,
+			model: $model,
+			name: $name,
+			required: $required,
+			siblings: $siblings,
+			translate: $translate,
+			when: $when,
+			width: $width
 		);
 
-		parent::__construct(...$props);
-
 		$this->setEmpty($empty);
+		$this->setFieldsets($fieldsets);
 		$this->setGroup($group);
 		$this->setMax($max);
 		$this->setMin($min);
@@ -262,17 +294,14 @@ protected function setDefault(mixed $default = null): void
 		parent::setDefault($default);
 	}
 
-	protected function setFieldsets(
-		string|array|null $fieldsets,
-		ModelWithContent $model
-	): void {
+	protected function setFieldsets(string|array|null $fieldsets): void {
 		if (is_string($fieldsets) === true) {
 			$fieldsets = [];
 		}
 
 		$this->fieldsets = Fieldsets::factory(
 			$fieldsets,
-			['parent' => $model]
+			['parent' => $this->model]
 		);
 	}
 

src/Reflection/DocComment.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Kirby\Reflection;
+
+use ReflectionClass;
+use ReflectionFunction;
+use ReflectionMethod;
+use ReflectionProperty;
+
+class DocComment
+{
+    public function __construct(
+        protected string $comment,
+    ) {
+    }
+
+    public static function from(
+        ReflectionClass|ReflectionFunction|ReflectionMethod|ReflectionProperty|null $object
+    ) {
+        return new static($object?->getDocComment() ?? '');
+    }
+
+    /**
+     * Returns the cleaned docblock text of the given property.
+     */
+    public function description(): string|null
+    {
+        $comment = preg_replace(['#^/\*\*#', '#\*/$#'], '', $this->comment);
+        $lines   = preg_split('/\R/', (string)$comment) ?: [];
+        $lines   = array_map(static fn(string $line): string => ltrim(trim($line), "* \t"), $lines);
+        $lines   = array_filter(
+            $lines,
+            static fn(string $line): bool => $line !== '' && str_starts_with($line, '@') === false
+        );
+
+        return implode(' ', $lines);
+    }
+}

src/Reflection/Field.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Kirby\Reflection;
+
+use Kirby\Form\FieldClass;
+use ReflectionClass;
+use ReflectionProperty;
+
+class Field
+{
+    protected Constructor $constructor;
+    protected ReflectionClass $class;
+
+    public function __construct(
+        protected FieldClass $field
+    ) {
+        $this->class       = new ReflectionClass($field);
+        $this->constructor = new Constructor($field);
+    }
+
+    /**
+     * Returns field properties based on the constructor signature.
+     */
+    public function props(): array
+    {
+        $props  = [];
+        $ignore = ['model', 'siblings', 'props'];
+
+        foreach ($this->constructor->getParameters() as $parameter) {
+            $name = $parameter->getName();
+
+            if (in_array($name, $ignore) === true) {
+                continue;
+            }
+
+            $property = $this->class->hasProperty($name) ? $this->class->getProperty($name) : null;
+            $comment  = DocComment::from($property);
+
+            $props[$name] = [
+                'name'        => $name,
+                'type'        => (string)$parameter->getType(),
+                'default'     => $parameter->getDefaultValue(),
+                'description' => $comment->description()
+            ];
+        }
+
+        return $props;
+    }
+}