O2System\Reactor\Services\Loader

Complexity

Total Complexity

35

Size/Duplication

Total Lines	331
Duplicated Lines	0 %

Importance

Changes	4
Bugs	2	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getClassNamespaceDirs()	0	10	2
A	__construct()	0	9	2
A	getDirNamespace()	0	12	2
B	loadHelper()	0	31	7
A	getNamespaceDirs()	0	9	2
A	loadClass()	0	27	3
A	register()	0	4	1
A	loadHelpers()	0	4	2
A	requireFile()	0	9	2
A	loadMappedFile()	0	26	4
B	addNamespace()	0	39	8

<?php
/**
 * This file is part of the O2System PHP 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\Reactor\Services;

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

use O2System\Psr\Loader\AutoloadInterface;
use O2System\Reactor\DataStructures\Module;

The type O2System\Reactor\DataStructures\Module was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * O2System Loader
 *
 * Class and files loader based on PSR-4 Autoloader
 *
 * @see     http://www.php-fig.org/psr/psr-4/
 *
 * @package O2System\Kernel
 */
class Loader implements AutoloadInterface
{
    /**
     * Loader::$publicDirs
     *
     * Loader Public Directories.
     *
     * @var array
     */
    protected $publicDirs = [
        PATH_PUBLIC,
    ];

    /**
     * Loader::$namespaceDirs
     *
     * Loader Namespaces Directories.
     *
     * @var array
     */
    protected $namespaceDirs = [];

    /**
     * Loader::$namespaceDirsMap
     *
     * Loader Namespaces Directories Maps.
     *
     * @var array
     */
    protected $namespaceDirsMap = [];

    /**
     * Loader::$loadedHelpers
     *
     * Loader Loaded Helpers Registry.
     *
     * @var array
     */
    protected $loadedHelpers = [];

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

    /**
     * Loader::__construct
     */
    public function __construct()
    {
        $this->register();

        // Add Kernel Namespace
        $this->addNamespace('O2System\Kernel', PATH_KERNEL);

        if (defined('PATH_REACTOR')) {
            $this->addNamespace('O2System\Reactor', PATH_REACTOR);
        }
    }

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

    /**
     * Register loader with SPL autoloader stack.
     *
     * @return void
     */
    public function register()
    {
        // Prepend the PSR4 autoloader for maximum performance.
        spl_autoload_register([&$this, 'loadClass'], true, true);
    }

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

    /**
     * Adds a base directory for a namespace prefix.
     *
     * @param string $namespace     The namespace prefix.
     * @param string $baseDirectory A base directory for class files in the
     *                              namespace.
     * @param bool   $prepend       If true, prepend the base directory to the stack
     *                              instead of appending it; this causes it to be searched first rather
     *                              than last.
     *
     * @return void
     */
    public function addNamespace($namespace, $baseDirectory, $prepend = false)
    {
        // normalize namespace prefix
        $namespace = trim($namespace, '\\') . '\\';

        if (empty($namespace) OR $namespace === '\\') {
            return;
        }

        // normalize the base directory with a trailing separator
        $baseDirectory = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $baseDirectory);
        $baseDirectory = rtrim($baseDirectory, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;

        if (is_dir($baseDirectory)) {
            // initialize the namespace prefix array
            if (isset($this->namespaceDirs[ $namespace ]) === false) {
                $this->namespaceDirs[ $namespace ] = [];
            }

            // retain the base directory for the namespace prefix
            if ( ! in_array($baseDirectory, $this->namespaceDirs[ $namespace ])) {
                if ($prepend) {
                    array_unshift($this->namespaceDirs[ $namespace ], $baseDirectory);
                } else {
                    array_push($this->namespaceDirs[ $namespace ], $baseDirectory);
                }
            }

            $this->namespaceDirsMap[ $baseDirectory ] = $namespace;

            // Register Namespace Language
            language()->addFilePath($baseDirectory);

            // Register Namespace Output FilePath
            output()->addFilePath($baseDirectory);

            // Autoload Composer
            if (is_file($baseDirectory . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php')) {
                require($baseDirectory . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php');
            }
        }
    }

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

    /**
     * Get Namespace
     *
     * Get PSR4 Directory base on directory path
     *
     * @param string $dir
     *
     * @return string|bool
     */
    public function getDirNamespace($dir)
    {
        $dir = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $dir);

        $dir = realpath($dir);
        $dir = rtrim($dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;

        if (array_key_exists($dir, $this->namespaceDirsMap)) {
            return $this->namespaceDirsMap[ $dir ];
        }

        return false;
    }

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

    /**
     * Get Namespace Class Directory
     *
     * @param string $className
     *
     * @return string|null
     */
    public function getClassNamespaceDirs($className)
    {
        $className = ltrim($className, '\\');
        $namespace = null;

The assignment to $namespace is dead and can be removed.

        if ($lastNsPos = strripos($className, '\\')) {
            return $this->getNamespaceDirs(substr($className, 0, $lastNsPos));
        }

        return false;

The expression return false returns the type false which is incompatible with the documented return type null|string.

    }

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

    /**
     * Get Namespace Directory
     *
     * @param string $namespace
     *
     * @return string
     */
    public function getNamespaceDirs($namespace)
    {
        $namespace = trim($namespace, '\\') . '\\';

        if (array_key_exists($namespace, $this->namespaceDirs)) {
            return $this->namespaceDirs[ $namespace ];
        }

        return false;

The expression return false returns the type false which is incompatible with the documented return type string.

    }

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

    public function loadHelpers(array $helpers)
    {
        foreach ($helpers as $helper) {
            $this->loadHelper($helper);
        }
    }

    public function loadHelper($helper)
    {
        if (array_key_exists($helper, $this->loadedHelpers)) {

            return;
        }

        if ($this->requireFile($helper)) {
            $this->loadedHelpers[ pathinfo($helper, PATHINFO_FILENAME) ][] = $helper;

            return;
        }

        $helperDirectories = [
            PATH_KERNEL . 'Helpers' . DIRECTORY_SEPARATOR,
            PATH_FRAMEWORK . 'Helpers' . DIRECTORY_SEPARATOR,

The constant O2System\Reactor\Services\PATH_FRAMEWORK was not found. Maybe you did not declare it correctly or list all dependencies?

            PATH_APP . 'Helpers' . DIRECTORY_SEPARATOR,
        ];
        
        if ( ! array_key_exists($helper, $this->loadedHelpers)) {
            $this->loadedHelpers[ $helper ] = [];
        }

        foreach ($helperDirectories as $helperDirectory) {

            $helperFilePath = $helperDirectory . studlycase($helper) . '.php';

            if (in_array($helperFilePath, $this->loadedHelpers[ $helper ])) {
                continue;
            } elseif ($this->requireFile($helperFilePath)) {
                $this->loadedHelpers[ $helper ][] = $helperFilePath;
            }
        }
    }

    /**
     * If a file exists, require it from the file system.
     *
     * @param string $file The file to require.
     *
     * @return bool True if the file exists, false if not.
     */
    public function requireFile($file)
    {
        if (is_file($file)) {
            require_once $file;

            return true;
        }

        return false;
    }

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

    /**
     * Loads the class file for a given class name.
     *
     * @param string $class The fully-qualified class name.
     *
     * @return mixed The mapped file name on success, or boolean false on
     * failure.
     */
    public function loadClass($class)
    {
        // the current namespace prefix
        $namespace = $class;

        // work backwards through the namespace names of the fully-qualified
        // class name to find a mapped file name
        while (false !== $pos = strrpos($namespace, '\\')) {
            // retain the trailing namespace separator in the prefix
            $namespace = substr($class, 0, $pos + 1);

            // the rest is the relative class name
            $relativeClass = substr($class, $pos + 1);

            // try to load a mapped file for the prefix and relative class
            $mappedFile = $this->loadMappedFile($namespace, $relativeClass);
            if ($mappedFile) {
                return $mappedFile;
            }

            // remove the trailing namespace separator for the next iteration
            // of strrpos()
            $namespace = rtrim($namespace, '\\');
        }

        // never found a mapped file
        return false;
    }

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

    /**
     * Load the mapped file for a namespace prefix and relative class.
     *
     * @param string $namespace     The namespace prefix.
     * @param string $relativeClass The relative class name.
     *
     * @return mixed Boolean false if no mapped file can be loaded, or the
     * name of the mapped file that was loaded.
     */
    public function loadMappedFile($namespace, $relativeClass)
    {
        // are there any base directories for this namespace prefix?
        if (isset($this->namespaceDirs[ $namespace ]) === false) {
            return false;
        }

        // look through base directories for this namespace prefix
        foreach ($this->namespaceDirs[ $namespace ] as $namespaceDirectory) {

            // replace the namespace prefix with the base directory,
            // replace namespace separators with directory separators
            // in the relative class name, append with .php
            $file = $namespaceDirectory
                . str_replace('\\', '/', $relativeClass)
                . '.php';

            // if the mapped file exists, require it
            if ($this->requireFile($file)) {
                // yes, we're done
                return $file;
            }
        }

        // never found it
        return false;
    }
}