Команда
класс Command
Методы
| | __construct(Command $parent = null) | |
| строка | __toString() Возвращает команду в виде строки. | |
| статическая Command | create(Command $parent = null) Создаёт новый экземпляр Command. | |
| статическая строка | escape(строка $input) Экранирует специальные символы из входных данных. | |
| статическая строка | quote(строка $input) Указывает строку в кавычки. | |
| $this | add(строка|Command $bit) Добавляет строку или экземпляр Command. | |
| $this | top(строка|Command $bit) Вставляет строку или экземпляр команды в начало. | |
| $this | arg(строка $arg) Добавляет аргумент, который будет помещен в кавычки. | |
| $this | cmd(строка $esc) Добавляет экранированные специальные символы команды. | |
| Command|строка | ins(строка $label) Вставляет помеченную команду для последующего использования. | |
| Command|строка | get(строка $label) Извлекает ранее помеченную команду. | |
| Command | end() Возвращает родительскую команду (если есть). | |
| целое число | length() Подсчитывает элементы, хранящиеся в команде. | |
| $this | setErrorHandler(Closure $errorHandler) | |
| Closure|null | getErrorHandler() | |
| массив | execute() Выполняет текущую команду. | |
| строка | join() Объединяет элементы. | |
| $this | addAtIndex(строка|Command $bit, целое число $index) Вставляет строку или экземпляр Command перед элементом по указанному индексу $index (индекс начинается с 0). | |
Детали
__construct(Command $parent = null)
Параметры
string
__toString()
Возвращает команду в виде строки.
Значение возврата
static Command
create(Command $parent = null)
Создаёт новый экземпляр Command.
Параметры
Значение возврата
static string
escape(string $input)
Экранирует специальные символы из входных данных.
Параметры
| string | $input | Строка для экранирования |
Значение возврата
| string | Экранированная строка |
static string
quote(string $input)
Приводит входные данные к кавычкам.
Параметры
| string | $input | Строка аргумента |
Значение возврата
| string | Строка с кавычками |
$this
add(string|Command $bit)
Добавляет строку или экземпляр Command.
Параметры
Значение возврата
$this
top(string|Command $bit)
Добавляет в начало строку или экземпляр команды.
Параметры
Значение возврата
$this
arg(string $arg)
Добавляет аргумент, который будет заключён в кавычки.
Параметры
Значение возврата
$this
cmd(string $esc)
Добавляет экранированные специальные символы команд.
Параметры
Значение возврата
Command|string
ins(string $label)
Вставляет помеченную команду для последующей обработки.
Параметры
| string | $label | Уникальная метка |
Значение возврата
Исключения
Command|string
get(string $label)
Возвращает ранее помеченную команду.
Параметры
Значение возврата
Исключения
Возвращает родительскую команду (если есть).
Значение возврата
Исключения
int
length()
Считает количество элементов, хранящихся в команде.
Значение возврата
$this
setErrorHandler(Closure $errorHandler)
Параметры
Значение возврата
Closure|null
getErrorHandler()
Значение возврата
array
execute()
Выполняет текущую команду.
Значение возврата
Исключения
string
join()
Объединяет части.
Значение возврата
$this
addAtIndex(string|Команда $bit, int $index)
Вставить строку или экземпляр команды перед частью в заданной позиции $index (индекс начинается с 0).
Параметры
Значение возврата