JwtService::delete() - Code Metrics - pgaultier/yii2-oauth2 - Measure and Improve Code Quality continuously with Scrutinizer

JwtService::delete() A
last analyzed 2018-11-06 00:45 UTC

↳ Parent: JwtService

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	14
rs	9.7998
cc	2
nc	2
nop	1

<?php
/**
 * JwtService.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\JwtModelInterface;
use sweelix\oauth2\server\interfaces\JwtServiceInterface;
use yii\db\Exception as DatabaseException;
use Yii;
use yii\db\Query;

/**
 * This is the jwt service for mySql
 *  database structure
 *    * oauth2:jwt:<jid> : hash (Jwt)
 *
 * @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 JwtService extends BaseService implements JwtServiceInterface
{
    /**
     * @var string sql jwts table
     */
    public $jwtsTable = null;

    /**
     * Save Jwt
     * @param JwtModelInterface $jwt
     * @param null|array $attributes attributes to save
     * @return bool
     * @throws DatabaseException
     * @throws DuplicateIndexException
     * @throws DuplicateKeyException
     * @since 1.0.0
     */
    protected function insert(JwtModelInterface $jwt, $attributes)
    {
        $result = false;
        if (!$jwt->beforeSave(true)) {
            return $result;
        }
        $entity = (new Query())
            ->select('*')
            ->from($this->jwtsTable)
            ->where('id = :id', [':id' => $jwt->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 "' . $jwt->id . '"');
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

        $jwtParameters = [];
        $this->setAttributesDefinitions($jwt->attributesDefinition());
        foreach ($values as $key => $value) {
            if ($value !== null) {
                $jwtParameters[$key] = $this->convertToDatabase($key, $value);
            }
        }
        $jwtParameters['dateCreated'] = date('Y-m-d H:i:s');
        $jwtParameters['dateUpdated'] = date('Y-m-d H:i:s');
        try {
            $this->db->createCommand()
                ->insert($this->jwtsTable, $jwtParameters)
                ->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);
        $jwt->setOldAttributes($values);
        $jwt->afterSave(true, $changedAttributes);
        $result = true;
        return $result;
    }

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

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

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

        $jwtParameters = [];
        $this->setAttributesDefinitions($jwt->attributesDefinition());
        foreach ($values as $key => $value) {
            $jwtParameters[$key] = ($value !== null) ? $this->convertToDatabase($key, $value) : null;
        }
        $jwtParameters['dateUpdated'] = date('Y-m-d H:i:s');
        try {
            if (array_key_exists($modelKey, $values) === true) {
                $oldJwtKey = $jwt->getOldKey();
                $this->db->createCommand()
                    ->update($this->jwtsTable, $jwtParameters, 'id = :id', [':id' => $oldJwtKey])
                    ->execute();
            } else {
                $this->db->createCommand()
                    ->update($this->jwtsTable, $jwtParameters, 'id = :id', [':id' => $jwtKey])
                    ->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 = $jwt->getOldAttributes();
            $changedAttributes[$name] = isset($oldAttributes[$name]) ? $oldAttributes[$name] : null;
            $jwt->setOldAttribute($name, $value);
        }
        $jwt->afterSave(false, $changedAttributes);
        return true;
    }

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

    /**
     * @inheritdoc
     */
    public function findOne($key)
    {
        $record = null;
        $jwtData = (new Query())
            ->select('*')
            ->from($this->jwtsTable)
            ->where('id = :id', [':id' => $key])
            ->one($this->db);
        if ($jwtData !== false) {
            $record = Yii::createObject('sweelix\oauth2\server\interfaces\JwtModelInterface');
            /** @var JwtModelInterface $record */
            $properties = $record->attributesDefinition();
            $this->setAttributesDefinitions($properties);
            $attributes = [];
            foreach ($jwtData as $key => $value) {
                if (isset($properties[$key]) === true) {
                    $jwtData[$key] = $this->convertToModel($key, $value);
                    $record->setAttribute($key, $jwtData[$key]);
                    $attributes[$key] = $jwtData[$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(JwtModelInterface $jwt)
    {
        $result = false;
        if ($jwt->beforeDelete()) {
            //TODO: check results to return correct information
            $this->db->createCommand()
                ->delete($this->jwtsTable, 'id = :id', [':id' => $jwt->getKey()])
                ->execute();
            $jwt->setIsNewRecord(true);
            $jwt->afterDelete();
            $result = true;
        }
        return $result;
    }
}

JwtService::delete() A
last analyzed 2018-11-06 00:45 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* JwtService.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\JwtModelInterface;
20			use sweelix\oauth2\server\interfaces\JwtServiceInterface;
21			use yii\db\Exception as DatabaseException;
22			use Yii;
23			use yii\db\Query;
24
25			/**
26			* This is the jwt service for mySql
27			* database structure
28			* * oauth2:jwt:<jid> : hash (Jwt)
29			*
30			* @author Philippe Gaultier <[email protected]>
31			* @copyright 2010-2017 Philippe Gaultier
32			* @license http://www.sweelix.net/license license
33			* @version 1.2.0
34			* @link http://www.sweelix.net
35			* @package sweelix\oauth2\server\services\mySql
36			* @since 1.0.0
37			*/
38			class JwtService extends BaseService implements JwtServiceInterface
39			{
40			/**
41			* @var string sql jwts table
42			*/
43			public $jwtsTable = null;
44
45			/**
46			* Save Jwt
47			* @param JwtModelInterface $jwt
48			* @param null\|array $attributes attributes to save
49			* @return bool
50			* @throws DatabaseException
51			* @throws DuplicateIndexException
52			* @throws DuplicateKeyException
53			* @since 1.0.0
54			*/
55			protected function insert(JwtModelInterface $jwt, $attributes)
56			{
57			$result = false;
58			if (!$jwt->beforeSave(true)) {
59			return $result;
60			}
61			$entity = (new Query())
62			->select('*')
63			->from($this->jwtsTable)
64			->where('id = :id', [':id' => $jwt->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\interfaces\JwtModelInterface` 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...
65			->one($this->db);
66			if ($entity !== false) {
67			throw new DuplicateKeyException('Duplicate key "' . $jwt->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\interfaces\JwtModelInterface` 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...
68			}
69			$values = $jwt->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 55 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...
70			$jwtParameters = [];
71			$this->setAttributesDefinitions($jwt->attributesDefinition());
72			foreach ($values as $key => $value) {
73			if ($value !== null) {
74			$jwtParameters[$key] = $this->convertToDatabase($key, $value);
75			}
76			}
77			$jwtParameters['dateCreated'] = date('Y-m-d H:i:s');
78			$jwtParameters['dateUpdated'] = date('Y-m-d H:i:s');
79			try {
80			$this->db->createCommand()
81			->insert($this->jwtsTable, $jwtParameters)
82			->execute();
83			} catch (DatabaseException $e) {
84			// @codeCoverageIgnoreStart
85			// we have a MYSQL exception, we should not discard
86			Yii::debug('Error while inserting entity', __METHOD__);
87			throw $e;
88			// @codeCoverageIgnoreEnd
89			}
90			$changedAttributes = array_fill_keys(array_keys($values), null);
91			$jwt->setOldAttributes($values);
92			$jwt->afterSave(true, $changedAttributes);
93			$result = true;
94			return $result;
95			}
96
97			/**
98			* Update Jwt
99			* @param JwtModelInterface $jwt
100			* @param null\|array $attributes attributes to save
101			* @return bool
102			* @throws DatabaseException
103			* @throws DuplicateIndexException
104			* @throws DuplicateKeyException
105			*/
106			protected function update(JwtModelInterface $jwt, $attributes)
107			{
108			if (!$jwt->beforeSave(false)) {
109			return false;
110			}
111
112			$values = $jwt->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 106 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...
113			$modelKey = $jwt->key();
114			if (isset($values[$modelKey]) === true) {
115			$entity = (new Query())
116			->select('*')
117			->from($this->jwtsTable)
118			->where('id = :id', [':id' => $values[$modelKey]])
119			->one($this->db);
120			if ($entity !== false) {
121			throw new DuplicateKeyException('Duplicate key "' . $values[$modelKey] . '"');
122			}
123			}
124			$jwtKey = isset($values[$modelKey]) ? $values[$modelKey] : $jwt->getKey();
125
126			$jwtParameters = [];
127			$this->setAttributesDefinitions($jwt->attributesDefinition());
128			foreach ($values as $key => $value) {
129			$jwtParameters[$key] = ($value !== null) ? $this->convertToDatabase($key, $value) : null;
130			}
131			$jwtParameters['dateUpdated'] = date('Y-m-d H:i:s');
132			try {
133			if (array_key_exists($modelKey, $values) === true) {
134			$oldJwtKey = $jwt->getOldKey();
135			$this->db->createCommand()
136			->update($this->jwtsTable, $jwtParameters, 'id = :id', [':id' => $oldJwtKey])
137			->execute();
138			} else {
139			$this->db->createCommand()
140			->update($this->jwtsTable, $jwtParameters, 'id = :id', [':id' => $jwtKey])
141			->execute();
142			}
143			} catch (DatabaseException $e) {
144			// @codeCoverageIgnoreStart
145			// we have a MYSQL exception, we should not discard
146			Yii::debug('Error while updating entity', __METHOD__);
147			throw $e;
148			// @codeCoverageIgnoreEnd
149			}
150
151			$changedAttributes = [];
152			foreach ($values as $name => $value) {
153			$oldAttributes = $jwt->getOldAttributes();
154			$changedAttributes[$name] = isset($oldAttributes[$name]) ? $oldAttributes[$name] : null;
155			$jwt->setOldAttribute($name, $value);
156			}
157			$jwt->afterSave(false, $changedAttributes);
158			return true;
159			}
160
161			/**
162			* @inheritdoc
163			*/
164			public function save(JwtModelInterface $jwt, $attributes)
165			{
166			if ($jwt->getIsNewRecord()) {
167			$result = $this->insert($jwt, $attributes);
168			} else {
169			$result = $this->update($jwt, $attributes);
170			}
171			return $result;
172			}
173
174			/**
175			* @inheritdoc
176			*/
177			public function findOne($key)
178			{
179			$record = null;
180			$jwtData = (new Query())
181			->select('*')
182			->from($this->jwtsTable)
183			->where('id = :id', [':id' => $key])
184			->one($this->db);
185			if ($jwtData !== false) {
186			$record = Yii::createObject('sweelix\oauth2\server\interfaces\JwtModelInterface');
187			/** @var JwtModelInterface $record */
188			$properties = $record->attributesDefinition();
189			$this->setAttributesDefinitions($properties);
190			$attributes = [];
191			foreach ($jwtData as $key => $value) {
192			if (isset($properties[$key]) === true) {
193			$jwtData[$key] = $this->convertToModel($key, $value);
194			$record->setAttribute($key, $jwtData[$key]);
195			$attributes[$key] = $jwtData[$key];
196			// @codeCoverageIgnoreStart
197			} elseif ($record->canSetProperty($key)) {
198			// TODO: find a way to test attribute population
199			$record->{$key} = $value;
200			}
201			// @codeCoverageIgnoreEnd
202			}
203			if (empty($attributes) === false) {
204			$record->setOldAttributes($attributes);
205			}
206			$record->afterFind();
207			}
208			return $record;
209			}
210
211			/**
212			* @inheritdoc
213			*/
214			public function delete(JwtModelInterface $jwt)
215			{
216			$result = false;
217			if ($jwt->beforeDelete()) {
218			//TODO: check results to return correct information
219			$this->db->createCommand()
220			->delete($this->jwtsTable, 'id = :id', [':id' => $jwt->getKey()])
221			->execute();
222			$jwt->setIsNewRecord(true);
223			$jwt->afterDelete();
224			$result = true;
225			}
226			return $result;
227			}
228			}

pgaultier / yii2-oauth2

JwtService::delete() A last analyzed 2018-11-06 00:45 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

JwtService::delete() A
last analyzed 2018-11-06 00:45 UTC