Subreality\Dilmun\Nabu\Autoloader

Complexity

Total Complexity

13

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

93.33%

Importance

Changes	7
Bugs	1	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
A	registerPackages()	0	16	1
A	__construct()	0	7	1
B	includeClass()	0	27	4
A	setLogger()	0	4	1
A	getLogger()	0	4	1
B	loadPackage()	0	32	4

<?php
namespace Subreality\Dilmun\Nabu;

use Subreality\Dilmun\Nabu\LoggerHandler\System;

/**
 * Nabu was the god of writing and scribes and was the keeper of the Tablets of
 * Destiny, in which the fate of humankind was recorded.
 *
 * @author derek
 */
class Autoloader
{
    protected $logger;

    protected $packages = array();

    /**
     * Automatically initializes logging using the System handler
     */
    public function __construct()
    {
        $system_logger = new System();
        $system_logger->initialize();
        
        $this->logger = new Logger($system_logger);
    }

    /**
     * Registers the includeClass function as an autoloader.
     *
     * @see Autoloader::includeClass
     */
    public function register()
    {
        spl_autoload_register(array($this,"includeClass"));
    }

    /**
     * @param $package
     * @param $path
     */
    public function registerPackages($package, $path)
    {
        $this->logger->info("Preparing {$package} package for registration.");
        $this->logger->debug("Parameters: package = {$package}, path = {$path}");

        $package = trim($package, "\\");
        $package = $package . "\\";

        $path = rtrim($path, "/");
        $path = $path . "/";

        $this->logger->debug("Registering index {$package} with {$path}");
        $this->packages[$package][] = $path;

        $this->logger->info("Registered index {$package} as {$path}");
    }

    /**
     * Includes the file corresponding with the class name to be autoloaded.
     *
     * @param callable $class   class name as defined by PHP autoloading
     *
     * @return string|false     The path to the class on success; otherwise false
     */
    protected function includeClass($class)
    {
        $this->logger->info("Setting up {$class} class for inclusion.");

        $package_found  = false;
        $package_loaded = false;

        foreach ($this->packages as $package => $sources) {
            if (strpos($class, $package) !== false) {
                $package_found = true;

                $package_strlen = strlen($package);

                $class_path = substr($class, $package_strlen);

                $this->logger->debug("Found package {$package} and class path {$class_path} in class {$class}");

                $package_loaded = $this->loadPackage($package, $class_path);
            }
        }

        if (!$package_found) {
            $this->logger->alert("No registered packages found for {$class}!");
        }

        return $package_loaded;
    }

    /**
     * Loads a package based on registered paths associated with the package.
     *
     * @param string $package_name  The name of the package in Vendor\Package format
     * @param string $class_name    The full, relative name of the class with the vendor and package names stripped
     *
     * @return false|string          The path to the class on success; otherwise false
     */
    protected function loadPackage($package_name, $class_name)
    {
        $this->logger->info("Working on loading {$class_name} from {$package_name}");

        $class_path = false;

        if (isset($this->packages[$package_name])) {
            $this->logger->debug("Package index of {$package_name} is set.");

            foreach ($this->packages[$package_name] as $path) {
                $converted_class = str_replace('\\', '/', $class_name);
                $class_path      = $path . $converted_class . ".php";

                $this->logger->debug("Class file path is {$class_path}");

                if (file_exists($class_path)) {
                    $this->logger->debug("File {$class_path} exists; including file");

                    /** @noinspection PhpIncludeInspection */
                    include $class_path;

                    $this->logger->info("Completed loading {$class_path}");
                } else {
                    $this->logger->debug("File {$class_path} does not exist");

                    $class_path = false;
                }
            }
        }
        
        return $class_path;
    }

    /**
     * Allows overriding the default file logger created at construction
     *
     * @param Logger $logger
     */
    public function setLogger(Logger $logger)
    {
        $this->logger = $logger;
    }

    /**
     * Gets the Logger set for the Autoloader
     *
     * @return Logger
     */
    public function getLogger()
    {
        return $this->logger;
    }
}