CoolCMS API

ProductImportMapper extends ApiMapper
in package

FinalYes

Admin mapper that hydrates Api repository data into entities.

Tags
extends

Table of Contents

Properties

$hydrator  : EntityHydrator
$repository  : ProductImportRepository

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}
find()  : T|null
findAll()  : T>, 1: int}
findBy()  : T|null
getRunStatus()  : array{success: bool, message: ?string, data: mixed, code: ?int}
getStatistics()  : array{success: bool, message: ?string, data: mixed, code: ?int}
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}
getEntityClass()  : T>
initalizeEntity()  : ProductImport|null

Properties

Methods

delete()

public delete(int|array<string|int, mixed> $id) : Result
Parameters
$id : int|array<string|int, mixed>
Return values
Result

deleteAll()

public deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
$filters : array<string|int, mixed> = []
Return values
Result

enqueue()

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()

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 $pageId[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
$pageId : int
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

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 ]) : T>, 1: int}
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
T>, 1: int}

findBy()

public findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
$filters : array<string|int, mixed>|null = []
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

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()

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(BaseEntity $entity[, array<string, mixed> $meta = [] ][, array<int, string> $skipFields = [] ]) : Result
Parameters
$entity : BaseEntity
$meta : array<string, mixed> = []
$skipFields : array<int, string> = []
Return values
Result

setState()

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
Result

validate()

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}
On this page

Search results