class Mini

Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/pager/Mini.php \Drupal\views\Plugin\views\pager\Mini
  2. 10 core/modules/views/src/Plugin/views/pager/Mini.php \Drupal\views\Plugin\views\pager\Mini
  3. 11.x core/modules/views/src/Plugin/views/pager/Mini.php \Drupal\views\Plugin\views\pager\Mini

The plugin to handle mini pager.

Plugin annotation


@ViewsPager(
  id = "mini",
  title = @Translation("Paged output, mini pager"),
  short_title = @Translation("Mini"),
  help = @Translation("A simple pager containing previous and next links."),
  theme = "views_mini_pager"
)

Hierarchy

Expanded class hierarchy of Mini

Related topics

50 string references to 'Mini'
AreaDisplayLinkTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
DisplayPluginBase::defineOptions in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Information about options for all kinds of purposes will be held here.
FieldCounterTest::testPager in core/modules/views/tests/src/Kernel/Handler/FieldCounterTest.php
Tests the counter field when using a pager.
PagerTest::testStorePagerSettings in core/modules/views/tests/src/Functional/Plugin/PagerTest.php
Pagers was sometimes not stored.
PagerTest::testStorePagerSettings in core/modules/views/tests/src/Functional/Plugin/PagerTest.php
Pagers was sometimes not stored.

... See full list

File

core/modules/views/src/Plugin/views/pager/Mini.php, line 18

Namespace

Drupal\views\Plugin\views\pager
View source
class Mini extends SqlBase {
    
    /**
     * Overrides \Drupal\views\Plugin\views\pager\PagerPlugin::defineOptions().
     *
     * Provides sane defaults for the next/previous links.
     */
    public function defineOptions() {
        $options = parent::defineOptions();
        $options['tags']['contains']['previous']['default'] = '‹‹';
        $options['tags']['contains']['next']['default'] = '››';
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function summaryTitle() {
        if (!empty($this->options['offset'])) {
            return $this->formatPlural($this->options['items_per_page'], 'Mini pager, @count item, skip @skip', 'Mini pager, @count items, skip @skip', [
                '@count' => $this->options['items_per_page'],
                '@skip' => $this->options['offset'],
            ]);
        }
        return $this->formatPlural($this->options['items_per_page'], 'Mini pager, @count item', 'Mini pager, @count items', [
            '@count' => $this->options['items_per_page'],
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        parent::query();
        // Only modify the query if we don't want to do a total row count
        if (!$this->view->get_total_rows) {
            // Don't query for the next page if we have a pager that has a limited
            // amount of pages.
            if ($this->getItemsPerPage() > 0 && (empty($this->options['total_pages']) || $this->getCurrentPage() < $this->options['total_pages'])) {
                // Increase the items in the query in order to be able to find out
                // whether there is another page.
                $limit = $this->view->query
                    ->getLimit();
                $limit += 1;
                $this->view->query
                    ->setLimit($limit);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function useCountQuery() {
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function postExecute(&$result) {
        // Only modify the result if we didn't do a total row count
        if (!$this->view->get_total_rows) {
            $this->total_items = $this->getCurrentPage() * $this->getItemsPerPage() + count($result);
            // query() checks if we need a next link by setting limit 1 record past
            // this page If we got the extra record we need to remove it before we
            // render the result.
            if ($this->getItemsPerPage() > 0 && count($result) > $this->getItemsPerPage()) {
                array_pop($result);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($input) {
        // The 1, 3 indexes are correct, see template_preprocess_pager().
        $tags = [
            1 => $this->options['tags']['previous'],
            3 => $this->options['tags']['next'],
        ];
        return [
            '#theme' => $this->themeFunctions(),
            '#tags' => $tags,
            '#element' => $this->options['id'],
            '#parameters' => $input,
            '#route_name' => !empty($this->view->live_preview) ? '<current>' : '<none>',
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
Mini::defineOptions public function Overrides \Drupal\views\Plugin\views\pager\PagerPlugin::defineOptions(). Overrides SqlBase::defineOptions
Mini::postExecute public function Perform any needed actions just after the query executing. Overrides PagerPluginBase::postExecute
Mini::query public function Modify the query for paging. Overrides SqlBase::query
Mini::render public function Return the renderable array of the pager. Overrides PagerPluginBase::render
Mini::summaryTitle public function Returns a string to display as the clickable title for the pager plugin. Overrides PagerPluginBase::summaryTitle
Mini::useCountQuery public function Determine if a pager needs a count query. Overrides PagerPluginBase::useCountQuery
PagerPluginBase::$current_page public property
PagerPluginBase::$total_items public property
PagerPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
PagerPluginBase::executeCountQuery public function Executes the count query. 1
PagerPluginBase::exposedFormSubmit public function
PagerPluginBase::getCurrentPage public function Get the current page.
PagerPluginBase::getItemsPerPage public function Get how many items per page this pager will display. 1
PagerPluginBase::getOffset public function Get the page offset, or how many items to skip.
PagerPluginBase::getPagerId public function Get the pager id, if it exists.
PagerPluginBase::getTotalItems public function Get the total number of items.
PagerPluginBase::hasMoreRecords public function Determine if there are more records available.
PagerPluginBase::preExecute public function Perform any needed actions just prior to the query executing.
PagerPluginBase::preRender public function Perform any needed actions just before rendering.
PagerPluginBase::setItemsPerPage public function Set how many items per page this pager will display.
PagerPluginBase::setOffset public function Set the page offset, or how many items to skip.
PagerPluginBase::submitOptionsForm public function Provide the default form for submitting options. Overrides PluginBase::submitOptionsForm
PagerPluginBase::usePager public function Determine if this pager actually uses a pager. 2
PluginBase::$definition public property Plugins&#039; 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::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 6
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SqlBase::$pagerManager protected property The pager manager.
SqlBase::$pagerParameters protected property The pager parameters.
SqlBase::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm 1
SqlBase::create public static function Creates an instance of the plugin. Overrides PluginBase::create
SqlBase::exposedFormAlter public function Overrides PagerPluginBase::exposedFormAlter
SqlBase::exposedFormValidate public function Overrides PagerPluginBase::exposedFormValidate
SqlBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
SqlBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
SqlBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
SqlBase::getPagerTotal public function
SqlBase::isOffsetExposed protected function Overrides PagerPluginBase::isOffsetExposed
SqlBase::itemsPerPageExposed protected function Overrides PagerPluginBase::itemsPerPageExposed
SqlBase::setCurrentPage public function Set the current page. Overrides PagerPluginBase::setCurrentPage
SqlBase::updatePageInfo public function Update global paging info. Overrides PagerPluginBase::updatePageInfo
SqlBase::usesExposed public function Overrides PagerPluginBase::usesExposed
SqlBase::validateOptionsForm public function Provide the default form for validating options. Overrides PagerPluginBase::validateOptionsForm
SqlBase::__construct public function Constructs a SqlBase object. Overrides PluginBase::__construct
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.