Xetaravel\Models\ShopItem

Complexity

Total Complexity

6

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	slugStrategy()	0	3	1
A	shopCategory()	0	3	1
A	countCaches()	0	8	1
A	users()	0	3	1
A	hasUser()	0	5	1
A	boot()	0	12	1

<?php

namespace Xetaravel\Models;

use Eloquence\Behaviours\CountCache\Countable;
use Eloquence\Behaviours\Sluggable;
use Illuminate\Support\Facades\Auth;
use Spatie\Image\Exceptions\InvalidManipulation;
use Spatie\Image\Manipulations;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
use Xetaio\Mentions\Models\Traits\HasMentionsTrait;
use Xetaravel\Models\Presenters\ShopItemPresenter;

class ShopItem extends Model implements HasMedia
{
    use Countable;
    use Sluggable;
    use ShopItemPresenter;
    use HasMentionsTrait;
    use InteractsWithMedia;

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

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'title',
        'user_id',
        'shop_category_id',
        'content',
        'price',
        'discount',
        'quantity',
        'is_display',
        'start_at',
        'end_at'
    ];

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

        // Media Model
        'item_icon'
    ];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'start_at',
        'end_at'
    ];

    /**
     * The "booting" method of the model.
     *
     * @return void
     */
    protected static function boot(): void
    {
        parent::boot();

        // Generated the slug before updating.
        static::updating(function ($model) {
            $model->generateSlug();
        });

        // Set the user id to the new item before saving it.
        static::creating(function ($model) {
            $model->user_id = Auth::id();
        });
    }

    /**
     * Return the field to slug.
     *
     * @return string
     */
    public function slugStrategy(): string
    {
        return 'title';
    }

    /**
     * Return the count cache configuration.
     *
     * @return array
     */
    public function countCaches(): array
    {
        return [
            [
                'model' => ShopCategory::class,
                'field' => 'shop_item_count',
                'foreignKey' => 'shop_category_id',
                'key' => 'id'
            ]
        ];
    }

    /**
     * Get the category that owns the item.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function shopCategory()
    {
        return $this->belongsTo(ShopCategory::class);
    }

    /**
     * Get the users that owns the items.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTomany
     */
    public function users()
    {
        return $this->belongsToMany(User::class);
    }

    /**
     * Check if the given user has unlocked this item.
     *
     * @param User $user The user to check.
     *
     * @return bool
     */
    public function hasUser(User $user): bool
    {
        return $this->users()
            ->where('user_id', $user->getKey())
            ->exists();
    }
}