eth8505/zf-symfony-console

symfony/console module for zendframework3+

!!!! THIS PACKAGE IS NO LONGER MAINTAINED, PLEASE USE eth8505/laminas-symfony-console INSTEAD !!!!, _(*1)

Eth8585\ZfSymfonyConsole - Zend Framework 3 Symfony Console Module

The Eth8585\ZfSymfonyConsole module allows to use the symfony console component with Zend Framework 3., _(*2)

How to install

Install eth8505/zf-symfony-console package via composer., _(*3)

$ composer require eth8505/zf-symfony-console

Load the module in your application.config.php file like so:, _(*4)

<?php

return [
    'modules' => [
        'Eth8505\ZfSymfonyConsole\\',
        // ...
    ],
];

How to use

You can use the vendor/bin/console tool to run your commands. This tool may be in a different directory depending on how your composers bin-dir is configured., _(*5)

Depending on how you did setup your Zend Framework 3 project, you might need to modify public/index.php. For example this is neccassary if you did use the Zend MVC Skeleton project., _(*6)

Firstly that file has to return the Application instance for this library to work., _(*7)

Optionally you might only invoke the run() method of Zend\Mvc\Application if public/index.php has not been called via the PHP CLI. This will avoid cluttering up your console with the view., _(*8)

How do I create console commands?

1. Create command

Create commands as described in the symfony console docs. Please note that if you're using a fully-fledged zend-framework, it won't be possible to use all the nice symfony service container logic., _(*9)

2. Register with service manager

You can either register your commands with the service manager via the config in your module.config.php:, _(*10)

<?php

return [
    'zfsymfonyconsole_commands' => [
        'invokables' => [
            MyCommand::class
        ]
    ]
];

or register it in your module class using the ConsoleCommandProviderInterface:, _(*11)

<?php

namespace MyModule;

use Eth8505\ZfSymfonyConsole\ConsoleCommandProviderInterface;

class Module implements ConsoleCommandProviderInterface {

    /**
     * @inheritdoc 
     */
    public function getConsoleCommandConfig() {

        return [
            'invokables' => [
                MyCommand::class
            ]
        ];

    }

}

3. Your command is ready to go

Your command will now show up when using the bin/console utility and can be called with whatever you set up in the commands configure method., _(*12)

Thanks

Thanks to Rafi Adnan and his RDN Console module which this module is loosely based upon., _(*13)