1
|
|
|
<?php |
2
|
|
|
namespace Consolidation\OutputFormatters\Formatters; |
3
|
|
|
|
4
|
|
|
use Consolidation\OutputFormatters\Options\FormatterOptions; |
5
|
|
|
use Consolidation\OutputFormatters\Validate\ValidDataTypesInterface; |
6
|
|
|
use Consolidation\OutputFormatters\Validate\ValidDataTypesTrait; |
7
|
|
|
use Symfony\Component\Console\Output\OutputInterface; |
8
|
|
|
use Symfony\Component\Console\Helper\Table; |
9
|
|
|
use Symfony\Component\Console\Helper\TableCell; |
10
|
|
|
|
11
|
|
|
/** |
12
|
|
|
* Format an array into CLI help string. |
13
|
|
|
*/ |
14
|
|
|
class HelpFormatter implements FormatterInterface |
15
|
|
|
{ |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* @inheritdoc |
19
|
|
|
*/ |
20
|
|
|
public function write(OutputInterface $output, $data, FormatterOptions $options) |
21
|
|
|
{ |
22
|
|
|
$table = new Table($this->output()); |
|
|
|
|
23
|
|
|
$table->setStyle('compact'); |
24
|
|
|
|
25
|
|
|
// @todo. Get input data as an array. |
26
|
|
|
$output->writeln($command->getDescription()); |
|
|
|
|
27
|
|
|
|
28
|
|
View Code Duplication |
if ($usages = $command->getExampleUsages()) { |
|
|
|
|
29
|
|
|
$table->addRow(['','']); |
30
|
|
|
$table->addRow([new TableCell('Examples:', array('colspan' => 2))]); |
31
|
|
|
foreach ($usages as $key => $description) { |
32
|
|
|
$table->addRow([' ' . $key, $description]); |
33
|
|
|
} |
34
|
|
|
} |
35
|
|
|
|
36
|
|
|
if ($arguments = $def->getArguments()) { |
|
|
|
|
37
|
|
|
$table->addRow(['','']); |
38
|
|
|
$table->addRow([new TableCell('Arguments:', array('colspan' => 2))]); |
39
|
|
|
foreach ($arguments as $argument) { |
40
|
|
|
$formatted = $this->formatArgumentName($argument); |
|
|
|
|
41
|
|
|
$description = $argument->getDescription(); |
42
|
|
|
if ($argument->getDefault()) { |
43
|
|
|
$description .= ' [default: ' . $argument->getDefault() . ']'; |
44
|
|
|
} |
45
|
|
|
$table->addRow([' ' . $formatted, $description]); |
46
|
|
|
} |
47
|
|
|
} |
48
|
|
|
|
49
|
|
View Code Duplication |
if ($options = $def->getOptions()) { |
|
|
|
|
50
|
|
|
$table->addRow(['','']); |
51
|
|
|
$table->addRow([new TableCell('Options:', array('colspan' => 2))]); |
52
|
|
|
foreach ($options as $option) { |
53
|
|
|
$formatted = $this->formatOption($option); |
|
|
|
|
54
|
|
|
$table->addRow([' ' . $formatted, $option->getDescription()]); |
55
|
|
|
} |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
if ($topics = $command->getTopics()) { |
59
|
|
|
$table->addRow(['','']); |
60
|
|
|
$table->addRow([new TableCell('Topics:', array('colspan' => 2))]); |
61
|
|
|
foreach ($topics as $topic) { |
62
|
|
|
// @todo deal with long descriptions |
63
|
|
|
$table->addRow([' ' . $topic, substr($allTopics[$topic]['description'], 0, 30)]); |
|
|
|
|
64
|
|
|
} |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
if ($aliases = $command->getAliases()) { |
68
|
|
|
$table->addRow(['','']); |
69
|
|
|
$table->addRow([new TableCell('Aliases: '. implode(' ', $aliases), array('colspan' => 2))]); |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
$table->render(); |
73
|
|
|
|
74
|
|
|
$output->writeln($help); |
|
|
|
|
75
|
|
|
} |
76
|
|
|
} |
77
|
|
|
|
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.