You are here

class ConfigPagesContextBase in Config Pages 8.2

Same name and namespace in other branches
  1. 8.3 src/ConfigPagesContextBase.php \Drupal\config_pages\ConfigPagesContextBase
  2. 8 src/ConfigPagesContextBase.php \Drupal\config_pages\ConfigPagesContextBase

Base class for Context plugins.

@package Drupal\config_pages

Hierarchy

Expanded class hierarchy of ConfigPagesContextBase

1 file declares its use of ConfigPagesContextBase
Language.php in src/Plugin/ConfigPagesContext/Language.php

File

src/ConfigPagesContextBase.php, line 14

Namespace

Drupal\config_pages
View source
class ConfigPagesContextBase extends PluginBase implements ConfigPagesContextInterface, ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * Get the label of the context.
   *
   * @return string
   *   Return the label of the context.
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }

  /**
   * Get the value of the context. Needs to be overridden for concrete context.
   *
   * @return mixed
   *   Return the value of the context.
   */
  public function getValue() {
    return '';
  }

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

  /**
   * Return array of available links to switch on given context.
   *
   * @return array
   *   Return links.
   */
  public function getLinks() {
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigPagesContextBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ConfigPagesContextBase::getLabel public function Get the label of the context. Overrides ConfigPagesContextInterface::getLabel 1
ConfigPagesContextBase::getLinks public function Return array of available links to switch on given context. Overrides ConfigPagesContextInterface::getLinks 1
ConfigPagesContextBase::getValue public function Get the value of the context. Needs to be overridden for concrete context. Overrides ConfigPagesContextInterface::getValue 1
ConfigPagesContextBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
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.