ZedanLab / zedan-me-api

app/Models/Testimonial.php

<?php

namespace App\Models;

use App\Http\Resources\TestimonialResource;
use App\Traits\Hashidable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Storage;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
use Spatie\MediaLibrary\MediaCollections\Models\Media as SpatieMedia;

/**
 * App\Models\Testimonial.
 *
 * @property int $id
 * @property string $name
 * @property string $email
 * @property string $position
 * @property string $body
 * @property int $stars
 * @property bool $is_published
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property string $avatar
 * @property-read string $avatar_thumb
 * @property-read string $hashed_id
 * @property-read \Spatie\MediaLibrary\MediaCollections\Models\Collections\MediaCollection|\App\Models\Media[] $media
 * @property-read int|null $media_count
 * @method static Builder|Testimonial findByHashedId(string $hashedId)
 * @method static Builder|Testimonial newModelQuery()
 * @method static Builder|Testimonial newQuery()
 * @method static Builder|Testimonial published()
 * @method static Builder|Testimonial query()
 * @method static Builder|Testimonial whereBody($value)
 * @method static Builder|Testimonial whereCreatedAt($value)
 * @method static Builder|Testimonial whereEmail($value)
 * @method static Builder|Testimonial whereId($value)
 * @method static Builder|Testimonial whereIsPublished($value)
 * @method static Builder|Testimonial whereName($value)
 * @method static Builder|Testimonial wherePosition($value)
 * @method static Builder|Testimonial whereStars($value)
 * @method static Builder|Testimonial whereUpdatedAt($value)
 * @mixin \Eloquent
 */
class Testimonial extends Model implements HasMedia
{
    use HasFactory, Hashidable, InteractsWithMedia;

The trait Spatie\MediaLibrary\InteractsWithMedia requires some properties which are not provided by App\Models\Testimonial: $fallbackPath, $mediaConversionRegistrations, $forceDeleting, $fallbackUrl, $collection_name

    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'testimonials';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'avatar',
        'name',
        'email',
        'position',
        'body',
        'stars',
        'is_published',
    ];

    /**
     * The accessors to append to the model's array form.
     *
     * @var array
     */
    protected $appends = ['hashed_id'];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'is_published' => 'boolean',
        'stars'        => 'integer',
    ];

    /*
     * ----------------------------------------------------------------- *
     * --------------------------- Accessors --------------------------- *
     * ----------------------------------------------------------------- *
     */

    /**
     * Retrieve creator avatar attribute.
     *
     * @return string
     */
    public function getAvatarAttribute()
    {
        return ! blank($media = $this->getFirstMediaUrl('avatar', 'big')) ? $media : url(Storage::url('public/avatar.jpg'));
    }

    /**
     * Retrieve creator avatar_thumb attribute.
     *
     * @return string
     */
    public function getAvatarThumbAttribute()
    {
        return ! blank($media = $this->getFirstMediaUrl('avatar', 'thumb')) ? $media : url(Storage::url('public/avatar.jpg'));
    }

    /*
     * ----------------------------------------------------------------- *
     * ---------------------------- Mutators --------------------------- *
     * ----------------------------------------------------------------- *
     */

    /**
     * Set creator avatar attribute.
     *
     * @param  mixed  $avatar
     * @return void
     */
    public function setAvatarAttribute($avatar)
    {
        $avatar = is_string($avatar) ? $this->addMediaFromUrl($avatar) : $this->addMedia($avatar);

        $avatar->setName("{$this->hashed_id}_avatar")
               ->setFileName("{$this->hashed_id}-avatar")
               ->toMediaCollection('avatar');
    }

    /*
     * ----------------------------------------------------------------- *
     * ----------------------------- Scopes ---------------------------- *
     * ----------------------------------------------------------------- *
     */

    /**
     * Scope to get published testimonials.
     *
     * @param  \Illuminate\Database\Eloquent\Builder   $builder
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePublished(Builder $query): Builder
    {
        return $query->where('is_published', true);
    }

    /*
     * ----------------------------------------------------------------- *
     * ------------------------------ Misc ----------------------------- *
     * ----------------------------------------------------------------- *
     */

    /**
     * Register the media collections.
     *
     * @return void
     */
    public function registerMediaCollections(): void
    {
        $this->addMediaCollection('avatar')
             ->singleFile();
    }

    /**
     * Register media conversions.
     *
     * @param Media $media
     */
    public function registerMediaConversions(SpatieMedia $media = null): void
    {
        $this->addMediaConversion('thumb')
             ->fit('crop', 100, 100)
             ->performOnCollections('avatar');

        // Perform a resize on every collection
        $this->addMediaConversion('big')
             ->fit('crop', 500, 500)
             ->performOnCollections('avatar');
    }

    /**
     * Convert the model instance to an array.
     *
     * @return array
     */
    public function toArray()
    {
        return TestimonialResource::make($this)->toArray(request());
    }
}