Charcoal\Cms\Service\Loader\SectionLoader

Complexity

Total Complexity

27

Size/Duplication

Total Lines	289
Duplicated Lines	11.42 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	fromId()	0	6	1
A	fromSlug()	0	5	1
A	all()	10	10	1
A	masters()	0	11	2
B	children()	0	28	3
B	sectionRoutes()	0	57	6
A	resolveRoute()	11	11	2
A	resolveSectionId()	12	12	2
A	objType()	0	4	1
A	baseSection()	0	4	1
A	sectionTypes()	0	4	1
A	setObjType()	0	6	1
A	setBaseSection()	0	6	1
A	setSectionTypes()	0	6	1
A	snake()	0	14	3

<?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());

$this->objType() is of type object, but the function expects a string.

        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()

This method seems to be duplicated in your project.

    {
        $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) {

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.

            return $this->sectionRoutes;
        }

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

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

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.

            $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())

72% of this comment could be valid code. Did you maybe forget this after debugging?

        //     // 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');

70% of this comment could be valid code. Did you maybe forget this after debugging?

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

55% of this comment could be valid code. Did you maybe forget this after debugging?

        $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)

This method seems to be duplicated in your project.

    {
        $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)

This method seems to be duplicated in your project.

    {
        $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;

The property sectionTypes does not exist. Did you maybe forget to declare it?

    }

    // ==========================================================================
    // 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;
    }
}