Merge pull request #8 from PaulHendriks/issue_7_format_property

Add format to class property

Author: butschster

src/Attribute/Field.php

@@ -4,12 +4,15 @@
 
 namespace Spiral\JsonSchemaGenerator\Attribute;
 
+use Spiral\JsonSchemaGenerator\Schema\Format;
+
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 class Field
 {
     public function __construct(
         public readonly string $title = '',
         public readonly string $description = '',
         public readonly mixed $default = null,
+        public readonly ?Format $format = null,
     ) {}
 }

src/Generator.php

@@ -111,12 +111,14 @@ protected function generateProperty(PropertyInterface $property): ?Property
         $title = '';
         $description = '';
         $default = null;
+        $format = null;
 
         $attribute = $property->findAttribute(Field::class);
         if ($attribute !== null) {
             $title = $attribute->title;
             $description = $attribute->description;
             $default = $attribute->default;
+            $format = $attribute->format;
         }
 
         if ($default === null && $property->hasDefaultValue()) {
@@ -135,14 +137,14 @@ protected function generateProperty(PropertyInterface $property): ?Property
 
         $required = $default === null && !$type->allowsNull();
         if ($type->isBuiltin()) {
-            return new Property($type->getName(), $options, $title, $description, $required, $default);
+            return new Property($type->getName(), $options, $title, $description, $required, $default, $format);
         }
 
         // Class or enum
         $class = $type->getName();
 
         return \is_string($class) && \class_exists($class)
-            ? new Property($class, [], $title, $description, $required, $default)
+            ? new Property($class, [], $title, $description, $required, $default, $format)
             : null;
     }
 }

src/Schema/Format.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\JsonSchemaGenerator\Schema;
+
+/**
+ * Based on https://opis.io/json-schema/2.x/formats.html
+ */
+enum Format: string
+{
+    case Date = 'date';
+    case Time = 'time';
+    case DateTime = 'date-time';
+    case Duration = 'duration';
+    case Regex = 'regex';
+    case Email = 'email';
+    case IdnEmail = 'idn-email';
+    case Hostname = 'hostname';
+    case IdnHostname = 'idn-hostname';
+    case Ipv4 = 'ipv4';
+    case Ipv6 = 'ipv6';
+    case JsonPointer = 'json-pointer';
+    case RelativeJsonPointer = 'relative-json-pointer';
+    case Uri = 'uri';
+    case UriReference = 'uri-reference';
+    case UriTemplate = 'uri-template';
+    case Iri = 'iri';
+    case IriReference = 'iri-reference';
+    case Uuid = 'uuid';
+}

src/Schema/Property.php

@@ -21,6 +21,7 @@ public function __construct(
         public readonly string $description = '',
         public readonly bool $required = false,
         public readonly mixed $default = null,
+        public readonly ?Format $format = null,
     ) {
         if (\is_string($this->type) && !\class_exists($this->type)) {
             throw new InvalidTypeException('Invalid type definition.');
@@ -44,6 +45,11 @@ public function jsonSerialize(): array
             $property['default'] = $this->default;
         }
 
+        if ($this->format instanceof Format) {
+            $property['format'] = $this->format->value;
+        }
+
+
         if ($this->type === Type::Union) {
             $property['anyOf'] = $this->options->jsonSerialize();
             return $property;