Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Config/ConfigInstallerInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Config\ConfigInstallerInterface.
6	*/
7
8	namespace Drupal\Core\Config;
9
10	/**
11	* Interface for classes that install config.
12	*/
13	interface ConfigInstallerInterface {
14
15	/**
16	* Installs the default configuration of a given extension.
17	*
18	* When an extension is installed, it searches all the default configuration
19	* directories for all other extensions to locate any configuration with its
20	* name prefix. For example, the Node module provides the frontpage view as a
21	* default configuration file:
22	* core/modules/node/config/install/views.view.frontpage.yml
23	* When the Views module is installed after the Node module is already
24	* enabled, the frontpage view will be installed.
25	*
26	* Additionally, the default configuration directory for the extension being
27	* installed is searched to discover if it contains default configuration
28	* that is owned by other enabled extensions. So, the frontpage view will also
29	* be installed when the Node module is installed after Views.
30	*
31	* @param string $type
32	* The extension type; e.g., 'module' or 'theme'.
33	* @param string $name
34	* The name of the module or theme to install default configuration for.
35	*
36	* @see \Drupal\Core\Config\ExtensionInstallStorage
37	*/
38	public function installDefaultConfig($type, $name);
39
40	/**
41	* Installs optional configuration.
42	*
43	* Optional configuration is only installed if:
44	* - the configuration does not exist already.
45	* - it's a configuration entity.
46	* - its dependencies can be met.
47	*
48	* @param \Drupal\Core\Config\StorageInterface
49	* (optional) The configuration storage to search for optional
50	* configuration. If not provided, all enabled extension's optional
51	* configuration directories will be searched.
52	* @param array $dependency
53	* (optional) If set, ensures that the configuration being installed has
54	* this dependency. The format is dependency type as the key ('module',
55	* 'theme', or 'config') and the dependency name as the value
56	* ('book', 'bartik', 'views.view.frontpage').
57	*/
58	public function installOptionalConfig(StorageInterface $storage = NULL, $dependency = []);
59
60	/**
61	* Installs all default configuration in the specified collection.
62	*
63	* The function is useful if the site needs to respond to an event that has
64	* just created another collection and we need to check all the installed
65	* extensions for any matching configuration. For example, if a language has
66	* just been created.
67	*
68	* @param string $collection
69	* The configuration collection.
70	*/
71	public function installCollectionDefaultConfig($collection);
72
73	/**
74	* Sets the configuration storage that provides the default configuration.
75	*
76	* @param \Drupal\Core\Config\StorageInterface $storage
77	*
78	* @return $this
79	*/
80	public function setSourceStorage(StorageInterface $storage);
81
82	/**
83	* Sets the status of the isSyncing flag.
84	*
85	* @param bool $status
86	* The status of the sync flag.
87	*
88	* @return $this
89	*/
90	public function setSyncing($status);
91
92	/**
93	* Gets the syncing state.
94	*
95	* @return bool
96	* Returns TRUE is syncing flag set.
97	*/
98	public function isSyncing();
99
100	/**
101	* Checks the configuration that will be installed for an extension.
102	*
103	* @param string $type
104	* Type of extension to install.
105	* @param string $name
106	* Name of extension to install.
107	*
108	* @throws \Drupal\Core\Config\UnmetDependenciesException
109	* @throws \Drupal\Core\Config\PreExistingConfigException
110	*/
111	public function checkConfigurationToInstall($type, $name);
112
113	}