class PluginConfiguration in Plugin 8.2

Provides a plugin configuration data type.

Plugin annotation

@DataType(
  id = "plugin_configuration",
  label = @Translation("Plugin configuration")
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\plugin\Plugin\DataType\PluginConfiguration

File

src/Plugin/DataType/PluginConfiguration.php, line 19

Namespace

Drupal\plugin\Plugin\DataType

class PluginConfiguration extends TypedData {

  /**
   * The parent typed data object.
   *
   * @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface
   */
  protected $parent;

  /**
   * The plugin configuration.
   *
   * @var mixed[]
   */
  protected $value;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
   *   The data definition.
   * @param string $name
   *   The name of the created property.
   * @param \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $parent
   *   The parent object of the data property.
   */
  public function __construct(DataDefinitionInterface $definition, $name, PluginCollectionItemInterface $parent) {
    parent::__construct($definition, $name, $parent);
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($value, $notify = TRUE) {
    $value = (array) $value;
    $plugin_instance = $this->parent
      ->getContainedPluginInstance();
    if ($plugin_instance instanceof ConfigurableInterface || $plugin_instance instanceof ConfigurablePluginInterface) {
      $plugin_instance
        ->setConfiguration($value);
    }
    $this->parent
      ->onChange($this
      ->getName());
  }

  /**
   * {@inheritdoc}
   */
  public function getValue() {
    $plugin_instance = $this->parent
      ->getContainedPluginInstance();
    if ($plugin_instance instanceof ConfigurableInterface || $plugin_instance instanceof ConfigurablePluginInterface) {
      return $plugin_instance
        ->getConfiguration();
    }
    return [];
  }

}

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
PluginConfiguration::$parent	protected	property	The parent typed data object. Overrides TypedData::$parent
PluginConfiguration::$value	protected	property	The plugin configuration.
PluginConfiguration::getValue	public	function	Gets the data value. Overrides TypedData::getValue
PluginConfiguration::setValue	public	function	Sets the data value. Overrides TypedData::setValue
PluginConfiguration::__construct	public	function	Constructs a new instance. Overrides TypedData::__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.
TypedData::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	3
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString	public	function	Returns a string representation of the data. Overrides TypedDataInterface::getString	6
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2