Download the PHP package district5/cli without Composer
On this page you can find all versions of the php package district5/cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download district5/cli
More information about district5/cli
Files in district5/cli
Package cli
Short Description Easy to use CLI driven PHP applications.
License mit
Homepage https://github.com/district-5/php-cli
Informations about the package cli
District5\Cli
Originally from the OhConsole project.
Cli is a simple interface to create advanced PHP CLI applications by abstracting the commands into separated classes.
Composer
Theory
Arguments get converted to namespaces. The final route class must be appended with Route
. So for example, a fully
qualified class name of SomeApp\Foo\Bar\ProcessMyTasksRoute
could be called with some-app foo bar process-my-tasks
A much simpler example would be Config\Get\UrlRoute
which would be called with config get url
Quick Start
To get started in a hurry, first create your core command file. Generally this could be bin/console
.
This file should contain something like this:
Examples
Once you've got your example set up, call your main script (see below) and pass one of the commands defined in the PHP files.
Adding some arguments..
There are two different argument types you can pass into this script.
- Simple - Numeric -
./script.php command arg1 arg2 ...
- Retrievable with
getArgument(0)
andgetArgument(1)
- Retrievable with
- Advanced - Named -
./script.php command --foo=bar --hello=world ...
- Arguments are processed by
CliArgvs
. You can retrieve this object in your command by callinggetCliArgvs
- Retrievable with
getArgument('foo')
andgetArgument('hello')
- You can chain these into an array and calling
getArgument('foo')
would return an array. ./script.php command --foo=bar --foo=another --foo=andAnother
- Arguments are processed by
To send arguments into the route, simply append them. For example, appending hello
onto the end of the above script
would allow you to use the getArgument(0)
method within the command to retrieve the parameter.
-
In the route:
- Bash:
Here's a sample console.php
that you could use to get started.