Filesystem Class Reference

Inheritance diagram for Filesystem:

Public Member Functions
	rollback ()
	create ()
	validateAvailableDiscSpace ($backupDir, $size)
	setUseFtp ($host, $username, $password, $path)
	getType ()
	addIgnorePaths ($paths)
	getIgnorePaths ()
	setBackupsDir ($backupsDir)
	getFtpPath ()
	getFtpConnectString ()
Public Member Functions inherited from AbstractBackup
	setBackupExtension ($backupExtension)
	getBackupExtension ()
	setResourceModel ($resourceModel)
	getResourceModel ()
	setTime ($time)
	getTime ()
	setRootDir ($rootDir)
	getRootDir ()
	setBackupsDir ($backupsDir)
	getBackupsDir ()
	getBackupPath ()
	getBackupFilename ()
	getIsSuccess ()
	getErrorMessage ()
	setErrorMessage ($errorMessage)
	setName ($name, $applyFilter=true)
	getName ()
	getDisplayName ()
	keepSourceFile ()
	setKeepSourceFile (bool $keepSourceFile)

Protected Member Functions
	_checkBackupsDir ()
	_getTarTmpPath ()
	getRollBackFtp ()
	getRollBackFs ()
Protected Member Functions inherited from AbstractBackup
	_filterName ($name)

Protected Attributes
	$_ignorePaths = []
	$_useFtp = false
	$_ftpHost
	$_ftpUser
	$_ftpPass
	$_ftpPath
	$rollBackFtp
	$rollBackFs
Protected Attributes inherited from AbstractBackup
	$_name
	$_time
	$_backupExtension
	$_resourceModel
	$_rootDir
	$_backupsDir
	$_lastOperationSucceed = false
	$_lastErrorMessage

Detailed Description

Class to work with filesystem backups

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 25 of file Filesystem.php.

Member Function Documentation

_checkBackupsDir()

_checkBackupsDir ( )

protected

Check backups directory existence and whether it's writeable

Returns

void

Exceptions

LocalizedException

Definition at line 283 of file Filesystem.php.

    {
        $backupsDir = $this->getBackupsDir();

        if (!is_dir($backupsDir)) {
            $backupsDirParentDirectory = basename($backupsDir);

            if (!is_writeable($backupsDirParentDirectory)) {
                throw new NotEnoughPermissions(
                    new Phrase('Cant create backups directory')
                );
            }

            mkdir($backupsDir);
            chmod($backupsDir);
        }

        if (!is_writable($backupsDir)) {
            throw new NotEnoughPermissions(
                new Phrase('Backups directory is not writeable')
            );
        }
    }

_getTarTmpPath()

_getTarTmpPath ( )

protected

Generate tmp name for tarball

Returns

string

Definition at line 312 of file Filesystem.php.

    {
        $tmpName = '~tmp-' . microtime(true) . '.tar';
        return $this->getBackupsDir() . '/' . $tmpName;
    }

addIgnorePaths()

addIgnorePaths

(

$paths

)

Add path that should be ignoring when creating or rolling back backup

Parameters

string | array

$paths

Returns

$this

Definition at line 217 of file Filesystem.php.

    {
        if (is_string($paths)) {
            if (!in_array($paths, $this->_ignorePaths)) {
                $this->_ignorePaths[] = $paths;
            }
        } elseif (is_array($paths)) {
            foreach ($paths as $path) {
                $this->addIgnorePaths($path);
            }
        }

        return $this;
    }

create()

create

(

)

Implementation Create Backup functionality for Filesystem

Exceptions

LocalizedException

Returns

boolean

Implements BackupInterface.

Definition at line 105 of file Filesystem.php.

    {
        set_time_limit(0);
        ignore_user_abort(true);

        $this->_lastOperationSucceed = false;

        $this->_checkBackupsDir();

        $fsHelper = new Helper();

        $filesInfo = $fsHelper->getInfo(
            $this->getRootDir(),
            Helper::INFO_READABLE |
            Helper::INFO_SIZE,
            $this->getIgnorePaths()
        );

        if (!$filesInfo['readable']) {
            throw new NotEnoughPermissions(
                new Phrase('Not enough permissions to read files for backup')
            );
        }
        $this->validateAvailableDiscSpace($this->getBackupsDir(), $filesInfo['size']);

        $tarTmpPath = $this->_getTarTmpPath();

        $tarPacker = new Tar();
        $tarPacker->setSkipFiles($this->getIgnorePaths())->pack($this->getRootDir(), $tarTmpPath, true);

        if (!is_file($tarTmpPath) || filesize($tarTmpPath) == 0) {
            throw new LocalizedException(
                new Phrase('Failed to create backup')
            );
        }

        $backupPath = $this->getBackupPath();

        $gzPacker = new Gz();
        $gzPacker->pack($tarTmpPath, $backupPath);

        if (!is_file($backupPath) || filesize($backupPath) == 0) {
            throw new LocalizedException(
                new Phrase('Failed to create backup')
            );
        }

        @unlink($tarTmpPath);

        $this->_lastOperationSucceed = true;
        return $this->_lastOperationSucceed;
    }

getFtpConnectString()

getFtpConnectString

(

)

Get ftp connection string

Returns

string

Definition at line 272 of file Filesystem.php.

    {
        return 'ftp://' . $this->_ftpUser . ':' . $this->_ftpPass . '@' . $this->_ftpHost . $this->_ftpPath;
    }

getFtpPath()

getFtpPath

(

)

Getter for $_ftpPath variable

Returns

string

Definition at line 262 of file Filesystem.php.

    {
        return $this->_ftpPath;
    }

getIgnorePaths()

getIgnorePaths

(

)

Get paths that should be ignored while creating or rolling back backup procedure

Returns

array

Definition at line 237 of file Filesystem.php.

    {
        return $this->_ignorePaths;
    }

getRollBackFs()

getRollBackFs ( )

protected

Returns

Fs

Deprecated:

101.0.0

Definition at line 338 of file Filesystem.php.

    {
        if (!$this->rollBackFs) {
            $this->rollBackFs = ObjectManager::getInstance()->create(
                Fs::class,
                ['snapshotObject' => $this]
            );
        }

        return $this->rollBackFs;
    }

getRollBackFtp()

getRollBackFtp ( )

protected

Returns

Ftp

Deprecated:

101.0.0

Definition at line 322 of file Filesystem.php.

    {
        if (!$this->rollBackFtp) {
            $this->rollBackFtp = ObjectManager::getInstance()->create(
                Ftp::class,
                ['snapshotObject' => $this]
            );
        }

        return $this->rollBackFtp;
    }

getType()

getType

(

)

Get backup type

Returns

string

See also

BackupInterface::getType()

Implements BackupInterface.

Definition at line 206 of file Filesystem.php.

    {
        return 'filesystem';
    }

rollback()

rollback

(

)

Implementation Rollback functionality for Filesystem

Exceptions

LocalizedException

Returns

bool

Implements BackupInterface.

Definition at line 85 of file Filesystem.php.

    {
        $this->_lastOperationSucceed = false;

        set_time_limit(0);
        ignore_user_abort(true);

        $rollbackWorker = $this->_useFtp ? $this->getRollBackFtp() : $this->getRollBackFs();
        $rollbackWorker->run();

        $this->_lastOperationSucceed = true;
        return $this->_lastOperationSucceed;
    }

setBackupsDir()

setBackupsDir

(

$backupsDir

)

Set directory where backups saved and add it to ignore paths

Parameters

string

$backupsDir

Returns

$this

See also

AbstractBackup::setBackupsDir()

Implements BackupInterface.

Definition at line 250 of file Filesystem.php.

    {
        parent::setBackupsDir($backupsDir);
        $this->addIgnorePaths($backupsDir);
        return $this;
    }

setUseFtp()

setUseFtp	(		$host,
			$username,
			$password,
			$path
	)

Force class to use ftp for rollback procedure

Parameters

string	$host
string	$username
string	$password
string	$path

Returns

$this

Definition at line 189 of file Filesystem.php.

    {
        $this->_useFtp = true;
        $this->_ftpHost = $host;
        $this->_ftpUser = $username;
        $this->_ftpPass = $password;
        $this->_ftpPath = $path;
        return $this;
    }

validateAvailableDiscSpace()

validateAvailableDiscSpace	(		$backupDir,
			$size
	)

Validate if disk space is available for creating backup

Parameters

string	$backupDir
int	$size

Returns

void

Exceptions

LocalizedException

Definition at line 166 of file Filesystem.php.

    {
        $freeSpace = disk_free_space($backupDir);
        $requiredSpace = 2 * $size;
        if ($requiredSpace > $freeSpace) {
            throw new NotEnoughFreeSpace(
                new Phrase(
                    'Warning: necessary space for backup is ' . (ceil($requiredSpace) / 1024)
                    . 'MB, but your free disc space is ' . (ceil($freeSpace) / 1024) . 'MB.'
                )
            );
        }
    }

Field Documentation

$_ftpHost

$_ftpHost

protected

Definition at line 46 of file Filesystem.php.

$_ftpPass

$_ftpPass

protected

Definition at line 60 of file Filesystem.php.

$_ftpPath

$_ftpPath

protected

Definition at line 67 of file Filesystem.php.

$_ftpUser

$_ftpUser

protected

Definition at line 53 of file Filesystem.php.

$_ignorePaths

$_ignorePaths = []

protected

Definition at line 32 of file Filesystem.php.

$_useFtp

$_useFtp = false

protected

Definition at line 39 of file Filesystem.php.

$rollBackFs

$rollBackFs

protected

Definition at line 77 of file Filesystem.php.

$rollBackFtp

$rollBackFtp

protected

Definition at line 72 of file Filesystem.php.

---

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

• vendor/magento/framework/Backup/Filesystem.php