Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, Filesystem $filesystem, \Magento\Framework\AuthorizationInterface $authorization, \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList)
	getBackupTypes ()
	getBackupTypesList ()
	getDefaultBackupType ()
	getBackupsDir ()
	getExtensionByType ($type)
	getExtensions ()
	generateBackupDownloadName (\Magento\Backup\Model\Backup $backup)
	isRollbackAllowed ()
	getBackupIgnorePaths ()
	getRollbackIgnorePaths ()
	getCreateSuccessMessageByType ($type)
	invalidateCache ()
	nameToDisplayName ($name)
	extractDataFromFilename ($filename)
	isEnabled ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$_filesystem
	$_authorization
	$_cacheTypeList
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Backup data helper @api

Since

100.0.2

Definition at line 20 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		Filesystem	$filesystem,
		\Magento\Framework\AuthorizationInterface	$authorization,
		\Magento\Framework\App\Cache\TypeListInterface	$cacheTypeList
	)

Construct

Parameters

\Magento\Framework\App\Helper\Context	$context
Filesystem	$filesystem
\Magento\Framework\AuthorizationInterface	$authorization
\Magento\Framework\App\Cache\TypeListInterface	$cacheTypeList

Definition at line 45 of file Data.php.

      {
        parent::__construct($context);
        $this->_authorization = $authorization;
        $this->_filesystem = $filesystem;
        $this->_cacheTypeList = $cacheTypeList;
    }

Member Function Documentation

extractDataFromFilename()

extractDataFromFilename

(

$filename

)

Extracts information from backup's filename

Parameters

string

$filename

Returns

\Magento\Framework\DataObject

Definition at line 262 of file Data.php.

    {
        $extensions = $this->getExtensions();

        $filenameWithoutExtension = $filename;

        foreach ($extensions as $extension) {
            $filenameWithoutExtension = preg_replace(
                '/' . preg_quote($extension, '/') . '$/',
                '',
                $filenameWithoutExtension
            );
        }

        $filenameWithoutExtension = substr($filenameWithoutExtension, 0, strrpos($filenameWithoutExtension, "."));

        list($time, $type) = explode("_", $filenameWithoutExtension);

        $name = str_replace($time . '_' . $type, '', $filenameWithoutExtension);

        if (!empty($name)) {
            $name = substr($name, 1);
        }

        $result = new \Magento\Framework\DataObject();
        $result->addData(['name' => $name, 'type' => $type, 'time' => $time]);

        return $result;
    }

generateBackupDownloadName()

generateBackupDownloadName

(

\Magento\Backup\Model\Backup

$backup

)

Generate backup download name

Parameters

\Magento\Backup\Model\Backup

$backup

Returns

string

Definition at line 140 of file Data.php.

    {
        $additionalExtension = $backup->getType() == \Magento\Framework\Backup\Factory::TYPE_DB ? '.sql' : '';
        return $backup->getTime() .
            '_' .
            $backup->getType() .
            '_' .
            $backup->getName() .
            $additionalExtension .
            '.' .
            $this->getExtensionByType(
                $backup->getType()
            );
    }

getBackupIgnorePaths()

getBackupIgnorePaths

(

)

Get paths that should be ignored when creating system snapshots

Returns

string[]

Definition at line 170 of file Data.php.

    {
        return [
            '.git',
            '.svn',
            $this->_filesystem->getDirectoryRead(MaintenanceMode::FLAG_DIR)
                ->getAbsolutePath(MaintenanceMode::FLAG_FILENAME),
            $this->_filesystem->getDirectoryRead(DirectoryList::SESSION)->getAbsolutePath(),
            $this->_filesystem->getDirectoryRead(DirectoryList::CACHE)->getAbsolutePath(),
            $this->_filesystem->getDirectoryRead(DirectoryList::LOG)->getAbsolutePath(),
            $this->_filesystem->getDirectoryRead(DirectoryList::VAR_DIR)->getAbsolutePath('full_page_cache'),
            $this->_filesystem->getDirectoryRead(DirectoryList::VAR_DIR)->getAbsolutePath('locks'),
            $this->_filesystem->getDirectoryRead(DirectoryList::VAR_DIR)->getAbsolutePath('report'),
        ];
    }

getBackupsDir()

getBackupsDir

(

)

Get directory path where backups stored

Returns

string

Definition at line 102 of file Data.php.

    {
        return $this->_filesystem->getDirectoryWrite(DirectoryList::VAR_DIR)->getAbsolutePath('backups');
    }

getBackupTypes()

getBackupTypes

(

)

Get all possible backup type values with descriptive title

Returns

array

Definition at line 62 of file Data.php.

    {
        return [
            \Magento\Framework\Backup\Factory::TYPE_DB => __('Database'),
            \Magento\Framework\Backup\Factory::TYPE_MEDIA => __('Database and Media'),
            \Magento\Framework\Backup\Factory::TYPE_SYSTEM_SNAPSHOT => __('System'),
            \Magento\Framework\Backup\Factory::TYPE_SNAPSHOT_WITHOUT_MEDIA => __('System (excluding Media)')
        ];
    }

getBackupTypesList()

getBackupTypesList

(

)

Get all possible backup type values

Returns

string[]

Definition at line 77 of file Data.php.

    {
        return [
            \Magento\Framework\Backup\Factory::TYPE_DB,
            \Magento\Framework\Backup\Factory::TYPE_SYSTEM_SNAPSHOT,
            \Magento\Framework\Backup\Factory::TYPE_SNAPSHOT_WITHOUT_MEDIA,
            \Magento\Framework\Backup\Factory::TYPE_MEDIA
        ];
    }

getCreateSuccessMessageByType()

getCreateSuccessMessageByType

(

$type

)

Get backup create success message by backup type

Parameters

string

$type

Returns

void|string

Definition at line 213 of file Data.php.

    {
        $messagesMap = [
            \Magento\Framework\Backup\Factory::TYPE_SYSTEM_SNAPSHOT => __('You created the system backup.'),
            \Magento\Framework\Backup\Factory::TYPE_SNAPSHOT_WITHOUT_MEDIA => __(
                'You created the system backup (excluding media).'
            ),
            \Magento\Framework\Backup\Factory::TYPE_MEDIA => __('You created the database and media backup.'),
            \Magento\Framework\Backup\Factory::TYPE_DB => __('You created the database backup.'),
        ];

        if (!isset($messagesMap[$type])) {
            return;
        }

        return $messagesMap[$type];
    }

getDefaultBackupType()

getDefaultBackupType

(

)

Get default backup type value

Returns

string

Definition at line 92 of file Data.php.

    {
        return \Magento\Framework\Backup\Factory::TYPE_DB;
    }

getExtensionByType()

getExtensionByType

(

$type

)

Get backup file extension by backup type

Parameters

string

$type

Returns

string

Definition at line 113 of file Data.php.

    {
        $extensions = $this->getExtensions();
        return $extensions[$type] ?? '';
    }

getExtensions()

getExtensions

(

)

Get all types to extensions map

Returns

array

Definition at line 124 of file Data.php.

    {
        return [
            \Magento\Framework\Backup\Factory::TYPE_SYSTEM_SNAPSHOT => 'tgz',
            \Magento\Framework\Backup\Factory::TYPE_SNAPSHOT_WITHOUT_MEDIA => 'tgz',
            \Magento\Framework\Backup\Factory::TYPE_MEDIA => 'tgz',
            \Magento\Framework\Backup\Factory::TYPE_DB => 'sql'
        ];
    }

getRollbackIgnorePaths()

getRollbackIgnorePaths

(

)

Get paths that should be ignored when rolling back system snapshots

Returns

string[]

Definition at line 191 of file Data.php.

    {
        return [
            '.svn',
            '.git',
            $this->_filesystem->getDirectoryRead(MaintenanceMode::FLAG_DIR)
                ->getAbsolutePath(MaintenanceMode::FLAG_FILENAME),
            $this->_filesystem->getDirectoryRead(DirectoryList::SESSION)->getAbsolutePath(),
            $this->_filesystem->getDirectoryRead(DirectoryList::LOG)->getAbsolutePath(),
            $this->_filesystem->getDirectoryRead(DirectoryList::VAR_DIR)->getAbsolutePath('locks'),
            $this->_filesystem->getDirectoryRead(DirectoryList::VAR_DIR)->getAbsolutePath('report'),
            $this->_filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath('errors'),
            $this->_filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath('index.php'),
        ];
    }

invalidateCache()

invalidateCache

(

)

Invalidate Cache

Returns

$this

Definition at line 236 of file Data.php.

    {
        if ($cacheTypes = $this->_cacheConfig->getTypes()) {
            $cacheTypesList = array_keys($cacheTypes);
            $this->_cacheTypeList->invalidate($cacheTypesList);
        }
        return $this;
    }

isEnabled()

isEnabled

(

)

Is backup functionality enabled.

Returns

bool

Definition at line 297 of file Data.php.

                               : bool
    {
        return $this->scopeConfig->isSetFlag('system/backup/functionality_enabled');
    }

isRollbackAllowed()

isRollbackAllowed

(

)

Check Permission for Rollback

Returns

bool

Definition at line 160 of file Data.php.

    {
        return $this->_authorization->isAllowed('Magento_Backup::rollback');
    }

nameToDisplayName()

nameToDisplayName

(

$name

)

Creates backup's display name from it's name

Parameters

string

$name

Returns

string

Definition at line 251 of file Data.php.

    {
        return str_replace('_', ' ', $name);
    }

Field Documentation

$_authorization

$_authorization

protected

Definition at line 30 of file Data.php.

$_cacheTypeList

$_cacheTypeList

protected

Definition at line 35 of file Data.php.

$_filesystem

$_filesystem

protected

Definition at line 25 of file Data.php.

---

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

• vendor/magento/module-backup/Helper/Data.php