Tokens::getQueryModelData() - Code Metrics - Inspection of "update for new orm access patterns" - bytic/hello - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 056d39...c33903 )

by Gabriel

created 2020-10-20 13:21 UTC

Tokens::getQueryModelData() A

↳ Parent: Tokens

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	10
cc	3
nc	2
nop	1
crap	3

<?php

namespace ByTIC\Hello\Models\AccessTokens;

use ByTIC\Hello\Models\Clients\Client;
use ByTIC\Hello\Models\Clients\Clients;
use ByTIC\Hello\Models\Users\Traits\UserTrait;
use Carbon\Carbon;
use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Entities\ScopeEntityInterface;
use League\OAuth2\Server\Entities\TokenInterface;
use League\OAuth2\Server\Exception\UniqueTokenIdentifierConstraintViolationException;
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
use Nip\Records\Collections\Collection;

/**
 * Class Tokens
 * @package ByTIC\Auth\Models\Tokens
 *
 * @method Token getNew()
 */
class Tokens extends \Nip\Records\RecordManager implements AccessTokenRepositoryInterface
{
    /**
     * Create a new access token
     *
     * @param ClientEntityInterface $clientEntity
     * @param ScopeEntityInterface[] $scopes
     * @param mixed $userIdentifier
     *
     * @return AccessTokenEntityInterface|Token
     */
    public function getNewToken(ClientEntityInterface $clientEntity, array $scopes, $userIdentifier = null)
    {
        $token = $this->getNew();
        $token->populateFromClient($clientEntity);
        $token->setUserIdentifier($userIdentifier);
        $token->addScopes($scopes);
        return $token;
    }

    /**
     * Persists a new access token to permanent storage.
     *
     * @param AccessTokenEntityInterface|Token $accessTokenEntity
     *
     * @throws UniqueTokenIdentifierConstraintViolationException
     */
    public function persistNewAccessToken(AccessTokenEntityInterface $accessTokenEntity)
    {
        $accessTokenEntity->save();
    }

    /**
     * Revoke an access token.
     *
     * @param string $tokenId
     */
    public function revokeAccessToken($tokenId)
    {
        $token = $this->getByIdentifier($tokenId);
        if (!($token instanceof Token)) {
            return;
        }
        $token->revoked = true;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $token->save();
    }

    /**
     * Check if the access token has been revoked.
     *
     * @param string $tokenId
     *
     * @return bool Return true if this token has been revoked
     */
    public function isAccessTokenRevoked($tokenId)
    {
        $token = $this->getByIdentifier($tokenId);
        if ($token instanceof TokenInterface) {
            return $token->revoked;

        }
        return true;
    }

    /**
     * @param UserTrait $user
     * @param Client $client
     * @return Collection|Token[]
     */
    public function getValidUserTokens($user, $client)
    {
        $params = [];
        $params['where'] = [
            ['user_id = ?', $user->getIdentifier()],
            ['client_id = ?', $client->getIdentifier()],
            ['revoked = ?', 0],
            ['expires_at > ?', Carbon::now()->toDateString()],
        ];
        return $this->findByParams($params);
    }

    /**
     * @param $tokenId
     * @return Token|null
     */
    public function getByIdentifier($tokenId)
    {
        $collection = $this->findByField('identifier', $tokenId);
        return $collection->current();
    }

    public function getQueryModelData($model)
    {
        $data = parent::getQueryModelData($model);
        if (isset($data['scopes']) && is_array($data['scopes'])) {
            $data['scopes'] = implode(',', $data['scopes']);
        }
        return $data;
    }

    protected function initRelations()
    {
        parent::initRelations();
        $this->belongsTo('Client', ['class' => Clients::class, 'fk' => 'client_id', 'withPK' => 'identifier']);
    }

    /** @noinspection PhpMissingParentCallCommonInspection
     * @inheritDoc
     */
    protected function generateTable()
    {
        return 'oauth_access_tokens';
    }
}


1		<?php
2
3		namespace ByTIC\Hello\Models\AccessTokens;
4
5		use ByTIC\Hello\Models\Clients\Client;
6		use ByTIC\Hello\Models\Clients\Clients;
7		use ByTIC\Hello\Models\Users\Traits\UserTrait;
8		use Carbon\Carbon;
9		use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
10		use League\OAuth2\Server\Entities\ClientEntityInterface;
11		use League\OAuth2\Server\Entities\ScopeEntityInterface;
12		use League\OAuth2\Server\Entities\TokenInterface;
13		use League\OAuth2\Server\Exception\UniqueTokenIdentifierConstraintViolationException;
14		use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
15		use Nip\Records\Collections\Collection;
16
17		/**
18		* Class Tokens
19		* @package ByTIC\Auth\Models\Tokens
20		*
21		* @method Token getNew()
22		*/
23		class Tokens extends \Nip\Records\RecordManager implements AccessTokenRepositoryInterface
24		{
25		/**
26		* Create a new access token
27		*
28		* @param ClientEntityInterface $clientEntity
29		* @param ScopeEntityInterface[] $scopes
30		* @param mixed $userIdentifier
31		*
32		* @return AccessTokenEntityInterface\|Token
33		*/
34	1	public function getNewToken(ClientEntityInterface $clientEntity, array $scopes, $userIdentifier = null)
35		{
36	1	$token = $this->getNew();
37	1	$token->populateFromClient($clientEntity);
38	1	$token->setUserIdentifier($userIdentifier);
39	1	$token->addScopes($scopes);
40	1	return $token;
41		}
42
43		/**
44		* Persists a new access token to permanent storage.
45		*
46		* @param AccessTokenEntityInterface\|Token $accessTokenEntity
47		*
48		* @throws UniqueTokenIdentifierConstraintViolationException
49		*/
50		public function persistNewAccessToken(AccessTokenEntityInterface $accessTokenEntity)
51		{
52		$accessTokenEntity->save();
53		}
54
55		/**
56		* Revoke an access token.
57		*
58		* @param string $tokenId
59		*/
60		public function revokeAccessToken($tokenId)
61		{
62		$token = $this->getByIdentifier($tokenId);
63		if (!($token instanceof Token)) {
64		return;
65		}
66		$token->revoked = true;
		0 ignored issues – show Documentation Bug introduced 2020-06-22 13:49 UTC by Report Bug Copy Issue Report The property `$revoked` was declared of type `string`, but `true` is of type `true`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
67		$token->save();
68		}
69
70		/**
71		* Check if the access token has been revoked.
72		*
73		* @param string $tokenId
74		*
75		* @return bool Return true if this token has been revoked
76		*/
77		public function isAccessTokenRevoked($tokenId)
78		{
79		$token = $this->getByIdentifier($tokenId);
80		if ($token instanceof TokenInterface) {
81		return $token->revoked;
		0 ignored issues – show Bug Best Practice introduced 2020-06-22 13:49 UTC by Report Bug Copy Issue Report The expression `return $token->revoked` returns the type `string` which is incompatible with the documented return type `boolean`. Loading history...
82		}
83		return true;
84		}
85
86		/**
87		* @param UserTrait $user
88		* @param Client $client
89		* @return Collection\|Token[]
90		*/
91	1	public function getValidUserTokens($user, $client)
92		{
93	1	$params = [];
94	1	$params['where'] = [
95	1	['user_id = ?', $user->getIdentifier()],
96	1	['client_id = ?', $client->getIdentifier()],
97		['revoked = ?', 0],
98	1	['expires_at > ?', Carbon::now()->toDateString()],
99		];
100	1	return $this->findByParams($params);
101		}
102
103		/**
104		* @param $tokenId
105		* @return Token\|null
106		*/
107		public function getByIdentifier($tokenId)
108		{
109		$collection = $this->findByField('identifier', $tokenId);
110		return $collection->current();
111		}
112
113	2	public function getQueryModelData($model)
114		{
115	2	$data = parent::getQueryModelData($model);
116	2	if (isset($data['scopes']) && is_array($data['scopes'])) {
117	1	$data['scopes'] = implode(',', $data['scopes']);
118		}
119	2	return $data;
120		}
121
122	1	protected function initRelations()
123		{
124	1	parent::initRelations();
125	1	$this->belongsTo('Client', ['class' => Clients::class, 'fk' => 'client_id', 'withPK' => 'identifier']);
126	1	}
127
128		/** @noinspection PhpMissingParentCallCommonInspection
129		* @inheritDoc
130		*/
131		protected function generateTable()
132		{
133		return 'oauth_access_tokens';
134		}
135		}
136

bytic / hello

Push — master ( 056d39...c33903 )

Tokens::getQueryModelData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like