SplClassLoader.php

<?php

namespace utilities;

use cms\Logger;
use Exception;

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

/**
 * SplClassLoader implementation that implements the technical interoperability
 * standards for PHP 5.3 namespaces and class names.
 *
 * http://groups.google.com/group/php-standards/web/psr-0-final-proposal?pli=1
 *
 *     // Example which loads classes for the Doctrine Common package in the
 *     // Doctrine\Common namespace.
 *     $classLoader = new SplClassLoader('Doctrine\Common', '/path/to/doctrine');
 *     $classLoader->register();
 *
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @author  Lars Moelleken <[email protected]>
 * @author  Pierre Cassat <[email protected]>
 * @author  Jonathan H. Wage <[email protected]>
 * @author  Roman S. Borschel <[email protected]>
 * @author  Matthew Weier O'Phinney <[email protected]>
 * @author  Kris Wallsmith <[email protected]>
 * @author  Fabien Potencier <[email protected]>
 */
class SplClassLoader
{

  /**
   * @var string
   */
  private $_fileExtension = '.php';

  /**
   * @var null|string
   */
  private $_namespace;

  /**
   * @var null|string
   */
  private $_includePath;

  /**
   * @var string
   */
  private $_namespaceSeparator = '\\';

  /**
   * Creates a new <tt>SplClassLoader</tt> that loads classes of the
   * specified namespace.
   *
   * @param null|string $ns The namespace to use.
   * @param null|string $includePath
   */
  public function __construct($ns = null, $includePath = null)
  {
    $this->_namespace = $ns;
    $this->_includePath = $includePath;
  }

  /**
   * Gets the namespace separator used by classes in the namespace of this class loader.
   *
   * @return string
   */
  public function getNamespaceSeparator()
  {
    return $this->_namespaceSeparator;
  }

  /**
   * Sets the namespace separator used by classes in the namespace of this class loader.
   *
   * @param string $sep The separator to use.
   */
  public function setNamespaceSeparator($sep)
  {
    $this->_namespaceSeparator = $sep;
  }

  /**
   * Gets the base include path for all class files in the namespace of this class loader.
   *
   * @return string $includePath
   */
  public function getIncludePath()
  {
    return $this->_includePath;
  }

  /**
   * Sets the base include path for all class files in the namespace of this class loader.
   *
   * @param string $includePath
   *
   * @throws \InvalidArgumentException
   */
  public function setIncludePath($includePath)
  {
    if (!file_exists($includePath)) {
      throw new \InvalidArgumentException(
          sprintf('Path "%s" declared as namespace\'s "%s" include path does not exist!', $includePath, $this->_namespace)
      );
    }
    if (!is_dir($includePath)) {
      throw new \InvalidArgumentException(
          sprintf('Path "%s" declared as namespace\'s "%s" include path is not a directory!', $includePath, $this->_namespace)
      );
    }

    $this->_includePath = realpath($includePath);
  }

  /**
   * Gets the file extension of class files in the namespace of this class loader.
   *
   * @return string $fileExtension
   */
  public function getFileExtension()
  {
    return $this->_fileExtension;
  }

  /**
   * Sets the file extension of class files in the namespace of this class loader.
   *
   * @param string $fileExtension
   */
  public function setFileExtension($fileExtension)
  {
    $this->_fileExtension = $fileExtension;
  }

  /**
   * Installs this class loader on the SPL autoload stack.
   */
  public function register()
  {
    try {
      if (version_compare(phpversion(), '5.3.0', '>=')) {
        spl_autoload_register(
            array(
                $this,
                'loadClass',
            ),
            true,
            false
        );
      } else {
        spl_autoload_register(
            array(
                $this,
                'loadClass',
            )
        );
      }
    } catch (Exception $e) {
      Logger::error(date('d. m. Y G:i:s') . ' ' . $e->getFile() . ' | ' . $e->getLine() . ' : ' . $e->getMessage());
    }
  }

  /**
   * Uninstalls this class loader from the SPL autoloader stack.
   */
  public function unregister()
  {
    spl_autoload_unregister(
        array(
            $this,
            'loadClass',
        )
    );
  }

  /**
   * Constructs the file path of a class.
   *
   * @param string $className The name of the class to load.
   *
   * @return null|string
   */
  public function resolveFileName($className)
  {
    if (
        null === $this->_namespace
        ||
        0 === strpos($className, $this->_namespace . $this->_namespaceSeparator)
    ) {

      $fileName = null;

      $lastNamespacePosition = strrpos($className, $this->_namespaceSeparator);
      if (false !== $lastNamespacePosition) {
        $namespace = substr($className, 0, $lastNamespacePosition);
        $className = substr($className, $lastNamespacePosition + 1);
        $fileName = str_replace($this->_namespaceSeparator, DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
      }

      if (strpos($className, '_') !== false) {
        $className = str_replace('_', DIRECTORY_SEPARATOR, $className);
      }

      $fileName .= $className . $this->_fileExtension;

      return $fileName;
    }

    return null;
  }

  /**
   * Loads the given class or interface.
   *
   * @param string $className The name of the class to load.
   *
   * @throws \Exception
   */
  public function loadClass($className)
  {
    if ($this->_includePath !== null) {
      $path = $this->_includePath . DIRECTORY_SEPARATOR;
    } else {
      $path = '';
    }

    $fileName = $this->resolveFileName($className);

    if ($fileName) {
      $fileNameWithPath = $path . $fileName;

      if (!file_exists($fileNameWithPath)) {
        throw new \Exception('File do not exists: ' . $fileNameWithPath);
      }

      if (!is_readable($fileNameWithPath)) {
        throw new \Exception('Unreadable file: ' . $fileNameWithPath);
      }

      /** @noinspection PhpIncludeInspection */
      require $fileNameWithPath;
    }
  }
}