You are here

interface ConfigImporterServiceInterface in Config Importer and Tools 8

Same name and namespace in other branches
  1. 8.2 src/ConfigImporterServiceInterface.php \Drupal\config_import\ConfigImporterServiceInterface
  2. 8.0 src/ConfigImporterServiceInterface.php \Drupal\config_import\ConfigImporterServiceInterface

Interface ConfigImporterServiceInterface.

Hierarchy

Expanded class hierarchy of ConfigImporterServiceInterface

All classes that implement ConfigImporterServiceInterface

File

src/ConfigImporterServiceInterface.php, line 10

Namespace

Drupal\config_import
View source
interface ConfigImporterServiceInterface extends ContainerInjectionInterface {

  /**
   * Set path to directory where configs stored.
   *
   * @param string $directory
   *   Path to directory with configs or type of config directory.
   */
  public function setDirectory($directory);

  /**
   * Get path to directory where configs stored.
   *
   * @return string
   *   Path to directory where configs stored.
   */
  public function getDirectory();

  /**
   * Import configurations.
   *
   * @param string[] $configs
   *   Configurations to import.
   *
   * @example
   * The next example will import the following configs:
   * - /directory/outside/webroot/user.role.authenticated.yml
   * - /directory/outside/webroot/user.role.anonymous.yml
   *
   * @code
   * $this->importConfigs([
   *   'user.role.authenticated',
   *   'user.role.anonymous',
   * ]);
   * @endcode
   */
  public function importConfigs(array $configs);

  /**
   * Export configurations.
   *
   * @param string[] $configs
   *   Configurations to export.
   */
  public function exportConfigs(array $configs);

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigImporterServiceInterface::exportConfigs public function Export configurations. 1
ConfigImporterServiceInterface::getDirectory public function Get path to directory where configs stored. 1
ConfigImporterServiceInterface::importConfigs public function Import configurations. 1
ConfigImporterServiceInterface::setDirectory public function Set path to directory where configs stored. 1
ContainerInjectionInterface::create public static function Instantiates a new instance of this class. 70