95 lines
3.2 KiB
PHP
95 lines
3.2 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of Psy Shell
|
|
*
|
|
* (c) 2012-2014 Justin Hileman
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Psy\Util;
|
|
|
|
use Psy\Exception\RuntimeException;
|
|
use Psy\Reflection\ReflectionConstant;
|
|
|
|
/**
|
|
* A utility class for getting Reflectors.
|
|
*/
|
|
class Mirror
|
|
{
|
|
const CONSTANT = 1;
|
|
const METHOD = 2;
|
|
const STATIC_PROPERTY = 4;
|
|
const PROPERTY = 8;
|
|
|
|
/**
|
|
* Get a Reflector for a function, class or instance, constant, method or property.
|
|
*
|
|
* Optionally, pass a $filter param to restrict the types of members checked. For example, to only Reflectors for
|
|
* static properties and constants, pass:
|
|
*
|
|
* $filter = Mirror::CONSTANT | Mirror::STATIC_PROPERTY
|
|
*
|
|
* @throws \Psy\Exception\RuntimeException when a $member specified but not present on $value.
|
|
* @throws \InvalidArgumentException if $value is something other than an object or class/function name.
|
|
*
|
|
* @param mixed $value Class or function name, or variable instance.
|
|
* @param string $member Optional: property, constant or method name (default: null)
|
|
* @param int $filter (default: CONSTANT | METHOD | PROPERTY | STATIC_PROPERTY)
|
|
*
|
|
* @return Reflector
|
|
*/
|
|
public static function get($value, $member = null, $filter = 15)
|
|
{
|
|
if ($member === null && is_string($value) && function_exists($value)) {
|
|
return new \ReflectionFunction($value);
|
|
}
|
|
|
|
$class = self::getClass($value);
|
|
|
|
if ($member === null) {
|
|
return $class;
|
|
} elseif ($filter & self::CONSTANT && $class->hasConstant($member)) {
|
|
return new ReflectionConstant($class, $member);
|
|
} elseif ($filter & self::METHOD && $class->hasMethod($member)) {
|
|
return $class->getMethod($member);
|
|
} elseif ($filter & self::PROPERTY && $class->hasProperty($member)) {
|
|
return $class->getProperty($member);
|
|
} elseif ($filter & self::STATIC_PROPERTY && $class->hasProperty($member) && $class->getProperty($member)->isStatic()) {
|
|
return $class->getProperty($member);
|
|
} else {
|
|
throw new RuntimeException(sprintf(
|
|
'Unknown member %s on class %s',
|
|
$member,
|
|
is_object($value) ? get_class($value) : $value
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get a ReflectionClass (or ReflectionObject) if possible.
|
|
*
|
|
* @throws \InvalidArgumentException if $value is not a class name or instance.
|
|
*
|
|
* @param mixed $value
|
|
*
|
|
* @return \ReflectionClass
|
|
*/
|
|
private static function getClass($value)
|
|
{
|
|
if (is_object($value)) {
|
|
return new \ReflectionObject($value);
|
|
}
|
|
|
|
if (!is_string($value)) {
|
|
throw new \InvalidArgumentException('Mirror expects an object or class');
|
|
} elseif (!class_exists($value) && !interface_exists($value) && !(function_exists('trait_exists') && trait_exists($value))) {
|
|
throw new \InvalidArgumentException('Unknown class or function: ' . $value);
|
|
}
|
|
|
|
return new \ReflectionClass($value);
|
|
}
|
|
}
|