Archive Class Reference

Public Member Functions
	pack ($source, $destination='packed.tgz', $skipRoot=false)
	unpack ($source, $destination='.', $tillTar=false, $clearInterm=true)
	extract ($file, $source, $destination='.')
	isArchive ($file)
	isTar ($file)

Data Fields
const	DEFAULT_ARCHIVER = 'gz'
const	TAPE_ARCHIVER = 'tar'

Protected Member Functions
	_getArchiver ($extension)
	_getArchivers ($source)

Protected Attributes
	$_archiver = null
	$_formats

Detailed Description

Class to work with archives

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 17 of file Archive.php.

Member Function Documentation

_getArchiver()

_getArchiver (   $extension )

protected

Create object of current archiver by $extension.

Parameters

string

$extension

Returns

Tar|Gz|Bz

Definition at line 63 of file Archive.php.

    {
        $extension = strtolower($extension);
        $format = isset($this->_formats[$extension]) ? $this->_formats[$extension] : self::DEFAULT_ARCHIVER;
        $class = '\\Magento\Framework\Archive\\' . ucfirst($format);
        $this->_archiver = new $class();
        return $this->_archiver;
    }

_getArchivers()

_getArchivers (   $source )

protected

Split current format to list of archivers.

Parameters

string

$source

Returns

string[]|string

Definition at line 78 of file Archive.php.

    {
        $ext = pathinfo($source, PATHINFO_EXTENSION);
        if (!empty($this->_formats[$ext])) {
            return explode('.', $this->_formats[$ext]);
        }
        return [];
    }

extract()

extract	(		$file,
			$source,
			$destination = '.'
	)

Extract one file from TAR (Tape Archiver).

Parameters

string	$file
string	$source
string	$destination

Returns

string Path to file

Definition at line 161 of file Archive.php.

    {
        $tarFile = $this->unpack($source, $destination, true);
        $resFile = $this->_getArchiver(self::TAPE_ARCHIVER)->extract($file, $tarFile, $destination);
        if (!$this->isTar($source)) {
            unlink($tarFile);
        }
        return $resFile;
    }

isArchive()

isArchive

(

$file

)

Check file is archive.

Parameters

string

$file

Returns

boolean

Definition at line 177 of file Archive.php.

    {
        $archivers = $this->_getArchivers($file);
        if (count($archivers)) {
            return true;
        }
        return false;
    }

isTar()

isTar

(

$file

)

Check file is TAR.

Parameters

string

$file

Returns

boolean

Definition at line 192 of file Archive.php.

    {
        $archivers = $this->_getArchivers($file);
        if (count($archivers) == 1 && $archivers[0] == self::TAPE_ARCHIVER) {
            return true;
        }
        return false;
    }

pack()

pack	(		$source,
			$destination = 'packed.tgz',
			$skipRoot = false
	)

Pack file or directory to archivers are parsed from extension.

Parameters

string	$source
string	$destination
boolean	$skipRoot	skip first level parent

Returns

string Path to file

Definition at line 95 of file Archive.php.

    {
        $archivers = $this->_getArchivers($destination);
        $interimSource = '';
        for ($i = 0; $i < count($archivers); $i++) {
            if ($i == count($archivers) - 1) {
                $packed = $destination;
            } else {
                $packed = dirname($destination) . '/~tmp-' . microtime(true) . $archivers[$i] . '.' . $archivers[$i];
            }
            $source = $this->_getArchiver($archivers[$i])->pack($source, $packed, $skipRoot);
            if ($interimSource && $i < count($archivers)) {
                unlink($interimSource);
            }
            $interimSource = $source;
        }
        return $source;
    }

unpack()

unpack	(		$source,
			$destination = '.',
			$tillTar = false,
			$clearInterm = true
	)

Unpack file from archivers are parsed from extension. If $tillTar == true unpack file from archivers till meet TAR archiver.

Parameters

string	$source
string	$destination
bool	$tillTar
bool	$clearInterm

Returns

string Path to file

Definition at line 125 of file Archive.php.

    {
        $archivers = $this->_getArchivers($source);
        $interimSource = '';
        for ($i = count($archivers) - 1; $i >= 0; $i--) {
            if ($tillTar && $archivers[$i] == self::TAPE_ARCHIVER) {
                break;
            }
            if ($i == 0) {
                $packed = rtrim($destination, '/') . '/';
            } else {
                $packed = rtrim(
                    $destination,
                    '/'
                ) . '/~tmp-' . microtime(
                    true
                ) . $archivers[$i - 1] . '.' . $archivers[$i - 1];
            }
            $source = $this->_getArchiver($archivers[$i])->unpack($source, $packed);

            if ($clearInterm && $interimSource && $i >= 0) {
                unlink($interimSource);
            }
            $interimSource = $source;
        }
        return $source;
    }

Field Documentation

$_archiver

$_archiver = null

protected

Definition at line 34 of file Archive.php.

$_formats

$_formats

protected

Initial value:

= [
        'tar' => 'tar',
        'gz' => 'gz',
        'gzip' => 'gz',
        'tgz' => 'tar.gz',
        'tgzip' => 'tar.gz',
        'bz' => 'bz',
        'bzip' => 'bz',
        'bzip2' => 'bz',
        'bz2' => 'bz',
        'tbz' => 'tar.bz',
        'tbzip' => 'tar.bz',
        'tbz2' => 'tar.bz',
        'tbzip2' => 'tar.bz',
    ]

Definition at line 41 of file Archive.php.

DEFAULT_ARCHIVER

const DEFAULT_ARCHIVER = 'gz'

Archiver is used for compress.

Definition at line 22 of file Archive.php.

TAPE_ARCHIVER

const TAPE_ARCHIVER = 'tar'

Default packer for directory.

Definition at line 27 of file Archive.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Archive.php