Helper.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  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()
  32. {
  33. return $this->helperSet;
  34. }
  35. /**
  36. * Returns the length of a string, using mb_strwidth if it is available.
  37. *
  38. * @return int The length of the string
  39. */
  40. public static function strlen(?string $string)
  41. {
  42. $string ?? $string = '';
  43. if (preg_match('//u', $string)) {
  44. return (new UnicodeString($string))->width(false);
  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 subset of a string, using mb_substr if it is available.
  53. *
  54. * @return string The string subset
  55. */
  56. public static function substr(?string $string, int $from, int $length = null)
  57. {
  58. $string ?? $string = '';
  59. if (false === $encoding = mb_detect_encoding($string, null, true)) {
  60. return substr($string, $from, $length);
  61. }
  62. return mb_substr($string, $from, $length, $encoding);
  63. }
  64. public static function formatTime($secs)
  65. {
  66. static $timeFormats = [
  67. [0, '< 1 sec'],
  68. [1, '1 sec'],
  69. [2, 'secs', 1],
  70. [60, '1 min'],
  71. [120, 'mins', 60],
  72. [3600, '1 hr'],
  73. [7200, 'hrs', 3600],
  74. [86400, '1 day'],
  75. [172800, 'days', 86400],
  76. ];
  77. foreach ($timeFormats as $index => $format) {
  78. if ($secs >= $format[0]) {
  79. if ((isset($timeFormats[$index + 1]) && $secs < $timeFormats[$index + 1][0])
  80. || $index == \count($timeFormats) - 1
  81. ) {
  82. if (2 == \count($format)) {
  83. return $format[1];
  84. }
  85. return floor($secs / $format[2]).' '.$format[1];
  86. }
  87. }
  88. }
  89. }
  90. public static function formatMemory(int $memory)
  91. {
  92. if ($memory >= 1024 * 1024 * 1024) {
  93. return sprintf('%.1f GiB', $memory / 1024 / 1024 / 1024);
  94. }
  95. if ($memory >= 1024 * 1024) {
  96. return sprintf('%.1f MiB', $memory / 1024 / 1024);
  97. }
  98. if ($memory >= 1024) {
  99. return sprintf('%d KiB', $memory / 1024);
  100. }
  101. return sprintf('%d B', $memory);
  102. }
  103. public static function strlenWithoutDecoration(OutputFormatterInterface $formatter, ?string $string)
  104. {
  105. $string = self::removeDecoration($formatter, $string);
  106. if (preg_match('//u', $string)) {
  107. return (new UnicodeString($string))->width(true);
  108. }
  109. return self::strlen($string);
  110. }
  111. public static function removeDecoration(OutputFormatterInterface $formatter, ?string $string)
  112. {
  113. $isDecorated = $formatter->isDecorated();
  114. $formatter->setDecorated(false);
  115. // remove <...> formatting
  116. $string = $formatter->format($string ?? '');
  117. // remove already formatted characters
  118. $string = preg_replace("/\033\[[^m]*m/", '', $string);
  119. $formatter->setDecorated($isDecorated);
  120. return $string;
  121. }
  122. }