Mirror.php
3.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?php
/*
* This file is part of Psy Shell.
*
* (c) 2012-2015 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);
}
}