Adding model attributes autocomplete to model

Author: Marius

README.md

@@ -47,9 +47,25 @@ Create a constant in your code
         ];
     }
 
-Extend BaseModel (it needs datetime NOT timestamp for created_at and updated_at columns) and BaseResourceService and use ResourceControllerTrait in a BaseController (that you extend) and add this new resource to the above map.
+Extend:
 
-The BaseController should call $this->init() from its construct.
+- BaseModel (it needs datetime NOT timestamp for created_at and updated_at columns)
+- BaseResourceService
+
+Create a Controller that uses ResourceControllerTrait and call $this->init() from its __construct.
+
+For model properties autocomplete:
+
+- extend BaseModelAttributes following the same FQN structure as the parent's:
+
+      \App\Models\ChildBaseModel paired with \App\Models\Attributes\ChildBaseModelAttributes
+      \App\Models\Folder\ChildBaseModel paired with \App\Models\Folder\Attributes\ChildBaseModelAttributes
+
+- add in its class dock block using **@property** all the models properties/attributes/columns
+- add in the model's class dock block **@property ChildBaseModelAttributes $a**
+- use **$model->a->** instead of **$model->**
+
+Add this new resource to the above map.
 
 Register the crud routes in your application using (for example in Laravel)
 

src/Models/Attributes/BaseModelAttributes.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace MacropaySolutions\LaravelCrudWizard\Models\Attributes;
+
+use Illuminate\Support\Traits\ForwardsCalls;
+use Transactions\Crud\Models\BaseModel;
+
+/**
+ * For properties autocompletion declare in the children classes (with @ property) all the model's parameters (columns)
+ */
+class BaseModelAttributes
+{
+    use ForwardsCalls;
+
+    private const PRIVATE_ATTRIBUTE = 'ownerBaseModel';
+
+    public function __construct(
+        private BaseModel $ownerBaseModel
+    ) {
+    }
+
+    public function __get(string $key): mixed
+    {
+        if ($key === self::PRIVATE_ATTRIBUTE) {
+            return null;
+        }
+
+        return $this->ownerBaseModel->getAttribute($key);
+    }
+
+    public function __set(string $key, mixed $value): void
+    {
+        if ($key === self::PRIVATE_ATTRIBUTE) {
+            return;
+        }
+
+        $this->ownerBaseModel->setAttribute($key, $value);
+    }
+
+    public function __isset(string $key): bool
+    {
+        if ($key === self::PRIVATE_ATTRIBUTE) {
+            return true;
+        }
+
+        return $this->ownerBaseModel->__isset($key);
+    }
+
+    public function __unset(string $key): void
+    {
+        if ($key === self::PRIVATE_ATTRIBUTE) {
+            return;
+        }
+
+        $this->ownerBaseModel->__unset($key);
+    }
+
+    public function __call(string $method, array $parameters): mixed
+    {
+        return $this->forwardCallTo($this->ownerBaseModel, $method, $parameters);
+    }
+}

src/Models/BaseModel.php

@@ -9,7 +9,11 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Log;
 use MacropaySolutions\LaravelCrudWizard\Helpers\GeneralHelper;
+use MacropaySolutions\LaravelCrudWizard\Models\Attributes\BaseModelAttributes;
 
+/**
+ * For properties autocompletion declare in the children classes (with @ property) ChildBaseModelAttributes $a
+ */
 abstract class BaseModel extends Model
 {
     public const RESOURCE_NAME = null;
@@ -18,6 +22,7 @@ abstract class BaseModel extends Model
     public const UPDATED_AT_FORMAT = 'Y-m-d H:i:s';
     public const COMPOSITE_PK_SEPARATOR = '_';
     public $timestamps = false;
+    public BaseModelAttributes $a;
     protected array $ignoreUpdateFor = [];
     protected array $ignoreExternalCreateFor = [];
     protected array $allowNonExternalUpdatesFor = [];
@@ -33,6 +38,13 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
+        $attributes = \substr($class = static::class, 0, $l = (-1 * (\strlen($class) - \strrpos($class, '\\') - 1))) .
+            'Attributes\\' . \substr($class, $l) . 'Attributes';
+
+        if (\class_exists($attributes)) {
+            $this->a = new $attributes($this);
+        }
+
         $this->append('primary_key_identifier');
     }