class Full
Same name in other branches
- 9 core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full
- 8.9.x core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full
- 10 core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full
The plugin to handle full pager.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\pager\PagerPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\pager\SqlBase extends \Drupal\views\Plugin\views\pager\PagerPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\views\pager\Full extends \Drupal\views\Plugin\views\pager\SqlBase
- class \Drupal\views\Plugin\views\pager\SqlBase extends \Drupal\views\Plugin\views\pager\PagerPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\views\pager\PagerPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Full
Related topics
240 string references to 'Full'
- AreaDisplayLinkTest::testAreaDisplayLink in core/
modules/ views/ tests/ src/ Kernel/ Handler/ AreaDisplayLinkTest.php - Tests the views area display_link handler.
- AreaEntityTest::doTestRender in core/
modules/ views/ tests/ src/ Kernel/ Handler/ AreaEntityTest.php - Tests rendering the entity area handler.
- block.block.call_to_action.yml in core/
modules/ config/ tests/ config_override_test/ config/ install/ block.block.call_to_action.yml - core/modules/config/tests/config_override_test/config/install/block.block.call_to_action.yml
- block.block.foobar_gorilla.yml in core/
modules/ block_content/ tests/ modules/ block_content_test/ config/ install/ block.block.foobar_gorilla.yml - core/modules/block_content/tests/modules/block_content_test/config/install/block.block.foobar_gorilla.yml
- block.block.umami_banner_home.yml in core/
profiles/ demo_umami/ config/ optional/ block.block.umami_banner_home.yml - core/profiles/demo_umami/config/optional/block.block.umami_banner_home.yml
File
-
core/
modules/ views/ src/ Plugin/ views/ pager/ Full.php, line 14
Namespace
Drupal\views\Plugin\views\pagerView source
class Full extends SqlBase {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
// Use the same default quantity that core uses by default.
$options['quantity'] = [
'default' => 9,
];
$options['tags']['contains']['first'] = [
'default' => $this->t('« First'),
];
$options['tags']['contains']['last'] = [
'default' => $this->t('Last »'),
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['quantity'] = [
'#type' => 'number',
'#min' => 0,
'#title' => $this->t('Number of pager links visible'),
'#description' => $this->t('Specify the number of links to pages to display in the pager.'),
'#default_value' => $this->options['quantity'],
];
$form['tags']['first'] = [
'#type' => 'textfield',
'#title' => $this->t('First page link text'),
'#default_value' => $this->options['tags']['first'],
'#weight' => -10,
];
$form['tags']['last'] = [
'#type' => 'textfield',
'#title' => $this->t('Last page link text'),
'#default_value' => $this->options['tags']['last'],
'#weight' => 10,
];
}
/**
* {@inheritdoc}
*/
public function summaryTitle() {
if (!empty($this->options['offset'])) {
return $this->formatPlural($this->options['items_per_page'], '@count item, skip @skip', 'Paged, @count items, skip @skip', [
'@count' => $this->options['items_per_page'],
'@skip' => $this->options['offset'],
]);
}
return $this->formatPlural($this->options['items_per_page'], '@count item', 'Paged, @count items', [
'@count' => $this->options['items_per_page'],
]);
}
/**
* {@inheritdoc}
*/
public function render($input) {
// The 0, 1, 3, 4 indexes are correct. See the template_preprocess_pager()
// documentation.
$tags = [
0 => $this->options['tags']['first'],
1 => $this->options['tags']['previous'],
3 => $this->options['tags']['next'],
4 => $this->options['tags']['last'],
];
return [
'#theme' => $this->themeFunctions(),
'#tags' => $tags,
'#element' => $this->options['id'],
'#pagination_heading_level' => parent::getHeadingLevel(),
'#parameters' => $input,
'#quantity' => $this->options['quantity'],
'#route_name' => !empty($this->view->live_preview) ? '<current>' : '<none>',
];
}
}
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 | |
Full::buildOptionsForm | public | function | Provide the default form for setting options. | Overrides SqlBase::buildOptionsForm | |
Full::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides SqlBase::defineOptions | |
Full::render | public | function | Return the renderable array of the pager. | Overrides PagerPluginBase::render | |
Full::summaryTitle | public | function | Returns a string to display as the clickable title for the pager plugin. | Overrides PagerPluginBase::summaryTitle | |
PagerPluginBase::$current_page | public | property | |||
PagerPluginBase::$headingOptions | protected | property | Options available for setting pagination headers. | ||
PagerPluginBase::$total_items | public | property | |||
PagerPluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | |
PagerPluginBase::executeCountQuery | public | function | Executes the count query. | 1 | |
PagerPluginBase::exposedFormSubmit | public | function | |||
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::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::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 | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 |
PluginBase::destroy | public | function | Clears a plugin. | 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 | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | |
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | |
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | 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 | Initialize the plugin. | Overrides ViewsPluginInterface::init | 6 |
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | |
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | 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 | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 |
PluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 6 |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 |
PluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | 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. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
SqlBase::$pagerManager | protected | property | The pager manager. | ||
SqlBase::$pagerParameters | protected | property | The pager parameters. | ||
SqlBase::create | public static | function | Creates an instance of the plugin. | Overrides PluginBase::create | |
SqlBase::exposedFormAlter | public | function | Overrides PagerPluginBase::exposedFormAlter | ||
SqlBase::exposedFormValidate | public | function | Overrides PagerPluginBase::exposedFormValidate | ||
SqlBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |
SqlBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
SqlBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |
SqlBase::getPagerTotal | public | function | |||
SqlBase::isOffsetExposed | protected | function | Overrides PagerPluginBase::isOffsetExposed | ||
SqlBase::itemsPerPageExposed | protected | function | Overrides PagerPluginBase::itemsPerPageExposed | ||
SqlBase::query | public | function | Modify the query for paging. | 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 | Provide the default form for validating options. | 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.