Inheritance diagram for Backup:

Public Member Functions
	__construct (\Magento\Backup\Helper\Data $helper, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Magento\Backend\Model\Auth\Session $authSession, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Framework\Filesystem $filesystem, $data=[])

	setTime ($time)

	setPath ($path)

	setName ($name)

	load ($fileName, $filePath)

	exists ()

	getFileName ()

	setType ($value='db')

	getType ()

	setFile (&$content)

&	getFile ()

	deleteFile ()

	read ($length)

	eof ()

	write ($string)

	close ()

	getSize ()

	validateUserPassword ($password)

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BackupInterface
	open ($write=false)

Data Fields
const	COMPRESS_RATE = 9

Protected Member Functions
	_getStream ()

	_getFilePath ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_stream = null

	$_filesystem

	$_helper

	$_localeResolver

	$_backendAuthSession

	$_encryptor

	$varDirectory

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Backup file item model

@method string getPath() @method string getName() @method string getTime() @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 21 of file Backup.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backup\Helper\Data	$helper,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Magento\Backend\Model\Auth\Session	$authSession,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Framework\Filesystem	$filesystem,
			$data = `[]`
	)

Parameters

\Magento\Backup\Helper\Data	$helper
\Magento\Framework\Locale\ResolverInterface	$localeResolver
\Magento\Backend\Model\Auth\Session	$authSession
\Magento\Framework\Encryption\EncryptorInterface	$encryptor
\Magento\Framework\Filesystem	$filesystem
array	$data

Definition at line 84 of file Backup.php.

       {
         $this->_encryptor = $encryptor;
         parent::__construct($data);
 
         $this->_filesystem = $filesystem;
         $this->varDirectory = $this->_filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);
         $this->_helper = $helper;
         $this->_localeResolver = $localeResolver;
         $this->_backendAuthSession = $authSession;
     }

Member Function Documentation

◆ _getFilePath()

_getFilePath ( )

protected

Get file path.

Returns: string

Definition at line 434 of file Backup.php.

     {
         return $this->varDirectory->getRelativePath($this->getPath() . '/' . $this->getFileName());
     }

◆ _getStream()

_getStream ( )

protected

Get zlib handler

Returns: \Magento\Framework\Filesystem\File\WriteInterface

Exceptions

Definition at line 320 of file Backup.php.

     {
         if ($this->_stream === null) {
             throw new \Magento\Framework\Exception\InputException(__('The backup file handler was unspecified.'));
         }
         return $this->_stream;
     }

◆ close()

close ( )

Close open backup file

Returns: $this

Implements BackupInterface.

Definition at line 374 of file Backup.php.

     {
         $this->_getStream()->close();
         $this->_stream = null;
 
         return $this;
     }

◆ deleteFile()

deleteFile ( )

Delete backup file

Returns: $this

Exceptions

Definition at line 263 of file Backup.php.

     {
         if (!$this->exists()) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The backup file does not exist.'));
         }
 
         $this->varDirectory->delete($this->_getFilePath());
         return $this;
     }

◆ eof()

eof ( )

Check end of file.

Returns: bool

Definition at line 344 of file Backup.php.

     {
         return $this->_getStream()->eof();
     }

◆ exists()

exists ( )

Checks backup file exists.

Returns: bool

Definition at line 170 of file Backup.php.

     {
         return $this->varDirectory->isFile($this->_getFilePath());
     }

◆ getFile()

& getFile ( )

Return content of backup file

Returns: string

Exceptions

Definition at line 248 of file Backup.php.

     {
         if (!$this->exists()) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The backup file does not exist.'));
         }
 
         return $this->varDirectory->read($this->_getFilePath());
     }

◆ getFileName()

getFileName ( )

Return file name of backup file

Returns: string

Definition at line 180 of file Backup.php.

     {
         $filename = $this->getTime() . "_" . $this->getType();
         $backupName = $this->getName();
 
         if (!empty($backupName)) {
             $filename .= '_' . $backupName;
         }
 
         $filename .= '.' . $this->_helper->getExtensionByType($this->getType());
 
         return $filename;
     }

◆ getSize()

getSize ( )

Returns: int|mixed

Definition at line 403 of file Backup.php.

     {
         if ($this->getData('size') !== null) {
             return $this->getData('size');
         }
 
         if ($this->exists()) {
             $this->setData('size', $this->varDirectory->stat($this->_getFilePath())['size']);
             return $this->getData('size');
         }
 
         return 0;
     }

◆ getType()

getType ( )

Returns type of backup file

Returns: string

Definition at line 218 of file Backup.php.

     {
         return $this->_type;
     }

◆ load()

load	(	$fileName,
		$filePath
	)

Load backup file info

Parameters

string	$fileName
string	$filePath

Returns: $this

Definition at line 145 of file Backup.php.

     {
         $backupData = $this->_helper->extractDataFromFilename($fileName);
 
         $this->addData(
             [
                 'id' => $filePath . '/' . $fileName,
                 'time' => (int)$backupData->getTime(),
                 'path' => $filePath,
                 'extension' => $this->_helper->getExtensionByType($backupData->getType()),
                 'display_name' => $this->_helper->nameToDisplayName($backupData->getName()),
                 'name' => $backupData->getName(),
                 'date_object' => (new \DateTime())->setTimestamp($backupData->getTime()),
             ]
         );
 
         $this->setType($backupData->getType());
         return $this;
     }

◆ read()

read ( $length )

Read backup uncompressed data

Parameters

int $length

Returns: string

Definition at line 334 of file Backup.php.

     {
         return $this->_getStream()->read($length);
     }

◆ setFile()

setFile ( & $content )

Set the backup file content

Parameters

string &$content

Returns: $this

Exceptions

Definition at line 230 of file Backup.php.

     {
         if (!$this->hasData('time') || !$this->hasData('type') || !$this->hasData('path')) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Please correct the order of creation for a new backup.')
             );
         }
 
         $this->varDirectory->writeFile($this->_getFilePath(), $content);
         return $this;
     }

◆ setName()

setName ( $name )

Set backup name

Parameters

string $name

Returns: $this

Implements BackupInterface.

Definition at line 132 of file Backup.php.

     {
         $this->setData('name', $name);
         return $this;
     }

◆ setPath()

setPath ( $path )

Set backup path

Parameters

string $path

Returns: $this

Implements BackupInterface.

Definition at line 120 of file Backup.php.

     {
         $this->setData('path', $path);
         return $this;
     }

◆ setTime()

setTime ( $time )

Set backup time

Parameters

int $time

Returns: $this

Implements BackupInterface.

Definition at line 108 of file Backup.php.

     {
         $this->setData('time', $time);
         return $this;
     }

◆ setType()

setType ( $value = 'db' )

Sets type of file

Parameters

string $value

Returns: $this

Implements BackupInterface.

Definition at line 200 of file Backup.php.

     {
         $possibleTypes = $this->_helper->getBackupTypesList();
         if (!in_array($value, $possibleTypes)) {
             $value = $this->_helper->getDefaultBackupType();
         }
 
         $this->_type = $value;
         $this->setData('type', $this->_type);
 
         return $this;
     }

◆ validateUserPassword()

validateUserPassword ( $password )

Validate user password

Parameters

string $password

Returns: bool

Definition at line 423 of file Backup.php.

     {
         $userPasswordHash = $this->_backendAuthSession->getUser()->getPassword();
         return $this->_encryptor->validateHash($password, $userPasswordHash);
     }

◆ write()

write ( $string )

Write to backup file

Parameters

string $string

Returns: $this

Exceptions

Implements BackupInterface.

Definition at line 356 of file Backup.php.

     {
         try {
             $this->_getStream()->write($string);
         } catch (\Magento\Framework\Exception\FileSystemException $e) {
             throw new \Magento\Framework\Exception\InputException(
                 __('Something went wrong while writing to the backup file "%1".', $this->getFileName())
             );
         }
 
         return $this;
     }

Field Documentation

◆ $_backendAuthSession

$_backendAuthSession

protected

Definition at line 64 of file Backup.php.

◆ $_encryptor

$_encryptor

protected

Definition at line 69 of file Backup.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 45 of file Backup.php.

◆ $_helper

$_helper

protected

Definition at line 50 of file Backup.php.

◆ $_localeResolver

$_localeResolver

protected

Definition at line 57 of file Backup.php.

◆ $_stream

$_stream = null

protected

Definition at line 40 of file Backup.php.

◆ $varDirectory

$varDirectory

protected

Definition at line 74 of file Backup.php.

◆ COMPRESS_RATE

const COMPRESS_RATE = 9

Compress rate

Definition at line 26 of file Backup.php.

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

vendor/magento/module-backup/Model/Backup.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getFilePath()

◆ _getStream()

◆ close()

◆ deleteFile()

◆ eof()

◆ exists()

◆ getFile()

◆ getFileName()

◆ getSize()

◆ getType()

◆ load()

◆ read()

◆ setFile()

◆ setName()

◆ setPath()

◆ setTime()

◆ setType()

◆ validateUserPassword()

◆ write()

Field Documentation

◆ $_backendAuthSession

◆ $_encryptor

◆ $_filesystem

◆ $_helper

◆ $_localeResolver

◆ $_stream

◆ $varDirectory

◆ COMPRESS_RATE