| Methods |
public
static
|
create(): PipelineInterface<mixed, mixed, mixed>
Get a new pipeline
|
#
|
public
|
send($payload, $arg = null)
Pass a payload to the pipeline
Pass a payload to the pipeline
Call {@see EntityPipelineInterface::run()} to run the pipeline and get
the result.
Implements
|
#
|
public
|
stream(iterable $payload, $arg = null)
Pass a list of payloads to the pipeline
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.
Implements
|
#
|
public
|
withConformity(int $conformity)
Set the payload's conformity level
Set the payload's conformity level
$conformity is passed to any array key mappers added to the pipeline
with {@see BasePipelineInterface::throughKeyMap()}. It has no effect
otherwise.
Parameters
| $conformity |
Use
{@see BasePipelineInterface::CONFORMITY_COMPLETE} wherever possible to
improve performance.
|
Implements
|
#
|
public
|
getConformity(): int
Get the payload's conformity level
Get the payload's conformity level
Implements
|
#
|
public
|
after(Closure $closure)
Apply a closure to each payload before it is sent
Apply a closure to each payload before it is sent
This method can only be called once per pipeline.
Implements
|
#
|
public
|
afterIf(Closure $closure)
Apply a closure to each payload before it is sent if after() hasn't
already been called
Apply a closure to each payload before it is sent if after() hasn't
already been called
Implements
|
#
|
public
|
through(Closure $pipe)
Add a pipe to the pipeline
Add a pipe to the pipeline
A pipe should do something with the $payload it receives 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
Implements
|
#
|
public
|
throughClosure(Closure $closure)
Add a simple closure to the pipeline
Add a simple closure to the pipeline
Implements
|
#
|
public
|
throughKeyMap(array $keyMap, int $flags = ArrayMapper::ADD_UNMAPPED)
Add an array key mapper to the pipeline
Add an array key mapper to the pipeline
Parameters
| $keyMap |
An array that maps
input keys to one or more output keys.
|
Implements
|
#
|
public
|
then(Closure $closure)
Apply a closure to each result
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.
Implements
|
#
|
public
|
thenIf(Closure $closure)
Apply a closure to each result if then() hasn't already been called
Apply a closure to each result if then() hasn't already been called
Implements
|
#
|
public
|
collectThen(Closure $closure)
Pass results to a closure in batches
Pass results to a closure in batches
This method 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.
Implements
|
#
|
public
|
collectThenIf(Closure $closure)
Pass results to a closure in batches if collectThen() hasn't already been
called
Pass results to a closure in batches if collectThen() hasn't already been
called
Implements
|
#
|
public
|
cc(Closure $closure)
Pass each result to a closure
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.
Implements
|
#
|
public
|
unless(Closure $filter)
Apply a filter to each result
Apply a filter to each result
This method can only be called once per pipeline.
If $filter returns false, $result is returned to the caller,
otherwise it is discarded.
Implements
|
#
|
public
|
unlessIf(Closure $filter)
Apply a filter to each result if unless() hasn't already been called
Apply a filter to each result if unless() hasn't already been called
Implements
|
#
|
public
|
run()
Run the pipeline and return the result
Run the pipeline and return the result
Implements
|
#
|
public
|
runInto(PipelineInterface $next)
Run the pipeline and pass the result to another pipeline
Run the pipeline and pass the result to another pipeline
Implements
|
#
|
public
|
start(): iterable
Run the pipeline with each of the payload's values and return the results
via a forward-only iterator
Run the pipeline with each of the payload's values and return the results
via a forward-only iterator
Implements
|
#
|
public
|
startInto(PipelineInterface $next)
Run the pipeline and pass each result to another pipeline
Run the pipeline and pass each result to another pipeline
Implements
|
#
|