class views_plugin_pager in Views (for Drupal 7) 7.3

The base plugin to handle pager.

Hierarchy

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

Related topics

Views pager plugins

@todo.

1 string reference to 'views_plugin_pager'

views_views_plugins in includes/plugins.inc

Implements hook_views_plugins().

File

plugins/views_plugin_pager.inc, line 19

Definition of views_plugin_pager.

class views_plugin_pager extends views_plugin {

  /**
   *
   */
  public $current_page = NULL;

  /**
   *
   */
  public $total_items = 0;

  /**
   * Initialize the plugin.
   *
   * @param view $view
   *   The view object.
   * @param object $display
   *   The display handler.
   */
  public function init(&$view, &$display, $options = array()) {
    $this->view =& $view;
    $this->display =& $display;
    $this
      ->unpack_options($this->options, $options);
  }

  /**
   * Get how many items per page this pager will display.
   *
   * All but the leanest pagers should probably return a value here, so
   * most pagers will not need to override this method.
   */
  public function get_items_per_page() {
    return isset($this->options['items_per_page']) ? (int) $this->options['items_per_page'] : 0;
  }

  /**
   * Set how many items per page this pager will display.
   *
   * This is mostly used for things that will override the value.
   */
  public function set_items_per_page($items) {
    $this->options['items_per_page'] = (int) $items;
  }

  /**
   * Get the page offset, or how many items to skip.
   *
   * Even pagers that don't actually page can skip items at the beginning,
   * so few pagers will need to override this method.
   */
  public function get_offset() {
    return isset($this->options['offset']) ? (int) $this->options['offset'] : 0;
  }

  /**
   * Set the page offset, or how many items to skip.
   */
  public function set_offset($offset) {
    $this->options['offset'] = (int) $offset;
  }

  /**
   * Get the current page.
   *
   * If NULL, we do not know what the current page is.
   */
  public function get_current_page() {
    return $this->current_page;
  }

  /**
   * Set the current page.
   *
   * @param int $number
   *   If provided, the page number will be set to this. If NOT provided,
   *   the page number will be set from the global page array.
   */
  public function set_current_page($number = NULL) {
    if (!is_numeric($number) || $number < 0) {
      $number = 0;
    }
    $this->current_page = $number;
  }

  /**
   * Get the total number of items.
   *
   * If NULL, we do not yet know what the total number of items are.
   */
  public function get_total_items() {
    return $this->total_items;
  }

  /**
   * Get the pager id, if it exists.
   */
  public function get_pager_id() {
    return !empty($this->options['id']) ? $this->options['id'] : 0;
  }

  /**
   * Provide the default form form for validating options.
   */
  public function options_validate(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for submitting options.
   */
  public function options_submit(&$form, &$form_state) {
  }

  /**
   * Return a string to display as the clickable title for the
   * pager plugin.
   */
  public function summary_title() {
    return t('Unknown');
  }

  /**
   * Determine if this pager actually uses a pager.
   *
   * Only a couple of very specific pagers will set this to false.
   */
  public function use_pager() {
    return TRUE;
  }

  /**
   * Determine if a pager needs a count query.
   *
   * If a pager needs a count query, a simple query
   */
  public function use_count_query() {
    return TRUE;
  }

  /**
   * Execute the count query, which will be done just prior to the query
   * itself being executed.
   */
  public function execute_count_query(&$count_query) {
    $this->total_items = $count_query
      ->execute()
      ->fetchField();
    if (!empty($this->options['offset'])) {
      $this->total_items -= $this->options['offset'];
    }
    $this
      ->update_page_info();
    return $this->total_items;
  }

  /**
   * 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.
   */
  public function update_page_info() {
  }

  /**
   * Modify the query for paging
   *
   * This is called during the build phase and can directly modify the query.
   */
  public function query() {
  }

  /**
   * Perform any needed actions just prior to the query executing.
   */
  public function pre_execute(&$query) {
  }

  /**
   * Perform any needed actions just after the query executing.
   */
  public function post_execute(&$result) {
  }

  /**
   * Perform any needed actions just before rendering.
   */
  public function pre_render(&$result) {
  }

  /**
   * Render the pager.
   *
   * Called during the view render process, this will render the
   * pager.
   *
   * @param array $input
   *   Any extra GET parameters that should be retained, such as exposed
   *   input.
   */
  public function render($input) {
  }

  /**
   * Determine if there are more records available.
   *
   * This is primarily used to control the display of a more link.
   */
  public function has_more_records() {
    return $this
      ->get_items_per_page() && $this->total_items > (intval($this->current_page) + 1) * $this
      ->get_items_per_page();
  }

  /**
   * {@inheritdoc}
   */
  public function exposed_form_alter(&$form, &$form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function exposed_form_validate(&$form, &$form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function exposed_form_submit(&$form, &$form_state, &$exclude) {
  }

  /**
   * {@inheritdoc}
   */
  public function uses_exposed() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function items_per_page_exposed() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function offset_exposed() {
    return FALSE;
  }

}

Members

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