Tokens::getToken() - Code Metrics - dukt/videos - Measure and Improve Code Quality continuously with Scrutinizer

Tokens::getToken() A
last analyzed 2023-06-29 13:02 UTC

↳ Parent: Tokens

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	9
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	14
rs	9.9666

<?php
/**
 * @link      https://dukt.net/videos/
 * @copyright Copyright (c) Dukt
 * @license   https://github.com/dukt/videos/blob/v2/LICENSE.md
 */

namespace dukt\videos\services;

use Craft;
use dukt\analytics\errors\InvalidViewException;
filter:
    dependency_paths: ["lib/*"]
use dukt\videos\models\Token;
use dukt\videos\records\Token as TokenRecord;
use Exception;
use yii\base\Component;

/**
 * Class Tokens service.
 *
 * An instance of the Tokens service is globally accessible via [[Plugin::oauth `VideosPlugin::$plugin->getTokens()`]].
 *
 * @author Dukt <[email protected]>
 * @since  2.0
 */
class Tokens extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Get a token by its gateway handle.
     *
     * @param $gatewayHandle
     * @return Token|null
     */
    public function getToken($gatewayHandle): ?\dukt\videos\models\Token
    {
        $result = TokenRecord::find()
            ->where(['gateway' => $gatewayHandle])
            ->one();

        if (!$result) {
            return null;
        }

        return new Token($result->toArray([
            'id',
            'gateway',
            'accessToken',
        ]));
    }

    /**
     * Saves a token.
     *
     * @param Token $token
     * @param bool $runValidation
     * @return bool
     * @throws InvalidViewException
     */
    public function saveToken(Token $token, bool $runValidation = true): bool
    {
        if ($runValidation && !$token->validate()) {
            Craft::info('Token not saved due to validation error.', __METHOD__);

            return false;
        }

        if ($token->id) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $tokenRecord = TokenRecord::find()
                ->where(['id' => $token->id])
                ->one();

            if (!$tokenRecord) {
                throw new InvalidViewException(sprintf('No token exists with the ID \'%s\'', $token->id));
            }

            $isNewToken = false;
        } else {
            $tokenRecord = new TokenRecord();
            $isNewToken = true;
        }

        $tokenRecord->gateway = $token->gateway;

        $tokenRecord->accessToken = $token->accessToken;


        $transaction = Craft::$app->getDb()->beginTransaction();

        try {
            // Is the event giving us the go-ahead?
            $tokenRecord->save(false);

            // Now that we have a view ID, save it on the model
            if ($isNewToken) {
                $token->id = $tokenRecord->id;

            }

            $transaction->commit();
        } catch (Exception $exception) {
            $transaction->rollBack();

            throw $exception;
        }

        return true;
    }

    /**
     * Deletes a token.
     *
     * @param int $id
     * @return bool
     * @throws \Throwable
     * @throws \yii\db\StaleObjectException
     */
    public function deleteTokenById(int $id): bool
    {
        $tokenRecord = TokenRecord::findOne($id);

        if (!$tokenRecord instanceof \dukt\videos\records\Token) {
            return true;
        }

        $tokenRecord->delete();

        return true;
    }
}


1			<?php
2			/**
3			* @link https://dukt.net/videos/
4			* @copyright Copyright (c) Dukt
5			* @license https://github.com/dukt/videos/blob/v2/LICENSE.md
6			*/
7
8			namespace dukt\videos\services;
9
10			use Craft;
11			use dukt\analytics\errors\InvalidViewException;
			0 ignored issues – show Bug introduced 2019-06-02 00:25 UTC by Report Bug Copy Issue Report The type `dukt\analytics\errors\InvalidViewException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
12			use dukt\videos\models\Token;
13			use dukt\videos\records\Token as TokenRecord;
14			use Exception;
15			use yii\base\Component;
16
17			/**
18			* Class Tokens service.
19			*
20			* An instance of the Tokens service is globally accessible via [[Plugin::oauth `VideosPlugin::$plugin->getTokens()`]].
21			*
22			* @author Dukt <[email protected]>
23			* @since 2.0
24			*/
25			class Tokens extends Component
26			{
27			// Public Methods
28			// =========================================================================
29
30			/**
31			* Get a token by its gateway handle.
32			*
33			* @param $gatewayHandle
34			* @return Token\|null
35			*/
36			public function getToken($gatewayHandle): ?\dukt\videos\models\Token
37			{
38			$result = TokenRecord::find()
39			->where(['gateway' => $gatewayHandle])
40			->one();
41
42			if (!$result) {
43			return null;
44			}
45
46			return new Token($result->toArray([
47			'id',
48			'gateway',
49			'accessToken',
50			]));
51			}
52
53			/**
54			* Saves a token.
55			*
56			* @param Token $token
57			* @param bool $runValidation
58			* @return bool
59			* @throws InvalidViewException
60			*/
61			public function saveToken(Token $token, bool $runValidation = true): bool
62			{
63			if ($runValidation && !$token->validate()) {
64			Craft::info('Token not saved due to validation error.', __METHOD__);
65
66			return false;
67			}
68
69			if ($token->id) {
			0 ignored issues – show Bug Best Practice introduced 2019-06-02 00:25 UTC by Report Bug Copy Issue Report The expression `$token->id` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. 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 `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
70			$tokenRecord = TokenRecord::find()
71			->where(['id' => $token->id])
72			->one();
73
74			if (!$tokenRecord) {
75			throw new InvalidViewException(sprintf('No token exists with the ID \'%s\'', $token->id));
76			}
77
78			$isNewToken = false;
79			} else {
80			$tokenRecord = new TokenRecord();
81			$isNewToken = true;
82			}
83
84			$tokenRecord->gateway = $token->gateway;
			0 ignored issues – show Bug Best Practice introduced 2019-06-02 00:25 UTC by Report Bug Copy Issue Report The property `gateway` does not exist on `dukt\videos\records\Token`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
85			$tokenRecord->accessToken = $token->accessToken;
			0 ignored issues – show Bug Best Practice introduced 2019-06-02 00:25 UTC by Report Bug Copy Issue Report The property `accessToken` does not exist on `dukt\videos\records\Token`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
86
87			$transaction = Craft::$app->getDb()->beginTransaction();
88
89			try {
90			// Is the event giving us the go-ahead?
91			$tokenRecord->save(false);
92
93			// Now that we have a view ID, save it on the model
94			if ($isNewToken) {
95			$token->id = $tokenRecord->id;
			0 ignored issues – show Bug Best Practice introduced 2019-06-02 00:25 UTC by Report Bug Copy Issue Report The property `id` does not exist on `dukt\videos\records\Token`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
96			}
97
98			$transaction->commit();
99			} catch (Exception $exception) {
100			$transaction->rollBack();
101
102			throw $exception;
103			}
104
105			return true;
106			}
107
108			/**
109			* Deletes a token.
110			*
111			* @param int $id
112			* @return bool
113			* @throws \Throwable
114			* @throws \yii\db\StaleObjectException
115			*/
116			public function deleteTokenById(int $id): bool
117			{
118			$tokenRecord = TokenRecord::findOne($id);
119
120			if (!$tokenRecord instanceof \dukt\videos\records\Token) {
121			return true;
122			}
123
124			$tokenRecord->delete();
125
126			return true;
127			}
128			}
129

dukt / videos

Tokens::getToken() A last analyzed 2023-06-29 13:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Tokens::getToken() A
last analyzed 2023-06-29 13:02 UTC