class ModelJoin extends Join
A ModelJoin is a Join object tied to a RelationMap object
Constants
EQUAL |
|
INNER_JOIN |
|
Methods
__construct(string $leftColumn = null, string $rightColumn = null, string $joinType = null)
Constructor Use it preferably with no arguments, and then use addCondition() and setJoinType() Syntax with arguments used mainly for backwards compatibility |
from Join | |
addCondition(string $left, string $right, string $operator = self::EQUAL)
Join condition definition. |
from Join | |
addConditions(array $lefts, array $rights, array $operators = array())
Join condition definition, for several conditions |
from Join | |
addExplicitCondition(string $leftTableName, string $leftColumnName, string $leftTableAlias, string $rightTableName, string $rightColumnName, string $rightTableAlias = null, string $operator = self::EQUAL)
Join condition definition. |
from Join | |
integer |
countConditions()
Retrieve the number of conditions in the join |
from Join |
array |
getConditions()
Return an array of the join conditions |
from Join |
addOperator(string $operator = null)
|
from Join | |
string |
getOperator(int $index)
|
from Join |
getOperators()
|
from Join | |
setJoinType(string $joinType = null)
Set the join type |
from Join | |
string |
getJoinType()
Get the join type |
from Join |
addLeftColumnName(string $left)
Add a left column name to the join condition |
from Join | |
string |
getLeftColumn(integer $index)
Get the fully qualified name of the left column of the join condition |
from Join |
string |
getLeftColumnName(integer $index)
Get the left column name of the join condition |
from Join |
array |
getLeftColumns()
Get the list of all the names of left columns of the join condition |
from Join |
setLeftTableName($leftTableName)
|
from Join | |
getLeftTableName()
|
from Join | |
setLeftTableAlias($leftTableAlias)
|
from Join | |
getLeftTableAlias()
|
from Join | |
hasLeftTableAlias()
|
from Join | |
getLeftTableAliasOrName()
|
from Join | |
getLeftTableWithAlias()
|
from Join | |
addRightColumnName(string $right)
Add a right column name to the join condition |
from Join | |
string |
getRightColumn(integer $index)
Get the fully qualified name of the right column of the join condition |
from Join |
string |
getRightColumnName(integer $index)
Get the right column name of the join condition |
from Join |
all |
getRightColumns()
|
from Join |
setRightTableName($rightTableName)
|
from Join | |
getRightTableName()
|
from Join | |
setRightTableAlias($rightTableAlias)
|
from Join | |
getRightTableAlias()
|
from Join | |
hasRightTableAlias()
|
from Join | |
getRightTableAliasOrName()
|
from Join | |
getRightTableWithAlias()
|
from Join | |
DBAdapter |
getDB()
Get the value of db. |
from Join |
void |
setDB(DBAdapter $db)
Set the value of db. |
from Join |
setJoinCondition(Criterion $joinCondition)
Set a custom join condition |
from Join | |
Criterion |
getJoinCondition()
Get the custom join condition, if previously set |
from Join |
buildJoinCondition(Criteria $c)
Set the custom join condition Criterion based on the conditions of this join |
from Join | |
string |
getClause(array $params)
Get the join clause for this Join. |
from Join |
bool |
equals(ModelJoin $join)
|
|
string |
toString()
Returns a String representation of the class, |
from Join |
__toString()
|
||
setRelationMap(RelationMap $relationMap, $leftTableAlias = null, $relationAlias = null)
|
||
getRelationMap()
|
||
ModelJoin |
setTableMap(TableMap $tableMap)
Sets the right tableMap for this join |
|
TableMap |
getTableMap()
Gets the right tableMap for this join |
|
ModelJoin |
setPreviousJoin(ModelJoin $join)
|
|
ModelJoin |
getPreviousJoin()
|
|
bool |
isPrimary()
|
|
setRelationAlias($relationAlias)
|
||
getRelationAlias()
|
||
hasRelationAlias()
|
||
Object |
getObjectToRelate(Object $startObject)
This method returns the last related, but already hydrated object up until this join Starting from $startObject and continuously calling the getters to get to the base object for the current join. |
Details
in Join at line 71
public
__construct(string $leftColumn = null, string $rightColumn = null, string $joinType = null)
Constructor Use it preferably with no arguments, and then use addCondition() and setJoinType() Syntax with arguments used mainly for backwards compatibility
in Join at line 97
public
addCondition(string $left, string $right, string $operator = self::EQUAL)
Join condition definition.
Warning: doesn't support table aliases. Use the explicit methods to use aliases.
in Join at line 122
public
addConditions(array $lefts, array $rights, array $operators = array())
Join condition definition, for several conditions
in Join at line 152
public
addExplicitCondition(string $leftTableName, string $leftColumnName, string $leftTableAlias, string $rightTableName, string $rightColumnName, string $rightTableAlias = null, string $operator = self::EQUAL)
Join condition definition.
in Join at line 169
public integer
countConditions()
Retrieve the number of conditions in the join
in Join at line 179
public array
getConditions()
Return an array of the join conditions
in Join at line 196
public
addOperator(string $operator = null)
in Join at line 206
public string
getOperator(int $index)
in Join at line 211
public
getOperators()
in Join at line 223
public
setJoinType(string $joinType = null)
Set the join type
in Join at line 233
public string
getJoinType()
Get the join type
in Join at line 249
public
addLeftColumnName(string $left)
Add a left column name to the join condition
in Join at line 267
public string
getLeftColumn(integer $index)
Get the fully qualified name of the left column of the join condition
in Join at line 287
public string
getLeftColumnName(integer $index)
Get the left column name of the join condition
in Join at line 297
public array
getLeftColumns()
Get the list of all the names of left columns of the join condition
in Join at line 307
public
setLeftTableName($leftTableName)
in Join at line 314
public
getLeftTableName()
in Join at line 319
public
setLeftTableAlias($leftTableAlias)
in Join at line 326
public
getLeftTableAlias()
in Join at line 331
public
hasLeftTableAlias()
in Join at line 336
public
getLeftTableAliasOrName()
in Join at line 341
public
getLeftTableWithAlias()
in Join at line 357
public
addRightColumnName(string $right)
Add a right column name to the join condition
in Join at line 375
public string
getRightColumn(integer $index)
Get the fully qualified name of the right column of the join condition
in Join at line 395
public string
getRightColumnName(integer $index)
Get the right column name of the join condition
in Join at line 403
public all
getRightColumns()
in Join at line 413
public
setRightTableName($rightTableName)
in Join at line 420
public
getRightTableName()
in Join at line 425
public
setRightTableAlias($rightTableAlias)
in Join at line 432
public
getRightTableAlias()
in Join at line 437
public
hasRightTableAlias()
in Join at line 442
public
getRightTableAliasOrName()
in Join at line 447
public
getRightTableWithAlias()
in Join at line 459
public DBAdapter
getDB()
Get the value of db.
The DBAdapter which might be used to get db specific variations of sql.
in Join at line 472
public void
setDB(DBAdapter $db)
Set the value of db.
The DBAdapter might be used to get db specific variations of sql.
in Join at line 482
public
setJoinCondition(Criterion $joinCondition)
Set a custom join condition
in Join at line 492
public Criterion
getJoinCondition()
Get the custom join condition, if previously set
in Join at line 502
public
buildJoinCondition(Criteria $c)
Set the custom join condition Criterion based on the conditions of this join
in Join at line 533
public string
getClause(array $params)
Get the join clause for this Join.
If the join condition needs binding, uses the passed params array.
at line 156
public bool
equals(ModelJoin $join)
in Join at line 577
public string
toString()
Returns a String representation of the class,
at line 164
public
__toString()
at line 34
public
setRelationMap(RelationMap $relationMap, $leftTableAlias = null, $relationAlias = null)
at line 50
public
getRelationMap()
at line 62
public ModelJoin
setTableMap(TableMap $tableMap)
Sets the right tableMap for this join
at line 74
public TableMap
getTableMap()
Gets the right tableMap for this join
at line 88
public ModelJoin
setPreviousJoin(ModelJoin $join)
at line 98
public ModelJoin
getPreviousJoin()
at line 106
public bool
isPrimary()
at line 111
public
setRelationAlias($relationAlias)
at line 116
public
getRelationAlias()
at line 121
public
hasRelationAlias()
at line 138
public Object
getObjectToRelate(Object $startObject)
This method returns the last related, but already hydrated object up until this join Starting from $startObject and continuously calling the getters to get to the base object for the current join.
This method only works if PreviousJoin has been defined, which only happens when you provide dotted relations when calling join