You are here

abstract class SlickSkinPluginBase in Slick Carousel 8.2

Provides base class for all slick skins.

Hierarchy

Expanded class hierarchy of SlickSkinPluginBase

2 files declare their use of SlickSkinPluginBase
SlickSkin.php in src/Plugin/slick/SlickSkin.php
SlickSkinTest.php in tests/modules/slick_test/src/Plugin/slick/SlickSkinTest.php

File

src/SlickSkinPluginBase.php, line 11

Namespace

Drupal\slick
View source
abstract class SlickSkinPluginBase extends PluginBase implements SlickSkinPluginInterface {
  use StringTranslationTrait;

  /**
   * The slick main/thumbnail skin definitions.
   *
   * @var array
   */
  protected $skins;

  /**
   * The slick arrow skin definitions.
   *
   * @var array
   */
  protected $arrows;

  /**
   * The slick dot skin definitions.
   *
   * @var array
   */
  protected $dots;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->skins = $this
      ->setSkins();
    $this->arrows = $this
      ->setArrows();
    $this->dots = $this
      ->setDots();
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->configuration['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function skins() {
    return $this->skins;
  }

  /**
   * {@inheritdoc}
   */
  public function arrows() {
    return $this->arrows;
  }

  /**
   * {@inheritdoc}
   */
  public function dots() {
    return $this->dots;
  }

  /**
   * Sets the required plugin main/thumbnail skins.
   */
  protected abstract function setSkins();

  /**
   * Sets the optional/ empty plugin arrow skins.
   */
  protected function setArrows() {
    return [];
  }

  /**
   * Sets the optional/ empty plugin dot skins.
   */
  protected function setDots() {
    return [];
  }

}

Members

Namesort descending 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.
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.
SlickSkinPluginBase::$arrows protected property The slick arrow skin definitions.
SlickSkinPluginBase::$dots protected property The slick dot skin definitions.
SlickSkinPluginBase::$skins protected property The slick main/thumbnail skin definitions.
SlickSkinPluginBase::arrows public function Returns the plugin arrow skins. Overrides SlickSkinPluginInterface::arrows
SlickSkinPluginBase::dots public function Returns the plugin dot skins. Overrides SlickSkinPluginInterface::dots
SlickSkinPluginBase::label public function Returns the plugin label. Overrides SlickSkinPluginInterface::label
SlickSkinPluginBase::setArrows protected function Sets the optional/ empty plugin arrow skins. 1
SlickSkinPluginBase::setDots protected function Sets the optional/ empty plugin dot skins. 1
SlickSkinPluginBase::setSkins abstract protected function Sets the required plugin main/thumbnail skins. 2
SlickSkinPluginBase::skins public function Returns the Slick skins. Overrides SlickSkinPluginInterface::skins
SlickSkinPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.