ModelById::getRecordById() - Code Metrics - Inspection of "Optimizing model to record methods" - flipbox/spark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7be59a...6fea24 )

by Nate

created 2017-05-17 21:24 UTC

ModelById::getRecordById() A

↳ Parent: ModelById

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
nc	2
cc	2
eloc	4
nop	2

<?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	View Code Duplication	public function findById(int $id, string $toScenario = null)
		0 ignored issues – show Duplication introduced 2017-03-27 23:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
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 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
63		// Find record in db
64		if ($record = $this->findRecordById($id)) {
65
66		$model = $this->findByRecord($record, $toScenario);
67
68		} else {
69
70		$this->_cacheById[$id] = null;
71
72		return null;
73
74		}
75
76		}
77
78		return $model;
79
80		}
81
82		/**
83		* @param int $id
84		* @param string\|null $toScenario
85		* @return ModelWithId\|null
86		* @throws ModelNotFoundException
87		*/
88	View Code Duplication	public function getById(int $id, string $toScenario = null): ModelWithId
89		{
90
91		if (!$model = $this->findById($id, $toScenario)) {
92
93		$this->notFoundByIdException($id);
94
95		}
96
97		return $model;
98
99		}
100
101		/**
102		* @param int $id
103		* @param string\|null $toScenario
104		* @return ModelWithId\|null
105		*/
106		public function freshFindById(int $id, string $toScenario = null)
107		{
108
109		// Find record in db
110		if (!$record = $this->findRecordById($id)) {
111		return null;
112		}
113
114		$model = $this->create($record, $toScenario);
		0 ignored issues – show Documentation introduced 2017-05-16 20:38 UTC by Report Bug Copy Issue Report `$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...
115
116		return $model;
117
118		}
119
120		/**
121		* @param int $id
122		* @param string\|null $toScenario
123		* @return ModelWithId
124		* @throws ModelNotFoundException
125		*/
126	View Code Duplication	public function freshGetById(int $id, string $toScenario = null): ModelWithId
127		{
128
129		if (!$model = $this->freshFindById($id, $toScenario)) {
130
131		$this->notFoundByIdException($id);
132
133		}
134
135		return $model;
136
137		}
138
139		/*******************************************
140		* CACHE
141		*******************************************/
142
143		/**
144		* Find an existing cache by id
145		*
146		* @param int $id
147		* @return null
148		*/
149		public function findCacheById(int $id)
150		{
151
152		// Check if already in cache
153		if (!$this->isCachedById($id)) {
154		return null;
155		}
156
157		return $this->_cacheById[$id];
158
159		}
160
161		/**
162		* Identify whether in cache by id
163		*
164		* @param int $id
165		* @return bool
166		*/
167		private function isCachedById(int $id): bool
168		{
169		return array_key_exists($id, $this->_cacheById);
170		}
171
172
173		/**
174		* @param ModelWithId $model
175		* @return static
176		*/
177		protected function cacheById(ModelWithId $model)
178		{
179
180		if (null === $model->getId()) {
181		return $this;
182		}
183
184		// Check if already in cache
185		if (!$this->isCachedById($model->getId())) {
186
187		// Cache it
188		$this->_cacheById[$model->getId()] = $model;
189
190		}
191
192		return $this;
193
194		}
195
196		/**
197		* @param RecordWithId $record
198		* @return ModelWithId\|null
199		*/
200		protected function findCacheByRecordById(RecordWithId $record)
201		{
202
203		$value = $record->id;
204
205		if ($value === null) {
206		return null;
207		}
208
209		return $this->findCacheById($value);
210
211		}
212
213		/*******************************************
214		* RECORD BY ID
215		*******************************************/
216
217		/**
218		* @param int $id
219		* @param string\|null $toScenario
220		* @return RecordWithId\|null
221		*/
222		public function findRecordById(int $id, string $toScenario = null)
223		{
224
225		return $this->findRecordByCondition(
226		[
227		'id' => $id
228		],
229		$toScenario
230		);
231
232		}
233
234		/**
235		* @param int $id
236		* @param string\|null $toScenario
237		* @return Record\|RecordWithId\|null
238		*/
239		public function getRecordById(int $id, string $toScenario = null): Record
240		{
241
242		if (!$record = $this->findRecordById($id, $toScenario)) {
243
244		$this->notFoundRecordByIdException($id);
245
246		}
247
248		return $record;
249
250		}
251
252
253		/*******************************************
254		* EXCEPTIONS
255		*******************************************/
256
257		/**
258		* @param int\|null $id
259		* @throws ModelNotFoundException
260		*/
261		protected function notFoundByIdException(int $id = null)
262		{
263
264		throw new ModelNotFoundException(
265		sprintf(
266		'Model does not exist with the id "%s".',
267		(string)$id
268		)
269		);
270
271		}
272
273		/**
274		* @param int\|null $id
275		* @throws RecordNotFoundException
276		*/
277		protected function notFoundRecordByIdException(int $id = null)
278		{
279
280		throw new RecordNotFoundException(
281		sprintf(
282		'Record does not exist with the id "%s".',
283		(string)$id
284		)
285		);
286
287		}
288
289		}
290

flipbox / spark

Push — master ( 7be59a...6fea24 )

ModelById::getRecordById() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like