CoolCMS API

ResponseManager extends Manager

in package

• Application

implements MessageThreadReadListener, ContentCreationLimitedInterface uses BlacklistGuardTrait, MessageThreadCreatorTrait, ResponseColumnGuardTrait, ResponseCurrencyGuardTrait, ResponseMarkReadTrait, ResponseThreadReadSyncTrait, ContentCreationLimitTrait

Base class of Api managers whose traits delegate to a typed `Service<TEntity>`.

Tags

extends

Table of Contents

Interfaces

MessageThreadReadListener

Listener notified when a user has read a private conversation.

ContentCreationLimitedInterface

Manager that draws on the {@see ContentCreationLimiter} quota when creating content.

Constants

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}.

$blacklistManager  : BlacklistManager|null

$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

$advertManager  : AdvertManager

$blacklistedWordManager  : BlacklistedWordManager

$blacklistedWordsCache  : array<string|int, string>|null

$contentCreationLimiter  : ContentCreationLimiter|null

$currencyManager  : CurrencyManager

$emailManager  : EmailManager

$messageThreadManager  : MessageThreadManager

$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`.

Methods

__construct()  : mixed

afterSave()  : Result|null

Runs after a response is saved.

beforeSave()  : Result|null

Gate for response writes: column limits (every write) and rate limit (INSERT only).

canUserWrite()  : bool

Tells whether `$userId` may write this response; input of the RBAC gate of the `save` action ({@see \App\UI\Api\Bazaar\Presenters\ResponsePresenter::verifyOwnership()}).

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>)

findBy()  : T|null

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).

generateReadKey()  : string

24 random bytes = 48 hex characters (column `read_key` is `varchar(64)`).

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>

IMPORTANT: the sender is carried by the `$user` association, not by a scalar: `Response::$userId` in the Api leaf has `#[ORM\AttributeOverride]` with `insertable: false, updatable: false` ({@see Response}), so `['userId' => ...]` would be silently not written. See {@see BaseManager::getExternalOwnerData()}.

getExternalRemoteIpData()  : array<string, mixed>

Sets the sender IP on an external INSERT: `insertIp` is `#[ExternalReadonly]` and without the server value an external response would bypass the per-IP limits in {@see self::beforeSave()}.

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

isOwnedBy()  : bool

Tells whether the response to advert `$responseId` belongs to user `$userId`.

markRead()  : Result

Writes `read = 1` after the presenter decided that the caller is the receiver ({@see \App\Core\Traits\Api\Presenters\ResponseReceiverTrait::isResponseReceiver()}).

onMessageThreadRead()  : void

Thread to response: the advert owner read the conversation, so their response is read too.

readKeyMatches()  : bool

Tells whether the given key matches the stored one. A null or empty stored key (older responses) and an empty given key never match; the comparison runs in constant time.

registerEvent()  : Result

save()  : Result

setAppContext()  : $this

setAssetFormatRegistry()  : static

setCacheTagInvalidator()  : static

setContentCreationLimiter()  : void

setInternalCallContext()  : static

setLanguageContext()  : $this

setParamsConfig()  : static

setPresenterContext()  : $this

setSettingContext()  : $this

updateAllRelations()  : Result

updateColumn()  : Result

updateColumns()  : Result

updateRelations()  : Result

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()}.

blacklistedWordsForThread()  : array<string|int, string>

Returns the blacklisted words for the private-message filter; overrides the hook {@see MessageThreadCreatorTrait::blacklistedWordsForThread()}.

buildMessageParticipant()  : MessageParticipant

Builds a participant from a user id, falling back to a guest. When `$userId` is missing (anonymous advert, logged-out asker), the participant carries contact data and the thread switches to e-mail-only mode.

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.

openMessageThreadFor()  : Result|null

Opens a thread with two participants and a root message and writes its id into `$column` of the entity `$entityId` (default `messageThreadId`).

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_*`).

resolveThreadSubject()  : string|null

Resolves the thread subject from a response: the response subject when filled, otherwise the fallback (the advert title).

advertDisplayName()  : string|null

Returns the advert name as a string (parameter `name`), or `null` without it.

blacklistRefusal()  : Result|null

buildMarkReadLink()  : string|null

Returns the absolute URL of the "mark as read" button in the e-mail.

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

containsBlacklistedWord()  : bool

Tells whether the text contains a blacklisted word.

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.

guardAnonymousInsert()  : Result|null

Returns `RATE_LIMIT_EXCEEDED` when a guest visitor exceeded the quota of anonymous records of the kind `$scope` (per IP and per normalized `$email`), otherwise `null`. Only an insert by a guest (`$userId` null); a logged-in user is counted by {@see guardContentCreation()}.

guardContentCreation()  : Result|null

Returns `RATE_LIMIT_EXCEEDED` when the quota is exceeded, otherwise `null`. Only an insert by a logged-in user is counted (see {@see ContentCreationLimiter::isAllowed()}).

guardResponseColumnLimits()  : Result|null

Rejects a response whose value does not fit its typed column.

guardResponseCurrency()  : Result|null

hasResponsePriceChanged()  : bool

Tells whether the price or currency differs from the stored row. Without an id or a readable row it counts as changed: the guard then checks rather than let an unverified currency through.

isActivationMailAllowed()  : bool

Tells whether another activation e-mail may be sent to `$email`. Unlike {@see guardContentCreation()} it applies to guests too (it protects the recipient); see {@see ContentCreationLimiter::isActivationMailAllowed()}.

isAssetPathAllowed()  : bool

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

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.

markThreadReadForResponse()  : void

openThreadForResponse()  : Result|null

Creates a thread between the inquirer and the advert owner and stores its id on the response.

resolveSenderUserId()  : int|null

Returns the response sender: front/admin fill the scalar `userId`, external INSERT the `user` association (the scalar is read-only in the Api leaf, see {@see self::getExternalOwnerData()}).

responseColumnFailure()  : Result

Builds the uniform rejection; `errorCode` is a machine-readable reason.

responseReceiverUserId()  : int|null

Returns the user the response was addressed to (the advert owner), or `null` for an anonymous advert.

rollbackBatch()  : void

saveWithHooks()  : Result

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

sendEmail()  : void

usesAssetPathTrait()  : bool