abstract class QueryPluginBase in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/views/src/Plugin/views/query/QueryPluginBase.php \Drupal\views\Plugin\views\query\QueryPluginBase
Base plugin class for Views queries.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\query\QueryPluginBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of QueryPluginBase
Related topics
7 files declare their use of QueryPluginBase
- DisplayKernelTest.php in core/
modules/ views/ src/ Tests/ Plugin/ DisplayKernelTest.php - Contains \Drupal\views\Tests\Plugin\DisplayKernelTest.
- EntityFieldRenderer.php in core/
modules/ views/ src/ Entity/ Render/ EntityFieldRenderer.php - Contains \Drupal\views\Entity\Render\EntityFieldRenderer.
- EntityTranslationRendererBase.php in core/
modules/ views/ src/ Entity/ Render/ EntityTranslationRendererBase.php - Contains \Drupal\views\Entity\Render\EntityTranslationRendererBase.
- QueryTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ query/ QueryTest.php - Contains \Drupal\views_test_data\Plugin\views\query\QueryTest.
- RendererBase.php in core/
modules/ views/ src/ Entity/ Render/ RendererBase.php - Contains \Drupal\views\Entity\Render\RendererBase.
File
- core/
modules/ views/ src/ Plugin/ views/ query/ QueryPluginBase.php, line 39 - Contains \Drupal\views\Plugin\views\query\QueryPluginBase.
Namespace
Drupal\views\Plugin\views\queryView source
abstract class QueryPluginBase extends PluginBase implements CacheableDependencyInterface {
/**
* A pager plugin that should be provided by the display.
*
* @var views_plugin_pager
*/
var $pager = NULL;
/**
* Stores the limit of items that should be requested in the query.
*
* @var int
*/
protected $limit;
/**
* 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.
*/
public function addSignature(ViewExecutable $view) {
}
/**
* Get aggregation info for group by queries.
*
* If NULL, aggregation is not allowed.
*/
public function getAggregationInfo() {
}
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
}
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
}
public function summaryTitle() {
return $this
->t('Settings');
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = [];
foreach ($this
->getEntityTableInfo() as $entity_type => $info) {
if (!empty($info['provider'])) {
$dependencies['module'][] = $info['provider'];
}
}
return $dependencies;
}
/**
* Set a LIMIT on the query, specifying a maximum number of results.
*/
public function setLimit($limit) {
$this->limit = $limit;
}
/**
* Set an OFFSET on the query, specifying a number of results to skip
*/
public function setOffset($offset) {
$this->offset = $offset;
}
/**
* Returns the limit of the query.
*/
public function getLimit() {
return $this->limit;
}
/**
* 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.
*/
public function setWhereGroup($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'
*/
public function setGroupOperator($type = 'AND') {
$this->groupOperator = 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 loadEntities(&$results) {
}
/**
* Returns a Unix timestamp to database native timestamp expression.
*
* @param string $field
* The query field that will be used in the expression.
*
* @return string
* An expression representing a timestamp with time zone.
*/
public function getDateField($field) {
return $field;
}
/**
* Set the database to the current user timezone,
*
* @return string
* The current timezone as returned by drupal_get_user_timezone().
*/
public function setupTimezone() {
return drupal_get_user_timezone();
}
/**
* Creates cross-database date formatting.
*
* @param string $field
* An appropriate query expression pointing to the date field.
* @param string $format
* A format string for the result, like 'Y-m-d H:i:s'.
* @param boolean $string_date
* For certain databases, date format functions vary depending on string or
* numeric storage.
*
* @return string
* A string representing the field formatted as a date in the format
* specified by $format.
*/
public function getDateFormat($field, $format, $string_date = FALSE) {
return $field;
}
/**
* Returns an array of all tables from the query that map to an entity type.
*
* Includes the base table and all relationships, if eligible.
*
* Available keys for each table:
* - base: The actual base table (i.e. "user" for an author relationship).
* - relationship_id: The id of the relationship, or "none".
* - alias: The alias used for the relationship.
* - entity_type: The entity type matching the base table.
* - revision: A boolean that specifies whether the table is a base table or
* a revision table of the entity type.
*
* @return array
* An array of table information, keyed by table alias.
*/
public function getEntityTableInfo() {
// Start with the base table.
$entity_tables = array();
$views_data = Views::viewsData();
$base_table = $this->view->storage
->get('base_table');
$base_table_data = $views_data
->get($base_table);
if (isset($base_table_data['table']['entity type'])) {
$entity_tables[$base_table_data['table']['entity type']] = array(
'base' => $base_table,
'alias' => $base_table,
'relationship_id' => 'none',
'entity_type' => $base_table_data['table']['entity type'],
'revision' => $base_table_data['table']['entity revision'],
);
// Include the entity provider.
if (!empty($base_table_data['table']['provider'])) {
$entity_tables[$base_table_data['table']['entity type']]['provider'] = $base_table_data['table']['provider'];
}
}
// Include all relationships.
foreach ((array) $this->view->relationship as $relationship_id => $relationship) {
$table_data = $views_data
->get($relationship->definition['base']);
if (isset($table_data['table']['entity type'])) {
$entity_tables[$relationship_id . '__' . $relationship->tableAlias] = array(
'base' => $relationship->definition['base'],
'relationship_id' => $relationship_id,
'alias' => $relationship->alias,
'entity_type' => $table_data['table']['entity type'],
'revision' => $table_data['table']['entity revision'],
);
// Include the entity provider.
if (!empty($table_data['table']['provider'])) {
$entity_tables[$relationship_id . '__' . $relationship->tableAlias]['provider'] = $table_data['table']['provider'];
}
}
}
// Determine which of the tables are revision tables.
foreach ($entity_tables as $table_alias => $table) {
$entity_type = \Drupal::entityManager()
->getDefinition($table['entity_type']);
if ($entity_type
->getRevisionTable() == $table['base']) {
$entity_tables[$table_alias]['revision'] = TRUE;
}
}
return $entity_tables;
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
$contexts = [];
if (($views_data = Views::viewsData()
->get($this->view->storage
->get('base_table'))) && !empty($views_data['table']['entity type'])) {
$entity_type_id = $views_data['table']['entity type'];
$entity_type = \Drupal::entityManager()
->getDefinition($entity_type_id);
$contexts = $entity_type
->getListCacheContexts();
}
return $contexts;
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
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. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 2 |
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 form to edit options for this plugin. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
50 |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. | 18 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
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:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
5 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
PluginBase:: |
public | function |
Constructs a PluginBase object. Overrides PluginBase:: |
|
QueryPluginBase:: |
protected | property | Stores the limit of items that should be requested in the query. | |
QueryPluginBase:: |
property | A pager plugin that should be provided by the display. | ||
QueryPluginBase:: |
public | 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:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
1 |
QueryPluginBase:: |
function | Executes the query and fills the associated view object with according values. | 2 | |
QueryPluginBase:: |
public | function | Get aggregation info for group by queries. | 1 |
QueryPluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
QueryPluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
1 |
QueryPluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
1 |
QueryPluginBase:: |
public | function | Returns a Unix timestamp to database native timestamp expression. | 1 |
QueryPluginBase:: |
public | function | Creates cross-database date formatting. | 1 |
QueryPluginBase:: |
public | function | Returns an array of all tables from the query that map to an entity type. | |
QueryPluginBase:: |
public | function | Returns the limit of the query. | |
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:: |
public | function | Control how all WHERE and HAVING groups are put together. | |
QueryPluginBase:: |
public | function | Set a LIMIT on the query, specifying a maximum number of results. | |
QueryPluginBase:: |
public | function | Set an OFFSET on the query, specifying a number of results to skip | |
QueryPluginBase:: |
public | function | Set the database to the current user timezone, | 1 |
QueryPluginBase:: |
public | 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:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |