ScopeService::findAvailableScopeIds() - Code Metrics - Inspection of "Merge pull request #18 from mdeschamps-ibitux/feat..." - pgaultier/yii2-oauth2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — devel ( f78bd1...13d8c8 )

by Philippe

created 2018-08-04 15:01 UTC

ScopeService::findAvailableScopeIds() A

↳ Parent: ScopeService

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	12
rs	9.8666
cc	2
nc	2
nop	0

<?php
/**
 * ScopeService.php
 *
 * PHP version 5.6+
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2017 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version 1.2.0
 * @link http://www.sweelix.net
 * @package sweelix\oauth2\server\services\mySql
 */

namespace sweelix\oauth2\server\services\mySql;

use sweelix\oauth2\server\exceptions\DuplicateIndexException;
use sweelix\oauth2\server\exceptions\DuplicateKeyException;
use sweelix\oauth2\server\interfaces\ScopeModelInterface;
use sweelix\oauth2\server\interfaces\ScopeServiceInterface;
use yii\db\Exception as DatabaseException;
use Yii;
use yii\db\Query;

/**
 * This is the scope service for mySql
 *  database structure
 *    * oauth2:scopes:<sid> : hash (Scope)
 *    * oauth2:scopes:keys : set scopeIds
 *    * oauth2:scopes:defaultkeys : set default scopeIds
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2017 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version 1.2.0
 * @link http://www.sweelix.net
 * @package sweelix\oauth2\server\services\mySql
 * @since 1.0.0
 */
class ScopeService extends BaseService implements ScopeServiceInterface
{
    /**
     * @var string sql scope client table
     */
    public $scopeClientTable = null;

    /**
     * @var string sql scopes table
     */
    public $scopesTable = null;

    /**
     * Save Scope
     * @param ScopeModelInterface $scope
     * @param null|array $attributes attributes to save
     * @return bool
     * @throws DatabaseException
     * @throws DuplicateIndexException
     * @throws DuplicateKeyException
     * @since 1.0.0
     */
    protected function insert(ScopeModelInterface $scope, $attributes)
    {
        $result = false;
        if (!$scope->beforeSave(true)) {
            return $result;
        }
        $entity = (new Query())
            ->select('*')
            ->from($this->scopesTable)
            ->where('id = :id', [':id' => $scope->id])
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->one($this->db);
        if ($entity !== false) {
            throw new DuplicateKeyException('Duplicate key "' . $scope->id . '"');
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
        $values = $scope->getDirtyAttributes($attributes);

        $scopeParameters = [];
        $this->setAttributesDefinitions($scope->attributesDefinition());
        foreach ($values as $key => $value) {
            if ($value !== null) {
                $scopeParameters[$key] = $this->convertToDatabase($key, $value);
            }
        }
        $scopeParameters['dateCreated'] = date('Y-m-d H:i:s');
        $scopeParameters['dateUpdated'] = date('Y-m-d H:i:s');
        try {
            $this->db->createCommand()
                ->insert($this->scopesTable, $scopeParameters)
                ->execute();
        } catch (DatabaseException $e) {
            // @codeCoverageIgnoreStart
            // we have a MYSQL exception, we should not discard
            Yii::debug('Error while inserting entity', __METHOD__);
            throw $e;
            // @codeCoverageIgnoreEnd
        }
        $changedAttributes = array_fill_keys(array_keys($values), null);
        $scope->setOldAttributes($values);
        $scope->afterSave(true, $changedAttributes);
        $result = true;
        return $result;
    }

    /**
     * Update ScopeModelInterface
     * @param ScopeModelInterface $scope
     * @param null|array $attributes attributes to save
     * @return bool
     * @throws DatabaseException
     * @throws DuplicateIndexException
     * @throws DuplicateKeyException
     */
    protected function update(ScopeModelInterface $scope, $attributes)
    {
        if (!$scope->beforeSave(false)) {
            return false;
        }

        $values = $scope->getDirtyAttributes($attributes);

        $modelKey = $scope->key();
        if (isset($values[$modelKey]) === true) {
            $entity = (new Query())
                ->select('*')
                ->from($this->scopesTable)
                ->where('id = :id', [':id' => $values[$modelKey]])
                ->one($this->db);
            if ($entity !== false) {
                throw new DuplicateKeyException('Duplicate key "' . $values[$modelKey] . '"');
            }
        }
        $scopeKey = isset($values[$modelKey]) ? $values[$modelKey] : $scope->getKey();

        $scopeParameters = [];
        $this->setAttributesDefinitions($scope->attributesDefinition());
        foreach ($values as $key => $value) {
            $scopeParameters[$key] = ($value !== null) ? $this->convertToDatabase($key, $value) : null;
        }
        $scopeParameters['dateUpdated'] = date('Y-m-d H:i:s');
        try {
            if (array_key_exists($modelKey, $values) === true) {
                $oldScopeKey = $scope->getOldKey();
                $this->db->createCommand()
                    ->update($this->scopesTable, $scopeParameters, 'id = :id', [':id' => $oldScopeKey])
                    ->execute();
            } else {
                $this->db->createCommand()
                    ->update($this->scopesTable, $scopeParameters, 'id = :id', [':id' => $scopeKey])
                    ->execute();
            }
        } catch (DatabaseException $e) {
            // @codeCoverageIgnoreStart
            // we have a MYSQL exception, we should not discard
            Yii::debug('Error while updating entity', __METHOD__);
            throw $e;
            // @codeCoverageIgnoreEnd
        }

        $changedAttributes = [];
        foreach ($values as $name => $value) {
            $oldAttributes = $scope->getOldAttributes();
            $changedAttributes[$name] = isset($oldAttributes[$name]) ? $oldAttributes[$name] : null;
            $scope->setOldAttribute($name, $value);
        }
        $scope->afterSave(false, $changedAttributes);
        return true;
    }

    /**
     * @inheritdoc
     */
    public function save(ScopeModelInterface $scope, $attributes)
    {
        if ($scope->getIsNewRecord()) {
            $result = $this->insert($scope, $attributes);
        } else {
            $result = $this->update($scope, $attributes);
        }
        return $result;
    }

    /**
     * @inheritdoc
     */
    public function findOne($key)
    {
        $record = null;
        $scopeData = (new Query())
            ->select('*')
            ->from($this->scopesTable)
            ->where('id = :id', [':id' => $key])
            ->one($this->db);
        if ($scopeData !== false) {
            $record = Yii::createObject('sweelix\oauth2\server\interfaces\ScopeModelInterface');
            /** @var ScopeModelInterface $record */
            $properties = $record->attributesDefinition();
            $this->setAttributesDefinitions($properties);
            $attributes = [];
            foreach ($scopeData as $key => $value) {
                if (isset($properties[$key]) === true) {
                    $scopeData[$key] = $this->convertToModel($key, $value);
                    $record->setAttribute($key, $scopeData[$key]);
                    $attributes[$key] = $scopeData[$key];
                    // @codeCoverageIgnoreStart
                } elseif ($record->canSetProperty($key)) {
                    // TODO: find a way to test attribute population
                    $record->{$key} = $value;
                }
                // @codeCoverageIgnoreEnd
            }
            if (empty($attributes) === false) {
                $record->setOldAttributes($attributes);
            }
            $record->afterFind();
        }
        return $record;
    }

    /**
     * @inheritdoc
     */
    public function delete(ScopeModelInterface $scope)
    {
        $result = false;
        if ($scope->beforeDelete()) {
            //TODO: check results to return correct information
            $this->db->createCommand()
                ->delete($this->scopesTable, 'id = :id', [':id' => $scope->getKey()])
                ->execute();
            $scope->setIsNewRecord(true);
            $scope->afterDelete();
            $result = true;
        }
        return $result;
    }

    /**
     * @inheritdoc
     */
    public function findAvailableScopeIds()
    {
        $tmpScopes = (new Query())
            ->select('id')
            ->from($this->scopesTable)
            ->all($this->db);
        $scopes = [];
        foreach ($tmpScopes as $scope) {
            $scopes[] = $scope['id'];
        }
        return $scopes;
    }

    /**
     * @inheritdoc
     */
    public function findDefaultScopeIds($clientId = null)
    {
        //TODO: add default scopes for clients
        $defaultScopeIds = [];
        if ($clientId !== null) {
            $tmpScopeIds = (new Query())
                ->select('scopeId as ID')
                ->from($this->scopeClientTable)
                ->where('clientId = :clientId', [':clientId' => $clientId])
                ->all($this->db);
        } else {
            $tmpScopeIds = (new Query())
                ->select('id as ID')
                ->from($this->scopesTable)
                ->where('isDefault = :isDefault', [':isDefault' => true])
                ->all($this->db);
        }
        foreach ($tmpScopeIds as $tmpScopeId) {
            $defaultScopeIds[] = $tmpScopeId['ID'];
        }
        return $defaultScopeIds;
    }
}


Push — devel ( f78bd1...13d8c8 )

ScopeService::findAvailableScopeIds() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* ScopeService.php
4			*
5			* PHP version 5.6+
6			*
7			* @author Philippe Gaultier <[email protected]>
8			* @copyright 2010-2017 Philippe Gaultier
9			* @license http://www.sweelix.net/license license
10			* @version 1.2.0
11			* @link http://www.sweelix.net
12			* @package sweelix\oauth2\server\services\mySql
13			*/
14
15			namespace sweelix\oauth2\server\services\mySql;
16
17			use sweelix\oauth2\server\exceptions\DuplicateIndexException;
18			use sweelix\oauth2\server\exceptions\DuplicateKeyException;
19			use sweelix\oauth2\server\interfaces\ScopeModelInterface;
20			use sweelix\oauth2\server\interfaces\ScopeServiceInterface;
21			use yii\db\Exception as DatabaseException;
22			use Yii;
23			use yii\db\Query;
24
25			/**
26			* This is the scope service for mySql
27			* database structure
28			* * oauth2:scopes:<sid> : hash (Scope)
29			* * oauth2:scopes:keys : set scopeIds
30			* * oauth2:scopes:defaultkeys : set default scopeIds
31			*
32			* @author Philippe Gaultier <[email protected]>
33			* @copyright 2010-2017 Philippe Gaultier
34			* @license http://www.sweelix.net/license license
35			* @version 1.2.0
36			* @link http://www.sweelix.net
37			* @package sweelix\oauth2\server\services\mySql
38			* @since 1.0.0
39			*/
40			class ScopeService extends BaseService implements ScopeServiceInterface
41			{
42			/**
43			* @var string sql scope client table
44			*/
45			public $scopeClientTable = null;
46
47			/**
48			* @var string sql scopes table
49			*/
50			public $scopesTable = null;
51
52			/**
53			* Save Scope
54			* @param ScopeModelInterface $scope
55			* @param null\|array $attributes attributes to save
56			* @return bool
57			* @throws DatabaseException
58			* @throws DuplicateIndexException
59			* @throws DuplicateKeyException
60			* @since 1.0.0
61			*/
62			protected function insert(ScopeModelInterface $scope, $attributes)
63			{
64			$result = false;
65			if (!$scope->beforeSave(true)) {
66			return $result;
67			}
68			$entity = (new Query())
69			->select('*')
70			->from($this->scopesTable)
71			->where('id = :id', [':id' => $scope->id])
			0 ignored issues – show Bug introduced 2018-06-26 10:14 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `sweelix\oauth2\server\in...ces\ScopeModelInterface` 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...
72			->one($this->db);
73			if ($entity !== false) {
74			throw new DuplicateKeyException('Duplicate key "' . $scope->id . '"');
			0 ignored issues – show Bug introduced 2018-06-26 10:14 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `sweelix\oauth2\server\in...ces\ScopeModelInterface` 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...
75			}
76			$values = $scope->getDirtyAttributes($attributes);
			0 ignored issues – show Bug introduced 2018-06-26 10:14 UTC by Report Bug Copy Issue Report It seems like `$attributes` defined by parameter `$attributes` on line 62 can also be of type `array`; however, `sweelix\oauth2\server\in...e::getDirtyAttributes()` does only seem to accept `array<integer,string>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
77			$scopeParameters = [];
78			$this->setAttributesDefinitions($scope->attributesDefinition());
79			foreach ($values as $key => $value) {
80			if ($value !== null) {
81			$scopeParameters[$key] = $this->convertToDatabase($key, $value);
82			}
83			}
84			$scopeParameters['dateCreated'] = date('Y-m-d H:i:s');
85			$scopeParameters['dateUpdated'] = date('Y-m-d H:i:s');
86			try {
87			$this->db->createCommand()
88			->insert($this->scopesTable, $scopeParameters)
89			->execute();
90			} catch (DatabaseException $e) {
91			// @codeCoverageIgnoreStart
92			// we have a MYSQL exception, we should not discard
93			Yii::debug('Error while inserting entity', __METHOD__);
94			throw $e;
95			// @codeCoverageIgnoreEnd
96			}
97			$changedAttributes = array_fill_keys(array_keys($values), null);
98			$scope->setOldAttributes($values);
99			$scope->afterSave(true, $changedAttributes);
100			$result = true;
101			return $result;
102			}
103
104			/**
105			* Update ScopeModelInterface
106			* @param ScopeModelInterface $scope
107			* @param null\|array $attributes attributes to save
108			* @return bool
109			* @throws DatabaseException
110			* @throws DuplicateIndexException
111			* @throws DuplicateKeyException
112			*/
113			protected function update(ScopeModelInterface $scope, $attributes)
114			{
115			if (!$scope->beforeSave(false)) {
116			return false;
117			}
118
119			$values = $scope->getDirtyAttributes($attributes);
			0 ignored issues – show Bug introduced 2018-06-26 10:14 UTC by Report Bug Copy Issue Report It seems like `$attributes` defined by parameter `$attributes` on line 113 can also be of type `array`; however, `sweelix\oauth2\server\in...e::getDirtyAttributes()` does only seem to accept `array<integer,string>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
120			$modelKey = $scope->key();
121			if (isset($values[$modelKey]) === true) {
122			$entity = (new Query())
123			->select('*')
124			->from($this->scopesTable)
125			->where('id = :id', [':id' => $values[$modelKey]])
126			->one($this->db);
127			if ($entity !== false) {
128			throw new DuplicateKeyException('Duplicate key "' . $values[$modelKey] . '"');
129			}
130			}
131			$scopeKey = isset($values[$modelKey]) ? $values[$modelKey] : $scope->getKey();
132
133			$scopeParameters = [];
134			$this->setAttributesDefinitions($scope->attributesDefinition());
135			foreach ($values as $key => $value) {
136			$scopeParameters[$key] = ($value !== null) ? $this->convertToDatabase($key, $value) : null;
137			}
138			$scopeParameters['dateUpdated'] = date('Y-m-d H:i:s');
139			try {
140			if (array_key_exists($modelKey, $values) === true) {
141			$oldScopeKey = $scope->getOldKey();
142			$this->db->createCommand()
143			->update($this->scopesTable, $scopeParameters, 'id = :id', [':id' => $oldScopeKey])
144			->execute();
145			} else {
146			$this->db->createCommand()
147			->update($this->scopesTable, $scopeParameters, 'id = :id', [':id' => $scopeKey])
148			->execute();
149			}
150			} catch (DatabaseException $e) {
151			// @codeCoverageIgnoreStart
152			// we have a MYSQL exception, we should not discard
153			Yii::debug('Error while updating entity', __METHOD__);
154			throw $e;
155			// @codeCoverageIgnoreEnd
156			}
157
158			$changedAttributes = [];
159			foreach ($values as $name => $value) {
160			$oldAttributes = $scope->getOldAttributes();
161			$changedAttributes[$name] = isset($oldAttributes[$name]) ? $oldAttributes[$name] : null;
162			$scope->setOldAttribute($name, $value);
163			}
164			$scope->afterSave(false, $changedAttributes);
165			return true;
166			}
167
168			/**
169			* @inheritdoc
170			*/
171			public function save(ScopeModelInterface $scope, $attributes)
172			{
173			if ($scope->getIsNewRecord()) {
174			$result = $this->insert($scope, $attributes);
175			} else {
176			$result = $this->update($scope, $attributes);
177			}
178			return $result;
179			}
180
181			/**
182			* @inheritdoc
183			*/
184			public function findOne($key)
185			{
186			$record = null;
187			$scopeData = (new Query())
188			->select('*')
189			->from($this->scopesTable)
190			->where('id = :id', [':id' => $key])
191			->one($this->db);
192			if ($scopeData !== false) {
193			$record = Yii::createObject('sweelix\oauth2\server\interfaces\ScopeModelInterface');
194			/** @var ScopeModelInterface $record */
195			$properties = $record->attributesDefinition();
196			$this->setAttributesDefinitions($properties);
197			$attributes = [];
198			foreach ($scopeData as $key => $value) {
199			if (isset($properties[$key]) === true) {
200			$scopeData[$key] = $this->convertToModel($key, $value);
201			$record->setAttribute($key, $scopeData[$key]);
202			$attributes[$key] = $scopeData[$key];
203			// @codeCoverageIgnoreStart
204			} elseif ($record->canSetProperty($key)) {
205			// TODO: find a way to test attribute population
206			$record->{$key} = $value;
207			}
208			// @codeCoverageIgnoreEnd
209			}
210			if (empty($attributes) === false) {
211			$record->setOldAttributes($attributes);
212			}
213			$record->afterFind();
214			}
215			return $record;
216			}
217
218			/**
219			* @inheritdoc
220			*/
221			public function delete(ScopeModelInterface $scope)
222			{
223			$result = false;
224			if ($scope->beforeDelete()) {
225			//TODO: check results to return correct information
226			$this->db->createCommand()
227			->delete($this->scopesTable, 'id = :id', [':id' => $scope->getKey()])
228			->execute();
229			$scope->setIsNewRecord(true);
230			$scope->afterDelete();
231			$result = true;
232			}
233			return $result;
234			}
235
236			/**
237			* @inheritdoc
238			*/
239			public function findAvailableScopeIds()
240			{
241			$tmpScopes = (new Query())
242			->select('id')
243			->from($this->scopesTable)
244			->all($this->db);
245			$scopes = [];
246			foreach ($tmpScopes as $scope) {
247			$scopes[] = $scope['id'];
248			}
249			return $scopes;
250			}
251
252			/**
253			* @inheritdoc
254			*/
255			public function findDefaultScopeIds($clientId = null)
256			{
257			//TODO: add default scopes for clients
258			$defaultScopeIds = [];
259			if ($clientId !== null) {
260			$tmpScopeIds = (new Query())
261			->select('scopeId as ID')
262			->from($this->scopeClientTable)
263			->where('clientId = :clientId', [':clientId' => $clientId])
264			->all($this->db);
265			} else {
266			$tmpScopeIds = (new Query())
267			->select('id as ID')
268			->from($this->scopesTable)
269			->where('isDefault = :isDefault', [':isDefault' => true])
270			->all($this->db);
271			}
272			foreach ($tmpScopeIds as $tmpScopeId) {
273			$defaultScopeIds[] = $tmpScopeId['ID'];
274			}
275			return $defaultScopeIds;
276			}
277			}
278

pgaultier / yii2-oauth2

Push — devel ( f78bd1...13d8c8 )

ScopeService::findAvailableScopeIds() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like