class Pagerer in Pagerer 8.2

Same name in this branch

8.2 src/Pagerer.php \Drupal\pagerer\Pagerer
8.2 src/Plugin/views/pager/Pagerer.php \Drupal\pagerer\Plugin\views\pager\Pagerer

Same name and namespace in other branches

8 src/Plugin/views/pager/Pagerer.php \Drupal\pagerer\Plugin\views\pager\Pagerer

The views plugin to handle Pagerer pager.

Based on the 'Full' pager, just adds the option to select the Pagerer preset to use for rendering the pager, and removes the options to define the text tags.

Plugin annotation


@ViewsPager(
  id = "pagerer",
  title = @Translation("Paged output, Pagerer"),
  short_title = @Translation("Pagerer"),
  help = @Translation("Paged output, using Pagerer presets"),
  theme = "pagerer",
  register_theme = FALSE
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\pager\PagerPluginBase
    class \Drupal\views\Plugin\views\pager\SqlBase implements CacheableDependencyInterface, ContainerFactoryPluginInterface
    class \Drupal\views\Plugin\views\pager\Full
    class \Drupal\pagerer\Plugin\views\pager\Pagerer implements ContainerFactoryPluginInterface

Expanded class hierarchy of Pagerer

3 string references to 'Pagerer'

pagerer.info.yml in ./pagerer.info.yml: pagerer.info.yml
pagerer.links.menu.yml in ./pagerer.links.menu.yml: pagerer.links.menu.yml
pagerer.routing.yml in ./pagerer.routing.yml: pagerer.routing.yml

File

src/Plugin/views/pager/Pagerer.php, line 31

Namespace

Drupal\pagerer\Plugin\views\pager

View source

class Pagerer extends Full implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The list of pagerer presets.
   *
   * @var \Drupal\Core\Entity\EntityListBuilderInterface
   */
  protected $presetsList;

  /**
   * The Pagerer preset entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $presetStorage;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Pager\PagerManagerInterface $pager_manager
   *   The pager manager.
   * @param \Drupal\Core\Pager\PagerParametersInterface $pager_parameters
   *   The pager parameters.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PagerManagerInterface $pager_manager, PagerParametersInterface $pager_parameters, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $pager_manager, $pager_parameters);
    $this->entityTypeManager = $entity_type_manager;
    $this->presetsList = $this->entityTypeManager
      ->getListBuilder('pagerer_preset');
    $this->presetStorage = $this->entityTypeManager
      ->getStorage('pagerer_preset');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('pager.manager'), $container
      ->get('pager.parameters'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    if ($preset = $this->presetStorage
      ->load($this->options['preset'])) {
      $preset_label = $preset
        ->label();
    }
    else {
      $preset_label = $this
        ->t('n/a');
    }
    if (!empty($this->options['offset'])) {
      return $this
        ->formatPlural($this->options['items_per_page'], "Using preset %preset, @count item, skip @skip", "Using preset %preset, @count items, skip @skip", [
        '%preset' => $preset_label,
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ]);
    }
    return $this
      ->formatPlural($this->options['items_per_page'], "Using preset %preset, @count item", "Using preset %preset, @count items", [
      '%preset' => $preset_label,
      '@count' => $this->options['items_per_page'],
    ]);
  }

  /**
   * {@inheritdoc}
   *
   * Same as 'Full', plus preset. Tags are left even if the options form
   * will not present them, as tags in Pagerer are different than in core.
   */
  public function defineOptions() {
    $options = parent::defineOptions();
    $options['preset'] = [
      'default' => 'core',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   *
   * Same as 'Full', plus preset, less tags and quantity.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['preset'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Preset'),
      '#description' => $this
        ->t("Select the Pagerer preset to use to render the pager."),
      '#options' => $this->presetsList
        ->listOptions(),
      '#default_value' => $this->options['preset'],
    ];
    parent::buildOptionsForm($form, $form_state);
    unset($form['tags'], $form['quantity']);
  }

  /**
   * {@inheritdoc}
   */
  public function render($input) {
    return [
      '#theme' => $this
        ->themeFunctions(),
      '#route_name' => !empty($this->view->live_preview) ? '<current>' : '<none>',
      '#element' => $this->options['id'],
      '#parameters' => $input,
      '#config' => [
        'preset' => $this->options['preset'],
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
Pagerer::$entityTypeManager	protected	property	The entity type manager service.
Pagerer::$presetsList	protected	property	The list of pagerer presets.
Pagerer::$presetStorage	protected	property	The Pagerer preset entity storage.
Pagerer::buildOptionsForm	public	function	Same as 'Full', plus preset, less tags and quantity. Overrides Full::buildOptionsForm
Pagerer::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create
Pagerer::defineOptions	public	function	Same as 'Full', plus preset. Tags are left even if the options form will not present them, as tags in Pagerer are different than in core. Overrides Full::defineOptions
Pagerer::render	public	function	Return the renderable array of the pager. Overrides Full::render
Pagerer::summaryTitle	public	function	Return a string to display as the clickable title for the pager plugin. Overrides Full::summaryTitle
Pagerer::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct
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	Execute the count query, which will be done just prior to the query itself being executed.	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::postExecute	public	function	Perform any needed actions just after the query executing.	2
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 form for submitting options Overrides PluginBase::submitOptionsForm
PagerPluginBase::useCountQuery	public	function	Determine if a pager needs a count query.	3
PagerPluginBase::usePager	public	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::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
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::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
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	8
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. 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' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
SqlBase::$pagerManager	protected	property	The pager manager.
SqlBase::$pagerParameters	protected	property	The pager parameters.
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::query	public	function	Modify the query for paging Overrides PagerPluginBase::query	83
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 form for validating options Overrides PagerPluginBase::validateOptionsForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
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.

You are here