AbstractBackup Class Reference

Inheritance diagram for AbstractBackup:

Public Member Functions
	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)
Public Member Functions inherited from BackupInterface
	create ()
	rollback ()
	getType ()

Protected Member Functions
	_filterName ($name)

Protected Attributes
	$_name
	$_time
	$_backupExtension
	$_resourceModel
	$_rootDir
	$_backupsDir
	$_lastOperationSucceed = false
	$_lastErrorMessage

Detailed Description

Class to work with archives

@api

Since

100.0.2

Definition at line 17 of file AbstractBackup.php.

Member Function Documentation

_filterName()

_filterName (   $name )

protected

Removes disallowed characters and replaces spaces with underscores

Parameters

string

$name

Returns

string

Definition at line 302 of file AbstractBackup.php.

    {
        $name = trim(preg_replace('/[^\da-zA-Z ]/', '', $name));
        $name = preg_replace('/\s{2,}/', ' ', $name);
        $name = str_replace(' ', '_', $name);

        return $name;
    }

getBackupExtension()

getBackupExtension

(

)

Get Backup Extension

Returns

string

Definition at line 99 of file AbstractBackup.php.

    {
        return $this->_backupExtension;
    }

getBackupFilename()

getBackupFilename

(

)

Get backup file name

Returns

string

Definition at line 213 of file AbstractBackup.php.

    {
        $filename = $this->getTime() . '_' . $this->getType();

        $name = $this->getName();

        if (!empty($name)) {
            $filename .= '_' . $name;
        }

        $filename .= '.' . $this->getBackupExtension();

        return $filename;
    }

getBackupPath()

getBackupPath

(

)

Get path to backup

Returns

string

Definition at line 203 of file AbstractBackup.php.

    {
        return $this->getBackupsDir() . '/' . $this->getBackupFilename();
    }

getBackupsDir()

getBackupsDir

(

)

Get path to directory where backups stored

Returns

string

Definition at line 193 of file AbstractBackup.php.

    {
        return $this->_backupsDir;
    }

getDisplayName()

getDisplayName

(

)

Get backup display name

Returns

string

Definition at line 291 of file AbstractBackup.php.

    {
        return str_replace('_', ' ', $this->_name);
    }

getErrorMessage()

getErrorMessage

(

)

Get last error message

Returns

string

Definition at line 244 of file AbstractBackup.php.

    {
        return $this->_lastErrorMessage;
    }

getIsSuccess()

getIsSuccess

(

)

Check whether last operation completed successfully

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 234 of file AbstractBackup.php.

    {
        return $this->_lastOperationSucceed;
    }

getName()

getName

(

)

Get backup name

Returns

string

Definition at line 281 of file AbstractBackup.php.

    {
        return $this->_name;
    }

getResourceModel()

getResourceModel

(

)

Get Resource Model

Returns

object

Definition at line 121 of file AbstractBackup.php.

    {
        return $this->_resourceModel;
    }

getRootDir()

getRootDir

(

)

Get Magento's root directory

Returns

string

Definition at line 171 of file AbstractBackup.php.

    {
        return $this->_rootDir;
    }

getTime()

getTime

(

)

Get Time

Returns

int

Definition at line 143 of file AbstractBackup.php.

    {
        return $this->_time;
    }

keepSourceFile()

keepSourceFile

(

)

Check if keep files of backup

Returns

bool

Implements SourceFileInterface.

Definition at line 316 of file AbstractBackup.php.

    {
        return $this->keepSourceFile;
    }

setBackupExtension()

setBackupExtension

(

$backupExtension

)

Set Backup Extension

Parameters

string

$backupExtension

Returns

$this

Implements BackupInterface.

Definition at line 88 of file AbstractBackup.php.

    {
        $this->_backupExtension = $backupExtension;
        return $this;
    }

setBackupsDir()

setBackupsDir

(

$backupsDir

)

Set path to directory where backups stored

Parameters

string

$backupsDir

Returns

$this

Implements BackupInterface.

Definition at line 182 of file AbstractBackup.php.

    {
        $this->_backupsDir = $backupsDir;
        return $this;
    }

setErrorMessage()

setErrorMessage

(

$errorMessage

)

Set error message

Parameters

string

$errorMessage

Returns

void

Definition at line 255 of file AbstractBackup.php.

    {
        $this->_lastErrorMessage = $errorMessage;
    }

setKeepSourceFile()

setKeepSourceFile

(

bool

$keepSourceFile

)

Set if keep files of backup

Parameters

bool

$keepSourceFile

Returns

$this

Implements SourceFileInterface.

Definition at line 327 of file AbstractBackup.php.

    {
        $this->keepSourceFile = $keepSourceFile;
        return $this;
    }

setName()

setName	(		$name,
			$applyFilter = true
	)

Set backup name

Parameters

string	$name
bool	$applyFilter

Returns

$this

Definition at line 267 of file AbstractBackup.php.

    {
        if ($applyFilter) {
            $name = $this->_filterName($name);
        }
        $this->_name = $name;
        return $this;
    }

setResourceModel()

setResourceModel

(

$resourceModel

)

Set Resource Model

Parameters

object

$resourceModel

Returns

$this

Implements BackupInterface.

Definition at line 110 of file AbstractBackup.php.

    {
        $this->_resourceModel = $resourceModel;
        return $this;
    }

setRootDir()

setRootDir

(

$rootDir

)

Set root directory of Magento installation

Parameters

string

$rootDir

Exceptions

LocalizedException

Returns

$this

Definition at line 155 of file AbstractBackup.php.

    {
        if (!is_dir($rootDir)) {
            throw new LocalizedException(
                new Phrase('Bad root directory')
            );
        }

        $this->_rootDir = $rootDir;
        return $this;
    }

setTime()

setTime

(

$time

)

Set Time

Parameters

int

$time

Returns

$this

Implements BackupInterface.

Definition at line 132 of file AbstractBackup.php.

    {
        $this->_time = $time;
        return $this;
    }

Field Documentation

$_backupExtension

$_backupExtension

protected

Definition at line 38 of file AbstractBackup.php.

$_backupsDir

$_backupsDir

protected

Definition at line 59 of file AbstractBackup.php.

$_lastErrorMessage

$_lastErrorMessage

protected

Definition at line 73 of file AbstractBackup.php.

$_lastOperationSucceed

$_lastOperationSucceed = false

protected

Definition at line 66 of file AbstractBackup.php.

$_name

$_name

protected

Definition at line 24 of file AbstractBackup.php.

$_resourceModel

$_resourceModel

protected

Definition at line 45 of file AbstractBackup.php.

$_rootDir

$_rootDir

protected

Definition at line 52 of file AbstractBackup.php.

$_time

$_time

protected

Definition at line 31 of file AbstractBackup.php.

---

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

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