improved model-docs for better IDE support

Author: pdphilip

src/Eloquent/Docs/ModelDocs.php

@@ -8,7 +8,6 @@
 use Illuminate\Pagination\Cursor;
 use PDPhilip\Elasticsearch\Eloquent\Builder;
 use PDPhilip\Elasticsearch\Eloquent\ElasticCollection;
-use PDPhilip\Elasticsearch\Eloquent\Model;
 use PDPhilip\Elasticsearch\Pagination\SearchAfterPaginator;
 
 /**
@@ -192,12 +191,12 @@
  *===========================================
  * Executors
  *===========================================
- * @method static Model|null find($id)
- * @method static Model|null first($columns = ['*'])
- * @method static Model firstOrCreate($attributes, $values = [])
+ * @method static static|null find($id)
+ * @method static static|null first($columns = ['*'])
+ * @method static static firstOrCreate($attributes, $values = [])
  *-----------------------------------
  * @method static array getModels($columns = ['*'])
- * @method static ElasticCollection get($columns = ['*'])
+ * @method static ElasticCollection|array<int, static> get($columns = ['*'])
  * @method static ElasticCollection insert($values, $returnData = null)
  * @method static $this create(array $attributes)
  * @method static $this createOnly()
@@ -207,7 +206,7 @@
  * @method static array toSql($columns = ['*'])
  *-----------------------------------
  * @method static mixed rawDsl($bodyParams)
- * @method static ElasticCollection rawSearch($bodyParams)
+ * @method static array<int, static> rawSearch($bodyParams)
  * @method static array rawAggregation($bodyParams)
  *-----------------------------------
  * @method static LengthAwarePaginator paginate($perPage = 15, $columns = ['*'], $pageName = 'page', $page = null,  $total = null)
@@ -216,8 +215,8 @@
  * @method static bool chunk($count, $callback)
  * @method static bool chunkById($count, $callback, $column = '_id', $alias = null)
  *-----------------------------------
- * @method static ElasticCollection distinct($columns = [], $includeCount = false)
- * @method static ElasticCollection bulkDistinct($columns = [], $includeCount = false)
+ * @method static array<int, static> distinct($columns = [], $includeCount = false)
+ * @method static array<int, static> bulkDistinct($columns = [], $includeCount = false)
  *===========================================
  * Aggregators Methods
  *===========================================

src/Eloquent/ElasticCollection.php

@@ -6,13 +6,12 @@
 use Illuminate\Database\Eloquent\Collection;
 use PDPhilip\Elasticsearch\Data\MetaDTO;
 use PDPhilip\Elasticsearch\Data\QueryMeta;
-use PDPhilip\Elasticsearch\Eloquent\Model as TModel;
 
 /**
  * @template TKey of array-key
  * @template TModel of \PDPhilip\Elasticsearch\Eloquent\Model
  *
- * @extends Collection<int, TModel>
+ * @extends \Illuminate\Database\Eloquent\Collection<TKey, TModel>
  */
 class ElasticCollection extends Collection
 {

tests/Models/Item.php

@@ -12,7 +12,12 @@
 use PDPhilip\Elasticsearch\Schema\Schema;
 use PDPhilip\Elasticsearch\Tests\Concerns\TestsWithIdStrategies;
 
-/** @property Carbon $created_at */
+/**
+ * @property string $id
+ * @property string $name
+ * @property string $user_id
+ * @property Carbon $created_at
+ */
 class Item extends Model
 {
     use TestsWithIdStrategies;

tests/Models/Post.php

@@ -4,11 +4,20 @@
 
 namespace PDPhilip\Elasticsearch\Tests\Models;
 
+use Carbon\Carbon;
 use PDPhilip\Elasticsearch\Eloquent\Model;
 use PDPhilip\Elasticsearch\Schema\Blueprint;
 use PDPhilip\Elasticsearch\Schema\Schema;
 use PDPhilip\Elasticsearch\Tests\Concerns\TestsWithIdStrategies;
 
+/**
+ * @property string $id
+ * @property string $title
+ * @property int $status
+ * @property array $comments
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ */
 class Post extends Model
 {
     use TestsWithIdStrategies;