bgaze/silex-console-provider

This package is abandoned and no longer maintained. No replacement package was suggested.

CLI application service provider for Silex

dev-master 2017-08-27 16:16 UTC

Requires

• php: >=5.6.0
• silex/silex: ~2.0
• symfony/console: ~3.0
• symfony/filesystem: ~3.0

MIT

• Benjamin Gazé

• silex
• php
• console
• service
• provider
• serviceprovider

README

Provides for Silex :

• a handy way to create custom console commands.
• clear cache command : $ php bin/console cache:clear.

Please check Console component documentation for more details about how to use console and build commands.

Installation

Import the provider with Composer:

$ composer require bgaze/silex-console-provider dev-master

Clear cache commands requires cache path to be defined under cache_dir key :

$app['cache_dir'] = __DIR__ . '/../var/cache';

Then register it in your app :

use Bgaze\Silex\Provider\ConsoleServiceProvider;
$app->register(new ConsoleServiceProvider(), ['console.name' => 'My Application', 'console.version' => 'n/a']);
$app['console']->add(new \Bgaze\Silex\Console\Command\ClearCacheCommand());

Usage

Assuming your console executable is bin/console, call any of command like this :

$ php bin/console your:command

Clear your application cache like this :

$ php bin/console cache:clear

Write commands

Your commands should extend Bgaze\Silex\Console\Command\AbstractCommand.
This base class provide acces to the current Silex application under $app protected attribute.

Here is a custom command example :

<?php

namespace MyApp\Command;

use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Bgaze\Silex\Console\Command\AbstractCommand;

class MyCommand extends AbstractCommand {

    public function isEnabled() {
        if (!isset($this->app['my_value'])) {
            return false;
        }

        return parent::isEnabled();
    }

    protected function configure() {
        $this
            ->setName('my:command')
            ->setDefinition([
                new InputArgument('foo', InputArgument::REQUIRED, 'A required argument'),
                new InputOption('bar', 'b', InputOption::VALUE_REQUIRED, 'An option with default value', 'Bar!')
            ])
            ->setDescription('This is a demo command ...');
    }

    protected function execute(InputInterface $input, OutputInterface $output) {
        $foo = $input->getArgument('foo');
        $output->writeln('Foo : ' . $foo);

        $bar = $input->getOption('bar');
        $output->writeln('Bar : ' . $bar);
    }

}

Credits

This provider is heavily inspired from codito/silex-console-provider

More stuff

• Pre-configured skeleton for the Silex microframework
• Silex service provider for Symfony finder component