PHP Class Spatie\Backup\Tasks\Backup\BackupJob

Show file Open project: spatie/laravel-backup

Protected Properties

Property Type Description
$backupDestinations Illuminate\Support\Collection
$dbDumpers Illuminate\Support\Collection
$fileSelection FileSelection
$filename string
$temporaryDirectory TemporaryDirectory

Public Methods

Method Description
__construct ( )
dontBackupDatabases ( ) : BackupJob
dontBackupFilesystem ( ) : BackupJob
filesToBeBackedUp ( )
onlyBackupTo ( string $diskName ) : BackupJob
run ( )
setBackupDestinations ( Collection $backupDestinations ) : BackupJob
setDbDumpers ( Collection $dbDumpers ) : BackupJob
setDefaultFilename ( ) : BackupJob
setFileSelection ( FileSelection $fileSelection ) : BackupJob
setFilename ( string $filename ) : BackupJob

Protected Methods

Method Description
copyToBackupDestinations ( string $path )
createBackupManifest ( ) : Manifest
createZipContainingEveryFileInManifest ( Manifest $manifest )
directoriesUsedByBackupJob ( ) : array
dumpDatabases ( string $directory ) : array Dumps the databases to the given directory.

Method Details

__construct() public method

public __construct ( )

copyToBackupDestinations() protected method

protected copyToBackupDestinations ( string $path )
$path string

createBackupManifest() protected method

protected createBackupManifest ( ) : Manifest
return Manifest

createZipContainingEveryFileInManifest() protected method

protected createZipContainingEveryFileInManifest ( Manifest $manifest )
$manifest Manifest

directoriesUsedByBackupJob() protected method

protected directoriesUsedByBackupJob ( ) : array
return array

dontBackupDatabases() public method

public dontBackupDatabases ( ) : BackupJob
return BackupJob

dontBackupFilesystem() public method

public dontBackupFilesystem ( ) : BackupJob
return BackupJob

dumpDatabases() protected method

Returns an array with paths to the dump files.
protected dumpDatabases ( string $directory ) : array
$directory string
return array

filesToBeBackedUp() public method

public filesToBeBackedUp ( )

onlyBackupTo() public method

public onlyBackupTo ( string $diskName ) : BackupJob
$diskName string
return BackupJob

run() public method

public run ( )

setBackupDestinations() public method

public setBackupDestinations ( Collection $backupDestinations ) : BackupJob
$backupDestinations Illuminate\Support\Collection
return BackupJob

setDbDumpers() public method

public setDbDumpers ( Collection $dbDumpers ) : BackupJob
$dbDumpers Illuminate\Support\Collection
return BackupJob

setDefaultFilename() public method

public setDefaultFilename ( ) : BackupJob
return BackupJob

setFileSelection() public method

public setFileSelection ( FileSelection $fileSelection ) : BackupJob
$fileSelection FileSelection
return BackupJob

setFilename() public method

public setFilename ( string $filename ) : BackupJob
$filename string
return BackupJob

Property Details

$backupDestinations protected property

protected Collection,Illuminate\Support $backupDestinations
return Illuminate\Support\Collection

$dbDumpers protected property

protected Collection,Illuminate\Support $dbDumpers
return Illuminate\Support\Collection

$fileSelection protected property

protected FileSelection,Spatie\Backup\Tasks\Backup $fileSelection
return FileSelection

$filename protected property

protected string $filename
return string

$temporaryDirectory protected property

protected TemporaryDirectory,Spatie\Backup\Tasks\Backup $temporaryDirectory
return TemporaryDirectory