O2System\Framework\Containers\Modules\DataStructures\Module

Complexity

Total Complexity

54

Size/Duplication

Total Lines	499
Duplicated Lines	0 %

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	setSegments()	0	5	2
A	getParentSegments()	0	7	2
A	getProperties()	0	3	1
A	__construct()	0	4	1
A	getThemes()	0	12	3
A	getChecksum()	0	3	1
A	getDefaultControllerClassName()	0	3	1
A	getDir()	0	10	3
A	setProperties()	0	11	2
A	getSegments()	0	7	2
A	getResourcesDir()	0	19	4
A	getPresets()	0	3	1
A	getCode()	0	3	1
A	hasTheme()	0	15	5
A	getPublicDir()	0	3	1
A	setPresets()	0	5	1
A	loadModel()	0	6	2
A	getParameter()	0	3	1
A	getType()	0	3	1
B	getTheme()	0	23	7
A	getNamespace()	0	3	1
A	setNamespace()	0	5	1
A	setParentSegments()	0	5	2
B	getControllers()	0	36	6
A	setType()	0	5	1
A	getThemesDir()	0	3	1

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

The constant O2System\Framework\Containers\Modules\DataStructures\PATH_ROOT was not found. Maybe you did not declare it correctly or list all dependencies?

    }

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

    /**
     * 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)) {

Are you sure $this->getResourcesDir('themes') of type false|string can be used in concatenation?

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

The expression return $this->getResourcesDir('themes') could also return false which is incompatible with the documented return type string. Did you maybe forget to handle an error condition?

    }

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

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

The method load() does not exist on O2System\Framework\Models\Sql\Model. Since you implemented __call, consider adding a @method annotation.

The method load() does not exist on O2System\Framework\Models\NoSql\Model.

        }
    }

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

        if (is_dir($directory = $this->getDir('Controllers'))) {

It seems like $directory = $this->getDir('Controllers') can also be of type false; however, parameter $filename of is_dir() does only seem to accept string, maybe add an additional type check?

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

array($directory, '.php', '/', O2System\Framework\Containers\Modules\DataStructures\DIRECTORY_SEPARATOR) of type array<integer,false|string> is incompatible with the type string|string[] expected by parameter $search of str_replace().

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