class views_plugin_pager_mini

The plugin to handle mini pager.

Hierarchy

class views_object
- class views_plugin
  - class views_plugin_pager
    class views_plugin_pager_full
    class views_plugin_pager_mini

Expanded class hierarchy of views_plugin_pager_mini

File

core/modules/views/plugins/views_plugin_pager_mini.inc, line 12: Definition of views_plugin_pager_mini.

View source

class views_plugin_pager_mini extends views_plugin_pager_full {
  function summary_title() {
    if (!empty($this->options['offset'])) {
      return format_plural($this->options['items_per_page'], 'Mini pager, @count item, skip @skip', 'Mini pager, @count items, skip @skip', array('@count' => $this->options['items_per_page'], '@skip' => $this->options['offset']));
    }
    return format_plural($this->options['items_per_page'], 'Mini pager, @count item', 'Mini pager, @count items', array('@count' => $this->options['items_per_page']));
  }

  /**
   * Overrides views_plugin_pager_full::option_definition().
   *
   * Overrides the full pager options form by deleting unused settings.
   */
  function option_definition() {
    $options = parent::option_definition();

    // Intentionally setting $options['quantity'] to NULL here instead of using
    // unset(), otherwise it throws "undefined index" notices.
    $options['quantity'] = NULL;
    unset($options['tags']['first']);
    unset($options['tags']['last']);
    $options['tags']['previous']['default'] = '‹‹';
    $options['tags']['next']['default'] = '››';

    return $options;
  }

  /**
   * Overrides views_plugin_pager_full::options_form().
   *
   * Overrides the full pager options form by deleting unused settings.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    unset($form['quantity']);
    unset($form['tags']['first']);
    unset($form['tags']['last']);
  }

  /**
   * Overrides views_plugin_pager_full::render().
   *
   * Overrides the full pager renderer by changing the theme function
   * and leaving out variables that are not used in the mini pager.
   */
  function render($input) {
    $pager_theme = views_theme_functions('views_mini_pager', $this->view, $this->display);
    // The 1, 3 index are correct.
    // @see theme_pager().
    $tags = array(
      1 => $this->options['tags']['previous'],
      3 => $this->options['tags']['next'],
    );
    return theme($pager_theme, array(
      'tags' => $tags,
      'element' => $this->get_pager_id(),
      'parameters' => $input,
    ));
  }
}

Members

Name	Modifiers	Type	Description
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy		function
views_object::options Deprecated		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
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	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		function
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title		function	Return the human readable name of the display.
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.
views_plugin_pager::execute_count_query		function	Execute the count query, which will be done just prior to the query itself being executed.
views_plugin_pager::exposed_form_submit		function
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.
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.
views_plugin_pager::options_submit		function	Provide the default form form for submitting options Overrides views_plugin::options_submit
views_plugin_pager::post_execute		function	Perform any needed actions just after the query executing.
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::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::use_count_query		function	Determine if a pager needs a count query.
views_plugin_pager::use_pager		function	Determine if this pager actually uses a pager.
views_plugin_pager_full::exposed_form_alter		function	Overrides views_plugin_pager::exposed_form_alter
views_plugin_pager_full::exposed_form_validate		function	Overrides views_plugin_pager::exposed_form_validate
views_plugin_pager_full::get_pager_total		function
views_plugin_pager_full::items_per_page_exposed		function	Overrides views_plugin_pager::items_per_page_exposed
views_plugin_pager_full::offset_exposed		function	Overrides views_plugin_pager::offset_exposed
views_plugin_pager_full::options_validate		function	Provide the default form form for validating options Overrides views_plugin_pager::options_validate
views_plugin_pager_full::query		function	Modify the query for paging Overrides views_plugin_pager::query
views_plugin_pager_full::set_current_page		function	Set the current page. Overrides views_plugin_pager::set_current_page
views_plugin_pager_full::update_page_info		function	Update global paging info. Overrides views_plugin_pager::update_page_info
views_plugin_pager_full::uses_exposed		function	Overrides views_plugin_pager::uses_exposed
views_plugin_pager_mini::options_form		function	Overrides views_plugin_pager_full::options_form(). Overrides views_plugin_pager_full::options_form
views_plugin_pager_mini::option_definition		function	Overrides views_plugin_pager_full::option_definition(). Overrides views_plugin_pager_full::option_definition
views_plugin_pager_mini::render		function	Overrides views_plugin_pager_full::render(). Overrides views_plugin_pager_full::render
views_plugin_pager_mini::summary_title		function	Return a string to display as the clickable title for the pager plugin. Overrides views_plugin_pager_full::summary_title

class views_plugin_pager_mini

Hierarchy

Related topics

File

Members