class Multipane in Pagerer 8

A multi-pane (left, center, and right) pager style.

Plugin annotation

@PagererStyle(
  id = "multipane",
  title = @Translation("Pagerer multi-pane pager"),
  short_title = @Translation("Multi-pane"),
  help = @Translation("A multi-pane (left, center, and right) pager style, enabling each pane to contain a base style."),
  style_type = "composite"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\pagerer\Plugin\pagerer\Multipane implements PagererStyleInterface

File

src/Plugin/pagerer/Multipane.php, line 23

Namespace

Drupal\pagerer\Plugin\pagerer

class Multipane extends PluginBase implements PagererStyleInterface {

  /**
   * The Pagerer pager object.
   *
   * @var \Drupal\pagerer\Pagerer
   */
  protected $pager;

  /**
   * {@inheritdoc}
   */
  public function setPager(Pagerer $pager) {
    $this->pager = $pager;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function preprocess(array &$variables) {

    // Load preset if specified.
    if (!empty($this->configuration['preset'])) {
      $preset = PagererPreset::load($this->configuration['preset']);
    }

    // Fully qualify all panes.
    if (isset($preset)) {
      $cacheable = TRUE;
      foreach ([
        'left',
        'center',
        'right',
      ] as $pane) {

        // Determine pane's style.
        if ($preset_style = $preset
          ->getPaneData($pane, 'style')) {
          $this->configuration['panes'][$pane]['style'] = $preset_style;
        }

        // If we are overriding preset's configuration via passed in pane
        // variables, we can't cache on its config entity.
        if (!empty($this->configuration['panes'][$pane]['config'])) {
          $cacheable = FALSE;
        }

        // Determine pane's config.
        if ($preset_config = $preset
          ->getPaneData($pane, 'config')) {
          $this->configuration['panes'][$pane]['config'] = NestedArray::mergeDeep($preset_config, $this->configuration['panes'][$pane]['config']);
        }
      }
    }

    // Check if pager is needed; if not, return immediately.
    // It is the lowest required number of pages in any of the panes.
    $page_restriction = min(isset($this->configuration['panes']['left']['config']['display_restriction']) ? $this->configuration['panes']['left']['config']['display_restriction'] : 2, isset($this->configuration['panes']['center']['config']['display_restriction']) ? $this->configuration['panes']['center']['config']['display_restriction'] : 2, isset($this->configuration['panes']['right']['config']['display_restriction']) ? $this->configuration['panes']['right']['config']['display_restriction'] : 2);
    if ($this->pager
      ->getTotalPages() < $page_restriction) {
      return;
    }

    // Build render array.
    foreach ([
      'left',
      'center',
      'right',
    ] as $pane) {
      if ($this->configuration['panes'][$pane]['style'] != 'none') {
        $variables['pagerer'][$pane . '_pane'] = [
          '#type' => 'pager',
          '#theme' => 'pagerer_base',
          '#style' => $this->configuration['panes'][$pane]['style'],
          '#route_name' => $variables['pager']['#route_name'],
          '#route_parameters' => isset($variables['pager']['#route_parameters']) ? $variables['pager']['#route_parameters'] : [],
          '#element' => $variables['pager']['#element'],
          '#parameters' => $variables['pager']['#parameters'],
          '#config' => $this->configuration['panes'][$pane]['config'],
        ];
      }
      else {
        $variables['pagerer'][$pane . '_pane'] = [];
      }
    }

    // Add the preset entity cache metadata, if possible.
    if (isset($preset) && $cacheable) {
      CacheableMetadata::createFromRenderArray($variables)
        ->merge(CacheableMetadata::createFromObject($preset))
        ->applyTo($variables);
    }
  }

}

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.
Multipane::$pager	protected	property	The Pagerer pager object.
Multipane::preprocess	public	function	Prepares to render the pager. Overrides PagererStyleInterface::preprocess
Multipane::setPager	public	function	Sets the Pagerer pager to be rendered. Overrides PagererStyleInterface::setPager
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.