interface ConfigProviderInterface in Configuration Provider 8.2

Defines an interface for Configuration provider plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\config_provider\Plugin\ConfigProviderInterface

File

src/Plugin/ConfigProviderInterface.php, line 13

Namespace

Drupal\config_provider\Plugin

interface ConfigProviderInterface extends PluginInspectionInterface {

  /**
   * Indicates whether the configuration items returned by the provider are
   * full as opposed to partials.
   *
   * A partial is a subset of a full configuration item and typically would be
   * merged into the item. Example: an array of user permissions to be merged
   * into a user role configuration item.
   *
   * @return bool
   *   TRUE if the configuration returned is full; otherwise, FALSE.
   */
  public function providesFullConfig();

  /**
   * Returns the configuration directory.
   *
   * @return string
   *   The configuration directory for this provider.
   */
  public function getDirectory();

  /**
   * Injects the active configuration storage.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   */
  public function setConfigFactory(ConfigFactoryInterface $config_factory);

  /**
   * Injects the active configuration storage.
   *
   * @param \Drupal\Core\Config\StorageInterface $storage
   *   The configuration storage to read configuration from.
   */
  public function setActiveStorages(StorageInterface $active_storage);

  /**
   * Injects the active configuration storage.
   *
   * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
   *   The configuration manager.
   */
  public function setConfigManager(ConfigManagerInterface $config_manager);

  /**
   * Sets the install profile.
   *
   * @param string $install_profile
   *   The name of the install profile.
   */
  public function setInstallProfile($install_profile);

  /**
   * Adds configuration to be installed.
   *
   * This method is invoked at extension install time. A given configuration
   * provider can add configuration to be installed or alter configuration
   * as provided by a prior extension.
   *
   * In some cases, installation of configuration may be handled separately,
   * meaning that no configuration need be added here.
   *
   * @param StorageInterface $storage
   *   The configuration storage to read configuration from.
   * @param string $collection
   *   The configuration collection to use.
   * @param string $prefix
   *   (optional) Limit to configuration starting with the provided string.
   * @param \Drupal\Core\Config\StorageInterface[] $profile_storages
   *   An array of storage interfaces containing profile configuration to check
   *   for overrides.
   *
   * @return array
   *   An array of configuration data read from the source storage keyed by the
   *   configuration object name.
   *
   * @see \Drupal\config_provider\ConfigProviderConfigInstaller::getConfigToCreate()
   * @see \Drupal\config_provider\Plugin\ConfigProviderInterface\addInstallableConfig()
   */
  public function addConfigToCreate(array &$config_to_create, StorageInterface $storage, $collection, $prefix = '', array $profile_storages = []);

  /**
   * Adds configuration that is available to be installed or updated.
   *
   * Not intended to be called an install time, this method instead facilitates
   * determining what configuration updates are available.
   *
   * Implementing plugins should write configuration as appropriate to the
   * ::providerStorage storage.
   *
   * @param \Drupal\Core\Extension\Extension[] $extensions
   *   (Optional) An associative array of Extension objects, keyed by extension
   *   name. If provided, data loaded will be limited to these extensions.
   *
   * @see \Drupal\config_provider\Plugin\ConfigProviderInterface\addConfigToCreate()
   */
  public function addInstallableConfig(array $extensions = []);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigProviderInterface::addConfigToCreate	public	function	Adds configuration to be installed.	3
ConfigProviderInterface::addInstallableConfig	public	function	Adds configuration that is available to be installed or updated.	3
ConfigProviderInterface::getDirectory	public	function	Returns the configuration directory.	1
ConfigProviderInterface::providesFullConfig	public	function	Indicates whether the configuration items returned by the provider are full as opposed to partials.	1
ConfigProviderInterface::setActiveStorages	public	function	Injects the active configuration storage.	1
ConfigProviderInterface::setConfigFactory	public	function	Injects the active configuration storage.	1
ConfigProviderInterface::setConfigManager	public	function	Injects the active configuration storage.	1
ConfigProviderInterface::setInstallProfile	public	function	Sets the install profile.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2