Newer
Older
<?php
/**
* @file
* Definition of Drupal\Component\Archiver\Zip.
*/
namespace Drupal\Component\Archiver;
use ZipArchive;
/**
* Defines a archiver implementation for .zip files.
*
* @link http://php.net/zip
*/
class Zip implements ArchiverInterface {
/**
* The underlying ZipArchive instance that does the heavy lifting.
*
* @var ZipArchive
*/
protected $zip;
/**
Dries Buytaert
committed
* Constructs a Zip object.
*
* @param string $file_path
Dries Buytaert
committed
* The full system path of the archive to manipulate. Only local files
* are supported. If the file does not yet exist, it will be created if
* appropriate.
*
* @throws Drupal\Component\Archiver\ArchiverException
*/
public function __construct($file_path) {
$this->zip = new ZipArchive();
if ($this->zip->open($file_path) !== TRUE) {
Dries Buytaert
committed
throw new ArchiverException(t('Cannot open %file_path', array('%file_path' => $file_path)));
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
}
}
/**
* Implements Drupal\Component\Archiver\ArchiveInterface::add().
*/
public function add($file_path) {
$this->zip->addFile($file_path);
return $this;
}
/**
* Implements Drupal\Component\Archiver\ArchiveInterface::remove().
*/
public function remove($file_path) {
$this->zip->deleteName($file_path);
return $this;
}
/**
* Implements Drupal\Component\Archiver\ArchiveInterface::extract().
*/
public function extract($path, Array $files = array()) {
if ($files) {
$this->zip->extractTo($path, $files);
}
else {
$this->zip->extractTo($path);
}
return $this;
}
/**
* Implements Drupal\Component\Archiver\ArchiveInterface::listContents().
*/
public function listContents() {
$files = array();
for ($i=0; $i < $this->zip->numFiles; $i++) {
$files[] = $this->zip->getNameIndex($i);
}
return $files;
}
/**
* Retrieves the zip engine itself.
*
* In some cases it may be necessary to directly access the underlying
* ZipArchive object for implementation-specific logic. This is for advanced
* use only as it is not shared by other implementations of ArchiveInterface.
*
* @return ZipArchive
* The ZipArchive object used by this object.
*/
public function getArchive() {
return $this->zip;
}
}