Token::hasUserForRole() - Code Metrics - Inspection of "use phpunit 5.4" - brainexe/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 66ec7e...c9ec0a )

by Matze

created 2016-06-04 17:44 UTC

Token::hasUserForRole() A

↳ Parent: Token

Complexity

Conditions	4
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	1

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

<?php

namespace BrainExe\Core\Authentication;

use BrainExe\Annotations\Annotations\Service;
use BrainExe\Core\Traits\IdGeneratorTrait;
use BrainExe\Core\Traits\RedisTrait;
use Generator;

/**
 * @Service("Core.Authentication.Token", public=false)
 */
class Token
{

    const USER_KEY  = 'tokens:user:%s';
    const TOKEN_KEY = 'tokens';

    use RedisTrait;
    use IdGeneratorTrait;

    /**
     * @param int $userId
     * @param string[] $roles
     * @return string
     */
    public function addToken(int $userId, array $roles = []) : string
    {
        $token = $this->generateRandomId(32);

        $redis = $this->getRedis()->pipeline();

        $redis->sadd(sprintf(self::USER_KEY, $userId), $token);
        $redis->hset(self::TOKEN_KEY, $token, json_encode(['userId' => $userId, 'roles' => $roles]));

        $redis->execute();

        return $token;
    }

    /**
     * @param string $token
     * @return array|
     */
    public function getToken(string $token)
    {
        return json_decode($this->getRedis()->hget(self::TOKEN_KEY, $token), true);
    }

    /**
     * @param int $userId
     * @return array[]|Generator
     */
    public function getTokensForUser(int $userId)
    {
        $redis     = $this->getRedis();
        $tokensIds = $redis->smembers(sprintf(self::USER_KEY, $userId));

        if (!empty($tokensIds)) {
            $tokens = $redis->hmget(self::TOKEN_KEY, $tokensIds);

            foreach ($tokens as $idx => $token) {
                yield $tokensIds[$idx] => json_decode($token, true)['roles'];
            }
        }
    }

    /**
     * @param string $token
     * @param string|null $role
     * @return int|null
     */
    public function hasUserForRole(string $token, string $role = null)
    {
        $tokenData = $this->getToken($token);
        if (empty($tokenData)) {
            return null;
        }

        if ($role && !in_array($role, $tokenData['roles'])) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return null;
        }

        return $tokenData['userId'];
    }

    /**
     * @param string $token
     */
    public function revoke(string $token)
    {
        $tokenData = $this->getToken($token);
        if (!$tokenData) {

            return;
        }

        $userId = $tokenData['userId'];

        $redis = $this->getRedis()->pipeline();

        $redis->srem(sprintf(self::USER_KEY, $userId), $token);
        $redis->hdel(self::TOKEN_KEY, $token);

        $redis->execute();
    }
}


1			<?php
2
3			namespace BrainExe\Core\Authentication;
4
5			use BrainExe\Annotations\Annotations\Service;
6			use BrainExe\Core\Traits\IdGeneratorTrait;
7			use BrainExe\Core\Traits\RedisTrait;
8			use Generator;
9
10			/**
11			* @Service("Core.Authentication.Token", public=false)
12			*/
13			class Token
14			{
15
16			const USER_KEY = 'tokens:user:%s';
17			const TOKEN_KEY = 'tokens';
18
19			use RedisTrait;
20			use IdGeneratorTrait;
21
22			/**
23			* @param int $userId
24			* @param string[] $roles
25			* @return string
26			*/
27			public function addToken(int $userId, array $roles = []) : string
28			{
29			$token = $this->generateRandomId(32);
30
31			$redis = $this->getRedis()->pipeline();
32
33			$redis->sadd(sprintf(self::USER_KEY, $userId), $token);
34			$redis->hset(self::TOKEN_KEY, $token, json_encode(['userId' => $userId, 'roles' => $roles]));
35
36			$redis->execute();
37
38			return $token;
39			}
40
41			/**
42			* @param string $token
43			* @return array\|
44			*/
45			public function getToken(string $token)
46			{
47			return json_decode($this->getRedis()->hget(self::TOKEN_KEY, $token), true);
48			}
49
50			/**
51			* @param int $userId
52			* @return array[]\|Generator
53			*/
54			public function getTokensForUser(int $userId)
55			{
56			$redis = $this->getRedis();
57			$tokensIds = $redis->smembers(sprintf(self::USER_KEY, $userId));
58
59			if (!empty($tokensIds)) {
60			$tokens = $redis->hmget(self::TOKEN_KEY, $tokensIds);
61
62			foreach ($tokens as $idx => $token) {
63			yield $tokensIds[$idx] => json_decode($token, true)['roles'];
64			}
65			}
66			}
67
68			/**
69			* @param string $token
70			* @param string\|null $role
71			* @return int\|null
72			*/
73			public function hasUserForRole(string $token, string $role = null)
74			{
75			$tokenData = $this->getToken($token);
76			if (empty($tokenData)) {
77			return null;
78			}
79
80			if ($role && !in_array($role, $tokenData['roles'])) {
			0 ignored issues – show Bug Best Practice introduced 2016-05-05 16:04 UTC by Report Bug Copy Issue Report The expression `$role` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
81			return null;
82			}
83
84			return $tokenData['userId'];
85			}
86
87			/**
88			* @param string $token
89			*/
90			public function revoke(string $token)
91			{
92			$tokenData = $this->getToken($token);
93			if (!$tokenData) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-22 21:06 UTC by Report Bug Copy Issue Report The expression `$tokenData` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
94			return;
95			}
96
97			$userId = $tokenData['userId'];
98
99			$redis = $this->getRedis()->pipeline();
100
101			$redis->srem(sprintf(self::USER_KEY, $userId), $token);
102			$redis->hdel(self::TOKEN_KEY, $token);
103
104			$redis->execute();
105			}
106			}
107

brainexe / core

Push — master ( 66ec7e...c9ec0a )

Token::hasUserForRole() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like