JoinPluginBase::$extra

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/join/JoinPluginBase.php \Drupal\views\Plugin\views\join\JoinPluginBase::extra
  2. 10 core/modules/views/src/Plugin/views/join/JoinPluginBase.php \Drupal\views\Plugin\views\join\JoinPluginBase::extra
  3. 11.x core/modules/views/src/Plugin/views/join/JoinPluginBase.php \Drupal\views\Plugin\views\join\JoinPluginBase::extra

An array of extra conditions on the join.

Each condition is either a string that's directly added, or an array of items:

  • table(optional): If not set, current table; if NULL, no table. If you specify a table in cached configuration, Views will try to load from an existing alias. If you use realtime joins, it works better.
  • field(optional): Field or formula. In formulas we can reference the right table by using %alias.
  • left_field(optional): Field or formula. In formulas we can reference the left table by using %alias.
  • operator(optional): The operator used, Defaults to "=".
  • value: Must be set. If an array, operator will be defaulted to IN.
  • numeric: If true, the value will not be surrounded in quotes.

Type: array

See also

SelectQueryInterface::addJoin()

File

core/modules/views/src/Plugin/views/join/JoinPluginBase.php, line 210

Class

JoinPluginBase
Represents a join and creates the SQL necessary to implement the join.

Namespace

Drupal\views\Plugin\views\join

Code

public $extra;

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