-
Notifications
You must be signed in to change notification settings - Fork 238
/
Help.php
322 lines (279 loc) · 8.57 KB
/
Help.php
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2013, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\console\command;
use lithium\core\Libraries;
use lithium\core\Environment;
use lithium\util\Inflector;
use lithium\analysis\Inspector;
use lithium\analysis\Docblock;
/**
* Get information about a particular class including methods, properties,
* and descriptions.
*/
class Help extends \lithium\console\Command {
/**
* Auto run the help command.
*
* @param string $command Name of the command to return help about.
* @return void
*/
public function run($command = null) {
$message = 'Lithium console started in the ' . Environment::get() . ' environment.';
$message .= ' Use the --env=environment key to alter this.';
$this->out($message);
if (!$command) {
$this->_renderCommands();
return true;
}
if (!preg_match('/\\\\/', $command)) {
$command = Inflector::camelize($command);
}
if (!$class = Libraries::locate('command', $command)) {
$this->error("Command `{$command}` not found");
return false;
}
if (strpos($command, '\\') !== false) {
$command = join('', array_slice(explode("\\", $command), -1));
}
$command = strtolower(Inflector::slug($command));
$run = null;
$methods = $this->_methods($class);
$properties = $this->_properties($class);
$info = Inspector::info($class);
$this->out('USAGE', 'heading');
if (isset($methods['run'])) {
$run = $methods['run'];
unset($methods['run']);
$this->_renderUsage($command, $run, $properties);
}
foreach ($methods as $method) {
$this->_renderUsage($command, $method);
}
if (!empty($info['description'])) {
$this->nl();
$this->_renderDescription($info);
$this->nl();
}
if ($properties || $methods) {
$this->out('OPTIONS', 'heading');
}
if ($run) {
$this->_render($run['args']);
}
if ($methods) {
$this->_render($methods);
}
if ($properties) {
$this->_render($properties);
}
return true;
}
/**
* Gets the API for the class.
*
* @param string $class fully namespaced class in dot notation.
* @param string $type method|property
* @param string $name the name of the method or property.
* @return array
*/
public function api($class = null, $type = null, $name = null) {
$class = str_replace(".", "\\", $class);
switch ($type) {
default:
$info = Inspector::info($class);
$result = array('class' => array(
'name' => $info['shortName'],
'description' => trim($info['description'] . PHP_EOL . PHP_EOL . $info['text'])
));
break;
case 'method':
$result = $this->_methods($class, compact('name'));
break;
case 'property':
$result = $this->_properties($class, compact('name'));
break;
}
$this->_render($result);
}
/**
* Get the methods for the class.
*
* @param string $class
* @param array $options
* @return array
*/
protected function _methods($class, $options = array()) {
$defaults = array('name' => null);
$options += $defaults;
$map = function($item) {
if ($item->name[0] === '_') {
return;
}
$modifiers = array_values(Inspector::invokeMethod('_modifiers', array($item)));
$setAccess = array_intersect($modifiers, array('private', 'protected')) != array();
if ($setAccess) {
$item->setAccessible(true);
}
$args = array();
foreach ($item->getParameters() as $arg) {
$args[] = array(
'name' => $arg->getName(),
'optional' => $arg->isOptional(),
'description' => null
);
}
$result = compact('modifiers', 'args') + array(
'docComment' => $item->getDocComment(),
'name' => $item->getName()
);
if ($setAccess) {
$item->setAccessible(false);
}
return $result;
};
$methods = Inspector::methods($class)->map($map, array('collect' => false));
$results = array();
foreach (array_filter($methods) as $method) {
$comment = Docblock::comment($method['docComment']);
$name = $method['name'];
$description = trim($comment['description'] . PHP_EOL . $comment['text']);
$args = $method['args'];
$return = null;
foreach ($args as &$arg) {
if (isset($comment['tags']['params']['$' . $arg['name']])) {
$arg['description'] = $comment['tags']['params']['$' . $arg['name']]['text'];
}
$arg['usage'] = $arg['optional'] ? "[<{$arg['name']}>]" : "<{$arg['name']}>";
}
if (isset($comment['tags']['return'])) {
$return = trim(strtok($comment['tags']['return'], ' '));
}
$results[$name] = compact('name', 'description', 'return', 'args');
if ($name && $name == $options['name']) {
return array($name => $results[$name]);
}
}
return $results;
}
/**
* Get the properties for the class.
*
* @param string $class
* @param array $options
* @return array
*/
protected function _properties($class, $options = array()) {
$defaults = array('name' => null);
$options += $defaults;
$properties = Inspector::properties($class);
$results = array();
foreach ($properties as &$property) {
$name = str_replace('_', '-', Inflector::underscore($property['name']));
$comment = Docblock::comment($property['docComment']);
$description = trim($comment['description']);
$type = isset($comment['tags']['var']) ? strtok($comment['tags']['var'], ' ') : null;
$usage = strlen($name) == 1 ? "-{$name}" : "--{$name}";
if ($type != 'boolean') {
$usage .= "=<{$type}>";
}
$usage = "[{$usage}]";
$results[$name] = compact('name', 'description', 'type', 'usage');
if ($name == $options['name']) {
return array($name => $results[$name]);
}
}
return $results;
}
/**
* Output the formatted properties or methods.
*
* @see lithium\console\command\Help::_properties()
* @see lithium\console\command\Help::_methods()
* @param array $params From `_properties()` or `_methods()`.
* @return void
*/
protected function _render($params) {
foreach ($params as $name => $param) {
if ($name === 'run' || empty($param['name'])) {
continue;
}
$usage = (!empty($param['usage'])) ? trim($param['usage'], ' []') : $param['name'];
$this->out($this->_pad($usage), 'option');
if ($param['description']) {
$this->out($this->_pad($param['description'], 2));
}
$this->nl();
}
}
/**
* Output the formatted available commands.
*
* @return void
*/
protected function _renderCommands() {
$commands = Libraries::locate('command', null, array('recursive' => false));
foreach ($commands as $key => $command) {
$library = strtok($command, '\\');
if (!$key || strtok($commands[$key - 1] , '\\') != $library) {
$this->out("{:heading}COMMANDS{:end} {:blue}via {$library}{:end}");
}
$info = Inspector::info($command);
$name = strtolower(Inflector::slug($info['shortName']));
$this->out($this->_pad($name) , 'heading');
$this->out($this->_pad($info['description']), 2);
}
$message = 'See `{:command}li3 help COMMAND{:end}`';
$message .= ' for more information on a specific command.';
$this->out($message, 2);
}
/**
* Output the formatted usage.
*
* @see lithium\console\command\Help::_methods()
* @see lithium\console\command\Help::_properties()
* @param string $command The name of the command.
* @param array $method Information about the method of the command to render usage for.
* @param array $properties From `_properties()`.
* @return void
*/
protected function _renderUsage($command, $method, $properties = array()) {
$params = array_reduce($properties, function($a, $b) {
return "{$a} {$b['usage']}";
});
$args = array_reduce($method['args'], function($a, $b) {
return "{$a} {$b['usage']}";
});
$format = "{:command}li3 %s%s{:end}{:command}%s{:end}{:option}%s{:end}";
$name = $method['name'] == 'run' ? '' : " {$method['name']}";
$this->out($this->_pad(sprintf($format, $command ?: 'COMMAND', $name, $params, $args)));
}
/**
* Output the formatted command description.
*
* @param array $info Info from inspecting the class of the command.
* @return void
*/
protected function _renderDescription($info) {
$this->out('DESCRIPTION', 'heading');
$break = PHP_EOL . PHP_EOL;
$description = trim("{$info['description']}{$break}{$info['text']}");
$this->out($this->_pad($description, PHP_EOL));
}
/**
* Add left padding for prettier display.
*
* @param string $message the text to render.
* @param integer|string $level the level of indentation.
* @return string
*/
protected function _pad($message, $level = 1) {
$padding = str_repeat(' ', $level * 4);
return $padding . str_replace("\n", "\n{$padding}", $message);
}
}
?>