class SqlBase
Same name in this branch
- 11.x core/modules/migrate/src/Plugin/migrate/source/SqlBase.php \Drupal\migrate\Plugin\migrate\source\SqlBase
Same name in other branches
- 9 core/modules/views/src/Plugin/views/pager/SqlBase.php \Drupal\views\Plugin\views\pager\SqlBase
- 9 core/modules/migrate/src/Plugin/migrate/source/SqlBase.php \Drupal\migrate\Plugin\migrate\source\SqlBase
- 8.9.x core/modules/views/src/Plugin/views/pager/SqlBase.php \Drupal\views\Plugin\views\pager\SqlBase
- 8.9.x core/modules/migrate/src/Plugin/migrate/source/SqlBase.php \Drupal\migrate\Plugin\migrate\source\SqlBase
- 10 core/modules/views/src/Plugin/views/pager/SqlBase.php \Drupal\views\Plugin\views\pager\SqlBase
- 10 core/modules/migrate/src/Plugin/migrate/source/SqlBase.php \Drupal\migrate\Plugin\migrate\source\SqlBase
A common base class for sql based pager.
Hierarchy
- class \Drupal\views\Plugin\views\pager\SqlBase extends \Drupal\views\Plugin\views\pager\PagerPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
Expanded class hierarchy of SqlBase
1 file declares its use of SqlBase
- StubSqlBase.php in core/
modules/ views/ tests/ src/ Unit/ Plugin/ pager/ StubSqlBase.php
File
-
core/
modules/ views/ src/ Plugin/ views/ pager/ SqlBase.php, line 16
Namespace
Drupal\views\Plugin\views\pagerView source
abstract class SqlBase extends PagerPluginBase implements CacheableDependencyInterface, ContainerFactoryPluginInterface {
/**
* The pager manager.
*
* @var \Drupal\Core\Pager\PagerManagerInterface
*/
protected $pagerManager;
/**
* The pager parameters.
*
* @var \Drupal\Core\Pager\PagerParametersInterface
*/
protected $pagerParameters;
/**
* Constructs a SqlBase object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Pager\PagerManagerInterface $pager_manager
* The pager manager.
* @param \Drupal\Core\Pager\PagerParametersInterface $pager_parameters
* The pager parameters.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, PagerManagerInterface $pager_manager, PagerParametersInterface $pager_parameters) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->pagerManager = $pager_manager;
$this->pagerParameters = $pager_parameters;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('pager.manager'), $container->get('pager.parameters'));
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['items_per_page'] = [
'default' => 10,
];
$options['offset'] = [
'default' => 0,
];
$options['id'] = [
'default' => 0,
];
$options['total_pages'] = [
'default' => '',
];
$options['pagination_heading_level'] = [
'default' => 'h4',
];
$options['expose'] = [
'contains' => [
'items_per_page' => [
'default' => FALSE,
],
'items_per_page_label' => [
'default' => $this->t('Items per page'),
],
'items_per_page_options' => [
'default' => '5, 10, 25, 50',
],
'items_per_page_options_all' => [
'default' => FALSE,
],
'items_per_page_options_all_label' => [
'default' => $this->t('- All -'),
],
'offset' => [
'default' => FALSE,
],
'offset_label' => [
'default' => $this->t('Offset'),
],
],
];
$options['tags'] = [
'contains' => [
'previous' => [
'default' => $this->t('‹ Previous'),
],
'next' => [
'default' => $this->t('Next ›'),
],
],
];
return $options;
}
/**
* Provide the default form for setting options.
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$pager_text = $this->displayHandler
->getPagerText();
$form['pagination_heading_level'] = [
'#title' => $this->t('Heading Level'),
'#type' => 'select',
'#options' => $this->headingOptions,
'#default_value' => $this->options['pagination_heading_level'],
'#description' => $this->t('Choose a heading level equal to or one lower than the preceding header.'),
'#fieldset' => 'style_settings',
];
$form['items_per_page'] = [
'#title' => $pager_text['items per page title'],
'#type' => 'number',
'#min' => 0,
'#description' => $pager_text['items per page description'],
'#default_value' => $this->options['items_per_page'],
];
$form['offset'] = [
'#type' => 'number',
'#min' => 0,
'#title' => $this->t('Offset (number of items to skip)'),
'#description' => $this->t('For example, set this to 3 and the first 3 items will not be displayed.'),
'#default_value' => $this->options['offset'],
];
$form['id'] = [
'#type' => 'number',
'#min' => 0,
'#title' => $this->t('Pager ID'),
'#description' => $this->t("Unless you're experiencing problems with pagers related to this view, you should leave this at 0. If using multiple pagers on one page you may need to set this number to a higher value so as not to conflict within the ?page= array. Large values will add a lot of commas to your URLs, so avoid if possible."),
'#default_value' => $this->options['id'],
];
$form['total_pages'] = [
'#type' => 'number',
'#min' => 0,
'#title' => $this->t('Number of pages'),
'#description' => $this->t('Leave empty to show all pages.'),
'#default_value' => $this->options['total_pages'],
];
$form['tags'] = [
'#type' => 'details',
'#open' => TRUE,
'#tree' => TRUE,
'#title' => $this->t('Pager link labels'),
'#input' => TRUE,
];
$form['tags']['previous'] = [
'#type' => 'textfield',
'#title' => $this->t('Previous page link text'),
'#default_value' => $this->options['tags']['previous'],
];
$form['tags']['next'] = [
'#type' => 'textfield',
'#title' => $this->t('Next page link text'),
'#default_value' => $this->options['tags']['next'],
];
$form['expose'] = [
'#type' => 'details',
'#open' => TRUE,
'#tree' => TRUE,
'#title' => $this->t('Exposed options'),
'#input' => TRUE,
'#description' => $this->t('Allow user to control selected display options for this view.'),
];
$form['expose']['items_per_page'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow user to control the number of items displayed in this view'),
'#default_value' => $this->options['expose']['items_per_page'],
];
$form['expose']['items_per_page_label'] = [
'#type' => 'textfield',
'#title' => $this->t('Items per page label'),
'#required' => TRUE,
'#default_value' => $this->options['expose']['items_per_page_label'],
'#states' => [
'invisible' => [
'input[name="pager_options[expose][items_per_page]"]' => [
'checked' => FALSE,
],
],
],
];
$form['expose']['items_per_page_options'] = [
'#type' => 'textfield',
'#title' => $this->t('Exposed items per page options'),
'#required' => TRUE,
'#description' => $this->t('Set between which values the user can choose when determining the items per page. Separated by comma.'),
'#default_value' => $this->options['expose']['items_per_page_options'],
'#states' => [
'invisible' => [
'input[name="pager_options[expose][items_per_page]"]' => [
'checked' => FALSE,
],
],
],
];
$form['expose']['items_per_page_options_all'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow user to display all items'),
'#default_value' => $this->options['expose']['items_per_page_options_all'],
];
$form['expose']['items_per_page_options_all_label'] = [
'#type' => 'textfield',
'#title' => $this->t('All items label'),
'#default_value' => $this->options['expose']['items_per_page_options_all_label'],
'#states' => [
'invisible' => [
'input[name="pager_options[expose][items_per_page_options_all]"]' => [
'checked' => FALSE,
],
],
],
];
$form['expose']['offset'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow user to specify number of items skipped from beginning of this view.'),
'#default_value' => $this->options['expose']['offset'],
];
$form['expose']['offset_label'] = [
'#type' => 'textfield',
'#title' => $this->t('Offset label'),
'#required' => TRUE,
'#default_value' => $this->options['expose']['offset_label'],
'#states' => [
'invisible' => [
'input[name="pager_options[expose][offset]"]' => [
'checked' => FALSE,
],
],
],
];
}
/**
* {@inheritdoc}
*/
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
// Only accept integer values.
$error = FALSE;
$exposed_options = $form_state->getValue([
'pager_options',
'expose',
'items_per_page_options',
]);
if (str_contains($exposed_options, '.')) {
$error = TRUE;
}
$options = explode(',', $exposed_options);
if (!$error && is_array($options)) {
foreach ($options as $option) {
if (!is_numeric($option) || intval($option) == 0) {
$error = TRUE;
}
}
}
else {
$error = TRUE;
}
if ($error) {
$form_state->setErrorByName('pager_options][expose][items_per_page_options', $this->t('Insert a list of integer numeric values separated by commas: e.g: 10, 20, 50, 100'));
}
// Make sure that the items_per_page is part of the expose settings.
if (!$form_state->isValueEmpty([
'pager_options',
'expose',
'items_per_page',
]) && !$form_state->isValueEmpty([
'pager_options',
'items_per_page',
])) {
$items_per_page = $form_state->getValue([
'pager_options',
'items_per_page',
]);
if (array_search($items_per_page, $options) === FALSE) {
$form_state->setErrorByName('pager_options][expose][items_per_page_options', $this->t("The <em>Exposed items per page</em> field's options must include the value from the <em>Items per page</em> field (@items_per_page).", [
'@items_per_page' => $items_per_page,
]));
}
}
}
/**
* {@inheritdoc}
*/
public function query() {
if ($this->itemsPerPageExposed()) {
$query = $this->view
->getRequest()->query;
$items_per_page = $query->get('items_per_page');
if ((int) $items_per_page > 0) {
$this->options['items_per_page'] = $items_per_page;
}
elseif ($items_per_page == 'All' && $this->options['expose']['items_per_page_options_all']) {
$this->options['items_per_page'] = 0;
}
}
if ($this->isOffsetExposed()) {
$query = $this->view
->getRequest()->query;
$offset = $query->get('offset');
if (isset($offset) && $offset >= 0) {
$this->options['offset'] = $offset;
}
}
$limit = $this->options['items_per_page'];
$offset = $this->current_page * $this->options['items_per_page'] + $this->options['offset'];
if (!empty($this->options['total_pages'])) {
if ($this->current_page >= $this->options['total_pages']) {
$limit = $this->options['items_per_page'];
$offset = $this->options['total_pages'] * $this->options['items_per_page'];
}
}
$this->view->query
->setLimit($limit);
$this->view->query
->setOffset($offset);
}
/**
* Set the current page.
*
* @param int|null $number
* If provided, the page number will be set to this. If NOT provided,
* the page number will be set from the pager manager service.
*/
public function setCurrentPage($number = NULL) {
if (isset($number)) {
$this->current_page = max(0, $number);
return;
}
$this->current_page = max(0, $this->pagerParameters
->findPage($this->options['id']));
}
/**
* Gets the total number of pages.
*/
public function getPagerTotal() {
if ($items_per_page = intval($this->getItemsPerPage())) {
return ceil($this->total_items / $items_per_page);
}
else {
return 1;
}
}
/**
* Update global paging info.
*
* This is called after the count query has been run to set the total
* items available and to update the current page if the requested
* page is out of range.
*/
public function updatePageInfo() {
if (!empty($this->options['total_pages'])) {
if ($this->options['total_pages'] * $this->options['items_per_page'] < $this->total_items) {
$this->total_items = $this->options['total_pages'] * $this->options['items_per_page'];
}
}
// Don't set pager settings for items per page = 0.
$items_per_page = $this->getItemsPerPage();
if (!empty($items_per_page)) {
$pager = $this->pagerManager
->createPager($this->getTotalItems(), $this->options['items_per_page'], $this->options['id']);
// See if the requested page was within range:
if ($this->getCurrentPage() >= $pager->getTotalPages()) {
$this->setCurrentPage($pager->getTotalPages() - 1);
}
}
}
/**
* {@inheritdoc}
*/
public function usesExposed() {
return $this->itemsPerPageExposed() || $this->isOffsetExposed();
}
/**
* {@inheritdoc}
*/
protected function itemsPerPageExposed() {
return !empty($this->options['expose']['items_per_page']);
}
/**
* {@inheritdoc}
*/
protected function isOffsetExposed() {
return !empty($this->options['expose']['offset']);
}
/**
* {@inheritdoc}
*/
public function exposedFormAlter(&$form, FormStateInterface $form_state) {
if ($this->itemsPerPageExposed()) {
$options = explode(',', $this->options['expose']['items_per_page_options']);
$sanitized_options = [];
if (is_array($options)) {
foreach ($options as $option) {
$sanitized_options[intval($option)] = intval($option);
}
if (!empty($this->options['expose']['items_per_page_options_all']) && !empty($this->options['expose']['items_per_page_options_all_label'])) {
$sanitized_options['All'] = $this->options['expose']['items_per_page_options_all_label'];
}
$form['items_per_page'] = [
'#type' => 'select',
'#title' => $this->options['expose']['items_per_page_label'],
'#options' => $sanitized_options,
'#default_value' => $this->getItemsPerPage(),
];
}
}
if ($this->isOffsetExposed()) {
$form['offset'] = [
'#type' => 'textfield',
'#size' => 10,
'#maxlength' => 10,
'#title' => $this->options['expose']['offset_label'],
'#default_value' => $this->getOffset(),
];
}
}
/**
* {@inheritdoc}
*/
public function exposedFormValidate(&$form, FormStateInterface $form_state) {
if (!$form_state->isValueEmpty('offset') && trim($form_state->getValue('offset'))) {
if (!is_numeric($form_state->getValue('offset')) || $form_state->getValue('offset') < 0) {
$form_state->setErrorByName('offset', $this->t('Offset must be a number greater than or equal to 0.'));
}
}
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
// The rendered link needs to play well with any other query parameter used
// on the page, like other pagers and exposed filter.
return [
'url.query_args',
];
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
PagerPluginBase::$current_page | public | property | |||
PagerPluginBase::$headingOptions | protected | property | Options available for setting pagination headers. | ||
PagerPluginBase::$total_items | public | property | |||
PagerPluginBase::$usesOptions | protected | property | Overrides PluginBase::$usesOptions | ||
PagerPluginBase::executeCountQuery | public | function | Executes the count query. | 1 | |
PagerPluginBase::exposedFormSubmit | public | function | Handles submission of the exposed form. | ||
PagerPluginBase::getCurrentPage | public | function | Get the current page. | ||
PagerPluginBase::getHeadingLevel | public | function | Get the pager heading tag. | ||
PagerPluginBase::getItemsPerPage | public | function | Get how many items per page this pager will display. | 1 | |
PagerPluginBase::getOffset | public | function | Get the page offset, or how many items to skip. | ||
PagerPluginBase::getPagerId | public | function | Get the pager id, if it exists. | ||
PagerPluginBase::getTotalItems | public | function | Get the total number of items. | ||
PagerPluginBase::hasMoreRecords | public | function | Determine if there are more records available. | ||
PagerPluginBase::postExecute | public | function | Perform any needed actions just after the query executing. | 3 | |
PagerPluginBase::preExecute | public | function | Perform any needed actions just prior to the query executing. | ||
PagerPluginBase::preRender | public | function | Perform any needed actions just before rendering. | ||
PagerPluginBase::render | public | function | Return the renderable array of the pager. | 2 | |
PagerPluginBase::setHeadingLevel | public | function | Set the pager heading. | ||
PagerPluginBase::setItemsPerPage | public | function | Set how many items per page this pager will display. | ||
PagerPluginBase::setOffset | public | function | Set the page offset, or how many items to skip. | ||
PagerPluginBase::submitOptionsForm | public | function | Provide the default form for submitting options. | Overrides PluginBase::submitOptionsForm | |
PagerPluginBase::summaryTitle | public | function | Returns a string to display as the clickable title for the pager plugin. | Overrides PluginBase::summaryTitle | 4 |
PagerPluginBase::useCountQuery | public | function | Determine if a pager needs a count query. | 3 | |
PagerPluginBase::usePager | public | function | Determine if this pager actually uses a pager. | 2 | |
PluginBase::$definition | public | property | Plugins' definition. | ||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | ||
PluginBase::$options | public | property | Options for this plugin will be held here. | ||
PluginBase::$position | public | property | The handler position. | ||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::calculateDependencies | public | function | Overrides DependentPluginInterface::calculateDependencies | 14 | |
PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | ||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | |||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | |||
PluginBase::init | public | function | Overrides ViewsPluginInterface::init | 6 | |
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | ||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | ||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | ||
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | |
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::validate | public | function | Overrides ViewsPluginInterface::validate | 6 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
SqlBase::$pagerManager | protected | property | The pager manager. | ||
SqlBase::$pagerParameters | protected | property | The pager parameters. | ||
SqlBase::buildOptionsForm | public | function | Provide the default form for setting options. | Overrides PluginBase::buildOptionsForm | 1 |
SqlBase::create | public static | function | Overrides PluginBase::create | ||
SqlBase::defineOptions | protected | function | Overrides PluginBase::defineOptions | 2 | |
SqlBase::exposedFormAlter | public | function | Overrides PagerPluginBase::exposedFormAlter | ||
SqlBase::exposedFormValidate | public | function | Overrides PagerPluginBase::exposedFormValidate | ||
SqlBase::getCacheContexts | public | function | Overrides CacheableDependencyInterface::getCacheContexts | ||
SqlBase::getCacheMaxAge | public | function | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
SqlBase::getCacheTags | public | function | Overrides CacheableDependencyInterface::getCacheTags | ||
SqlBase::getPagerTotal | public | function | Gets the total number of pages. | ||
SqlBase::isOffsetExposed | protected | function | Overrides PagerPluginBase::isOffsetExposed | ||
SqlBase::itemsPerPageExposed | protected | function | Overrides PagerPluginBase::itemsPerPageExposed | ||
SqlBase::query | public | function | Overrides PagerPluginBase::query | 1 | |
SqlBase::setCurrentPage | public | function | Set the current page. | Overrides PagerPluginBase::setCurrentPage | |
SqlBase::updatePageInfo | public | function | Update global paging info. | Overrides PagerPluginBase::updatePageInfo | |
SqlBase::usesExposed | public | function | Overrides PagerPluginBase::usesExposed | ||
SqlBase::validateOptionsForm | public | function | Overrides PagerPluginBase::validateOptionsForm | ||
SqlBase::__construct | public | function | Constructs a SqlBase object. | Overrides PluginBase::__construct | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.