1. class
  2. Hypervel
  3. \
  4. Grpc
  5. \
  6. Server
  7. \
  8. Pipeline

Pipeline

class Pipeline extends Pipeline

internal  
 

Map failures at the closest gRPC middleware boundary.

Traits

Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
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
protected string|UnitEnum|false|null $withinTransaction

Indicates whether to wrap the pipeline in a database transaction.

 from  Pipeline

Methods

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

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

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

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

from  Conditionable
static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

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

Create a new class instance.

from  Pipeline
Pipeline
send(mixed $passable)

Set the object being sent through the pipeline.

from  Pipeline
Pipeline
through(mixed $pipes)

Set the array of pipes.

from  Pipeline
Pipeline
pipe(mixed $pipes)

Push additional pipes onto the pipeline.

from  Pipeline
Pipeline
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
Closure
toClosure(Closure $destination)

Create a reusable closure that receives a value on each invocation.

from  Pipeline
mixed
thenReturn()

Run the pipeline and return the result.

from  Pipeline
Pipeline
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
Pipeline
withinTransaction(string|UnitEnum|false|null $withinTransaction = null)

Execute each pipeline step within a database transaction.

from  Pipeline
Container
getContainer()

Get the container instance.

from  Pipeline
Pipeline
setContainer(Container $container)

Set the container instance.

from  Pipeline
mixed
handleCarry(mixed $carry)

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

from  Pipeline
mixed
handleException(mixed $passable, Throwable $e)

Map the given exception to an RPC failure value.

static void
flushState()

Flush all static state.

from  Pipeline

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

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

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

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

Return Value

mixed

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new class instance.

Parameters

Container|null $container

in Pipeline at line 65
Pipeline send(mixed $passable)

Set the object being sent through the pipeline.

Parameters

mixed $passable

Return Value

Pipeline

in Pipeline at line 77
Pipeline through(mixed $pipes)

Set the array of pipes.

Parameters

mixed $pipes

Return Value

Pipeline

in Pipeline at line 89
Pipeline pipe(mixed $pipes)

Push additional pipes onto the pipeline.

Parameters

mixed $pipes

Return Value

Pipeline

in Pipeline at line 101
Pipeline via(string $method)

Set the method to call on the pipes.

Parameters

string $method

Return Value

Pipeline

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

Run the pipeline with a final destination callback.

Parameters

Closure $destination

Return Value

mixed

in Pipeline at line 124
Closure toClosure(Closure $destination)

Create a reusable closure that receives a value on each invocation.

Class middleware resolves inside each call using its container lifetime. Supplied middleware objects and captured closure state remain shared. Transaction and finally callbacks are applied per invocation. Keep this pipeline's configuration unchanged while using the closure.

Parameters

Closure $destination

Return Value

Closure

in Pipeline at line 148
mixed thenReturn()

Run the pipeline and return the result.

Return Value

mixed

in Pipeline at line 160
Pipeline finally(Closure $callback)

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

Parameters

Closure $callback

Return Value

Pipeline

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

Get the final piece of the Closure onion.

Parameters

Closure $destination

Return Value

Closure

in Pipeline at line 184
protected Closure carry()

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

Return Value

Closure

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

Parse full pipe string to get name and parameters.

Parameters

string $pipe

Return Value

array

in Pipeline at line 255
protected array pipes()

Get the array of configured pipes.

Return Value

array

in Pipeline at line 265
Pipeline withinTransaction(string|UnitEnum|false|null $withinTransaction = null)

Execute each pipeline step within a database transaction.

Parameters

string|UnitEnum|false|null $withinTransaction

Return Value

Pipeline

in Pipeline at line 275
protected Container getContainer()

Get the container instance.

Return Value

Container

in Pipeline at line 289
Pipeline setContainer(Container $container)

Set the container instance.

Parameters

Container $container

Return Value

Pipeline

in Pipeline at line 299
protected mixed handleCarry(mixed $carry)

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

Parameters

mixed $carry

Return Value

mixed

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

Map the given exception to an RPC failure value.

Parameters

mixed $passable
Throwable $e

Return Value

mixed

in Pipeline at line 317
static void flushState()

Flush all static state.

Return Value

void