RegionService
extends ApiService
in package
implements
ServiceInterface
Front service that reads entities through the mapper.
Tags
Table of Contents
Interfaces
- ServiceInterface
- Contract of the front service layer.
Properties
Methods
- __construct() : mixed
- 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.
- findLocality() : RegionLocality|null
- geocode() : GeocodingLookup
- getTotalCount() : int|null
- suggest() : RegionSuggestResult
Properties
$mapper read-only
protected
RegionMapper
$mapper
Methods
__construct()
public
__construct(RegionMapper $mapper) : mixed
Parameters
- $mapper : RegionMapper
find()
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|nullfindLocality()
public
findLocality(int $id, int $languageId) : RegionLocality|null
Parameters
- $id : int
- $languageId : int
Tags
Return values
RegionLocality|nullgeocode()
public
geocode(string $text, int $languageId, int|null $preferRegionId) : GeocodingLookup
Parameters
- $text : string
- $languageId : int
- $preferRegionId : int|null
Tags
Return values
GeocodingLookupgetTotalCount()
public
getTotalCount() : int|null
Return values
int|nullsuggest()
public
suggest(RegionSuggestQuery $query) : RegionSuggestResult
Parameters
- $query : RegionSuggestQuery