This RFC is dealing with the CLI components of the Zend Framework 2 and should discuss:
- the need for CLI component(s)
- various use cases
- requirements
- possible, but not final, implementations
This RFC is planned to be discussed on the next ZF2 IRC meeting, which will be held on November 9th (1)
It is based on a few mailing list threads - (2), (3), (4), (5) - and 2 CLI prototypes by Matt Cockayne and Robert Basic.
The goal is to have two separate components, Zend\Console and Zend\Cli (naming of these components is open to discussion). In context, “CLI components” refers to both Zend\Console and Zend\Cli.
Zend\Console should deal with “low level” problems, like, console argument parsing and outputting to STDOUT\STDERR, similar to what Zend\Console\Getopt is now. At most, it should rely only on the Zend\Stdlib component, on classes and interfaces defined in it. This would assure that this component can be used outside of Zend Framework as a standalone component for writing CLI scripts.
Zend\Cli should deal with “higher level” problems, like writing complete CLI modules and applications. Zend\Cli should utilise Zend\Console and follow as close as possible and necessary the Zend\Mvc component. Basically, it would offer a command line entry point to an MVC style application.
Why we need CLI components?
To ease creating of CLI scripts, modules and applications, and, most likely, other ZF2 components like Zend\Tool.
Use cases
The biggest use case so far is the Module Installation and Distribution (6) which should be the main driving force behind these CLI components, in both the requirements and the deadline for these CLI components to provide something usable and useful.
Other uses cases include cron scripts, development modules and tools, which could help with project management (for example, Zend\Tool)...
Requirements
Implementations
Various links
(1) 2011-11-09 Meeting Agenda
(2) http://zend-framework-community.634137.n4.nabble.com/A-ZF2-Cli-module-td3865659.html
(3) http://zend-framework-community.634137.n4.nabble.com/Cli-Prototype-td3922653.html
(4) http://zend-framework-community.634137.n4.nabble.com/Parsing-console-arguments-td3934526.html
(5) http://zend-framework-community.634137.n4.nabble.com/Improving-Zend-Console-td3934296.html
(6) RFC - Module Installation and Distribution