RatingService
extends ApiService
in package
implements
ServiceInterface
uses
SaveTrait
Front service that reads entities through the mapper.
Tags
Table of Contents
Interfaces
- ServiceInterface
- Contract of the front service layer.
Properties
Methods
- __construct() : mixed
- canRespondTo() : bool
- Pass-through to the mapper. `$mapper` is a concrete type with the guaranteed method here (no `method_exists` guard).
- find() : T|null
- Finds one entity by id.
- findAll() : T>, 1: int}
- Finds all entities matching the criteria.
- findBy() : T|null
- Finds one entity by filters.
- getTotalCount() : int|null
- myVotes() : array<int, bool>
- Pass-through to the mapper. How the visitor voted on the displayed ratings (batch for the whole page).
- report() : Result
- Reports an inappropriate review.
- save() : Result
- saveReply() : Result
- Pass-through to the mapper. The rating reply has its own Api action `saveReply` with its own key and its own ownership check.
- updateColumns() : Result
- vote() : Result
- Pass-through to the mapper. Vote on the helpfulness of a rating.
Properties
$mapper read-only
protected
RatingMapper
$mapper
Methods
__construct()
public
__construct(RatingMapper $mapper) : mixed
Parameters
- $mapper : RatingMapper
canRespondTo()
Pass-through to the mapper. `$mapper` is a concrete type with the guaranteed method here (no `method_exists` guard).
public
canRespondTo(int $ratingId, int $userId) : bool
Parameters
- $ratingId : int
- $userId : int
Return values
boolfind()
Finds one entity by id.
public
find(int $id[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $id : int
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
T|nullfindAll()
Finds all entities matching the criteria.
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()
Finds one entity by filters.
public
findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed>|null $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $filters : array<string|int, mixed>|null = []
- $includes : string|array<string|int, mixed>|null = []
- $useCache : bool|null = null
Return values
T|nullgetTotalCount()
public
getTotalCount() : int|null
Return values
int|nullmyVotes()
Pass-through to the mapper. How the visitor voted on the displayed ratings (batch for the whole page).
public
myVotes(array<int, int> $ratingIds, int|null $userId, string $ip) : array<int, bool>
Parameters
- $ratingIds : array<int, int>
- $userId : int|null
- $ip : string
Return values
array<int, bool>report()
Reports an inappropriate review.
public
report(int $ratingId, int|null $userId, string $ip) : Result
Parameters
- $ratingId : int
- $userId : int|null
- $ip : string
Return values
Resultsave()
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
ResultsaveReply()
Pass-through to the mapper. The rating reply has its own Api action `saveReply` with its own key and its own ownership check.
public
saveReply(int $ratingId, string|null $response) : Result
Parameters
- $ratingId : int
- $response : string|null
Return values
ResultupdateColumns()
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
Resultvote()
Pass-through to the mapper. Vote on the helpfulness of a rating.
public
vote(int $ratingId, bool $up, int|null $userId, string $ip) : Result
Parameters
- $ratingId : int
- $up : bool
- $userId : int|null
- $ip : string