PHP code example of radnan / rdn-console

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

radnan / rdn-console example snippets

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.

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.

Make sure you return your application variable `$app` in your `public/index.php` file:

~~~php
// ...
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.

Let's create a hello world command inside our `App` module:

### 1. Create command class

Create the class `App\Console\Command\HelloWorld` by extending `RdnConsole\Command\AbstractCommand`:

~~~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!');
	}

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:

~~~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.

## 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`:

~~~php


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

## Command Adapter

You'll notice the command uses an adapter to configure itself:

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

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!');
	}

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);
	}