Merge pull request #111 from php-openapi/inverse-relations

inverse-relations and bugs-fixing

Author: cebe

docker-compose.yml

@@ -2,6 +2,7 @@ name: yii2-docker
 services:
     php:
         image: yii2-openapi-php:${PHP_VERSION:-8.3}
+        pull_policy: build
         build:
             dockerfile: tests/docker/Dockerfile
             context: .

src/generator/default/dbmodel.php

@@ -4,9 +4,52 @@
  * @var string $namespace
  * @var string $relationNamespace
  **/
+use cebe\yii2openapi\lib\items\AttributeRelation;
 use yii\helpers\Inflector;
 use yii\helpers\VarDumper;
 
+$allCoveredClasses = array_merge(
+    array_map(fn($r) => $r->getClassName(), (array)$model->relations),
+    array_map(fn($r) => $r->relatedClassName, (array)$model->many2many),
+    array_map(fn($r) => $r->getClassName(), (array)$model->nonDbRelations)
+);
+/**
+ * Resolve inverse relation method names from the FK column name of the other model.
+ * Relations already covered by $model->relations, many2many, or nonDbRelations are skipped.
+ * Relations from models declared with "x-table: false" are skipped (no real table, no FK).
+ *
+ * Naming logic (model being generated = e.g. "Lead", $modelSnake = "lead"):
+ *   1. Take the FK column name from the other model (e.g. Order.customer_lead_id)
+ *   2. Strip trailing "_id"              → "customer_lead"
+ *   3. Strip trailing "_<modelSnake>"    → "customer"
+ *   4. If a prefix remains, prepend it to the pluralized class name:
+ *        "customer" + "Orders"           → getCustomerOrders()
+ *      If no prefix remains (plain FK like "lead_id"):
+ *        "" + "Orders"                   → getOrders()
+ *
+ * Examples: Order has three FK columns pointing to Lead ($model->name = "Lead"):
+ *
+ *   FK column (on Order)      | generated on Order      | generated on Lead (inverse)
+ *   --------------------------|-------------------------|----------------------------
+ *   lead_id                   | getLead()               | getOrders()
+ *   customer_lead_id          | getCustomerLead()       | getCustomerOrders()
+ *   billing_lead_id           | getBillingLead()        | getBillingOrders()
+ */
+$modelSnake = Inflector::underscore($model->name);
+$inverseRelations = array_map(function (AttributeRelation $relation) use ($modelSnake): array {
+    $inverseMethod = $relation->getMethod() === 'hasOne' ? 'hasMany' : 'hasOne';
+    $classBase = $inverseMethod === 'hasMany' ? Inflector::pluralize($relation->getCamelName()) : $relation->getCamelName();
+    $fkBase = preg_replace('/_id$/', '', $relation->getForeignName());
+    $prefix = preg_replace('/_?' . preg_quote($modelSnake, '/') . '$/', '', $fkBase);
+    return [
+        'relation' => $relation,
+        'inverseMethod' => $inverseMethod,
+        'inverseName' => $prefix !== '' ? Inflector::camelize($prefix) . $classBase : $classBase,
+    ];
+}, array_filter(
+    (array)$model->belongsToRelations,
+    fn(AttributeRelation $r) => !in_array($r->getClassName(), $allCoveredClasses) && $r->getTableName() !== ''
+));
 ?>
 <?= '<?php' ?>
 
@@ -45,6 +88,15 @@
 <?php foreach ($model->many2many as $relation): ?>
  * @property array|\<?= trim($relationNamespace, '\\') ?>\<?= $relation->relatedClassName ?>[] $<?= Inflector::variablize($relation->name) ?>
 
+<?php endforeach; ?>
+<?php foreach ($inverseRelations as $inverse): ?>
+<?php if ($inverse['inverseMethod'] === 'hasOne'):?>
+ * @property \<?= trim($relationNamespace, '\\') ?>\<?= $inverse['relation']->getClassName() ?> $<?= Inflector::variablize($inverse['inverseName']) ?>
+
+<?php else:?>
+ * @property array|\<?= trim($relationNamespace, '\\') ?>\<?= $inverse['relation']->getClassName() ?>[] $<?= Inflector::variablize($inverse['inverseName']) ?>
+
+<?php endif?>
 <?php endforeach; ?>
  */
 abstract class <?= $model->getClassName() ?> extends \yii\db\ActiveRecord
@@ -146,14 +198,17 @@ public function get<?= $relation->getCamelName() ?>()
 <?php endif;?>
     }
 <?php endforeach; ?>
-<?php $i = 1; $usedRelationNames = [];
-foreach ($model->belongsToRelations as $relationName => $relation): ?><?php $number = in_array($relation->getCamelName(), $usedRelationNames) ? $i : '' ?>
+<?php foreach ($model->nonDbRelations as $nonDbRelation): ?>
 
-    # belongs to relation
-    public function get<?= $relation->getCamelName() . ($number) ?>()
+    abstract public function get<?= $nonDbRelation->getCamelName() ?>(): \yii\db\ActiveQuery;
+<?php endforeach; ?>
+<?php foreach ($inverseRelations as $inverse): ?>
+
+    // inverse relation
+    public function get<?= $inverse['inverseName'] ?>()
     {
-        return $this-><?= $relation->getMethod() ?>(\<?= trim($relationNamespace, '\\') ?>\<?= $relation->getClassName() ?>::class, <?php
-    echo $relation->linkToString() ?>);
+        return $this-><?= $inverse['inverseMethod'] ?>(\<?= trim($relationNamespace, '\\') ?>\<?= $inverse['relation']->getClassName() ?>::class, <?php
+    echo $inverse['relation']->linkToString() ?>);
     }
-<?php $i++; $usedRelationNames[] = $relation->getCamelName(); endforeach; ?>
+<?php endforeach; ?>
 }

src/lib/FakerStubResolver.php

@@ -104,7 +104,13 @@ public function resolve(): ?string
             $result = $this->fakeForFloat($limits['min'], $limits['max']);
         } elseif ($this->attribute->phpType === 'array' ||
             substr($this->attribute->phpType, -2) === '[]') {
-            $result = $this->fakeForArray($this->property->getProperty());
+            $property = $this->property->getProperty();
+            if ($property->type === 'object') {
+                // A JSONB/JSON column declared as type:object in the spec has phpType=array but must
+                // be faked as an object, not as an array.
+                return $this->fakeForObject($property);
+            }
+            $result = $this->fakeForArray($property);
             if ($result !== '$faker->words()') { # example for array will only work with a list/`$faker->words()`
                 return $result;
             }
@@ -122,6 +128,7 @@ public function resolve(): ?string
 
         $example = $this->property->getAttr('example');
         $example = VarExporter::export($example);
+        $example = preg_replace('/\n/', "\n        ", $example);
         return str_replace('$faker->', '$faker->optional(0.92, ' . $example . ')->', $result);
     }
 
@@ -284,7 +291,8 @@ private function fakeForArray(SpecObjectInterface $property, int $count = 4): st
         $items = $property->items;
 
         if (!$items) {
-            return $this->arbitraryArray();
+            // Required fields cannot use [] — Yii2's isEmpty() treats empty arrays as blank.
+            return $this->attribute->required ? $this->arbitraryArray() : '[]';
         }
 
         if ($items instanceof Reference) {
@@ -299,46 +307,121 @@ private function fakeForArray(SpecObjectInterface $property, int $count = 4): st
         if ($type === null) {
             return $this->arbitraryArray();
         }
-        $aFaker = $this->aElementFaker($this->property->getProperty(), $this->attribute->columnName);
         if (in_array($type, ['string', 'number', 'integer', 'boolean', 'array'])) {
+            $aFaker = $this->aElementFaker($this->property->getProperty(), $this->attribute->columnName);
             return $this->wrapInArray($aFaker, $uniqueItems, $count);
         }
 
         if ($type === 'object') {
             $result = $this->fakeForObject($items);
+            if ($result === '(object) []') {
+                return '[]';
+            }
             return $this->wrapInArray($result, $uniqueItems, $count);
         }
 
         return '[]';
     }
 
     /**
+     * Generates a PHP array literal string for an OpenAPI object property.
+     * The output is embedded as PHP code in Faker fixture files, not as JSON.
+     *
+     * Flow: Faker assigns a PHP array to the model property → ActiveRecord passes it
+     * to the DB driver → the driver JSON-encodes it before storing.
+     * Result in DB:
+     *   PHP []              → json_encode([])             → []           (JSON array)
+     *   PHP ['key' => 'v']  → json_encode(['key' => 'v']) → {"key": "v"} (JSON object)
+     *
+     * A non-empty associative array correctly becomes a JSON object in the DB.
+     * An empty PHP array always becomes [] in the DB, never {} — regardless of whether
+     * the OpenAPI field is typed as "object" or "array". For test/faker data without
+     * defined properties this is acceptable, as no schema is enforced.
      * @internal
      */
-    public function fakeForObject(SpecObjectInterface $items): string
+    public function fakeForObject(SpecObjectInterface $items, int $depth = 1): string
     {
         if (!$items->properties) {
-            return $this->arbitraryArray();
+            return '(object) []';
         }
 
-        $props = '[' . PHP_EOL;
+        $indent = str_repeat('    ', $depth + 3);
+        $closingIndent = str_repeat('    ', $depth + 2);
+        $parts = [];
 
         foreach ($items->properties as $name => $prop) {
             /** @var SpecObjectInterface $prop */
 
-            if (!empty($prop->properties)) { // nested object
-                $result = $this->{__FUNCTION__}($prop);
+            if (!$prop instanceof Reference && ($prop->type === 'object' || !empty($prop->properties))) {
+                $result = $this->fakeForObject($prop, $depth + 1);
             } else {
                 $result = $this->aElementFaker(['items' => $prop->getSerializableData()], $name);
+                if (str_starts_with($result, 'array_map')) {
+                    $result = $this->reindentArrayMapForObject($result, $depth);
+                }
             }
-            $props .= '\'' . $name . '\' => ' . $result . ',' . PHP_EOL;
+            $parts[] = $indent . '\'' . $name . '\' => ' . $result . ',';
         }
 
-        $props .= ']';
+        $props = '[' . PHP_EOL . implode(PHP_EOL, $parts) . PHP_EOL . $closingIndent . ']';
 
         return $props;
     }
 
+    /**
+     * Re-indents a compact wrapInArray() output string to match the correct depth inside fakeForObject().
+     * wrapInArray() always uses hardcoded 12/8-space indentation; when its result is embedded as a
+     * property value inside a fakeForObject() output at depth >= 1, the indentation must be adjusted.
+     * For a nested array_map body the inner call is expanded to multi-line style via expandCompactArrayMap().
+     */
+    private function reindentArrayMapForObject(string $code, int $depth): string
+    {
+        $bodyIndent  = str_repeat('    ', $depth + 4);
+        $closeIndent = str_repeat('    ', $depth + 3);
+
+        $pat = '/^array_map\(function \(\) use \(\$faker, \$uniqueFaker\) \{\n            (.*)\n        \}, range\(1, (\d+)\)\)$/s';
+        if (!preg_match($pat, $code, $m)) {
+            return $code;
+        }
+        [$body, $count] = [$m[1], $m[2]];
+
+        if (str_starts_with($body, 'return array_map(')) {
+            $inner    = substr($body, 7, -1); // strip "return " prefix and trailing ";"
+            $expanded = $this->expandCompactArrayMap($inner, $bodyIndent);
+            return "array_map(function () use (\$faker, \$uniqueFaker) {\n"
+                . $bodyIndent  . "return {$expanded};\n"
+                . $closeIndent . "},\n"
+                . $closeIndent . "range(1, {$count}))";
+        }
+
+        return "array_map(function () use (\$faker, \$uniqueFaker) {\n"
+            . $bodyIndent  . $body . "\n"
+            . $closeIndent . "},\n"
+            . $closeIndent . "range(1, {$count}))";
+    }
+
+    /**
+     * Expands a compact wrapInArray() string (single-line function + range) into multi-line style,
+     * using $baseIndent as the reference indentation level for the opening "array_map(" line.
+     */
+    private function expandCompactArrayMap(string $code, string $baseIndent): string
+    {
+        $pat = '/^array_map\(function \(\) use \(\$faker, \$uniqueFaker\) \{\n            (.*)\n        \}, range\(1, (\d+)\)\)$/s';
+        if (!preg_match($pat, $code, $m)) {
+            return $code;
+        }
+        [$body, $count] = [$m[1], $m[2]];
+        $funcIndent  = $baseIndent . '    ';
+        $innerIndent = $baseIndent . '        ';
+
+        return "array_map(\n"
+            . $funcIndent  . "function () use (\$faker, \$uniqueFaker) {\n"
+            . $innerIndent . $body . "\n"
+            . $funcIndent  . "},\n"
+            . $funcIndent  . "range(1, {$count})\n"
+            . $baseIndent  . ")";
+    }
+
     /**
      * This method must be only used incase of array
      * @param SpecObjectInterface $items
@@ -355,15 +438,28 @@ public function fakeForObject(SpecObjectInterface $items): string
     public function handleOneOf(SpecObjectInterface $items, int $count): string
     {
         $result = '';
+        $indent = str_repeat(' ', 12);
         foreach ($items->oneOf as $key => $aDataType) {
             /** @var Schema|Reference $aDataType */
 
             $inp = $aDataType instanceof Reference ? $aDataType : ['items' => $aDataType->getSerializableData()];
             $aFaker = $this->aElementFaker($inp, $this->attribute->columnName);
+            /**
+             * Each $dataTypeN gets its own line (12-space indent = wrapInArray body level).
+             * wrapInArray output (array_map) gets +4 spaces on continuation lines (12→16, 8→12).
+             * fakeForObject output (starts with "[") is left as-is — depth=1 already gives 16/12.
+             * return goes on its own line.
+             */
+            if (str_contains($aFaker, PHP_EOL) && !str_starts_with($aFaker, '[')) {
+                $aFaker = str_replace(PHP_EOL, PHP_EOL . '    ', $aFaker);
+            }
+            if ($result !== '') {
+                $result .= PHP_EOL . $indent;
+            }
             $result .= '$dataType' . $key . ' = ' . $aFaker . ';';
         }
         $ct = count($items->oneOf) - 1;
-        $result .= 'return ${"dataType".rand(0, ' . $ct . ')}';
+        $result .= PHP_EOL . $indent . 'return ${"dataType".rand(0, ' . $ct . ')}';
         return $result;
     }
 

src/lib/openapi/PropertySchema.php

@@ -100,6 +100,7 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
         $this->isPk = $name === $schema->getPkName();
 
         $onUpdate = $onDelete = $xFaker = $reference = $fkColName = null;
+        $xDbTypeFalse = false;
 
         foreach ($property->allOf ?? [] as $element) {
             // x-fk-on-delete | x-fk-on-update
@@ -122,6 +123,11 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
             if (!empty($element->{CustomSpecAttr::FK_COLUMN_NAME})) {
                 $fkColName = $element->{CustomSpecAttr::FK_COLUMN_NAME};
             }
+
+            // x-db-type: false → treat as non-DB reference (no FK column, no migration)
+            if (isset($element->{CustomSpecAttr::DB_TYPE}) && $element->{CustomSpecAttr::DB_TYPE} === false) {
+                $xDbTypeFalse = true;
+            }
         }
 
         if (
@@ -143,6 +149,9 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
             $this->xFaker = $xFaker;
             $this->property = $reference;
             $property = $this->property;
+        } elseif ($xDbTypeFalse && $reference instanceof Reference) {
+            $this->property = $reference;
+            $property = $this->property;
         }
 
         // don't go reference part if `x-no-relation` is true
@@ -152,6 +161,9 @@ public function __construct(SpecObjectInterface $property, string $name, Compone
 
         if ($property instanceof Reference) {
             $this->initReference();
+            if ($xDbTypeFalse) {
+                $this->isNonDbReference = true;
+            }
         } elseif (
             isset($property->type, $property->items) && $property->type === 'array'
             && $property->items instanceof Reference

tests/docker/Dockerfile

@@ -9,11 +9,8 @@ ENV DEBIAN_FRONTEND=noninteractive
 RUN echo "force-unsafe-io" > /etc/dpkg/dpkg.cfg.d/02apt-speedup && \
     echo "Acquire::http {No-Cache=True;};" > /etc/apt/apt.conf.d/no-cache
 RUN apt-get update && \
-    apt-get -y install \
-        gnupg2 && \
-    apt-key update && \
-    apt-get update && \
     apt-get install -y --no-install-recommends \
+            gnupg2 \
             imagemagick \
             libmagickwand-dev libmagickcore-dev \
             libfreetype6-dev \
@@ -35,7 +32,7 @@ RUN apt-get update && \
         apt-get clean && \
         rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
         # https://xdebug.org/docs/compat \
-        && if [ "$BUILD_PHP_VERSION" = "8.2" ] || [ "$BUILD_PHP_VERSION" = "8.3" ] ; then pecl install xdebug ; else pecl install xdebug-3.1.5 ; fi \
+        && if [ "$BUILD_PHP_VERSION" = "8.2" ] || [ "$BUILD_PHP_VERSION" = "8.3" ] ; then pecl install xdebug-3.3.2 ; else pecl install xdebug-3.1.5 ; fi \
         && docker-php-ext-enable xdebug \
         && docker-php-ext-install \
                 zip \

tests/fixtures/blog.php

@@ -117,11 +117,9 @@
                 ->setDescription('The User')
                 ->setFakerStub('$faker->randomElement(\app\models\User::find()->select("id")->column())'),
             'message' => (new Attribute('message', ['phpType' => 'array', 'dbType' => 'json', 'xDbType' => 'json']))
-                ->setRequired()->setDefault([])->setFakerStub('$faker->words()'),
+                ->setRequired()->setDefault([])->setXDescriptionIsComment(null)->setFakerStub('$faker->words()'),
             'meta_data' => (new Attribute('meta_data', ['phpType' => 'array', 'dbType' => 'json', 'xDbType' => 'json']))
-                ->setDefault([])->setFakerStub('array_map(function () use ($faker, $uniqueFaker) {
-            return $faker->words();
-        }, range(1, 4))'),
+                ->setDefault([])->setXDescriptionIsComment(null)->setFakerStub('[]'),
             'created_at' => (new Attribute('created_at',['phpType' => 'int', 'dbType' => 'integer']))
                 ->setRequired()->setFakerStub('$faker->unixTime'),
         ],

tests/specs/blog/models/CommentFaker.php

@@ -33,9 +33,7 @@ public function generateModel($attributes = [])
         $model->post_id = $faker->randomElement(\app\models\Post::find()->select("id")->column());
         $model->author_id = $faker->randomElement(\app\models\User::find()->select("id")->column());
         $model->message = $faker->words();
-        $model->meta_data = array_map(function () use ($faker, $uniqueFaker) {
-            return $faker->words();
-        }, range(1, 4));
+        $model->meta_data = [];
         $model->created_at = $faker->unixTime;
         if (!is_callable($attributes)) {
             $model->setAttributes($attributes, false);

tests/specs/blog/models/base/Category.php

@@ -38,10 +38,4 @@ public function getPosts()
     {
         return $this->hasMany(\app\models\Post::class, ['category_id' => 'id'])->inverseOf('category');
     }
-
-    # belongs to relation
-    public function getPost()
-    {
-        return $this->hasOne(\app\models\Post::class, ['category_id' => 'id']);
-    }
 }