Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
AbstractBackup Class Reference
Inheritance diagram for AbstractBackup:
BackupInterface SourceFileInterface Db Filesystem Snapshot Media Nomedia

Public Member Functions

 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)
 
- Public Member Functions inherited from BackupInterface
 create ()
 
 rollback ()
 
 getType ()
 

Protected Member Functions

 _filterName ($name)
 

Protected Attributes

 $_name
 
 $_time
 
 $_backupExtension
 
 $_resourceModel
 
 $_rootDir
 
 $_backupsDir
 
 $_lastOperationSucceed = false
 
 $_lastErrorMessage
 

Detailed Description

Class to work with archives

@api

Since
100.0.2

Definition at line 17 of file AbstractBackup.php.

Member Function Documentation

◆ _filterName()

_filterName (   $name)
protected

Removes disallowed characters and replaces spaces with underscores

Parameters
string$name
Returns
string

Definition at line 302 of file AbstractBackup.php.

303  {
304  $name = trim(preg_replace('/[^\da-zA-Z ]/', '', $name));
305  $name = preg_replace('/\s{2,}/', ' ', $name);
306  $name = str_replace(' ', '_', $name);
307 
308  return $name;
309  }
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ getBackupExtension()

getBackupExtension ( )

Get Backup Extension

Returns
string

Definition at line 99 of file AbstractBackup.php.

◆ getBackupFilename()

getBackupFilename ( )

Get backup file name

Returns
string

Definition at line 213 of file AbstractBackup.php.

214  {
215  $filename = $this->getTime() . '_' . $this->getType();
216 
217  $name = $this->getName();
218 
219  if (!empty($name)) {
220  $filename .= '_' . $name;
221  }
222 
223  $filename .= '.' . $this->getBackupExtension();
224 
225  return $filename;
226  }
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ getBackupPath()

getBackupPath ( )

Get path to backup

Returns
string

Definition at line 203 of file AbstractBackup.php.

◆ getBackupsDir()

getBackupsDir ( )

Get path to directory where backups stored

Returns
string

Definition at line 193 of file AbstractBackup.php.

◆ getDisplayName()

getDisplayName ( )

Get backup display name

Returns
string

Definition at line 291 of file AbstractBackup.php.

292  {
293  return str_replace('_', ' ', $this->_name);
294  }

◆ getErrorMessage()

getErrorMessage ( )

Get last error message

Returns
string

Definition at line 244 of file AbstractBackup.php.

◆ getIsSuccess()

getIsSuccess ( )

Check whether last operation completed successfully

Returns
bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 234 of file AbstractBackup.php.

◆ getName()

getName ( )

Get backup name

Returns
string

Definition at line 281 of file AbstractBackup.php.

◆ getResourceModel()

getResourceModel ( )

Get Resource Model

Returns
object

Definition at line 121 of file AbstractBackup.php.

◆ getRootDir()

getRootDir ( )

Get Magento's root directory

Returns
string

Definition at line 171 of file AbstractBackup.php.

◆ getTime()

getTime ( )

Get Time

Returns
int

Definition at line 143 of file AbstractBackup.php.

◆ keepSourceFile()

keepSourceFile ( )

Check if keep files of backup

Returns
bool

Implements SourceFileInterface.

Definition at line 316 of file AbstractBackup.php.

317  {
318  return $this->keepSourceFile;
319  }

◆ setBackupExtension()

setBackupExtension (   $backupExtension)

Set Backup Extension

Parameters
string$backupExtension
Returns
$this

Implements BackupInterface.

Definition at line 88 of file AbstractBackup.php.

89  {
90  $this->_backupExtension = $backupExtension;
91  return $this;
92  }

◆ setBackupsDir()

setBackupsDir (   $backupsDir)

Set path to directory where backups stored

Parameters
string$backupsDir
Returns
$this

Implements BackupInterface.

Definition at line 182 of file AbstractBackup.php.

183  {
184  $this->_backupsDir = $backupsDir;
185  return $this;
186  }

◆ setErrorMessage()

setErrorMessage (   $errorMessage)

Set error message

Parameters
string$errorMessage
Returns
void

Definition at line 255 of file AbstractBackup.php.

256  {
257  $this->_lastErrorMessage = $errorMessage;
258  }

◆ setKeepSourceFile()

setKeepSourceFile ( bool  $keepSourceFile)

Set if keep files of backup

Parameters
bool$keepSourceFile
Returns
$this

Implements SourceFileInterface.

Definition at line 327 of file AbstractBackup.php.

328  {
329  $this->keepSourceFile = $keepSourceFile;
330  return $this;
331  }

◆ setName()

setName (   $name,
  $applyFilter = true 
)

Set backup name

Parameters
string$name
bool$applyFilter
Returns
$this

Definition at line 267 of file AbstractBackup.php.

268  {
269  if ($applyFilter) {
270  $name = $this->_filterName($name);
271  }
272  $this->_name = $name;
273  return $this;
274  }
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ setResourceModel()

setResourceModel (   $resourceModel)

Set Resource Model

Parameters
object$resourceModel
Returns
$this

Implements BackupInterface.

Definition at line 110 of file AbstractBackup.php.

111  {
112  $this->_resourceModel = $resourceModel;
113  return $this;
114  }
$resourceModel
Definition: tablerates.php:10

◆ setRootDir()

setRootDir (   $rootDir)

Set root directory of Magento installation

Parameters
string$rootDir
Exceptions
LocalizedException
Returns
$this

Definition at line 155 of file AbstractBackup.php.

156  {
157  if (!is_dir($rootDir)) {
158  throw new LocalizedException(
159  new Phrase('Bad root directory')
160  );
161  }
162 
163  $this->_rootDir = $rootDir;
164  return $this;
165  }
$rootDir
Definition: website.php:12

◆ setTime()

setTime (   $time)

Set Time

Parameters
int$time
Returns
$this

Implements BackupInterface.

Definition at line 132 of file AbstractBackup.php.

133  {
134  $this->_time = $time;
135  return $this;
136  }

Field Documentation

◆ $_backupExtension

$_backupExtension
protected

Definition at line 38 of file AbstractBackup.php.

◆ $_backupsDir

$_backupsDir
protected

Definition at line 59 of file AbstractBackup.php.

◆ $_lastErrorMessage

$_lastErrorMessage
protected

Definition at line 73 of file AbstractBackup.php.

◆ $_lastOperationSucceed

$_lastOperationSucceed = false
protected

Definition at line 66 of file AbstractBackup.php.

◆ $_name

$_name
protected

Definition at line 24 of file AbstractBackup.php.

◆ $_resourceModel

$_resourceModel
protected

Definition at line 45 of file AbstractBackup.php.

◆ $_rootDir

$_rootDir
protected

Definition at line 52 of file AbstractBackup.php.

◆ $_time

$_time
protected

Definition at line 31 of file AbstractBackup.php.


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