function SelectInterface::getUnion

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::getUnion()
  2. 8.9.x core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::getUnion()
  3. 10 core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::getUnion()

Returns a reference to the union queries for this query.

This includes queries for UNION, UNION ALL, and UNION DISTINCT.

Because this method returns by reference, alter hooks may edit the tables array directly to make their changes. If just adding union queries, however, the use of the union() method is preferred.

Note that this method must be called by reference as well:

$fields =& $query->getUnion();

Return value

array A reference to the union query array structure.

2 methods override SelectInterface::getUnion()
Select::getUnion in core/lib/Drupal/Core/Database/Query/Select.php
Returns a reference to the union queries for this query.
SelectExtender::getUnion in core/lib/Drupal/Core/Database/Query/SelectExtender.php
Returns a reference to the union queries for this query.

File

core/lib/Drupal/Core/Database/Query/SelectInterface.php, line 124

Class

SelectInterface
Interface definition for a Select Query object.

Namespace

Drupal\Core\Database\Query

Code

public function &getUnion();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.