1. class
  2. Illuminate
  3. \
  4. Routing
  5. \
  6. Pipeline

Pipeline

class Pipeline extends Pipeline (View source)

This extended pipeline catches any exceptions that occur during each slice.

The exceptions are converted to HTTP responses for proper middleware handling.

Traits

Conditionable

Properties

protected Container|null $container

The container implementation.

 from  Pipeline
protected mixed $passable

The object being passed through the pipeline.

 from  Pipeline
protected array $pipes

The array of class pipes.

 from  Pipeline
protected string $method

The method to call on each pipe.

 from  Pipeline
protected Closure|null $finally

The final callback to be executed after the pipeline ends regardless of the outcome.

 from  Pipeline

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
__construct(Container|null $container = null)

Create a new class instance.

from  Pipeline
$this
send(mixed $passable)

Set the object being sent through the pipeline.

from  Pipeline
$this
through(array|mixed $pipes)

Set the array of pipes.

from  Pipeline
$this
pipe(array|mixed $pipes)

Push additional pipes onto the pipeline.

from  Pipeline
$this
via(string $method)

Set the method to call on the pipes.

from  Pipeline
mixed
then(Closure $destination)

Run the pipeline with a final destination callback.

from  Pipeline
mixed
thenReturn()

Run the pipeline and return the result.

from  Pipeline
$this
finally(Closure $callback)

Set a final callback to be executed after the pipeline ends regardless of the outcome.

from  Pipeline
Closure
prepareDestination(Closure $destination)

Get the final piece of the Closure onion.

from  Pipeline
Closure
carry()

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

from  Pipeline
array
parsePipeString(string $pipe)

Parse full pipe string to get name and parameters.

from  Pipeline
array
pipes()

Get the array of configured pipes.

from  Pipeline
Container
getContainer()

Get the container instance.

from  Pipeline
$this
setContainer(Container $container)

Set the container instance.

from  Pipeline
mixed
handleCarry(mixed $carry)

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

mixed
handleException(mixed $passable, Throwable $e)

Handle the given exception.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Pipeline at line 56
__construct(Container|null $container = null)

Create a new class instance.

Parameters

Container|null $container

in Pipeline at line 67
$this send(mixed $passable)

Set the object being sent through the pipeline.

Parameters

mixed $passable

Return Value

$this

in Pipeline at line 80
$this through(array|mixed $pipes)

Set the array of pipes.

Parameters

array|mixed $pipes

Return Value

$this

in Pipeline at line 93
$this pipe(array|mixed $pipes)

Push additional pipes onto the pipeline.

Parameters

array|mixed $pipes

Return Value

$this

in Pipeline at line 106
$this via(string $method)

Set the method to call on the pipes.

Parameters

string $method

Return Value

$this

in Pipeline at line 119
mixed then(Closure $destination)

Run the pipeline with a final destination callback.

Parameters

Closure $destination

Return Value

mixed

in Pipeline at line 139
mixed thenReturn()

Run the pipeline and return the result.

Return Value

mixed

in Pipeline at line 152
$this finally(Closure $callback)

Set a final callback to be executed after the pipeline ends regardless of the outcome.

Parameters

Closure $callback

Return Value

$this

in Pipeline at line 165
protected Closure prepareDestination(Closure $destination)

Get the final piece of the Closure onion.

Parameters

Closure $destination

Return Value

Closure

in Pipeline at line 181
protected Closure carry()

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

Return Value

Closure

in Pipeline at line 225
protected array parsePipeString(string $pipe)

Parse full pipe string to get name and parameters.

Parameters

string $pipe

Return Value

array

in Pipeline at line 243
protected array pipes()

Get the array of configured pipes.

Return Value

array

in Pipeline at line 255
protected Container getContainer()

Get the container instance.

Return Value

Container

Exceptions

RuntimeException

in Pipeline at line 270
$this setContainer(Container $container)

Set the container instance.

Parameters

Container $container

Return Value

$this

at line 24
protected mixed handleCarry(mixed $carry)

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

Parameters

mixed $carry

Return Value

mixed

at line 40
protected mixed handleException(mixed $passable, Throwable $e)

Handle the given exception.

Parameters

mixed $passable
Throwable $e

Return Value

mixed

Exceptions

Throwable