• Home
• DNDataArchive

PHP Class DNDataArchive

The model can also represent a request to upload a file later, through offline processes like mailing a DVD. In order to associate and authenticate those requests easily, an upload token is generated for every archive. The "OriginalEnvironment" points to original source of this snapshot (the one it was backed up from). It will be empty if the snapshot has been created with offline process. The "Environment" denotes the ownership of the snapshot. It will be initially set to match the "OriginalEnvironment", but can be changed later. During the offline process the ownership can be set up arbitrarily. When moving snapshots, the file always remains in its initial location. The archive can have associations to {@link DNDataTransfer}: - Zero transfers if a manual upload was requested, but not fulfilled yet - One transfer with Direction=get for a backup from an environment - One or more transfers with Direction=push for a restore to an environment The "Author" is either the person creating the archive through a "backup" operation, the person uploading through a web form, or the person requesting a manual upload. The "Mode" is what the "Author" said the file includes (either 'only assets', 'only database', or both). This is used in the ArchiveList.ss template. Show file Open project: silverstripe/deploynaut Class Usage Examples

Public Methods

Method	Description
FileSize ( ) : string	Calculates and returns a human-readable size of this archive file. If the file exists, it will determine whether to display the output in bytes, kilobytes, megabytes, or gigabytes.
attachFile ( string $sspakFilepath, DNDataTransfer $dataTransfer ) : boolean	Attach an sspak file path to this archive and associate the transfer.
canDelete ( Member | null $member = null ) : boolean	Whether a {@link Member} can delete this archive from staging area.
canDownload ( Member | null $member = null ) : true	Whether a {@link Member} can download this archive to their PC.
canMoveTo ( DNEnvironment $targetEnv, Member | null $member = null ) : boolean	Check if this member can move archive into the environment.
canRestore ( Member | null $member = null ) : true	Whether a {@link Member} can restore this archive to an environment.
canView ( Member | null $member = null )	Inferred from both restore and backup permissions.
extractArchive ( string | null $workingDir = null ) : boolean	Extract the current sspak contents into the given working directory.
fixArchivePermissions ( string | null $workingDir ) : boolean	Given a path that already exists and contains an extracted sspak, including the assets, fix all of the file permissions so they're in a state ready to be pushed to remote servers.
generateFilename ( DNDataTransfer $dataTransfer ) : string	Returns a unique filename, including project/environment/timestamp details.
generateFilepath ( DNDataTransfer $dataTransfer ) : string	Returns a path unique to a specific transfer, including project/environment details.
generate_upload_token ( $chars = 8 ) : string	Returns a unique token to correlate an offline item (posted DVD) with a specific archive placeholder.
getCMSFields ( )
getDefaultSearchContext ( )
getModeNice ( )
get_mode_map ( )
isPending ( ) : boolean	Some archives don't have files attached to them yet, because a file has been posted offline and is waiting to be uploaded against this "archive placeholder".
onAfterDelete ( )
onBeforeWrite ( )
setArchiveFromFiles ( string | null $workingDir ) : boolean	Given extracted sspak contents, create an sspak from it and overwrite the current ArchiveFile with it's contents.
validTargetEnvironments ( ) : ArrayList	Finds all environments within this project where the archive can be moved to.
validateArchiveContents ( string | null $mode = null ) : ValidationResult	Validate that an sspak contains the correct content.

Method Details