Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Archiver/ArchiverInterface.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\Archiver\ArchiverInterface.
6	*/
7
8	namespace Drupal\Core\Archiver;
9
10	/**
11	* Defines the common interface for all Archiver classes.
12	*
13	* @see \Drupal\Core\Archiver\ArchiverManager
14	* @see \Drupal\Core\Archiver\Annotation\Archiver
15	* @see plugin_api
16	*/
17	interface ArchiverInterface {
18
19	/**
20	* Adds the specified file or directory to the archive.
21	*
22	* @param string $file_path
23	* The full system path of the file or directory to add. Only local files
24	* and directories are supported.
25	*
26	* @return \Drupal\Core\Archiver\ArchiverInterface
27	* The called object.
28	*/
29	public function add($file_path);
30
31	/**
32	* Removes the specified file from the archive.
33	*
34	* @param string $path
35	* The file name relative to the root of the archive to remove.
36	*
37	* @return \Drupal\Core\Archiver\ArchiverInterface
38	* The called object.
39	*/
40	public function remove($path);
41
42	/**
43	* Extracts multiple files in the archive to the specified path.
44	*
45	* @param string $path
46	* A full system path of the directory to which to extract files.
47	* @param array $files
48	* Optionally specify a list of files to be extracted. Files are
49	* relative to the root of the archive. If not specified, all files
50	* in the archive will be extracted.
51	*
52	* @return \Drupal\Core\Archiver\ArchiverInterface
53	* The called object.
54	*/
55	public function extract($path, array $files = array());
56
57	/**
58	* Lists all files in the archive.
59	*
60	* @return array
61	* An array of file names relative to the root of the archive.
62	*/
63	public function listContents();
64	}