Issues in ModelById.php (master) - Issues in master - flipbox/spark - Measure and Improve Code Quality continuously with Scrutinizer

Issues (38)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/services/traits/ModelById.php (2 issues)

Labels

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipbox/spark/blob/master/LICENSE
 * @link       https://github.com/flipbox/spark
 */

namespace flipbox\spark\services\traits;

use flipbox\spark\exceptions\ModelNotFoundException;
use flipbox\spark\exceptions\RecordNotFoundException;
use flipbox\spark\models\Model as BaseModel;
use flipbox\spark\models\ModelWithId;
use flipbox\spark\records\Record;
use flipbox\spark\records\RecordWithId;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 2.0.0
 *
 * @method RecordWithId|null findRecordByCondition($condition, string $toScenario = null)
 */
trait ModelById
{

    use Model;

    /**
     * @var ModelWithId[]
     */
    protected $cacheById = [];

    /**
     * @param Record $record
     * @param string|null $toScenario
     * @return BaseModel|ModelWithId
     */
    abstract protected function findByRecord(Record $record, string $toScenario = null): BaseModel;

    /**
     * @param array $config
     * @param string|null $toScenario
     * @return BaseModel|ModelWithId
     */
    abstract public function create($config = [], string $toScenario = null): BaseModel;

    /*******************************************
     * FIND/GET BY ID
     *******************************************/

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return ModelWithId|null
     */
    public function findById(int $id, string $toScenario = null)
    {

        // Check cache
        if (!$model = $this->findCacheById($id)) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            // Find record in db
            if ($record = $this->findRecordById($id)) {
                $model = $this->findByRecord($record, $toScenario);
            } else {
                $this->cacheById[$id] = null;

                return null;
            }
        }

        return $model;
    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return ModelWithId|null
     * @throws ModelNotFoundException
     */
    public function getById(int $id, string $toScenario = null): ModelWithId
    {

        if (!$model = $this->findById($id, $toScenario)) {
            $this->notFoundByIdException($id);
        }

        return $model;
    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return ModelWithId|null
     */
    public function freshFindById(int $id, string $toScenario = null)
    {

        // Find record in db
        if (!$record = $this->findRecordById($id)) {
            return null;
        }

        $model = $this->create($record, $toScenario);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $model;
    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return ModelWithId
     * @throws ModelNotFoundException
     */
    public function freshGetById(int $id, string $toScenario = null): ModelWithId
    {

        if (!$model = $this->freshFindById($id, $toScenario)) {
            $this->notFoundByIdException($id);
        }

        return $model;
    }

    /*******************************************
     * CACHE
     *******************************************/

    /**
     * Find an existing cache by id
     *
     * @param int $id
     * @return null
     */
    public function findCacheById(int $id)
    {

        // Check if already in cache
        if (!$this->isCachedById($id)) {
            return null;
        }

        return $this->cacheById[$id];
    }

    /**
     * Identify whether in cache by id
     *
     * @param int $id
     * @return bool
     */
    private function isCachedById(int $id): bool
    {
        return array_key_exists($id, $this->cacheById);
    }


    /**
     * @param ModelWithId $model
     * @return static
     */
    protected function cacheById(ModelWithId $model)
    {

        if (null === $model->getId()) {
            return $this;
        }

        // Check if already in cache
        if (!$this->isCachedById($model->getId())) {
            // Cache it
            $this->cacheById[$model->getId()] = $model;
        }

        return $this;
    }

    /**
     * @param RecordWithId $record
     * @return ModelWithId|null
     */
    protected function findCacheByRecordById(RecordWithId $record)
    {

        $value = $record->id;

        if ($value === null) {
            return null;
        }

        return $this->findCacheById($value);
    }

    /*******************************************
     * RECORD BY ID
     *******************************************/

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return RecordWithId|null
     */
    public function findRecordById(int $id, string $toScenario = null)
    {

        return $this->findRecordByCondition(
            [
                'id' => $id
            ],
            $toScenario
        );
    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return Record|RecordWithId|null
     */
    public function getRecordById(int $id, string $toScenario = null): Record
    {

        if (!$record = $this->findRecordById($id, $toScenario)) {
            $this->notFoundRecordByIdException($id);
        }

        return $record;
    }


    /*******************************************
     * EXCEPTIONS
     *******************************************/

    /**
     * @param int|null $id
     * @throws ModelNotFoundException
     */
    protected function notFoundByIdException(int $id = null)
    {

        throw new ModelNotFoundException(
            sprintf(
                'Model does not exist with the id "%s".',
                (string)$id
            )
        );
    }

    /**
     * @param int|null $id
     * @throws RecordNotFoundException
     */
    protected function notFoundRecordByIdException(int $id = null)
    {

        throw new RecordNotFoundException(
            sprintf(
                'Record does not exist with the id "%s".',
                (string)$id
            )
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://github.com/flipbox/spark/blob/master/LICENSE
6			* @link https://github.com/flipbox/spark
7			*/
8
9			namespace flipbox\spark\services\traits;
10
11			use flipbox\spark\exceptions\ModelNotFoundException;
12			use flipbox\spark\exceptions\RecordNotFoundException;
13			use flipbox\spark\models\Model as BaseModel;
14			use flipbox\spark\models\ModelWithId;
15			use flipbox\spark\records\Record;
16			use flipbox\spark\records\RecordWithId;
17
18			/**
19			* @author Flipbox Factory <[email protected]>
20			* @since 2.0.0
21			*
22			* @method RecordWithId\|null findRecordByCondition($condition, string $toScenario = null)
23			*/
24			trait ModelById
25			{
26
27			use Model;
28
29			/**
30			* @var ModelWithId[]
31			*/
32			protected $cacheById = [];
33
34			/**
35			* @param Record $record
36			* @param string\|null $toScenario
37			* @return BaseModel\|ModelWithId
38			*/
39			abstract protected function findByRecord(Record $record, string $toScenario = null): BaseModel;
40
41			/**
42			* @param array $config
43			* @param string\|null $toScenario
44			* @return BaseModel\|ModelWithId
45			*/
46			abstract public function create($config = [], string $toScenario = null): BaseModel;
47
48			/*******************************************
49			* FIND/GET BY ID
50			*******************************************/
51
52			/**
53			* @param int $id
54			* @param string\|null $toScenario
55			* @return ModelWithId\|null
56			*/
57			public function findById(int $id, string $toScenario = null)
58			{
59
60			// Check cache
61			if (!$model = $this->findCacheById($id)) {
			0 ignored issues – show Bug introduced 2017-05-16 20:38 UTC by Report Bug Copy Issue Report Show Similar Issues like this Are you sure the assignment to `$model` is correct as `$this->findCacheById($id)` (which targets `flipbox\spark\services\t...elById::findCacheById()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
62			// Find record in db
63			if ($record = $this->findRecordById($id)) {
64			$model = $this->findByRecord($record, $toScenario);
65			} else {
66			$this->cacheById[$id] = null;
67
68			return null;
69			}
70			}
71
72			return $model;
73			}
74
75			/**
76			* @param int $id
77			* @param string\|null $toScenario
78			* @return ModelWithId\|null
79			* @throws ModelNotFoundException
80			*/
81			public function getById(int $id, string $toScenario = null): ModelWithId
82			{
83
84			if (!$model = $this->findById($id, $toScenario)) {
85			$this->notFoundByIdException($id);
86			}
87
88			return $model;
89			}
90
91			/**
92			* @param int $id
93			* @param string\|null $toScenario
94			* @return ModelWithId\|null
95			*/
96			public function freshFindById(int $id, string $toScenario = null)
97			{
98
99			// Find record in db
100			if (!$record = $this->findRecordById($id)) {
101			return null;
102			}
103
104			$model = $this->create($record, $toScenario);
			0 ignored issues – show Documentation introduced 2017-05-16 20:38 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$record` is of type `object<flipbox\spark\records\RecordWithId>`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
105
106			return $model;
107			}
108
109			/**
110			* @param int $id
111			* @param string\|null $toScenario
112			* @return ModelWithId
113			* @throws ModelNotFoundException
114			*/
115			public function freshGetById(int $id, string $toScenario = null): ModelWithId
116			{
117
118			if (!$model = $this->freshFindById($id, $toScenario)) {
119			$this->notFoundByIdException($id);
120			}
121
122			return $model;
123			}
124
125			/*******************************************
126			* CACHE
127			*******************************************/
128
129			/**
130			* Find an existing cache by id
131			*
132			* @param int $id
133			* @return null
134			*/
135			public function findCacheById(int $id)
136			{
137
138			// Check if already in cache
139			if (!$this->isCachedById($id)) {
140			return null;
141			}
142
143			return $this->cacheById[$id];
144			}
145
146			/**
147			* Identify whether in cache by id
148			*
149			* @param int $id
150			* @return bool
151			*/
152			private function isCachedById(int $id): bool
153			{
154			return array_key_exists($id, $this->cacheById);
155			}
156
157
158			/**
159			* @param ModelWithId $model
160			* @return static
161			*/
162			protected function cacheById(ModelWithId $model)
163			{
164
165			if (null === $model->getId()) {
166			return $this;
167			}
168
169			// Check if already in cache
170			if (!$this->isCachedById($model->getId())) {
171			// Cache it
172			$this->cacheById[$model->getId()] = $model;
173			}
174
175			return $this;
176			}
177
178			/**
179			* @param RecordWithId $record
180			* @return ModelWithId\|null
181			*/
182			protected function findCacheByRecordById(RecordWithId $record)
183			{
184
185			$value = $record->id;
186
187			if ($value === null) {
188			return null;
189			}
190
191			return $this->findCacheById($value);
192			}
193
194			/*******************************************
195			* RECORD BY ID
196			*******************************************/
197
198			/**
199			* @param int $id
200			* @param string\|null $toScenario
201			* @return RecordWithId\|null
202			*/
203			public function findRecordById(int $id, string $toScenario = null)
204			{
205
206			return $this->findRecordByCondition(
207			[
208			'id' => $id
209			],
210			$toScenario
211			);
212			}
213
214			/**
215			* @param int $id
216			* @param string\|null $toScenario
217			* @return Record\|RecordWithId\|null
218			*/
219			public function getRecordById(int $id, string $toScenario = null): Record
220			{
221
222			if (!$record = $this->findRecordById($id, $toScenario)) {
223			$this->notFoundRecordByIdException($id);
224			}
225
226			return $record;
227			}
228
229
230			/*******************************************
231			* EXCEPTIONS
232			*******************************************/
233
234			/**
235			* @param int\|null $id
236			* @throws ModelNotFoundException
237			*/
238			protected function notFoundByIdException(int $id = null)
239			{
240
241			throw new ModelNotFoundException(
242			sprintf(
243			'Model does not exist with the id "%s".',
244			(string)$id
245			)
246			);
247			}
248
249			/**
250			* @param int\|null $id
251			* @throws RecordNotFoundException
252			*/
253			protected function notFoundRecordByIdException(int $id = null)
254			{
255
256			throw new RecordNotFoundException(
257			sprintf(
258			'Record does not exist with the id "%s".',
259			(string)$id
260			)
261			);
262			}
263			}
264

flipbox / spark

Issues (38)

Security Analysis not enabled

src/services/traits/ModelById.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like