BackupRollback Class Reference

Public Member Functions
	__construct (ObjectManagerInterface $objectManager, LoggerInterface $log, DirectoryList $directoryList, File $file, Helper $fsHelper)
	getFSDiskSpace ($type=Factory::TYPE_FILESYSTEM)

Data Fields
const	DEFAULT_BACKUP_DIRECTORY = 'backups'

Detailed Description

Class to deal with backup and rollback functionality for database and Code base

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file BackupRollback.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectManagerInterface	$objectManager,
		LoggerInterface	$log,
		DirectoryList	$directoryList,
		File	$file,
		Helper	$fsHelper
	)

Constructor

Parameters

ObjectManagerInterface	$objectManager
LoggerInterface	$log
DirectoryList	$directoryList
File	$file
Helper	$fsHelper

Definition at line 81 of file BackupRollback.php.

      {
        $this->objectManager = $objectManager;
        $this->log = $log;
        $this->directoryList = $directoryList;
        $this->file = $file;
        $this->fsHelper = $fsHelper;
        $this->backupsDir = $this->directoryList->getPath(DirectoryList::VAR_DIR)
            . '/' . self::DEFAULT_BACKUP_DIRECTORY;
    }

Member Function Documentation

getFSDiskSpace()

getFSDiskSpace

(

$type = Factory::TYPE_FILESYSTEM

)

Get disk availability for filesystem backup

Parameters

string

$type

Returns

int

Exceptions

LocalizedException

Definition at line 305 of file BackupRollback.php.

    {
        $filesystemSize = 0;
        if ($type === Factory::TYPE_FILESYSTEM) {
            $ignorePaths = $this->getCodeBackupIgnorePaths();
        } elseif ($type === Factory::TYPE_MEDIA) {
            $ignorePaths = $this->getMediaBackupIgnorePaths();
        } else {
            throw new LocalizedException(new Phrase("This backup type '$type' is not supported."));
        }
        $filesInfo = $this->fsHelper->getInfo(
            $this->directoryList->getRoot(),
            Helper::INFO_SIZE,
            $ignorePaths
        );
        if ($filesInfo['size']) {
            $filesystemSize = $filesInfo['size'];
        }
        return $filesystemSize;
    }

Field Documentation

DEFAULT_BACKUP_DIRECTORY

const DEFAULT_BACKUP_DIRECTORY = 'backups'

Default backup directory

Definition at line 28 of file BackupRollback.php.

---

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

• vendor/magento/framework/Setup/BackupRollback.php