Merge branch '90-implement-belongs-to-relations-in-models' of github.com:php-openapi/yii2-openapi into fix-conflicting-pull-requests

Author: SOHELAHMED7

src/generator/default/dbmodel.php

@@ -146,4 +146,14 @@ 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 : '' ?>
+
+    # belongs to relation
+    public function get<?= $relation->getCamelName() . ($number) ?>()
+    {
+        return $this-><?= $relation->getMethod() ?>(\<?= trim($relationNamespace, '\\') ?>\<?= $relation->getClassName() ?>::class, <?php
+    echo $relation->linkToString() ?>);
+    }
+<?php $i++; $usedRelationNames[] = $relation->getCamelName(); endforeach; ?>
 }

src/lib/AttributeResolver.php

@@ -37,6 +37,11 @@ class AttributeResolver
      */
     public array $relations = [];
 
+    /**
+     * @var array keys contains class names and value contains array of belongs to relations
+     */
+    public array $belongsToRelations = [];
+
     /**
      * @var NonDbRelation[]|array
      */
@@ -273,6 +278,13 @@ protected function resolveProperty(
             $relation->onDeleteFkConstraint = $property->onDeleteFkConstraint;
             if ($property->isRefPointerToSelf()) {
                 $relation->asSelfReference();
+            } else { # belongs to relations https://github.com/php-openapi/yii2-openapi/issues/90
+                $belongsToRelation = Yii::createObject(
+                    AttributeRelation::class,
+                    [$this->schemaName, $this->tableName, $this->schemaName]
+                )
+                    ->asHasOne([$attribute->columnName => $fkProperty->getName()]);
+                $this->belongsToRelations[$property->getRefClassName()][] = $belongsToRelation;
             }
             $this->relations[$property->getName()] = $relation;
         }

src/lib/SchemaToDatabase.php

@@ -110,6 +110,14 @@ public function prepareModels(): array
             $models[$schemaName] = $resolvers[$schemaName]->resolve();
         }
 
+        // handle belongs to relation
+        foreach ($resolvers as $aResolver) {
+            foreach ($aResolver->belongsToRelations as $name => $relations) {
+                /** @var AttributeRelation[] $relations */
+                $models[$name]->belongsToRelations = [...$models[$name]->belongsToRelations, ...$relations];
+            }
+        }
+
         foreach ($models as $model) {
             foreach ($model->many2many as $relation) {
                 if (isset($models[$relation->viaModelName])) {

src/lib/items/DbModel.php

@@ -86,9 +86,9 @@ class DbModel extends BaseObject
     public bool $descriptionIsComment = false;
 
     /**
-     * @var array Automatically generated scenarios from the model 'x-scenarios'.
+     * @var AttributeRelation[] belongs to relations
      */
-    private $_scenarios;
+    public array $belongsToRelations = [];
 
     /**
      * @var bool
@@ -98,6 +98,11 @@ class DbModel extends BaseObject
      */
     public $drop = false;
 
+    /**
+     * @var array Automatically generated scenarios from the model 'x-scenarios'.
+     */
+    private $_scenarios;
+
     public function getTableAlias(): string
     {
         return '{{%' . $this->tableName . '}}';

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

@@ -38,4 +38,10 @@ 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']);
+    }
 }

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

@@ -61,4 +61,10 @@ public function getComments()
     {
         return $this->hasMany(\app\models\Comment::class, ['post_id' => 'uid'])->inverseOf('post');
     }
+
+    # belongs to relation
+    public function getComment()
+    {
+        return $this->hasOne(\app\models\Comment::class, ['post_id' => 'uid']);
+    }
 }

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

@@ -44,4 +44,16 @@ public function rules()
             'email_unique' => [['email'], 'unique'],
         ];
     }
+
+    # belongs to relation
+    public function getPost()
+    {
+        return $this->hasOne(\app\models\Post::class, ['created_by_id' => 'id']);
+    }
+
+    # belongs to relation
+    public function getComment()
+    {
+        return $this->hasOne(\app\models\Comment::class, ['author_id' => 'id']);
+    }
 }

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

@@ -38,4 +38,10 @@ 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']);
+    }
 }

tests/specs/blog_v2/models/base/Post.php

@@ -73,4 +73,10 @@ public function getTags()
         return $this->hasMany(\app\models\Tag::class, ['id' => 'tag_id'])
                     ->viaTable('posts2tags', ['post_id' => 'id']);
     }
+
+    # belongs to relation
+    public function getComment()
+    {
+        return $this->hasOne(\app\models\Comment::class, ['post_id' => 'id']);
+    }
 }

tests/specs/blog_v2/models/base/User.php

@@ -47,4 +47,16 @@ public function rules()
             'email_unique' => [['email'], 'unique'],
         ];
     }
+
+    # belongs to relation
+    public function getPost()
+    {
+        return $this->hasOne(\app\models\Post::class, ['created_by_id' => 'id']);
+    }
+
+    # belongs to relation
+    public function getComment()
+    {
+        return $this->hasOne(\app\models\Comment::class, ['user_id' => 'id']);
+    }
 }

tests/specs/fk_col_name/app/models/base/Delivery.php

@@ -27,4 +27,10 @@ public function rules()
             'title_string' => [['title'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getWebhook()
+    {
+        return $this->hasOne(\app\models\Webhook::class, ['redelivery_of' => 'id']);
+    }
 }

tests/specs/fk_col_name/app/models/base/User.php

@@ -28,4 +28,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getWebhook()
+    {
+        return $this->hasOne(\app\models\Webhook::class, ['user_id' => 'id']);
+    }
 }

tests/specs/fk_col_name_index/app/models/base/Delivery.php

@@ -27,4 +27,16 @@ public function rules()
             'title_string' => [['title'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getWebhook()
+    {
+        return $this->hasOne(\app\models\Webhook::class, ['redelivery_of' => 'id']);
+    }
+
+    # belongs to relation
+    public function getWebhook2()
+    {
+        return $this->hasOne(\app\models\Webhook::class, ['rd_abc_2' => 'id']);
+    }
 }

tests/specs/fk_col_name_index/app/models/base/User.php

@@ -28,4 +28,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getWebhook()
+    {
+        return $this->hasOne(\app\models\Webhook::class, ['user_id' => 'id']);
+    }
 }

tests/specs/issue_fix/159_bug_giiapi_generated_rules_emailid/maria/models/base/Mailing.php

@@ -30,4 +30,10 @@ public function rules()
             'paymentMethodName_string' => [['paymentMethodName'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getContact()
+    {
+        return $this->hasOne(\app\models\Contact::class, ['mailing_id' => 'id']);
+    }
 }

tests/specs/issue_fix/162_bug_dollarref_with_x_faker/app/models/base/Invoice.php

@@ -23,4 +23,10 @@ public function rules()
     {
         return [];
     }
+
+    # belongs to relation
+    public function getOrder()
+    {
+        return $this->hasOne(\app\models\Order::class, ['invoice_id' => 'id']);
+    }
 }

tests/specs/issue_fix/175_bug_allof_with_multiple_dollarrefs/pgsql/models/base/Account.php

@@ -30,4 +30,10 @@ public function rules()
             'paymentMethodName_string' => [['paymentMethodName'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getContact()
+    {
+        return $this->hasOne(\app\models\Contact::class, ['account_id' => 'id']);
+    }
 }

tests/specs/issue_fix/25_generate_inverse_relations/mysql/models/base/User.php

@@ -34,4 +34,22 @@ public function getAccounts()
     {
         return $this->hasMany(\app\models\Account::class, ['user_id' => 'id'])->inverseOf('user');
     }
+
+    # belongs to relation
+    public function getAccount()
+    {
+        return $this->hasOne(\app\models\Account::class, ['user_id' => 'id']);
+    }
+
+    # belongs to relation
+    public function getAccount2()
+    {
+        return $this->hasOne(\app\models\Account::class, ['user2_id' => 'id']);
+    }
+
+    # belongs to relation
+    public function getAccount3()
+    {
+        return $this->hasOne(\app\models\Account::class, ['user3' => 'id']);
+    }
 }

tests/specs/issue_fix/29_extension_fk_column_name_cause_error_in_case_of_column_name_without_underscore/mysql/models/base/User.php

@@ -27,4 +27,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getPost()
+    {
+        return $this->hasOne(\app\models\Post::class, ['user' => 'id']);
+    }
 }

tests/specs/issue_fix/52_bug_dependenton_allof_with_x_faker_false/mysql/models/base/Animal.php

@@ -27,4 +27,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getInvoice()
+    {
+        return $this->hasOne(\app\models\Invoice::class, ['animal_id' => 'id']);
+    }
 }

tests/specs/issue_fix/52_bug_dependenton_allof_with_x_faker_false/mysql/models/base/Fruit.php

@@ -27,4 +27,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getInvoice()
+    {
+        return $this->hasOne(\app\models\Invoice::class, ['fruit_id' => 'id']);
+    }
 }

tests/specs/issue_fix/52_bug_dependenton_allof_with_x_faker_false/mysql/models/base/User.php

@@ -27,4 +27,16 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getInvoice()
+    {
+        return $this->hasOne(\app\models\Invoice::class, ['user_id' => 'id']);
+    }
+
+    # belongs to relation
+    public function getInvoice2()
+    {
+        return $this->hasOne(\app\models\Invoice::class, ['user_2_id' => 'id']);
+    }
 }

tests/specs/issue_fix/88_in_case_of_updating_a_model_generator_creates_redundant_inverse_relations/index.yaml

@@ -29,5 +29,3 @@ components:
           type: string
         address:
           $ref: '#/components/schemas/Address'
-
-

tests/specs/issue_fix/88_in_case_of_updating_a_model_generator_creates_redundant_inverse_relations/mysql/models/base/Address.php

@@ -27,4 +27,10 @@ public function rules()
             'name_string' => [['name'], 'string'],
         ];
     }
+
+    # belongs to relation
+    public function getHuman()
+    {
+        return $this->hasOne(\app\models\Human::class, ['address_id' => 'id']);
+    }
 }

tests/specs/issue_fix/90_implement_belongs_to_relations_in_models/index.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/90_implement_belongs_to_relations_in_models/index.yaml',
+    'generateUrls' => false,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => false,
+    'generateMigrations' => false,
+    'generateModelFaker' => false, // `generateModels` must be `true` in order to use `generateModelFaker` as `true`
+];

tests/specs/issue_fix/90_implement_belongs_to_relations_in_models/index.yaml

@@ -0,0 +1,26 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: \#90
+paths:
+  /:
+    get:
+      responses:
+        '200':
+          description: The information
+
+components:
+  schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: integer
+
+    Address:
+      type: object
+      properties:
+        id:
+          type: integer
+        user:
+          $ref: '#/components/schemas/User'

tests/specs/issue_fix/90_implement_belongs_to_relations_in_models/mysql/models/Address.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace app\models;
+
+class Address extends \app\models\base\Address
+{
+
+
+}
+

tests/specs/issue_fix/90_implement_belongs_to_relations_in_models/mysql/models/User.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace app\models;
+
+class User extends \app\models\base\User
+{
+
+
+}
+