Mage_Backup_Model_Backup Class Reference

Inheritance diagram for Mage_Backup_Model_Backup:

List of all members.

Public Member Functions
	load ($fileName, $filePath)
	exists ()
	getFileName ()
	setType ($value='db')
	getType ()
	setFile (&$content)
&	getFile ()
	deleteFile ()
	open ($write=false)
	read ($length)
	eof ()
	write ($string)
	close ()
	output ()
	getSize ()
Public Attributes
const	BACKUP_DB = 'db'
const	BACKUP_VIEW = 'view'
const	BACKUP_MEDIA = 'media'
const	BACKUP_EXTENSION = 'gz'
const	COMPRESS_RATE = 9
Protected Attributes
	$_handler = null

---

Detailed Description

Definition at line 34 of file Backup.php.

---

Member Function Documentation

close

(

)

Close open backup file

Returns:

Mage_Backup_Model_Backup

Definition at line 313 of file Backup.php.

    {
        @gzclose($this->_handler);
        $this->_handler = null;

        return $this;
    }

deleteFile

(

)

Delete backup file

Exceptions:

Mage_Backup_Exception

Definition at line 209 of file Backup.php.

    {
        if (!$this->exists()) {
            Mage::throwException(Mage::helper('backup')->__("Backup file doesn't exist"));
        }

        $ioProxy = new Varien_Io_File();
        $ioProxy->open(array('path'=>$this->getPath()));
        $ioProxy->rm($this->getFileName());
        return $this;
    }

eof

(

)

Definition at line 277 of file Backup.php.

    {
        if (is_null($this->_handler)) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file handler don\'t specify'));
        }

        return gzeof($this->_handler);
    }

exists

(

)

Checks backup file exists.

Returns:

boolean

Definition at line 84 of file Backup.php.

    {
        return is_file($this->getPath() . DS . $this->getFileName());
    }

& getFile

(

)

Return content of backup file

Todo:

rewrite to Varien_IO, but there no possibility read part of files.

Returns:

string

Exceptions:

Mage_Backup_Exception

Definition at line 168 of file Backup.php.

    {

        if (!$this->exists()) {
            Mage::throwException(Mage::helper('backup')->__("Backup file doesn't exist"));
        }

        $fResource = @fopen($this->getPath() . DS . $this->getFileName(), "rb");
        if (!$fResource) {
            Mage::throwException(Mage::helper('backup')->__("Cannot read backup file"));
        }

        $content = '';
        $compressed = 0;

        $info = unpack("lcompress/llength", fread($fResource, 8));
        if ($info['compress']) { // If file compressed by zlib
            $compressed = 1;
        }

        if ($compressed && !extension_loaded("zlib")) {
            fclose($fResource);
            Mage::throwException(Mage::helper('backup')->__('File compressed with Zlib, but this extension is not installed on server'));
        }

        if ($compressed) {
            $content = gzuncompress(fread($fResource, $info['length']));
        } else {
            $content = fread($fResource, $info['length']);
        }

        fclose($fResource);

        return $content;
    }

getFileName

(

)

Return file name of backup file

Returns:

string

Definition at line 94 of file Backup.php.

    {
        return $this->getTime() . "_" . $this->getType()
               . "." . self::BACKUP_EXTENSION;
    }

getSize

(

)

Definition at line 341 of file Backup.php.

    {
        if (!is_null($this->getData('size'))) {
            return $this->getData('size');
        }

        if ($this->exists()) {
            $this->setData('size', filesize($this->getPath() . DS . $this->getFileName()));
            return $this->getData('size');
        }

        return 0;
    }

getType

(

)

Returns type of backup file

Returns:

string db|media|view

Definition at line 122 of file Backup.php.

    {
        return $this->_type;
    }

load	(	$	fileName,
		$	filePath
	)

Load backup file info

Parameters:

	string	fileName
	string	filePath

Returns:

Mage_Backup_Model_Backup

Definition at line 66 of file Backup.php.

    {
        list ($time, $type) = explode("_", substr($fileName, 0, strrpos($fileName, ".")));
        $this->addData(array(
            'id'   => $filePath . DS . $fileName,
            'time' => (int)$time,
            'path' => $filePath,
            'time_formated' => date('Y-m-d H:i:s', (int)$time))
        );
        $this->setType($type);
        return $this;
    }

open

(

$

write = false

)

Open backup file (write or read mode)

Parameters:

bool

$write

Returns:

Mage_Backup_Model_Backup

Definition at line 227 of file Backup.php.

    {
        if (is_null($this->getPath())) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file path don\'t specify'));
        }

        $ioAdapter = new Varien_Io_File();
        try {
            $path = $ioAdapter->getCleanPath($this->getPath());
            $ioAdapter->checkAndCreateFolder($path);
            $filePath = $path . DS . $this->getFileName();
        }
        catch (Exception $e) {
            Mage::exception('Mage_Backup', $e->getMessage());
        }

        if ($write && $ioAdapter->fileExists($filePath)) {
            $ioAdapter->rm($filePath);
        }
        if (!$write && !$ioAdapter->fileExists($filePath)) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file "%s" doesn\'t exist', $this->getFileName()));
        }

        $mode = $write ? 'wb' . self::COMPRESS_RATE : 'rb';

        try {
            $this->_handler = gzopen($filePath, $mode);
        }
        catch (Exception $e) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file "%s" can\'t read or write', $this->getFileName()));
        }

        return $this;
    }

output

(

)

Print output

Definition at line 325 of file Backup.php.

    {
        if (!$this->exists()) {
            return ;
        }

        $ioAdapter = new Varien_Io_File();
        $ioAdapter->open(array('path' => $this->getPath()));

        $ioAdapter->streamOpen($this->getFileName(), 'r');
        while ($buffer = $ioAdapter->streamRead()) {
            echo $buffer;
        }
        $ioAdapter->streamClose();
    }

read

(

$

length

)

Read backup uncomressed data

Parameters:

int

$length

Returns:

string

Definition at line 268 of file Backup.php.

    {
        if (is_null($this->_handler)) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file handler don\'t specify'));
        }

        return gzread($this->_handler, $length);
    }

setFile

(

&$

content

)

Set the backup file content

Parameters:

string

$content

Returns:

Mage_Backup_Model_Backup

Exceptions:

Mage_Backup_Exception

Definition at line 134 of file Backup.php.

    {
        if (!$this->hasData('time') || !$this->hasData('type') || !$this->hasData('path')) {
            Mage::throwException(Mage::helper('backup')->__('Wrong order of creation for new backup'));
        }

        $ioProxy = new Varien_Io_File();
        $ioProxy->setAllowCreateFolders(true);
        $ioProxy->open(array('path'=>$this->getPath()));

        $compress = 0;
        if (extension_loaded("zlib")) {
            $compress = 1;
        }

        $rawContent = '';
        if ( $compress ) {
            $rawContent = gzcompress( $content, self::COMPRESS_RATE );
        } else {
            $rawContent = $content;
        }

        $fileHeaders = pack("ll", $compress, strlen($rawContent));
        $ioProxy->write($this->getFileName(), $fileHeaders . $rawContent);
        return $this;
    }

setType

(

$

value = 'db'

)

Sets type of file

Parameters:

string

$value db|media|view

Definition at line 105 of file Backup.php.

    {
        if(!in_array($value, array('db','media','view'))) {
            $value = 'db';
        }

        $this->_type = $value;
        $this->setData('type', $this->_type);

        return $this;
    }

write

(

$

string

)

Write to backup file

Parameters:

string

$string

Returns:

Mage_Backup_Model_Backup

Definition at line 292 of file Backup.php.

    {
        if (is_null($this->_handler)) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Backup file handler don\'t specify'));
        }

        try {
            gzwrite($this->_handler, $string);
        }
        catch (Exception $e) {
            Mage::exception('Mage_Backup', Mage::helper('backup')->__('Error write to Backup file "%s"', $this->getFileName()));
        }

        return $this;
    }

---

Member Data Documentation

$_handler = null [protected]

Definition at line 57 of file Backup.php.

const BACKUP_DB = 'db'

Definition at line 37 of file Backup.php.

const BACKUP_EXTENSION = 'gz'

Definition at line 42 of file Backup.php.

const BACKUP_MEDIA = 'media'

Definition at line 39 of file Backup.php.

const BACKUP_VIEW = 'view'

Definition at line 38 of file Backup.php.

const COMPRESS_RATE = 9

Definition at line 43 of file Backup.php.

---

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

• app/code/core/Mage/Backup/Model/Backup.php