Zend Framework 2 : Step by Step Create Console Application

Sometimes, console is more interactive than GUI, and quicker to be executed. Console Application often need by cron job or generator for your datawarehouse that summarize your transactional data. It’s very easy in Zend Framework 2.
Just define console route, register controller invokables, set help for command line ( if necessary ), and run it.

Before we doing anything, if we run :

php index.php

and the console will show the following :
In this post, I will show you an example to show how to get current processes of your server by rule :

Firstly, set the module.config.php

return array(

    'controllers' => array(
        'invokables' => array(
            'MyModule\Controller\Do' => 'MyModule\Controller\DoController',
            )
    ),

    'console' => array(
        'router' => array(
            'routes' => array(
                'get-happen-use' => array(
                    'options' => array(
                                    // add [ and ] if optional ( ex : [<doname>] )
                        'route' => 'get happen [--verbose|-v] <doname>', 
                        'defaults' => array(
                            '__NAMESPACE__' => 'MyModule\Controller',
                            'controller' => 'do',
                            'action' => 'donow'
                        ),
                    ),
                ),
            )
        )
    ),

);

So, the Controller code may be like this :

namespace MyModule\Controller;

use Zend\Mvc\Controller\AbstractActionController,
    Zend\Console\Request as ConsoleRequest;

class DoController extends AbstractActionController
{

    public function donowAction()
    {
        $request = $this->getRequest();

        // Make sure that we are running in a console and the user has not tricked our
        // application into running this action from a public web server.
        if (!$request instanceof ConsoleRequest){
            throw new \RuntimeException('You can only use this action from a console!');
        }

        // Get system service name  from console and check if the user used --verbose or -v flag
        $doname   = $request->getParam('doname', false);
        $verbose     = $request->getParam('verbose');

        $shell = "ps aux";
        if ($doname){
            $shell .= " |grep -i $doname ";
        }
        $shell .= " > /Users/abdulmalikikhsan/www/success.txt ";
        //execute...
        system($shell, $val);

        if(!$verbose){
            echo "Process listed in /Users/abdulmalikikhsan/www/success.txt \r\n";
        }else{
            $file = fopen('/Users/abdulmalikikhsan/www/success.txt',"r");

            while(! feof($file)){
                $listprocess = trim( fgets($file) );

                echo $listprocess."\r\n";
            }
            fclose($file);
        }
    }
}

And if we run :

php index.php get happen --verbose apache2

we will get the result :

NB :
For Console usage help, add the following in Module class :

namespace MyModule;

use Zend\ModuleManager\Feature\AutoloaderProviderInterface,
    Zend\ModuleManager\Feature\ConfigProviderInterface,
    Zend\ModuleManager\Feature\ConsoleUsageProviderInterface,
    Zend\Console\Adapter\AdapterInterface as Console;

class Module implements
    AutoloaderProviderInterface,
    ConfigProviderInterface,
    ConsoleUsageProviderInterface
{
    public function getAutoloaderConfig(){ /* common code*/ }
    public function getConfig(){ /* common code */}

    public function getConsoleUsage(Console $console)
    {
	return array(
            // Describe available commands
            'get happen [--verbose|-v] <doname>'    => 'Get Process already happen',

            // Describe expected parameters
            array( 'doname',            'Process Name' ),
            array( '--verbose|-v',     '(optional) turn on verbose mode'        ),

	);
    }
}

Done !

References :
1. http://zf2.readthedocs.org/en/latest/modules/zend.console.introduction.html