Docs For Class Mage_Backup_Model

Description

Backup file item model

author: Magento Core Team <[email protected]>

Located in /Backup/Model/Backup.php (line 34)

Varien_Object
   |
   --Mage_Backup_Model_Backup

Class Constant Summary

BACKUP_DB = 'db'

BACKUP_EXTENSION = 'gz'

BACKUP_MEDIA = 'media'

BACKUP_VIEW = 'view'

COMPRESS_RATE = 9

Variable Summary

resource $_handler

Method Summary

Mage_Backup_Model_Backup close ()

void deleteFile ()

void eof ()

boolean exists ()

string &getFile ()

string getFileName ()

void getSize ()

string getType ()

Mage_Backup_Model_Backup load (string $fileName, string $filePath)

Mage_Backup_Model_Backup open ([bool $write = false])

void output ()

string read (int $length)

Mage_Backup_Model_Backup setFile ( &$content, string $content)

void setType ([string $value = 'db'])

Mage_Backup_Model_Backup write (string $string)

Variables

resource $_handler = null (line 57)

Gz file pointer

access: protected

Methods

close (line 313)

Close open backup file

access: public

Mage_Backup_Model_Backup close ()

deleteFile (line 209)

Delete backup file

throws: Mage_Backup_Exception
access: public

void deleteFile ()

eof (line 277)

access: public

void eof ()

exists (line 84)

Checks backup file exists.

access: public

boolean exists ()

getFile (line 168)

Return content of backup file

todo: rewrite to Varien_IO, but there no possibility read part of files.
throws: Mage_Backup_Exception
access: public

string &getFile ()

getFileName (line 94)

Return file name of backup file

access: public

string getFileName ()

getSize (line 341)

access: public

void getSize ()

getType (line 122)

Returns type of backup file

return: db|media|view
access: public

string getType ()

load (line 66)

Load backup file info

access: public

Mage_Backup_Model_Backup load (string $fileName, string $filePath)

string $fileName: fileName
string $filePath: filePath

open (line 227)

Open backup file (write or read mode)

access: public

Mage_Backup_Model_Backup open ([bool $write = false])

bool $write

output (line 325)

Print output

access: public

void output ()

read (line 268)

Read backup uncomressed data

access: public

string read (int $length)

int $length

setFile (line 134)

Set the backup file content

throws: Mage_Backup_Exception
access: public

Mage_Backup_Model_Backup setFile ( &$content, string $content)

string $content
&$content

setType (line 105)

Sets type of file

access: public

void setType ([string $value = 'db'])

string $value: db|media|view

write (line 292)

Write to backup file

access: public

Mage_Backup_Model_Backup write (string $string)

string $string

Class Constants

BACKUP_DB = 'db' (line 37)

BACKUP_EXTENSION = 'gz' (line 42)

BACKUP_MEDIA = 'media' (line 39)

BACKUP_VIEW = 'view' (line 38)

COMPRESS_RATE = 9 (line 43)

Class Mage_Backup_Model_Backup