You are here

Home » API reference » Views Slideshow 8.4 » Pager.php

class Pager in Views Slideshow 8.4

Provides a pager widget type.

Plugin annotation


@ViewsSlideshowWidgetType(
  id = "views_slideshow_pager",
  label = @Translation("Pager"),
  accepts = {
    "transitionBegin" = {"required" = TRUE},
    "goToSlide",
    "previousSlide",
    "nextSlide"
  },
  calls = {"goToSlide", "pause", "play"}
)

Hierarchy

Expanded class hierarchy of Pager

File

src/Plugin/ViewsSlideshowWidgetType/Pager.php, line 23

Namespace

Drupal\views_slideshow\Plugin\ViewsSlideshowWidgetType
View source 
class Pager extends ViewsSlideshowWidgetTypeBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $options = parent::defaultConfiguration() + [
      'type' => [
        'default' => 0,
      ],
      'views_slideshow_pager_numbered_hover' => [
        'default' => 0,
      ],
      'views_slideshow_pager_numbered_click_to_page' => [
        'default' => 0,
      ],
      'views_slideshow_pager_thumbnails_hover' => [
        'default' => 0,
      ],
      'views_slideshow_pager_thumbnails_click_to_page' => [
        'default' => 0,
      ],
    ];

    /* @var \Drupal\Component\Plugin\PluginManagerInterface */
    $widgetManager = \Drupal::service('plugin.manager.views_slideshow.widget');

    // Get default configuration of all Pager plugins.
    foreach ($widgetManager
      ->getDefinitions($this
      ->getPluginId()) as $widget_id => $widget_info) {
      $options += $widgetManager
        ->createInstance($widget_id, [])
        ->defaultConfiguration();
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $view = $form_state
      ->get('view')
      ->get('executable');

    /* @var \Drupal\Component\Plugin\PluginManagerInterface */
    $widgetManager = \Drupal::service('plugin.manager.views_slideshow.widget');

    // Determine if this widget type is compatible with any slideshow type.
    $widgets = [];
    foreach ($widgetManager
      ->getDefinitions($this
      ->getPluginId()) as $widget_id => $widget_info) {
      if ($widgetManager
        ->createInstance($widget_id, [])
        ->checkCompatiblity($view)) {
        $widgets[$widget_id] = $widget_info['label'];
      }
    }
    if (!empty($widgets)) {

      // Need to wrap this so it indents correctly.
      $form['views_slideshow_pager_wrapper'] = [
        '#markup' => '<div class="vs-dependent">',
      ];

      // Create the widget type field.
      $form['type'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Pager Type'),
        '#description' => $this
          ->t('Style of the pager'),
        '#default_value' => $this
          ->getConfiguration()['type'],
        '#options' => $widgets,
        '#states' => [
          'visible' => [
            ':input[name="' . $this
              ->getConfiguration()['dependency'] . '[enable]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      foreach ($widgetManager
        ->getDefinitions() as $widget_id => $widget_info) {

        // Get the current configuration of this widget.
        $configuration = [];
        if (!empty($this
          ->getConfiguration()[$widget_id])) {
          $configuration = $this
            ->getConfiguration()[$widget_id];
        }
        $configuration['dependency'] = $this
          ->getConfiguration()['dependency'];
        $configuration['view'] = $view;
        $instance = $widgetManager
          ->createInstance($widget_id, $configuration);

        // Get the configuration form of this widget type.
        $form[$widget_id] = isset($form[$widget_id]) ? $form[$widget_id] : [];
        $form[$widget_id] = $instance
          ->buildConfigurationForm($form[$widget_id], $form_state);
      }
      $form['views_slideshow_pager_wrapper_close'] = [
        '#markup' => '</div>',
      ];
    }
    else {
      $form['enable_pager'] = [
        '#markup' => 'There are no pagers available.',
      ];
    }
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Pager::buildConfigurationForm public function Form constructor. Overrides ViewsSlideshowWidgetTypeBase::buildConfigurationForm
Pager::defaultConfiguration public function Gets default configuration for this plugin. Overrides ViewsSlideshowWidgetTypeBase::defaultConfiguration
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.
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.
ViewsSlideshowWidgetTypeBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ViewsSlideshowWidgetTypeBase::checkCompatiblity public function Check if the widget type is compatible with the selected slideshow. Overrides ViewsSlideshowWidgetTypeInterface::checkCompatiblity
ViewsSlideshowWidgetTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsSlideshowWidgetTypeBase::getTitle public function
ViewsSlideshowWidgetTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsSlideshowWidgetTypeBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ViewsSlideshowWidgetTypeBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ViewsSlideshowWidgetTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct