You are here

Home » API reference » Views Slideshow Rendered Entity Pager 8.4 » PagerRenderedEntity.php

class PagerRenderedEntity in Views Slideshow Rendered Entity Pager 8.4

Provides a pager using rendered entity.

Plugin annotation


@ViewsSlideshowWidget(
  id = "views_slideshow_rendered_entity_pager",
  type = "views_slideshow_pager",
  label = @Translation("Rendered entity"),
)

Hierarchy

Expanded class hierarchy of PagerRenderedEntity

File

src/Plugin/ViewsSlideshowWidget/PagerRenderedEntity.php, line 22
Contains Drupal\views_slideshow_rendered_entity_pager\ViewsSlideshowWidget\PagerRenderedEntity.

Namespace

Drupal\views_slideshow_rendered_entity_pager\Plugin\ViewsSlideshowWidget
View source 
class PagerRenderedEntity extends ViewsSlideshowWidgetBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'views_slideshow_rendered_entity_pager_view_mode' => array(
        'default' => '',
      ),
      'views_slideshow_rendered_entity_pager_hover' => array(
        'default' => 0,
      ),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $baseTable = $this
      ->getConfiguration()['view']->storage
      ->get('base_table');
    $entityType = \Drupal::service('views.views_data')
      ->get($baseTable)['table']['entity type'];
    $viewModes = \Drupal::entityManager()
      ->getViewModes($entityType);
    $options = array();
    if (!empty($viewModes)) {
      foreach ($viewModes as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }

    // Display a list only if user has selected "Rendered entity" as pager style.
    $form['views_slideshow_rendered_entity_pager_view_mode'] = array(
      '#type' => 'select',
      '#title' => t('Pager view mode'),
      '#options' => $options,
      '#default_value' => $this
        ->getConfiguration()['views_slideshow_rendered_entity_pager_view_mode'],
      '#description' => t('Choose the view mode that will appear in the pager.'),
      '#states' => array(
        'visible' => array(
          ':input[name="' . $this
            ->getConfiguration()['dependency'] . '[enable]"]' => array(
            'checked' => TRUE,
          ),
          ':input[name="' . $this
            ->getConfiguration()['dependency'] . '[type]"]' => array(
            'value' => 'views_slideshow_rendered_entity_pager',
          ),
        ),
      ),
    );

    // Add field to see if they would like to activate slide and pause on pager
    // hover.
    $form['views_slideshow_rendered_entity_pager_hover'] = array(
      '#type' => 'checkbox',
      '#title' => t('Activate Slide and Pause on Pager Hover'),
      '#default_value' => $this
        ->getConfiguration()['views_slideshow_rendered_entity_pager_hover'],
      '#description' => t('Should the slide be activated and paused when hovering over a pager item.'),
      '#states' => array(
        'visible' => array(
          ':input[name="' . $this
            ->getConfiguration()['dependency'] . '[enable]"]' => array(
            'checked' => TRUE,
          ),
          ':input[name="' . $this
            ->getConfiguration()['dependency'] . '[type]"]' => array(
            'value' => 'views_slideshow_rendered_entity_pager',
          ),
        ),
      ),
    );
    return $form;
  }

}

Members

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