Some.php

Same filename and directory in other branches
  1. 9 core/modules/views/src/Plugin/views/pager/Some.php
  2. 8.9.x core/modules/views/src/Plugin/views/pager/Some.php
  3. 11.x core/modules/views/src/Plugin/views/pager/Some.php

Namespace

Drupal\views\Plugin\views\pager

File

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

View source
<?php

namespace Drupal\views\Plugin\views\pager;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\views\Attribute\ViewsPager;

/**
 * Plugin for views without pagers.
 *
 * @ingroup views_pager_plugins
 */
class Some extends PagerPluginBase {
  public function summaryTitle() {
    if (!empty($this->options['offset'])) {
      return $this->formatPlural($this->options['items_per_page'], '@count item, skip @skip', '@count items, skip @skip', [
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ]);
    }
    return $this->formatPlural($this->options['items_per_page'], '@count item', '@count items', [
      '@count' => $this->options['items_per_page'],
    ]);
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['items_per_page'] = [
      'default' => 10,
    ];
    $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);
    $pager_text = $this->displayHandler
      ->getPagerText();
    $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'],
    ];
  }
  public function usePager() {
    return FALSE;
  }
  public function useCountQuery() {
    return FALSE;
  }
  public function query() {
    $this->view->query
      ->setLimit($this->options['items_per_page']);
    $this->view->query
      ->setOffset($this->options['offset']);
  }
  
  /**
   * {@inheritdoc}
   */
  public function postExecute(&$result) : void {
    $this->total_items = count($result);
  }

}

Classes

Title Deprecated Summary
Some Plugin for views without pagers.

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