Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Config/StorageComparerInterface.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\StorageComparerInterface.
6	*/
7
8	namespace Drupal\Core\Config;
9
10	/**
11	* Defines an interface for comparison of configuration storage objects.
12	*/
13	interface StorageComparerInterface {
14
15	/**
16	* Gets the configuration source storage.
17	*
18	* @param string $collection
19	* (optional) The storage collection to use. Defaults to the
20	* default collection.
21	*
22	* @return \Drupal\Core\Config\StorageInterface
23	* Storage object used to read configuration.
24	*/
25	public function getSourceStorage($collection = StorageInterface::DEFAULT_COLLECTION);
26
27	/**
28	* Gets the configuration target storage.
29	*
30	* @param string $collection
31	* (optional) The storage collection to use. Defaults to the
32	* default collection.
33	*
34	* @return \Drupal\Core\Config\StorageInterface
35	* Storage object used to write configuration.
36	*/
37	public function getTargetStorage($collection = StorageInterface::DEFAULT_COLLECTION);
38
39	/**
40	* Gets an empty changelist.
41	*
42	* @return array
43	* An empty changelist array.
44	*/
45	public function getEmptyChangelist();
46
47	/**
48	* Gets the list of differences to import.
49	*
50	* @param string $op
51	* (optional) A change operation. Either delete, create or update. If
52	* supplied the returned list will be limited to this operation.
53	* @param string $collection
54	* (optional) The collection to get the changelist for. Defaults to the
55	* default collection.
56	*
57	* @return array
58	* An array of config changes that are yet to be imported.
59	*/
60	public function getChangelist($op = NULL, $collection = StorageInterface::DEFAULT_COLLECTION);
61
62	/**
63	* Recalculates the differences.
64	*
65	* @return \Drupal\Core\Config\StorageComparerInterface
66	* An object which implements the StorageComparerInterface.
67	*/
68	public function reset();
69
70	/**
71	* Checks if there are any operations with changes to process.
72	*
73	* Until the changelist has been calculated this will always be FALSE.
74	*
75	* @see \Drupal\Core\Config\StorageComparerInterface::createChangelist().
76	*
77	* @return bool
78	* TRUE if there are changes to process and FALSE if not.
79	*/
80	public function hasChanges();
81
82	/**
83	* Validates that the system.site::uuid in the source and target match.
84	*
85	* @return bool
86	* TRUE if identical, FALSE if not.
87	*/
88	public function validateSiteUuid();
89
90	/**
91	* Moves a rename operation to an update.
92	*
93	* @param string $rename
94	* The rename name, as provided by ConfigImporter::createRenameName().
95	* @param string $collection
96	* (optional) The collection where the configuration is stored. Defaults to
97	* the default collection.
98	*
99	* @see \Drupal\Core\Config\ConfigImporter::createRenameName()
100	*/
101	public function moveRenameToUpdate($rename, $collection = StorageInterface::DEFAULT_COLLECTION);
102
103	/**
104	* Extracts old and new configuration names from a configuration change name.
105	*
106	* @param string $name
107	* The configuration change name, as provided by
108	* ConfigImporter::createRenameName().
109	*
110	* @return array
111	* An associative array of configuration names. The array keys are
112	* 'old_name' and 'new_name' representing the old and new configuration
113	* object names during a rename operation.
114	*
115	* @see \Drupal\Core\Config\StorageComparer::createRenameNames()
116	*/
117	public function extractRenameNames($name);
118
119	/**
120	* Gets the existing collections from both the target and source storage.
121	*
122	* @param bool $include_default
123	* (optional) Include the default collection. Defaults to TRUE.
124	*
125	* @return array
126	* An array of existing collection names.
127	*/
128	public function getAllCollectionNames($include_default = TRUE);
129
130	}