FormatterHelper
class FormatterHelper extends Helper
Класс Formatter предоставляет помощники для форматирования сообщений.
Свойства
| protected | $helperSet | из Helper |
Методы
| setHelperSet(HelperSet $helperSet = null) Устанавливает набор помощников, связанных с этим помощником. | из Helper | |
| HelperSet | getHelperSet() Получает набор помощников, связанных с этим помощником. | из Helper |
| static int | strlen(string $string) Возвращает длину строки, используя mb_strwidth, если он доступен. | из Helper |
| static string | substr(string $string, int $from, int|null $length = null) Возвращает подстроку, используя mb_substr, если он доступен. | из Helper |
| static | formatTime($secs) | из Helper |
| static | formatMemory($memory) | из Helper |
| static | strlenWithoutDecoration(OutputFormatterInterface $formatter, $string) | из Helper |
| static | removeDecoration(OutputFormatterInterface $formatter, $string) | из Helper |
| string | formatSection(string $section, string $message, string $style = 'info') Форматирует сообщение в секции. | |
| string | formatBlock(string|array $messages, string $style, bool $large = false) Форматирует сообщение как блок текста. | |
| string | truncate(string $message, int $length, string $suffix = '...') Усекает сообщение до заданной длины. | |
| string | getName() Возвращает каноническое имя этого помощника. |
Подробности
setHelperSet(HelperSet $helperSet = null)
Устанавливает набор помощников, связанных с этим помощником.
Параметры
| HelperSet | $helperSet |
HelperSet getHelperSet()
Получает набор помощников, связанных с этим помощником.
Возвращаемое значение
| HelperSet | Экземпляр HelperSet |
static int strlen(string $string)
Возвращает длину строки, используя mb_strwidth, если он доступен.
Параметры
| string | $string | Строка, для которой нужно проверить длину |
Возвращаемое значение
| int | Длина строки |
static string substr(string $string, int $from, int|null $length = null)
Возвращает подстроку, используя mb_substr, если он доступен.
Параметры
| string | $string | Строка для извлечения подстроки |
| int | $from | Начальный смещение |
| int|null | $length | Длина подстроки |
Возвращаемое значение
| string | Подстрока |
static formatTime($secs)
Параметры
| $secs |
static formatMemory($memory)
Параметры
| $memory |
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)
Параметры
| OutputFormatterInterface | $formatter | |
| $string |
static removeDecoration(OutputFormatterInterface $formatter, $string)
Параметры
| OutputFormatterInterface | $formatter | |
| $string |
string formatSection(string $section, string $message, string $style = 'info')
Форматирует сообщение в секции.
Параметры
| string | $section | Имя секции |
| string | $message | Сообщение |
| string | $style | Стиль, применяемый к секции |
Возвращаемое значение
| string | Отформатированная секция |
string formatBlock(string|array $messages, string $style, bool $large = false)
Форматирует сообщение как блок текста.
Параметры
| string|array | $messages | Сообщение для записи в блоке |
| string | $style | Стиль, применяемый к всему блоку |
| bool | $large | Возвращать ли большой блок |
Возвращаемое значение
| string | Отформатированное сообщение |
string truncate(string $message, int $length, string $suffix = '...')
Усекает сообщение до заданной длины.
Параметры
| string | $message | |
| int | $length | |
| string | $suffix |
Возвращаемое значение
| string |
string getName()
Возвращает каноническое имя этого помощника.
Возвращаемое значение
| string | Каноническое имя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Helper/FormatterHelper.html