wilderborn/partyline

A Laravel 5 package to output to the console from outside of command classes

Partyline

This package allows you to output to the console from outside of command class., _(*1)

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., _(*2)

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., _(*3)

Usage

In your console command's handle method, bind the command into Partyline using the facade:, _(*4)

``` php public function handle() { \Partyline::bind($this); }, <sub>(*5)</sub>

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:, <sub>(*6)</sub>

\Partyline::method();

Or, you can import the facade:, <sub>(*7)</sub>

use Wilderborn\Partyline\Facade as Partyline;

Partyline::method();

Installation

This package can be installed through Composer., <sub>(*8)</sub>

composer require wilderborn/partyline

For Laravel 5.4 and below, register the service provider and facade:, <sub>(*9)</sub>

``` php // config/app.php 'providers' => [ ... Wilderborn\Partyline\ServiceProvider::class, ... ],, <sub>(*10)</sub>

'aliases' => [ ... 'Partyline' => Wilderborn\Partyline\Facade::class, ... ], <sub>(*11)</sub>

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);, <sub>(*12)</sub>

    return parent::run($input, $output);
}

} ```, <sub>(*13)</sub>

More info on our Statamic blog: https://statamic.com/blog/partyline, <sub>(*14)</sub>