1: <?php
 2: /**
 3:  * PHP Token Reflection
 4:  *
 5:  * Version 1.3.1
 6:  *
 7:  * LICENSE
 8:  *
 9:  * This source file is subject to the new BSD license that is bundled
10:  * with this library in the file LICENSE.
11:  *
12:  * @author Ondřej Nešpor
13:  * @author Jaroslav Hanslík
14:  */
15: 
16: namespace TokenReflection;
17: 
18: /**
19:  * Basic TokenReflection interface.
20:  */
21: interface IReflection
22: {
23:     /**
24:      * Returns the name (FQN).
25:      *
26:      * @return string
27:      */
28:     public function getName();
29: 
30:     /**
31:      * Returns if the reflection object is internal.
32:      *
33:      * @return boolean
34:      */
35:     public function isInternal();
36: 
37:     /**
38:      * Returns if the reflection object is user defined.
39:      *
40:      * @return boolean
41:      */
42:     public function isUserDefined();
43: 
44:     /**
45:      * Returns if the current reflection comes from a tokenized source.
46:      *
47:      * @return boolean
48:      */
49:     public function isTokenized();
50: 
51:     /**
52:      * Returns the reflection broker used by this reflection object.
53:      *
54:      * @return \TokenReflection\Broker
55:      */
56:     public function getBroker();
57: 
58:     /**
59:      * Magic __get method.
60:      *
61:      * @param string $key Variable name
62:      * @return mixed
63:      */
64:     public function __get($key);
65: 
66:     /**
67:      * Magic __isset method.
68:      *
69:      * @param string $key Variable name
70:      * @return boolean
71:      */
72:     public function __isset($key);
73: 
74:     /**
75:      * Returns an element pretty (docblock compatible) name.
76:      *
77:      * @return string
78:      */
79:     public function getPrettyName();
80: }
81: