class Full

Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full
  2. 10 core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full
  3. 8.9.x core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full

The plugin to handle full pager.

Plugin annotation


@ViewsPager(
  id = "full",
  title = @Translation("Paged output, full pager"),
  short_title = @Translation("Full"),
  help = @Translation("Paged output, full Drupal style"),
  theme = "pager",
  register_theme = FALSE
)

Hierarchy

Expanded class hierarchy of Full

Related topics

233 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.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
block.block.umami_banner_recipes.yml in core/profiles/demo_umami/config/optional/block.block.umami_banner_recipes.yml
core/profiles/demo_umami/config/optional/block.block.umami_banner_recipes.yml
block.block.umami_disclaimer.yml in core/profiles/demo_umami/config/optional/block.block.umami_disclaimer.yml
core/profiles/demo_umami/config/optional/block.block.umami_disclaimer.yml

... See full list

File

core/modules/views/src/Plugin/views/pager/Full.php, line 21

Namespace

Drupal\views\Plugin\views\pager
View 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'],
      '#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
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
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
MessengerTrait::$messenger protected property The messenger.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
PagerPluginBase::$current_page public property
PagerPluginBase::$total_items public property
PagerPluginBase::$usesOptions protected property
PagerPluginBase::executeCountQuery public function Executes the count query.
PagerPluginBase::exposedFormSubmit public function
PagerPluginBase::getCurrentPage public function Get the current page.
PagerPluginBase::getItemsPerPage public function Get how many items per page this pager will display.
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.
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::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.
PagerPluginBase::useCountQuery public function Determine if a pager needs a count query.
PagerPluginBase::usePager public function Determine if this pager actually uses a pager.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins&#039; 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::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function 2
PluginBase::calculateDependencies public function 2
PluginBase::calculateDependencies public function 2
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
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
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
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
PluginBase::trustedCallbacks public static function
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::validate public function
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
SqlBase::$pagerManager protected property The pager manager.
SqlBase::$pagerParameters protected property The pager parameters.
SqlBase::create public static function
SqlBase::exposedFormAlter public function
SqlBase::exposedFormValidate public function
SqlBase::getCacheContexts public function
SqlBase::getCacheMaxAge public function
SqlBase::getCacheTags public function
SqlBase::getPagerTotal public function
SqlBase::isOffsetExposed protected function
SqlBase::itemsPerPageExposed protected function
SqlBase::query public function
SqlBase::setCurrentPage public function Set the current page.
SqlBase::updatePageInfo public function Update global paging info.
SqlBase::usesExposed public function
SqlBase::validateOptionsForm public function
SqlBase::__construct public function Constructs a SqlBase object.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.