SectionLoader::sectionRoutes() - Code Metrics - Inspection of "Merge pull request #2 from locomotivemtl/cms_servi..." - locomotivemtl/charcoal-cms - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( dc68d1...1f5199 )

by Mathieu

created 2017-04-03 15:56 UTC

SectionLoader::sectionRoutes() B

↳ Parent: SectionLoader

Complexity

Conditions	6
Paths	13

Size

Total Lines	57
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	57
rs	8.7433
c	0
b	0
f	0
cc	6
eloc	27
nc	13
nop	0

How to fix Long Method

<?php

namespace Charcoal\Cms\Service\Loader;

use Charcoal\Loader\CollectionLoader;
use Charcoal\Object\ObjectRoute;
use Exception;

use \Charcoal\Translator\TranslatorAwareTrait;
/**
 * Section Loader
 */
class SectionLoader extends AbstractLoader
{
    /**
     * @var array $sectionRoutes The section's routes.
     */
    protected $sectionRoutes;

    /**
     * @var integer $baseSection The id of the base section.
     */
    protected $baseSection;

    /**
     * The cache of snake-cased words.
     *
     * @var array
     */
    protected static $snakeCache = [];

    /**
     * @param integer $id The section's id.
     * @return mixed
     */
    public function fromId($id)
    {
        $proto = $this->modelFactory()->create($this->objType());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $proto->loadFrom('id', $id);
    }

    /**
     * @param string $slug The section's slug.
     * @return mixed
     */
    public function fromSlug($slug)
    {
        $id = $this->resolveSectionId($slug);
        return $this->fromId($id);
    }

    /**
     * @return CollectionLoader
     */
    public function all()

    {
        $proto = $this->modelFactory()->get($this->objType());
        $loader = $this->collectionLoader();
        $loader->setModel($proto);
        $loader->addFilter('active', true);
        $loader->addOrder('position', 'asc');

        return $loader;
    }

    /**
     * @return \ArrayAccess|\Traversable
     */
    public function masters()
    {
        $loader = $this->all();
        $operator = [];
        if (!$this->baseSection()) {
            $operator = [ 'operator' => 'IS NULL' ];
        }
        $loader->addFilter('master', $this->baseSection(), $operator);

        return $loader->load();
    }

    /**
     * @return \ArrayAccess|\Traversable
     */
    public function children()
    {
        $masters = $this->masters();

        $children = [];
        $hasChildren = count($masters) > 0;

        while ($hasChildren) {
            $ids = [];

            foreach ($masters as $master) {
                $ids[] = $master->id();
            }

            $masters = $this->all()
                ->addFilter([
                    'property' => 'master',
                    'val'      => $ids,
                    'operator' => 'IN'
                ])
                ->load();

            $children = array_merge($children, $masters);
            $hasChildren = count($masters) > 0;
        }

        return $children;
    }

    /**
     * Pair routes slug to sections ID
     * @return array
     */
    public function sectionRoutes()
    {
        if ($this->sectionRoutes) {

            return $this->sectionRoutes;
        }

        $proto = $this->modelFactory()->get(ObjectRoute::class);

        $sectionTypes = $this->sectionTypes();
        if (!$sectionTypes) {

            $sectionTypes = [
                'base' => $this->objType()
            ];
        }

        $loader = $this->collectionLoader();
        $loader->setModel($proto);

        $filters = [];
        foreach ($sectionTypes as $key => $val) {
            $filters[] = 'route_obj_type = \''.$val.'\'';
        }
        $q = 'SELECT * FROM `'.$proto->source()->table().'`
            WHERE active=1 AND ( '
            . implode(' OR ', $filters) . ' )
            ORDER BY creation_date ASC';

        $objectRoutes = $loader->loadFromQuery($q);

        // $loader->addFilter('route_obj_type', $this->objType())

        //     // This is important. This is why it all works
        //     // Loading it from the first created to the last created
        //     // makes the following foreach override previous data.
        //     ->addOrder('creation_date', 'asc');


        // $objectRoutes = $loader->load();


        $sections = [];
        $routes = [];
        // The current language
        $lang = $this->translator()->getLocale();
        foreach ($objectRoutes as $o) {
            if ($o->lang() === $lang) {
                // Will automatically override previous slug set
                $sections[$o->routeObjId()] = $o->slug();
            }
            // Keep track of EVERY slug.
            $routes[$o->slug()] = $o->routeObjId();
        }

        $this->sectionRoutes = [
            'sections' => $sections,
            'routes'   => $routes
        ];

        return $this->sectionRoutes;
    }

    /**
     * Resolve latest route from route slug.
     * @param  string $route The route to resolve.
     * @return string
     */
    public function resolveRoute($route)

    {
        $routes = $this->sectionRoutes();
        $sId = $this->resolveSectionId($route);

        if (!isset($routes['sections'][$sId])) {
            return '';
        }

        return $routes['sections'][$sId];
    }

    /**
     * Resolve section ID from route slug.
     * @param  string $route The route to resolve.
     * @return integer
     */
    public function resolveSectionId($route)

    {
        $routes = $this->sectionRoutes();

        if (!isset($routes['routes'][$route])) {
            return '';
        }

        $sId = $routes['routes'][$route];

        return $sId;
    }

    // ==========================================================================
    // GETTERS
    // ==========================================================================

    /**
     * @return object
     */
    public function objType()
    {
        return $this->objType;
    }

    /**
     * @return integer
     */
    public function baseSection()
    {
        return $this->baseSection;
    }

    /**
     * @return array
     */
    public function sectionTypes()
    {
        return $this->sectionTypes;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    // ==========================================================================
    // SETTERS
    // ==========================================================================

    /**
     * @param object $objType The object type.
     * @return self
     */
    public function setObjType($objType)
    {
        $this->objType = $objType;

        return $this;
    }

    /**
     * @param integer $baseSection The base section id.
     * @return self
     */
    public function setBaseSection($baseSection)
    {
        $this->baseSection = $baseSection;

        return $this;
    }

    /**
     * @param array $sectionTypes Section types array | null.
     * @return self
     */
    public function setSectionTypes($sectionTypes)
    {
        $this->sectionTypes = $sectionTypes;

        return $this;
    }

    // ==========================================================================
    // UTILS
    // ==========================================================================

    /**
     * Convert a string to snake case.
     *
     * @param  string $value     The value to convert.
     * @param  string $delimiter The word delimiter.
     * @return string
     */
    public static function snake($value, $delimiter = '-')
    {
        $key = $value;
        if (isset(static::$snakeCache[$key][$delimiter])) {
            return static::$snakeCache[$key][$delimiter];
        }
        if (!ctype_lower($value)) {
            $value = preg_replace('/\s+/u', '', $value);
            $value = mb_strtolower(preg_replace('/(.)(?=[A-Z])/u', '$1'.$delimiter, $value), 'UTF-8');
        }
        static::$snakeCache[$key][$delimiter] = $value;

        return $value;
    }
}


1		<?php
2
3		namespace Charcoal\Cms\Service\Loader;
4
5		use Charcoal\Loader\CollectionLoader;
6		use Charcoal\Object\ObjectRoute;
7		use Exception;
8
9		use \Charcoal\Translator\TranslatorAwareTrait;
10		/**
11		* Section Loader
12		*/
13		class SectionLoader extends AbstractLoader
14		{
15		/**
16		* @var array $sectionRoutes The section's routes.
17		*/
18		protected $sectionRoutes;
19
20		/**
21		* @var integer $baseSection The id of the base section.
22		*/
23		protected $baseSection;
24
25		/**
26		* The cache of snake-cased words.
27		*
28		* @var array
29		*/
30		protected static $snakeCache = [];
31
32		/**
33		* @param integer $id The section's id.
34		* @return mixed
35		*/
36		public function fromId($id)
37		{
38		$proto = $this->modelFactory()->create($this->objType());
		0 ignored issues – show Documentation introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report `$this->objType()` is of type `object`, but the function expects a `string`. 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...
39
40		return $proto->loadFrom('id', $id);
41		}
42
43		/**
44		* @param string $slug The section's slug.
45		* @return mixed
46		*/
47		public function fromSlug($slug)
48		{
49		$id = $this->resolveSectionId($slug);
50		return $this->fromId($id);
51		}
52
53		/**
54		* @return CollectionLoader
55		*/
56	View Code Duplication	public function all()
		0 ignored issues – show Duplication introduced 2017-03-28 16:58 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...
57		{
58		$proto = $this->modelFactory()->get($this->objType());
59		$loader = $this->collectionLoader();
60		$loader->setModel($proto);
61		$loader->addFilter('active', true);
62		$loader->addOrder('position', 'asc');
63
64		return $loader;
65		}
66
67		/**
68		* @return \ArrayAccess\|\Traversable
69		*/
70		public function masters()
71		{
72		$loader = $this->all();
73		$operator = [];
74		if (!$this->baseSection()) {
75		$operator = [ 'operator' => 'IS NULL' ];
76		}
77		$loader->addFilter('master', $this->baseSection(), $operator);
78
79		return $loader->load();
80		}
81
82		/**
83		* @return \ArrayAccess\|\Traversable
84		*/
85		public function children()
86		{
87		$masters = $this->masters();
88
89		$children = [];
90		$hasChildren = count($masters) > 0;
91
92		while ($hasChildren) {
93		$ids = [];
94
95		foreach ($masters as $master) {
96		$ids[] = $master->id();
97		}
98
99		$masters = $this->all()
100		->addFilter([
101		'property' => 'master',
102		'val' => $ids,
103		'operator' => 'IN'
104		])
105		->load();
106
107		$children = array_merge($children, $masters);
108		$hasChildren = count($masters) > 0;
109		}
110
111		return $children;
112		}
113
114		/**
115		* Pair routes slug to sections ID
116		* @return array
117		*/
118		public function sectionRoutes()
119		{
120		if ($this->sectionRoutes) {
		0 ignored issues – show Bug Best Practice introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The expression `$this->sectionRoutes` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
121		return $this->sectionRoutes;
122		}
123
124		$proto = $this->modelFactory()->get(ObjectRoute::class);
125
126		$sectionTypes = $this->sectionTypes();
127		if (!$sectionTypes) {
		0 ignored issues – show Bug Best Practice introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The expression `$sectionTypes` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
128		$sectionTypes = [
129		'base' => $this->objType()
130		];
131		}
132
133		$loader = $this->collectionLoader();
134		$loader->setModel($proto);
135
136		$filters = [];
137		foreach ($sectionTypes as $key => $val) {
138		$filters[] = 'route_obj_type = \''.$val.'\'';
139		}
140		$q = 'SELECT * FROM `'.$proto->source()->table().'`
141		WHERE active=1 AND ( '
142		. implode(' OR ', $filters) . ' )
143		ORDER BY creation_date ASC';
144
145		$objectRoutes = $loader->loadFromQuery($q);
146
147		// $loader->addFilter('route_obj_type', $this->objType())
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report `72%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
148		// // This is important. This is why it all works
149		// // Loading it from the first created to the last created
150		// // makes the following foreach override previous data.
151		// ->addOrder('creation_date', 'asc');
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
152
153		// $objectRoutes = $loader->load();
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report `55%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
154
155		$sections = [];
156		$routes = [];
157		// The current language
158		$lang = $this->translator()->getLocale();
159		foreach ($objectRoutes as $o) {
160		if ($o->lang() === $lang) {
161		// Will automatically override previous slug set
162		$sections[$o->routeObjId()] = $o->slug();
163		}
164		// Keep track of EVERY slug.
165		$routes[$o->slug()] = $o->routeObjId();
166		}
167
168		$this->sectionRoutes = [
169		'sections' => $sections,
170		'routes' => $routes
171		];
172
173		return $this->sectionRoutes;
174		}
175
176		/**
177		* Resolve latest route from route slug.
178		* @param string $route The route to resolve.
179		* @return string
180		*/
181	View Code Duplication	public function resolveRoute($route)
		0 ignored issues – show Duplication introduced 2017-03-28 16:58 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...
182		{
183		$routes = $this->sectionRoutes();
184		$sId = $this->resolveSectionId($route);
185
186		if (!isset($routes['sections'][$sId])) {
187		return '';
188		}
189
190		return $routes['sections'][$sId];
191		}
192
193		/**
194		* Resolve section ID from route slug.
195		* @param string $route The route to resolve.
196		* @return integer
197		*/
198	View Code Duplication	public function resolveSectionId($route)
		0 ignored issues – show Duplication introduced 2017-03-28 16:58 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...
199		{
200		$routes = $this->sectionRoutes();
201
202		if (!isset($routes['routes'][$route])) {
203		return '';
204		}
205
206		$sId = $routes['routes'][$route];
207
208		return $sId;
209		}
210
211		// ==========================================================================
212		// GETTERS
213		// ==========================================================================
214
215		/**
216		* @return object
217		*/
218		public function objType()
219		{
220		return $this->objType;
221		}
222
223		/**
224		* @return integer
225		*/
226		public function baseSection()
227		{
228		return $this->baseSection;
229		}
230
231		/**
232		* @return array
233		*/
234		public function sectionTypes()
235		{
236		return $this->sectionTypes;
		0 ignored issues – show Bug introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The property `sectionTypes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
237		}
238
239		// ==========================================================================
240		// SETTERS
241		// ==========================================================================
242
243		/**
244		* @param object $objType The object type.
245		* @return self
246		*/
247		public function setObjType($objType)
248		{
249		$this->objType = $objType;
250
251		return $this;
252		}
253
254		/**
255		* @param integer $baseSection The base section id.
256		* @return self
257		*/
258		public function setBaseSection($baseSection)
259		{
260		$this->baseSection = $baseSection;
261
262		return $this;
263		}
264
265		/**
266		* @param array $sectionTypes Section types array \| null.
267		* @return self
268		*/
269		public function setSectionTypes($sectionTypes)
270		{
271		$this->sectionTypes = $sectionTypes;
272
273		return $this;
274		}
275
276		// ==========================================================================
277		// UTILS
278		// ==========================================================================
279
280		/**
281		* Convert a string to snake case.
282		*
283		* @param string $value The value to convert.
284		* @param string $delimiter The word delimiter.
285		* @return string
286		*/
287		public static function snake($value, $delimiter = '-')
288		{
289		$key = $value;
290		if (isset(static::$snakeCache[$key][$delimiter])) {
291		return static::$snakeCache[$key][$delimiter];
292		}
293		if (!ctype_lower($value)) {
294		$value = preg_replace('/\s+/u', '', $value);
295		$value = mb_strtolower(preg_replace('/(.)(?=[A-Z])/u', '$1'.$delimiter, $value), 'UTF-8');
296		}
297		static::$snakeCache[$key][$delimiter] = $value;
298
299		return $value;
300		}
301		}
302

locomotivemtl / charcoal-cms

Push — master ( dc68d1...1f5199 )

SectionLoader::sectionRoutes() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like