function SelectInterface::leftJoin
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::leftJoin()
- 10 core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::leftJoin()
- 11.x core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::leftJoin()
Left Outer Join against another table in the database.
Parameters
$table: The table against which to join. May be a string or another SelectQuery object. If a query object is passed, it will be used as a subselect. Unless the table name starts with the database / schema name and a dot it will be prefixed.
$alias: The alias for the table. In most cases this should be the first letter of the table, or the first letter of each "word" in the table.
$condition: The condition on which to join this table. If the join requires values, this clause should use a named placeholder and the value or values to insert should be passed in the 4th parameter. For the first table joined on a query, this value is ignored as the first table is taken as the base table. The token %alias can be used in this string to be replaced with the actual alias. This is useful when $alias is modified by the database system, for example, when joining the same table more than once.
$arguments: An array of arguments to replace into the $condition of this join.
Return value
string The unique alias that was assigned for this table.
2 methods override SelectInterface::leftJoin()
- Select::leftJoin in core/
lib/ Drupal/ Core/ Database/ Query/ Select.php - Left Outer Join against another table in the database.
- SelectExtender::leftJoin in core/
lib/ Drupal/ Core/ Database/ Query/ SelectExtender.php - Left Outer Join against another table in the database.
File
-
core/
lib/ Drupal/ Core/ Database/ Query/ SelectInterface.php, line 326
Class
- SelectInterface
- Interface definition for a Select Query object.
Namespace
Drupal\Core\Database\QueryCode
public function leftJoin($table, $alias = NULL, $condition = NULL, $arguments = []);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.