Writing Your Own Command

General Considerations

We would recommend to read Symfony’s guide to creating basic command prior to proceed further. SiteSupra mostly follows the same approach with a few minor differences:

• A command must extend Supra\Core\Console\AbstractCommand (or implement Supra\Core\DependencyInjection\ContainerAware), read more about that in Dependency Injection chapter;
• There is no limit on where you can store your commands or what namespace are you using. SiteSupra does not autoload commands, so you are free to choose your class structure.

Basic console command can look like shown below:

<?php

namespace Some\Your\Namespace\Command;

use Supra\Core\Console\AbstractCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class FoobarCommand extends AbstractCommand
{
    protected function configure()
    {
        $this->setName('foobar:do')
            ->setDescription('Does some foobar');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        //foobar is happening here
    }
}

Of course, you can use any of the helpers bundled in Symfony Console - tables, dialogs, and so on.

Registering New Command from Your Package

Let’s assume that you have a Package created (refer to Creating Sample CMS Package for package creating instructions). Now you can register a new command instance in package’s inject() method:

<?php

namespace Vendor\Package;
use Supra\Core\DependencyInjection\ContainerInterface
use Some\Your\Namespace\Command\FoobarCommand;
use Supra\Core\Package\AbstractSupraPackage;

class FoobarPackage extends AbstractSupraPackage
{
    public function inject(ContainerInterface $container)
    {
        //some magic here...

        $container->getConsole()->add(new FoobarCommand());

        //even more magic here...
    }
}

After that, you can run your command with supra/cli.php foobar:do (shortcuts like supra/cli.php f:d are working also).