0

Final Class Yiisoft\Queue\Command\RunCommand

InheritanceYiisoft\Queue\Command\RunCommand » Symfony\Component\Console\Command\Command

Protected Methods

Hide inherited methods

Method Description Defined By
execute() Yiisoft\Queue\Command\RunCommand

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Queue\Provider\QueueConsumerProviderInterface $queueProvider )
$queueProvider Yiisoft\Queue\Provider\QueueConsumerProviderInterface

                public function __construct(
    private readonly QueueConsumerProviderInterface $queueProvider,
) {
    parent::__construct();
}

            
configure() public method

public void configure ( )

                public function configure(): void
{
    $this->addArgument(
        'queue',
        InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
        'Queue name list to connect to.',
        [],
    )
        ->addOption(
            'limit',
            'm',
            InputOption::VALUE_REQUIRED,
            'Maximum number of messages to process in each queue. Default is 0 (no limits).',
            0,
        )
        ->addUsage('[queue1 [queue2 [...]]] --limit 100');
}

            
execute() protected method

protected integer execute ( \Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output )
$input \Symfony\Component\Console\Input\InputInterface
$output \Symfony\Component\Console\Output\OutputInterface

                protected function execute(InputInterface $input, OutputInterface $output): int
{
    /** @var string[] $queueNames */
    $queueNames = $input->getArgument('queue');
    if ($queueNames === []) {
        $queueNames = $this->queueProvider->getConsumerQueueNames();
    }
    /** @var string $queueName */
    foreach ($queueNames as $queueName) {
        $queueConsumer = $this->queueProvider->getConsumer($queueName);
        $output->write("Processing queue $queueName... ");
        $count = $queueConsumer->run((int) $input->getOption('limit'));
        $output->writeln("Messages processed: $count.");
    }
    return 0;
}