Support to read custom attribute for validation when using swagger. (…

…#6379)

src/Annotation/Property.php

@@ -62,7 +62,8 @@ public function __construct(
         AdditionalProperties|bool|null $additionalProperties = null,
         ?array $x = null,
         ?array $attachables = null,
-        public mixed $rules = null
+        public mixed $rules = null,
+        public mixed $attribute = null
     ) {
         parent::__construct(
             $property,

src/Annotation/QueryParameter.php

@@ -45,6 +45,7 @@ public function __construct(
         ?array $x = null,
         ?array $attachables = null,
         public mixed $rules = null,
+        public mixed $attribute = null,
     ) {
         parent::__construct(
             $parameter,

src/Request/AttributeCollector.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Swagger\Request;
+
+use Hyperf\Di\Annotation\AnnotationCollector;
+use Hyperf\Swagger\Annotation\JsonContent;
+use Hyperf\Swagger\Annotation\Property;
+use Hyperf\Swagger\Annotation\QueryParameter;
+use Hyperf\Swagger\Annotation\RequestBody;
+use Hyperf\Swagger\Util;
+
+class AttributeCollector
+{
+    protected static $attributes = [];
+
+    public static function get(string $class, string $method): array
+    {
+        if (! empty(static::$attributes[$class][$method])) {
+            return static::$attributes[$class][$method];
+        }
+        $methodAnnotations = AnnotationCollector::getClassMethodAnnotation($class, $method);
+        /** @var QueryParameter[] $queryParameters */
+        $queryParameters = Util::findAnnotations($methodAnnotations, QueryParameter::class);
+
+        $attributes = [];
+        foreach ($queryParameters as $parameter) {
+            if ($parameter->attribute) {
+                $attributes[$parameter->name] = $parameter->attribute;
+            }
+        }
+
+        /** @var RequestBody $body */
+        $body = Util::findAnnotations($methodAnnotations, RequestBody::class)[0] ?? null;
+        if ($body) {
+            if ($body->_content instanceof JsonContent) {
+                if (is_array($body->_content->properties)) {
+                    foreach ($body->_content->properties as $property) {
+                        if ($property instanceof Property) {
+                            if ($property->attribute) {
+                                $attributes[$property->property] = $property->attribute;
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+        return static::$attributes[$class][$method] = $attributes;
+    }
+}

src/Request/SwaggerRequest.php

@@ -44,4 +44,20 @@ public function rules(): array
 
         return RuleCollector::get($callback[0], $callback[1]);
     }
+
+    public function attributes(): array
+    {
+        /** @var Dispatched $dispatched */
+        $dispatched = RequestContext::getOrNull()?->getAttribute(Dispatched::class);
+        if (! $dispatched) {
+            throw new RuntimeException('The request is invalid.');
+        }
+
+        $callback = $dispatched->handler?->callback;
+        if (! $callback || ! is_array($callback)) {
+            throw new RuntimeException('The SwaggerRequest is only used by swagger annotations.');
+        }
+
+        return AttributeCollector::get($callback[0], $callback[1]);
+    }
 }