Class Salient\Core\Pipeline

Creates a new Pipeline object

Creates a new Pipeline object

Pass a payload to the pipeline

Call {@see EntityPipelineInterface::run()} to run the pipeline and get the result.

Pass a list of payloads to the pipeline

Call {@see StreamPipelineInterface::start()} to run the pipeline with each value in $payload and get the results via a generator.

Set the payload's array key conformity

$conformity is passed to any array key mappers added to the pipeline with {@see BasePipelineInterface::throughKeyMap()}. It has no effect otherwise.

Get the payload's array key conformity

Apply a closure to each payload before it is sent

This method can only be called once per pipeline.

Apply a closure to each payload before it is sent if after() hasn't already been called

Add a pipe to the pipeline

A pipe must be one of the following:

• an instance of a class that implements {@see PipeInterface}
• the name of a class that implements {@see PipeInterface}
• a closure

Whichever form it takes, a pipe should do something with $payload before taking one of the following actions:

• return the value of $next($payload)
• return a value that will be discarded by {@see StreamPipelineInterface::unless()}, bypassing any remaining pipes and {@see BasePipelineInterface::then()}, if applicable
• throw an exception

Add a simple closure to the pipeline

Add an array key mapper to the pipeline

Apply a closure to each result

This method can only be called once per pipeline, and only if {@see StreamPipelineInterface::collectThen()} is not also called.

Apply a closure to each result if then() hasn't already been called

Pass results to a closure in batches

{@see StreamPipelineInterface::collectThen()} can only be called once per pipeline, and only if {@see BasePipelineInterface::then()} is not also called.

Values returned by the closure are returned to the caller via a forward-only iterator.

Pass results to a closure in batches if collectThen() hasn't already been called

Pass each result to a closure

Results not discarded by {@see StreamPipelineInterface::unless()} are passed to the closure before leaving the pipeline. The closure's return value is ignored.

Apply a filter to each result

{@see StreamPipelineInterface::unless()} can only be called once per pipeline.

If $filter returns false, $result is returned to the caller, otherwise it is discarded.

Apply a filter to each result if unless() hasn't already been called

Run the pipeline and return the result

Run the pipeline and pass the result to another pipeline

Run the pipeline with each of the payload's values and return the results via a forward-only iterator

Run the pipeline and pass each result to another pipeline