CountryService
extends ApiService
in package
uses
VatIdCheckTrait
FinalYes
Admin service that delegates reads to the mapper.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- delete() : Result
- deleteAll() : Result
- fetchVatIdCheckHistory() : array<string, mixed>
- fetchVatIdVerification() : array<string, 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.
- getTotalCount() : int|null
- save() : Result
- saveVatIdManual() : Result
- updateColumns() : Result
Properties
$mapper read-only
protected
CountryMapper
$mapper
Methods
__construct()
public
__construct(CountryMapper $mapper) : mixed
Parameters
- $mapper : CountryMapper
delete()
public
delete(int|array<string|int, mixed> $id) : Result
Parameters
- $id : int|array<string|int, mixed>
Return values
ResultdeleteAll()
public
deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
- $filters : array<string|int, mixed> = []
Return values
ResultfetchVatIdCheckHistory()
public
fetchVatIdCheckHistory(string $number, string|null $countryCode) : array<string, mixed>
Parameters
- $number : string
- $countryCode : string|null
Return values
array<string, mixed>fetchVatIdVerification()
public
fetchVatIdVerification(string $vatId, bool $forceOnline, string|null $countryCode[, bool $automatic = false ]) : array<string, mixed>
Parameters
- $vatId : string
- $forceOnline : bool
- $countryCode : string|null
- $automatic : bool = false
Return values
array<string, mixed>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|nullgetTotalCount()
public
getTotalCount() : int|null
Return values
int|nullsave()
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
ResultsaveVatIdManual()
public
saveVatIdManual(string $countryCode, string $vatNumber, bool $valid, string $note) : Result
Parameters
- $countryCode : string
- $vatNumber : string
- $valid : bool
- $note : string
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