AbstractBackup.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Backup;

use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Phrase;

abstract class AbstractBackup implements BackupInterface, SourceFileInterface
{
    protected $_name;

    protected $_time;

    protected $_backupExtension;

    protected $_resourceModel;

    protected $_rootDir;

    protected $_backupsDir;

    protected $_lastOperationSucceed = false;

    protected $_lastErrorMessage;

    private $keepSourceFile;

    public function setBackupExtension($backupExtension)
    {
        $this->_backupExtension = $backupExtension;
        return $this;
    }

    public function getBackupExtension()
    {
        return $this->_backupExtension;
    }

    public function setResourceModel($resourceModel)
    {
        $this->_resourceModel = $resourceModel;
        return $this;
    }

    public function getResourceModel()
    {
        return $this->_resourceModel;
    }

    public function setTime($time)
    {
        $this->_time = $time;
        return $this;
    }

    public function getTime()
    {
        return $this->_time;
    }

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

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

    public function getRootDir()
    {
        return $this->_rootDir;
    }

    public function setBackupsDir($backupsDir)
    {
        $this->_backupsDir = $backupsDir;
        return $this;
    }

    public function getBackupsDir()
    {
        return $this->_backupsDir;
    }

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

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

        $name = $this->getName();

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

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

        return $filename;
    }

    public function getIsSuccess()
    {
        return $this->_lastOperationSucceed;
    }

    public function getErrorMessage()
    {
        return $this->_lastErrorMessage;
    }

    public function setErrorMessage($errorMessage)
    {
        $this->_lastErrorMessage = $errorMessage;
    }

    public function setName($name, $applyFilter = true)
    {
        if ($applyFilter) {
            $name = $this->_filterName($name);
        }
        $this->_name = $name;
        return $this;
    }

    public function getName()
    {
        return $this->_name;
    }

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

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

        return $name;
    }

    public function keepSourceFile()
    {
        return $this->keepSourceFile;
    }

    public function setKeepSourceFile(bool $keepSourceFile)
    {
        $this->keepSourceFile = $keepSourceFile;
        return $this;
    }
}