Remove Zend\Stdlib\SubClass

weierophinney · weierophinney · commit 387c5294e00b · 2012-07-11T17:26:04.000-05:00
The main reason for this class was to work around changes in PHP between versions 5.3.3 and 5.3.7 regarding how is_subclass_of() works. In the earlier versions, it was buggy. In 5.3.7 and up, the bugs are fixed, and the solution is very fast. There are very few places in the framework where an is_subclass_of() test makes sense, and those are typically only with classes responsible for creating other classes -- factories, primarily. As such, the number of places where this will be of use is minimal, and can be maintained. The main goal is to have a consistent, performant way to do the check when required, and one which will work with case sensitive contexts. The solution by @prolic in zendframework#1807 is good; we just don't need to abstract this, particularly as we'll be able to remove this entirely in ZF3. Additionally, abstracting it gives additional dependencies for those components needing it, and in cases like autoloaders, DI, and the service manager, the extra dependency is undesirable as these should stand alone. The code has been duplicated into each class requiring the lookup (I put the check into AbstractPluginManager, as it's not unlikely other plugin managers may need this).
diff --git a/library/Zend/Di/Di.php b/library/Zend/Di/Di.php
@@ -11,7 +11,7 @@
 namespace Zend\Di;
 
 use Closure;
-use Zend\Stdlib\SubClass;
+use ReflectionClass;
 
 class Di implements DependencyInjectionInterface
 {
@@ -310,7 +310,7 @@ protected function handleInjectDependencies($instance, $injectionMethods, $param
                                         if ($methodParams) {
                                             foreach ($methodParams as $methodParam) {
                                                 $objectToInjectClass = $this->getClass($objectToInject);
-                                                if ($objectToInjectClass == $methodParam[1] || SubClass::isSubclassOf($objectToInjectClass, $methodParam[1])) {
+                                                if ($objectToInjectClass == $methodParam[1] || self::isSubclassOf($objectToInjectClass, $methodParam[1])) {
                                                     if ($this->resolveAndCallInjectionMethodForInstance($instance, $typeInjectionMethod, array($methodParam[0] => $objectToInject), $instanceAlias, true, $type)) {
                                                         $calledMethods[$typeInjectionMethod] = true;
                                                     }
@@ -583,7 +583,7 @@ protected function resolveMethodParameters($class, $method, array $callTimeUserP
                     }
                     $pInstanceClass = ($this->instanceManager->hasAlias($pInstance)) ?
                          $this->instanceManager->getClassFromAlias($pInstance) : $pInstance;
-                    if ($pInstanceClass === $type || SubClass::isSubclassOf($pInstanceClass, $type)) {
+                    if ($pInstanceClass === $type || self::isSubclassOf($pInstanceClass, $type)) {
                         $computedParams['required'][$fqParamPos] = array($pInstance, $pInstanceClass);
                         continue 2;
                     }
@@ -600,7 +600,7 @@ protected function resolveMethodParameters($class, $method, array $callTimeUserP
                     }
                     $pInstanceClass = ($this->instanceManager->hasAlias($pInstance)) ?
                          $this->instanceManager->getClassFromAlias($pInstance) : $pInstance;
-                    if ($pInstanceClass === $type || SubClass::isSubclassOf($pInstanceClass, $type)) {
+                    if ($pInstanceClass === $type || self::isSubclassOf($pInstanceClass, $type)) {
                         $computedParams['required'][$fqParamPos] = array($pInstance, $pInstanceClass);
                         continue 2;
                     }
@@ -682,4 +682,27 @@ protected function getClass($instance)
         return get_class($instance);
     }
 
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/Form/Annotation/AnnotationBuilder.php b/library/Zend/Form/Annotation/AnnotationBuilder.php
@@ -11,6 +11,7 @@
 namespace Zend\Form\Annotation;
 
 use ArrayObject;
+use ReflectionClass;
 use Zend\Code\Annotation\AnnotationCollection;
 use Zend\Code\Annotation\AnnotationManager;
 use Zend\Code\Annotation\Parser;
@@ -22,7 +23,6 @@
 use Zend\Form\Exception;
 use Zend\Form\Factory;
 use Zend\Stdlib\ArrayUtils;
-use Zend\Stdlib\SubClass;
 
 /**
  * Parses a class' properties for annotations in order to create a form and
@@ -329,7 +329,7 @@ protected function configureElement($annotations, $reflection, $formSpec, $filte
             : 'Zend\Form\Element';
 
         // Compose as a fieldset or an element, based on specification type
-        if (SubClass::isSubclassOf($type, 'Zend\Form\FieldsetInterface')) {
+        if (self::isSubclassOf($type, 'Zend\Form\FieldsetInterface')) {
             if (!isset($formSpec['fieldsets'])) {
                 $formSpec['fieldsets'] = array();
             }
@@ -376,4 +376,27 @@ protected function checkForExclude($annotations)
         return (bool) $results->last();
     }
 
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/Form/Factory.php b/library/Zend/Form/Factory.php
@@ -17,7 +17,6 @@
 use Zend\InputFilter\InputFilterInterface;
 use Zend\Stdlib\ArrayUtils;
 use Zend\Stdlib\Hydrator;
-use Zend\Stdlib\SubClass;
 
 /**
  * @category   Zend
@@ -73,15 +72,15 @@ public function create($spec)
         $spec = $this->validateSpecification($spec, __METHOD__);
         $type = isset($spec['type']) ? $spec['type'] : 'Zend\Form\Element';
 
-        if (SubClass::isSubclassOf($type, 'Zend\Form\FormInterface')) {
+        if (self::isSubclassOf($type, 'Zend\Form\FormInterface')) {
             return $this->createForm($spec);
         }
 
-        if (SubClass::isSubclassOf($type, 'Zend\Form\FieldsetInterface')) {
+        if (self::isSubclassOf($type, 'Zend\Form\FieldsetInterface')) {
             return $this->createFieldset($spec);
         }
 
-        if (SubClass::isSubclassOf($type, 'Zend\Form\ElementInterface')) {
+        if (self::isSubclassOf($type, 'Zend\Form\ElementInterface')) {
             return $this->createElement($spec);
         }
 
@@ -456,4 +455,28 @@ protected function prepareAndInjectValidationGroup($spec, FormInterface $form, $
 
         $form->setValidationGroup($spec);
     }
+
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/InfoCard/XML/AbstractElement.php b/library/Zend/InfoCard/XML/AbstractElement.php
@@ -12,7 +12,6 @@
 
 use DOMElement;
 use SimpleXMLElement;
-use Zend\Stdlib\SubClass;
 
 /**
  * An abstract class representing a an XML data block
@@ -68,7 +67,7 @@ static public function convertToObject(\DOMElement $e, $classname)
             throw new Exception\InvalidArgumentException('Class provided for converting does not exist');
         }
 
-        if (!SubClass::isSubclassOf($classname, 'Zend\InfoCard\XML\ElementInterface')) {
+        if (!self::isSubclassOf($classname, 'Zend\InfoCard\XML\ElementInterface')) {
             throw new Exception\InvalidArgumentException("DOM element must be converted to an instance of Zend_InfoCard_Xml_Element");
         }
 
@@ -83,4 +82,28 @@ static public function convertToObject(\DOMElement $e, $classname)
 
         return $sxe;
     }
+
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/Loader/AutoloaderFactory.php b/library/Zend/Loader/AutoloaderFactory.php
@@ -90,7 +90,7 @@ public static function factory($options = null)
                 }
 
                 require_once __DIR__ . '/../Stdlib/SubClass.php';
-                if (!\Zend\Stdlib\SubClass::isSubclassOf($class, 'Zend\Loader\SplAutoloader')) {
+                if (!self::isSubclassOf($class, 'Zend\Loader\SplAutoloader')) {
                     require_once 'Exception/InvalidArgumentException.php';
                     throw new Exception\InvalidArgumentException(
                         sprintf('Autoloader class %s must implement Zend\\Loader\\SplAutoloader', $class)
@@ -195,4 +195,28 @@ protected static function getStandardAutoloader()
         static::$standardAutoloader = $loader;
         return static::$standardAutoloader;
     }
+
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/Mvc/Router/RoutePluginManager.php b/library/Zend/Mvc/Router/RoutePluginManager.php
@@ -10,7 +10,6 @@
 
 namespace Zend\Mvc\Router;
 
-use Zend\Stdlib\SubClass;
 use Zend\ServiceManager\AbstractPluginManager;
 
 /**
@@ -80,7 +79,7 @@ protected function createFromInvokable($canonicalName, $requestedName)
             ));
         }
 
-        if (!SubClass::isSubclassOf($invokable, __NAMESPACE__ . '\RouteInterface')) {
+        if (!self::isSubclassOf($invokable, __NAMESPACE__ . '\RouteInterface')) {
             throw new Exception\RuntimeException(sprintf(
                 '%s: failed retrieving "%s%s" via invokable class "%s"; class does not implement %s\RouteInterface',
                 __METHOD__,
diff --git a/library/Zend/ServiceManager/AbstractPluginManager.php b/library/Zend/ServiceManager/AbstractPluginManager.php
@@ -180,4 +180,27 @@ protected function createFromInvokable($canonicalName, $requestedName)
         return $instance;
     }
 
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/library/Zend/XmlRpc/Server.php b/library/Zend/XmlRpc/Server.php
@@ -13,7 +13,6 @@
 use Zend\Server\AbstractServer;
 use Zend\Server\Definition;
 use Zend\Server\Reflection;
-use Zend\Stdlib\SubClass;
 
 /**
  * An XML-RPC server implementation
@@ -439,7 +438,7 @@ public function getResponse()
      */
     public function setResponseClass($class)
     {
-        if (!class_exists($class) || !SubClass::isSubclassOf($class, 'Zend\XmlRpc\Response')) {
+        if (!class_exists($class) || !self::isSubclassOf($class, 'Zend\XmlRpc\Response')) {
             throw new Server\Exception\InvalidArgumentException('Invalid response class');
 
         }
@@ -588,4 +587,28 @@ protected function registerSystemMethods()
         $this->_system = $system;
         $this->setClass($system, 'system');
     }
+
+    /**
+     * Checks if the object has this class as one of its parents
+     *
+     * @see https://bugs.php.net/bug.php?id=53727
+     * @see https://github.com/zendframework/zf2/pull/1807
+     *
+     * @param string $className
+     * @param string $type
+     */
+    protected static function isSubclassOf($className, $type)
+    {
+        if (version_compare(PHP_VERSION, '5.3.7', '>=')) {
+            return is_subclass_of($className, $type);
+        }
+        if (is_subclass_of($className, $type)) {
+            return true;
+        }
+        if (!interface_exists($type)) {
+            return false;
+        }
+        $r = new ReflectionClass($className);
+        return $r->implementsInterface($type);
+    }
 }
diff --git a/tests/Zend/Stdlib/SubClassTest.php b/tests/Zend/Stdlib/SubClassTest.php
diff --git a/tests/Zend/Stdlib/TestAsset/DummySubclasses.php b/tests/Zend/Stdlib/TestAsset/DummySubclasses.php
