Метод success

Метод success класса SymfonyStyle выводит в консоль сообщение об успехе. Обычно применяется для информирования пользователя о том, что команда завершилась удачно. Первым параметром передаётся текст сообщения, вторым - префикс, который выводится перед текстом.

Синтаксис

success(string $message, string $prefix = 'OK')

Пример

Давайте выведем сообщение об успехе в консольной команде:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputInterface;
	use SymfonyComponentConsoleOutputOutputInterface;
	use SymfonyComponentConsoleStyleSymfonyStyle;
	
	class ArticleCommand extends Command
	{
		protected static $defaultName = 'app:article';
		
		protected function execute(InputInterface $input, OutputInterface $output): int
		{
			$io = new SymfonyStyle($input, $output);
			
			$io->success('Article created');
			
			return Command::SUCCESS;
		}
	}
?>

Результат выполнения команды:

[OK] Article created

Пример

Давайте зададим собственный префикс вместо стандартного 'OK':

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputInterface;
	use SymfonyComponentConsoleOutputOutputInterface;
	use SymfonyComponentConsoleStyleSymfonyStyle;
	
	class ArticleCommand extends Command
	{
		protected static $defaultName = 'app:article';
		
		protected function execute(InputInterface $input, OutputInterface $output): int
		{
			$io = new SymfonyStyle($input, $output);
			
			$io->success('Article created', 'DONE');
			
			return Command::SUCCESS;
		}
	}
?>

Результат выполнения команды:

[DONE] Article created

Пример

Давайте выведем несколько сообщений об успехе подряд:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputInterface;
	use SymfonyComponentConsoleOutputOutputInterface;
	use SymfonyComponentConsoleStyleSymfonyStyle;
	
	class ArticleCommand extends Command
	{
		protected static $defaultName = 'app:article';
		
		protected function execute(InputInterface $input, OutputInterface $output): int
		{
			$io = new SymfonyStyle($input, $output);
			
			$io->success('Article created');
			$io->success('Article published');
			
			return Command::SUCCESS;
		}
	}
?>

Результат выполнения команды:

[OK] Article created
[OK] Article published

Смотрите также

класс SymfonyStyle,
который предоставляет методы для красивого вывода в консоль
метод error,
который выводит сообщение об ошибке
метод warning,
который выводит предупреждение
метод info,
который выводит информационное сообщение