interface JoinPluginInterface in Drupal 8

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

Extensions of this class can be used to create more interesting joins.

Hierarchy

• interface \Drupal\views\Plugin\views\join\JoinPluginInterface

File

core/modules/views/src/Plugin/views/join/JoinPluginInterface.php, line 10

Namespace

Drupal\views\Plugin\views\join

interface JoinPluginInterface {

  /**
   * Builds the SQL for the join this object represents.
   *
   * When possible, try to use table alias instead of table names.
   *
   * @param $select_query
   *   An select query object.
   * @param $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);

}

Members

Name	Modifiers	Type	Description	Overrides
JoinPluginInterface::buildJoin	public	function	Builds the SQL for the join this object represents.	1