class Join
Data object to describe a join between two tables, for example <pre> table_a LEFT JOIN table_b ON table_a.id = table_b.a_id </pre>
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 |
||
addCondition(string $left, string $right, string $operator = self::EQUAL)
Join condition definition. |
||
addConditions(array $lefts, array $rights, array $operators = array())
Join condition definition, for several conditions |
||
addExplicitCondition(string $leftTableName, string $leftColumnName, string $leftTableAlias = null, string $rightTableName, string $rightColumnName, string $rightTableAlias = null, string $operator = self::EQUAL)
Join condition definition. |
||
integer |
countConditions()
Retrieve the number of conditions in the join |
|
array |
getConditions()
Return an array of the join conditions |
|
addOperator(string $operator = null) | ||
string | getOperator(int $index) | |
getOperators() | ||
setJoinType(string $joinType = null)
Set the join type |
||
string |
getJoinType()
Get the join type |
|
addLeftColumnName(string $left)
Add a left column name to the join condition |
||
string |
getLeftColumn(integer $index)
Get the fully qualified name of the left column of the join condition |
|
string |
getLeftColumnName(integer $index)
Get the left column name of the join condition |
|
array |
getLeftColumns()
Get the list of all the names of left columns of the join condition |
|
setLeftTableName($leftTableName) | ||
getLeftTableName() | ||
setLeftTableAlias($leftTableAlias) | ||
getLeftTableAlias() | ||
hasLeftTableAlias() | ||
getLeftTableAliasOrName() | ||
getLeftTableWithAlias() | ||
addRightColumnName(string $right)
Add a right column name to the join condition |
||
string |
getRightColumn(integer $index)
Get the fully qualified name of the right column of the join condition |
|
string |
getRightColumnName(integer $index)
Get the right column name of the join condition |
|
all | getRightColumns() | |
setRightTableName($rightTableName) | ||
getRightTableName() | ||
setRightTableAlias($rightTableAlias) | ||
getRightTableAlias() | ||
hasRightTableAlias() | ||
getRightTableAliasOrName() | ||
getRightTableWithAlias() | ||
DBAdapter |
getDB()
Get the value of db. |
|
void |
setDB(DBAdapter $db)
Set the value of db. |
|
setJoinCondition(Criterion $joinCondition)
Set a custom join condition |
||
Criterion |
getJoinCondition()
Get the custom join condition, if previously set |
|
buildJoinCondition(Criteria $c)
Set the custom join condition Criterion based on the conditions of this join |
||
string |
getClause(array $params)
Get the join clause for this Join. |
|
bool | equals(Join $join) | |
string |
toString()
Returns a String representation of the class, |
|
__toString() |
Details
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
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.
at line 122
public
addConditions(array $lefts, array $rights, array $operators = array())
Join condition definition, for several conditions
at line 151
public
addExplicitCondition(string $leftTableName, string $leftColumnName, string $leftTableAlias = null, string $rightTableName, string $rightColumnName, string $rightTableAlias = null, string $operator = self::EQUAL)
Join condition definition.
at line 168
public integer
countConditions()
Retrieve the number of conditions in the join
at line 178
public array
getConditions()
Return an array of the join conditions
at line 195
public
addOperator(string $operator = null)
at line 204
public string
getOperator(int $index)
at line 209
public
getOperators()
at line 221
public
setJoinType(string $joinType = null)
Set the join type
at line 232
public string
getJoinType()
Get the join type
at line 247
public
addLeftColumnName(string $left)
Add a left column name to the join condition
at line 263
public string
getLeftColumn(integer $index)
Get the fully qualified name of the left column of the join condition
at line 281
public string
getLeftColumnName(integer $index)
Get the left column name of the join condition
at line 290
public array
getLeftColumns()
Get the list of all the names of left columns of the join condition
at line 300
public
setLeftTableName($leftTableName)
at line 307
public
getLeftTableName()
at line 312
public
setLeftTableAlias($leftTableAlias)
at line 319
public
getLeftTableAlias()
at line 324
public
hasLeftTableAlias()
at line 329
public
getLeftTableAliasOrName()
at line 334
public
getLeftTableWithAlias()
at line 349
public
addRightColumnName(string $right)
Add a right column name to the join condition
at line 365
public string
getRightColumn(integer $index)
Get the fully qualified name of the right column of the join condition
at line 383
public string
getRightColumnName(integer $index)
Get the right column name of the join condition
at line 391
public all
getRightColumns()
at line 401
public
setRightTableName($rightTableName)
at line 408
public
getRightTableName()
at line 413
public
setRightTableAlias($rightTableAlias)
at line 420
public
getRightTableAlias()
at line 425
public
hasRightTableAlias()
at line 430
public
getRightTableAliasOrName()
at line 435
public
getRightTableWithAlias()
at line 446
public DBAdapter
getDB()
Get the value of db.
The DBAdapter which might be used to get db specific
variations of sql.
at line 457
public void
setDB(DBAdapter $db)
Set the value of db.
The DBAdapter might be used to get db specific variations of sql.
at line 467
public
setJoinCondition(Criterion $joinCondition)
Set a custom join condition
at line 477
public Criterion
getJoinCondition()
Get the custom join condition, if previously set
at line 487
public
buildJoinCondition(Criteria $c)
Set the custom join condition Criterion based on the conditions of this join
at line 517
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 547
public bool
equals(Join $join)
at line 560
public string
toString()
Returns a String representation of the class,