None.php

Same filename in this branch
  1. 9 core/modules/views/src/Plugin/views/argument_validator/None.php
  2. 9 core/modules/views/src/Plugin/views/cache/None.php
  3. 9 core/modules/views/src/Plugin/views/access/None.php
Same filename in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/argument_validator/None.php
  2. 8.9.x core/modules/views/src/Plugin/views/cache/None.php
  3. 8.9.x core/modules/views/src/Plugin/views/access/None.php
  4. 8.9.x core/modules/views/src/Plugin/views/pager/None.php
  5. 10 core/modules/views/src/Plugin/views/argument_validator/None.php
  6. 10 core/modules/views/src/Plugin/views/cache/None.php
  7. 10 core/modules/views/src/Plugin/views/access/None.php
  8. 10 core/modules/views/src/Plugin/views/pager/None.php
  9. 11.x core/modules/views/src/Plugin/views/argument_validator/None.php
  10. 11.x core/modules/views/src/Plugin/views/cache/None.php
  11. 11.x core/modules/views/src/Plugin/views/access/None.php
  12. 11.x core/modules/views/src/Plugin/views/pager/None.php

Namespace

Drupal\views\Plugin\views\pager

File

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

View source
<?php

namespace Drupal\views\Plugin\views\pager;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\display\DisplayPluginBase;

/**
 * Plugin for views without pagers.
 *
 * @ingroup views_pager_plugins
 *
 * @ViewsPager(
 *   id = "none",
 *   title = @Translation("Display all items"),
 *   help = @Translation("Display all items that this view might find."),
 *   display_types = {"basic"}
 * )
 */
class None extends PagerPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
        parent::init($view, $display, $options);
        // If the pager is set to none, then it should show all items.
        $this->setItemsPerPage(0);
    }
    public function summaryTitle() {
        if (!empty($this->options['offset'])) {
            return $this->t('All items, skip @skip', [
                '@skip' => $this->options['offset'],
            ]);
        }
        return $this->t('All items');
    }
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['offset'] = [
            'default' => 0,
        ];
        return $options;
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        $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'],
        ];
    }
    public function usePager() {
        return FALSE;
    }
    public function useCountQuery() {
        return FALSE;
    }
    public function getItemsPerPage() {
        return 0;
    }
    public function executeCountQuery(&$count_query) {
        // If we are displaying all items, never count. But we can update the count in post_execute.
    }
    public function postExecute(&$result) {
        $this->total_items = count($result);
    }
    public function query() {
        // The only query modifications we might do are offsets.
        if (!empty($this->options['offset'])) {
            $this->view->query
                ->setOffset($this->options['offset']);
        }
    }

}

Classes

Title Deprecated Summary
None Plugin for views without pagers.

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