ImportJob

MMO\core\jobs · 1 symbol · generated 27 Oct 2026

class

ImportJob

An import as a long job (aJob): the importers of a configuration (Importer::FromMultipleConfigs), each reading its rows, one after the other, with each row's entities given to row before they are committed.

abstract class MMO\core\jobs\ImportJob extends MMO\core\jobs\aJob

Namespace: MMO\core\jobs
Extends: aJob

What [`ImportSocket`](https://mmoframework.fr/en/documentation/mmo.core/php/ImportSocket.md#importsocket) did over a websocket, followed instead like any job (`<mmo-job>`). A subclass gives the configuration ([`config`](https://mmoframework.fr/en/documentation/mmo.core/php/jobs/ImportJob.md#importjob-config)) and the rows of each importer ([`data`](https://mmoframework.fr/en/documentation/mmo.core/php/jobs/ImportJob.md#importjob-data)); [`row`](https://mmoframework.fr/en/documentation/mmo.core/php/jobs/ImportJob.md#importjob-row) checks or changes a row's entities, and [`ignore`](https://mmoframework.fr/en/documentation/mmo.core/php/jobs/ImportJob.md#importjob-ignore) drops one. It reports: - its progress, importer by importer (`{key}: row/rows`); - each row that failed (a log error), each entity left invalid (an html table at the end); - its result: by importer, by variable, how many were created, updated, ignored and invalid. Params (on top of the subclass's own): - `keys` (?array): only these importers, by key; - `dryRun` (bool): read and convert everything, commit nothing (relations to entities created by the same run are then not found).

class ProductsImportJob extends ImportJob { protected function config(array $params): string|array {return \MMO\filename('{root}/import/products.json');} protected function data(int|string $key, Importer $importer, array $params): ?iterable { return \MMO\core\files\csv(\MMO\filename("{root}/import/$key.csv")); } protected function row(int|string $index, array &$row, int|string $key, Importer $importer): void { if (empty($row['product']['sku'])) {$this->ignore($row, 'product');} } }

Index

	counts
	importer
	key
	config($params) abstract
	count($row, $invalid)	Count a row's entities by variable: created, updated, unchanged (ignored), invalid.
	countReport()
	data($key, $importer, $params) abstract	The rows an importer reads.
	ignore($row, $name)	Drop an entity of the row: it is not committed, and counted `ignored`.
	importers($params)
	invalidReport($invalid)
	row($index, $row, $key, $importer)	A row's entities, before they are committed: check them, change them, `ignore` some.
	run($params)
	Title() static
	total($key, $rows, $params)	How many rows an importer reads, for its progress.

Properties3

counts

protected array $counts = []

Type: array

importer

protected ?MMO\core\entities\Importer $importer = null

Type: null | Importer

key

protected string|int $key = ''

Type: string | int

Methods11

config($params)

abstractImportJob.php:50

abstract protected function config(array $params): array|string

$params	array
returns	array \| string	the importers' configuration: a json file, a folder of them, or the configuration itself (`Importer::FromMultipleConfigs`)

count($row, $invalid)

ImportJob.php:170

Count a row's entities by variable: created, updated, unchanged (ignored), invalid.

protected function count(array $row, array &$invalid): void

$row	array
$invalid	array	the invalid ones, once each
returns	void

countReport()

ImportJob.php:185

protected function countReport(): string

returns

string

the counts, as an html table

data($key, $importer, $params)

abstractImportJob.php:59

The rows an importer reads.

abstract protected function data(string|int $key, MMO\core\entities\Importer $importer, array $params): ?iterable

$key	string \| int	the importer's key in the configuration
$importer	Importer
$params	array
returns	null \| iterable	null to skip the importer

ignore($row, $name)

ImportJob.php:159

Drop an entity of the row: it is not committed, and counted ignored.

protected function ignore(array &$row, string $name): MMO\core\interfaces\iEntity|array|null

$row	array
$name	string	its variable
returns	iEntity \| array \| null	what was dropped

importers($params)

ImportJob.php:90

protected function importers(array $params): array

$params	array
returns	array	Importer> the importers, by key: those of `config`

invalidReport($invalid)

ImportJob.php:203

protected function invalidReport(array $invalid): string

$invalid	array
returns	string	the invalid entities and their errors, as an html table

row($index, $row, $key, $importer)

ImportJob.php:79

A row's entities, before they are committed: check them, change them, ignore some.

protected function row( string|int $index, array &$row, string|int $key, MMO\core\entities\Importer $importer ): void

$index	string \| int	the row's index in the importer's data
$row	array	the entities of the row, by variable name
$key	string \| int	the importer's key
$importer	Importer
returns	void

run($params)

ImportJob.php:94

function run(array $params): mixed

$params	array
returns	mixed

Title()

staticImportJob.php:82

static function Title(): string

returns

string

what the import is: its importers run one after the other

total($key, $rows, $params)

ImportJob.php:68

How many rows an importer reads, for its progress.

protected function total(string|int $key, iterable $rows, array $params): ?int

$key	string \| int
$rows	iterable	what `data` returned
$params	array
returns	null \| int	null when unknown (a progress without a percentage)

Inherited members (56)

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
	`heartbeatInterval`	aJob
	`id`	aJob
	`lastHeartbeat`	aJob
	`lastProgress`	aJob
	`otherVerbosity`	aJob
	`progress`	aJob
	`progressInterval`	aJob
	`progressSent`	aJob
	`stopped`	aJob
	`store`	aJob
	`verbosity`	aJob

Methods	Declared by	Description
`alert($message, $context)`	aJob	Action must be taken immediately.
`backtraces($message, $context)`	aJob	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)`	aJob	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aJob	Detailed debug information.
`debugName()`	aJob
`emergency($message, $context)`	aJob	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`emit($type, $data)`	aJob	Add an event of any type to the job's events (`JobStore::emit`).
`error($message, $context)`	aJob	Runtime errors that do not require immediate action but should typically be logged and monitored.
`Exclusive()`	aJob
`flushProgress($record)`	aJob	Send the last progress if `progress` skipped it (what the job ends with).
`getId()`	aJob
`getStore()`	aJob
`getVerbosity()`	aJob
`heartbeat($changes, $force)`	aJob	Refresh the record's heartbeat (with $changes), at most every `$heartbeatInterval` seconds.
`html($html)`	aJob	Show an html fragment as is (a report, a table): the people following the job see it in its log.
`info($message, $context)`	aJob	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`isStopped()`	aJob
`log($level, $message, $context)`	aJob	Logs with an arbitrary level.
`notice($message, $context)`	aJob	Normal but significant events.
`progress($done, $total, $label)`	aJob	Say how far the job is.
`requestStop()`	aJob	Ask the job to stop from inside its own process (what `JobRunner` does on SIGTERM).
`setVerbosity($verb)`	aJob	Set the current verbosity mask, replacing whatever it was before.
`shouldStop()`	aJob	Whether the job was asked to stop (`JobStore::stop`, or SIGTERM): call it in loops, and return when true.
`testVerbosity($level)`	aJob	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`warning($message, $context)`	aJob	Exceptional occurrences that are not errors.
`__construct($store, $id)`	aJob