Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[DDC-1698] Add autoloader especially for the non PSR-0 Proxy class na…

…mes. This is necessary when you want to deserialize your proxy classes from the session.
  • Loading branch information...
commit 9b4d60897dfc7e9b165712428539e694ec596c80 1 parent c6ef7a7
@beberlei beberlei authored
View
78 lib/Doctrine/ORM/Proxy/Autoloader.php
@@ -0,0 +1,78 @@
+<?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 LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\ORM\Proxy;
+
+/**
+ * Special Autoloader for Proxy classes because them not being PSR-0 compatible.
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ */
+class Autoloader
+{
+ /**
+ * Resolve proxy class name to a filename based on the following pattern.
+ *
+ * 1. Remove Proxy namespace from class name
+ * 2. Remove namespace seperators 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
+ */
+ static public function resolveFile($proxyDir, $proxyNamespace, $className)
+ {
+ if (0 !== strpos($className, $proxyNamespace)) {
+ throw ProxyException::notProxyClass($className, $proxyNamespace);
+ }
+
+ $className = str_replace('\\', '', substr($className, strlen($proxyNamespace) +1));
+ return $proxyDir . DIRECTORY_SEPARATOR . $className.'.php';
+ }
+
+ /**
+ * Register and return autoloader callback for the given proxy dir and
+ * namespace.
+ *
+ * @param string $proxyDir
+ * @param string $proxyNamespace
+ * @param Closure $notFoundCallback Invoked when the proxy file is not found.
+ * @return Closure
+ */
+ static public function register($proxyDir, $proxyNamespace, \Closure $notFoundCallback = null)
+ {
+ $proxyNamespace = ltrim($proxyNamespace, "\\");
+ $autoloader = function($className) use ($proxyDir, $proxyNamespace, $notFoundCallback) {
+ if (0 === strpos($className, $proxyNamespace)) {
+ $file = Autoloader::resolveFile($proxyDir, $proxyNamespace, $className);
+
+ if ($notFoundCallback && ! file_exists($file)) {
+ $notFoundCallback($proxyDir, $proxyNamespace, $className);
+ }
+
+ require $file;
+ }
+ };
+ spl_autoload_register($autoloader);
+ return $autoloader;
+ }
+}
+
View
10 lib/Doctrine/ORM/Proxy/ProxyException.php
@@ -44,4 +44,12 @@ public static function proxyNamespaceRequired() {
return new self("You must configure a proxy namespace. See docs for details");
}
-}
+ public static function notProxyClass($className, $proxyNamespace)
+ {
+ return new self(sprintf(
+ "The class %s is not part of the proxy namespace %s",
+ $className, $proxyNamespace
+ ));
+ }
+
+}
View
62 tests/Doctrine/Tests/ORM/Proxy/AutoloaderTest.php
@@ -0,0 +1,62 @@
+<?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 LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Tests\ORM\Proxy;
+
+use Doctrine\Tests\OrmTestCase;
+use Doctrine\ORM\Proxy\Autoloader;
+
+/**
+ * @group DDC-1698
+ */
+class AutoloaderTest extends OrmTestCase
+{
+ static public function dataResolveFile()
+ {
+ return array(
+ array('/tmp', 'MyProxy', 'MyProxy\__CG__\RealClass', '/tmp/__CG__RealClass.php'),
+ array('/tmp', 'MyProxy\Subdir', 'MyProxy\Subdir\__CG__\RealClass', '/tmp/__CG__RealClass.php'),
+ array('/tmp', 'MyProxy', 'MyProxy\__CG__\Other\RealClass', '/tmp/__CG__OtherRealClass.php'),
+ );
+ }
+
+ /**
+ * @dataProvider dataResolveFile
+ */
+ public function testResolveFile($proxyDir, $proxyNamespace, $className, $expectedProxyFile)
+ {
+ $actualProxyFile = Autoloader::resolveFile($proxyDir, $proxyNamespace, $className);
+ $this->assertEquals($expectedProxyFile, $actualProxyFile);
+ }
+
+ public function testAutoload()
+ {
+ if (file_exists(sys_get_temp_dir() ."/AutoloaderTestClass.php")) {
+ unlink(sys_get_temp_dir() ."/AutoloaderTestClass.php");
+ }
+
+ $autoloader = Autoloader::register(sys_get_temp_dir(), 'ProxyAutoloaderTest', function($proxyDir, $proxyNamespace, $className) {
+ file_put_contents(sys_get_temp_dir() . "/AutoloaderTestClass.php", "<?php namespace ProxyAutoloaderTest; class AutoloaderTestClass {} ");
+ });
+
+ $this->assertTrue(class_exists('ProxyAutoloaderTest\AutoloaderTestClass', true));
+ unlink(sys_get_temp_dir() ."/AutoloaderTestClass.php");
+ }
+}
+
Please sign in to comment.
Something went wrong with that request. Please try again.