class Joinable

Constants

JOIN_SIDE_LEFT

JOIN_SIDE_INNER

JOIN_TYPE_ONE_TO_ONE

JOIN_TYPE_MANY_TO_ONE

JOIN_TYPE_ONE_TO_MANY

Properties

protected string $baseTable
protected string $baseColumn
protected string $targetTable
protected string $targetColumn
protected string $alias
protected array $conditions
protected string $joinSide
protected int $joinType
protected string $entity
protected array $entityFields

Methods

__construct($targetTable, $targetColumn, string|null $alias = NULL)

No description

array
getConditionsForJoin(string|null $baseTableAlias = NULL)

Gets conditions required when joining to a base table

string
getBaseTable()

No description

$this
setBaseTable(string $baseTable)

No description

string
getBaseColumn()

No description

$this
setBaseColumn(string $baseColumn)

No description

string
getAlias()

No description

$this
setAlias(string $alias)

No description

string
getTargetTable()

No description

string
getTargetColumn()

No description

string
getEntity()

No description

$this
addCondition($condition)

No description

array
getExtraJoinConditions()

No description

$this
setConditions(array $conditions)

No description

string
getJoinSide()

No description

$this
setJoinSide(string $joinSide)

No description

int
getJoinType()

No description

$this
setJoinType(int $joinType)

No description

array
toArray()

No description

getEntityFields()

No description

FieldSpec|NULL
getField($fieldName)

No description

Details

at line 109
__construct($targetTable, $targetColumn, string|null $alias = NULL)

Parameters

$targetTable
$targetColumn
string|null $alias

at line 126
array getConditionsForJoin(string|null $baseTableAlias = NULL)

Gets conditions required when joining to a base table

Parameters

string|null $baseTableAlias Name of the base table, if aliased.

Return Value

array

at line 141
string getBaseTable()

Return Value

string

at line 150
$this setBaseTable(string $baseTable)

Parameters

string $baseTable

Return Value

$this

at line 159
string getBaseColumn()

Return Value

string

at line 168
$this setBaseColumn(string $baseColumn)

Parameters

string $baseColumn

Return Value

$this

at line 177
string getAlias()

Return Value

string

at line 186
$this setAlias(string $alias)

Parameters

string $alias

Return Value

$this

at line 195
string getTargetTable()

Return Value

string

at line 202
string getTargetColumn()

Return Value

string

at line 209
string getEntity()

Return Value

string

at line 218
$this addCondition($condition)

Parameters

$condition

Return Value

$this

at line 227
array getExtraJoinConditions()

Return Value

array

at line 236
$this setConditions(array $conditions)

Parameters

array $conditions

Return Value

$this

at line 245
string getJoinSide()

Return Value

string

at line 254
$this setJoinSide(string $joinSide)

Parameters

string $joinSide

Return Value

$this

at line 263
int getJoinType()

Return Value

int

at line 272
$this setJoinType(int $joinType)

Parameters

int $joinType

Return Value

$this

at line 281
array toArray()

Return Value

array

at line 288
FieldSpec[] getEntityFields()

Return Value

FieldSpec[]

at line 303
FieldSpec|NULL getField($fieldName)

Parameters

$fieldName

Return Value

FieldSpec|NULL