ArchiveReader.php
2.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
<?php
/**
* Created by PhpStorm.
* User: Tsurkanov
* Date: 03.11.2015
* Time: 14:48
*/
namespace common\components\archives;
/**
* Class ArchiveReader
* @package common\components\archives
* абстрактный класс для предоставления универсального интерфейса по работе с архиваторами (в режиме распаковки архивов)
*/
abstract class ArchiveReader
{
/**
* @var - экземляр конкретного архиватора
*/
protected $resource;
/**
* @var array - массив извлеченных файлов
* после распаковки будет содержать все распакованные файлы, ключ - путь к файлу, значение - расширение
*/
protected $extracted_files = [];
/**
* @var - префикс который будет прибавлен к оригинальному имени сохраняемого файла
*/
protected $file_name_prefix = '';
/**
* @param $file - имя открываемого архива
* @param string $password - пароль (необяз) открываемого архива
* @return mixed - true если успешно и throw при неудаче
*/
public abstract function open( $file, $password = '');
/**
* @param $destination - путь куда положить распакованные файлы
* если указан аттрибут $file_name_prefix то происходит переименование файла
* в результате выполнения метода заполняется аттрибут $extracted_files извлеченными файлами
* если извлечение не произошло аттрибут $extracted_files - пустой
*/
public abstract function extractTo($destination);
/**
* @return string- возвращает MIME-тип, расширение которое поддерживает архиватор
*/
public static abstract function getExtension();
public function getExtractedFiles(){
return $this->extracted_files;
}
public function setExtractedFiles($name, $ext){
$this->extracted_files[$name] = $ext;
}
/**
* @param mixed $file_name_prefix
*/
public function setFileNamePrefix($file_name_prefix)
{
$this->file_name_prefix = $file_name_prefix;
}
}