You are here

interface PagererStyleInterface in Pagerer 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/PagererStyleInterface.php \Drupal\pagerer\Plugin\PagererStyleInterface

Provides an interface defining an Pagerer pager style.

Hierarchy

Expanded class hierarchy of PagererStyleInterface

All classes that implement PagererStyleInterface

2 files declare their use of PagererStyleInterface
Multipane.php in src/Plugin/pagerer/Multipane.php
PagererStyleBase.php in src/Plugin/pagerer/PagererStyleBase.php

File

src/Plugin/PagererStyleInterface.php, line 10

Namespace

Drupal\pagerer\Plugin
View source
interface PagererStyleInterface {

  /**
   * Sets the Pagerer pager to be rendered.
   *
   * @param \Drupal\pagerer\Pagerer $pager
   *   The pager object.
   *
   * @return \Drupal\pagerer\Plugin\PagererStyleInterface
   *   The pager style object.
   */
  public function setPager(Pagerer $pager);

  /**
   * Prepares to render the pager.
   *
   * @param array $variables
   *   An associative array containing:
   *   - style: The PagererStyle plugin id to be used to render the pager. Only
   *     for base style plugins.
   *   - element: An optional integer to distinguish between multiple pagers on
   *     one page.
   *   - parameters: An associative array of query string parameters to append
   *     to the pager links.
   *   - config: An associative array of configuration elements for the pager
   *     style.
   */
  public function preprocess(array &$variables);

}

Members

Namesort descending Modifiers Type Description Overrides
PagererStyleInterface::preprocess public function Prepares to render the pager. 2
PagererStyleInterface::setPager public function Sets the Pagerer pager to be rendered. 2