Clarkeash\Doorman\Models\Invite

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setForAttribute()	0	4	1
A	hasExpired()	0	8	2
A	isFull()	0	8	2
A	isRestricted()	0	4	1
A	isRestrictedFor()	0	4	1
A	isUseless()	0	4	2
A	scopeExpired()	0	4	1
A	scopeFull()	0	4	1
A	scopeUseless()	0	11	1

<?php

namespace Clarkeash\Doorman\Models;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;

class Invite extends Model
{
    protected $dates = [ 'valid_until' ];
    
    public function __construct(array $attributes = [ ])
    {
        $this->table = config('doorman.invite_table_name');
        parent::__construct($attributes);
    }

    public function setForAttribute($for)
    {
        $this->attributes['for'] = strtolower($for);
    }

    /**
     * Has the invite expired.
     *
     * @return bool
     */
    public function hasExpired()
    {
        if (is_null($this->valid_until)) {
            return false;
        }

        return $this->valid_until->isPast();
    }

    /**
     * Is the invite full.
     *
     * @return bool
     */
    public function isFull()
    {
        if ($this->max == 0) {
            return false;
        }

        return $this->uses >= $this->max;
    }

    /**
     * Is the invite restricted to a user.
     *
     * @return bool
     */
    public function isRestricted()
    {
        return !is_null($this->for);
    }


    /**
     * Is the invite restricted for a particular user.
     * 
     * @param string $email
     *
     * @return bool
     */
    public function isRestrictedFor($email)
    {
        return strtolower($email) == $this->for;
    }

    /**
     * Can the invite be used anymore.
     *
     * @return bool
     */
    public function isUseless()
    {
        return $this->hasExpired() || $this->isFull();
    }

    /**
     * Scope a query to only include expired invites.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeExpired($query)
    {
        return $query->where('valid_until', '<', Carbon::now(config('app.timezone')));
    }

    /**
     * Scope a query to only include full invites.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeFull($query)
    {
        return $query->where('max', '!=', 0)->whereRaw('uses = max');
    }

    /**
     * Scope a query to only include useless invites.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeUseless($query)
    {
        return $query
            ->where(function($q) {
                $this->scopeExpired($q);
            })
            ->orWhere(function($q) {
                $this->scopeFull($q);
            })
        ;
    }
}