Flow PHP

Expression implements Describable, PairPredicate

Read onlyYes

FinalYes

Interfaces

Describable
PairPredicate

Methods

__construct() : mixed
comparison() : Condition
describe() : null|Description
fromDescription() : static
keys() : JoinKeys|null: The equality pairs of a conjunction, each once, as column names; null when the comparison holds none (it is then verified on every pair of rows).
left() : array<string|int, Reference>
meet() : array<int, bool>
on() : self
prefix() : string
right() : array<string|int, Reference>
schema() : JoinSchema: Without a prefix, a join column named alike on both sides appears once: from the right side of a right join, from the left side otherwise.

__construct()


    public
                    __construct(Condition $comparison[, string $joinPrefix = '' ]) : mixed

Parameters

$comparison : Condition
$joinPrefix : string = ''

comparison()


    public
                    comparison() : Condition

Return values

Condition

describe()


    public
                    describe() : null|Description

Return values

null|Description —

null when this instance cannot cross a process boundary (a live client, a custom collaborator)

fromDescription()


    public
            static        fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static

Parameters

$data : array<string|int, mixed>
$rebuild : Rebuild

Return values

static

keys()

The equality pairs of a conjunction, each once, as column names; null when the comparison holds none (it is then verified on every pair of rows).


    public
                    keys() : JoinKeys|null

Return values

JoinKeys|null

left()


    public
                    left() : array<string|int, Reference>

Return values

array<string|int, Reference>

meet()


    public
                    meet(Rows $left, array<string|int, mixed> $leftIndices, Rows $right, array<string|int, mixed> $rightIndices) : array<int, bool>

Parameters

$left : Rows
$leftIndices : array<string|int, mixed>
$right : Rows
$rightIndices : array<string|int, mixed>: pairwise with $leftIndices

Return values

array<int, bool> —

pair i is (left row $leftIndices[i], right row $rightIndices[i])

on()


    public
            static        on(array<string|int, Condition>|array<string, string>|Condition $comparison[, string $joinPrefix = '' ]) : self

Parameters

$comparison : array<string|int, Condition>|array<string, string>|Condition
$joinPrefix : string = ''

Return values

self

prefix()


    public
                    prefix() : string

Return values

string

right()


    public
                    right() : array<string|int, Reference>

Return values

array<string|int, Reference>

schema()

Without a prefix, a join column named alike on both sides appears once: from the right side of a right join, from the left side otherwise.


    public
                    schema(JoinType $type) : JoinSchema

Parameters

$type : JoinType

Return values

JoinSchema