Атрибут description

Атрибут description класса Command позволяет задать текстовое описание консольной команды. Это описание отображается в списке доступных команд при выполнении команды php artisan list, а также в справке по конкретной команде при использовании флага --help. В отличие от свойства signature, которое определяет имя и синтаксис команды, атрибут description носит исключительно информативный характер и не влияет на логику выполнения команды.

Синтаксис

<?php
	namespace AppConsoleCommands;
	
	use IlluminateConsoleCommand;
	
	class MyCommand extends Command
	{
		protected $description = 'Command description text';
	}
?>

Пример

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

<?php
	namespace AppConsoleCommands;
	
	use IlluminateConsoleCommand;
	
	class HelloCommand extends Command
	{
		protected $signature = 'hello {name? : The name of the user}';
		protected $description = 'Display a hello message to the user';
		
		public function handle()
		{
			$name = $this->argument('name') ?? 'World';
			$this->info("Hello, {$name}!");
		}
	}
?>

Теперь посмотрим, как эта команда будет выглядеть в списке доступных команд:

php artisan list

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

"hello Display a hello message to the user"

Пример

Рассмотрим команду для очистки кэша с подробным многострочным описанием:

<?php
	namespace AppConsoleCommands;
	
	use IlluminateConsoleCommand;
	use IlluminateSupportFacadesCache;
	
	class CacheClearCommand extends Command
	{
		protected $signature = 'cache:custom-clear';
		protected $description = 'Clear all application cache data including redis and file drivers';
		
		public function handle()
		{
			Cache::flush();
			$this->info('Cache cleared successfully!');
		}
	}
?>

Посмотрим справку по этой команде:

php artisan cache:custom-clear --help

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

"Description: Clear all application cache data including redis and file drivers"

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

атрибут signature,
который определяет имя и синтаксис команды
метод handle,
который содержит логику выполнения команды
команда make:command,
которая создаёт новый класс консольной команды
метод info,
который выводит информационное сообщение