DescriptorHelper
class DescriptorHelper extends Helper
Этот класс добавляет методы для описания объектов в различных форматах.
Свойства
| 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 |
| __construct() | ||
| describe(OutputInterface $output, object $object, array $options = array()) Описывает объект, если это поддерживается. | ||
| $this | register(string $format, DescriptorInterface $descriptor) Регистрирует описатель. | |
| 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 |
__construct()
describe(OutputInterface $output, object $object, array $options = array())
Описывает объект, если это поддерживается.
Доступные опции: * format: строка, имя формата вывода * raw_text: boolean, устанавливает тип вывода как raw
Параметры
| OutputInterface | $output | |
| object | $object | |
| array | $options |
Исключения
| InvalidArgumentException | при неподдерживаемом формате |
$this register(string $format, DescriptorInterface $descriptor)
Регистрирует описатель.
Параметры
| string | $format | |
| DescriptorInterface | $descriptor |
Возвращаемое значение
| $this |
string getName()
Возвращает каноническое имя этого помощника.
Возвращаемое значение
| string | Каноническое имя |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Helper/DescriptorHelper.html