class Mini

The plugin to handle mini pager.

Plugin annotation


@Plugin(
  id = "mini",
  title = @Translation("Paged output, mini pager"),
  short_title = @Translation("Mini"),
  help = @Translation("Use the mini pager output.")
)

Hierarchy

Expanded class hierarchy of Mini

Related topics

Views pager plugins
The base plugin to handler pagers of a view.
1 string reference to 'Mini'
PagerTest::testStorePagerSettings in drupal/core/modules/views/lib/Drupal/views/Tests/Plugin/PagerTest.php
Pagers was sometimes not stored.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/pager/Mini.php, line 25
Definition of Drupal\views\Plugin\views\pager\Mini.

Namespace

Drupal\views\Plugin\views\pager
View source
class Mini extends Full {
  public function summaryTitle() {
    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'],
    ));
  }
  function render($input) {
    $pager_theme = views_theme_functions('views_mini_pager', $this->view, $this->view->display_handler->display);
    return theme($pager_theme, array(
      'parameters' => $input,
      'element' => $this->options['id'],
    ));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Full::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm
Full::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PluginBase::defineOptions
Full::exposed_form_alter function Overrides PagerPluginBase::exposed_form_alter
Full::exposed_form_validate function Overrides PagerPluginBase::exposed_form_validate
Full::get_pager_total function
Full::items_per_page_exposed function Overrides PagerPluginBase::items_per_page_exposed
Full::offset_exposed function Overrides PagerPluginBase::offset_exposed
Full::query public function Modify the query for paging Overrides PagerPluginBase::query
Full::set_current_page function Set the current page. Overrides PagerPluginBase::set_current_page
Full::update_page_info function Update global paging info. Overrides PagerPluginBase::update_page_info
Full::uses_exposed function Overrides PagerPluginBase::uses_exposed
Full::validateOptionsForm public function Provide the default form form for validating options Overrides PagerPluginBase::validateOptionsForm
Mini::render function Render the pager. Overrides Full::render
Mini::summaryTitle public function Return a string to display as the clickable title for the pager plugin. Overrides Full::summaryTitle
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_submit function
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::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::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::use_count_query function Determine if a pager needs a count query. 2
PagerPluginBase::use_pager function Determine if this pager actually uses a pager. 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id 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::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
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