Helper.php 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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 = null;
  21. /**
  22. * {@inheritdoc}
  23. */
  24. public function setHelperSet(HelperSet $helperSet = null)
  25. {
  26. $this->helperSet = $helperSet;
  27. }
  28. /**
  29. * {@inheritdoc}
  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 ?? $string = '';
  42. if (preg_match('//u', $string)) {
  43. return (new UnicodeString($string))->width(false);
  44. }
  45. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  46. return \strlen($string);
  47. }
  48. return mb_strwidth($string, $encoding);
  49. }
  50. /**
  51. * Returns the length of a string, using mb_strlen if it is available.
  52. * The length is related to how many bytes the string will use.
  53. */
  54. public static function length(?string $string): int
  55. {
  56. $string ?? $string = '';
  57. if (preg_match('//u', $string)) {
  58. return (new UnicodeString($string))->length();
  59. }
  60. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  61. return \strlen($string);
  62. }
  63. return mb_strlen($string, $encoding);
  64. }
  65. /**
  66. * Returns the subset of a string, using mb_substr if it is available.
  67. */
  68. public static function substr(?string $string, int $from, int $length = null): string
  69. {
  70. $string ?? $string = '';
  71. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  72. return substr($string, $from, $length);
  73. }
  74. return mb_substr($string, $from, $length, $encoding);
  75. }
  76. public static function formatTime(int|float $secs)
  77. {
  78. static $timeFormats = [
  79. [0, '< 1 sec'],
  80. [1, '1 sec'],
  81. [2, 'secs', 1],
  82. [60, '1 min'],
  83. [120, 'mins', 60],
  84. [3600, '1 hr'],
  85. [7200, 'hrs', 3600],
  86. [86400, '1 day'],
  87. [172800, 'days', 86400],
  88. ];
  89. foreach ($timeFormats as $index => $format) {
  90. if ($secs >= $format[0]) {
  91. if ((isset($timeFormats[$index + 1]) && $secs < $timeFormats[$index + 1][0])
  92. || $index == \count($timeFormats) - 1
  93. ) {
  94. if (2 == \count($format)) {
  95. return $format[1];
  96. }
  97. return floor($secs / $format[2]).' '.$format[1];
  98. }
  99. }
  100. }
  101. }
  102. public static function formatMemory(int $memory)
  103. {
  104. if ($memory >= 1024 * 1024 * 1024) {
  105. return sprintf('%.1f GiB', $memory / 1024 / 1024 / 1024);
  106. }
  107. if ($memory >= 1024 * 1024) {
  108. return sprintf('%.1f MiB', $memory / 1024 / 1024);
  109. }
  110. if ($memory >= 1024) {
  111. return sprintf('%d KiB', $memory / 1024);
  112. }
  113. return sprintf('%d B', $memory);
  114. }
  115. public static function removeDecoration(OutputFormatterInterface $formatter, ?string $string)
  116. {
  117. $isDecorated = $formatter->isDecorated();
  118. $formatter->setDecorated(false);
  119. // remove <...> formatting
  120. $string = $formatter->format($string ?? '');
  121. // remove already formatted characters
  122. $string = preg_replace("/\033\[[^m]*m/", '', $string ?? '');
  123. $formatter->setDecorated($isDecorated);
  124. return $string;
  125. }
  126. }