class Subquery

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/join/Subquery.php \Drupal\views\Plugin\views\join\Subquery
  2. 8.9.x core/modules/views/src/Plugin/views/join/Subquery.php \Drupal\views\Plugin\views\join\Subquery
  3. 10 core/modules/views/src/Plugin/views/join/Subquery.php \Drupal\views\Plugin\views\join\Subquery

Join handler for relationships that join with a subquery as the left field.

For example:


LEFT JOIN node node_term_data ON ([YOUR SUBQUERY HERE]) = node_term_data.nid

Join definition: same as \Drupal\views\Plugin\views\join\JoinPluginBase, except:

  • left_query: The subquery to use in the left side of the join clause.

Hierarchy

Expanded class hierarchy of Subquery

Related topics

3 string references to 'Subquery'
GroupwiseMax::query in core/modules/views/src/Plugin/views/relationship/GroupwiseMax.php
Add anything to the query that we might need to.
Select::addJoin in core/lib/Drupal/Core/Database/Query/Select.php
Join against another table in the database.
SelectPagerDefaultTest::testInnerPagerQuery in core/modules/system/tests/src/Functional/Database/SelectPagerDefaultTest.php
Confirms that a pager query results with an inner pager query are valid.

File

core/modules/views/src/Plugin/views/join/Subquery.php, line 21

Namespace

Drupal\views\Plugin\views\join
View source
class Subquery extends JoinPluginBase {
    
    /**
     * The left join query.
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
    public string $left_query;
    
    /**
     * Constructs a Subquery object.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->left_query = $this->configuration['left_query'];
    }
    
    /**
     * Builds the SQL for the join this object represents.
     *
     * @param \Drupal\Core\Database\Query\SelectInterface $select_query
     *   The select query object.
     * @param string $table
     *   The base table to join.
     * @param \Drupal\views\Plugin\views\query\QueryPluginBase $view_query
     *   The source views query.
     */
    public function buildJoin($select_query, $table, $view_query) {
        if (empty($this->configuration['table formula'])) {
            $right_table = "{" . $this->table . "}";
        }
        else {
            $right_table = $this->configuration['table formula'];
        }
        // Add our join condition, using a subquery on the left instead of a field.
        $condition = "({$this->left_query}) = {$table['alias']}.{$this->field}";
        $arguments = [];
        // Tack on the extra.
        // This is just copied verbatim from the parent class, which itself has a
        // bug: https://www.drupal.org/node/1118100.
        if (isset($this->extra)) {
            if (is_array($this->extra)) {
                $extras = [];
                foreach ($this->extra as $info) {
                    // Figure out the table name. Remember, only use aliases provided
                    // if at all possible.
                    $join_table = '';
                    if (!array_key_exists('table', $info)) {
                        $join_table = $table['alias'] . '.';
                    }
                    elseif (isset($info['table'])) {
                        $join_table = $info['table'] . '.';
                    }
                    $placeholder = ':views_join_condition_' . $select_query->nextPlaceholder();
                    if (is_array($info['value'])) {
                        $operator = !empty($info['operator']) ? $info['operator'] : 'IN';
                        // Transform from IN() notation to = notation if just one value.
                        if (count($info['value']) == 1) {
                            $info['value'] = array_shift($info['value']);
                            $operator = $operator == 'NOT IN' ? '!=' : '=';
                        }
                    }
                    else {
                        $operator = !empty($info['operator']) ? $info['operator'] : '=';
                    }
                    $extras[] = "{$join_table}{$info['field']} {$operator} {$placeholder}";
                    $arguments[$placeholder] = $info['value'];
                }
                if ($extras) {
                    if (count($extras) == 1) {
                        $condition .= ' AND ' . array_shift($extras);
                    }
                    else {
                        $condition .= ' AND (' . implode(' ' . $this->extraOperator . ' ', $extras) . ')';
                    }
                }
            }
            elseif ($this->extra && is_string($this->extra)) {
                $condition .= " AND ({$this->extra})";
            }
        }
        $select_query->addJoin($this->type, $right_table, $table['alias'], $condition, $arguments);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
JoinPluginBase::$adjusted public property Defines whether a join has been adjusted.
JoinPluginBase::$configuration public property The configuration array passed by initJoin.
JoinPluginBase::$extra public property An array of extra conditions on the join.
JoinPluginBase::$extraOperator public property How all the extras will be combined. Either AND or OR.
JoinPluginBase::$field public property The field to join on (right field).
JoinPluginBase::$leftField public property The field we join to.
JoinPluginBase::$leftFormula public property A formula to be used instead of the left field.
JoinPluginBase::$leftTable public property The table we join to.
JoinPluginBase::$table public property The table to join (right table).
JoinPluginBase::$type public property The join type, so for example LEFT (default) or INNER.
JoinPluginBase::buildExtra protected function Builds a single extra condition.
JoinPluginBase::joinAddExtra protected function Adds the extras to the join condition. 1
Subquery::$left_query public property
Subquery::buildJoin public function Builds the SQL for the join this object represents. Overrides JoinPluginBase::buildJoin
Subquery::__construct public function Constructs a Subquery object. Overrides JoinPluginBase::__construct

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