CoolCMS API

VatIdCheckManager extends Manager
in package

Application

Evidence of VAT id checks and the verification policy.

Policy (verify()), the latest decisive check of the country_code + vat_number pair wins:

manual + valid → verified, no expiry (valid until the VAT id changes — a new pair has no row);
manual + invalid → not verified, never overridden online (the admin decided);
CacheOnly (display, preview, later pairing of a payment): vies + valid and checked_at ≥ date − FRESH_DAYS days → verified; otherwise not verified (VAT_ID_NOT_VERIFIED);
RefreshStale = submit of an order / payment, the supply date: VIES is asked online, at most once a day per VAT id — a decisive vies answer from the same day is taken from the evidence (valid → verified, invalid → not verified, no second call). On an outage the outage row is stored as proof (outageCheckId) and the latest valid check ≤ FRESH_DAYS days still decides (VIES_UNAVAILABLE); without one the customer is not verified.

A VIES outage (valid = NULL) is stored as proof but never decides on its own: the latest decisive row (valid / invalid) still applies: a valid check ≤ 30 days keeps the customer a business, flagged VIES_UNAVAILABLE. Without this the outage row would hide it and the customer would fall to a consumer.

Online rate limit (VatIdCheckLimit, config/Shared/ratelimit.neon → vatIdCheck): only a real VIES call counts (checked before, hit after the call); an answer from the evidence never does. An exhausted limit skips VIES and answers like an unavailable VIES — the stored row if any, otherwise not verified — plus VAT_ID_CHECK_LIMIT_REACHED. null limit = unlimited (privileged role, admin / CLI code).

Never blocks: a failing insert (e.g. before sql/2026-09-15_21_vat_id_checks.sql) is logged and the online answer is still used, only without checkId.

Not final: stubbed in tests/Unit/System/TaxManagerTest.php for the classification cases.

Constants

FRESH_DAYS : int = 30: A VIES check at most 30 days before the supply is acceptable.
HISTORY_LIMIT : int = 10: Rows of the admin history of one VAT id / registration number (admin history).
DELETED_IDS_META : string = '__deletedIds': Reserved `$meta` key with the ids of the entities being deleted, captured before the first hook.

Properties

$service : Service<string|int, TEntity>: Manager service; subclasses narrow the type (`@property` in the Api/Admin/Front manager).
$appContext : AppContext
$assetFormatRegistry : AssetFormatRegistry|null: Format processor registry for file uploads, used by {@see \App\Core\Traits\Api\Models\Managers\AssetProcessingTrait}.
$cacheTagInvalidator : CacheTagInvalidator|null: Post-commit invalidator of the wire-payload query cache (tag bump per entity class).
$internalCallContext : InternalCallContext|null: Tells whether the call is an internal bridge call; the single source for reading uploaded items with `path` ({@see readUploadedItem()}).
$languageContext : LanguageContext|null
$nonInvalidatingColumns : array<string|int, string>: Columns whose update does not invalidate the cache: view counters (`registerEvent()` bumps the counter on every pageview). Without this every view would flush the query cache of the whole class; counters are therefore stale up to the TTL. Override per manager by redefining the property.
$paramsConfig : Config|null: Neon parameters (`%params%`: server paths and directories), set by the decorator (`decorators.neon`) like `setAppContext()`.
$presenterContext : PresenterContext
$settingContext : SettingContext
$totalCount : int|null
$useTransactionForDelete : bool
$useTransactionForSave : bool
$countryManager : CountryManager
$rateLimit : RateLimit
$rateLimitConfig : RateLimitConfig
$rejectedUploads : array<int, array{name: string, reason: string}>: New uploaded items that the Api did not save during the `save()` that is running right now (type, dimensions, unreadable, …). Filled by {@see recordRejectedUpload()} and returned in `saveInfo.rejectedUploads`.
$vatIdCheckService : VatIdCheckService
$viesClient : ViesClient

Methods

__construct() : mixed
buildAutoCheckLimit() : VatIdCheckLimit|null: Safety cap of the automatic online checks on a payment / order submit (`RefreshStale`) — per IP, a separate counter from the button. Null (unlimited) for a privileged role or when `vatIdCheck.autoIpLimit` ≤ 0.
buildUserCheckLimit() : VatIdCheckLimit|null: Limit of the "verify VAT id" button (`verify` with `forceOnline`) — per user, per IP for a caller without identity.
delete() : Result: Deletes the entity or entities by id. Optional hooks (opt-in via `method_exists`, like {@see SaveTrait}) allow cleanup of derived or denormalized state during the delete:
deleteAll() : Result
find() : T|null
findAll() : T> : list>)
findBusinessEvidence() : VatIdVerification|null: Evidence of a non-EU business: the latest decisive record of the pair is a valid manual record ("document business"). It never changes the class — the declaration decides and `BUSINESS_STATUS_DECLARED` stays — it only gives the snapshot `customer_vat_id_check_id`. Null = no evidence (a VIES row never counts outside the EU).
findBy() : T|null
findHistory() : VatIdCheckHistoryRow>}: Admin history of the evidence of one customer record (newest first, VIES outages included) — read only.
findOnlineCheckAllowance() : VatIdCheckAllowance: Remaining online checks without consuming one — the UI hides the button when `canCheckOnline()` is false.
findRelatedIds() : array<int, int>|null: Returns the ids of target entities that already belong to the record `$parentId` through the relation collection `$property` (for example `('assetRels', 'asset')`, `('fileRels', 'file')`). Reads straight from the database, not through the Api read path (no `UoW::clear()` in the middle of save hooks).
getAppContext() : AppContext
getDefaultSkipFields() : array<string|int, string>: Returns keys that the generic `service->save()` must not copy onto the managed entity.
getEntityClass() : TEntity>: Returns the root Doctrine entity class managed by this manager.
getExternalMetaAllowlist() : array<string|int, string>: Returns the meta keys allowed through the external HTTP path ({@see \App\Core\Traits\Api\Presenters\SaveTrait::actionSave()}).
getExternalOwnerData() : array<string, mixed>: Returns `data` keys that fill the owner from the server when an external save creates a record.
getExternalRemoteIpData() : array<string, mixed>: Returns `data` keys that fill the caller's IP from the server when an external save creates a record; sibling of {@see getExternalOwnerData()}.
getExternalUpdateColumnsAllowlist() : array<string|int, string>: Returns the columns the external HTTP path may change through {@see \App\Core\Traits\Api\Presenters\SaveTrait::actionUpdateColumns()}.
getGraphDataKeys() : array<string|int, string>: Returns the keys an external client may send nested in `data`.
getLanguageContext() : LanguageContext|null
getPresenterContext() : PresenterContext
getServiceClass() : class-string: Returns the fully qualified service class name, the identity for the per-service rollout allowlist of the wire-payload query cache ({@see \App\Core\Cache\Config::isServiceEnabled()}).
getSettingContext() : SettingContext
getSettings() : array<int, array<string, mixed>>
getTotalCount() : int|null
initializeAllContexts() : void
registerEvent() : Result
resolveEvidencePair() : TaxCountry, number: string, nonEuBusiness: bool}|null: Pair (country + number) under which the evidence of a customer record is stored and read: - address country outside the EU on `$at` → that country + the number without its own prefix — the business evidence of a non-EU customer ("document business"); a letter pair of the number is never read as an EU prefix, - otherwise the pair of {@see verify()}: the VAT id prefix wins, the address country is the fallback.
resolveVatIdCountry() : TaxCountry|null: ISO country of a VAT id: its prefix wins, otherwise the fallback (address) country.
save() : Result
saveManual() : Result: Manual verification by an admin ("verify manually" / "document business") — the note with the evidence is mandatory. Works for non-EU countries too (registration number as `vatNumber`).
setAppContext() : $this
setAssetFormatRegistry() : static
setCacheTagInvalidator() : static
setInternalCallContext() : static
setLanguageContext() : $this
setParamsConfig() : static
setPresenterContext() : $this
setSettingContext() : $this
updateAllRelations() : Result
updateColumn() : Result
updateColumns() : Result
updateRelations() : Result
verify() : VatIdVerification
beginRejectedUploads() : array<int, array{name: string, reason: string}>: Starts a save ({@see save()}): the list of rejected items belongs to this save only; the outer one (a nested save of the same manager) is returned to the caller and restored after the save through {@see finishRejectedUploads()}.
bumpCacheTags() : void: Bumps cache tags for the entity after commit: its class, the owned-cascade classes from metadata and the optional `additionalCacheTags()` of the manager.
bumpCacheTagsExplicit() : void: Bumps the given classes explicitly (raw-DBAL paths with a cross-entity effect).
bumpCacheTagsForClass() : void: Bumps cache tags by class name when there is no instance (bulk delete, `updateColumns()`, raw DBAL, tree operations).
classCacheTags() : array<string|int, string>: Returns extra tags for a bump that has no entity, typically tree operations ({@see \App\Core\Traits\Api\Models\Managers\TreeTrait::treeTransaction()}) that rewrite `lft`/`rgt` on many rows.
finishRejectedUploads() : void: Ends a save: whatever {@see recordRejectedUpload()} wrote during it is added to the data of a successful result as `saveInfo.rejectedUploads` (the Api presenter passes it on to the caller, the admin builds a warning from it). A rejected item does not fail the save; the accepted files stay.
getDeletedId() : int|null: Returns the id `$entity` had before the delete, from the snapshot in `$meta` that {@see delete()} hands to every hook. Null for an entity the snapshot does not know (not loaded by this delete, or without a simple id).
getService() : Service<string|int, TEntity>: Returns the service backing the manager traits.
readUploadedItem() : string|null: Reads the content of an uploaded item (`{name, data}` base64 or `{name, path}` from the dropzone) through the single reader {@see UploadedItem}.
recordRejectedUpload() : void: Records a new uploaded item that the save skipped ({@see UploadRejection} `REASON_*`).
buildFromRow() : VatIdVerification|null: Verification from a stored row; null when the row does not decide (missing, or a stale / invalid VIES answer that the caller may refresh — the returned "not verified" is then built by the caller).
buildLimitReached() : VatIdVerification: Exhausted limit: no VIES call — the stored row decides like with an unavailable VIES (never verified by a stale answer), flagged so that the consumer can tell "limit" from "VIES outage".
bumpDeleteCacheTags() : void: Post-commit bump after a delete. With entities it goes through {@see \App\Core\Base\BaseManager::bumpCacheTags()}, which also collects `additionalCacheTags()` (Comment → CommentThread); without them it falls back to bumping the manager class itself, the original behavior.
captureDeletedIds() : WeakMap<object, int>: Keys the ids by the loaded entity objects, not by the input ids: an input id that loaded nothing must not shift the pairing. A weak map, so the snapshot never keeps an entity alive.
columnsInvalidateCache() : bool
deleteBatch() : Result: Bulk delete of a list of ids as one transaction. `Service::deleteAll()` flushes per entity; in autocommit the rows deleted before a database failure would stay deleted while the caller got either an escaped `EntityManagerClosed` or an "OK" with an error text. Here the service stops at the technical failure, this wrapper rolls the whole batch back and returns the failure Result with `deletedCount = 0` and `rolledBack = true`: nothing of the batch is durable and nothing is attempted over the closed EntityManager. A domain partial success (missing ids) keeps the existing contract and is committed.
findLatestDecisive() : VatIdCheckRow|null: Latest decisive row (a stored outage is skipped — see the class docblock).
fitColumn() : string|null: VIES texts are cut to the column length: an overflow would fail the save (strict `sql_mode`) or be cut silently.
isAssetPathAllowed() : bool: Checks only entities composing {@see AssetPathTrait}; the trait is the allowlist of "relative file path" columns, other `assetPath`-like fields are untouched.
isDecidedByEvidence() : bool: Does the stored decisive row answer without calling VIES? A manual check always; with `CacheOnly` a verified (fresh) VIES answer; with `RefreshStale` only a VIES answer from the supply day itself (once a day).
loadEntitiesForCacheTags() : array<int, object>: Loads the entities being deleted only to find out their `additionalCacheTags()`. Fail-soft: what cannot be loaded is simply missing and the bump falls back to the class; it must never stop the delete.
normalizeNumberFor() : string|null: Number stored for a manual record of `$country`: separators dropped, upper-cased, the country's own VAT prefix stripped (any other letter pair is part of the number — e.g. a registration number of a non-EU company).
resolveVerification() : VatIdVerification: The policy of {@see verify()} without the allowance.
rollbackBatch() : void
saveWithHooks() : Result: Runs the save itself: transaction, `beforeSave` / `afterSave` / `completedSave`, tree, cache.
storeViesResult() : int
usesAssetPathTrait() : bool
verifyOnline() : VatIdVerification

FRESH_DAYS

A VIES check at most 30 days before the supply is acceptable.


    public
        int
    FRESH_DAYS
    = 30

HISTORY_LIMIT

Rows of the admin history of one VAT id / registration number (admin history).


    public
        int
    HISTORY_LIMIT
    = 10

DELETED_IDS_META

Reserved `$meta` key with the ids of the entities being deleted, captured before the first hook.


    protected
        string
    DELETED_IDS_META
    = '__deletedIds'

Read it only through getDeletedId().

$service

Manager service; subclasses narrow the type (`@property` in the Api/Admin/Front manager).


        public
            Service<string|int, TEntity>
    $service

$appContext


        protected
            AppContext
    $appContext

$assetFormatRegistry

Format processor registry for file uploads, used by {@see \App\Core\Traits\Api\Models\Managers\AssetProcessingTrait}.


        protected
            AssetFormatRegistry|null
    $assetFormatRegistry
     = null

Set by a decorator (decorators.neon) like setParamsConfig(): more than ten managers process assets and each has its own constructor, so constructor injection would touch all of them.

$cacheTagInvalidator

Post-commit invalidator of the wire-payload query cache (tag bump per entity class).


        protected
            CacheTagInvalidator|null
    $cacheTagInvalidator
     = null

Set by the decorator (decorators.neon) like setParamsConfig(). Nullable and fail-open: without wiring (or without Redis) a bump is a no-op.

$internalCallContext

Tells whether the call is an internal bridge call; the single source for reading uploaded items with `path` ({@see readUploadedItem()}).


        protected
            InternalCallContext|null
    $internalCallContext
     = null

Only ApiBridge::internalCall() sets it, never the payload and not the RBAC guard, so the emergency apiRbac.internalMode: off cannot disable it. Set by a decorator like setAssetFormatRegistry(). Without it (direct manager call from cron or a test) the call counts as external.

$languageContext


        protected
            LanguageContext|null
    $languageContext
     = NULL

$nonInvalidatingColumns

Columns whose update does not invalidate the cache: view counters (`registerEvent()` bumps the counter on every pageview). Without this every view would flush the query cache of the whole class; counters are therefore stale up to the TTL. Override per manager by redefining the property.


        protected
            array<string|int, string>
    $nonInvalidatingColumns
     = ['views', 'viewsList', 'viewsDetail']

Covers all view counters across modules: views (Blog Article), viewsList (list impression of Advert/Message) and viewsDetail (detail view of Advert/Message, registerEvent() in the *DetailTraits). IMPORTANT: viewsDetail must stay in the list, otherwise every open of an advert/post detail would invalidate all lists of the class.

$paramsConfig

Neon parameters (`%params%`: server paths and directories), set by the decorator (`decorators.neon`) like `setAppContext()`.


        protected
            Config|null
    $paramsConfig
     = null

Write logic (asset directories) reads paths from here, not from getSettings() or the setting context, which may be filled by the client without server paths. The property cannot be named $config: it collides with the promoted $config in some managers.

$presenterContext


        protected
            PresenterContext
    $presenterContext

$settingContext


        protected
            SettingContext
    $settingContext

$totalCount


        protected
            int|null
    $totalCount
     = null

$useTransactionForDelete


        protected
            bool
    $useTransactionForDelete
     = true

$useTransactionForSave


        protected
            bool
    $useTransactionForSave
     = true

$countryManager read-only


        private
            CountryManager
    $countryManager

$rateLimit read-only


        private
            RateLimit
    $rateLimit

$rateLimitConfig read-only


        private
            RateLimitConfig
    $rateLimitConfig

$rejectedUploads

New uploaded items that the Api did not save during the `save()` that is running right now (type, dimensions, unreadable, …). Filled by {@see recordRejectedUpload()} and returned in `saveInfo.rejectedUploads`.


        private
            array<int, array{name: string, reason: string}>
    $rejectedUploads
     = []

$vatIdCheckService read-only


        private
            VatIdCheckService
    $vatIdCheckService

$viesClient read-only


        private
            ViesClient
    $viesClient

__construct()


    public
                    __construct(VatIdCheckService $vatIdCheckService, CountryManager $countryManager, ViesClient $viesClient, RateLimit $rateLimit, RateLimitConfig $rateLimitConfig) : mixed

Parameters

$vatIdCheckService : VatIdCheckService
$countryManager : CountryManager
$viesClient : ViesClient
$rateLimit : RateLimit
$rateLimitConfig : RateLimitConfig

buildAutoCheckLimit()

Safety cap of the automatic online checks on a payment / order submit (`RefreshStale`) — per IP, a separate counter from the button. Null (unlimited) for a privileged role or when `vatIdCheck.autoIpLimit` ≤ 0.


    public
                    buildAutoCheckLimit(string|null $ip, bool $privileged) : VatIdCheckLimit|null

Parameters

$ip : string|null
$privileged : bool

Return values

VatIdCheckLimit|null

buildUserCheckLimit()

Limit of the "verify VAT id" button (`verify` with `forceOnline`) — per user, per IP for a caller without identity.


    public
                    buildUserCheckLimit(int|null $userId, string|null $ip, bool $privileged) : VatIdCheckLimit|null

Null (unlimited) for a privileged role or when vatIdCheck.userLimit ≤ 0.

Parameters

$userId : int|null
$ip : string|null
$privileged : bool

Return values

VatIdCheckLimit|null

delete()

Deletes the entity or entities by id. Optional hooks (opt-in via `method_exists`, like {@see SaveTrait}) allow cleanup of derived or denormalized state during the delete:


    public
                    delete(int|array<string|int, mixed> $id[, array<string, mixed> $meta = [] ]) : Result

beforeDelete(array $entities, array $meta): ?Result runs before the delete (validation or capturing context while the rows exist). A failed Result means rollback and return. Its data flows into afterDelete under $meta['__beforeDelete'].
afterDelete(array $entities, Result $result, array $meta): ?Result runs after the delete, still in the transaction. It is only for recomputing derived state from the remaining rows (toped_until, member_until, county), idempotent and reversible. A failure rolls back the delete itself (atomicity). It is also the place for the mandatory delete of dependents through a foreign manager (comment, rating and message threads): an owner still managed in the unit of work references them, so they must go after its row, never before it in beforeDelete (collect their ids there). Additive or irreversible effects (credits, e-mails, invoices) do not belong here, only into completedDelete.
completedDelete(array $entities, Result $result, array $meta): void runs best effort after the commit, outside the transaction; an exception is only logged (the delete stays).
completedAssetCleanup(array $entities, Result $result, array $meta): void runs best effort after the commit and releases the Asset rows and files the deleted entity owned. The body is in AssetProcessingTrait; opt-in is ownedAssetIds(object $entity): array on the manager, without it the hook does not run.

IMPORTANT: the cleanup has its own name instead of completedDelete() because many Api managers define completedDelete() themselves and a class method overrides a trait method without a warning, so the cleanup would silently be missing in them.

IMPORTANT: a soft delete (deleted = 1) goes through save(), not here; assets must not be released there because the record can be restored.

$entities are the entities loaded before the delete (after the DELETE the row is gone, but the PHP object keeps the data, such as FKs for the recomputation).

IMPORTANT: the id is the exception. Doctrine nulls the id of a removed instance on flush(), so a hook must not rely on getId() once the delete ran (today only the read UoW::clear() in the service find() hands the preloaded entities over detached and keeps their id). Every hook therefore gets the ids captured before beforeDelete under the reserved key DELETED_IDS_META, keyed by the loaded entity object (an input id that loaded nothing has no entry); read it through getDeletedId(). The key is always set here, so a caller-supplied value never survives.

Without hooks it behaves exactly as before (no preloading, no transaction). NOTE: deleteAll() (bulk) and the tree deleteNode take another path and do not trigger these hooks.

Parameters

$id : int|array<string|int, mixed>
$meta : array<string, 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 $id[, string|array<string|int, mixed> $includes = [] ]) : T|null

Parameters

$id : int
$includes : string|array<string|int, mixed> = []

Return values

T|null

findAll()


    public
                    findAll([array<string|int, mixed>|null $includes = [] ][, 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 ]) : T> : list>)

Parameters

$includes : array<string|int, mixed>|null = []
$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

Return values

T> : list>) —

entities, or raw rows when $columns is set

findBusinessEvidence()

Evidence of a non-EU business: the latest decisive record of the pair is a valid manual record ("document business"). It never changes the class — the declaration decides and `BUSINESS_STATUS_DECLARED` stays — it only gives the snapshot `customer_vat_id_check_id`. Null = no evidence (a VIES row never counts outside the EU).


    public
                    findBusinessEvidence(string $number, TaxCountry $country) : VatIdVerification|null

Parameters

$number : string: VAT id or registration number as typed
$country : TaxCountry

Return values

VatIdVerification|null

findBy()


    public
                    findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed> $includes = [] ]) : T|null

Parameters

$filters : array<string|int, mixed>|null = []
$includes : string|array<string|int, mixed> = []

Return values

T|null

findHistory()

Admin history of the evidence of one customer record (newest first, VIES outages included) — read only.


    public
                    findHistory(string $number, string|null $addressCountryCode[, int $limit = self::HISTORY_LIMIT ]) : VatIdCheckHistoryRow>}

businessDocumented = non-EU business with a valid manual record ("document business").

Parameters

$number : string
$addressCountryCode : string|null
$limit : int = self::HISTORY_LIMIT

Return values

VatIdCheckHistoryRow>}

findOnlineCheckAllowance()

Remaining online checks without consuming one — the UI hides the button when `canCheckOnline()` is false.


    public
                    findOnlineCheckAllowance(VatIdCheckLimit|null $limit) : VatIdCheckAllowance

Parameters

$limit : VatIdCheckLimit|null

Return values

VatIdCheckAllowance

findRelatedIds()

Returns the ids of target entities that already belong to the record `$parentId` through the relation collection `$property` (for example `('assetRels', 'asset')`, `('fileRels', 'file')`). Reads straight from the database, not through the Api read path (no `UoW::clear()` in the middle of save hooks).


    public
                    findRelatedIds(int $parentId, string $property, string $targetAssociation) : array<int, int>|null

Parameters

$parentId : int
$property : string
$targetAssociation : string

Return values

array<int, int>|null —

null when it cannot be determined (collection mapping missing / database error)

getAppContext()


    public
                    getAppContext() : AppContext

Return values

AppContext

getDefaultSkipFields()

Returns keys that the generic `service->save()` must not copy onto the managed entity.


    public
                    getDefaultSkipFields() : array<string|int, string>

The manager's own afterSave()/beforeSave() sync trait handles them through $meta, not through the object graph. Backed by an optional protected per-manager property. The write Api endpoint (SaveTrait::internalActionSave()) also uses this accessor to strip the same keys from $data before hydration, because defaultSkipFields alone does not protect hydration.

Return values

array<string|int, string>

getEntityClass()

Returns the root Doctrine entity class managed by this manager.


    public
                    getEntityClass() : TEntity>

The write Api endpoint (SaveTrait) takes it from here instead of the request, so a client cannot choose the instantiated PHP class.

Return values

TEntity>

getExternalMetaAllowlist()

Returns the meta keys allowed through the external HTTP path ({@see \App\Core\Traits\Api\Presenters\SaveTrait::actionSave()}).


    public
                    getExternalMetaAllowlist() : array<string|int, string>

The internal path (ApiBridge::internalCall() calling internalActionSave() directly, admin and front) is not limited by this allowlist and reads $meta unchanged. The default is an empty array, so external meta is dropped entirely; actionSave() is reachable through HTTP routing regardless of ApiBridge, hence the strip. Override per manager with the protected property $externalMetaAllowlist, analogous to self::getDefaultSkipFields().

Return values

array<string|int, string>

getExternalOwnerData()

Returns `data` keys that fill the owner from the server when an external save creates a record.


    public
                    getExternalOwnerData(int $userId) : array<string, mixed>

The default [] means the domain has no owner or must not be created through external save (Order uses the dedicated checkout action, User registers another way). On INSERT there is nothing to own, so the owner cannot be verified, only determined: the owner field is #[ExternalReadonly] (the strip removes it from the payload) and SaveTrait::applyExternalOwner() then fills it from the JWT, so the client value never reaches hydration.

IMPORTANT: return the key that matches the column mapping, otherwise the owner is silently not written:

Watchdog/Comment/Rating/Message: scalar column, ['userId' => $userId];
Advert (Bazaar/Comcat): mapped column, ['insertUserId' => $userId];
Bazaar Response/AdvertFollower: the scalar userId has an #[ORM\AttributeOverride] with insertable: false, updatable: false in the Api leaf and the column belongs to the association $user, so ['user' => ['id' => $userId]]; Comcat Response has no $user association, so there it is ['userId' => $userId];
Complaint: the owner is the association $user, ['user' => ['id' => $userId]].

['id' => X] is a reference that hydrateForPersist() looks up in the DB (OrmEntityHydrator::isReference()). Called only on the external path and only on INSERT; on UPDATE it would make whoever saves a foreign record its owner.

Parameters

$userId : int: identity from the JWT (never from the request)

Return values

array<string, mixed>

getExternalRemoteIpData()

Returns `data` keys that fill the caller's IP from the server when an external save creates a record; sibling of {@see getExternalOwnerData()}.


    public
                    getExternalRemoteIpData(string $ip) : array<string, mixed>

The IP field is #[ExternalReadonly], so the external strip removes it and the client cannot forge it. Without filling, an external insert would have no IP and the "anonymous by IP" deduplication and per-IP manager limits would silently stop working. SaveTrait::applyExternalRemoteIp() fills it from IRequest::getRemoteAddress(), never from the request. The default [] means the entity carries no IP; overrides return the entity field name (['insertIp' => $ip]).

Parameters

$ip : string

Return values

array<string, mixed>

getExternalUpdateColumnsAllowlist()

Returns the columns the external HTTP path may change through {@see \App\Core\Traits\Api\Presenters\SaveTrait::actionUpdateColumns()}.


    public
                    getExternalUpdateColumnsAllowlist() : array<string|int, string>

updateColumn on a to-many relation is DELETE-all plus INSERT, so without this filter an external POST with values={userRoles: [...]} would bypass the strip/guard of the save path (privilege escalation). The internal path (ApiBridge::internalCall() calling internalActionUpdateColumns() directly) is not limited. The default is an empty array, so external updateColumns is rejected entirely. Override with the protected property $externalUpdateColumnsAllowlist.

Return values

array<string|int, string>

getGraphDataKeys()

Returns the keys an external client may send nested in `data`.


    public
                    getGraphDataKeys() : array<string|int, string>

Before hydration the write Api endpoint (SaveTrait::internalActionSave()) moves them from $data to $meta, where the manager's own afterSave()/beforeSave() sync trait reads them (the same mechanism as internal meta). When the client also sends the same key explicitly in meta, meta wins (compatibility with admin, e.g. the categoryRels collision on Advert). Backed by an optional protected per-manager property, like self::getDefaultSkipFields().

IMPORTANT: promoting a key here does not make its content safe to write as received. When the key carries a sensitive field that the server otherwise dictates (typically a payment or approval flag), the manager must overwrite or verify it server-side on the external path in beforeSave()/afterSave() before its sync trait reads it; otherwise the client sets it itself (privilege escalation). The external path is recognized by $meta['__external'] === true, which only SaveTrait::actionSave() sets (never internalActionSave() alone), so internal calls never get the marker. Example: Bazaar Advert.categoryRels is persisted through the object graph (owned collection outside $graphDataKeys); a client could mark paid itself and get a paid advert without payment, so AdvertManager::beforeSave() overwrites it through CategoryRelsPaidSanitizationTrait::sanitizeExternalCategoryRelsPaid() before flush.

Return values

array<string|int, string>

getLanguageContext()


    public
                    getLanguageContext() : LanguageContext|null

Return values

LanguageContext|null

getPresenterContext()


    public
                    getPresenterContext() : PresenterContext

Return values

PresenterContext

getServiceClass()

Returns the fully qualified service class name, the identity for the per-service rollout allowlist of the wire-payload query cache ({@see \App\Core\Cache\Config::isServiceEnabled()}).


    public
                    getServiceClass() : class-string

The cache is controlled at the Api presenter boundary through this identity.

Return values

class-string

getSettingContext()


    public
                    getSettingContext() : SettingContext

Return values

SettingContext

getSettings()


    public
                    getSettings() : array<int, array<string, mixed>>

Return values

array<int, array<string, mixed>>

getTotalCount()


    public
                    getTotalCount() : int|null

Return values

int|null

initializeAllContexts()


    public
                    initializeAllContexts() : void

registerEvent()


    public
                    registerEvent(array<string|int, int> $ids, class-string $entityClass, string $property) : Result

Parameters

$ids : array<string|int, int>
$entityClass : class-string: entity used to translate the property into a column in the expression
$property : string

Return values

Result

resolveEvidencePair()

Pair (country + number) under which the evidence of a customer record is stored and read: - address country outside the EU on `$at` → that country + the number without its own prefix — the business evidence of a non-EU customer ("document business"); a letter pair of the number is never read as an EU prefix, - otherwise the pair of {@see verify()}: the VAT id prefix wins, the address country is the fallback.


    public
                    resolveEvidencePair(string $number, string|null $addressCountryCode, DateTimeInterface $at) : TaxCountry, number: string, nonEuBusiness: bool}|null

Parameters

$number : string: VAT id, or the registration number of a non-EU business
$addressCountryCode : string|null
$at : DateTimeInterface

Return values

TaxCountry, number: string, nonEuBusiness: bool}|null —

null = no usable number / country

resolveVatIdCountry()

ISO country of a VAT id: its prefix wins, otherwise the fallback (address) country.


    public
                    resolveVatIdCountry(string $vatId, string|null $fallbackCountryCode) : TaxCountry|null

Parameters

$vatId : string
$fallbackCountryCode : string|null

Return values

TaxCountry|null

save()


    public
                    save(TEntity $entity[, array<string, mixed> $meta = [] ][, array<int, string> $skipFields = [] ]) : Result

Parameters

$entity : TEntity
$meta : array<string, mixed> = []
$skipFields : array<int, string> = []

Return values

Result

saveManual()

Manual verification by an admin ("verify manually" / "document business") — the note with the evidence is mandatory. Works for non-EU countries too (registration number as `vatNumber`).


    public
                    saveManual(string $countryCode, string $vatNumber, bool $valid, string $note, int|null $checkedByUserId[, string|null $name = null ][, string|null $address = null ]) : Result

Parameters

$countryCode : string
$vatNumber : string
$valid : bool
$note : string
$checkedByUserId : int|null
$name : string|null = null
$address : string|null = null

Return values

Result

setAppContext()


    public
                    setAppContext(AppContext $appContext) : $this

Parameters

$appContext : AppContext

Return values

$this

setAssetFormatRegistry()


    public
                    setAssetFormatRegistry(AssetFormatRegistry $assetFormatRegistry) : static

Parameters

$assetFormatRegistry : AssetFormatRegistry

Return values

static

setCacheTagInvalidator()


    public
                    setCacheTagInvalidator(CacheTagInvalidator $cacheTagInvalidator) : static

Parameters

$cacheTagInvalidator : CacheTagInvalidator

Return values

static

setInternalCallContext()


    public
                    setInternalCallContext(InternalCallContext $internalCallContext) : static

Parameters

$internalCallContext : InternalCallContext

Return values

static

setLanguageContext()


    public
                    setLanguageContext(LanguageContext|null $languageContext) : $this

Parameters

$languageContext : LanguageContext|null

Return values

$this

setParamsConfig()


    public
                    setParamsConfig(Config $paramsConfig) : static

Parameters

$paramsConfig : Config

Return values

static

setPresenterContext()


    public
                    setPresenterContext(PresenterContext $presenterContext) : $this

Parameters

$presenterContext : PresenterContext

Return values

$this

setSettingContext()


    public
                    setSettingContext(SettingContext $settingContext) : $this

Parameters

$settingContext : SettingContext

Return values

$this

updateAllRelations()


    public
                    updateAllRelations(int|array<string|int, mixed> $entityId, string $property, array<string, mixed> $values) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$property : string
$values : array<string, mixed>: relation property name => value set on every row

Return values

Result

updateColumn()


    public
                    updateColumn(int|array<string|int, mixed> $entityId, string $property, mixed $value) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$property : string
$value : mixed

Return values

Result

updateColumns()


    public
                    updateColumns(int|array<string|int, mixed> $entityId, array<string, mixed> $values) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$values : array<string, mixed>: property name => new value

Return values

Result

updateRelations()


    public
                    updateRelations(int|array<string|int, mixed> $entityId, string $property, array<string|int, object> $relationEntities) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$property : string
$relationEntities : array<string|int, object>: relation entities with updated values

Return values

Result

verify()


    public
                    verify(string $vatId, VatIdPolicy $policy, DateTimeInterface $at[, string|null $fallbackCountryCode = null ][, string|null $requesterVatId = null ][, bool $forceOnline = false ][, VatIdCheckLimit|null $limit = null ]) : VatIdVerification

Parameters

$vatId : string: raw VAT id (prefix optional)
$policy : VatIdPolicy
$at : DateTimeInterface
$fallbackCountryCode : string|null = null: ISO country used when the VAT id has no prefix (address country)
$requesterVatId : string|null = null: seller VAT id sent to VIES for a consultation number
$forceOnline : bool = false
$limit : VatIdCheckLimit|null = null: rate limit of the online call; null = unlimited

Return values

VatIdVerification

beginRejectedUploads()

Starts a save ({@see save()}): the list of rejected items belongs to this save only; the outer one (a nested save of the same manager) is returned to the caller and restored after the save through {@see finishRejectedUploads()}.


    protected
                    beginRejectedUploads() : array<int, array{name: string, reason: string}>

Return values

array<int, array{name: string, reason: string}> —

the outer save's list

bumpCacheTags()

Bumps cache tags for the entity after commit: its class, the owned-cascade classes from metadata and the optional `additionalCacheTags()` of the manager.


    protected
                    bumpCacheTags(object $entity) : void

Fail-open (the invalidator swallows exceptions). Called from the manager Save/Delete/Tree traits after the commit.

Parameters

$entity : object

bumpCacheTagsExplicit()

Bumps the given classes explicitly (raw-DBAL paths with a cross-entity effect).


    protected
                    bumpCacheTagsExplicit(array<string|int, string> $classes) : void

Parameters

$classes : array<string|int, string>

bumpCacheTagsForClass()

Bumps cache tags by class name when there is no instance (bulk delete, `updateColumns()`, raw DBAL, tree operations).


    protected
                    bumpCacheTagsForClass(class-string $rootClass[, array<string|int, string> $extraTags = [] ]) : void

Bumps the root class and its owned-cascade classes.

Parameters

$rootClass : class-string
$extraTags : array<string|int, string> = []

classCacheTags()

Returns extra tags for a bump that has no entity, typically tree operations ({@see \App\Core\Traits\Api\Models\Managers\TreeTrait::treeTransaction()}) that rewrite `lft`/`rgt` on many rows.


    protected
                    classCacheTags() : array<string|int, string>

IMPORTANT: additionalCacheTags(object) receives an entity, so a class-level bump cannot use it; without this hook a delete would lose the cross-entity tag (Comment to CommentThread). A manager whose cross-entity tag does not depend on a particular entity returns it here.

NOTE: unlike additionalCacheTags(), this hook is declared (with an empty default) instead of being an opt-in through method_exists(); method_exists() is always true in a manager that has the method, which phpstan reports as alreadyNarrowedType.

Return values

array<string|int, string>

finishRejectedUploads()

Ends a save: whatever {@see recordRejectedUpload()} wrote during it is added to the data of a successful result as `saveInfo.rejectedUploads` (the Api presenter passes it on to the caller, the admin builds a warning from it). A rejected item does not fail the save; the accepted files stay.


    protected
                    finishRejectedUploads(Result|null $result, array<int, array{name: string, reason: string}> $outer) : void

Parameters

$result : Result|null
$outer : array<int, array{name: string, reason: string}>: list from beginRejectedUploads()

getDeletedId()

Returns the id `$entity` had before the delete, from the snapshot in `$meta` that {@see delete()} hands to every hook. Null for an entity the snapshot does not know (not loaded by this delete, or without a simple id).


    protected
                    getDeletedId(array<string, mixed> $meta, object $entity) : int|null

Parameters

$meta : array<string, mixed>
$entity : object

Return values

int|null

getService()

Returns the service backing the manager traits.


    protected
                    getService() : Service<string|int, TEntity>

Return values

Service<string|int, TEntity>

readUploadedItem()

Reads the content of an uploaded item (`{name, data}` base64 or `{name, path}` from the dropzone) through the single reader {@see UploadedItem}.


    protected
                    readUploadedItem(array<string|int, mixed> $item[, bool $strictBase64 = true ][, int|null $maxBytes = null ]) : string|null

Call it right before processing and release the result before the next item, so that files never meet in memory. A path is accepted only during an internal bridge call ($internalCallContext) and only inside the dropzone root. A rejected path is logged to the auth channel and null is returned; callers treat it like unreadable data (skip the item or refuse the save).

Parameters

$item : array<string|int, mixed>
$strictBase64 : bool = true: false for callers that decode loosely (base64_decode($x))
$maxBytes : int|null = null: size limit; for path it is checked before reading

Return values

string|null

recordRejectedUpload()

Records a new uploaded item that the save skipped ({@see UploadRejection} `REASON_*`).


    protected
                    recordRejectedUpload(mixed $name, string $reason) : void

Called by the places that drop an item (processOrderedAssets(), advert attachments, product set gallery).

Parameters

$name : mixed
$reason : string

buildFromRow()

Verification from a stored row; null when the row does not decide (missing, or a stale / invalid VIES answer that the caller may refresh — the returned "not verified" is then built by the caller).


    private
                    buildFromRow(TaxCountry $country, string $number, VatIdCheckRow|null $row, DateTimeInterface $at) : VatIdVerification|null

Parameters

$country : TaxCountry
$number : string
$row : VatIdCheckRow|null
$at : DateTimeInterface

Return values

VatIdVerification|null

buildLimitReached()

Exhausted limit: no VIES call — the stored row decides like with an unavailable VIES (never verified by a stale answer), flagged so that the consumer can tell "limit" from "VIES outage".


    private
                    buildLimitReached(TaxCountry $country, string $number, VatIdVerification|null $fromHistory) : VatIdVerification

Parameters

$country : TaxCountry
$number : string
$fromHistory : VatIdVerification|null

Return values

VatIdVerification

bumpDeleteCacheTags()

Post-commit bump after a delete. With entities it goes through {@see \App\Core\Base\BaseManager::bumpCacheTags()}, which also collects `additionalCacheTags()` (Comment → CommentThread); without them it falls back to bumping the manager class itself, the original behavior.


    private
                    bumpDeleteCacheTags(array<int, object> $entities) : void

Parameters

$entities : array<int, object>

captureDeletedIds()

Keys the ids by the loaded entity objects, not by the input ids: an input id that loaded nothing must not shift the pairing. A weak map, so the snapshot never keeps an entity alive.


    private
                    captureDeletedIds(array<int, object> $entities) : WeakMap<object, int>

Parameters

$entities : array<int, object>

Return values

WeakMap<object, int>

columnsInvalidateCache()


    private
                    columnsInvalidateCache(array<int, string> $columns) : bool

Parameters

$columns : array<int, string>

Return values

bool

deleteBatch()

Bulk delete of a list of ids as one transaction. `Service::deleteAll()` flushes per entity; in autocommit the rows deleted before a database failure would stay deleted while the caller got either an escaped `EntityManagerClosed` or an "OK" with an error text. Here the service stops at the technical failure, this wrapper rolls the whole batch back and returns the failure Result with `deletedCount = 0` and `rolledBack = true`: nothing of the batch is durable and nothing is attempted over the closed EntityManager. A domain partial success (missing ids) keeps the existing contract and is committed.


    private
                    deleteBatch(array<int, int|string|array<string|int, mixed>> $ids) : Result

Transaction ownership: the wrapper only opens its own level; inside a caller's transaction a rollback here marks the caller's transaction rollback-only, so its final commit rolls the whole scope back (TransactionManager counter contract, the same as the hooked delete() path).

Parameters

$ids : array<int, int|string|array<string|int, mixed>>

Return values

Result

findLatestDecisive()

Latest decisive row (a stored outage is skipped — see the class docblock).


    private
                    findLatestDecisive(TaxCountry $country, string $number) : VatIdCheckRow|null

Parameters

$country : TaxCountry
$number : string

Return values

VatIdCheckRow|null

fitColumn()

VIES texts are cut to the column length: an overflow would fail the save (strict `sql_mode`) or be cut silently.


    private
                    fitColumn(string $property, string|null $value) : string|null

Parameters

$property : string
$value : string|null

Return values

string|null

isAssetPathAllowed()

Checks only entities composing {@see AssetPathTrait}; the trait is the allowlist of "relative file path" columns, other `assetPath`-like fields are untouched.


    private
                    isAssetPathAllowed(BaseEntity $entity) : bool

Parameters

$entity : BaseEntity

Return values

bool

isDecidedByEvidence()

Does the stored decisive row answer without calling VIES? A manual check always; with `CacheOnly` a verified (fresh) VIES answer; with `RefreshStale` only a VIES answer from the supply day itself (once a day).


    private
                    isDecidedByEvidence(VatIdCheckRow $row, VatIdVerification $fromHistory, VatIdPolicy $policy, DateTimeInterface $at) : bool

Parameters

$row : VatIdCheckRow
$fromHistory : VatIdVerification
$policy : VatIdPolicy
$at : DateTimeInterface

Return values

bool

loadEntitiesForCacheTags()

Loads the entities being deleted only to find out their `additionalCacheTags()`. Fail-soft: what cannot be loaded is simply missing and the bump falls back to the class; it must never stop the delete.


    private
                    loadEntitiesForCacheTags(int|array<string|int, mixed> $id) : array<int, object>

Parameters

$id : int|array<string|int, mixed>

Return values

array<int, object>

normalizeNumberFor()

Number stored for a manual record of `$country`: separators dropped, upper-cased, the country's own VAT prefix stripped (any other letter pair is part of the number — e.g. a registration number of a non-EU company).


    private
                    normalizeNumberFor(TaxCountry $country, string $number) : string|null

Null = nothing usable or longer than the column.

Parameters

$country : TaxCountry
$number : string

Return values

string|null

resolveVerification()

The policy of {@see verify()} without the allowance.


    private
                    resolveVerification(string $vatId, VatIdPolicy $policy, DateTimeInterface $at, string|null $fallbackCountryCode, string|null $requesterVatId, bool $forceOnline, VatIdCheckLimit|null $limit) : VatIdVerification

Parameters

$vatId : string
$policy : VatIdPolicy
$at : DateTimeInterface
$fallbackCountryCode : string|null
$requesterVatId : string|null
$forceOnline : bool
$limit : VatIdCheckLimit|null

Return values

VatIdVerification

rollbackBatch()


    private
                    rollbackBatch() : void

saveWithHooks()

Runs the save itself: transaction, `beforeSave` / `afterSave` / `completedSave`, tree, cache.


    private
                    saveWithHooks(TEntity $entity, array<string, mixed> $meta, array<int, string> $skipFields) : Result

Parameters

$entity : TEntity
$meta : array<string, mixed>
$skipFields : array<int, string>

Return values

Result

storeViesResult()


    private
                    storeViesResult(TaxCountry $country, string $number, ViesResult $result, DateTimeImmutable $checkedAt) : int

Parameters

$country : TaxCountry
$number : string
$result : ViesResult
$checkedAt : DateTimeImmutable

Return values

int

usesAssetPathTrait()


    private
            static        usesAssetPathTrait(string $class) : bool

Parameters

$class : string

Return values

bool

verifyOnline()


    private
                    verifyOnline(TaxCountry $country, string $number, DateTimeInterface $at, string|null $requesterVatId) : VatIdVerification

Parameters

$country : TaxCountry
$number : string
$at : DateTimeInterface
$requesterVatId : string|null

Return values

VatIdVerification

VatIdCheckManager extends Manager in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

FRESH_DAYS

HISTORY_LIMIT

DELETED_IDS_META

Properties

$service

$appContext

$assetFormatRegistry

$cacheTagInvalidator

$internalCallContext

$languageContext

$nonInvalidatingColumns

$paramsConfig

$presenterContext

$settingContext

$totalCount

$useTransactionForDelete

$useTransactionForSave

$countryManager read-only

$rateLimit read-only

$rateLimitConfig read-only

$rejectedUploads

$vatIdCheckService read-only

$viesClient read-only

Methods

__construct()

Parameters

buildAutoCheckLimit()

Parameters

Return values

buildUserCheckLimit()

Parameters

Return values

delete()

Parameters

Return values

deleteAll()

Parameters

Return values

find()

Parameters

Return values

findAll()

Parameters

Return values

findBusinessEvidence()

Parameters

Return values

findBy()

Parameters

Return values

findHistory()

Parameters

Return values

findOnlineCheckAllowance()

Parameters

Return values

findRelatedIds()

Parameters

Return values

getAppContext()

Return values

getDefaultSkipFields()

Return values

getEntityClass()

Return values

getExternalMetaAllowlist()

Return values

getExternalOwnerData()

Parameters

Return values

getExternalRemoteIpData()

Parameters

Return values

VatIdCheckManager extends Manager
in package

Application