Для разработчиков

“ Command Line Interface (CLI) — это интерфейс командной строки. ”

НПО Кристалл

Основная цель CLI - упрощённое управление программным комплексом Кристалл из командной строки, например, установка, создание резервных копий, запуск планировщика заданий...

Команда вызывает метод из класса, после выводит hello world и некоторый текст в терминал.

/**
 * Имя команды по умолчанию
 *
 * @var    string
 */
protected static $defaultName = 'commandgroup:commandname';

/**
 * SymfonyStyle Object
 *
 * @var SymfonyStyle
 */
private $ioStyle;

/**
 * Код возврата, в случае не удачи.
 */
const COMMANDNAME_FAILED = 1;

/**
 * Код возврата, в случае успеха.
 */
const COMMANDNAME_SUCCESSFUL = 0;

/**
 * Настраивает IO (ввод-вывод)
 *
 * @param   InputInterface   $input   Входные данные для ввода в команду.
 * @param   OutputInterface  $output  Выходные данные для внедрения в команду.
 *
 * @return void
 */
private function configureIO(InputInterface $input, OutputInterface $output): void {
	$this->ioStyle = new SymfonyStyle($input, $output);
}

/**
 * Внутренняя функция для выполнения команды.
 *
 * @param   InputInterface   $input   Входные данные для ввода в команду.
 * @param   OutputInterface  $output  Выходные данные для внедрения в команду.
 *
 * @return  integer  Код статуса выполнения команды.
 */
protected function doExecute(InputInterface $input, OutputInterface $output): int {
	$this->configureIO($input, $output);
	
	$returnCode = $this->getApplication()
						->getCommand(SetCommandgroupCommand::getDefaultName())
						->execute(/* Метод из контейнера, который необходимо выполнить */, $output);
	
	if ($returnCode === 0) {
		$this->ioStyle->success('Hello World!');

		return self::COMMANDNAME_SUCCESSFUL;
	}

	return self::COMMANDNAME_FAILED;
}

/**
 * Настройка команды.
 *
 * @return  void
 */
protected function configure(): void {
	$help = "Команда <info>%command.name%</info> выводит hello world всем, кто её вызывает
			\nИспользование: <info>php %command.full_name%</info>";
	
	$this->setDescription('Эта команда печатает hello world тому, кто её вызывает.');
	$this->setHelp($help);
}