abstract class QueryPluginBase in Views (for Drupal 7) 8.3
@todo.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\query\QueryPluginBase implements QueryInterface
- class \Drupal\views\Plugin\views\PluginBase
Expanded class hierarchy of QueryPluginBase
1 file declares its use of QueryPluginBase
- QueryTest.php in tests/
views_test_data/ lib/ Drupal/ views_test_data/ Plugin/ views/ query/ QueryTest.php - Definition of Drupal\views_test_data\Plugin\views\query\QueryTest.
File
- lib/
Drupal/ views/ Plugin/ views/ query/ QueryPluginBase.php, line 16 - Definition of Drupal\views\Plugin\views\query\QueryPluginBase.
Namespace
Drupal\views\Plugin\views\queryView source
abstract class QueryPluginBase extends PluginBase implements QueryInterface {
/**
* A pager plugin that should be provided by the display.
*
* @var views_plugin_pager
*/
var $pager = NULL;
/**
* Constructor; Create the basic query object and fill with default values.
*/
public function init($base_table, $base_field, $options) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->base_table = $base_table;
$this->base_field = $base_field;
$this
->unpackOptions($this->options, $options);
}
/**
* Generate a query and a countquery from all of the information supplied
* to the object.
*
* @param $get_count
* Provide a countquery if this is true, otherwise provide a normal query.
*/
public function query($get_count = FALSE) {
}
/**
* Let modules modify the query just prior to finalizing it.
*
* @param view $view
* The view which is executed.
*/
function alter(ViewExecutable $view) {
}
/**
* Builds the necessary info to execute the query.
*
* @param view $view
* The view which is executed.
*/
function build(ViewExecutable $view) {
}
/**
* Executes the query and fills the associated view object with according
* values.
*
* Values to set: $view->result, $view->total_rows, $view->execute_time,
* $view->pager['current_page'].
*
* $view->result should contain an array of objects. The array must use a
* numeric index starting at 0.
*
* @param view $view
* The view which is executed.
*/
function execute(ViewExecutable $view) {
}
/**
* Add a signature to the query, if such a thing is feasible.
*
* This signature is something that can be used when perusing query logs to
* discern where particular queries might be coming from.
*
* @param view $view
* The view which is executed.
*/
function add_signature(ViewExecutable $view) {
}
/**
* Get aggregation info for group by queries.
*
* If NULL, aggregation is not allowed.
*/
function get_aggregation_info() {
}
public function validateOptionsForm(&$form, &$form_state) {
}
public function submitOptionsForm(&$form, &$form_state) {
}
public function summaryTitle() {
return t('Settings');
}
/**
* Set a LIMIT on the query, specifying a maximum number of results.
*/
function set_limit($limit) {
$this->limit = $limit;
}
/**
* Set an OFFSET on the query, specifying a number of results to skip
*/
function set_offset($offset) {
$this->offset = $offset;
}
/**
* Create a new grouping for the WHERE or HAVING clause.
*
* @param $type
* Either 'AND' or 'OR'. All items within this group will be added
* to the WHERE clause with this logical operator.
* @param $group
* An ID to use for this group. If unspecified, an ID will be generated.
* @param $where
* 'where' or 'having'.
*
* @return $group
* The group ID generated.
*/
function set_where_group($type = 'AND', $group = NULL, $where = 'where') {
// Set an alias.
$groups =& $this->{$where};
if (!isset($group)) {
$group = empty($groups) ? 1 : max(array_keys($groups)) + 1;
}
// Create an empty group
if (empty($groups[$group])) {
$groups[$group] = array(
'conditions' => array(),
'args' => array(),
);
}
$groups[$group]['type'] = strtoupper($type);
return $group;
}
/**
* Control how all WHERE and HAVING groups are put together.
*
* @param $type
* Either 'AND' or 'OR'
*/
function set_group_operator($type = 'AND') {
$this->group_operator = strtoupper($type);
}
/**
* 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];
*
* Query plugins that don't support entities can leave the method empty.
*/
function load_entities(&$results) {
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Provide a form to edit options for this plugin. | 14 |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. @code 'option_name' => array( | 13 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
2 |
QueryPluginBase:: |
property | A pager plugin that should be provided by the display. | ||
QueryPluginBase:: |
function | Add a signature to the query, if such a thing is feasible. | 1 | |
QueryPluginBase:: |
function | Let modules modify the query just prior to finalizing it. | 1 | |
QueryPluginBase:: |
function | Builds the necessary info to execute the query. | 2 | |
QueryPluginBase:: |
function | Executes the query and fills the associated view object with according values. | 2 | |
QueryPluginBase:: |
function | Get aggregation info for group by queries. | 1 | |
QueryPluginBase:: |
public | function | Constructor; Create the basic query object and fill with default values. | 1 |
QueryPluginBase:: |
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:: |
public | function |
Generate a query and a countquery from all of the information supplied
to the object. Overrides PluginBase:: |
1 |
QueryPluginBase:: |
function | Control how all WHERE and HAVING groups are put together. | ||
QueryPluginBase:: |
function | Set a LIMIT on the query, specifying a maximum number of results. | ||
QueryPluginBase:: |
function | Set an OFFSET on the query, specifying a number of results to skip | ||
QueryPluginBase:: |
function | Create a new grouping for the WHERE or HAVING clause. | ||
QueryPluginBase:: |
public | function |
Handle any special handling on the validate form. Overrides PluginBase:: |
1 |
QueryPluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides PluginBase:: |
|
QueryPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |