CoolCMS API

FeedMapper extends ApiMapper
in package

FinalYes

Admin mapper that hydrates Api repository data into entities.

Tags
extends

Table of Contents

Properties

$hydrator  : EntityHydrator
$repository  : FeedRepository

Methods

__construct()  : mixed
delete()  : Result
deleteAll()  : Result
find()  : T|null
findAll()  : T>, 1: int}
findBy()  : T|null
getCategoryRels()  : array<int, array<string, mixed>>
Returns the mapping of a single category to a value per feed (category form).
getParameterRels()  : array<int, array<string, mixed>>
getParameterRelsForSet()  : array<int, array<string, mixed>>
Returns the overrides of a single product set ("Feeds" tab of the set).
getParameterTree()  : array<int, array<string, mixed>>
save()  : Result
saveCategoryRels()  : array{success: bool, message: ?string, data: mixed, code: ?int}
saveParameterRels()  : array{success: bool, message: ?string, data: mixed, code: ?int}
saveParameterRelsForSet()  : array{success: bool, message: ?string, data: mixed, code: ?int}
saveParameterTree()  : array{success: bool, message: ?string, data: mixed, code: ?int}
updateColumns()  : Result
getEntityClass()  : T>
initalizeEntity()  : Feed|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

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

getCategoryRels()

Returns the mapping of a single category to a value per feed (category form).

public getCategoryRels(int $categoryId) : array<int, array<string, mixed>>
Parameters
$categoryId : int
Return values
array<int, array<string, mixed>>

getParameterRels()

public getParameterRels(int $feedId) : array<int, array<string, mixed>>
Parameters
$feedId : int
Return values
array<int, array<string, mixed>>

getParameterRelsForSet()

Returns the overrides of a single product set ("Feeds" tab of the set).

public getParameterRelsForSet(int $productSetId) : array<int, array<string, mixed>>
Parameters
$productSetId : int
Return values
array<int, array<string, mixed>>

getParameterTree()

public getParameterTree(int $feedId) : array<int, array<string, mixed>>
Parameters
$feedId : int
Return values
array<int, array<string, mixed>>

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

saveCategoryRels()

public saveCategoryRels(int $categoryId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
$categoryId : int
$rows : array<int, array<string, mixed>>
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterRels()

public saveParameterRels(int $feedId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
$feedId : int
$rows : array<int, array<string, mixed>>
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterRelsForSet()

public saveParameterRelsForSet(int $productSetId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
$productSetId : int
$rows : array<int, array<string, mixed>>
Return values
array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterTree()

public saveParameterTree(int $feedId, array<int, array<string, mixed>> $tree) : array{success: bool, message: ?string, data: mixed, code: ?int}
Parameters
$feedId : int
$tree : array<int, array<string, mixed>>
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

getEntityClass()

protected getEntityClass() : T>
Return values
T>

initalizeEntity()

protected initalizeEntity(array<string, mixed> $row) : Feed|null
Parameters
$row : array<string, mixed>
Return values
Feed|null
On this page

Search results