<?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;
    }

}