Как добавлять и обрабатывать своим модулем дополнительные консольные команды

dmitrii_fediuk · 25.Сентябрь.2015 19:56:39

Magento 2 поддерживает множество консольных команд.
Консольные команды бывают двух видов:

Встроенные: они добавляются методом \Magento\Setup\Console\CommandList::getCommandsClasses(). Я составил полный перечень встроенных консольных команд.
Дополнительные: они добавляются модулями, в том числе и стандартными модулями Magento 2 (смотрите примеры ниже).

Вы можете своим модулем добавлять и обрабатывать дополнительные консольные команды.
В качестве примера обработки консольной команды рассмотрим стандартную команду cache:enable.
Эта команда описана модулем Mage_Backend в файле di.xml file:

github.com

magento/magento2/blob/daf301d625d8652996a6d3c9400e5f9816184bde/app/code/Magento/Backend/etc/di.xml#L155


    </arguments>
</virtualType>
<type name="Magento\Backend\Model\Session\Quote">
    <arguments>
        <argument name="storage" xsi:type="object">Magento\Backend\Model\Session\Quote\Storage</argument>
    </arguments>
</type>
<type name="Magento\Framework\Console\CommandList">
    <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>
<virtualType name="Magento\Setup\BackendApp" type="Magento\Backend\App\BackendApp">
    <arguments>
        <argument name="cookiePath" xsi:type="string">setup</argument>

Обработчиком этой команды является класс \Magento\Backend\Console\Command\CacheEnableCommand.
Обратите внимание, что Вы должены в конструкторе присвоить своей консольной команде имя (именно оно используется в командной строке):

github.com

magento/magento2/blob/daf301d625d8652996a6d3c9400e5f9816184bde/app/code/Magento/Backend/Console/Command/CacheEnableCommand.php#L19


/**
* Command for enabling cache
*/
class CacheEnableCommand extends AbstractCacheSetCommand
{
   /**
    * {@inheritdoc}
    */
   protected function configure()
   {
       $this->setName('cache:enable');
       $this->setDescription('Enables cache type(s)');
       parent::configure();
   }


   /**
    * Is enable cache
    *
    * @return bool
    */
   protected function isEnable()

Вы должны перекрыть метод execute и поместить туда программный код обработки консольной команды:

github.com

magento/magento2/blob/daf301d625d8652996a6d3c9400e5f9816184bde/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));
    }
}