Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Updater/UpdaterInterface.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\Updater\UpdaterInterface.
6	*/
7
8	namespace Drupal\Core\Updater;
9
10	/**
11	* Defines an interface for a class which can update a Drupal project.
12	*
13	* An Updater currently serves the following purposes:
14	* - It can take a given directory, and determine if it can operate on it.
15	* - It can move the contents of that directory into the appropriate place
16	* on the system using FileTransfer classes.
17	* - It can return a list of "next steps" after an update or install.
18	* - In the future, it will most likely perform some of those steps as well.
19	*/
20	interface UpdaterInterface {
21
22	/**
23	* Checks if the project is installed.
24	*
25	* @return bool
26	*/
27	public function isInstalled();
28
29	/**
30	* Returns the system name of the project.
31	*
32	* @param string $directory
33	* A directory containing a project.
34	*/
35	public static function getProjectName($directory);
36
37	/**
38	* Returns the path to the default install location for the current project.
39	*
40	* @return string
41	* An absolute path to the default install location.
42	*/
43	public function getInstallDirectory();
44
45	/**
46	* Returns the name of the root directory under which projects will be copied.
47	*
48	* @return string
49	* A relative path to the root directory.
50	*/
51	public static function getRootDirectoryRelativePath();
52
53	/**
54	* Determines if the Updater can handle the project provided in $directory.
55	*
56	* @param string $directory
57	*
58	* @return bool
59	* TRUE if the project is installed, FALSE if not.
60	*/
61	public static function canUpdateDirectory($directory);
62
63	/**
64	* Actions to run after an install has occurred.
65	*/
66	public function postInstall();
67
68	/**
69	* Actions to run after an update has occurred.
70	*/
71	public function postUpdate();
72	}