App\Traits\RememberDeviceTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getRememberDeviceTokenName()	0	3	1
A	getRememberDeviceToken()	0	4	2
A	getRememberDeviceKey()	0	3	1
A	cycleRememberDeviceToken()	0	7	1
A	setRememberDeviceToken()	0	4	2

<?php

namespace App\Traits;

use Illuminate\Support\Str;

trait RememberDeviceTrait
{
    /**
     * The column name of the "remember device" token.
     *
     * @var string
     */
    protected $rememberDeviceTokenName = 'remember_device_token';

    /**
     * Get the token value for the "remember device" session.
     *
     * @return string|null
     */
    public function getRememberDeviceToken()

Method \App\Traits\RememberDeviceTrait::getRememberDeviceToken() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "string|null".

    {
        if (!empty($this->getRememberDeviceTokenName())) {
            return (string)$this->{$this->getRememberDeviceTokenName()};
        }
    }

    /**
     * Set the token value for the "remember device" session.
     *
     * @param  string $value

Missing parameter comment

     * @return void
     */
    public function setRememberDeviceToken($value)

Type hint "string" missing for $value

Method \App\Traits\RememberDeviceTrait::setRememberDeviceToken() does not have native type hint for its parameter $value but it should be possible to add it based on @param annotation "string".

Method \App\Traits\RememberDeviceTrait::setRememberDeviceToken() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "void".

    {
        if (!empty($this->getRememberDeviceTokenName())) {
            $this->{$this->getRememberDeviceTokenName()} = $value;
        }
    }

    /**
     * Get the column name for the "remember device" token.
     *
     * @return string
     */
    public function getRememberDeviceTokenName()

Method \App\Traits\RememberDeviceTrait::getRememberDeviceTokenName() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "string".

    {
        return $this->rememberDeviceTokenName;
    }

    /**
     * Refresh the "remember device" token for the User.
     *
     * @return void
     */
    public function cycleRememberDeviceToken()

Method \App\Traits\RememberDeviceTrait::cycleRememberDeviceToken() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "void".

    {
        $this->setRememberDeviceToken(Str::random(60));
        $timestamps = $this->timestamps;
        $this->timestamps = false;

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

        $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->timestamps = $timestamps;
    }

    /**
     * Get a key to be used by a cookie for the
     * remember device token.
     *
     * @return string

Method \App\Traits\RememberDeviceTrait::getRememberDeviceKey() has useless @return annotation.

     */
    public function getRememberDeviceKey(): string
    {
        return 'remember_device_' . sha1(static::class);
    }
}