Flow PHP

Sort implements Node

Read onlyYes

FinalYes

Every row passes, but the output order is a function of the whole input, so the input is drained first.

Interfaces

Node

Properties

$algorithm : SortAlgorithmBuilder|null
$columns : array<int, SortColumn>

Methods

__construct() : mixed
children() : array<int, Node>: Inputs, in the order they are planned. children()[0] is the node's ROW INPUT - the chain a rule walks down and the chain Planner::pipelines() cuts into pipelines. A join's second child is the joined frame's whole plan: its Result or Outputs root, read without taking its rows as input and never rewritten by this plan's rewrites.
redefines() : Redefined: Columns this node introduces, renames or removes on its output. A predicate that references one of them means a different column below this node, so it cannot be pushed past it. Answered from what the node holds, never from a class list.
requiredInputColumns() : RequiredColumns
rowCount() : RowCount: What this node does to the row count. Answered from what the node holds, never from a class list.
transparency() : Transparency: Whether the node's output is a function of the rows it is handed, one at a time, with no effect outside the stream.
withChildren() : self: The same node over new children. Returns $this when the children are the ones it already holds, so an untouched subtree keeps its identity and its planned steps (PlannedNodes remembers them by identity).

$algorithm


        public
            SortAlgorithmBuilder|null
    $algorithm
     = null

$columns


        public
            array<int, SortColumn>
    $columns

__construct()


    public
                    __construct(Node $input, array<string|int, mixed> $columns[, SortAlgorithmBuilder|null $algorithm = null ]) : mixed

Parameters

$input : Node
$columns : array<string|int, mixed>
$algorithm : SortAlgorithmBuilder|null = null

children()

Inputs, in the order they are planned. children()[0] is the node's ROW INPUT - the chain a rule walks down and the chain Planner::pipelines() cuts into pipelines. A join's second child is the joined frame's whole plan: its Result or Outputs root, read without taking its rows as input and never rewritten by this plan's rewrites.


    public
                    children() : array<int, Node>

Return values

array<int, Node>

redefines()

Columns this node introduces, renames or removes on its output. A predicate that references one of them means a different column below this node, so it cannot be pushed past it. Answered from what the node holds, never from a class list.


    public
                    redefines() : Redefined

Return values

Redefined

requiredInputColumns()


    public
                    requiredInputColumns(RequiredColumns $output) : RequiredColumns

Parameters

$output : RequiredColumns

Return values

RequiredColumns

rowCount()

What this node does to the row count. Answered from what the node holds, never from a class list.


    public
                    rowCount() : RowCount

Return values

RowCount

transparency()

Whether the node's output is a function of the rows it is handed, one at a time, with no effect outside the stream.


    public
                    transparency() : Transparency

Return values

Transparency

withChildren()

The same node over new children. Returns $this when the children are the ones it already holds, so an untouched subtree keeps its identity and its planned steps (PlannedNodes remembers them by identity).


    public
                    withChildren(array<string|int, mixed> $children) : self

Parameters

$children : array<string|int, mixed>: exactly as many as children() returns

Return values

self