How to add custom console commands and handle them?

dmitry_fedyuk · September 25, 2015, 7:47pm

Magento 2 has a lot of console commands.
The console command can be of 2 types:

Embedded: they are added by the \Magento\Setup\Console\CommandList::getCommandsClasses() method. See the full embedded commands list.
Custom: they are added by the modules, including the standard modules (see examples below).

You can add and handle new commands with your custom module.
Let see as an example the cache:enable core command.
It is declared by Mage_Backend core module in di.xml file:

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Backend/etc/di.xml#L152-L162


<type name="Magento\Framework\Console\CommandListInterface">
    <arguments>
        <argument name="commands" xsi:type="array">
            <item name="cacheEnableCommand" xsi:type="object">Magento\Backend\Console\Command\CacheEnableCommand</item>
            <item name="cacheDisableCommand" xsi:type="object">Magento\Backend\Console\Command\CacheDisableCommand</item>
            <item name="cacheFlushCommand" xsi:type="object">Magento\Backend\Console\Command\CacheFlushCommand</item>
            <item name="cacheCleanCommand" xsi:type="object">Magento\Backend\Console\Command\CacheCleanCommand</item>
            <item name="cacheStatusCommand" xsi:type="object">Magento\Backend\Console\Command\CacheStatusCommand</item>
        </argument>
    </arguments>
</type>

It is implemented in \Magento\Backend\Console\Command\CacheEnableCommand class.
Please note that a command must have a name set:

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Backend/Console/Command/CacheEnableCommand.php#L17-L22


protected function configure()
{
    $this->setName('cache:enable');
    $this->setDescription('Enables cache type(s)');
    parent::configure();
}

You must place the handling into the overriden execute method:

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php#L24-L42


protected function execute(InputInterface $input, OutputInterface $output)
{
    $isEnable = $this->isEnable();
    $types = $this->getRequestedTypes($input);
    $changedTypes = $this->cacheManager->setEnabled($types, $isEnable);
    if ($changedTypes) {
        $output->writeln('Changed cache status:');
        foreach ($changedTypes as $type) {
            $output->writeln(sprintf('%30s: %d -> %d', $type, !$isEnable, $isEnable));
        }
    } else {
        $output->writeln('There is nothing to change in cache status');
    }
    if (!empty($changedTypes) && $isEnable) {
        $this->cacheManager->clean($changedTypes);
        $output->writeln('Cleaned cache types:');
        $output->writeln(join(PHP_EOL, $changedTypes));
    }
}

dmitry_fedyuk · March 17, 2016, 5:50am

The simplest example

github.com

mage2pro/ru/blob/0.1.1/Translation/etc/di.xml#L7-L13


	<type name='Magento\Framework\Console\CommandListInterface'>
		<arguments>
			<argument name='commands' xsi:type='array'>
				<item name='Dfr\Translation\Update' xsi:type='object'>Dfr\Translation\Update</item>
			</argument>
		</arguments>
	</type>

github.com

mage2pro/ru/blob/0.1.1/Translation/Update.php#L1-L32


<?php
namespace Dfr\Translation;
use Symfony\Component\Console\Command\Command as _P;
use Symfony\Component\Console\Input\InputInterface as I;
use Symfony\Component\Console\Output\OutputInterface as O;
// 2017-06-21 «How to add custom console commands and handle them?» https://mage2.pro/t/85
final class Update extends _P {
	/**
	 * 2017-06-21
	 * @override
	 * @see _P::configure()
	 * @used-by _P::__construct()
	 */
	protected function configure() {
		$this->setName('dfr:translation:update');
		$this->setDescription('Updates the Dfr\* CSV files from the M2 built-in modules.');
		parent::configure();
	}


	/**
	 * 2017-06-21
	 * @override
	 * @see _P::execute()
	 * @param I $input
	 * @param O $output
	 * @return int
	 */
	protected function execute(I $input, O $output) {
		echo __METHOD__;
		return 0;
	}
}