bytic / hello

src/Models/Traits/HasApiTokensTrait.php

<?php

namespace ByTIC\Hello\Models\Traits;

use ByTIC\Hello\Models\AccessTokens\Token;
use ByTIC\Hello\Models\Clients\PersonalAccess\TokenFactory;
use Nip\Container\Container;

/**
 * Trait HasApiTokensTrait
 * @package ByTIC\Hello\Models\Traits
 */
trait HasApiTokensTrait
{
    /**
     * The current access token for the authentication user.
     *
     * @var Token
     */
    protected $accessToken = null;

    /**
     * Set the current access token being used by the user.
     *
     * @param Token|boolean $token
     * @return Token|null
     */
    public function setToken($token)
    {
        return $this->accessToken = $token;

It seems like $token can also be of type boolean. However, the property $accessToken is declared as type ByTIC\Hello\Models\AccessTokens\Token. Maybe add an additional type check?

The expression return $this->accessToken = $token also could return the type boolean which is incompatible with the documented return type ByTIC\Hello\Models\AccessTokens\Token|null.

    }

    /**
     * Get the current access token being used by the user.
     *
     * @return Token|null
     */
    public function token()
    {
        if ($this->accessToken === null) {
            $this->initToken();
        }
        return $this->accessToken;

The expression return $this->accessToken could also return false which is incompatible with the documented return type ByTIC\Hello\Models\AccessTokens\Token|null. Did you maybe forget to handle an error condition?

    }

    /**
     * @param $name
     * @param array $scopes
     */
    public function initTokenInModel($name, array $scopes = [])
    {
        $token = $this->createToken($name, $scopes);
        $this->setToken($token);
    }

    /**
     * Create a new personal access token for the user.
     *
     * @param string $name
     * @param array $scopes
     * @return Token|null
     */
    public function createToken($name, array $scopes = [])
    {
        $tokenResponse = Container::getInstance()
            ->get(TokenFactory::class)
            ->make($this->getIdentifier(), $name, $scopes);

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

        return $tokenResponse;
    }

    protected function initToken()
    {
        $this->setToken($this->generateToken());
    }

    /**
     * @return bool
     */
    protected function generateToken()
    {
        return false;
    }

    /**
     * @param null $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @return string|null
     */
    protected function generateTokenName($name = null)
    {
        return !empty($name) ? $name : 'default';
    }
}