interface ConfigurationIgnorePluginInterface in Config Ignore Keys 8

Interface ConfigurationIgnorePluginInterface.

@package Drupal\config_ignore_keys\Plugin

Hierarchy

• interface \Drupal\config_ignore_keys\Plugin\ConfigurationIgnorePluginInterface

2 files declare their use of ConfigurationIgnorePluginInterface

NodeConfigIgnore.php in tests/modules/configuration_ignore_test/src/Plugin/ConfigIgnore/NodeConfigIgnore.php

NullConfigIgnorePlugin.php in src/Plugin/ConfigIgnore/NullConfigIgnorePlugin.php

File

src/Plugin/ConfigurationIgnorePluginInterface.php, line 10

Namespace

Drupal\config_ignore_keys\Plugin

interface ConfigurationIgnorePluginInterface {

  /**
   * Should return an array containing the following structure.
   *
   * @code
   *  [
   *    'name.of.the.configuration.file.without.extension.1' => [
   *      'key.of.the.configuration.1'
   *      'key.of.the.configuration.2'
   *    ],
   *    'name.of.the.configuration.file.without.extension.2' => [
   *      'key.of.the.configuration.1'
   *      'key.of.the.configuration.2'
   *    ],
   *    'name.of.the.configuration.file.without.extension.3'
   * ]
   * @endcode
   *
   * The key.of.the.configuration is the path to the config key inside the array
   * containing the entire configuration of the file.
   *
   * For 'name.of.the.configuration.file.without.extension.3' the whole file
   * will be ignored.
   *
   * @see ConfigFactoryInterface::getEditable()
   *
   * @return array
   *   The configuration.
   */
  public function getConfigurations();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationIgnorePluginInterface::getConfigurations	public	function	Should return an array containing the following structure.	2