Drupal investigation

TextDescriptor.php 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Descriptor;
  11. use Symfony\Component\Console\Application;
  12. use Symfony\Component\Console\Command\Command;
  13. use Symfony\Component\Console\Formatter\OutputFormatter;
  14. use Symfony\Component\Console\Helper\Helper;
  15. use Symfony\Component\Console\Input\InputArgument;
  16. use Symfony\Component\Console\Input\InputDefinition;
  17. use Symfony\Component\Console\Input\InputOption;
  18. /**
  19. * Text descriptor.
  20. *
  21. * @author Jean-François Simon <contact@jfsimon.fr>
  22. *
  23. * @internal
  24. */
  25. class TextDescriptor extends Descriptor
  26. {
  27. /**
  28. * {@inheritdoc}
  29. */
  30. protected function describeInputArgument(InputArgument $argument, array $options = array())
  31. {
  32. if (null !== $argument->getDefault() && (!is_array($argument->getDefault()) || count($argument->getDefault()))) {
  33. $default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($argument->getDefault()));
  34. } else {
  35. $default = '';
  36. }
  37. $totalWidth = isset($options['total_width']) ? $options['total_width'] : Helper::strlen($argument->getName());
  38. $spacingWidth = $totalWidth - strlen($argument->getName());
  39. $this->writeText(sprintf(' <info>%s</info> %s%s%s',
  40. $argument->getName(),
  41. str_repeat(' ', $spacingWidth),
  42. // + 4 = 2 spaces before <info>, 2 spaces after </info>
  43. preg_replace('/\s*[\r\n]\s*/', "\n".str_repeat(' ', $totalWidth + 4), $argument->getDescription()),
  44. $default
  45. ), $options);
  46. }
  47. /**
  48. * {@inheritdoc}
  49. */
  50. protected function describeInputOption(InputOption $option, array $options = array())
  51. {
  52. if ($option->acceptValue() && null !== $option->getDefault() && (!is_array($option->getDefault()) || count($option->getDefault()))) {
  53. $default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($option->getDefault()));
  54. } else {
  55. $default = '';
  56. }
  57. $value = '';
  58. if ($option->acceptValue()) {
  59. $value = '='.strtoupper($option->getName());
  60. if ($option->isValueOptional()) {
  61. $value = '['.$value.']';
  62. }
  63. }
  64. $totalWidth = isset($options['total_width']) ? $options['total_width'] : $this->calculateTotalWidthForOptions(array($option));
  65. $synopsis = sprintf('%s%s',
  66. $option->getShortcut() ? sprintf('-%s, ', $option->getShortcut()) : ' ',
  67. sprintf('--%s%s', $option->getName(), $value)
  68. );
  69. $spacingWidth = $totalWidth - Helper::strlen($synopsis);
  70. $this->writeText(sprintf(' <info>%s</info> %s%s%s%s',
  71. $synopsis,
  72. str_repeat(' ', $spacingWidth),
  73. // + 4 = 2 spaces before <info>, 2 spaces after </info>
  74. preg_replace('/\s*[\r\n]\s*/', "\n".str_repeat(' ', $totalWidth + 4), $option->getDescription()),
  75. $default,
  76. $option->isArray() ? '<comment> (multiple values allowed)</comment>' : ''
  77. ), $options);
  78. }
  79. /**
  80. * {@inheritdoc}
  81. */
  82. protected function describeInputDefinition(InputDefinition $definition, array $options = array())
  83. {
  84. $totalWidth = $this->calculateTotalWidthForOptions($definition->getOptions());
  85. foreach ($definition->getArguments() as $argument) {
  86. $totalWidth = max($totalWidth, Helper::strlen($argument->getName()));
  87. }
  88. if ($definition->getArguments()) {
  89. $this->writeText('<comment>Arguments:</comment>', $options);
  90. $this->writeText("\n");
  91. foreach ($definition->getArguments() as $argument) {
  92. $this->describeInputArgument($argument, array_merge($options, array('total_width' => $totalWidth)));
  93. $this->writeText("\n");
  94. }
  95. }
  96. if ($definition->getArguments() && $definition->getOptions()) {
  97. $this->writeText("\n");
  98. }
  99. if ($definition->getOptions()) {
  100. $laterOptions = array();
  101. $this->writeText('<comment>Options:</comment>', $options);
  102. foreach ($definition->getOptions() as $option) {
  103. if (strlen($option->getShortcut()) > 1) {
  104. $laterOptions[] = $option;
  105. continue;
  106. }
  107. $this->writeText("\n");
  108. $this->describeInputOption($option, array_merge($options, array('total_width' => $totalWidth)));
  109. }
  110. foreach ($laterOptions as $option) {
  111. $this->writeText("\n");
  112. $this->describeInputOption($option, array_merge($options, array('total_width' => $totalWidth)));
  113. }
  114. }
  115. }
  116. /**
  117. * {@inheritdoc}
  118. */
  119. protected function describeCommand(Command $command, array $options = array())
  120. {
  121. $command->getSynopsis(true);
  122. $command->getSynopsis(false);
  123. $command->mergeApplicationDefinition(false);
  124. $this->writeText('<comment>Usage:</comment>', $options);
  125. foreach (array_merge(array($command->getSynopsis(true)), $command->getAliases(), $command->getUsages()) as $usage) {
  126. $this->writeText("\n");
  127. $this->writeText(' '.$usage, $options);
  128. }
  129. $this->writeText("\n");
  130. $definition = $command->getNativeDefinition();
  131. if ($definition->getOptions() || $definition->getArguments()) {
  132. $this->writeText("\n");
  133. $this->describeInputDefinition($definition, $options);
  134. $this->writeText("\n");
  135. }
  136. if ($help = $command->getProcessedHelp()) {
  137. $this->writeText("\n");
  138. $this->writeText('<comment>Help:</comment>', $options);
  139. $this->writeText("\n");
  140. $this->writeText(' '.str_replace("\n", "\n ", $help), $options);
  141. $this->writeText("\n");
  142. }
  143. }
  144. /**
  145. * {@inheritdoc}
  146. */
  147. protected function describeApplication(Application $application, array $options = array())
  148. {
  149. $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
  150. $description = new ApplicationDescription($application, $describedNamespace);
  151. if (isset($options['raw_text']) && $options['raw_text']) {
  152. $width = $this->getColumnWidth($description->getCommands());
  153. foreach ($description->getCommands() as $command) {
  154. $this->writeText(sprintf("%-{$width}s %s", $command->getName(), $command->getDescription()), $options);
  155. $this->writeText("\n");
  156. }
  157. } else {
  158. if ('' != $help = $application->getHelp()) {
  159. $this->writeText("$help\n\n", $options);
  160. }
  161. $this->writeText("<comment>Usage:</comment>\n", $options);
  162. $this->writeText(" command [options] [arguments]\n\n", $options);
  163. $this->describeInputDefinition(new InputDefinition($application->getDefinition()->getOptions()), $options);
  164. $this->writeText("\n");
  165. $this->writeText("\n");
  166. $width = $this->getColumnWidth($description->getCommands());
  167. if ($describedNamespace) {
  168. $this->writeText(sprintf('<comment>Available commands for the "%s" namespace:</comment>', $describedNamespace), $options);
  169. } else {
  170. $this->writeText('<comment>Available commands:</comment>', $options);
  171. }
  172. // add commands by namespace
  173. foreach ($description->getNamespaces() as $namespace) {
  174. if (!$describedNamespace && ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) {
  175. $this->writeText("\n");
  176. $this->writeText(' <comment>'.$namespace['id'].'</comment>', $options);
  177. }
  178. foreach ($namespace['commands'] as $name) {
  179. $this->writeText("\n");
  180. $spacingWidth = $width - Helper::strlen($name);
  181. $this->writeText(sprintf(' <info>%s</info>%s%s', $name, str_repeat(' ', $spacingWidth), $description->getCommand($name)->getDescription()), $options);
  182. }
  183. }
  184. $this->writeText("\n");
  185. }
  186. }
  187. /**
  188. * {@inheritdoc}
  189. */
  190. private function writeText($content, array $options = array())
  191. {
  192. $this->write(
  193. isset($options['raw_text']) && $options['raw_text'] ? strip_tags($content) : $content,
  194. isset($options['raw_output']) ? !$options['raw_output'] : true
  195. );
  196. }
  197. /**
  198. * Formats input option/argument default value.
  199. *
  200. * @param mixed $default
  201. *
  202. * @return string
  203. */
  204. private function formatDefaultValue($default)
  205. {
  206. if (is_string($default)) {
  207. $default = OutputFormatter::escape($default);
  208. } elseif (is_array($default)) {
  209. foreach ($default as $key => $value) {
  210. if (is_string($value)) {
  211. $default[$key] = OutputFormatter::escape($value);
  212. }
  213. }
  214. }
  215. if (PHP_VERSION_ID < 50400) {
  216. return str_replace(array('\/', '\\\\'), array('/', '\\'), json_encode($default));
  217. }
  218. return str_replace('\\\\', '\\', json_encode($default, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  219. }
  220. /**
  221. * @param Command[] $commands
  222. *
  223. * @return int
  224. */
  225. private function getColumnWidth(array $commands)
  226. {
  227. $widths = array();
  228. foreach ($commands as $command) {
  229. $widths[] = Helper::strlen($command->getName());
  230. foreach ($command->getAliases() as $alias) {
  231. $widths[] = Helper::strlen($alias);
  232. }
  233. }
  234. return max($widths) + 2;
  235. }
  236. /**
  237. * @param InputOption[] $options
  238. *
  239. * @return int
  240. */
  241. private function calculateTotalWidthForOptions($options)
  242. {
  243. $totalWidth = 0;
  244. foreach ($options as $option) {
  245. // "-" + shortcut + ", --" + name
  246. $nameLength = 1 + max(strlen($option->getShortcut()), 1) + 4 + Helper::strlen($option->getName());
  247. if ($option->acceptValue()) {
  248. $valueLength = 1 + Helper::strlen($option->getName()); // = + value
  249. $valueLength += $option->isValueOptional() ? 2 : 0; // [ + ]
  250. $nameLength += $valueLength;
  251. }
  252. $totalWidth = max($totalWidth, $nameLength);
  253. }
  254. return $totalWidth;
  255. }
  256. }