SpecialOfferRepositoryInterface
in
Interface SpecialOfferRepositoryInterface
Table of Contents
- delete() : void
- Deletes the given special offer from the storage.
- getAll() : SpecialOfferCollection
- Returns all special offers.
- getBy() : SpecialOfferCollection
- Returns all special offers that matches the given search condition.
- getById() : SpecialOfferInterface
- Returns a special offer by the given id.
- save() : SpecialOfferInterface
- Saves or updates the given special offer in the storage.
Methods
delete()
Deletes the given special offer from the storage.
public
delete(SpecialOfferInterface $specialOffer) : void
Parameters
- $specialOffer : SpecialOfferInterface
-
Special offer to be removed.
Return values
void —getAll()
Returns all special offers.
public
getAll([Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : SpecialOfferCollection
Parameters
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
SpecialOfferCollection —List of special offers.
getBy()
Returns all special offers that matches the given search condition.
public
getBy(SpecialOfferSearchCondition $searchCondition[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : SpecialOfferCollection
Parameters
- $searchCondition : SpecialOfferSearchCondition
-
Condition that must match for found items.
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
SpecialOfferCollection —List of special offers by given conditions.
getById()
Returns a special offer by the given id.
public
getById(SpecialOfferIdInterface $specialOfferId) : SpecialOfferInterface
Parameters
- $specialOfferId : SpecialOfferIdInterface
-
Id of expected special offer.
Tags
Return values
SpecialOfferInterface —Special offer entity by given id.
save()
Saves or updates the given special offer in the storage.
public
save(SpecialOfferInterface $specialOffer) : SpecialOfferInterface
Parameters
- $specialOffer : SpecialOfferInterface
-
Special offer to be saved.