aDatabaseTask

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

class

aDatabaseTask

Shared ground for the tasks that touch a target's database (BackupTask,

abstract class MMO\admin\classes\aDatabaseTask extends MMO\admin\classes\aDeployTask

Namespace: MMO\admin\classes
Extends: aDeployTask
See: RestoreTask, MigrateTask).

The repository does the actual work -- [`MongoRepository::backup`](https://mcp.mmoframework.fr/documentation/mmo.mongodb/php/MongoRepository.md#mongorepository-backup) already takes an `iShell` and transparently runs `mongodump` on the other side, then pulls the archive back. That abstraction was the one genuinely well-factored piece of the old production script, so these tasks reuse it rather than re-implementing it, and mmo.admin does NOT depend on mmo.mongodb: the three methods it needs are checked at runtime, and a repository without them gets a clear error instead of a fatal.

Index

	REQUIRED
	getDatabase($context)
	getRepository($context)
	getShell($context)
	snapshot($context)	Take a snapshot of the target's database and record it on the context, so whatever comes next is reversible.

Constants1

REQUIRED

const REQUIRED = ['backup', 'restore', 'patch', 'getBackupName']

Methods4

getDatabase($context)

aDatabaseTask.php:46

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

$context	Context
returns	string	the database name on the target.
throws		when the target declares none.

getRepository($context)

aDatabaseTask.php:27

protected function getRepository(MMO\admin\helpers\Context $context): object

$context	Context
returns	object	the repository, guaranteed to support the backup/restore/patch trio.
throws		when the run has no repository, or one that cannot do this.

getShell($context)

aDatabaseTask.php:86

protected function getShell(MMO\admin\helpers\Context $context): ?MMO\core\interfaces\iShell

$context	Context
returns	null \| iShell	the shell the repository should run its mongo commands through (null means local).

snapshot($context)

aDatabaseTask.php:61

Take a snapshot of the target's database and record it on the context, so whatever comes next is reversible. Every mutating database task calls this FIRST -- in the old script this was a habit (route_reset did it by hand, restore and patch did not); here it is the only way in.

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

$context	Context
returns	null \| string	the backup's filename on the target (null during a dry run).

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
`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.
`apply($context)`	aDeployTask	Perform the task. Must throw on failure: returning normally is taken to mean the step ran.
`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.
`getDescription()`	aDeployTask
`getName()`	aDeployTask
`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.
`isRollbackCritical()`	aDeployTask
`log($level, $message, $context)`	aDeployTask	Logs with an arbitrary level.
`notice($message, $context)`	aDeployTask	Normal but significant events.
`plan($context)`	aDeployTask	Describe what `apply` would do, WITHOUT doing it.
`rollback($context)`	aDeployTask	Undo this task. Called by the runner, in reverse order, for every task already applied when a later one failed.
`setVerbosity($verb)`	aDeployTask	Set the current verbosity mask, replacing whatever it was before.
`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.