class views_plugin_pager_some in Views (for Drupal 7) 6.3

Plugin for views without pagers.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_pager
      • class \views_plugin_pager_some

1 string reference to 'views_plugin_pager_some'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_pager_some.inc, line 8

class views_plugin_pager_some extends views_plugin_pager {
  function summary_title() {
    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'],
    ));
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['items_per_page'] = array(
      'default' => 10,
    );
    $options['offset'] = array(
      'default' => 0,
    );
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {
    $form['items_per_page'] = array(
      '#title' => t('Items to display'),
      '#type' => 'textfield',
      '#description' => t('The number of items to display per page.'),
      '#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;
  }
  function query() {
    $this->view->query
      ->set_limit($this->options['items_per_page']);
    $this->view->query
      ->set_offset($this->options['offset']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$definition		property	Handler's definition
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	6
views_object::destroy		function		2
views_object::export_option		function		1
views_object::export_options		function
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable		function	Unpack a single option definition.
views_object::unpack_translatables		function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults		function
views_plugin::$display		property	The current used views display.
views_plugin::$plugin_type		property	The plugin type of this plugin, for example style or query.
views_plugin::$view		property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_pager::$current_page		property
views_plugin_pager::$total_items		property
views_plugin_pager::execute_count_query		function	Execute the count query, which will be done just prior to the query itself being executed.	1
views_plugin_pager::exposed_form_alter		function		1
views_plugin_pager::exposed_form_submit		function
views_plugin_pager::exposed_form_validate		function		1
views_plugin_pager::get_current_page		function	Get the current page.
views_plugin_pager::get_items_per_page		function	Get how many items per page this pager will display.	1
views_plugin_pager::get_offset		function	Get the page offset, or how many items to skip.
views_plugin_pager::get_pager_id		function	Get the pager id, if it exists
views_plugin_pager::get_total_items		function	Get the total number of items.
views_plugin_pager::has_more_records		function	Determine if there are more records available.
views_plugin_pager::init		function	Initialize the plugin.	1
views_plugin_pager::items_per_page_exposed		function		1
views_plugin_pager::offset_exposed		function		1
views_plugin_pager::options_submit		function	Provide the default form form for submitting options Overrides views_plugin::options_submit
views_plugin_pager::options_validate		function	Provide the default form form for validating options Overrides views_plugin::options_validate	1
views_plugin_pager::post_execute		function	Perform any needed actions just after the query executing.	1
views_plugin_pager::pre_execute		function	Perform any needed actions just prior to the query executing.
views_plugin_pager::pre_render		function	Perform any needed actions just before rendering.
views_plugin_pager::render		function	Render the pager.	1
views_plugin_pager::set_current_page		function	Set the current page.	1
views_plugin_pager::set_items_per_page		function	Set how many items per page this pager will display.
views_plugin_pager::set_offset		function	Set the page offset, or how many items to skip.
views_plugin_pager::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
views_plugin_pager::uses_exposed		function		1
views_plugin_pager_some::options_form		function	Provide the default form for setting options. Overrides views_plugin::options_form
views_plugin_pager_some::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition
views_plugin_pager_some::query		function	Modify the query for paging Overrides views_plugin_pager::query
views_plugin_pager_some::summary_title		function	Return a string to display as the clickable title for the pager plugin. Overrides views_plugin_pager::summary_title
views_plugin_pager_some::use_count_query		function	Determine if a pager needs a count query. Overrides views_plugin_pager::use_count_query
views_plugin_pager_some::use_pager		function	Determine if this pager actually uses a pager. Overrides views_plugin_pager::use_pager