User::findIdentity() - Code Metrics - Inspection of "Added support for Initiating User Registration via..." - rhertogh/yii2-oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 06cf71...6c597b )

by Rutger

created 2024-07-27 22:38 UTC

User::findIdentity() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	1

<?php

namespace sample\models;

use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2OidcUserInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2PasswordGrantUserInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2UserInterface;
use rhertogh\Yii2Oauth2Server\Oauth2Module;
use rhertogh\Yii2Oauth2Server\traits\models\Oauth2OidcUserIdentityTrait;
use rhertogh\Yii2Oauth2Server\traits\models\Oauth2UserIdentityTrait;
use Yii;
use yii\db\ActiveQuery;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;

/**
 * @property int $id
 * @property string $username
 * @property string $password_hash
 * @property string $email_address
 * @property string $latest_authenticated_at
 * @property boolean $enabled
 * @property int $created_at
 * @property int $updated_at
 *
 * @property-read User[] $linkedIdentities
 */
class User extends ActiveRecord implements
    IdentityInterface,
    Oauth2UserInterface,
    Oauth2OidcUserInterface, # Optional interface, only required when OpenID Connect support is enabled
    Oauth2PasswordGrantUserInterface # Optional interface, only required when `password` grant type is used
{
    // phpcs:disable Generic.Files.LineLength.TooLong, PSR12.Traits.UseDeclaration.NoBlankLineAfterUse -- Sample documentation
    use Oauth2UserIdentityTrait; # Helper trait for Oauth2UserInterface
    use Oauth2OidcUserIdentityTrait; # Optional helper trait for Oauth2OidcUserInterface, only required when OpenID Connect support is enabled
    // phpcs:enable Generic.Files.LineLength.TooLong, PSR12.Traits.UseDeclaration.NoBlankLineAfterUse

    # region IdentityInterface (Default Yii interface)
    /**
     * @inheritDoc
     */
    public static function findIdentity($id)
    {
        return static::findOne(['id' => $id]);
    }

    /**
     * @inheritDoc
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @inheritDoc
     */
    public function getAuthKey()
    {
        // TODO: Implement getAuthKey() method (native to Yii2 \yii\web\IdentityInterface).
    }

    /**
     * @inheritDoc
     */
    public function validateAuthKey($authKey)
    {
        // TODO: Implement getAuthKey() method (native to Yii2 \yii\web\IdentityInterface).
    }
    # endregion IdentityInterface

    # region Oauth2UserInterface
    /**
     * @inheritDoc
     */
    public function isOauth2ClientAllowed($client, $grantType)
    {
        // If you want, you can restrict access to certain clients and/or grant types.
        // For now, allow all users to use all clients with any grant type.
        return true;
    }
    # endregion Oauth2UserInterface

    # region Oauth2OidcUserInterface
    /**
     * @inheritDoc
     */
    public function getLatestAuthenticatedAt()
    {
        return new \DateTimeImmutable('@' . ($this->latest_authenticated_at ?: $this->created_at));
    }

    # Other methods are implemented via Oauth2OidcUserIdentityTrait
    # endregion Oauth2OidcUserInterface

    # region Oauth2PasswordGrantUserInterface (Optional interface, only required when `password` grant type is used)
    /**
     * @inheritDoc
     */
    public static function findByUsername($username)
    {
        return static::findOne(['username' => $username]);
    }

    /**
     * Generates password hash from password and sets it to the model
     *
     * @param string $password
     */
    public function setPassword($password)
    {
        $this->password_hash = Yii::$app->security->generatePasswordHash($password);
    }

    /**
     * @inheritDoc
     */
    public function validatePassword($password)
    {
        return Yii::$app->security->validatePassword($password, $this->password_hash);
    }
    # endregion Oauth2PasswordGrantUserInterface

    # region Not Oauth specific but can be used with Oauth Scopes to hide/expose certain fields
    /**
     * @inheritDoc
     */
    public function fields()
    {
        /** @var Oauth2Module $oauth2Module */
        $oauth2Module = Yii::$app->getModule('oauth2');
        return [
            'id',
            ...($oauth2Module->requestHasScope('user.username.read') ? ['username'] : []),
            ...($oauth2Module->requestHasScope('user.email_address.read') ? ['email_address'] : []),
        ];
    }
    # endregion

    # region Sample for a custom OpenID Connect Claim
    public function getCustomOpenIdConnectClaimProperty()
    {
        return 'Custom property for user ' . $this->id;
    }
    # endregion

    # region Application specific implementation for user identity selection
    /**
     * Checks if this user has another identity linked to their account
     * @param int $id
     * @return bool
     */
    public function hasLinkedIdentity($id)
    {
        if ($id == $this->id) {
            return true;
        }
        return $this->getUserIdentityLinks()
            ->andWhere(['linked_user_id' => $id])
            ->exists();
    }

    /**
     * Get an identity that is linked to this account
     * @param $id
     * @return User|null
     */
    public function getLinkedIdentity($id)
    {
        if ($id == $this->id) {
            return $this;
        }

        return $this->getLinkedIdentities()
            ->andWhere(['id' => $id])
            ->one();
    }

    /**
     * Get all available identities for this account (including itself)
     * @return User[]
     */
    public function getAvailableIdentities()
    {
        return [$this, ...$this->linkedIdentities];
    }
    # endregion

    # region ActiveRecord Relations
    /**
     * @return ActiveQuery
     */
    public function getUserIdentityLinks()
    {
        return $this->hasMany(UserIdentityLink::class, ['user_id' => 'id']);
    }

    /**
     * @return ActiveQuery
     */
    public function getLinkedIdentities()
    {
        return $this->hasMany(User::class, ['id' => 'linked_user_id'])->via('userIdentityLinks');
    }
    # endregion
}


1			<?php
2
3			namespace sample\models;
4
5			use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2OidcUserInterface;
6			use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2PasswordGrantUserInterface;
7			use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2UserInterface;
8			use rhertogh\Yii2Oauth2Server\Oauth2Module;
9			use rhertogh\Yii2Oauth2Server\traits\models\Oauth2OidcUserIdentityTrait;
10			use rhertogh\Yii2Oauth2Server\traits\models\Oauth2UserIdentityTrait;
11			use Yii;
12			use yii\db\ActiveQuery;
13			use yii\db\ActiveRecord;
14			use yii\web\IdentityInterface;
15
16			/**
17			* @property int $id
18			* @property string $username
19			* @property string $password_hash
20			* @property string $email_address
21			* @property string $latest_authenticated_at
22			* @property boolean $enabled
23			* @property int $created_at
24			* @property int $updated_at
25			*
26			* @property-read User[] $linkedIdentities
27			*/
28			class User extends ActiveRecord implements
29			IdentityInterface,
30			Oauth2UserInterface,
31			Oauth2OidcUserInterface, # Optional interface, only required when OpenID Connect support is enabled
32			Oauth2PasswordGrantUserInterface # Optional interface, only required when `password` grant type is used
33			{
34			// phpcs:disable Generic.Files.LineLength.TooLong, PSR12.Traits.UseDeclaration.NoBlankLineAfterUse -- Sample documentation
35			use Oauth2UserIdentityTrait; # Helper trait for Oauth2UserInterface
36			use Oauth2OidcUserIdentityTrait; # Optional helper trait for Oauth2OidcUserInterface, only required when OpenID Connect support is enabled
37			// phpcs:enable Generic.Files.LineLength.TooLong, PSR12.Traits.UseDeclaration.NoBlankLineAfterUse
38
39			# region IdentityInterface (Default Yii interface)
40			/**
41			* @inheritDoc
42			*/
43			public static function findIdentity($id)
44			{
45			return static::findOne(['id' => $id]);
46			}
47
48			/**
49			* @inheritDoc
50			*/
51			public function getId()
52			{
53			return $this->id;
54			}
55
56			/**
57			* @inheritDoc
58			*/
59			public function getAuthKey()
60			{
61			// TODO: Implement getAuthKey() method (native to Yii2 \yii\web\IdentityInterface).
62			}
63
64			/**
65			* @inheritDoc
66			*/
67			public function validateAuthKey($authKey)
68			{
69			// TODO: Implement getAuthKey() method (native to Yii2 \yii\web\IdentityInterface).
70			}
71			# endregion IdentityInterface
72
73			# region Oauth2UserInterface
74			/**
75			* @inheritDoc
76			*/
77			public function isOauth2ClientAllowed($client, $grantType)
78			{
79			// If you want, you can restrict access to certain clients and/or grant types.
80			// For now, allow all users to use all clients with any grant type.
81			return true;
82			}
83			# endregion Oauth2UserInterface
84
85			# region Oauth2OidcUserInterface
86			/**
87			* @inheritDoc
88			*/
89			public function getLatestAuthenticatedAt()
90			{
91			return new \DateTimeImmutable('@' . ($this->latest_authenticated_at ?: $this->created_at));
92			}
93
94			# Other methods are implemented via Oauth2OidcUserIdentityTrait
95			# endregion Oauth2OidcUserInterface
96
97			# region Oauth2PasswordGrantUserInterface (Optional interface, only required when `password` grant type is used)
98			/**
99			* @inheritDoc
100			*/
101			public static function findByUsername($username)
102			{
103			return static::findOne(['username' => $username]);
104			}
105
106			/**
107			* Generates password hash from password and sets it to the model
108			*
109			* @param string $password
110			*/
111			public function setPassword($password)
112			{
113			$this->password_hash = Yii::$app->security->generatePasswordHash($password);
114			}
115
116			/**
117			* @inheritDoc
118			*/
119			public function validatePassword($password)
120			{
121			return Yii::$app->security->validatePassword($password, $this->password_hash);
122			}
123			# endregion Oauth2PasswordGrantUserInterface
124
125			# region Not Oauth specific but can be used with Oauth Scopes to hide/expose certain fields
126			/**
127			* @inheritDoc
128			*/
129			public function fields()
130			{
131			/** @var Oauth2Module $oauth2Module */
132			$oauth2Module = Yii::$app->getModule('oauth2');
133			return [
134			'id',
135			...($oauth2Module->requestHasScope('user.username.read') ? ['username'] : []),
136			...($oauth2Module->requestHasScope('user.email_address.read') ? ['email_address'] : []),
137			];
138			}
139			# endregion
140
141			# region Sample for a custom OpenID Connect Claim
142			public function getCustomOpenIdConnectClaimProperty()
143			{
144			return 'Custom property for user ' . $this->id;
145			}
146			# endregion
147
148			# region Application specific implementation for user identity selection
149			/**
150			* Checks if this user has another identity linked to their account
151			* @param int $id
152			* @return bool
153			*/
154			public function hasLinkedIdentity($id)
155			{
156			if ($id == $this->id) {
157			return true;
158			}
159			return $this->getUserIdentityLinks()
160			->andWhere(['linked_user_id' => $id])
161			->exists();
162			}
163
164			/**
165			* Get an identity that is linked to this account
166			* @param $id
167			* @return User\|null
168			*/
169			public function getLinkedIdentity($id)
170			{
171			if ($id == $this->id) {
172			return $this;
173			}
174
175			return $this->getLinkedIdentities()
176			->andWhere(['id' => $id])
177			->one();
178			}
179
180			/**
181			* Get all available identities for this account (including itself)
182			* @return User[]
183			*/
184			public function getAvailableIdentities()
185			{
186			return [$this, ...$this->linkedIdentities];
187			}
188			# endregion
189
190			# region ActiveRecord Relations
191			/**
192			* @return ActiveQuery
193			*/
194			public function getUserIdentityLinks()
195			{
196			return $this->hasMany(UserIdentityLink::class, ['user_id' => 'id']);
197			}
198
199			/**
200			* @return ActiveQuery
201			*/
202			public function getLinkedIdentities()
203			{
204			return $this->hasMany(User::class, ['id' => 'linked_user_id'])->via('userIdentityLinks');
205			}
206			# endregion
207			}
208

rhertogh / yii2-oauth2-server

Push — master ( 06cf71...6c597b )

User::findIdentity() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like