LintCommand

static строка|null getDefaultName()

Значение возвращаемого значения

строка|null

Имя команды по умолчанию или null, если имя по умолчанию не задано

__construct(Environment $twig)

Параметры

Environment

$twig

Исключения

LogicException

При пустом имени команды

ignoreValidationErrors()

Игнорирует ошибки валидации.

Это в основном полезно для команды help.

setApplication(Application $application = null)

Параметры

Application

$application

setHelperSet(HelperSet $helperSet)

Параметры

HelperSet

$helperSet

HelperSet getHelperSet()

Получает набор помощников.

Значение возвращаемого значения

HelperSet

Экземпляр HelperSet

Application getApplication()

Получает экземпляр приложения для этой команды.

Значение возвращаемого значения

Application

Экземпляр Application

bool isEnabled()

Проверяет, включена ли команда в текущей среде.

Переопределите этот метод, чтобы проверить x или y и вернуть false, если команда не может корректно работать в текущих условиях.

Значение возвращаемого значения

bool

protected configure()

Настраивает текущую команду.

protected int|null execute(InputInterface $input, OutputInterface $output)

Выполняет текущую команду.

Этот метод не является абстрактным, потому что вы можете использовать этот класс как конкретный класс. В этом случае, вместо определения метода execute(), вы задаете код для выполнения, передавая Closure методу setCode().

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

int|null

null или 0, если всё прошло хорошо, или код ошибки

Исключения

LogicException

Если этот абстрактный метод не реализован

protected interact(InputInterface $input, OutputInterface $output)

Взаимодействует с пользователем.

Этот метод выполняется до валидации InputDefinition. Это означает, что это единственное место, где команда может интерактивно запросить значения отсутствующих обязательных аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

protected initialize(InputInterface $input, OutputInterface $output)

Инициализирует команду после привязки ввода и перед валидацией ввода.

Это в основном полезно, когда много команд расширяют одну главную команду, где некоторые вещи нужно инициализировать на основе аргументов и опций ввода.

Параметры

InputInterface	$input
OutputInterface	$output

См. также

InputInterface::bind
InputInterface::validate

int run(InputInterface $input, OutputInterface $output)

Выполняет команду.

Код для выполнения либо определяется напрямую с помощью метода setCode(), либо переопределяется методом execute() в подклассе.

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

int	Код завершения команды

Исключения

Exception

При неудачной привязке входных данных. Пропустите это, вызвав {@link ignoreValidationErrors()}.

См. также

setCode()
execute()

$this setCode(callable $code)

Устанавливает код для выполнения при запуске этой команды.

Если этот метод используется, он переопределяет код, определённый в методе execute().

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

Объединяет определение приложения с определением команды.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

Объединять ли аргументы определения Application с аргументами определения команды

$this setDefinition(array|InputDefinition $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

array|InputDefinition

$definition

Массив экземпляров аргументов и опций или экземпляр определения

Значение возвращаемого значения

$this

InputDefinition getDefinition()

Получает InputDefinition, прикреплённую к этой команде.

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

Получает InputDefinition, используемую для создания представлений этой команды.

Можно переопределить, чтобы предоставить исходное представление команды, когда оно иначе будет изменено путём объединения с InputDefinition приложения.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

$this addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|null $default = null)

Добавляет аргумент.

Параметры

string	$name	Имя аргумента
int|null	$mode	Режим аргумента: self::REQUIRED или self::OPTIONAL
string	$description	Текст описания
string|string[]|null	$default	Значение по умолчанию (только для режима self::OPTIONAL)

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

При некорректном режиме аргумента

$this addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null)

Добавляет опцию.

Параметры

string	$name	Имя опции
string|array	$shortcut	Сокращения, может быть null, строка сокращений, разделённых |, или массив сокращений
int|null	$mode	Режим опции: Одно из констант VALUE_*
string	$description	Текст описания
string|string[]|bool|null	$default	Значение по умолчанию (должно быть null для self::VALUE_NONE)

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

Если режим опции некорректен или несовместим

$this setName(string $name)

Устанавливает имя команды.

Этот метод может установить и имя, и пространство имён, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

Если имя некорректно

$this setProcessTitle(string $title)

Устанавливает заголовок процесса команды.

Эта функция должна использоваться только при создании команды с длительным процессом, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

Заголовок процесса

Значение возвращаемого значения

$this

string getName()

Возвращает имя команды.

Значение возвращаемого значения

string

Имя команды

Command setHidden(bool $hidden)

Параметры

bool

$hidden

Скрыть команду из списка команд или нет

Значение возвращаемого значения

Command

Текущий экземпляр

bool isHidden()

Значение возвращаемого значения

bool	Показывать команду публично или нет

$this setDescription(string $description)

Устанавливает описание команды.

Параметры

string

$description

Описание команды

Значение возвращаемого значения

$this

string getDescription()

Возвращает описание команды.

Значение возвращаемого значения

string

Описание команды

$this setHelp(string $help)

Устанавливает справку по команде.

Параметры

string

$help

Справка по команде

Значение возвращаемого значения

$this

string getHelp()

Возвращает справку по команде.

Значение возвращаемого значения

string

Справка по команде

string getProcessedHelp()

Возвращает обработанную справку по команде, динамически подставляя реальные значения в шаблоны %command.name% и %command.full_name%.

Значение возвращаемого значения

string

Обработанная справка по команде

$this setAliases(string[] $aliases)

Устанавливает псевдонимы команды.

Параметры

string[]

$aliases

Массив псевдонимов команды

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

Если псевдоним некорректен

array getAliases()

Возвращает псевдонимы команды.

Значение возвращаемого значения

array

Массив псевдонимов команды

string getSynopsis(bool $short = false)

Возвращает краткое описание команды.

Параметры

bool

$short

Показывать ли короткую версию описания (с свёрнутыми опциями)?

Значение возвращаемого значения

string

Краткое описание

$this addUsage(string $usage)

Добавляет пример использования команды.

Параметры

string

$usage

Пример использования, будет префикссован именем команды

Значение возвращаемого значения

$this

array getUsages()

Возвращает альтернативные способы использования команды.

Значение возвращаемого значения

array

mixed getHelper(string $name)

Получает экземпляр помощника по имени.

Параметры

string

$name

Имя помощника

Значение возвращаемого значения

mixed

Значение помощника

Исключения

LogicException	если HelperSet не определен
InvalidArgumentException	если помощник не определен

protected findFiles($filename)

Параметры

$filename