Refactor

Author: SOHELAHMED7

src/lib/items/DbModel.php

@@ -10,83 +10,78 @@
 use cebe\yii2openapi\lib\ValidationRulesBuilder;
 use Yii;
 use yii\base\BaseObject;
+use yii\base\InvalidConfigException;
 use yii\db\ColumnSchema;
 use yii\helpers\Inflector;
-use yii\helpers\StringHelper;
 use yii\helpers\VarDumper;
 use function array_filter;
 use function array_map;
 use function str_replace;
 use const PHP_EOL;
 
 /**
- * @property-read string                                                $tableAlias
- * @property-read array                                                 $uniqueColumnsList
- * @property-read array[]|array                                         $attributesByType
- * @property-read array|\cebe\yii2openapi\lib\items\AttributeRelation[] $hasOneRelations
+ * @property-read string $tableAlias
+ * @property-read array $uniqueColumnsList
+ * @property-read array[]|array $attributesByType
+ * @property-read array|AttributeRelation[] $hasOneRelations
  */
 class DbModel extends BaseObject
 {
-    /**
-     * @var string primary key attribute name
-     */
-    public $pkName;
+    // primary key attribute name
+    public string $pkName;
 
-    /**
-     * @var string model name.
-     */
-    public $name;
+    // model name
+    public string $name;
 
-    /**
-     * @var string table name. (without brackets and db prefix)
-     */
-    public $tableName;
+    // table name. (without brackets and db prefix)
+    public string $tableName;
 
-    /**
-     * @var string description from the schema.
-     */
-    public $description;
+    // description from the schema.
+    public string $description;
 
     /**
-     * @var array|\cebe\yii2openapi\lib\items\Attribute[] model attributes.
+     * @var array|Attribute[] model attributes.
      */
-    public $attributes = [];
+    public array $attributes = [];
 
     /**
-     * @var array|\cebe\yii2openapi\lib\items\AttributeRelation[] database relations.
+     * @var array|AttributeRelation[] database relations.
      */
-    public $relations = [];
+    public array $relations = [];
 
     /***
-     * @var array|\cebe\yii2openapi\lib\items\NonDbRelation[] non-db relations
+     * @var array|NonDbRelation[] non-db relations
      */
-    public $nonDbRelations = [];
+    public array $nonDbRelations = [];
 
     /**
-     * @var array|\cebe\yii2openapi\lib\items\ManyToManyRelation[] many to many relations.
+     * @var array|ManyToManyRelation[] many-to-many relations.
      */
-    public $many2many = [];
+    public array $many2many = [];
 
-    public $junctionCols = [];
+    public array $junctionCols = [];
 
     /**
-     * @var \cebe\yii2openapi\lib\items\DbIndex[]|array
+     * @var DbIndex[]|array
      */
-    public $indexes = [];
+    public array $indexes = [];
 
-    public $isNotDb = false;
+    public bool $isNotDb = false;
 
-    public function getTableAlias():string
+    public function getTableAlias(): string
     {
         return '{{%' . $this->tableName . '}}';
     }
 
-    public function getClassName():string
+    public function getClassName(): string
     {
         return Inflector::id2camel($this->name, '_');
     }
 
-    public function getValidationRules():string
+    /**
+     * @throws InvalidConfigException
+     */
+    public function getValidationRules(): string
     {
         $rules = Yii::createObject(ValidationRulesBuilder::class, [$this])->build();
         $rules = array_map('strval', $rules);
@@ -105,9 +100,9 @@ public function getValidationRules():string
     }
 
     /**
-     * @return \cebe\yii2openapi\lib\items\AttributeRelation[]|array
+     * @return AttributeRelation[]|array
      */
-    public function getHasOneRelations():array
+    public function getHasOneRelations(): array
     {
         return array_filter(
             $this->relations,
@@ -117,15 +112,15 @@ static function (AttributeRelation $relation) {
         );
     }
 
-    public function getPkAttribute():Attribute
+    public function getPkAttribute(): Attribute
     {
         return $this->attributes[$this->pkName];
     }
 
     /**
      * @return ColumnSchema[]
      */
-    public function attributesToColumnSchema():array
+    public function attributesToColumnSchema(): array
     {
         return $this->isNotDb
             ? []
@@ -142,9 +137,9 @@ static function ($acc, Attribute $attribute) {
     }
 
     /**
-     * @return array|\cebe\yii2openapi\lib\items\Attribute[]
+     * @return array|Attribute[]
      */
-    public function getEnumAttributes():array
+    public function getEnumAttributes(): array
     {
         return array_filter(
             $this->attributes,
@@ -155,19 +150,19 @@ static function (Attribute $attribute) {
     }
 
     /**
-     * @return array|\cebe\yii2openapi\lib\items\Attribute[]
+     * @return array|Attribute[]
      */
-    public function virtualAttributes():array
+    public function virtualAttributes(): array
     {
         return array_filter($this->attributes, static function (Attribute $attribute) {
             return $attribute->isVirtual;
         });
     }
 
     /**
-     * @return array|\cebe\yii2openapi\lib\items\Attribute[]
+     * @return array|Attribute[]
      */
-    public function dbAttributes():array
+    public function dbAttributes(): array
     {
         return array_filter($this->attributes, static function (Attribute $attribute) {
             return !$attribute->isVirtual;