abstract class PatternSourceBase in UI Patterns 8

Base class for UI Patterns Source plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\ui_patterns\Plugin\PatternSourceBase implements ConfigurableInterface, PluginInspectionInterface, PatternSourceInterface uses StringTranslationTrait

6 files declare their use of PatternSourceBase

DsFieldSource.php in modules/ui_patterns_ds/src/Plugin/UiPatterns/Source/DsFieldSource.php

DsFieldTemplateSource.php in modules/ui_patterns_ds/src/Plugin/UiPatterns/Source/DsFieldTemplateSource.php

FieldSource.php in src/Plugin/UiPatterns/Source/FieldSource.php

PatternDisplayFormTrait.php in src/Form/PatternDisplayFormTrait.php

TestSource.php in tests/modules/ui_patterns_field_source_test/src/Plugin/UiPatterns/Source/TestSource.php

... See full list

File

src/Plugin/PatternSourceBase.php, line 15

Namespace

Drupal\ui_patterns\Plugin

abstract class PatternSourceBase extends PluginBase implements PatternSourceInterface, PluginInspectionInterface, ConfigurableInterface {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function getSourceField($name, $label) {
    return new PatternSourceField($name, $label, $this->pluginDefinition['id'], $this->pluginDefinition['label']);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'context' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getContextProperty($name) {
    $configuration = $this
      ->getConfiguration();
    if (isset($configuration['context'][$name]) && !empty($configuration['context'][$name])) {
      return $configuration['context'][$name];
    }
    $reflection = new \ReflectionClass($this);
    $message = sprintf("Context property '%s' from %s is missing or empty.", $name, $reflection->name);
    throw new PluginException($message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PatternSourceBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSourceBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PatternSourceBase::getContextProperty	public	function	Get context property value, if any. Overrides PatternSourceInterface::getContextProperty
PatternSourceBase::getSourceField	public	function	Source field factory method. Overrides PatternSourceInterface::getSourceField
PatternSourceBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PatternSourceInterface::getSourceFields	public	function	Return list of source fields.	5
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.