abstract class ThrobberPluginBase in Ajax loader 8

Class ThrobberBase.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ajax_loader\ThrobberPluginBase implements ThrobberPluginInterface

11 files declare their use of ThrobberPluginBase

ThrobberChasingDots.php in src/Plugin/ajax_loader/ThrobberChasingDots.php

ThrobberCircle.php in src/Plugin/ajax_loader/ThrobberCircle.php

ThrobberCubeGrid.php in src/Plugin/ajax_loader/ThrobberCubeGrid.php

ThrobberDoubleBounce.php in src/Plugin/ajax_loader/ThrobberDoubleBounce.php

ThrobberFadingCircle.php in src/Plugin/ajax_loader/ThrobberFadingCircle.php

... See full list

File

src/ThrobberPluginBase.php, line 10

Namespace

Drupal\ajax_loader

abstract class ThrobberPluginBase extends PluginBase implements ThrobberPluginInterface {
  protected $path;
  protected $markup;

  /** @codingStandardsIgnoreLine. */
  protected $css_file;
  protected $label;

  /**
   * ThrobberPluginBase constructor.
   *
   * @param array $configuration
   *   Array with configuration.
   * @param string $plugin_id
   *   String with plugin id.
   * @param mixed $plugin_definition
   *   Plugin definition value.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->path = '/' . drupal_get_path('module', 'ajax_loader');
    $this->markup = $this
      ->setMarkup();
    $this->css_file = $this
      ->setCssFile();
  }

  /**
   * Function to get markup.
   *
   * @return mixed
   *   Return markup.
   */
  public function getMarkup() {
    return $this->markup;
  }

  /**
   * Function to get css file.
   *
   * @return mixed
   *   Return the css file.
   */
  public function getCssFile() {
    return $this->css_file;
  }

  /**
   * Function to get label.
   *
   * @return mixed
   *   Return the label.
   */
  public function getLabel() {
    return $this->configuration['label'];
  }

  /**
   * Sets markup for throbber.
   */
  protected abstract function setMarkup();

  /**
   * Sets css file for throbber.
   */
  protected abstract function setCssFile();

}

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.
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.
ThrobberPluginBase::$css_file	protected	property	@codingStandardsIgnoreLine.
ThrobberPluginBase::$label	protected	property
ThrobberPluginBase::$markup	protected	property
ThrobberPluginBase::$path	protected	property
ThrobberPluginBase::getCssFile	public	function	Function to get css file. Overrides ThrobberPluginInterface::getCssFile
ThrobberPluginBase::getLabel	public	function	Function to get label. Overrides ThrobberPluginInterface::getLabel
ThrobberPluginBase::getMarkup	public	function	Function to get markup. Overrides ThrobberPluginInterface::getMarkup
ThrobberPluginBase::setCssFile	abstract protected	function	Sets css file for throbber.	11
ThrobberPluginBase::setMarkup	abstract protected	function	Sets markup for throbber.	11
ThrobberPluginBase::__construct	public	function	ThrobberPluginBase constructor. Overrides PluginBase::__construct