Cortex\Auth\Models\Session

Complexity

Total Complexity

12

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	scopeMostRecent()	0	4	1
A	scopeLeastRecent()	0	4	1
A	scopeGuestsBySeconds()	0	4	1
A	scopeGuests()	0	4	1
A	scopeGuestsByMinutes()	0	4	1
A	scopeGuestsByHours()	0	4	1
A	scopeUsersBySeconds()	0	4	1
A	scopeUsersByMinutes()	0	4	1
A	scopeUsersByHours()	0	4	1
A	user()	0	4	1
A	scopeOfUser()	0	4	1

<?php

declare(strict_types=1);

namespace Cortex\Auth\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
 * Cortex\Auth\Models\Session.
 *
 * @property int                                                                         $id
 * @property int                                                                         $user_id
 * @property string                                                                      $user_type
 * @property string                                                                      $ip_address
 * @property string                                                                      $user_agent
 * @property string                                                                      $payload
 * @property \Carbon\Carbon                                                              $last_activity
 * @property-read \Cortex\Auth\Models\User|\Illuminate\Database\Eloquent\Model|\Eloquent $user
 *
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session guests($minutes = 5)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session guestsByHours($hours = 1)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session guestsByMinutes($minutes = 5)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session guestsBySeconds($seconds = 60)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session leastRecent($column = 'last_activity')
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session mostRecent($column = 'last_activity')
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session usersByHours($hours = 1)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session usersByMinutes($minutes = 5)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session usersBySeconds($seconds = 60)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereIpAddress($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereLastActivity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session wherePayload($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereUserAgent($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereUserId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Cortex\Auth\Models\Session whereUserType($value)
 * @mixin \Eloquent
 */
class Session extends Model
{
    /**
     * {@inheritdoc}
     */
    public $incrementing = false;

    /**
     * {@inheritdoc}
     */
    protected $fillable = [
        'id',
        'user_id',
        'user_type',
        'ip_address',
        'user_agent',
        'payload',
        'last_activity',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'user_id' => 'integer',
        'user_type' => 'string',
        'ip_address' => 'string',
        'user_agent' => 'string',
        'payload' => 'string',
        'last_activity' => 'datetime',
    ];

    /**
     * {@inheritdoc}
     */
    public $timestamps = false;

    /**
     * Create a new Eloquent model instance.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(config('session.table'));
    }

    /**
     * Add an "order by" clause to retrieve most recent sessions.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $column
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeMostRecent(Builder $builder, $column = 'last_activity'): Builder
    {
        return $builder->latest($column);
    }

    /**
     * Add an "order by" clause to retrieve least recent sessions.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $column
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeLeastRecent(Builder $builder, $column = 'last_activity'): Builder
    {
        return $builder->oldest($column);
    }

    /**
     * Constrain the query to retrieve only sessions of guests who
     * have been active within the specified number of seconds.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $seconds
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeGuestsBySeconds(Builder $builder, $seconds = 60): Builder
    {
        return $builder->where('last_activity', '>=', time() - $seconds)->whereNull('user_id');
    }

    /**
     * Alias for the `guestsByMinutes` query method.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $minutes
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeGuests(Builder $builder, $minutes = 5): Builder
    {
        return $builder->guestsByMinutes($minutes);
    }

    /**
     * Constrain the query to retrieve only sessions of guests who
     * have been active within the specified number of minutes.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $minutes
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeGuestsByMinutes(Builder $builder, $minutes = 5): Builder
    {
        return $builder->guestsBySeconds($minutes * 60);
    }

    /**
     * Constrain the query to retrieve only sessions of guests who
     * have been active within the specified number of hours.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $hours
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeGuestsByHours(Builder $builder, $hours = 1): Builder
    {
        return $builder->guestsByMinutes($hours * 60);
    }

    /**
     * Constrain the query to retrieve only sessions of users who
     * have been active within the specified number of seconds.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $seconds
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeUsersBySeconds(Builder $builder, $seconds = 60): Builder
    {
        return $builder->with(['user'])->where('last_activity', '>=', time() - $seconds)->whereNotNull('user_id');
    }

    /**
     * Constrain the query to retrieve only sessions of users who
     * have been active within the specified number of minutes.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $minutes
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeUsersByMinutes(Builder $builder, $minutes = 5): Builder
    {
        return $builder->usersBySeconds($minutes * 60);
    }

    /**
     * Constrain the query to retrieve only sessions of users who
     * have been active within the specified number of hours.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int                                   $hours
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeUsersByHours(Builder $builder, $hours = 1): Builder
    {
        return $builder->usersByMinutes($hours * 60);
    }

    /**
     * Get the owning user.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function user(): MorphTo
    {
        return $this->morphTo('user', 'user_type', 'user_id');
    }

    /**
     * Get sessions of the given user.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param \Illuminate\Database\Eloquent\Model   $user
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOfUser(Builder $builder, Model $user): Builder
    {
        return $builder->where('user_type', $user->getMorphClass())->where('user_id', $user->getKey());
    }
}