interface ArrayPluginDefinitionInterface in Plugin 8.2

Defines a plugin definition.

For backwards compatibility with array-based plugin definitions, this interface implements \ArrayAccess. The required array keys and their corresponding setters and getters are:

• id: static::setId() and static::getId()
• class: static::setClass() and static::getClass()
• label: static::setLabel() and static::getLabel()
• deriver: static::setDeriverClass() and static::getDeriverClass()
• context: static::setContextDefinitions() and static::getContextDefinitions()

Hierarchy

• interface \Drupal\Component\Plugin\Definition\PluginDefinitionInterface
  • interface \Drupal\plugin\PluginDefinition\PluginDefinitionInterface
    • interface \Drupal\plugin\PluginDefinition\ArrayPluginDefinitionInterface extends \Drupal\plugin\PluginDefinition\ArrayAccess \Drupal\plugin\PluginDefinition\IteratorAggregate \Drupal\plugin\PluginDefinition\Countable

Deprecated

Deprecated as of 8.0.0. Do not rely on array plugin definitions.

File

src/PluginDefinition/ArrayPluginDefinitionInterface.php, line 22

Namespace

Drupal\plugin\PluginDefinition

interface ArrayPluginDefinitionInterface extends PluginDefinitionInterface, \ArrayAccess, \IteratorAggregate, \Countable {

  /**
   * Gets the array definition.
   *
   * @return mixed[]
   *   The array definition.
   */
  public function getArrayDefinition();

  /**
   * Merges another array definition into this one, using the other for defaults.
   *
   * @param mixed[] $other_definition
   *   The other array definition.
   *
   * @return $this
   */
  public function mergeDefaultArrayDefinition(array $other_definition);

  /**
   * Merges another array definition into this one, using the other for overrides.
   *
   * @param mixed[] $other_definition
   *   The other array definition.
   *
   * @return $this
   */
  public function mergeOverrideArrayDefinition(array $other_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayPluginDefinitionInterface::getArrayDefinition	public	function	Gets the array definition.	1
ArrayPluginDefinitionInterface::mergeDefaultArrayDefinition	public	function	Merges another array definition into this one, using the other for defaults.	1
ArrayPluginDefinitionInterface::mergeOverrideArrayDefinition	public	function	Merges another array definition into this one, using the other for overrides.	1
PluginDefinitionInterface::getClass	public	function	Gets the class.	1
PluginDefinitionInterface::getId	public	function	Gets the plugin ID.	2
PluginDefinitionInterface::getProvider	public	function	Gets the plugin provider. Overrides PluginDefinitionInterface::getProvider	2
PluginDefinitionInterface::id	public	function	Gets the unique identifier of the plugin.	1
PluginDefinitionInterface::mergeDefaultDefinition	public	function	Merges another definition into this one, using the other for defaults.
PluginDefinitionInterface::mergeOverrideDefinition	public	function	Merges another definition into this one, using the other for overrides.
PluginDefinitionInterface::setClass	public	function	Sets the class.	1
PluginDefinitionInterface::setId	public	function	Sets the plugin ID.	2
PluginDefinitionInterface::setProvider	public	function	Sets the plugin provider.	2