PHP Class DNDataTransfer

It can be one of two directions: - Backup: Package up data on an environment and store it in a local file - Restore: Transfer data from a local file into an environment, extract assets and/or restore a database The choice of database and/or assets is represented in the "Mode". There's always one file archive involved (stored as the has_one "ArchiveFile") on the local Deploynaut environment. Each transfer is executed by a Resque job, so the model also contains a reference to a Resque token (which might still be in progress). The "Environment" points to the source or target involved.

Inheritance: extends DataObject

Show file Open project: silverstripe/deploynaut Class Usage Examples

Protected Properties

Property	Type	Description
$backupBeforePush	boolean	When running the transfer, should a backup be performed before pushing the data?

Public Methods

Method	Description
IsBackupDataTransfer ( ) : boolean	Is this transfer an automated backup prior to a push transfer or deployment?
Link ( )
LogContent ( ) : string
LogLink ( )
ResqueStatus ( ) : string	Returns the status of the resque job
canView ( Member \| null $member = null ) : boolean
getCMSFields ( )
getDefaultSearchContext ( )
getDescription ( )
getModeNice ( )
getTitle ( )
log ( ) : DeploynautLogFile
map_resque_status ( integer $int ) : string
setBackupBeforePush ( boolean $value )
start ( )	Queue a transfer job

Protected Methods

Method	Description
logfile ( ) : string	Return a path to the log file.

Method Details

IsBackupDataTransfer() public method

Is this transfer an automated backup prior to a push transfer or deployment?

public IsBackupDataTransfer ( ) : boolean
return	boolean

Link() public method

public Link ( )

LogContent() public method

public LogContent ( ) : string
return	string

LogLink() public method

public LogLink ( )

ResqueStatus() public method

Returns the status of the resque job

public ResqueStatus ( ) : string
return	string

canView() public method

public canView ( Member \| null $member = null ) : boolean
$member	Member \| null
return	boolean

getCMSFields() public method

public getCMSFields ( )

getDefaultSearchContext() public method

public getDefaultSearchContext ( )

getDescription() public method

public getDescription ( )

getModeNice() public method

public getModeNice ( )

getTitle() public method

public getTitle ( )

log() public method

public log ( ) : DeploynautLogFile
return	DeploynautLogFile

logfile() protected method

Return a path to the log file.

protected logfile ( ) : string
return	string

map_resque_status() public static method

public static map_resque_status ( integer $int ) : string
$int	integer
return	string

setBackupBeforePush() public method

public setBackupBeforePush ( boolean $value )
$value	boolean

start() public method

Queue a transfer job

public start ( )

Property Details

$backupBeforePush protected property

When running the transfer, should a backup be performed before pushing the data?

protected bool $backupBeforePush
return	boolean