Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Config/ConfigFactoryInterface.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\ConfigFactoryInterface.
6	*/
7
8	namespace Drupal\Core\Config;
9
10	/**
11	* Defines the interface for a configuration object factory.
12	*
13	* @ingroup config_api
14	*/
15	interface ConfigFactoryInterface {
16
17	/**
18	* Returns an immutable configuration object for a given name.
19	*
20	* @param string $name
21	* The name of the configuration object to construct.
22	*
23	* @return \Drupal\Core\Config\ImmutableConfig
24	* A configuration object.
25	*/
26	public function get($name);
27
28	/**
29	* Returns an mutable configuration object for a given name.
30	*
31	* Should not be used for config that will have runtime effects. Therefore it
32	* is always loaded override free.
33	*
34	* @param string $name
35	* The name of the configuration object to construct.
36	*
37	* @return \Drupal\Core\Config\Config
38	* A configuration object.
39	*/
40	public function getEditable($name);
41
42	/**
43	* Returns a list of configuration objects for the given names.
44	*
45	* This will pre-load all requested configuration objects does not create
46	* new configuration objects. This method always return immutable objects.
47	* ConfigFactoryInterface::getEditable() should be used to retrieve mutable
48	* configuration objects, one by one.
49	*
50	* @param array $names
51	* List of names of configuration objects.
52	*
53	* @return \Drupal\Core\Config\ImmutableConfig[]
54	* List of successfully loaded configuration objects, keyed by name.
55	*/
56	public function loadMultiple(array $names);
57
58	/**
59	* Resets and re-initializes configuration objects. Internal use only.
60	*
61	* @param string\|null $name
62	* (optional) The name of the configuration object to reset. If omitted, all
63	* configuration objects are reset.
64	*
65	* @return $this
66	*/
67	public function reset($name = NULL);
68
69	/**
70	* Renames a configuration object using the storage.
71	*
72	* @param string $old_name
73	* The old name of the configuration object.
74	* @param string $new_name
75	* The new name of the configuration object.
76	*
77	* @return $this
78	*/
79	public function rename($old_name, $new_name);
80
81	/**
82	* The cache keys associated with the state of the config factory.
83	*
84	* All state information that can influence the result of a get() should be
85	* included. Typically, this includes a key for each override added via
86	* addOverride(). This allows external code to maintain caches of
87	* configuration data in addition to or instead of caches maintained by the
88	* factory.
89	*
90	* @return array
91	* An array of strings, used to generate a cache ID.
92	*/
93	public function getCacheKeys();
94
95	/**
96	* Clears the config factory static cache.
97	*
98	* @return $this
99	*/
100	public function clearStaticCache();
101
102	/**
103	* Gets configuration object names starting with a given prefix.
104	*
105	* @see \Drupal\Core\Config\StorageInterface::listAll()
106	*
107	* @param string $prefix
108	* (optional) The prefix to search for. If omitted, all configuration object
109	* names that exist are returned.
110	*
111	* @return array
112	* An array containing matching configuration object names.
113	*/
114	public function listAll($prefix = '');
115
116	/**
117	* Adds config factory override services.
118	*
119	* @param \Drupal\Core\Config\ConfigFactoryOverrideInterface $config_factory_override
120	* The config factory override service to add. It is added at the end of the
121	* priority list (lower priority relative to existing ones).
122	*/
123	public function addOverride(ConfigFactoryOverrideInterface $config_factory_override);
124
125	}