FormatterHelper.php 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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\Helper;
  11. use Symfony\Component\Console\Formatter\OutputFormatter;
  12. /**
  13. * The Formatter class provides helpers to format messages.
  14. *
  15. * @author Fabien Potencier <fabien@symfony.com>
  16. */
  17. class FormatterHelper extends Helper
  18. {
  19. /**
  20. * Formats a message within a section.
  21. * @param string $section
  22. * @param string $message
  23. * @param string $style
  24. */
  25. public function formatSection($section, $message, $style = 'info')
  26. {
  27. return sprintf('<%s>[%s]</%s> %s', $style, $section, $style, $message);
  28. }
  29. /**
  30. * Formats a message as a block of text.
  31. * @param string|mixed[] $messages
  32. * @param string $style
  33. * @param bool $large
  34. */
  35. public function formatBlock($messages, $style, $large = false)
  36. {
  37. if (!\is_array($messages)) {
  38. $messages = [$messages];
  39. }
  40. $len = 0;
  41. $lines = [];
  42. foreach ($messages as $message) {
  43. $message = OutputFormatter::escape($message);
  44. $lines[] = sprintf($large ? ' %s ' : ' %s ', $message);
  45. $len = max(self::width($message) + ($large ? 4 : 2), $len);
  46. }
  47. $messages = $large ? [str_repeat(' ', $len)] : [];
  48. for ($i = 0; isset($lines[$i]); ++$i) {
  49. $messages[] = $lines[$i].str_repeat(' ', $len - self::width($lines[$i]));
  50. }
  51. if ($large) {
  52. $messages[] = str_repeat(' ', $len);
  53. }
  54. for ($i = 0; isset($messages[$i]); ++$i) {
  55. $messages[$i] = sprintf('<%s>%s</%s>', $style, $messages[$i], $style);
  56. }
  57. return implode("\n", $messages);
  58. }
  59. /**
  60. * Truncates a message to the given length.
  61. * @param string $message
  62. * @param int $length
  63. * @param string $suffix
  64. */
  65. public function truncate($message, $length, $suffix = '...')
  66. {
  67. $computedLength = $length - self::width($suffix);
  68. if ($computedLength > self::width($message)) {
  69. return $message;
  70. }
  71. return self::substr($message, 0, $length).$suffix;
  72. }
  73. public function getName()
  74. {
  75. return 'formatter';
  76. }
  77. }