Db Class Reference

Inheritance diagram for Db:

Public Member Functions
	__construct (BackupFactory $backupFactory)
	rollback ()
	create ()
	getDBSize ()
	getType ()
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
	_isLineLastInCommand ($line)
Protected Member Functions inherited from AbstractBackup
	_filterName ($name)

Protected Attributes
	$_backupFactory
Protected Attributes inherited from AbstractBackup
	$_name
	$_time
	$_backupExtension
	$_resourceModel
	$_rootDir
	$_backupsDir
	$_lastOperationSucceed = false
	$_lastErrorMessage

Detailed Description

Class to work with database backups

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @api

Since

100.0.2

Definition at line 19 of file Db.php.

Constructor & Destructor Documentation

__construct()

__construct

(

BackupFactory

$backupFactory

)

Parameters

BackupFactory

$backupFactory

Definition at line 29 of file Db.php.

    {
        $this->_backupFactory = $backupFactory;
    }

Member Function Documentation

_isLineLastInCommand()

_isLineLastInCommand (   $line )

protected

Checks whether the line is last in sql command

Parameters

string

$line

Returns

bool

Definition at line 68 of file Db.php.

    {
        $cleanLine = trim($line);
        $lineLength = strlen($cleanLine);

        $returnResult = false;
        if ($lineLength > 0) {
            $lastSymbolIndex = $lineLength - 1;
            if ($cleanLine[$lastSymbolIndex] == ';') {
                $returnResult = true;
            }
        }

        return $returnResult;
    }

create()

create

(

)

Implements Create Backup functionality for Db

Returns

bool

Implements BackupInterface.

Definition at line 89 of file Db.php.

    {
        set_time_limit(0);
        ignore_user_abort(true);

        $this->_lastOperationSucceed = false;

        $backup = $this->_backupFactory->createBackupModel()->setTime(
            $this->getTime()
        )->setType(
            $this->getType()
        )->setPath(
            $this->getBackupsDir()
        )->setName(
            $this->getName()
        );

        $backupDb = $this->_backupFactory->createBackupDbModel();
        $backupDb->createBackup($backup);

        $this->_lastOperationSucceed = true;

        return true;
    }

getDBSize()

getDBSize

(

)

Get database size

Returns

int

Definition at line 119 of file Db.php.

    {
        $backupDb = $this->_backupFactory->createBackupDbModel();
        return $backupDb->getDBBackupSize();
    }

getType()

getType

(

)

Get Backup Type

Returns

string

Implements BackupInterface.

Definition at line 130 of file Db.php.

    {
        return 'db';
    }

rollback()

rollback

(

)

Implements Rollback functionality for Db

Returns

bool

Implements BackupInterface.

Definition at line 39 of file Db.php.

    {
        set_time_limit(0);
        ignore_user_abort(true);

        $this->_lastOperationSucceed = false;

        $archiveManager = new Archive();
        $source = $archiveManager->unpack($this->getBackupPath(), $this->getBackupsDir());

        $file = new File($source);
        foreach ($file as $statement) {
            $this->getResourceModel()->runCommand($statement);
        }
        if ($this->keepSourceFile() === false) {
            @unlink($source);
        }

        $this->_lastOperationSucceed = true;

        return true;
    }

Field Documentation

$_backupFactory

$_backupFactory

protected

Definition at line 24 of file Db.php.

---

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

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