You are here

Home » API reference » Icon API 8 » IconSetBase.php

abstract class IconSetBase in Icon API 8

Class IconSetBase

Hierarchy

Expanded class hierarchy of IconSetBase

File

src/Plugin/Icon/IconSetBase.php, line 12

Namespace

Drupal\icon\Plugin\Icon
View source 
abstract class IconSetBase extends PluginBase implements IconSetInterface {
  use ContainerAwareTrait;
  private $icons = [];

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ContainerInterface $container = NULL, $icons = []) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    if (!isset($container)) {
      $container = \Drupal::getContainer();
    }
    $this
      ->setContainer($container);
    $this->icons = $icons;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container);
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return isset($this->pluginDefinition['label']) ? $this->pluginDefinition['label'] : $this
      ->getPluginId();
  }

  /**
   * {@inheritdoc}
   */
  public function getIcons() {
    return isset($this->pluginDefinition['icons']) ? $this->pluginDefinition['icons'] : $this->icons;
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider() {
    return isset($this->pluginDefinition['provider']) ? $this->pluginDefinition['provider'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getUrl() {
    return isset($this->pluginDefinition['url']) ? $this->pluginDefinition['url'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getVersion() {
    return isset($this->pluginDefinition['version']) ? $this->pluginDefinition['version'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getPath() {
    return isset($this->pluginDefinition['path']) ? $this->pluginDefinition['path'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getRenderer() {
    return isset($this->pluginDefinition['renderer']) ? $this->pluginDefinition['renderer'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings() {
    return isset($this->pluginDefinition['settings']) ? $this->pluginDefinition['settings'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function getAttached() {
    return isset($this->pluginDefinition['attached']) ? $this->pluginDefinition['attached'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function process() {
  }

  /**
   * {@inheritdoc}
   */
  public function getIcon($key = 'icon') {
    if (isset($this->icons[$key])) {
      return $this->icons[$key];
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setIcon($value, $key = 'icon') {
    $this->icons[$key] = $value;
  }

}

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
IconSetBase::$icons private property
IconSetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
IconSetBase::getAttached public function Retrieves an array of resources to be loaded alongside the icon set. Overrides IconSetInterface::getAttached
IconSetBase::getIcon public function Get icon. Overrides IconSetInterface::getIcon
IconSetBase::getIcons public function Retrieves an array of icons grouped by unique name. Overrides IconSetInterface::getIcons
IconSetBase::getLabel public function Retrieves the human readable label for the plugin. Overrides IconSetInterface::getLabel
IconSetBase::getPath public function Retrieves the path where the icon set resource files are located. Overrides IconSetInterface::getPath
IconSetBase::getProvider public function Retrieves the provider name corresponding to the icon set. Overrides IconSetInterface::getProvider
IconSetBase::getRenderer public function Retrieves the renderer the icon set should implement. Overrides IconSetInterface::getRenderer
IconSetBase::getSettings public function Retrieves an array of settings passed to the renderer. Overrides IconSetInterface::getSettings
IconSetBase::getUrl public function Retrieves the url for more information regarding the icon set. Overrides IconSetInterface::getUrl
IconSetBase::getVersion public function Retrieves the supplemental information for identifying the icon set. Overrides IconSetInterface::getVersion
IconSetBase::process public function Processes a IconSet. Overrides IconSetInterface::process 1
IconSetBase::setIcon public function Set icon. Overrides IconSetInterface::setIcon
IconSetBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.