Module::getControllers() - Code Metrics - Inspection of "module registry, acl, hierarchical, language bugs..." - o2system/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( c097a6...9587da )

by Steeven
created 2019-05-14 15:22 UTC
Module::getControllers() B

↳ Parent: Module
Complexity

Conditions	6
Paths	2
Size

Total Lines	36
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	22
nc	2
nop	0
dl	0
loc	36
rs	8.9457
c	0
b	0
f	0
<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Framework\Containers\Modules\DataStructures;

// ------------------------------------------------------------------------

use O2System\Spl\DataStructures\SplArrayObject;
use O2System\Spl\Info\SplDirectoryInfo;

/**
 * Class Module
 *
 * @package O2System\Framework\Containers\Modules\DataStructures
 */
class Module extends SplDirectoryInfo
{
    /**
     * Module::$type
     *
     * @var string
     */
    protected $type = 'MODULE';

    /**
     * Module::$namespace
     *
     * @var string
     */
    protected $namespace;

    /**
     * Module::$segments
     *
     * @var string
     */
    protected $segments;

    /**
     * Module::$parentSegments
     *
     * @var string
     */
    protected $parentSegments;

    /**
     * Module::$properties
     *
     * @var array
     */
    protected $properties = [];

    /**
     * Module::$presets
     *
     * @var array
     */
    protected $presets = [];

    // ------------------------------------------------------------------------

    /**
     * Module::__construct
     *
     * @param string $dir
     */
    public function __construct($dir)
    {
        parent::__construct($dir);
        $this->namespace = prepare_namespace(str_replace(PATH_ROOT, '', $dir), false);

    }

    // ------------------------------------------------------------------------

    /**
     * Module::getSegments
     *
     * @param bool $returnArray
     *
     * @return array|string
     */
    public function getSegments($returnArray = true)
    {
        if ($returnArray) {
            return explode('/', $this->segments);
        }

        return $this->segments;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setSegments
     *
     * @param array|string $segments
     *
     * @return static
     */
    public function setSegments($segments)
    {
        $this->segments = is_array($segments) ? implode('/', $segments) : $segments;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getParentSegments
     *
     * @param bool $returnArray
     *
     * @return array|string
     */
    public function getParentSegments($returnArray = true)
    {
        if ($returnArray) {
            return explode('/', $this->parentSegments);
        }

        return $this->parentSegments;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setParentSegments
     *
     * @param array|string $parentSegments
     *
     * @return static
     */
    public function setParentSegments($parentSegments)
    {
        $this->parentSegments = is_array($parentSegments) ? implode('/', $parentSegments) : $parentSegments;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getCode
     *
     * @return string
     */
    public function getCode()
    {
        return strtoupper(substr(md5(spl_object_hash($this)), 2, 7));
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getChecksum
     *
     * @return string
     */
    public function getChecksum()
    {
        return md5($this->getMTime());
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getProperties
     *
     * @return \O2System\Spl\DataStructures\SplArrayObject
     */
    public function getProperties()
    {
        return new SplArrayObject($this->properties);
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setProperties
     *
     * @param array $properties
     *
     * @return static
     */
    public function setProperties(array $properties)
    {
        if (isset($properties[ 'presets' ])) {
            $this->setPresets($properties[ 'presets' ]);

            unset($properties[ 'presets' ]);
        }

        $this->properties = $properties;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getPresets
     *
     * @return \O2System\Spl\DataStructures\SplArrayObject
     */
    public function getPresets()
    {
        return new SplArrayObject($this->presets);
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setPresets
     *
     * @param array $presets
     *
     * @return static
     */
    public function setPresets(array $presets)
    {
        $this->presets = $presets;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getDefaultControllerClassName
     *
     * @return string
     */
    public function getDefaultControllerClassName()
    {
        return $this->getNamespace() . 'Controllers\\' . $this->getDirName();
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getNamespace
     *
     * @return string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setNamespace
     *
     * @param string $namespace
     *
     * @return static
     */
    public function setNamespace($namespace)
    {
        $this->namespace = trim($namespace, '\\') . '\\';

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getThemes
     *
     * @return array
     */
    public function getThemes()
    {
        $directory = new SplDirectoryInfo($this->getResourcesDir() . 'themes' . DIRECTORY_SEPARATOR);

        $themes = [];
        foreach ($directory->getTree() as $themeName => $themeTree) {
            if (($theme = $this->getTheme($themeName)) instanceof Module\Theme) {
                $themes[ $themeName ] = $theme;
            }
        }

        return $themes;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getResourcesDir
     *
     * @param string|null $subDir
     *
     * @return bool|string
     */
    public function getResourcesDir($subDir = null)
    {
        $dirResources = PATH_RESOURCES;

        $dirPath = str_replace(PATH_APP, '', $this->getRealPath());
        $dirPathParts = explode(DIRECTORY_SEPARATOR, $dirPath);

        if (count($dirPathParts)) {
            $dirPathParts = array_map('dash', $dirPathParts);
            $dirResources .= implode(DIRECTORY_SEPARATOR, $dirPathParts);
        }

        if (is_null($subDir)) {
            return $dirResources;
        } elseif (is_dir($dirResources . $subDir . DIRECTORY_SEPARATOR)) {
            return $dirResources . $subDir . DIRECTORY_SEPARATOR;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getTheme
     *
     * @param string $theme
     * @param bool   $failover
     *
     * @return bool|Module\Theme
     */
    public function getTheme($theme, $failover = true)
    {
        $theme = dash($theme);

        if ($failover === false) {
            if (is_dir($themePath = $this->getResourcesDir('themes') . $theme . DIRECTORY_SEPARATOR)) {
            if (is_dir($themePath = /** @scrutinizer ignore-type */ $this->getResourcesDir('themes') . $theme . DIRECTORY_SEPARATOR)) {
                $themeObject = new Module\Theme($themePath);

                if ($themeObject->isValid()) {
                    return $themeObject;
                }
            }
        } else {
            foreach (modules() as $module) {
                if (in_array($module->getType(), ['KERNEL', 'FRAMEWORK'])) {
                    continue;
                } elseif ($themeObject = $module->getTheme($theme, false)) {
                    return $themeObject;
                }
            }
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getPublicDir
     *
     * @return string
     */
    public function getPublicDir()
    {
        return PATH_PUBLIC . strtolower(str_replace(PATH_APP, '', $this->getRealPath()));
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getType
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::setType
     *
     * @param string $type
     *
     * @return static
     */
    public function setType($type)
    {
        $this->type = strtoupper($type);

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getDir
     *
     * @param string $subDir
     * @param bool   $psrDir
     *
     * @return bool|string
     */
    public function getDir($subDir, $psrDir = false)
    {
        $subDir = $psrDir === true ? prepare_class_name($subDir) : $subDir;
        $subDir = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $subDir);

        if (is_dir($dirPath = $this->getRealPath() . $subDir)) {
            return $dirPath . DIRECTORY_SEPARATOR;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::hasTheme
     *
     * @param string $theme
     *
     * @return bool
     */
    public function hasTheme($theme)
    {
        if (is_dir($this->getThemesDir() . $theme)) {
            return true;
        } else {
            foreach (modules() as $module) {
                if (in_array($module->getType(), ['KERNEL', 'FRAMEWORK'])) {
                    continue;
                } elseif (is_dir($module->getResourcesDir('themes') . $theme)) {
                    return true;
                }
            }
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Module::getThemesDir
     *
     * @return string
     */
    public function getThemesDir()
    {
        return $this->getResourcesDir('themes');

    }

    // ------------------------------------------------------------------------

    /**
     * Module::getParameter
     *
     * @return string
     */
    public function getParameter()
    {
        return snakecase($this->getDirName());
    }

    // ------------------------------------------------------------------------

    /**
     * Module::loadModel
     */
    public function loadModel()
    {
        $modelClassName = $this->namespace . 'Models\Base';

        if (class_exists($modelClassName)) {
            models()->load($modelClassName, strtolower($this->type));
            models()->/** @scrutinizer ignore-call */ load($modelClassName, strtolower($this->type));
        }
    }

    public function getControllers()
    {
        $controllers = [];

        if (is_dir($directory = $this->getDir('Controllers'))) {
        if (is_dir(/** @scrutinizer ignore-type */ $directory = $this->getDir('Controllers'))) {
            $namespace = $this->getNamespace() . 'Controllers\\';

            $iterator = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator($directory, \RecursiveDirectoryIterator::SKIP_DOTS)
            );

            foreach ($iterator as $file) {
                if (pathinfo($file, PATHINFO_EXTENSION) == "php") {
                    $controllerClassName = str_replace([
                    $controllerClassName = str_replace(/** @scrutinizer ignore-type */ [
                        $directory,
                        '.php',
                        '/',
                        DIRECTORY_SEPARATOR,
                    ], [
                        '',
                        '',
                        '\\',
                        '\\',
                    ], $file->getRealPath());

                    $controller = new Module\Controller($namespace . $controllerClassName);

                    if ( ! empty($controller->name) and ! in_array($controller->getParameter(),
                            ['login', 'pages', 'setup', 'license'])) {
                        $controllers[ $controller->getParameter() ] = $controller;
                    }
                }
            }
        }

        return $controllers;
    }
}
o2system / framework

GitHub Access Token became invalid

Push — master ( c097a6...9587da )

Module::getControllers() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
