ThinKit\Models\Expiration\HasExpiration

Complexity

Total Complexity

10

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeHasExpiration()	0	4	2
A	expiresAt()	0	3	1
A	scopeExpired()	0	3	1
A	expired()	0	3	1
A	willBeExpiredAt()	0	8	2
A	expirationKeyName()	0	3	2
A	scopeWillBeExpiredAt()	0	5	1

<?php

namespace ThinKit\Models\Expiration;

use Carbon\Carbon;

use Illuminate\Database\Eloquent\Builder;

trait HasExpiration
{
    public function initializeHasExpiration()
    {
        if (!array_key_exists($this->expirationKeyName(), $this->casts)) {
            $this->casts[$this->expirationKeyName()] = 'datetime';

The property casts does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
    }

    public function expirationKeyName(): string
    {
        return property_exists($this, 'expirationKeyName') ? $this->expirationKeyName : 'expire_at';
    }

    public function expiresAt(): ?\DateTimeInterface
    {
        return $this->{$this->expirationKeyName()};
    }

    public function expired(): bool
    {
        return $this->willBeExpiredAt(Carbon::now());
    }

    public function willBeExpiredAt(\DateTimeInterface $dateTime): bool
    {
        $expiresAt = $this->expiresAt();
        if (is_null($expiresAt)) {
            return false;
        }

        return Carbon::instance($dateTime)->greaterThan($expiresAt);
    }

    public function scopeExpired(Builder $query): void
    {
        $this->scopeWillBeExpiredAt($query, Carbon::now());
    }

    public function scopeWillBeExpiredAt(Builder $query, \DateTimeInterface $dateTime): void
    {
        $query->where(function (Builder $query) use ($dateTime) {
            $query->whereNotNull($this->expirationKeyName());
            $query->where($this->expirationKeyName(), '<', $dateTime);
        });
    }
}