Some.php

Definition of Drupal\views\Plugin\views\pager\Some.

Namespace

Drupal\views\Plugin\views\pager

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/pager/Some.php
View source
<?php

/**
 * @file
 * Definition of Drupal\views\Plugin\views\pager\Some.
 */
namespace Drupal\views\Plugin\views\pager;

use Drupal\Core\Annotation\Plugin;
use Drupal\Core\Annotation\Translation;

/**
 * Plugin for views without pagers.
 *
 * @ingroup views_pager_plugins
 *
 * @Plugin(
 *   id = "some",
 *   title = @Translation("Display a specified number of items"),
 *   help = @Translation("Display a limited number items that this view might find."),
 *   type = "basic"
 * )
 */
class Some extends PagerPluginBase {
  public function summaryTitle() {
    if (!empty($this->options['offset'])) {
      return format_plural($this->options['items_per_page'], '@count item, skip @skip', '@count items, skip @skip', array(
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ));
    }
    return format_plural($this->options['items_per_page'], '@count item', '@count items', array(
      '@count' => $this->options['items_per_page'],
    ));
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['items_per_page'] = array(
      'default' => 10,
    );
    $options['offset'] = array(
      'default' => 0,
    );
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $pager_text = $this->displayHandler
      ->getPagerText();
    $form['items_per_page'] = array(
      '#title' => $pager_text['items per page title'],
      '#type' => 'textfield',
      '#description' => $pager_text['items per page description'],
      '#default_value' => $this->options['items_per_page'],
    );
    $form['offset'] = array(
      '#type' => 'textfield',
      '#title' => t('Offset'),
      '#description' => t('The number of items to skip. For example, if this field is 3, the first 3 items will be skipped and not displayed.'),
      '#default_value' => $this->options['offset'],
    );
  }
  function use_pager() {
    return FALSE;
  }
  function use_count_query() {
    return FALSE;
  }
  public function query() {
    $this->view->query
      ->set_limit($this->options['items_per_page']);
    $this->view->query
      ->set_offset($this->options['offset']);
  }

}

Classes

Namesort descending Description
Some Plugin for views without pagers.