SlotFlow API Documentation

Cascade extends Flow
in package

Backward-compatible inventory-oriented alias for Flow.

use Flow instead

Table of Contents

Methods

__construct()  : mixed
create()  : FlowStepBuilder
Add a creation step from nil into matching destination slots.
define()  : static
Build a flow fluently in one call.
destroy()  : FlowStepBuilder
Add a destruction step from matching source slots into nil.
move()  : FlowStepBuilder
Add a movement step from one slot pattern to another.
name()  : string
Return the flow name.
reverseIf()  : static
Conditionally reverse step order, optionally flipping edge direction too.
stepByLabeledEdges()  : FlowStepBuilder
Add a step that resolves its candidate edges from one or more labeled edge rules.
steps()  : array<int, FlowStep>
Return the compiled list of movement steps.

Methods

__construct()

public __construct(string $name) : mixed
Parameters
$name : string

create()

Add a creation step from nil into matching destination slots.

public create(string|array<string|int, mixed>|null $to) : FlowStepBuilder
Parameters
$to : string|array<string|int, mixed>|null
Tags
psalm-param

TSlotPattern $to

Return values
FlowStepBuilder

define()

Build a flow fluently in one call.

public static define(string $name, Closure $builder) : static
Parameters
$name : string
$builder : Closure
Return values
static

destroy()

Add a destruction step from matching source slots into nil.

public destroy(string|array<string|int, mixed>|null $from) : FlowStepBuilder
Parameters
$from : string|array<string|int, mixed>|null
Tags
psalm-param

TSlotPattern $from

Return values
FlowStepBuilder

move()

Add a movement step from one slot pattern to another.

public move(string|array<string|int, mixed>|null $from, string|array<string|int, mixed>|null $to) : FlowStepBuilder
Parameters
$from : string|array<string|int, mixed>|null
$to : string|array<string|int, mixed>|null
Tags
psalm-param

TSlotPattern $from

psalm-param

TSlotPattern $to

Return values
FlowStepBuilder

name()

Return the flow name.

public name() : string
Return values
string

reverseIf()

Conditionally reverse step order, optionally flipping edge direction too.

public reverseIf(bool $condition[, bool $flipEdges = true ]) : static
Parameters
$condition : bool
$flipEdges : bool = true
Return values
static

stepByLabeledEdges()

Add a step that resolves its candidate edges from one or more labeled edge rules.

public stepByLabeledEdges(non-empty-string ...$edgeLabels) : FlowStepBuilder
Parameters
$edgeLabels : non-empty-string
Return values
FlowStepBuilder

steps()

Return the compiled list of movement steps.

public steps() : array<int, FlowStep>
Return values
array<int, FlowStep> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results