Full.php

Same filename in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/pager/Full.php
  2. 10 core/modules/views/src/Plugin/views/pager/Full.php
  3. 11.x core/modules/views/src/Plugin/views/pager/Full.php

Namespace

Drupal\views\Plugin\views\pager

File

core/modules/views/src/Plugin/views/pager/Full.php

View source
<?php

namespace Drupal\views\Plugin\views\pager;

use Drupal\Core\Form\FormStateInterface;

/**
 * The plugin to handle full pager.
 *
 * @ingroup views_pager_plugins
 *
 * @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
 * )
 */
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>',
        ];
    }

}

Classes

Title Deprecated Summary
Full The plugin to handle full pager.

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