AbstractProviderIdentityService - Code Metrics - Inspection of "Added NameID Override per IDP to the SP templates." - flipboxfactory/saml-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 72ecff...582962 )

by Damien

created 2020-09-23 04:52 UTC

AbstractProviderIdentityService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	7
lcom	1
cbo	7
dl	0
loc	85
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	findByUserAndProvider()	7	1
A	findByUserAndProviderOrCreate()	14	1
A	findByNameId()	7	1
A	findByUser()	6	1
A	find()	10	1
A	save()	12	2

<?php
/**
 * Created by PhpStorm.
 * User: dsmrt
 * Date: 2/28/18
 * Time: 9:37 PM
 */

namespace flipbox\saml\core\services;

use craft\elements\User;
use flipbox\saml\core\EnsureSAMLPlugin;
use flipbox\saml\core\records\AbstractProvider;
use flipbox\saml\core\records\AbstractProviderIdentity;
use flipbox\saml\core\records\ProviderIdentityInterface;
use flipbox\saml\core\records\ProviderInterface;
use yii\base\Component;
use yii\helpers\Json;

/**
 * Class AbstractProviderIdentityService
 * @package flipbox\saml\core\services
 * @property \DateTime $lastLoginDate
 */
abstract class AbstractProviderIdentityService extends Component implements ProviderIdentityServiceInterface, EnsureSAMLPlugin
{
    /**
     * @inheritdoc
     */
    public function findByNameId(string $nameId, ProviderInterface $provider)
    {
        return $this->find([
            'nameId' => $nameId,
            'providerId' => $provider->id,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        ]);
    }

    /**
     * @inheritdoc
     */
    public function findByUser(User $user)
    {
        return $this->find([
            'userId' => $user->getId(),
        ]);
    }

    /**
     * @param User $user
     * @param AbstractProvider $provider
     * @return ProviderInterface|null
     */
    public function findByUserAndProvider(User $user, AbstractProvider $provider)
    {
        return $this->find([
            'userId' => $user->getId(),
            'providerId' => $provider->id,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        ])->one();
    }

    public function findByUserAndProviderOrCreate(User $user, AbstractProvider $provider)
    {
        $recordClass = $this->getPlugin()->getProviderIdentityRecordClass();
        return
            $this->findByUserAndProvider($user, $provider)
            ??
            new $recordClass([
                'nameId' => $provider->assignNameId($user),
                'providerId' => $provider->id,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                'enabled' => true,
                'userId' => $user->getId(),
                'lastLoginDate' => new \DateTime,
            ]);
    }

    /**
     * @inheritdoc
     */
    public function find($condition = [])
    {
        /** @var AbstractProviderIdentity $class */
        $class = $this->getPlugin()->getProviderIdentityRecordClass();

        /** @var AbstractProviderIdentity $class */
        $providerId = $class::find()->where($condition);

        return $providerId;
    }

    /**
     * @param ProviderIdentityInterface $record
     * @param bool $runValidation
     * @param array|null $attributeNames
     * @return ProviderIdentityInterface
     * @throws \Exception
     */
    public function save(
        ProviderIdentityInterface $record,
        $runValidation = true,
        $attributeNames = null
    ): ProviderIdentityInterface {

        if (! $record->save($runValidation, $attributeNames)) {
            throw new \Exception(Json::encode($record->getErrors()));
        }

        return $record;
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: dsmrt
5			* Date: 2/28/18
6			* Time: 9:37 PM
7			*/
8
9			namespace flipbox\saml\core\services;
10
11			use craft\elements\User;
12			use flipbox\saml\core\EnsureSAMLPlugin;
13			use flipbox\saml\core\records\AbstractProvider;
14			use flipbox\saml\core\records\AbstractProviderIdentity;
15			use flipbox\saml\core\records\ProviderIdentityInterface;
16			use flipbox\saml\core\records\ProviderInterface;
17			use yii\base\Component;
18			use yii\helpers\Json;
19
20			/**
21			* Class AbstractProviderIdentityService
22			* @package flipbox\saml\core\services
23			* @property \DateTime $lastLoginDate
24			*/
25			abstract class AbstractProviderIdentityService extends Component implements ProviderIdentityServiceInterface, EnsureSAMLPlugin
26			{
27			/**
28			* @inheritdoc
29			*/
30			public function findByNameId(string $nameId, ProviderInterface $provider)
31			{
32			return $this->find([
33			'nameId' => $nameId,
34			'providerId' => $provider->id,
			0 ignored issues – show Bug introduced 2018-06-29 21:37 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
35			]);
36			}
37
38			/**
39			* @inheritdoc
40			*/
41			public function findByUser(User $user)
42			{
43			return $this->find([
44			'userId' => $user->getId(),
45			]);
46			}
47
48			/**
49			* @param User $user
50			* @param AbstractProvider $provider
51			* @return ProviderInterface\|null
52			*/
53			public function findByUserAndProvider(User $user, AbstractProvider $provider)
54			{
55			return $this->find([
56			'userId' => $user->getId(),
57			'providerId' => $provider->id,
			0 ignored issues – show Documentation introduced 2019-05-09 20:04 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<flipbox\saml\core...cords\AbstractProvider>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
58			])->one();
59			}
60
61			public function findByUserAndProviderOrCreate(User $user, AbstractProvider $provider)
62			{
63			$recordClass = $this->getPlugin()->getProviderIdentityRecordClass();
64			return
65			$this->findByUserAndProvider($user, $provider)
66			??
67			new $recordClass([
68			'nameId' => $provider->assignNameId($user),
69			'providerId' => $provider->id,
			0 ignored issues – show Documentation introduced 2019-05-17 05:26 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<flipbox\saml\core...cords\AbstractProvider>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
70			'enabled' => true,
71			'userId' => $user->getId(),
72			'lastLoginDate' => new \DateTime,
73			]);
74			}
75
76			/**
77			* @inheritdoc
78			*/
79			public function find($condition = [])
80			{
81			/** @var AbstractProviderIdentity $class */
82			$class = $this->getPlugin()->getProviderIdentityRecordClass();
83
84			/** @var AbstractProviderIdentity $class */
85			$providerId = $class::find()->where($condition);
86
87			return $providerId;
88			}
89
90			/**
91			* @param ProviderIdentityInterface $record
92			* @param bool $runValidation
93			* @param array\|null $attributeNames
94			* @return ProviderIdentityInterface
95			* @throws \Exception
96			*/
97			public function save(
98			ProviderIdentityInterface $record,
99			$runValidation = true,
100			$attributeNames = null
101			): ProviderIdentityInterface {
102
103			if (! $record->save($runValidation, $attributeNames)) {
104			throw new \Exception(Json::encode($record->getErrors()));
105			}
106
107			return $record;
108			}
109			}
110

flipboxfactory / saml-core

Push — master ( 72ecff...582962 )

AbstractProviderIdentityService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like