Zend_Filter_Compress_Tar Class Reference

Inheritance diagram for Zend_Filter_Compress_Tar:

Public Member Functions
	__construct ($options=null)
	getArchive ()
	setArchive ($archive)
	getTarget ()
	setTarget ($target)
	getMode ()
	setMode ($mode)
	compress ($content)
	decompress ($content)
	toString ()
Public Member Functions inherited from Zend_Filter_Compress_CompressAbstract
	__construct ($options=null)
	getOptions ($option=null)
	setOptions (array $options)

Protected Attributes
	$_options

Detailed Description

Definition at line 35 of file Tar.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

array

$options

(Optional) Options to set

Definition at line 57 of file Tar.php.

    {
        if (!class_exists('Archive_Tar')) {
            #require_once 'Zend/Loader.php';
            try {
                Zend_Loader::loadClass('Archive_Tar');
            } catch (Zend_Exception $e) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception('This filter needs PEARs Archive_Tar', 0, $e);
            }
        }

        parent::__construct($options);
    }

Member Function Documentation

compress()

compress

(

$content

)

Compresses the given content

Parameters

string

$content

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 163 of file Tar.php.

    {
        $archive = new Archive_Tar($this->getArchive(), $this->getMode());
        if (!file_exists($content)) {
            $file = $this->getTarget();
            if (is_dir($file)) {
                $file .= DIRECTORY_SEPARATOR . "tar.tmp";
            }

            $result = file_put_contents($file, $content);
            if ($result === false) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception('Error creating the temporary file');
            }

            $content = $file;
        }

        if (is_dir($content)) {
            // collect all file infos
            foreach (new RecursiveIteratorIterator(
                        new RecursiveDirectoryIterator($content, RecursiveDirectoryIterator::KEY_AS_PATHNAME),
                        RecursiveIteratorIterator::SELF_FIRST
                    ) as $directory => $info
            ) {
                if ($info->isFile()) {
                    $file[] = $directory;
                }
            }

            $content = $file;
        }

        $result  = $archive->create($content);
        if ($result === false) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Error creating the Tar archive');
        }

        return $this->getArchive();
    }

decompress()

decompress

(

$content

)

Decompresses the given content

Parameters

string

$content

Returns

boolean

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 211 of file Tar.php.

    {
        $archive = $this->getArchive();
        if (file_exists($content)) {
            $archive = str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, realpath($content));
        } elseif (empty($archive) || !file_exists($archive)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Tar Archive not found');
        }

        $archive = new Archive_Tar($archive, $this->getMode());
        $target  = $this->getTarget();
        if (!is_dir($target)) {
            $target = dirname($target);
        }

        $result = $archive->extract($target);
        if ($result === false) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Error while extracting the Tar archive');
        }

        return true;
    }

getArchive()

getArchive

(

)

Returns the set archive

Returns

string

Definition at line 77 of file Tar.php.

    {
        return $this->_options['archive'];
    }

getMode()

getMode

(

)

Returns the set compression mode

Definition at line 127 of file Tar.php.

    {
        return $this->_options['mode'];
    }

getTarget()

getTarget

(

)

Returns the set targetpath

Returns

string

Definition at line 101 of file Tar.php.

    {
        return $this->_options['target'];
    }

setArchive()

setArchive

(

$archive

)

Sets the archive to use for de-/compression

Parameters

string

$archive

Archive to use

Returns

Zend_Filter_Compress_Tar

Definition at line 88 of file Tar.php.

    {
        $archive = str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $archive);
        $this->_options['archive'] = (string) $archive;

        return $this;
    }

setMode()

setMode

(

$mode

)

Compression mode to use Eighter Gz or Bz2

Parameters

string

$mode

Definition at line 138 of file Tar.php.

    {
        $mode = ucfirst(strtolower($mode));
        if (($mode != 'Bz2') && ($mode != 'Gz')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("The mode '$mode' is unknown");
        }

        if (($mode == 'Bz2') && (!extension_loaded('bz2'))) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This mode needs the bz2 extension');
        }

        if (($mode == 'Gz') && (!extension_loaded('zlib'))) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This mode needs the zlib extension');
        }
    }

setTarget()

setTarget

(

$target

)

Sets the targetpath to use

Parameters

string

$target

Returns

Zend_Filter_Compress_Tar

Definition at line 112 of file Tar.php.

    {
        if (!file_exists(dirname($target))) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("The directory '$target' does not exist");
        }

        $target = str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $target);
        $this->_options['target'] = (string) $target;
        return $this;
    }

toString()

toString

(

)

Returns the adapter name

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 241 of file Tar.php.

    {
        return 'Tar';
    }

Field Documentation

$_options

$_options

protected

Initial value:

= array(
        'archive'  => null,
        'target'   => '.',
        'mode'     => null,
    )

Definition at line 46 of file Tar.php.

---

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

• vendor/magento/zendframework1/library/Zend/Filter/Compress/Tar.php