radnan/rdn-console

Zend Framework 2 Symfony Console module

RdnConsole - Zend Framework Symfony Console Module

The RdnConsole module bridges the Symfony Console component with Zend Framework 2., _(*1)

How to install

Use composer to require the radnan/rdn-console package:, _(*2)

$ composer require radnan/rdn-console:1.*

Activate the module by including it in your application.config.php file:, _(*3)

<?php

return array(
    'modules' => array(
        'RdnConsole',
        // ...
    ),
);

How to use

You can use the vendor/bin/console utility to run your commands. This utility might be in a different directory depending on your composer's bin-dir configuration., _(*4)

The module will also take over all zf2 console routes. So you can simply run php public/index.php to run your commands as well., _(*5)

Make sure you return your application variable $app in your public/index.php file:, _(*6)

// ...
return Zend\Mvc\Application::init($config);

How to create commands

Create your commands inside your module, register them with the console command service locator, and finally inject the command into the console application., _(*7)

Let's create a hello world command inside our App module:, _(*8)

1. Create command class

Create the class App\Console\Command\HelloWorld by extending RdnConsole\Command\AbstractCommand:, _(*9)

<?php

namespace App\Console\Command;

use RdnConsole\Command\AbstractCommand;
use RdnConsole\Command\ConfigurableInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class HelloWorld extends AbstractCommand implements ConfigurableInterface
{
    public function configure()
    {
        $this->adapter
            ->setName('app:hello-world')
            ->setDescription('Test hello world command')
        ;
    }

    public function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('Hello world!');
    }
}

2. Register command with service locator

Place the following in your module.config.php file (or in your module's getConfig() method):, _(*10)

<?php

return array(
    'rdn_console_commands' => array(
        'invokables' => array(
            'App:HelloWorld' => 'App\Console\Command\HelloWorld',
        ),
    ),
);

3. Inject command into console application

Now, place the following in your module.config.php file:, _(*11)

<?php

return array(
    'rdn_console' => array(
        'commands' => array(
            'App:HelloWorld',
        ),
    ),
);

4. Run the command!

Now you can simply run vendor/bin/console app:hello-world to run this command., _(*12)

Sample command

A sample RdnConsole:CacheClear command is provided with the module. You can enable it by including the following in your module.config.php:, _(*13)

<?php

return array(
    'rdn_console' => array(
        'commands' => array(
            'RdnConsole:CacheClear',
        ),
    ),
);

Command Adapter

You'll notice the command uses an adapter to configure itself:, _(*14)

public function configure()
{
    $this->adapter
        ->setName('app:hello-world')
        ->setDescription('Test hello world command')
    ;
}

This is slightly different from the default Symfony workflow. You must always use this adapter to talk with symfony: to get the command name, get helpers, etc., _(*15)

We use the adapter in order to separate the configuration from the execution code. The benefits of this are explained in the next section., _(*16)

Factories

The best part about this module is that it allows us to separate a command's configuration from it's actual execution code., _(*17)

What does this mean? Well, let's say you have a lot of commands, each with multiple dependencies. If we were to create our commands the default way, Symfony would load each command and all its dependencies every time., _(*18)

But this is inefficient and slows down the application. Instead, this module will only load the initial configuration required to display the available list of commands., _(*19)

Then when you are ready to actually execute the command, the module will use the factory pattern to create the command, load all its dependencies, and finally run the execution code., _(*20)

How to create commands using factories

1. Create command class

Create your command class like you would normally, but don't implement the ConfigurableInterface. We also include any external dependencies:, _(*21)

<?php

namespace App\Console\Command;

use RdnConsole\Command\AbstractCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class HelloWorld extends AbstractCommand
{
    protected $dependency;

    public function __construct($dependency)
    {
        $this->dependency = $dependency;
    }

    public function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('Hello world!');
    }
}

2. Create command factory

Next, we create the factory for this class by extending the RdnConsole\Factory\Command\AbstractCommandFactory class. This factory class will contain the command's configuration. You must also implement the create() method to create the actual command object:, _(*22)

<?php

namespace App\Factory\Console\Command;

use App\Console\Command;
use RdnConsole\Factory\Command\AbstractCommandFactory;

class HelloWorld extends AbstractCommandFactory
{
    public function configure()
    {
        $this->adapter
            ->setName('app:hello-world')
            ->setDescription('Test hello world command')
        ;
    }

    protected function create()
    {
        $dependency = $this->service('External dependency');
        return new Command\HelloWorld($dependency);
    }
}

The AbstractCommandFactory class extends the AbstractFactory class from the rdn-factory module., _(*23)

3. Register command factory with service locator

Finally, we register this factory with the service locator replacing our previous invokable class:, _(*24)

<?php

return array(
    'rdn_console_commands' => array(
        'factories' => array(
            'App:HelloWorld' => 'App\Factory\Console\Command\HelloWorld',
        ),
    ),
);