Snapshot Class Reference

Inheritance diagram for Snapshot:

Public Member Functions
	__construct (AppFilesystem $filesystem, Factory $backupFactory)
	rollback ()
	create ()
	getType ()
	setDbBackupManager (AbstractBackup $manager)
	getDbBackupFilename ()
Public Member Functions inherited from Filesystem
	rollback ()
	create ()
	validateAvailableDiscSpace ($backupDir, $size)
	setUseFtp ($host, $username, $password, $path)
	getType ()
	addIgnorePaths ($paths)
	getIgnorePaths ()
	setBackupsDir ($backupsDir)
	getFtpPath ()
	getFtpConnectString ()
Public Member Functions inherited from AbstractBackup
	setBackupExtension ($backupExtension)
	getBackupExtension ()
	setResourceModel ($resourceModel)
	getResourceModel ()
	setTime ($time)
	getTime ()
	setRootDir ($rootDir)
	getRootDir ()
	setBackupsDir ($backupsDir)
	getBackupsDir ()
	getBackupPath ()
	getBackupFilename ()
	getIsSuccess ()
	getErrorMessage ()
	setErrorMessage ($errorMessage)
	setName ($name, $applyFilter=true)
	getName ()
	getDisplayName ()
	keepSourceFile ()
	setKeepSourceFile (bool $keepSourceFile)

Protected Member Functions
	_createDbBackupInstance ()
	_getDbBackupManager ()
	_removeDbBackup ()
Protected Member Functions inherited from Filesystem
	_checkBackupsDir ()
	_getTarTmpPath ()
	getRollBackFtp ()
	getRollBackFs ()
Protected Member Functions inherited from AbstractBackup
	_filterName ($name)

Protected Attributes
	$_dbBackupManager
	$_filesystem
	$_backupFactory
Protected Attributes inherited from Filesystem
	$_ignorePaths = []
	$_useFtp = false
	$_ftpHost
	$_ftpUser
	$_ftpPass
	$_ftpPath
	$rollBackFtp
	$rollBackFs
Protected Attributes inherited from AbstractBackup
	$_name
	$_time
	$_backupExtension
	$_resourceModel
	$_rootDir
	$_backupsDir
	$_lastOperationSucceed = false
	$_lastErrorMessage

Detailed Description

Definition at line 18 of file Snapshot.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AppFilesystem	$filesystem,
		Factory	$backupFactory
	)

Parameters

AppFilesystem	$filesystem
Factory	$backupFactory

Definition at line 43 of file Snapshot.php.

    {
        $this->_filesystem = $filesystem;
        $this->_backupFactory = $backupFactory;
    }

Member Function Documentation

_createDbBackupInstance()

_createDbBackupInstance ( )

protected

Create Db Instance

Returns

BackupInterface

Definition at line 114 of file Snapshot.php.

    {
        return $this->_backupFactory->create(Factory::TYPE_DB)
            ->setBackupExtension('sql')
            ->setTime($this->getTime())
            ->setBackupsDir($this->_filesystem->getDirectoryWrite(DirectoryList::VAR_DIR)->getAbsolutePath())
            ->setResourceModel($this->getResourceModel());
    }

_getDbBackupManager()

_getDbBackupManager ( )

protected

Get database backup manager

Returns

Db

Definition at line 128 of file Snapshot.php.

    {
        if ($this->_dbBackupManager === null) {
            $this->_dbBackupManager = $this->_createDbBackupInstance();
        }

        return $this->_dbBackupManager;
    }

_removeDbBackup()

_removeDbBackup ( )

protected

Remove Db backup after added it to the snapshot

Returns

$this

Definition at line 164 of file Snapshot.php.

    {
        @unlink($this->_getDbBackupManager()->getBackupPath());
        return $this;
    }

create()

create

(

)

Implementation Create Backup functionality for Snapshot

Exceptions

Exception

Returns

bool

Implements BackupInterface.

Definition at line 80 of file Snapshot.php.

    {
        $this->_getDbBackupManager()->create();

        try {
            $result = parent::create();
        } catch (Exception $e) {
            $this->_removeDbBackup();
            throw $e;
        }

        $this->_lastOperationSucceed = false;
        $this->_removeDbBackup();
        $this->_lastOperationSucceed = true;

        return $result;
    }

getDbBackupFilename()

getDbBackupFilename

(

)

Get Db Backup Filename

Returns

string

Definition at line 154 of file Snapshot.php.

    {
        return $this->_getDbBackupManager()->getBackupFilename();
    }

getType()

getType

(

)

Overlap getType

Returns

string

See also

BackupInterface::getType()

Implements BackupInterface.

Definition at line 104 of file Snapshot.php.

    {
        return 'snapshot';
    }

rollback()

rollback

(

)

Implementation Rollback functionality for Snapshot

Exceptions

Exception

Returns

bool

Implements BackupInterface.

Definition at line 55 of file Snapshot.php.

    {
        $result = parent::rollback();

        $this->_lastOperationSucceed = false;

        try {
            $this->_getDbBackupManager()->rollback();
        } catch (Exception $e) {
            $this->_removeDbBackup();
            throw $e;
        }

        $this->_removeDbBackup();
        $this->_lastOperationSucceed = true;

        return $result;
    }

setDbBackupManager()

setDbBackupManager

(

AbstractBackup

$manager

)

Set Db backup manager

Parameters

AbstractBackup

$manager

Returns

$this

Definition at line 143 of file Snapshot.php.

    {
        $this->_dbBackupManager = $manager;
        return $this;
    }

Field Documentation

$_backupFactory

$_backupFactory

protected

Definition at line 37 of file Snapshot.php.

$_dbBackupManager

$_dbBackupManager

protected

Definition at line 25 of file Snapshot.php.

$_filesystem

$_filesystem

protected

Definition at line 32 of file Snapshot.php.

---

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

• vendor/magento/framework/Backup/Snapshot.php