Autoloader.php in Plug 7

Namespace

Doctrine\Common\Proxy

File

lib/doctrine/common/lib/Doctrine/Common/Proxy/Autoloader.php

<?php

/*
 * 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>.
 */
namespace Doctrine\Common\Proxy;

use Doctrine\Common\Proxy\Exception\InvalidArgumentException;

/**
 * Special Autoloader for Proxy classes, which are not PSR-0 compliant.
 *
 * @author Benjamin Eberlei <[e-mail]>
 */
class Autoloader {

  /**
   * Resolves proxy class name to a filename based on the following pattern.
   *
   * 1. Remove Proxy namespace from class name.
   * 2. Remove namespace separators from remaining class name.
   * 3. Return PHP filename from proxy-dir with the result from 2.
   *
   * @param string $proxyDir
   * @param string $proxyNamespace
   * @param string $className
   *
   * @return string
   *
   * @throws InvalidArgumentException
   */
  public static function resolveFile($proxyDir, $proxyNamespace, $className) {
    if (0 !== strpos($className, $proxyNamespace)) {
      throw InvalidArgumentException::notProxyClass($className, $proxyNamespace);
    }
    $className = str_replace('\\', '', substr($className, strlen($proxyNamespace) + 1));
    return $proxyDir . DIRECTORY_SEPARATOR . $className . '.php';
  }

  /**
   * Registers and returns autoloader callback for the given proxy dir and namespace.
   *
   * @param string        $proxyDir
   * @param string        $proxyNamespace
   * @param callable|null $notFoundCallback Invoked when the proxy file is not found.
   *
   * @return \Closure
   *
   * @throws InvalidArgumentException
   */
  public static function register($proxyDir, $proxyNamespace, $notFoundCallback = null) {
    $proxyNamespace = ltrim($proxyNamespace, '\\');
    if (!(null === $notFoundCallback || is_callable($notFoundCallback))) {
      throw InvalidArgumentException::invalidClassNotFoundCallback($notFoundCallback);
    }
    $autoloader = function ($className) use ($proxyDir, $proxyNamespace, $notFoundCallback) {
      if (0 === strpos($className, $proxyNamespace)) {
        $file = Autoloader::resolveFile($proxyDir, $proxyNamespace, $className);
        if ($notFoundCallback && !file_exists($file)) {
          call_user_func($notFoundCallback, $proxyDir, $proxyNamespace, $className);
        }
        require $file;
      }
    };
    spl_autoload_register($autoloader);
    return $autoloader;
  }

}

Classes

Name	Description
Autoloader	Special Autoloader for Proxy classes, which are not PSR-0 compliant.