386 lines
12 KiB
PHP
386 lines
12 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* base include file for SimpleTest
|
||
|
|
* @package SimpleTest
|
||
|
|
* @subpackage UnitTester
|
||
|
|
* @version $Id: reflection_php5.php 2011 2011-04-29 08:22:48Z pp11 $
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Version specific reflection API.
|
||
|
|
* @package SimpleTest
|
||
|
|
* @subpackage UnitTester
|
||
|
|
*/
|
||
|
|
class SimpleReflection {
|
||
|
|
private $interface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stashes the class/interface.
|
||
|
|
* @param string $interface Class or interface
|
||
|
|
* to inspect.
|
||
|
|
*/
|
||
|
|
function __construct($interface) {
|
||
|
|
$this->interface = $interface;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks that a class has been declared. Versions
|
||
|
|
* before PHP5.0.2 need a check that it's not really
|
||
|
|
* an interface.
|
||
|
|
* @return boolean True if defined.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function classExists() {
|
||
|
|
if (! class_exists($this->interface)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
return ! $reflection->isInterface();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Needed to kill the autoload feature in PHP5
|
||
|
|
* for classes created dynamically.
|
||
|
|
* @return boolean True if defined.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function classExistsSansAutoload() {
|
||
|
|
return class_exists($this->interface, false);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks that a class or interface has been
|
||
|
|
* declared.
|
||
|
|
* @return boolean True if defined.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function classOrInterfaceExists() {
|
||
|
|
return $this->classOrInterfaceExistsWithAutoload($this->interface, true);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Needed to kill the autoload feature in PHP5
|
||
|
|
* for classes created dynamically.
|
||
|
|
* @return boolean True if defined.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function classOrInterfaceExistsSansAutoload() {
|
||
|
|
return $this->classOrInterfaceExistsWithAutoload($this->interface, false);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Needed to select the autoload feature in PHP5
|
||
|
|
* for classes created dynamically.
|
||
|
|
* @param string $interface Class or interface name.
|
||
|
|
* @param boolean $autoload True totriggerautoload.
|
||
|
|
* @return boolean True if interface defined.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function classOrInterfaceExistsWithAutoload($interface, $autoload) {
|
||
|
|
if (function_exists('interface_exists')) {
|
||
|
|
if (interface_exists($this->interface, $autoload)) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return class_exists($this->interface, $autoload);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the list of methods on a class or
|
||
|
|
* interface.
|
||
|
|
* @returns array List of method names.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function getMethods() {
|
||
|
|
return array_unique(get_class_methods($this->interface));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the list of interfaces from a class. If the
|
||
|
|
* class name is actually an interface then just that
|
||
|
|
* interface is returned.
|
||
|
|
* @returns array List of interfaces.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function getInterfaces() {
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
if ($reflection->isInterface()) {
|
||
|
|
return array($this->interface);
|
||
|
|
}
|
||
|
|
return $this->onlyParents($reflection->getInterfaces());
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the list of methods for the implemented
|
||
|
|
* interfaces only.
|
||
|
|
* @returns array List of enforced method signatures.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function getInterfaceMethods() {
|
||
|
|
$methods = array();
|
||
|
|
foreach ($this->getInterfaces() as $interface) {
|
||
|
|
$methods = array_merge($methods, get_class_methods($interface));
|
||
|
|
}
|
||
|
|
return array_unique($methods);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks to see if the method signature has to be tightly
|
||
|
|
* specified.
|
||
|
|
* @param string $method Method name.
|
||
|
|
* @returns boolean True if enforced.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isInterfaceMethod($method) {
|
||
|
|
return in_array($method, $this->getInterfaceMethods());
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds the parent class name.
|
||
|
|
* @returns string Parent class name.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function getParent() {
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
$parent = $reflection->getParentClass();
|
||
|
|
if ($parent) {
|
||
|
|
return $parent->getName();
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Trivially determines if the class is abstract.
|
||
|
|
* @returns boolean True if abstract.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function isAbstract() {
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
return $reflection->isAbstract();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Trivially determines if the class is an interface.
|
||
|
|
* @returns boolean True if interface.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function isInterface() {
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
return $reflection->isInterface();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Scans for final methods, as they screw up inherited
|
||
|
|
* mocks by not allowing you to override them.
|
||
|
|
* @returns boolean True if the class has a final method.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function hasFinal() {
|
||
|
|
$reflection = new ReflectionClass($this->interface);
|
||
|
|
foreach ($reflection->getMethods() as $method) {
|
||
|
|
if ($method->isFinal()) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whittles a list of interfaces down to only the
|
||
|
|
* necessary top level parents.
|
||
|
|
* @param array $interfaces Reflection API interfaces
|
||
|
|
* to reduce.
|
||
|
|
* @returns array List of parent interface names.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function onlyParents($interfaces) {
|
||
|
|
$parents = array();
|
||
|
|
$blacklist = array();
|
||
|
|
foreach ($interfaces as $interface) {
|
||
|
|
foreach($interfaces as $possible_parent) {
|
||
|
|
if ($interface->getName() == $possible_parent->getName()) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
if ($interface->isSubClassOf($possible_parent)) {
|
||
|
|
$blacklist[$possible_parent->getName()] = true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!isset($blacklist[$interface->getName()])) {
|
||
|
|
$parents[] = $interface->getName();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $parents;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether a method is abstract or not.
|
||
|
|
* @param string $name Method name.
|
||
|
|
* @return bool true if method is abstract, else false
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isAbstractMethod($name) {
|
||
|
|
$interface = new ReflectionClass($this->interface);
|
||
|
|
if (! $interface->hasMethod($name)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return $interface->getMethod($name)->isAbstract();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether a method is the constructor.
|
||
|
|
* @param string $name Method name.
|
||
|
|
* @return bool true if method is the constructor
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isConstructor($name) {
|
||
|
|
return ($name == '__construct') || ($name == $this->interface);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether a method is abstract in all parents or not.
|
||
|
|
* @param string $name Method name.
|
||
|
|
* @return bool true if method is abstract in parent, else false
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isAbstractMethodInParents($name) {
|
||
|
|
$interface = new ReflectionClass($this->interface);
|
||
|
|
$parent = $interface->getParentClass();
|
||
|
|
while($parent) {
|
||
|
|
if (! $parent->hasMethod($name)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
if ($parent->getMethod($name)->isAbstract()) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
$parent = $parent->getParentClass();
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether a method is static or not.
|
||
|
|
* @param string $name Method name
|
||
|
|
* @return bool true if method is static, else false
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isStaticMethod($name) {
|
||
|
|
$interface = new ReflectionClass($this->interface);
|
||
|
|
if (! $interface->hasMethod($name)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return $interface->getMethod($name)->isStatic();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Writes the source code matching the declaration
|
||
|
|
* of a method.
|
||
|
|
* @param string $name Method name.
|
||
|
|
* @return string Method signature up to last
|
||
|
|
* bracket.
|
||
|
|
* @access public
|
||
|
|
*/
|
||
|
|
function getSignature($name) {
|
||
|
|
if ($name == '__set') {
|
||
|
|
return 'function __set($key, $value)';
|
||
|
|
}
|
||
|
|
if ($name == '__call') {
|
||
|
|
return 'function __call($method, $arguments)';
|
||
|
|
}
|
||
|
|
if (version_compare(phpversion(), '5.1.0', '>=')) {
|
||
|
|
if (in_array($name, array('__get', '__isset', $name == '__unset'))) {
|
||
|
|
return "function {$name}(\$key)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ($name == '__toString') {
|
||
|
|
return "function $name()";
|
||
|
|
}
|
||
|
|
|
||
|
|
// This wonky try-catch is a work around for a faulty method_exists()
|
||
|
|
// in early versions of PHP 5 which would return false for static
|
||
|
|
// methods. The Reflection classes work fine, but hasMethod()
|
||
|
|
// doesn't exist prior to PHP 5.1.0, so we need to use a more crude
|
||
|
|
// detection method.
|
||
|
|
try {
|
||
|
|
$interface = new ReflectionClass($this->interface);
|
||
|
|
$interface->getMethod($name);
|
||
|
|
} catch (ReflectionException $e) {
|
||
|
|
return "function $name()";
|
||
|
|
}
|
||
|
|
return $this->getFullSignature($name);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* For a signature specified in an interface, full
|
||
|
|
* details must be replicated to be a valid implementation.
|
||
|
|
* @param string $name Method name.
|
||
|
|
* @return string Method signature up to last
|
||
|
|
* bracket.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function getFullSignature($name) {
|
||
|
|
$interface = new ReflectionClass($this->interface);
|
||
|
|
$method = $interface->getMethod($name);
|
||
|
|
$reference = $method->returnsReference() ? '&' : '';
|
||
|
|
$static = $method->isStatic() ? 'static ' : '';
|
||
|
|
return "{$static}function $reference$name(" .
|
||
|
|
implode(', ', $this->getParameterSignatures($method)) .
|
||
|
|
")";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the source code for each parameter.
|
||
|
|
* @param ReflectionMethod $method Method object from
|
||
|
|
* reflection API
|
||
|
|
* @return array List of strings, each
|
||
|
|
* a snippet of code.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function getParameterSignatures($method) {
|
||
|
|
$signatures = array();
|
||
|
|
foreach ($method->getParameters() as $parameter) {
|
||
|
|
$signature = '';
|
||
|
|
$type = $parameter->getClass();
|
||
|
|
if (is_null($type) && version_compare(phpversion(), '5.1.0', '>=') && $parameter->isArray()) {
|
||
|
|
$signature .= 'array ';
|
||
|
|
} elseif (!is_null($type)) {
|
||
|
|
$signature .= $type->getName() . ' ';
|
||
|
|
}
|
||
|
|
if ($parameter->isPassedByReference()) {
|
||
|
|
$signature .= '&';
|
||
|
|
}
|
||
|
|
$signature .= '$' . $this->suppressSpurious($parameter->getName());
|
||
|
|
if ($this->isOptional($parameter)) {
|
||
|
|
$signature .= ' = null';
|
||
|
|
}
|
||
|
|
$signatures[] = $signature;
|
||
|
|
}
|
||
|
|
return $signatures;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The SPL library has problems with the
|
||
|
|
* Reflection library. In particular, you can
|
||
|
|
* get extra characters in parameter names :(.
|
||
|
|
* @param string $name Parameter name.
|
||
|
|
* @return string Cleaner name.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function suppressSpurious($name) {
|
||
|
|
return str_replace(array('[', ']', ' '), '', $name);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Test of a reflection parameter being optional
|
||
|
|
* that works with early versions of PHP5.
|
||
|
|
* @param reflectionParameter $parameter Is this optional.
|
||
|
|
* @return boolean True if optional.
|
||
|
|
* @access private
|
||
|
|
*/
|
||
|
|
protected function isOptional($parameter) {
|
||
|
|
if (method_exists($parameter, 'isOptional')) {
|
||
|
|
return $parameter->isOptional();
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
?>
|