abstract class QueryPluginBase

@todo.

Hierarchy

Expanded class hierarchy of QueryPluginBase

1 file declares its use of QueryPluginBase

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/query/QueryPluginBase.php, line 17
Definition of Drupal\views\Plugin\views\query\QueryPluginBase.

Namespace

Drupal\views\Plugin\views\query
View source

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::buildOptionsForm public function Provide a form to edit options for this plugin. 15
PluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( 14
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
QueryPluginBase::$pager property A pager plugin that should be provided by the display.
QueryPluginBase::add_signature function Add a signature to the query, if such a thing is feasible. 1
QueryPluginBase::alter function Let modules modify the query just prior to finalizing it. 1
QueryPluginBase::build function Builds the necessary info to execute the query. 2
QueryPluginBase::execute function Executes the query and fills the associated view object with according values. 2
QueryPluginBase::get_aggregation_info function Get aggregation info for group by queries. 1
QueryPluginBase::init public function Overrides Drupal\views\Plugin\views\PluginBase::init(). 1
QueryPluginBase::load_entities function Loads all entities contained in the passed-in $results. . If the entity belongs to the base table, then it gets stored in $result->_entity. Otherwise, it gets stored in $result->_relationship_entities[$relationship_id]; 1
QueryPluginBase::query public function Generate a query and a countquery from all of the information supplied to the object. Overrides PluginBase::query 1
QueryPluginBase::set_group_operator function Control how all WHERE and HAVING groups are put together.
QueryPluginBase::set_limit function Set a LIMIT on the query, specifying a maximum number of results.
QueryPluginBase::set_offset function Set an OFFSET on the query, specifying a number of results to skip
QueryPluginBase::set_where_group function Create a new grouping for the WHERE or HAVING clause.
QueryPluginBase::submitOptionsForm public function Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm 1
QueryPluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle
QueryPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm