Merge pull request #16 from swaggest/phpdoc-pattern-properties

Add pattern/additional properties to phpdoc

Author: vearutop

src/JsonSchema/SchemaBuilder.php

@@ -215,7 +215,7 @@ private function processObject()
                         $this->copyTo(new SchemaBuilder(
                             $property,
                             "\$patternProperty",
-                            $this->path . '->patternProperties->{{$pattern}}',
+                            $this->path . "->patternProperties->{{$pattern}}",
                             $this->phpBuilder
                         ))->build()
                     );

src/JsonSchema/TypeBuilder.php

@@ -56,6 +56,35 @@ private function processLogicType()
         }
     }
 
+    /**
+     * @throws Exception
+     * @throws \Swaggest\PhpCodeBuilder\Exception
+     */
+    private function processAdditionalPatternProperties()
+    {
+        $schema = $this->schema;
+
+        if ($schema->additionalProperties instanceof Schema) {
+            $type = $this->phpBuilder->getType($schema->additionalProperties, $this->path . '->additionalProperties');
+            if ($type !== PhpStdType::mixed()) {
+                $this->result->add(new ArrayOf($type));
+            }
+        }
+
+        if ($schema->patternProperties !== null) {
+            foreach ($schema->patternProperties as $pattern => $property) {
+                if ($property instanceof Schema) {
+                    $type = $this->phpBuilder->getType($property, $this->path . "->patternProperties->{{$pattern}}");
+                    if ($type !== PhpStdType::mixed()) {
+                        $this->result->add(new ArrayOf($type));
+                    }
+                }
+            }
+        }
+
+    }
+
+
     /**
      * @throws Exception
      * @throws \Swaggest\PhpCodeBuilder\Exception
@@ -147,15 +176,13 @@ private function typeSwitch($type)
     }
 
     /**
-     * @param Schema $schema
-     * @param string $path
      * @throws Exception
      * @throws \Swaggest\PhpCodeBuilder\Exception
      */
-    private function processNamedClass($schema, $path)
+    private function processNamedClass()
     {
-        if ($schema->properties !== null) {
-            $class = $this->phpBuilder->getClass($schema, $path);
+        if ($this->schema->properties !== null) {
+            $class = $this->phpBuilder->getClass($this->schema, $this->path);
             $this->result->add($class);
         }
     }
@@ -178,10 +205,11 @@ public function build()
         }
 
 
-        $this->processNamedClass($this->schema, $this->path);
+        $this->processNamedClass();
         $this->processLogicType();
         $this->processArrayType();
         $this->processObjectType();
+        $this->processAdditionalPatternProperties();
 
         if (is_array($this->schema->type)) {
             foreach ($this->schema->type as $type) {

src/PhpStdType.php

@@ -54,7 +54,11 @@ public static function string()
 
     public static function mixed()
     {
-        return new self(self::TYPE_MIXED);
+        static $type = null;
+        if ($type === null) {
+            $type = new self(self::TYPE_MIXED);
+        }
+        return $type;
     }
 
     public static function object()

src/Types/ArrayOf.php

@@ -4,6 +4,7 @@
 
 
 use Swaggest\PhpCodeBuilder\PhpAnyType;
+use Swaggest\PhpCodeBuilder\PhpStdType;
 
 class ArrayOf implements PhpAnyType
 {
@@ -42,6 +43,8 @@ public function renderPhpDocType()
     {
         if ($this->type instanceof OrType) {
             return $this->type->renderArrayPhpDocType();
+        } elseif ($this->type === PhpStdType::mixed()) {
+            return '';
         } else {
             return $this->type->renderPhpDocType() . '[]';
         }

src/Types/OrType.php

@@ -80,6 +80,8 @@ public function simplify()
     {
         if (count($this->types) === 1) {
             return $this->types[0];
+        } elseif (count($this->types) === 0) {
+            return PhpStdType::mixed();
         } else {
             return $this;
         }

tests/src/PHPUnit/JsonSchema/AdvancedTest.php

@@ -421,7 +421,7 @@ public function testPatternProperties()
 
         $expected = <<<'PHP'
 /**
- * @method static mixed import($data, Swaggest\JsonSchema\Context $options = null)
+ * @method static null[]|float[]|bool[]|string[]|mixed[]|array[]|string[] import($data, Swaggest\JsonSchema\Context $options = null)
  */
 class Root extends Swaggest\JsonSchema\Structure\ClassStructure
 {
@@ -452,7 +452,7 @@ public static function setUpProperties($properties, Swaggest\JsonSchema\Schema $
     }
 
     /**
-     * @return null[]|float[]|bool[]|string[]|array[]
+     * @return null[]|float[]|bool[]|string[]|mixed[]|array[]
      * @codeCoverageIgnoreStart
      */
     public function getXValues()

tests/src/Tmp/Entity/Entity.php

@@ -16,7 +16,7 @@
 
 
 /**
- * @method static Entity|string[] import($data, Context $options = null)
+ * @method static Entity|string[]|int[]|bool[] import($data, Context $options = null)
  */
 class Entity extends ClassStructure
 {

tests/src/Tmp/Swagger/Operation.php

@@ -45,7 +45,7 @@ class Operation extends ClassStructure
     /** @var BodyParameter[]|HeaderParameterSubSchema[]|FormDataParameterSubSchema[]|QueryParameterSubSchema[]|PathParameterSubSchema[]|JsonReference[]|array The parameters needed to send a valid API call. */
     public $parameters;
 
-    /** @var mixed Response objects names can either be any valid HTTP status code or 'default'. */
+    /** @var Response[]|JsonReference[] Response objects names can either be any valid HTTP status code or 'default'. */
     public $responses;
 
     /** @var string[]|array The transfer protocol of the API. */
@@ -192,7 +192,7 @@ public function setParameters($parameters)
     /** @codeCoverageIgnoreEnd */
 
     /**
-     * @param mixed $responses Response objects names can either be any valid HTTP status code or 'default'.
+     * @param Response[]|JsonReference[] $responses Response objects names can either be any valid HTTP status code or 'default'.
      * @return $this
      * @codeCoverageIgnoreStart
      */

tests/src/Tmp/Swagger/Paths.php

@@ -18,7 +18,7 @@
 /**
  * Relative paths to the individual endpoints. They must be relative to the 'basePath'.
  * Built from #/definitions/paths
- * @method static mixed import($data, Context $options = null)
+ * @method static PathItem[] import($data, Context $options = null)
  */
 class Paths extends ClassStructure
 {

tests/src/Tmp/Swagger/Responses.php

@@ -18,7 +18,7 @@
 /**
  * Response objects names can either be any valid HTTP status code or 'default'.
  * Built from #/definitions/responses
- * @method static mixed import($data, Context $options = null)
+ * @method static Response[]|JsonReference[] import($data, Context $options = null)
  */
 class Responses extends ClassStructure
 {