Tutorial: Console commands

Last updated:
Edit on GitHub

A console command is a PHP class that contains the implementation of a functionality that can get executed from the command line.

Spryker offers a wrapper over Symfony’s Console component that makes the implementation and configuration of a console command easier.

Implementing a new Console command

To demonstrate how to use and implement a console command, we will create one that clears the generated files folder and refreshes the application cache. The UpdateApplicationConsole will run the following commands in one step:

vendor/bin/console router:cache:warm-up
vendor/bin/console twig:cache:warmer
vendor/bin/console navigation:build-cache
vendor/bin/console glue:rest:build-request-validation-cache
  1. Create the UpdateApplicationConsole class.

The console commands must be added in Zed, under the Communication layer of the module, to the Console folder. The console command must extend the Console class from Spryker:

<?php
namespace Pyz\Zed\Tutorial\Communication\Console;

use Spryker\Zed\Kernel\Communication\Console\Console;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class UpdateApplicationConsole extends Console
{
//..
}
  1. Configure the new console command—specify the name and a short description:
<?php
...
    public const COMMAND_NAME = 'tutorial:update';
    public const DESCRIPTION = 'Refresh the application cache and generated files';

    /**
     * @return void
     */
    protected function configure(): void
    {
        $this->setName(self::COMMAND_NAME);
        $this->setDescription(self::DESCRIPTION);

        parent::configure();
    }
...
  1. Implement the UpdateApplicationConsole command.

The code that gets executed when the command is called from the command line must be placed in the execute function:

<?php
...

/**
 * @param \Symfony\Component\Console\Input\InputInterface $input
 * @param \Symfony\Component\Console\Output\OutputInterface $output
 *
 * @return int|null|void
 */
protected function execute(InputInterface $input, OutputInterface $output)
{
    $this->runDependingCommand('router:cache:warm-up');
    $this->info('Route cache was successfully updated', false);

    $this->runDependingCommand('twig:cache:warmer');
    $this->info('Twig cache was successfully updated', false);

    $this->runDependingCommand('navigation:build-cache');
    $this->info('Navigation cache was successfully updated', false);

    $this->runDependingCommand('glue:rest:build-request-validation-cache');
    $this->info('Glue request validation cache was successfully updated', false);
}
...
  1. Register the new console command.

To enable the console command, it must be registered in the getConsoleCommands() operation in the ConsoleDependencyProvider class:

<?php
...

/**
 * @return \Symfony\Component\Console\Command\Command[]
 */
public function getConsoleCommands()
{
    $commands = [
        ...
        new UpdateApplicationConsole(),

    ];
    return $commands;
}
...
  1. Test the new console command.
vendor/bin/console tutorial:update

That’s it! A new console command is created.