BackupJob
in package
Table of Contents
- $backupDestinations : Collection
- $dbDumpers : Collection
- $filename : string
- $fileSelection : FileSelection
- $sendNotifications : bool
- $temporaryDirectory : TemporaryDirectory
- __construct() : mixed
- disableNotifications() : self
- dontBackupDatabases() : self
- dontBackupFilesystem() : self
- filesToBeBackedUp() : mixed
- onlyBackupTo() : self
- onlyDbName() : self
- run() : mixed
- setBackupDestinations() : self
- setDbDumpers() : self
- setDefaultFilename() : self
- setFilename() : self
- setFileSelection() : self
- copyToBackupDestinations() : mixed
- createBackupManifest() : Manifest
- createZipContainingEveryFileInManifest() : mixed
- directoriesUsedByBackupJob() : array<string|int, mixed>
- dumpDatabases() : array<string|int, mixed>
- Dumps the databases to the given directory.
- sendNotification() : mixed
Properties
$backupDestinations
protected
Collection
$backupDestinations
$dbDumpers
protected
Collection
$dbDumpers
$filename
protected
string
$filename
$fileSelection
protected
FileSelection
$fileSelection
$sendNotifications
protected
bool
$sendNotifications
= true
$temporaryDirectory
protected
TemporaryDirectory
$temporaryDirectory
Methods
__construct()
public
__construct() : mixed
Return values
mixed —disableNotifications()
public
disableNotifications() : self
Return values
self —dontBackupDatabases()
public
dontBackupDatabases() : self
Return values
self —dontBackupFilesystem()
public
dontBackupFilesystem() : self
Return values
self —filesToBeBackedUp()
public
filesToBeBackedUp() : mixed
Return values
mixed —onlyBackupTo()
public
onlyBackupTo(string $diskName) : self
Parameters
- $diskName : string
Return values
self —onlyDbName()
public
onlyDbName(array<string|int, mixed> $allowedDbNames) : self
Parameters
- $allowedDbNames : array<string|int, mixed>
Return values
self —run()
public
run() : mixed
Return values
mixed —setBackupDestinations()
public
setBackupDestinations(Collection $backupDestinations) : self
Parameters
- $backupDestinations : Collection
Return values
self —setDbDumpers()
public
setDbDumpers(Collection $dbDumpers) : self
Parameters
- $dbDumpers : Collection
Return values
self —setDefaultFilename()
public
setDefaultFilename() : self
Return values
self —setFilename()
public
setFilename(string $filename) : self
Parameters
- $filename : string
Return values
self —setFileSelection()
public
setFileSelection(FileSelection $fileSelection) : self
Parameters
- $fileSelection : FileSelection
Return values
self —copyToBackupDestinations()
protected
copyToBackupDestinations(string $path) : mixed
Parameters
- $path : string
Return values
mixed —createBackupManifest()
protected
createBackupManifest() : Manifest
Return values
Manifest —createZipContainingEveryFileInManifest()
protected
createZipContainingEveryFileInManifest(Manifest $manifest) : mixed
Parameters
- $manifest : Manifest
Return values
mixed —directoriesUsedByBackupJob()
protected
directoriesUsedByBackupJob() : array<string|int, mixed>
Return values
array<string|int, mixed> —dumpDatabases()
Dumps the databases to the given directory.
protected
dumpDatabases() : array<string|int, mixed>
Returns an array with paths to the dump files.
Return values
array<string|int, mixed> —sendNotification()
protected
sendNotification(mixed $notification) : mixed
Parameters
- $notification : mixed