Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/efrane/consoleadditions
Tools to make working with Symfony Console even more awesome.
https://github.com/efrane/consoleadditions
console php-library symfony symfony-console
Last synced: 6 days ago
JSON representation
Tools to make working with Symfony Console even more awesome.
- Host: GitHub
- URL: https://github.com/efrane/consoleadditions
- Owner: eFrane
- License: mit
- Created: 2017-10-16T16:15:37.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T16:21:05.000Z (18 days ago)
- Last Synced: 2024-10-31T21:47:19.621Z (15 days ago)
- Topics: console, php-library, symfony, symfony-console
- Language: PHP
- Homepage:
- Size: 1.24 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://travis-ci.org/eFrane/ConsoleAdditions)
[](https://packagist.org/packages/efrane/console-additions)
[](https://packagist.org/packages/efrane/console-additions)
[](https://packagist.org/packages/efrane/console-additions)
# Console Additions
Tools to make working with Symfony Console even more awesome.
## Installation
This package is available on [Packagist](https://packagist.org/packages/efrane/console-additions):
```bash
composer require efrane/console-additions
```
## The Additions
### `Batch`
This class offers batching commands of a Symfony Console Application. This can be
useful when writing things like deployment or update scripts as console commands
which call many other commands in a set order e.g. cache updating, database
migrations, etc.
Usage in a `Command::execute`:
```php
\EFrane\ConsoleAdditions\Command\Batch::create($this->getApplication(), $output)
->add('my:command --with-option')
->add('my:other:command for-this-input')
->run();
```
**Shell Commands**
Batches can be an intertwined set of console application and system shell
commands. This is an advanced feature which requires the `symfony/process`
package as additional dependency.
Since shell commands internally create `Process` objects, the `Batch` API
exposes to methods for adding a shell command:
- `addShell` adds the process with the given configuration (see Batch::addShell for details)
- `addShellCb(string $cmd, callable $cb)` creates the process and passes it to a callback
for further configuration. This is especially useful when the desired command requires
some kind of process piping.
**Silencing Errors**
It is possible to run a Batch of commands without throwing exceptions.
### Output
This Package offers additional console output interfaces:
#### `FileOutput`
FileOutputs write all their data to a file stream and come in to concrete flavours:
- `NativeFileOutput` uses the native PHP file streaming functions, thus being a good
option for local destinations and depending on your servers PHP streaming protocols
configuration it might even suffice for remote destinations.
- `FlysystemFileOutput` on the other hand passes the stream data on to a
`league/flysystem`-Adapter, thus being able to send that data to any Flysystem-supported
destination, i.e. S3, Dropbox, FTP, etc.
#### `MultiplexedOutput`
MultiplexedOutput can be used to combine multiple output interfaces to act as one.
This is the logical companion of file outputs since usually one would probably
want to send the output to the user's console and some other destination.
A simple setup inside might look like this:
```php
class Command extends \Symfony\Component\Console\Command {
public function execute(InputInterface $input, OutputInterface $output) {
// send output to multiple destinations
$output = new \EFrane\ConsoleAdditions\Output\MultiplexedOutput([
$output,
new \EFrane\ConsoleAdditions\Output\NativeFileOutput('command.log')
]);
// normal console command
}
}
```