PHP Class Spatie\Backup\Tasks\Monitor\BackupDestinationStatus

Show file Open project: spatie/laravel-backup Class Usage Examples

Protected Properties

Property Type Description
$backupDestination Spatie\Backup\BackupDestination\BackupDestination
$diskName string
$maximumAgeOfNewestBackupInDays integer
$maximumStorageUsageInMegabytes integer
$reachable boolean

Public Methods

Method Description
__construct ( BackupDestination $backupDestination, string $diskName )
amountOfBackups ( ) : integer
backupDestination ( ) : BackupDestination
backupName ( ) : string
connectionError ( ) : Exception
dateOfNewestBackup ( ) : Carbon\Carbon | null
diskName ( ) : string
humanReadableAllowedStorage ( ) : string
humanReadableUsedStorage ( ) : string
isHealthy ( ) : boolean
isReachable ( ) : boolean
maximumAgeOfNewestBackupInDays ( ) : integer
maximumAllowedUsageInBytes ( ) : integer
newestBackupIsTooOld ( ) : boolean
setMaximumAgeOfNewestBackupInDays ( integer $days ) : BackupDestinationStatus
setMaximumStorageUsageInMegabytes ( float $megabytes ) : BackupDestinationStatus
usedStorage ( ) : integer
usesTooMuchStorage ( ) : boolean

Method Details

__construct() public method

public __construct ( BackupDestination $backupDestination, string $diskName )
$backupDestination Spatie\Backup\BackupDestination\BackupDestination
$diskName string

amountOfBackups() public method

public amountOfBackups ( ) : integer
return integer

backupDestination() public method

public backupDestination ( ) : BackupDestination
return Spatie\Backup\BackupDestination\BackupDestination

backupName() public method

public backupName ( ) : string
return string

connectionError() public method

public connectionError ( ) : Exception
return Exception

dateOfNewestBackup() public method

public dateOfNewestBackup ( ) : Carbon\Carbon | null
return Carbon\Carbon | null

diskName() public method

public diskName ( ) : string
return string

humanReadableAllowedStorage() public method

public humanReadableAllowedStorage ( ) : string
return string

humanReadableUsedStorage() public method

public humanReadableUsedStorage ( ) : string
return string

isHealthy() public method

public isHealthy ( ) : boolean
return boolean

isReachable() public method

public isReachable ( ) : boolean
return boolean

maximumAgeOfNewestBackupInDays() public method

public maximumAgeOfNewestBackupInDays ( ) : integer
return integer

maximumAllowedUsageInBytes() public method

public maximumAllowedUsageInBytes ( ) : integer
return integer

newestBackupIsTooOld() public method

public newestBackupIsTooOld ( ) : boolean
return boolean

setMaximumAgeOfNewestBackupInDays() public method

public setMaximumAgeOfNewestBackupInDays ( integer $days ) : BackupDestinationStatus
$days integer
return BackupDestinationStatus

setMaximumStorageUsageInMegabytes() public method

public setMaximumStorageUsageInMegabytes ( float $megabytes ) : BackupDestinationStatus
$megabytes float
return BackupDestinationStatus

usedStorage() public method

public usedStorage ( ) : integer
return integer

usesTooMuchStorage() public method

public usesTooMuchStorage ( ) : boolean
return boolean

Property Details

$backupDestination protected property

protected BackupDestination,Spatie\Backup\BackupDestination $backupDestination
return Spatie\Backup\BackupDestination\BackupDestination

$diskName protected property

protected string $diskName
return string

$maximumAgeOfNewestBackupInDays protected property

protected int $maximumAgeOfNewestBackupInDays
return integer

$maximumStorageUsageInMegabytes protected property

protected int $maximumStorageUsageInMegabytes
return integer

$reachable protected property

protected bool $reachable
return boolean