Download the PHP package radnan/rdn-console without Composer

RdnConsole - Zend Framework Symfony Console Module

The RdnConsole module bridges the Symfony Console component with Zend Framework 2.

How to install

Use composer to require the radnan/rdn-console package:

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

Activate the module by including it in your application.config.php file:

2. Register command with service locator

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

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.

We use the adapter in order to separate the configuration from the execution code. The benefits of this are explained in the next section.

Factories

The best part about this module is that it allows us to separate a command's configuration from it's actual execution code.

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.

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.

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.

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:

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:

The AbstractCommandFactory class extends the AbstractFactory class from the rdn-factory module.

3. Register command factory with service locator

Finally, we register this factory with the service locator replacing our previous invokable class:

<?php

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