ProductImportRepository
extends ApiRepository
in package
FinalYes
Bridge repository of the product import job: generic CRUD (save, get-all, delete) plus dedicated actions outside the generic save (like `FeedRepository`): {@see setState()}, {@see validate()} (dry run) and {@see getValidationReport()} (one page of the row log).
Table of Contents
Properties
- $apiEndpoint : string
- Api presenter path (e.g. `api/system/page`); set by each concrete repository.
- $bridge : ApiBridge
Methods
- __construct() : mixed
- delete() : Result
- deleteAll() : Result
- enqueue() : array{success: bool, message: ?string, data: mixed, code: ?int}
- export() : array{success: bool, message: ?string, data: mixed, code: ?int}
- Exports the catalog in the import format, without a job.
- find() : array<string|int, mixed>
- findAll() : array<string|int, mixed>
- findBy() : array<string|int, mixed>
- getRunStatus() : array{success: bool, message: ?string, data: mixed, code: ?int}
- getStatistics() : array{success: bool, message: ?string, data: mixed, code: ?int}
- Returns the run summary for a period plus the last N jobs.
- getValidationReport() : array{success: bool, message: ?string, data: mixed, code: ?int}
- runNow() : array{success: bool, message: ?string, data: mixed, code: ?int}
- save() : Result
- setState() : array{success: bool, message: ?string, data: mixed, code: ?int}
- updateColumns() : Result
- validate() : array{success: bool, message: ?string, data: mixed, code: ?int}
- failSoftRead() : array<string|int, mixed>
- Normalizes a bridge response to plain data; a failed envelope or a non-array gives `[]`.
- getApiCallSource() : string
- Branch marker for writes ({@see ApiBridge::PARAM_SOURCE}), read by the shared repository `SaveTrait`.
- normalize() : array{success: bool, message: ?string, data: mixed, code: ?int}
Properties
$apiEndpoint
Api presenter path (e.g. `api/system/page`); set by each concrete repository.
protected
string
$apiEndpoint
= 'api/eshop/product-import'
$bridge read-only
protected
ApiBridge
$bridge
Methods
__construct()
public
__construct(ApiBridge $bridge) : mixed
Parameters
- $bridge : ApiBridge
delete()
public
delete(int|array<string|int, mixed> $id) : Result
Parameters
- $id : int|array<string|int, mixed>
Return values
ResultdeleteAll()
public
deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
- $filters : array<string|int, mixed> = []
Return values
Resultenqueue()
public
enqueue(int $id) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}export()
Exports the catalog in the import format, without a job.
public
export(array<int, int> $productIds, array<int, int> $productSetIds, array<int, string> $languages, bool $includeIds, array<int, string> $sections) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $productIds : array<int, int>
- $productSetIds : array<int, int>
- $languages : array<int, string>
- $includeIds : bool
- $sections : array<int, string>
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}find()
public
find(int $id[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : array<string|int, mixed>
Parameters
- $id : int
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
array<string|int, mixed>findAll()
public
findAll([array<string|int, mixed>|null $filters = [] ][, array<string|int, mixed>|null $orderBys = null ][, int|null $offset = null ][, int|null $limit = null ][, array<string|int, mixed>|null $columns = null ][, bool $computeTotalCount = false ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : array<string|int, mixed>
Parameters
- $filters : array<string|int, mixed>|null = []
- $orderBys : array<string|int, mixed>|null = null
- $offset : int|null = null
- $limit : int|null = null
- $columns : array<string|int, mixed>|null = null
- $computeTotalCount : bool = false
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
array<string|int, mixed>findBy()
public
findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : array<string|int, mixed>
Parameters
- $filters : array<string|int, mixed>|null = []
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
array<string|int, mixed>getRunStatus()
public
getRunStatus(int $id) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}getStatistics()
Returns the run summary for a period plus the last N jobs.
public
getStatistics(string|null $from, string|null $to, int $limit) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $from : string|null
- $to : string|null
- $limit : int
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}getValidationReport()
public
getValidationReport(int $id, int $page, int $perPage, string|null $level[, string $phase = 'validate' ]) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
- $page : int
- $perPage : int
- $level : string|null
- $phase : string = 'validate'
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}runNow()
public
runNow(int $id) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}save()
public
save(array<string, mixed> $data[, array<string, mixed> $meta = [] ][, array<int, string> $skipFields = [] ]) : Result
Parameters
- $data : array<string, mixed>
-
extracted entity payload
- $meta : array<string, mixed> = []
- $skipFields : array<int, string> = []
Return values
ResultsetState()
public
setState(int $id, string $state) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
- $state : string
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}updateColumns()
public
updateColumns(array<string|int, mixed> $ids, array<string, mixed> $values) : Result
Parameters
- $ids : array<string|int, mixed>
-
ids or composite-id arrays
- $values : array<string, mixed>
-
property name => new value
Return values
Resultvalidate()
public
validate(int $id) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $id : int
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}failSoftRead()
Normalizes a bridge response to plain data; a failed envelope or a non-array gives `[]`.
protected
failSoftRead(mixed $response, string $endpoint) : array<string|int, mixed>
NOTE: it does not log on purpose. ApiBridge::call(), which sees both the
endpoint and the caller, has already written the API_FAILSOFT source=bridge line; a second
copy would turn one failure into three lines in auth.log.
Parameters
- $response : mixed
- $endpoint : string
-
only for call readability; the log takes the endpoint from the bridge
Return values
array<string|int, mixed>getApiCallSource()
Branch marker for writes ({@see ApiBridge::PARAM_SOURCE}), read by the shared repository `SaveTrait`.
protected
getApiCallSource() : string
Return values
stringnormalize()
private
normalize(mixed $result) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
- $result : mixed