RestoreTask

MMO\admin\tasks · 1 symbol · generated 5 Oct 2026

class

RestoreTask

Replace the target's database with the content of a dump.

class MMO\admin\tasks\RestoreTask extends MMO\admin\classes\aDatabaseTask

Namespace: MMO\admin\tasks
Extends: aDatabaseTask

The single most destructive operation in the whole package, so it is the one with the most guardrails: - it always takes a snapshot of what it is about to overwrite FIRST ([`aDatabaseTask::snapshot`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/classes/aDatabaseTask.md#adatabasetask-snapshot)), and puts that snapshot in the journal, so "restore the wrong file" is recoverable rather than terminal; - it never picks a file for you: `--file=` is required, and a local file is uploaded to the target's own backup folder before being restored, so the restore always reads from the target's disk.

Index

	apply($context)
	getDescription()
	isRollbackCritical()
	plan($context)
	resolveFile($context)
	rollback($context)	Put back the snapshot taken before the restore.

Methods6

apply($context)

RestoreTask.php:27

function apply(MMO\admin\helpers\Context $context): void

$context	Context
returns	void

getDescription()

RestoreTask.php:18

function getDescription(): string

returns

string

isRollbackCritical()

RestoreTask.php:61

function isRollbackCritical(): bool

returns

bool

plan($context)

RestoreTask.php:20

function plan(MMO\admin\helpers\Context $context): array

$context	Context
returns	array

resolveFile($context)

RestoreTask.php:68

protected function resolveFile(MMO\admin\helpers\Context $context): string

$context	Context
returns	string
throws		when no dump was named.

rollback($context)

RestoreTask.php:54

Put back the snapshot taken before the restore.

function rollback(MMO\admin\helpers\Context $context): void

$context	Context
returns	void

Inherited members (43)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`REQUIRED`	aDatabaseTask
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aDeployTask

Methods	Declared by	Description
`alert($message, $context)`	aDeployTask	Action must be taken immediately.
`backtraces($message, $context)`	aDeployTask	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`critical($message, $context)`	aDeployTask	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aDeployTask	Detailed debug information.
`debugName()`	aDeployTask
`emergency($message, $context)`	aDeployTask	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aDeployTask	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getDatabase($context)`	aDatabaseTask
`getName()`	aDeployTask
`getRepository($context)`	aDatabaseTask
`getShell($context)`	aDatabaseTask
`getVerbosity()`	aDeployTask
`info($message, $context)`	aDeployTask	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`isChange()`	aDeployTask	Whether running this task CHANGES anything.
`isNeeded($context)`	aDeployTask	Whether this task has anything to do for this target -- e.g.
`log($level, $message, $context)`	aDeployTask	Logs with an arbitrary level.
`notice($message, $context)`	aDeployTask	Normal but significant events.
`setVerbosity($verb)`	aDeployTask	Set the current verbosity mask, replacing whatever it was before.
`snapshot($context)`	aDatabaseTask	Take a snapshot of the target's database and record it on the context, so whatever comes next is reversible.
`testVerbosity($level)`	aDeployTask	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`verify($context)`	aDeployTask	Check, by looking at the target, that the task really took effect.
`warning($message, $context)`	aDeployTask	Exceptional occurrences that are not errors.