ivoba / console-service-provider
console service provider for Silex
Installs: 123 479
Dependents: 2
Suggesters: 1
Security: 0
Stars: 4
Watchers: 4
Forks: 1
Open Issues: 0
Requires
- php: >=5.5
- silex/silex: ~2.0
- symfony/console: ~3.0
Requires (Dev)
- phpunit/phpunit: ^4.8
This package is auto-updated.
Last update: 2024-10-10 21:43:10 UTC
README
Provides a Symfony\Component\Console
based console for Silex.
Credits
This project is based on https://github.com/KnpLabs/ConsoleServiceProvider which is unmaintained.
Install
Add ivoba/console-service-provider
to your composer.json
and register the service:
<?php use Ivoba\Silex\Provider\ConsoleServiceProvider; $app->register(new ConsoleServiceProvider(), [ 'console.name' => 'MyApplication', 'console.version' => '1.0.0', 'console.project_directory' => __DIR__.'/..' ]); ?>
You can now copy the console
executable in whatever place you see fit, and tweak it to your needs. You will need a way to fetch your silex application, the most common way is to return it from your bootstrap:
<?php $app = new Silex\Application(); // your beautiful silex bootstrap return $app; ?>
For the rest of this document, we will assume you do have an app
directory, so the console
executable will be located at app/console
.
Usage
Use the console just like any Symfony\Component
based console:
$ app/console my:command
Write commands
Your commands should extend Ivoba\Silex\Command\Command
to have access to the 2 useful following commands:
getSilexApplication
, which returns the silex applicationgetProjectDirectory
, which returns your project's root directory (as configured earlier)
I know, it's a lot to learn, but it's worth the pain.
Register commands
There are two ways of registering commands to the console application.
Directly access the console application from the console
executable
Open up app/console
, and stuff your commands directly into the console application:
#!/usr/bin/env php <?php set_time_limit(0); $app = require_once __DIR__.'/bootstrap.php'; use My\Command\MyCommand; $application = $app['console']; $application->add(new MyCommand()); $application->run(); ?>
Use the Event Dispatcher
This way is intended for use by provider developers and exposes an unobstrusive way to register commands in 3 simple steps:
- Register a listener to the
ConsoleEvents::INIT
event - ???
- PROFIT!
Example:
<?php use My\Command\MyCommand; use Ivoba\Silex\Console\ConsoleEvents; use Ivoba\Silex\Console\ConsoleEvent; $app['dispatcher']->addListener(ConsoleEvents::INIT, function(ConsoleEvent $event) { $app = $event->getApplication(); $app->add(new MyCommand()); }); ?>