Pipeline

class Pipeline implements Pipeline (View source)

Properties

protected Container $container The container implementation.
protected mixed $passable The object being passed through the pipeline.
protected array $pipes The array of class pipes.
protected string $method The method to call on each pipe.

Methods

void __construct(Container $container = null)

Create a new class instance.
$this send(mixed $passable)

Set the object being sent through the pipeline.
$this through(array|mixed $pipes)

Set the array of pipes.
$this via(string $method)

Set the method to call on the pipes.
mixed then(Closure $destination)

Run the pipeline with a final destination callback.
mixed thenReturn()

Run the pipeline and return the result.
Closure prepareDestination(Closure $destination)

Get the final piece of the Closure onion.
Closure carry()

Get a Closure that represents a slice of the application onion.
array parsePipeString(string $pipe)

Parse full pipe string to get name and parameters.
array pipes()

Get the array of configured pipes.
Container getContainer()

Get the container instance.
mixed handleCarry(mixed $carry)

Handle the value returned from each pipe before passing it to the next.
mixed handleException(mixed $passable, Exception $e)

Handle the given exception.

Details

void __construct(Container $container = null)

Create a new class instance.

Parameters

Container $container

Return Value

void

$this send(mixed $passable)

Set the object being sent through the pipeline.

Parameters

mixed $passable

Return Value

$this

$this through(array|mixed $pipes)

Set the array of pipes.

Parameters

array|mixed $pipes

Return Value

$this

$this via(string $method)

Set the method to call on the pipes.

Parameters

string $method

Return Value

$this

mixed then(Closure $destination)

Run the pipeline with a final destination callback.

Parameters

Closure $destination

Return Value

mixed

mixed thenReturn()

Run the pipeline and return the result.

Return Value

mixed

protected Closure prepareDestination(Closure $destination)

Get the final piece of the Closure onion.

Parameters

Closure $destination

Return Value

Closure

protected Closure carry()

Get a Closure that represents a slice of the application onion.

Return Value

Closure

protected array parsePipeString(string $pipe)

Parse full pipe string to get name and parameters.

Parameters

string $pipe

Return Value

array

protected array pipes()

Get the array of configured pipes.

Return Value

array

protected Container getContainer()

Get the container instance.

Return Value

Container

Exceptions

RuntimeException

protected mixed handleCarry(mixed $carry)

Handle the value returned from each pipe before passing it to the next.

Parameters

mixed $carry

Return Value

mixed

protected mixed handleException(mixed $passable, Exception $e)

Handle the given exception.

Parameters

mixed $passable
Exception $e

Return Value

mixed

Exceptions

Exception

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Pipeline/Pipeline.html