LintCommand

__construct(string|null $name = 'lint:twig')

Конструктор.

Параметры

string|null

$name

Имя команды; передача null означает, что оно должно быть установлено в configure()

Исключения

LogicException

Если имя команды пустое

ignoreValidationErrors()

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

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

setApplication(Application $application = null)

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

Параметры

Application

$application

Экземпляр Application

setHelperSet(HelperSet $helperSet)

Устанавливает набор помощников.

Параметры

HelperSet

$helperSet

Экземпляр HelperSet

HelperSet getHelperSet()

Возвращает набор помощников.

Значение результата

HelperSet

Экземпляр HelperSet

Application getApplication()

Возвращает экземпляр приложения для этой команды.

Значение результата

Application

Экземпляр Application

bool isEnabled()

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

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

Значение результата

bool

int run(InputInterface $input, OutputInterface $output)

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

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

Параметры

InputInterface	$input	Экземпляр InputInterface
OutputInterface	$output	Экземпляр OutputInterface

Значение результата

int	Код выхода команды

Исключения

Exception

См. также

setCode()
execute()

Command setCode(callable $code)

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

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

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

Значение результата

Command

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

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

Этот метод не является частью публичного API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

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

Command setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

Значение результата

Command

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

InputDefinition getDefinition()

Возвращает InputDefinition, присоединённый к этой команде.

Значение результата

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

Возвращает InputDefinition, используемый для создания XML и текстовых представлений этой команды.

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

Этот метод не является частью публичного API и не должен использоваться напрямую.

Значение результата

InputDefinition

Экземпляр InputDefinition

Command addArgument(string $name, int $mode = null, string $description = '', mixed $default = null)

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

Параметры

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

Значение результата

Command

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

Command addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null)

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

Параметры

string	$name	Имя опции
string	$shortcut	Сокращение (может быть null)
int	$mode	Режим опции: Один из констант InputOption::VALUE_*
string	$description	Текст описания
mixed	$default	Значение по умолчанию (должно быть null для InputOption::VALUE_NONE)

Значение результата

Command

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

Command setName(string $name)

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

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

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

Параметры

string

$name

Имя команды

Значение результата

Command

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

Исключения

InvalidArgumentException

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

Command setProcessTitle(string $title)

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

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

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

Параметры

string

$title

Название процесса

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

Command

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

string getName()

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

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

string

Имя команды

Command setDescription(string $description)

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

Параметры

string

$description

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

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

Command

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

string getDescription()

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

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

string

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

Command setHelp(string $help)

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

Параметры

string

$help

Справка для команды

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

Command

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

string getHelp()

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

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

string

Справка для команды

string getProcessedHelp()

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

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

string

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

Command setAliases(string[] $aliases)

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

Параметры

string[]

$aliases

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

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

Command

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

Исключения

InvalidArgumentException

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

array getAliases()

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

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

array

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

string getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

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

string

Синопсис

Command addUsage(string $usage)

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

Параметры

string

$usage

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

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

Command

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

array getUsages()

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

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

array

mixed getHelper(string $name)

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

Параметры

string

$name

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

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

mixed

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

Исключения

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

string asText() ^{устаревшее}

^{устаревшее}

since версия 2.3, будет удалено в 3.0.

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

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

string

Строка, представляющая команду

string|DOMDocument asXml(bool $asDom = false) ^{устаревшее}

^{устаревшее}

since версия 2.3, будет удалено в 3.0.

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

Параметры

bool

$asDom

Возвращать DOM или строку XML

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

string|DOMDocument

Строка XML, представляющая команду

setTwigEnvironment(Twig_Environment $twig)

Устанавливает среду Twig.

Параметры

Twig_Environment

$twig

setContainer(ContainerInterface $container = null)

Устанавливает контейнер.

Параметры

ContainerInterface

$container

Экземпляр ContainerInterface или null