PagererStyleInterface.php in Pagerer 8.2

Namespace

Drupal\pagerer\Plugin

File

src/Plugin/PagererStyleInterface.php

<?php

namespace Drupal\pagerer\Plugin;

use Drupal\pagerer\Pagerer;

/**
 * Provides an interface defining an Pagerer pager style.
 */
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);

}

Interfaces

Name	Description
PagererStyleInterface	Provides an interface defining an Pagerer pager style.