first commit

app/Models/Review.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace App\Models;
+
+use Common\Core\BaseModel;
+use Common\Votes\OrdersByWeightedScore;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class Review extends BaseModel
+{
+    use OrdersByWeightedScore;
+
+    public const MODEL_TYPE = 'review';
+    protected $guarded = ['id'];
+    protected $appends = ['model_type'];
+
+    protected $casts = [
+        'id' => 'integer',
+        'user_id' => 'integer',
+        'reviewable_id' => 'integer',
+        'score' => 'integer',
+        'has_text' => 'boolean',
+        'helpful_count' => 'integer',
+        'not_helpful_count' => 'integer',
+    ];
+
+    public function feedback(): HasMany
+    {
+        return $this->hasMany(ReviewFeedback::class);
+    }
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class)->select(
+            'id',
+            'first_name',
+            'last_name',
+            'email',
+            'avatar',
+        );
+    }
+
+    public function reviewable(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    public function reports(): HasMany
+    {
+        return $this->hasMany(ReviewReport::class);
+    }
+
+    public function scopeOrderByMostHelpful(Builder $query): Builder
+    {
+        return $query->orderByWeightedScore(
+            'desc',
+            'helpful_count',
+            'not_helpful_count',
+        );
+    }
+
+    public function scopeWithTextOnly(Builder $query): Builder
+    {
+        return $query->where('has_text', true);
+    }
+
+    public function toSearchableArray(): array
+    {
+        return [
+            'id' => $this->id,
+            'body' => $this->body,
+            'created_at' => $this->created_at->timestamp ?? '_null',
+            'updated_at' => $this->updated_at->timestamp ?? '_null',
+        ];
+    }
+
+    public static function filterableFields(): array
+    {
+        return ['id', 'created_at', 'updated_at'];
+    }
+
+    public function toNormalizedArray(): array
+    {
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'model_type' => self::MODEL_TYPE,
+        ];
+    }
+
+    public static function getModelTypeAttribute(): string
+    {
+        return self::MODEL_TYPE;
+    }
+}