support non-db relations for transformers

Author: Insolita

src/generator/default/transformer.php

@@ -63,6 +63,31 @@ public function include<?=$relation->getCamelName()?>(<?=$transformer->dbModel->
 <?php endif;?>
     }
 <?php endforeach;?>
+<?php foreach ($transformer->nonDbRelations as $relation):?>
+
+    public function include<?=$relation->getCamelName()?>(<?=$transformer->dbModel->getClassName()?> $model)
+    {
+        $relation = $model-><?=Inflector::variablize($relation->getName())?>;
+<?php if ($relation->isHasOne()):?>
+        if ($relation === null) {
+            return $this->null();
+        }
+<?php if ($relation->getClassName() === $transformer->dbModel->getClassName()):?>
+        $transformer = new static();
+<?php else:?>
+        $transformer = new <?=Inflector::singularize($relation->getClassName())?>Transformer();
+<?php endif;?>
+        return $this->item($relation, $transformer, '<?=$transformer->makeResourceKey($relation->getClassKey())?>');
+<?php else:?>
+<?php if ($relation->getClassName() === $transformer->dbModel->getClassName()):?>
+        $transformer = new static();
+<?php else:?>
+        $transformer = new <?=Inflector::singularize($relation->getClassName())?>Transformer();
+<?php endif;?>
+        return $this->collection($relation, $transformer, '<?=$transformer->makeResourceKey($relation->getClassKey())?>');
+<?php endif;?>
+    }
+<?php endforeach;?>
 <?php foreach ($transformer->many2Many as $relation):?>
 
     public function include<?=$relation->getCamelName()?>(<?=$transformer->dbModel->getClassName()?> $model)

src/lib/items/NonDbRelation.php

@@ -7,6 +7,8 @@
 
 namespace cebe\yii2openapi\lib\items;
 
+use yii\helpers\Inflector;
+
 class NonDbRelation
 {
     public const HAS_ONE = 'hasOne';
@@ -83,6 +85,16 @@ public function getClassName():?string
         return $this->className;
     }
 
+    public function getCamelName():string
+    {
+        return Inflector::camelize($this->name);
+    }
+
+    public function getClassKey():string
+    {
+        return Inflector::camel2id($this->getClassName());
+    }
+
     /**
      * @return string
      */

src/lib/items/Transformer.php

@@ -21,6 +21,7 @@
  * @property-read string                                                 $fQN
  * @property-read array|\cebe\yii2openapi\lib\items\AttributeRelation[]  $relations
  * @property-read \cebe\yii2openapi\lib\items\ManyToManyRelation[]|array $many2Many
+ * @property-read \cebe\yii2openapi\lib\items\NonDbRelation[]|array $nonDbRelations
  * @property-read array                                                  $availableRelations
  */
 class Transformer extends BaseObject
@@ -87,7 +88,11 @@ public function getUniqueTransformerClasses(): array
             return Inflector::singularize($relation->getRelatedClassName()).'Transformer';
         }, $this->dbModel->many2many);
 
-        return array_unique(array_merge($relations, $relationsMany));
+        $relationsNonDb = array_map(static function (NonDbRelation $relation) {
+            return Inflector::singularize($relation->getClassName()).'Transformer';
+        }, $this->dbModel->nonDbRelations);
+
+        return array_unique(array_merge($relations, $relationsMany, $relationsNonDb));
     }
 
     /**
@@ -97,7 +102,13 @@ public function getRelations(): array
     {
         return $this->dbModel->relations;
     }
-
+    /**
+     * @return array|\cebe\yii2openapi\lib\items\NonDbRelation[]
+     */
+    public function getNonDbRelations(): array
+    {
+        return $this->dbModel->nonDbRelations;
+    }
     /**
      * @return array|\cebe\yii2openapi\lib\items\ManyToManyRelation[]
      */
@@ -121,7 +132,11 @@ public function getAvailableRelations(): array
             return Inflector::variablize($relation->name);
         }, $this->dbModel->many2many);
 
-        return array_merge($relations, $relationsMany);
+        $relationsNonDb = array_map(static function (NonDbRelation $relation) {
+            return Inflector::variablize($relation->getName());
+        }, $this->dbModel->nonDbRelations);
+
+        return array_merge($relations, $relationsMany, $relationsNonDb);
     }
 
     public function makeResourceKey(string $value): string

tests/specs/petstore_jsonapi/transformers/PetStatisticTransformer.php

@@ -6,7 +6,7 @@
 
 class PetStatisticTransformer extends TransformerAbstract
 {
-    protected $availableIncludes = ['parentPet', 'favoritePets'];
+    protected $availableIncludes = ['parentPet', 'favoritePets', 'topDoctors'];
     protected $defaultIncludes = [];
 
     public function transform(PetStatistic $model)
@@ -30,4 +30,11 @@ public function includeFavoritePets(PetStatistic $model)
         $transformer = new PetTransformer();
         return $this->collection($relation, $transformer, 'pets');
     }
+
+    public function includeTopDoctors(PetStatistic $model)
+    {
+        $relation = $model->topDoctors;
+        $transformer = new DoctorTransformer();
+        return $this->collection($relation, $transformer, 'doctors');
+    }
 }

tests/specs/petstore_jsonapi/transformers/PetTransformer.php

@@ -6,7 +6,7 @@
 
 class PetTransformer extends TransformerAbstract
 {
-    protected $availableIncludes = ['duplicates'];
+    protected $availableIncludes = ['duplicates', 'doctor'];
     protected $defaultIncludes = [];
 
     public function transform(Pet $model)
@@ -20,4 +20,14 @@ public function includeDuplicates(Pet $model)
         $transformer = new static();
         return $this->collection($relation, $transformer, 'pets');
     }
+
+    public function includeDoctor(Pet $model)
+    {
+        $relation = $model->doctor;
+        if ($relation === null) {
+            return $this->null();
+        }
+        $transformer = new DoctorTransformer();
+        return $this->item($relation, $transformer, 'doctors');
+    }
 }