Zend_Filter_Compress_Rar Class Reference

Inheritance diagram for Zend_Filter_Compress_Rar:

Public Member Functions
	__construct ($options=null)
	getCallback ()
	setCallback ($callback)
	getArchive ()
	setArchive ($archive)
	getPassword ()
	setPassword ($password)
	getTarget ()
	setTarget ($target)
	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 Rar.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

array

$options

(Optional) Options to set

Definition at line 60 of file Rar.php.

    {
        if (!extension_loaded('rar')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This filter needs the rar extension');
        }
        parent::__construct($options);
    }

Member Function Documentation

compress()

compress

(

$content

)

Compresses the given content

Parameters

string | array

$content

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 176 of file Rar.php.

    {
        $callback = $this->getCallback();
        if ($callback === null) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('No compression callback available');
        }

        $options = $this->getOptions();
        unset($options['callback']);

        $result = call_user_func($callback, $options, $content);
        if ($result !== true) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Error compressing the RAR Archive');
        }

        return $this->getArchive();
    }

decompress()

decompress

(

$content

)

Decompresses the given content

Parameters

string

$content

Returns

boolean

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 202 of file Rar.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('RAR Archive not found');
        }

        $password = $this->getPassword();
        if ($password !== null) {
            $archive = rar_open($archive, $password);
        } else {
            $archive = rar_open($archive);
        }

        if (!$archive) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("Error opening the RAR Archive");
        }

        $target = $this->getTarget();
        if (!is_dir($target)) {
            $target = dirname($target);
        }

        $filelist = rar_list($archive);
        if (!$filelist) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("Error reading the RAR Archive");
        }

        foreach($filelist as $file) {
            $file->extract($target);
        }

        rar_close($archive);
        return true;
    }

getArchive()

getArchive

(

)

Returns the set archive

Returns

string

Definition at line 101 of file Rar.php.

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

getCallback()

getCallback

(

)

Returns the set callback for compression

Returns

string

Definition at line 74 of file Rar.php.

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

getPassword()

getPassword

(

)

Returns the set password

Returns

string

Definition at line 125 of file Rar.php.

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

getTarget()

getTarget

(

)

Returns the set targetpath

Returns

string

Definition at line 147 of file Rar.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_Rar

Definition at line 112 of file Rar.php.

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

        return $this;
    }

setCallback()

setCallback

(

$callback

)

Sets the callback to use

Parameters

string

$callback

Returns

Zend_Filter_Compress_Rar

Definition at line 85 of file Rar.php.

    {
        if (!is_callable($callback)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Callback can not be accessed');
        }

        $this->_options['callback'] = $callback;
        return $this;
    }

setPassword()

setPassword

(

$password

)

Sets the password to use

Parameters

string

$password

Returns

Zend_Filter_Compress_Rar

Definition at line 136 of file Rar.php.

    {
        $this->_options['password'] = (string) $password;
        return $this;
    }

setTarget()

setTarget

(

$target

)

Sets the targetpath to use

Parameters

string

$target

Returns

Zend_Filter_Compress_Rar

Definition at line 158 of file Rar.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 248 of file Rar.php.

    {
        return 'Rar';
    }

Field Documentation

$_options

$_options

protected

Initial value:

= array(
        'callback' => null,
        'archive'  => null,
        'password' => null,
        'target'   => '.',
    )

Definition at line 48 of file Rar.php.

---

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

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