140 lines
4.4 KiB
PHP
140 lines
4.4 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Messenger\Command;
|
|
|
|
use Symfony\Component\Console\Attribute\AsCommand;
|
|
use Symfony\Component\Console\Command\Command;
|
|
use Symfony\Component\Console\Completion\CompletionInput;
|
|
use Symfony\Component\Console\Completion\CompletionSuggestions;
|
|
use Symfony\Component\Console\Exception\RuntimeException;
|
|
use Symfony\Component\Console\Input\InputArgument;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Console\Style\SymfonyStyle;
|
|
|
|
/**
|
|
* A console command to debug Messenger information.
|
|
*
|
|
* @author Roland Franssen <franssen.roland@gmail.com>
|
|
*/
|
|
#[AsCommand(name: 'debug:messenger', description: 'List messages you can dispatch using the message buses')]
|
|
class DebugCommand extends Command
|
|
{
|
|
public function __construct(
|
|
private array $mapping,
|
|
) {
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure(): void
|
|
{
|
|
$this
|
|
->addArgument('bus', InputArgument::OPTIONAL, sprintf('The bus id (one of "%s")', implode('", "', array_keys($this->mapping))))
|
|
->setHelp(<<<'EOF'
|
|
The <info>%command.name%</info> command displays all messages that can be
|
|
dispatched using the message buses:
|
|
|
|
<info>php %command.full_name%</info>
|
|
|
|
Or for a specific bus only:
|
|
|
|
<info>php %command.full_name% command_bus</info>
|
|
|
|
EOF
|
|
)
|
|
;
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int
|
|
{
|
|
$io = new SymfonyStyle($input, $output);
|
|
$io->title('Messenger');
|
|
|
|
$mapping = $this->mapping;
|
|
if ($bus = $input->getArgument('bus')) {
|
|
if (!isset($mapping[$bus])) {
|
|
throw new RuntimeException(sprintf('Bus "%s" does not exist. Known buses are "%s".', $bus, implode('", "', array_keys($this->mapping))));
|
|
}
|
|
$mapping = [$bus => $mapping[$bus]];
|
|
}
|
|
|
|
foreach ($mapping as $bus => $handlersByMessage) {
|
|
$io->section($bus);
|
|
|
|
$tableRows = [];
|
|
foreach ($handlersByMessage as $message => $handlers) {
|
|
if ($description = self::getClassDescription($message)) {
|
|
$tableRows[] = [sprintf('<comment>%s</>', $description)];
|
|
}
|
|
|
|
$tableRows[] = [sprintf('<fg=cyan>%s</fg=cyan>', $message)];
|
|
foreach ($handlers as $handler) {
|
|
$tableRows[] = [
|
|
sprintf(' handled by <info>%s</>', $handler[0]).$this->formatConditions($handler[1]),
|
|
];
|
|
if ($handlerDescription = self::getClassDescription($handler[0])) {
|
|
$tableRows[] = [sprintf(' <comment>%s</>', $handlerDescription)];
|
|
}
|
|
}
|
|
$tableRows[] = [''];
|
|
}
|
|
|
|
if ($tableRows) {
|
|
$io->text('The following messages can be dispatched:');
|
|
$io->newLine();
|
|
$io->table([], $tableRows);
|
|
} else {
|
|
$io->warning(sprintf('No handled message found in bus "%s".', $bus));
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
private function formatConditions(array $options): string
|
|
{
|
|
if (!$options) {
|
|
return '';
|
|
}
|
|
|
|
$optionsMapping = [];
|
|
foreach ($options as $key => $value) {
|
|
$optionsMapping[] = $key.'='.$value;
|
|
}
|
|
|
|
return ' (when '.implode(', ', $optionsMapping).')';
|
|
}
|
|
|
|
private static function getClassDescription(string $class): string
|
|
{
|
|
try {
|
|
$r = new \ReflectionClass($class);
|
|
|
|
if ($docComment = $r->getDocComment()) {
|
|
$docComment = preg_split('#\n\s*\*\s*[\n@]#', substr($docComment, 3, -2), 2)[0];
|
|
|
|
return trim(preg_replace('#\s*\n\s*\*\s*#', ' ', $docComment));
|
|
}
|
|
} catch (\ReflectionException) {
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
|
|
{
|
|
if ($input->mustSuggestArgumentValuesFor('bus')) {
|
|
$suggestions->suggestValues(array_keys($this->mapping));
|
|
}
|
|
}
|
|
}
|