ElementAccessor::find() - Code Metrics - Inspection of "refactoring to v2.0.0" - flipbox/spark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 39c748...16551a )

by Nate

created 2017-03-27 23:30 UTC

ElementAccessor::find() B

↳ Parent: ElementAccessor

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	11

Duplication

Lines	24
Ratio	100 %

Importance

Changes

Metric	Value
dl	24
loc	24
rs	8.6845
c	0
b	0
f	0
cc	4
eloc	11
nc	4
nop	2

<?php

/**
 * @package    Spark
 * @author     Flipbox Factory <[email protected]>
 * @copyright  2010-2016 Flipbox Digital Limited
 * @license    https://github.com/FlipboxFactory/Craft3-Spark/blob/master/LICENSE
 * @link       https://github.com/FlipboxFactory/Craft3-Spark
 * @since      Class available since Release 1.1.0
 */

namespace flipbox\spark\services;

use Craft;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\elements\db\ElementQueryInterface;
use flipbox\spark\exceptions\ElementNotFoundException;
use flipbox\spark\helpers\ElementHelper;
use flipbox\spark\helpers\QueryHelper;
use flipbox\spark\helpers\SiteHelper;
use yii\base\Component as BaseComponent;

abstract class ElementAccessor extends BaseComponent
{

    /**
     * @var [ElementInterface[]]
     */
    protected $_cacheById = [];

    /*******************************************
     * ELEMENT CLASSES
     *******************************************/

    /**
     * @return string
     */
    public abstract static function elementClass(): string;


    /**
     * The element instance that this class interacts with
     *
     * @return string
     */
    public static function elementClassInstance(): string
    {
        return ElementInterface::class;
    }

    /*******************************************
     * CREATE
     *******************************************/

    /**
     * @param array $config
     * @return Element|ElementInterface
     */
    public function create(array $config = [])
    {

        // Set the class the element should be
        $config['class'] = static::elementClass();

        // Create new model
        return ElementHelper::create(
            $config,
            static::elementClassInstance()
        );

    }


    /**
     * @param $identifier
     * @param int|null $siteId
     * @return Element|ElementInterface|null
     */
    public function find($identifier, int $siteId = null)

    {

        if ($identifier instanceof ElementInterface) {

            $this->addToCache($identifier);

            return $identifier;

        } elseif (is_numeric($identifier)) {

            return $this->findById($identifier, $siteId);

        } elseif (is_array($identifier)) {

            return $this->getQuery($identifier)
                ->siteId($siteId)
                ->one();

        }

        return null;

    }

    /**
     * @param int $id
     * @param int|null $siteId
     * @return Element|ElementInterface|null
     */
    public function findById(int $id, int $siteId = null)
    {

        // Check cache
        if (!$element = $this->findCacheById($id, $siteId)) {

            // Find new element
            if ($element = $this->freshFindById($id, $siteId)) {

                // Cache it
                $this->addToCache($element);

            } else {

                // Cache nothing
                $this->_cacheById[$id] = $element;

            }

        }

        return $element;

    }

    /*******************************************
     * GET
     *******************************************/

    /**
     * @param $identifier
     * @param int|null $siteId
     * @return Element|ElementInterface
     * @throws ElementNotFoundException
     */
    public function get($identifier, int $siteId = null)
    {

        // Find
        if (!$elemeny = $this->find($identifier, $siteId)) {

            $this->notFoundException();

        }

        return $elemeny;

    }

    /**
     * @param int $id
     * @param int|null $siteId
     * @return Element|ElementInterface
     * @throws ElementNotFoundException
     */
    public function getById(int $id, int $siteId = null)
    {

        // Find by ID
        if (!$element = $this->findById($id, $siteId)) {

            $this->notFoundByIdException($id);

        }

        return $element;

    }

    /*******************************************
     * FRESH FIND
     *******************************************/

    /**
     * @param int $id
     * @param int|null $siteId
     * @return Element|ElementInterface|null
     */
    public function freshFindById(int $id, int $siteId = null)
    {
        return Craft::$app->getElements()->getElementById($id, static::elementClass(), $siteId);
    }

    /**
     * @param $id
     * @param int|null $siteId
     * @return Element|ElementInterface
     * @throws ElementNotFoundException
     */
    public function freshGetById($id, int $siteId = null)
    {

        if (!$element = $this->freshFindById($id, $siteId)) {

            $this->notFoundByIdException($id);

        }

        return $element;

    }


    /*******************************************
     * QUERY
     *******************************************/

    /**
     * Get query
     *
     * @param $criteria
     * @return ElementQueryInterface
     */
    public function getQuery($criteria = [])
    {

        /** @var Element $elementClass */
        $elementClass = static::elementClass();

        /** @var ElementQueryInterface $query */
        $query = $elementClass::find();

        // Configure it
        QueryHelper::configure(
            $query,
            $criteria
        );

        return $query;

    }

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

    /**
     * @param $identifier
     * @param int|null $siteId
     * @return Element|ElementInterface|null
     */
    public function findCache($identifier, int $siteId = null)
    {

        if (is_numeric($identifier)) {

            return $this->findCacheById($identifier, $siteId);

        }

        return null;

    }

    /**
     * @param ElementInterface $element
     * @return $this
     */
    public function addToCache(ElementInterface $element)
    {

        $this->cacheById($element);

        return $this;

    }

    /**
     * Find an existing cache by ID
     *
     * @param int $id
     * @param int|null $siteId
     * @return Element|ElementInterface|null
     */
    public function findCacheById(int $id, int $siteId = null)
    {

        // Resolve siteId
        $siteId = SiteHelper::resolveSiteId($siteId);

        // Check if already in addToCache
        if ($this->isCachedById($id, $siteId)) {

            return $this->_cacheById[$siteId][$id];

        }

        return null;

    }

    /**
     * Identify whether in cached by ID
     *
     * @param int $id
     * @param int|null $siteId
     * @return bool
     */
    protected function isCachedById(int $id, int $siteId = null)

    {
        // Resolve siteId
        $siteId = SiteHelper::resolveSiteId($siteId);

        if (!isset($this->_cacheById[$siteId])) {
            $this->_cacheById[$siteId] = [];
        }

        return array_key_exists($id, $this->_cacheById[$siteId]);
    }

    /**
     * @param ElementInterface $element
     * @return $this
     */
    protected function cacheById(ElementInterface $element)
    {

        /** @var Element $element */

        $id = $element->id;

        $siteId = $element->siteId;

        // Check if already in cache
        if (!$this->isCachedById($id, $siteId)) {

            // Cache it
            $this->_cacheById[$siteId][$id] = $element;

        }

        return $this;

    }

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

    /**
     * @throws ElementNotFoundException
     */
    protected function notFoundException()
    {

        throw new ElementNotFoundException(
            sprintf(
                "Element does not exist."
            )
        );

    }

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

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

    }

}


1		<?php
2
3		/**
4		* @package Spark
5		* @author Flipbox Factory <[email protected]>
6		* @copyright 2010-2016 Flipbox Digital Limited
7		* @license https://github.com/FlipboxFactory/Craft3-Spark/blob/master/LICENSE
8		* @link https://github.com/FlipboxFactory/Craft3-Spark
9		* @since Class available since Release 1.1.0
10		*/
11
12		namespace flipbox\spark\services;
13
14		use Craft;
15		use craft\base\Element;
16		use craft\base\ElementInterface;
17		use craft\elements\db\ElementQueryInterface;
18		use flipbox\spark\exceptions\ElementNotFoundException;
19		use flipbox\spark\helpers\ElementHelper;
20		use flipbox\spark\helpers\QueryHelper;
21		use flipbox\spark\helpers\SiteHelper;
22		use yii\base\Component as BaseComponent;
23
24		abstract class ElementAccessor extends BaseComponent
25		{
26
27		/**
28		* @var [ElementInterface[]]
29		*/
30		protected $_cacheById = [];
31
32		/*******************************************
33		* ELEMENT CLASSES
34		*******************************************/
35
36		/**
37		* @return string
38		*/
39		public abstract static function elementClass(): string;
		0 ignored issues – show Coding Style introduced 2017-03-27 23:36 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
40
41		/**
42		* The element instance that this class interacts with
43		*
44		* @return string
45		*/
46		public static function elementClassInstance(): string
47		{
48		return ElementInterface::class;
49		}
50
51		/*******************************************
52		* CREATE
53		*******************************************/
54
55		/**
56		* @param array $config
57		* @return Element\|ElementInterface
58		*/
59		public function create(array $config = [])
60		{
61
62		// Set the class the element should be
63		$config['class'] = static::elementClass();
64
65		// Create new model
66		return ElementHelper::create(
67		$config,
68		static::elementClassInstance()
69		);
70
71		}
72
73
74		/**
75		* @param $identifier
76		* @param int\|null $siteId
77		* @return Element\|ElementInterface\|null
78		*/
79	View Code Duplication	public function find($identifier, int $siteId = null)
		1 ignored issue – 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...
80		{
81
82		if ($identifier instanceof ElementInterface) {
83
84		$this->addToCache($identifier);
85
86		return $identifier;
87
88		} elseif (is_numeric($identifier)) {
89
90		return $this->findById($identifier, $siteId);
91
92		} elseif (is_array($identifier)) {
93
94		return $this->getQuery($identifier)
95		->siteId($siteId)
96		->one();
97
98		}
99
100		return null;
101
102		}
103
104		/**
105		* @param int $id
106		* @param int\|null $siteId
107		* @return Element\|ElementInterface\|null
108		*/
109		public function findById(int $id, int $siteId = null)
110		{
111
112		// Check cache
113		if (!$element = $this->findCacheById($id, $siteId)) {
114
115		// Find new element
116		if ($element = $this->freshFindById($id, $siteId)) {
117
118		// Cache it
119		$this->addToCache($element);
120
121		} else {
122
123		// Cache nothing
124		$this->_cacheById[$id] = $element;
125
126		}
127
128		}
129
130		return $element;
131
132		}
133
134		/*******************************************
135		* GET
136		*******************************************/
137
138		/**
139		* @param $identifier
140		* @param int\|null $siteId
141		* @return Element\|ElementInterface
142		* @throws ElementNotFoundException
143		*/
144		public function get($identifier, int $siteId = null)
145		{
146
147		// Find
148		if (!$elemeny = $this->find($identifier, $siteId)) {
149
150		$this->notFoundException();
151
152		}
153
154		return $elemeny;
155
156		}
157
158		/**
159		* @param int $id
160		* @param int\|null $siteId
161		* @return Element\|ElementInterface
162		* @throws ElementNotFoundException
163		*/
164		public function getById(int $id, int $siteId = null)
165		{
166
167		// Find by ID
168		if (!$element = $this->findById($id, $siteId)) {
169
170		$this->notFoundByIdException($id);
171
172		}
173
174		return $element;
175
176		}
177
178		/*******************************************
179		* FRESH FIND
180		*******************************************/
181
182		/**
183		* @param int $id
184		* @param int\|null $siteId
185		* @return Element\|ElementInterface\|null
186		*/
187		public function freshFindById(int $id, int $siteId = null)
188		{
189		return Craft::$app->getElements()->getElementById($id, static::elementClass(), $siteId);
190		}
191
192		/**
193		* @param $id
194		* @param int\|null $siteId
195		* @return Element\|ElementInterface
196		* @throws ElementNotFoundException
197		*/
198		public function freshGetById($id, int $siteId = null)
199		{
200
201		if (!$element = $this->freshFindById($id, $siteId)) {
202
203		$this->notFoundByIdException($id);
204
205		}
206
207		return $element;
208
209		}
210
211
212		/*******************************************
213		* QUERY
214		*******************************************/
215
216		/**
217		* Get query
218		*
219		* @param $criteria
220		* @return ElementQueryInterface
221		*/
222		public function getQuery($criteria = [])
223		{
224
225		/** @var Element $elementClass */
226		$elementClass = static::elementClass();
227
228		/** @var ElementQueryInterface $query */
229		$query = $elementClass::find();
230
231		// Configure it
232		QueryHelper::configure(
233		$query,
234		$criteria
235		);
236
237		return $query;
238
239		}
240
241		/*******************************************
242		* CACHE
243		*******************************************/
244
245		/**
246		* @param $identifier
247		* @param int\|null $siteId
248		* @return Element\|ElementInterface\|null
249		*/
250		public function findCache($identifier, int $siteId = null)
251		{
252
253		if (is_numeric($identifier)) {
254
255		return $this->findCacheById($identifier, $siteId);
256
257		}
258
259		return null;
260
261		}
262
263		/**
264		* @param ElementInterface $element
265		* @return $this
266		*/
267		public function addToCache(ElementInterface $element)
268		{
269
270		$this->cacheById($element);
271
272		return $this;
273
274		}
275
276		/**
277		* Find an existing cache by ID
278		*
279		* @param int $id
280		* @param int\|null $siteId
281		* @return Element\|ElementInterface\|null
282		*/
283		public function findCacheById(int $id, int $siteId = null)
284		{
285
286		// Resolve siteId
287		$siteId = SiteHelper::resolveSiteId($siteId);
288
289		// Check if already in addToCache
290		if ($this->isCachedById($id, $siteId)) {
291
292		return $this->_cacheById[$siteId][$id];
293
294		}
295
296		return null;
297
298		}
299
300		/**
301		* Identify whether in cached by ID
302		*
303		* @param int $id
304		* @param int\|null $siteId
305		* @return bool
306		*/
307	View Code Duplication	protected function isCachedById(int $id, int $siteId = 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...
308		{
309		// Resolve siteId
310		$siteId = SiteHelper::resolveSiteId($siteId);
311
312		if (!isset($this->_cacheById[$siteId])) {
313		$this->_cacheById[$siteId] = [];
314		}
315
316		return array_key_exists($id, $this->_cacheById[$siteId]);
317		}
318
319		/**
320		* @param ElementInterface $element
321		* @return $this
322		*/
323		protected function cacheById(ElementInterface $element)
324		{
325
326		/** @var Element $element */
327
328		$id = $element->id;
329
330		$siteId = $element->siteId;
331
332		// Check if already in cache
333		if (!$this->isCachedById($id, $siteId)) {
334
335		// Cache it
336		$this->_cacheById[$siteId][$id] = $element;
337
338		}
339
340		return $this;
341
342		}
343
344		/*******************************************
345		* EXCEPTIONS
346		*******************************************/
347
348		/**
349		* @throws ElementNotFoundException
350		*/
351		protected function notFoundException()
352		{
353
354		throw new ElementNotFoundException(
355		sprintf(
356		"Element does not exist."
357		)
358		);
359
360		}
361
362		/**
363		* @param int\|null $id
364		* @throws ElementNotFoundException
365		*/
366		protected function notFoundByIdException(int $id = null)
367		{
368
369		throw new ElementNotFoundException(
370		sprintf(
371		'Element does not exist with the id "%s".',
372		(string)$id
373		)
374		);
375
376		}
377
378		}
379

flipbox / spark

Push — master ( 39c748...16551a )

ElementAccessor::find() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like