Метод isDebug класса Output

Метод isDebug класса Output возвращает булево значение true, если вывод работает в режиме отладки, и false в противном случае. В режиме отладки уровень многословности вывода соответствует константе VERBOSITY_DEBUG. Этот метод не принимает параметров и часто используется для условного вывода отладочной информации в консольных командах.

Синтаксис

public function isDebug(): bool

Пример

Давайте создадим команду, которая проверяет режим отладки и выводит соответствующее сообщение:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputInterface;
	use SymfonyComponentConsoleOutputOutputInterface;
	
	class DebugCommand extends Command
	{
		protected static $defaultName = 'app:debug';
		
		protected function execute(InputInterface $input, OutputInterface $output): int
		{
			if ($output->isDebug()) {
				$output->writeln('Debug mode is enabled');
			} else {
				$output->writeln('Debug mode is disabled');
			}
			
			return Command::SUCCESS;
		}
	}
?>

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

"Debug mode is disabled"

Результат выполнения команды с флагом -vvv:

php bin/console app:debug -vvv

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

"Debug mode is enabled"

Пример

Давайте выведем массив отладочных данных только при включённом режиме отладки:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputInterface;
	use SymfonyComponentConsoleOutputOutputInterface;
	
	class DataCommand extends Command
	{
		protected static $defaultName = 'app:data';
		
		protected function execute(InputInterface $input, OutputInterface $output): int
		{
			$res = ['a', 'b', 'c', 'd', 'e'];
			
			if ($output->isDebug()) {
				foreach ($res as $item) {
					$output->writeln($item);
				}
			}
			
			return Command::SUCCESS;
		}
	}
?>

Результат выполнения команды с флагом -vvv:

php bin/console app:data -vvv

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

"a"
"b"
"c"
"d"
"e"

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

класс Output,
который представляет поток вывода
метод isVerbose,
который проверяет подробный режим вывода
метод isVeryVerbose,
который проверяет очень подробный режим вывода
метод isQuiet,
который проверяет тихий режим вывода