Fasáda Imports

Všetko ide cez jednu fasádu RoundlyConsulting\Imports\Facades\Imports, ktorá je nadstavbou nad singletonom ImportsManager. Je zaregistrovaná aj ako globálny alias Imports:

use RoundlyConsulting\Imports\Enums\{SessionStatus, TemplateFormat};
use RoundlyConsulting\Imports\Facades\Imports;

// Importers and templates
Imports::importers()->available($user, $team);
Imports::register(AssetsImporter::class);
Imports::importer('assets')->descriptor('sk');
Imports::template('assets', TemplateFormat::Xlsx, locale: 'sk')->download();

// Everything for one owner — the entry point HTTP code uses
$imports = Imports::for($team)->by($user);
$session = $imports->upload('assets', $request->file('file'));
$files = $imports->uploadFiles('documents', $request->file('files'));
$imports->sessions('assets', SessionStatus::Previewed)->paginate();
$imports->session($id)->counts();
$imports->batch($id)->summary();
$imports->mappings('assets')->all();
$imports->running('assets');

// Trusted paths, the reader and housekeeping
Imports::session($model); Imports::batch($id);
Imports::read($request->file('file'));
Imports::sweep(); Imports::prune();

Celý proces od začiatku do konca:

$session = Imports::for($team)->by($user)->upload('assets', $request->file('file'));   // checked + stored
$session->suggestMapping();                       // MappingSuggestion (applied already when complete)
$session->map(['Inventory no' => 'asset_tag', 'Name' => 'name'])   // optional: by header text or column number
    ->saveMapping('ERP export');                  // optional: reused for identical headers
$session->mode(DuplicateMode::Update)->preview(); // ≤ 500 rows: now; more: queued (poll isPreviewed())
$session->counts();                               // ImportCounts
$session->rows(RowFilter::invalid())->paginate(50);
$batch = $session->commit();                      // a Laravel job batch
$batch->progress();
$batch->summary();
$batch->rollback();                               // within imports.undo.window

Metódy manažéra

container() a perform() sú na manažéri verejné, ale interné — perform() je lievik, cez ktorý každý handle spúšťa svoju akciu, a háčik, cez ktorý zaznamenáva fake. Z kódu aplikácie ich nevolajte.

Imports::for($owner)

$sheet je názov (presne, potom bez ohľadu na veľkosť písmen) alebo poradie od 1 medzi viditeľnými hárkami; $headerRow sa číta od 1; $locale je jazyk relácie — popisy, správy a desatinný oddeľovač.

Handle relácie

Metódy, ktoré niečo menia, vracajú handle, takže sa dajú reťaziť. Čítanie sa pýta na authorize(View) raz za handle; zápisy na vlastnú operáciu. Zmena zdroja, mapovania a režimu, náhľad aj zahodenie sa odmietnu výnimkou ImportStateException, keď reláciu drží import:

Handle dávky

Importéry, šablóny a uložené mapovania

• Imports::importers() — all() (každá ImportDefinition), find($key), has($key), describe($key, ?$locale), available(?$user, $owner, ?$locale).
• Imports::importer($key) — descriptor(?$locale), template(?$format, ?$locale), modes() (prázdne pri importéri súborov).
• Template — vlastnosti format a filename; download(?$filename), store($disk, $path), toTemporaryFile(?$target), contents().
• Imports::for($owner)->mappings($importer) — all(), find($name), save($name, $columns), delete($name).
• RowQuery ($session->rows($filter)) — paginate($perPage = 50, ?$page), cursor(), count().

Hodnotové objekty, DTO a enumy

• Definície (Definition\): Field, NaturalKey, Ownership, ChangeDetection, FileRules, FileDuplicates, Limits, FieldChange. Argumenty callbackov (Rows\): ImportRow, ImportContext, ImportFile. Čítanie (Reading\): SpreadsheetFile, Cell, ReadOptions.
• DTO (final readonly): ImportSource, UploadData, UploadFilesData, SaveMappingData, ColumnMapping, MappedColumn, MappingSuggestion, SuggestedColumn, SavedMapping, SheetInfo, ImportCounts, ImportPreview, RowFilter, RowResult, CellError, RecordReference, Progress, ImportSummary, RollbackReport, ImportedRecordView, ImportAudit, FileReference, ImporterDescriptor, FieldDescriptor, OptionDescriptor, PruneReport, SweepReport, DoctorFinding.
• Modely (vymeniteľné cez imports.models.*): ImportSession, ImportBatch, ImportRowResult, ImportedRecord. ImportSession a ImportBatch majú handle() a countOf(string $key) — jeden uložený počet (valid, creates, created, …), 0, ak chýba; statické ImportSession::count() je počet riadkov z Eloquentu.
• Enumy majú reťazcové hodnoty, používajú pomocníkov z enums-for-laravel (label(), labels(), options(), values(), fromLabel(), is(), …) a ich popisy sú preložené do angličtiny a slovenčiny: