GravityKit\GravityMigrate\Background\RunSummary
Describes a run in progress to somebody who did not start it.
An administrator opening this page while a colleague's export is halfway through cannot see the choices, did not make them, and is offered only Cancel. Without the details, cancelling somebody else's work rests on a sentence that does not say whose run it is or what it covers.
Every read is defensive. This runs during the settings page build, and a half-written option, a deleted user or a form since removed must degrade to saying less rather than to a fatal on a page whose job is to report the run.
Since: %ver%
Source: src/Background/RunSummary.php:28
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Background
Methods
| Method | Description |
|---|---|
describe() | What the running migration covers. |
Method Reference
describe()
public static function describe( string $type ): array
What the running migration covers.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$type | string | 'export' or 'import'. |
Returns
array{startedBy:— string, isYou: bool, startedAt: int, startedAtLabel: string, formCount: int, formNames: string[], dataTypes: string[]}
Since: %ver%
Source: src/Background/RunSummary.php:48