yaffs.net Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/Proxy/Autoloader.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Proxy;
  21
  22 use Doctrine\Common\Proxy\Exception\InvalidArgumentException;
  23
  24 /**
  25  * Special Autoloader for Proxy classes, which are not PSR-0 compliant.
  26  *
  27  * @author Benjamin Eberlei <kontakt@beberlei.de>
  28  */
  29 class Autoloader
  30 {
  31     /**
  32      * Resolves proxy class name to a filename based on the following pattern.
  33      *
  34      * 1. Remove Proxy namespace from class name.
  35      * 2. Remove namespace separators from remaining class name.
  36      * 3. Return PHP filename from proxy-dir with the result from 2.
  37      *
  38      * @param string $proxyDir
  39      * @param string $proxyNamespace
  40      * @param string $className
  41      *
  42      * @return string
  43      *
  44      * @throws InvalidArgumentException
  45      */
  46     public static function resolveFile($proxyDir, $proxyNamespace, $className)
  47     {
  48         if (0 !== strpos($className, $proxyNamespace)) {
  49             throw InvalidArgumentException::notProxyClass($className, $proxyNamespace);
  50         }
  51
  52         // remove proxy namespace from class name
  53         $classNameRelativeToProxyNamespace = substr($className, strlen($proxyNamespace));
  54
  55         // remove namespace separators from remaining class name
  56         $fileName = str_replace('\\', '', $classNameRelativeToProxyNamespace);
  57
  58         return $proxyDir . DIRECTORY_SEPARATOR . $fileName . '.php';
  59     }
  60
  61     /**
  62      * Registers and returns autoloader callback for the given proxy dir and namespace.
  63      *
  64      * @param string        $proxyDir
  65      * @param string        $proxyNamespace
  66      * @param callable|null $notFoundCallback Invoked when the proxy file is not found.
  67      *
  68      * @return \Closure
  69      *
  70      * @throws InvalidArgumentException
  71      */
  72     public static function register($proxyDir, $proxyNamespace, $notFoundCallback = null)
  73     {
  74         $proxyNamespace = ltrim($proxyNamespace, '\\');
  75
  76         if ( ! (null === $notFoundCallback || is_callable($notFoundCallback))) {
  77             throw InvalidArgumentException::invalidClassNotFoundCallback($notFoundCallback);
  78         }
  79
  80         $autoloader = function ($className) use ($proxyDir, $proxyNamespace, $notFoundCallback) {
  81             if (0 === strpos($className, $proxyNamespace)) {
  82                 $file = Autoloader::resolveFile($proxyDir, $proxyNamespace, $className);
  83
  84                 if ($notFoundCallback && ! file_exists($file)) {
  85                     call_user_func($notFoundCallback, $proxyDir, $proxyNamespace, $className);
  86                 }
  87
  88                 require $file;
  89             }
  90         };
  91
  92         spl_autoload_register($autoloader);
  93
  94         return $autoloader;
  95     }
  96 }