DebugFormatterHelper
class DebugFormatterHelper extends Helper
Помогает выводить отладочную информацию при запуске внешней программы из командной строки.
Внешняя программа может быть процессом, HTTP-запросом или чем-либо ещё.
Свойства
| 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 | start(string $id, string $message, string $prefix = 'RUN') Начинает сеанс форматирования отладки. | |
| string | progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR') Добавляет прогресс в сеанс форматирования. | |
| string | stop(string $id, string $message, bool $successful, string $prefix = 'RES') Останавливает сеанс форматирования. | |
| 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 start(string $id, string $message, string $prefix = 'RUN')
Начинает сеанс форматирования отладки.
Параметры
| string | $id | Идентификатор сеанса форматирования |
| string | $message | Сообщение для отображения |
| string | $prefix | Префикс для использования |
Значение возврата
| string |
string progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR')
Добавляет прогресс в сеанс форматирования.
Параметры
| string | $id | Идентификатор сеанса форматирования |
| string | $buffer | Сообщение для отображения |
| bool | $error | Является ли буфер ошибкой |
| string | $prefix | Префикс для вывода |
| string | $errorPrefix | Префикс для вывода ошибок |
Значение возврата
| string |
string stop(string $id, string $message, bool $successful, string $prefix = 'RES')
Останавливает сеанс форматирования.
Параметры
| string | $id | Идентификатор сеанса форматирования |
| string | $message | Сообщение для отображения |
| bool | $successful | Успешно ли завершился результат |
| string | $prefix | Префикс для конечного вывода |
Значение возврата
| string |
string getName()
Возвращает каноническое имя этого помощника.
Значение возврата
| string | Каноническое имя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Helper/DebugFormatterHelper.html