interface JoinPluginInterface

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

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

Expanded class hierarchy of JoinPluginInterface

All classes that implement JoinPluginInterface

File

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

Namespace

Drupal\views\Plugin\views\join
View source 
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
     *   A 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

Title Modifiers Object type Summary Overrides
JoinPluginInterface::buildJoin public function Builds the SQL for the join this object represents. 1

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