Method.php
5.27 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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Reflection
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: Method.php 23775 2011-03-01 17:25:24Z ralph $
*/
/**
* @see Zend_Reflection_Class
*/
require_once 'Zend/Reflection/Class.php';
/**
* @see Zend_Reflection_Docblock
*/
require_once 'Zend/Reflection/Docblock.php';
/**
* @see Zend_Reflection_Parameter
*/
require_once 'Zend/Reflection/Parameter.php';
/**
* @category Zend
* @package Zend_Reflection
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Reflection_Method extends ReflectionMethod
{
/**
* Retrieve method docblock reflection
*
* @return Zend_Reflection_Docblock
* @throws Zend_Reflection_Exception
*/
public function getDocblock($reflectionClass = 'Zend_Reflection_Docblock')
{
if ('' == $this->getDocComment()) {
require_once 'Zend/Reflection/Exception.php';
throw new Zend_Reflection_Exception($this->getName() . ' does not have a docblock');
}
$instance = new $reflectionClass($this);
if (!$instance instanceof Zend_Reflection_Docblock) {
require_once 'Zend/Reflection/Exception.php';
throw new Zend_Reflection_Exception('Invalid reflection class provided; must extend Zend_Reflection_Docblock');
}
return $instance;
}
/**
* Get start line (position) of method
*
* @param bool $includeDocComment
* @return int
*/
public function getStartLine($includeDocComment = false)
{
if ($includeDocComment) {
if ($this->getDocComment() != '') {
return $this->getDocblock()->getStartLine();
}
}
return parent::getStartLine();
}
/**
* Get reflection of declaring class
*
* @param string $reflectionClass Name of reflection class to use
* @return Zend_Reflection_Class
*/
public function getDeclaringClass($reflectionClass = 'Zend_Reflection_Class')
{
$phpReflection = parent::getDeclaringClass();
$zendReflection = new $reflectionClass($phpReflection->getName());
if (!$zendReflection instanceof Zend_Reflection_Class) {
require_once 'Zend/Reflection/Exception.php';
throw new Zend_Reflection_Exception('Invalid reflection class provided; must extend Zend_Reflection_Class');
}
unset($phpReflection);
return $zendReflection;
}
/**
* Get all method parameter reflection objects
*
* @param string $reflectionClass Name of reflection class to use
* @return array of Zend_Reflection_Parameter objects
*/
public function getParameters($reflectionClass = 'Zend_Reflection_Parameter')
{
$phpReflections = parent::getParameters();
$zendReflections = array();
while ($phpReflections && ($phpReflection = array_shift($phpReflections))) {
$instance = new $reflectionClass(array($this->getDeclaringClass()->getName(), $this->getName()), $phpReflection->getName());
if (!$instance instanceof Zend_Reflection_Parameter) {
require_once 'Zend/Reflection/Exception.php';
throw new Zend_Reflection_Exception('Invalid reflection class provided; must extend Zend_Reflection_Parameter');
}
$zendReflections[] = $instance;
unset($phpReflection);
}
unset($phpReflections);
return $zendReflections;
}
/**
* Get method contents
*
* @param bool $includeDocblock
* @return string
*/
public function getContents($includeDocblock = true)
{
$fileContents = file($this->getFileName());
$startNum = $this->getStartLine($includeDocblock);
$endNum = ($this->getEndLine() - $this->getStartLine());
return implode("\n", array_splice($fileContents, $startNum, $endNum, true));
}
/**
* Get method body
*
* @return string
*/
public function getBody()
{
$lines = array_slice(
file($this->getDeclaringClass()->getFileName(), FILE_IGNORE_NEW_LINES),
$this->getStartLine(),
($this->getEndLine() - $this->getStartLine()),
true
);
$firstLine = array_shift($lines);
if (trim($firstLine) !== '{') {
array_unshift($lines, $firstLine);
}
$lastLine = array_pop($lines);
if (trim($lastLine) !== '}') {
array_push($lines, $lastLine);
}
// just in case we had code on the bracket lines
return rtrim(ltrim(implode("\n", $lines), '{'), '}');
}
}