You are here

Home » API reference » Views (for Drupal 7) 8.3 » Some.php

class Some in Views (for Drupal 7) 8.3

Plugin for views without pagers.

Plugin annotation


@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"
)

Hierarchy

Expanded class hierarchy of Some

Related topics

Views pager plugins
The base plugin to handler pagers of a view.

File

lib/Drupal/views/Plugin/views/pager/Some.php, line 25
Definition of Drupal\views\Plugin\views\pager\Some.

Namespace

Drupal\views\Plugin\views\pager
View source 
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']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PagerPluginBase::$current_page property
PagerPluginBase::$total_items property
PagerPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
PagerPluginBase::execute_count_query function Execute the count query, which will be done just prior to the query itself being executed. 1
PagerPluginBase::exposed_form_alter function 1
PagerPluginBase::exposed_form_submit function
PagerPluginBase::exposed_form_validate function 1
PagerPluginBase::get_current_page function Get the current page.
PagerPluginBase::get_items_per_page function Get how many items per page this pager will display. 1
PagerPluginBase::get_offset function Get the page offset, or how many items to skip.
PagerPluginBase::get_pager_id function Get the pager id, if it exists
PagerPluginBase::get_total_items function Get the total number of items.
PagerPluginBase::has_more_records function Determine if there are more records available.
PagerPluginBase::init public function Initialize the plugin. 1
PagerPluginBase::items_per_page_exposed function 1
PagerPluginBase::offset_exposed function 1
PagerPluginBase::postExecute public function Perform any needed actions just after the query executing. 1
PagerPluginBase::pre_execute function Perform any needed actions just prior to the query executing.
PagerPluginBase::pre_render function Perform any needed actions just before rendering.
PagerPluginBase::render function Render the pager. 1
PagerPluginBase::set_current_page function Set the current page. 1
PagerPluginBase::set_items_per_page function Set how many items per page this pager will display.
PagerPluginBase::set_offset function Set the page offset, or how many items to skip.
PagerPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm
PagerPluginBase::update_page_info function If there are pagers that need global values set, this method can be used to set them. It will be called when the count query is run. 1
PagerPluginBase::uses_exposed function 1
PagerPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's 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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
Some::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm
Some::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PluginBase::defineOptions
Some::query public function Modify the query for paging Overrides PagerPluginBase::query
Some::summaryTitle public function Return a string to display as the clickable title for the pager plugin. Overrides PagerPluginBase::summaryTitle
Some::use_count_query function Determine if a pager needs a count query. Overrides PagerPluginBase::use_count_query
Some::use_pager function Determine if this pager actually uses a pager. Overrides PagerPluginBase::use_pager