SystemBackup Class Reference

Public Member Functions
	__construct (\Magento\Backup\Helper\Data $backupData, \Magento\Framework\Registry $coreRegistry, \Psr\Log\LoggerInterface $logger, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Backup\Factory $backupFactory, \Magento\Framework\App\MaintenanceMode $maintenanceMode)
	execute ()

Data Fields
const	XML_PATH_BACKUP_ENABLED = 'system/backup/enabled'
const	XML_PATH_BACKUP_TYPE = 'system/backup/type'
const	XML_PATH_BACKUP_MAINTENANCE_MODE = 'system/backup/maintenance'

Protected Attributes
	$_errors = []
	$_backupData = null
	$_coreRegistry = null
	$_logger
	$_scopeConfig
	$_filesystem
	$_backupFactory
	$maintenanceMode

Detailed Description

Performs scheduled backup.

Definition at line 14 of file SystemBackup.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backup\Helper\Data	$backupData,
		\Magento\Framework\Registry	$coreRegistry,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Backup\Factory	$backupFactory,
		\Magento\Framework\App\MaintenanceMode	$maintenanceMode
	)

Parameters

\Magento\Backup\Helper\Data	$backupData
\Magento\Framework\Registry	$coreRegistry
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Backup\Factory	$backupFactory
\Magento\Framework\App\MaintenanceMode	$maintenanceMode

Definition at line 81 of file SystemBackup.php.

      {
        $this->_backupData = $backupData;
        $this->_coreRegistry = $coreRegistry;
        $this->_logger = $logger;
        $this->_scopeConfig = $scopeConfig;
        $this->_filesystem = $filesystem;
        $this->_backupFactory = $backupFactory;
        $this->maintenanceMode = $maintenanceMode;
    }

Member Function Documentation

execute()

execute

(

)

Create Backup

Returns

$this

Exceptions

Definition at line 105 of file SystemBackup.php.

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

        if (!$this->_scopeConfig->isSetFlag(self::XML_PATH_BACKUP_ENABLED, ScopeInterface::SCOPE_STORE)) {
            return $this;
        }

        if ($this->_scopeConfig->isSetFlag(self::XML_PATH_BACKUP_MAINTENANCE_MODE, ScopeInterface::SCOPE_STORE)) {
            $this->maintenanceMode->set(true);
        }

        $type = $this->_scopeConfig->getValue(self::XML_PATH_BACKUP_TYPE, ScopeInterface::SCOPE_STORE);

        $this->_errors = [];
        try {
            $backupManager = $this->_backupFactory->create(
                $type
            )->setBackupExtension(
                $this->_backupData->getExtensionByType($type)
            )->setTime(
                time()
            )->setBackupsDir(
                $this->_backupData->getBackupsDir()
            );

            $this->_coreRegistry->register('backup_manager', $backupManager);

            if ($type != \Magento\Framework\Backup\Factory::TYPE_DB) {
                $backupManager->setRootDir(
                    $this->_filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath()
                )->addIgnorePaths(
                    $this->_backupData->getBackupIgnorePaths()
                );
            }

            $backupManager->create();
            $message = $this->_backupData->getCreateSuccessMessageByType($type);
            $this->_logger->info($message);
        } catch (\Exception $e) {
            $this->_errors[] = $e->getMessage();
            $this->_errors[] = $e->getTrace();
            throw $e;
        }

        if ($this->_scopeConfig->isSetFlag(self::XML_PATH_BACKUP_MAINTENANCE_MODE, ScopeInterface::SCOPE_STORE)) {
            $this->maintenanceMode->set(false);
        }

        return $this;
    }

Field Documentation

$_backupData

$_backupData = null

protected

Definition at line 34 of file SystemBackup.php.

$_backupFactory

$_backupFactory

protected

Definition at line 65 of file SystemBackup.php.

$_coreRegistry

$_coreRegistry = null

protected

Definition at line 41 of file SystemBackup.php.

$_errors

$_errors = []

protected

Definition at line 27 of file SystemBackup.php.

$_filesystem

$_filesystem

protected

Definition at line 60 of file SystemBackup.php.

$_logger

$_logger

protected

Definition at line 46 of file SystemBackup.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 53 of file SystemBackup.php.

$maintenanceMode

$maintenanceMode

protected

Definition at line 70 of file SystemBackup.php.

XML_PATH_BACKUP_ENABLED

const XML_PATH_BACKUP_ENABLED = 'system/backup/enabled'

Definition at line 16 of file SystemBackup.php.

XML_PATH_BACKUP_MAINTENANCE_MODE

const XML_PATH_BACKUP_MAINTENANCE_MODE = 'system/backup/maintenance'

Definition at line 20 of file SystemBackup.php.

XML_PATH_BACKUP_TYPE

const XML_PATH_BACKUP_TYPE = 'system/backup/type'

Definition at line 18 of file SystemBackup.php.

---

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

• vendor/magento/module-backup/Cron/SystemBackup.php