Reference extends ScalarFunction
Methods
- __toString() : string
- as() : self
- base() : string
- children() : array<int, FunctionTree>
- Every operand of this node that is an expression, in constructor order.
- eval() : mixed
- hasAlias() : bool
- is() : bool
- name() : string
- resolved() : bool
- True when this node and every node in children() can answer returns().
- returns() : Type<string|int, mixed>
- The type of the column this function produces, before any row is read.
- sort() : SortOrder
- to() : string
- withChildren() : static
- A copy of this node with $children in place of children(): same count, same order, same per-element narrowing. Never mutates $this.
Methods
__toString()
public
__toString() : string
Return values
stringas()
public
as(string $alias) : self
Parameters
- $alias : string
Return values
selfbase()
public
base() : string
Return values
stringchildren()
Every operand of this node that is an expression, in constructor order.
public
children() : array<int, FunctionTree>
Raw scalars, enums, Types and scope-introducing bodies are fields, not children.
Return values
array<int, FunctionTree>eval()
public
eval(Row $row, FlowContext $context) : mixed
Parameters
- $row : Row
- $context : FlowContext
hasAlias()
public
hasAlias() : bool
Return values
boolis()
public
is(self $ref) : bool
Parameters
- $ref : self
Return values
boolname()
public
name() : string
Return values
stringresolved()
True when this node and every node in children() can answer returns().
public
resolved() : bool
Return values
boolreturns()
The type of the column this function produces, before any row is read.
public
returns() : Type<string|int, mixed>
Column-representable only: MixedType and a multi-member UnionType are refused; NullType is permitted. A top-level OptionalType is permitted and is what "this column is nullable" means - it is the only legal OptionalType position for a declaration, because OptionalType never nests and type_bare() strips exactly one level.
Return values
Type<string|int, mixed>sort()
public
sort() : SortOrder
Return values
SortOrderto()
public
to() : string
Return values
stringwithChildren()
A copy of this node with $children in place of children(): same count, same order, same per-element narrowing. Never mutates $this.
public
withChildren(array<int, FunctionTree> $children) : static
Parameters
- $children : array<int, FunctionTree>