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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?php
/**
* PHP Token Reflection
*
* Version 1.3.1
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this library in the file LICENSE.
*
* @author Ondřej Nešpor
* @author Jaroslav Hanslík
*/
namespace TokenReflection;
/**
* Common reflection constant interface.
*/
interface IReflectionConstant extends IReflection
{
/**
* Returns the unqualified name (UQN).
*
* @return string
*/
public function getShortName();
/**
* Returns the declaring class reflection.
*
* @return \TokenReflection\IReflectionClass
*/
public function getDeclaringClass();
/**
* Returns the declaring class name.
*
* @return string
*/
public function getDeclaringClassName();
/**
* Returns the namespace name.
*
* @return string
*/
public function getNamespaceName();
/**
* Returns if the constant is defined within a namespace.
*
* @return boolean
*/
public function inNamespace();
/**
* Returns imported namespaces and aliases from the declaring namespace.
*
* @return array
*/
public function getNamespaceAliases();
/**
* Returns the file name the reflection object is defined in.
*
* @return string
*/
public function getFileName();
/**
* Returns the definition start line number in the file.
*
* @return integer
*/
public function getStartLine();
/**
* Returns the definition end line number in the file.
*
* @return integer
*/
public function getEndLine();
/**
* Returns the appropriate docblock definition.
*
* @return string|boolean
*/
public function getDocComment();
/**
* Returns the constant value.
*
* @return mixed
*/
public function getValue();
/**
* Returns the part of the source code defining the constant value.
*
* @return string
*/
public function getValueDefinition();
/**
* Returns the string representation of the reflection object.
*
* @return string
*/
public function __toString();
/**
* Returns if the constant definition is valid.
*
* That means that the source code is valid and the constant name is unique within parsed files.
*
* @return boolean
*/
public function isValid();
/**
* Returns if the constant is deprecated.
*
* @return boolean
*/
public function isDeprecated();
}
|
