Autoloader.php 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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. namespace Doctrine\Common\Proxy;
  20. use Doctrine\Common\Proxy\Exception\InvalidArgumentException;
  21. /**
  22. * Special Autoloader for Proxy classes, which are not PSR-0 compliant.
  23. *
  24. * @author Benjamin Eberlei <kontakt@beberlei.de>
  25. */
  26. class Autoloader
  27. {
  28. /**
  29. * Resolves proxy class name to a filename based on the following pattern.
  30. *
  31. * 1. Remove Proxy namespace from class name.
  32. * 2. Remove namespace separators from remaining class name.
  33. * 3. Return PHP filename from proxy-dir with the result from 2.
  34. *
  35. * @param string $proxyDir
  36. * @param string $proxyNamespace
  37. * @param string $className
  38. *
  39. * @return string
  40. *
  41. * @throws InvalidArgumentException
  42. */
  43. public static function resolveFile($proxyDir, $proxyNamespace, $className)
  44. {
  45. if (0 !== strpos($className, $proxyNamespace)) {
  46. throw InvalidArgumentException::notProxyClass($className, $proxyNamespace);
  47. }
  48. // remove proxy namespace from class name
  49. $classNameRelativeToProxyNamespace = substr($className, strlen($proxyNamespace));
  50. // remove namespace separators from remaining class name
  51. $fileName = str_replace('\\', '', $classNameRelativeToProxyNamespace);
  52. return $proxyDir . DIRECTORY_SEPARATOR . $fileName . '.php';
  53. }
  54. /**
  55. * Registers and returns autoloader callback for the given proxy dir and namespace.
  56. *
  57. * @param string $proxyDir
  58. * @param string $proxyNamespace
  59. * @param callable|null $notFoundCallback Invoked when the proxy file is not found.
  60. *
  61. * @return \Closure
  62. *
  63. * @throws InvalidArgumentException
  64. */
  65. public static function register($proxyDir, $proxyNamespace, $notFoundCallback = null)
  66. {
  67. $proxyNamespace = ltrim($proxyNamespace, '\\');
  68. if ( ! (null === $notFoundCallback || is_callable($notFoundCallback))) {
  69. throw InvalidArgumentException::invalidClassNotFoundCallback($notFoundCallback);
  70. }
  71. $autoloader = function ($className) use ($proxyDir, $proxyNamespace, $notFoundCallback) {
  72. if (0 === strpos($className, $proxyNamespace)) {
  73. $file = Autoloader::resolveFile($proxyDir, $proxyNamespace, $className);
  74. if ($notFoundCallback && ! file_exists($file)) {
  75. call_user_func($notFoundCallback, $proxyDir, $proxyNamespace, $className);
  76. }
  77. require $file;
  78. }
  79. };
  80. spl_autoload_register($autoloader);
  81. return $autoloader;
  82. }
  83. }