Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wilderborn/partyline
Output to Laravel's console from outside of your Command classes.
https://github.com/wilderborn/partyline
command-line-tool console laravel laravel-5-package statamic tooling
Last synced: 5 days ago
JSON representation
Output to Laravel's console from outside of your Command classes.
- Host: GitHub
- URL: https://github.com/wilderborn/partyline
- Owner: wilderborn
- Created: 2017-06-01T18:46:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-14T18:38:59.000Z (almost 2 years ago)
- Last Synced: 2024-05-22T08:44:15.280Z (6 months ago)
- Topics: command-line-tool, console, laravel, laravel-5-package, statamic, tooling
- Language: PHP
- Homepage:
- Size: 6.84 KB
- Stars: 189
- Watchers: 6
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Partyline
This package allows you to output to the console from outside of command class.
For example, you might have a feature that does the same thing from a command and through the web.
Until now, you may have found yourself duplicating code just to be able to output to the console in various places.
With Partyline, you can use output commands within your logic. If it's being run inside the console, you'll see it. Otherwise, nothing will happen.
## Usage
In your console command's `handle` method, bind the command into Partyline using the facade:
``` php
public function handle()
{
\Partyline::bind($this);
}
```
Then in your regular classes, you may call any public `Illuminate\Console\Command` methods on the `Partyline` facade, just like you would inside the command class.
``` php
\Partyline::info('foo');
// Equivalent to $this->info('foo') within your command.
```
### Facade usage
You can either use the globally aliased facade with a slash:
```php
\Partyline::method();
```
Or, you can import the facade:
```php
use Wilderborn\Partyline\Facade as Partyline;
Partyline::method();
```
## Installation
This package can be installed through Composer.
```
composer require wilderborn/partyline
```
For Laravel 5.4 and below, register the service provider and facade:
``` php
// config/app.php
'providers' => [
...
Wilderborn\Partyline\ServiceProvider::class,
...
],
'aliases' => [
...
'Partyline' => Wilderborn\Partyline\Facade::class,
...
]
```
For Laravel 5.5+, this package will be [automatically discovered](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518).
## Tips
If you have many commands classes, you may find it tedious to bind into Partyline every time. You may consider an abstract command class and bind inside the `run` method.
``` php
class YourCommand extends AbstractCommand
{
public function handle()
{
//
}
}
```
``` php
class AbstractCommand extends Command
{
/**
* Run the console command.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @return int
*/
public function run(InputInterface $input, OutputInterface $output)
{
\Partyline::bind($this);
return parent::run($input, $output);
}
}
```
More info on our Statamic blog: