Helper.php 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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\OutputFormatterInterface;
  12. use Symfony\Component\String\UnicodeString;
  13. /**
  14. * Helper is the base class for all helper classes.
  15. *
  16. * @author Fabien Potencier <fabien@symfony.com>
  17. */
  18. abstract class Helper implements HelperInterface
  19. {
  20. protected $helperSet;
  21. /**
  22. * @return void
  23. */
  24. public function setHelperSet(?HelperSet $helperSet = null)
  25. {
  26. if (1 > \func_num_args()) {
  27. trigger_deprecation('symfony/console', '6.2', 'Calling "%s()" without any arguments is deprecated, pass null explicitly instead.', __METHOD__);
  28. }
  29. $this->helperSet = $helperSet;
  30. }
  31. public function getHelperSet(): ?HelperSet
  32. {
  33. return $this->helperSet;
  34. }
  35. /**
  36. * Returns the width of a string, using mb_strwidth if it is available.
  37. * The width is how many characters positions the string will use.
  38. */
  39. public static function width(?string $string): int
  40. {
  41. $string ??= '';
  42. if (preg_match('//u', $string)) {
  43. $string = preg_replace('/[\p{Cc}\x7F]++/u', '', $string, -1, $count);
  44. return (new UnicodeString($string))->width(false) + $count;
  45. }
  46. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  47. return \strlen($string);
  48. }
  49. return mb_strwidth($string, $encoding);
  50. }
  51. /**
  52. * Returns the length of a string, using mb_strlen if it is available.
  53. * The length is related to how many bytes the string will use.
  54. */
  55. public static function length(?string $string): int
  56. {
  57. $string ??= '';
  58. if (preg_match('//u', $string)) {
  59. return (new UnicodeString($string))->length();
  60. }
  61. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  62. return \strlen($string);
  63. }
  64. return mb_strlen($string, $encoding);
  65. }
  66. /**
  67. * Returns the subset of a string, using mb_substr if it is available.
  68. */
  69. public static function substr(?string $string, int $from, ?int $length = null): string
  70. {
  71. $string ??= '';
  72. if (preg_match('//u', $string)) {
  73. return (new UnicodeString($string))->slice($from, $length);
  74. }
  75. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  76. return substr($string, $from, $length);
  77. }
  78. return mb_substr($string, $from, $length, $encoding);
  79. }
  80. /**
  81. * @return string
  82. */
  83. public static function formatTime(int|float $secs, int $precision = 1)
  84. {
  85. $secs = (int) floor($secs);
  86. if (0 === $secs) {
  87. return '< 1 sec';
  88. }
  89. static $timeFormats = [
  90. [1, '1 sec', 'secs'],
  91. [60, '1 min', 'mins'],
  92. [3600, '1 hr', 'hrs'],
  93. [86400, '1 day', 'days'],
  94. ];
  95. $times = [];
  96. foreach ($timeFormats as $index => $format) {
  97. $seconds = isset($timeFormats[$index + 1]) ? $secs % $timeFormats[$index + 1][0] : $secs;
  98. if (isset($times[$index - $precision])) {
  99. unset($times[$index - $precision]);
  100. }
  101. if (0 === $seconds) {
  102. continue;
  103. }
  104. $unitCount = ($seconds / $format[0]);
  105. $times[$index] = 1 === $unitCount ? $format[1] : $unitCount.' '.$format[2];
  106. if ($secs === $seconds) {
  107. break;
  108. }
  109. $secs -= $seconds;
  110. }
  111. return implode(', ', array_reverse($times));
  112. }
  113. /**
  114. * @return string
  115. */
  116. public static function formatMemory(int $memory)
  117. {
  118. if ($memory >= 1024 * 1024 * 1024) {
  119. return \sprintf('%.1f GiB', $memory / 1024 / 1024 / 1024);
  120. }
  121. if ($memory >= 1024 * 1024) {
  122. return \sprintf('%.1f MiB', $memory / 1024 / 1024);
  123. }
  124. if ($memory >= 1024) {
  125. return \sprintf('%d KiB', $memory / 1024);
  126. }
  127. return \sprintf('%d B', $memory);
  128. }
  129. /**
  130. * @return string
  131. */
  132. public static function removeDecoration(OutputFormatterInterface $formatter, ?string $string)
  133. {
  134. $isDecorated = $formatter->isDecorated();
  135. $formatter->setDecorated(false);
  136. // remove <...> formatting
  137. $string = $formatter->format($string ?? '');
  138. // remove already formatted characters
  139. $string = preg_replace("/\033\[[^m]*m/", '', $string ?? '');
  140. // remove terminal hyperlinks
  141. $string = preg_replace('/\\033]8;[^;]*;[^\\033]*\\033\\\\/', '', $string ?? '');
  142. $formatter->setDecorated($isDecorated);
  143. return $string;
  144. }
  145. }