CoolCMS API

ProductCategoryManager extends Manager

in package

• Application

implements TreeManagerInterface uses AssetTrait, AssetProcessingTrait, EshopAssetTrait, TreeTrait, CategoryParameterRelSyncTrait

Manages the product category nested-set tree (single tree, unscoped).

Tags

extends

Table of Contents

Interfaces

TreeManagerInterface

Manager of a nested-set tree entity.

Constants

META_MOVE_SUBTREE_PARENT  : mixed = 'moveSubtreeToParentId'

Meta key by which an admin/front form says "this entity changed its parent"; the value is the new `parentId` (`null`/0 = root). See {@see applyMetaSubtreeMove()}.

DELETED_IDS_META  : string = '__deletedIds'

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

ESHOP_SETTINGS_MODULE  : int = 4

Eshop module index (image directories `assetDir(4, ...)` in managers using this trait).

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

$defaultSkipFields  : array<int, string>

Parameter targeting is not saved by the object graph (the entity maps it without cascade/orphanRemoval); {@see CategoryParameterRelSyncTrait} writes it in `afterSave()` from `meta['parameterRels']`.

$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

$lastAssetRejectionCode  : string|null

Why the last {@see saveAssetVariants()} returned `null` ({@see UploadRejection} `REASON_*`); the caller passes it to the report of rejected items. `null` means the last save passed.

$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

$assetManager  : AssetManager

$em  : EntityManagerInterface

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

$variantProvider  : AssetVariantProvider

Methods

__construct()  : mixed

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

deleteNode()  : Result

Deletes a node with its whole subtree and closes the gap in lft/rgt.

fetchOwnProductCounts()  : array<int, int>

Returns the category's own (not subtree) distinct product count for every category.

fetchParameterRelsForCategory()  : array<int, array{parameterId: int, order: int}>

Returns the stored parameter rels of one category, sorted by `order`.

fetchParametersForProduct()  : array<int, int>

Returns the distinct parameter ids aggregated over all categories of a product.

fetchProductIdsInSubtree()  : array<int, int>

Returns distinct ids of active, non-deleted products in a category or any descendant.

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

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

insertTreeNode()  : Result

Computes lft/rgt/level for a newly inserted node (after `save()`, when it has `parent_id` in the database but zero lft/rgt). It is inserted as the last sibling (after the largest `rgt` among nodes with the same `parent_id`).

moveDown()  : Result

Moves after the next sibling.

moveSubtree()  : Result

Moves a whole subtree (root and descendants) under another parent.

moveSubtreeTo()  : Result

Moves a whole subtree under a new parent at a specific position.

moveUp()  : Result

Moves before the previous sibling.

registerEvent()  : Result

reorderChildren()  : Result

Reorders the direct children of a parent (with whole subtrees) into the given order, in one operation under the tree lock (the "sort children alphabetically" admin grid action; the caller decides the order). A mismatching set of children returns `TREE_STALE` and nothing is written; `data.changed` is the number of moved children.

save()  : Result

setAppContext()  : $this

setAssetFormatRegistry()  : static

setCacheTagInvalidator()  : static

setInternalCallContext()  : static

setLanguageContext()  : $this

setParamsConfig()  : static

setPresenterContext()  : $this

setSettingContext()  : $this

updateAllRelations()  : Result

updateColumn()  : Result

updateColumns()  : Result

updateRelations()  : Result

afterMoveSubtree()  : Result

Hook after a subtree move ({@see moveSubtree()}, {@see moveSubtreeTo()}, so also {@see applyMetaSubtreeMove()} from a form). It runs inside the transaction and the tree lock, so a failure returned from here also rolls back the move itself. The default does nothing; a manager whose derived data depends on the tree path (region slugs) overrides it.

afterSave()  : Result|null

applyMetaSubtreeMove()  : Result|null

Recomputes the nested set after a parent change. Called from `afterSave()`, so inside the save transaction.

assetCleanupRoots()  : array<int, string>

Asset roots inside which {@see removeEmptyAssetDirs()} may remove empty directories; never above them.

assetDir()  : string

Returns the asset directory from the server neon `params` (through Config), not from `getSettings()`: the shared setting context may be filled by a client without server paths (see the in-process ApiBridge).

assetIdOf()  : int|null

Normalizes the "current image" to an id. Channels with an ORM association return an entity (even a lazy proxy; `getId()` does not initialize it), channels with a scalar FK return an int.

assetVariantFilePaths()  : array<int, string>

Returns the absolute paths of the files of the asset just written (variants and the original).

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

buildVariantConfigs()  : array<string, array{maxWidth: int, maxHeight: int, resizeFlags: int[], useWatermark: bool}>

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

captureOwnedAssetIds()  : array<int, int>

Ids of the images the given entities own ({@see completedAssetCleanup()} requires the same opt-in `ownedAssetIds()`), captured before the rows are deleted. For paths that bypass {@see DeleteTrait::delete()} and its hooks, such as a subtree delete ({@see TreeTrait::deleteNode()}). Fail-soft: an error of one entity is logged and the others are processed.

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.

completedAssetCleanup()  : void

Post-commit cleanup of the assets of an entity that was just deleted.

createAssetRel()  : object

Unused hook: a category has no image relation collection (only the main image FK).

deleteAsset()  : void

Deletes an asset file by its absolute path.

deleteAssetFiles()  : void

Deletes the previously scanned files (see {@see listAssetFilesIn()}). Call only after the FK update to the new Asset succeeded.

dropForeignExistingItems()  : array<int, TItem>

From the `type: existing` items keeps only those whose id is already linked to the record `$parentId` through `$relationProperty` (read from the database). Other types (`new`) stay unchanged. When the links cannot be determined (`null`), no existing item passes: losing the order is better than attaching a foreign file.

failureOrNull()  : Result|null

A failed Result to propagate, success is null (the `afterSave` hook returns `?Result`).

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.

getAssetDirAbs()  : string

getAssetDirRel()  : string

getAssetFormatKinds()  : array<int, AssetFormatKind>

Media kinds allowed in the dropzone gallery of this manager. The default is images and video. Vector is left out on purpose: an end-user svg is needless exposure even when the sanitizer passes it; enable it explicitly if needed.

getAssetFormatRegistry()  : AssetFormatRegistry

Requires `$this->assetFormatRegistry` set by the decorator ({@see \App\Core\Base\Api\Models\Managers\Manager::setAssetFormatRegistry()}).

getAssetMaxBytes()  : int|null

Upper size limit of a new gallery file in bytes, `null` = no limit. The default has none; adverts and company profiles return {@see \App\Core\Security\Upload\ImageUploadSizeLimit::bytes()}.

getAssetSubDir()  : string

getAssetUsageKey()  : string|null

getAssetVariantType()  : string

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

getMainAssetColumn()  : string

Name of the property the main (first) gallery image is written to. The default `asset` is an ORM ManyToOne to `Asset` (Message/Advert/Intro). Entities that keep the main image as a flat FK column without an association (Company `Reference::$imageId`) override the hook; otherwise `updateColumn()` would write to a nonexistent property.

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

Returns the service backing the manager traits.

listAssetFilesIn()  : array<int, string>

Lists the files lying in the target directory before a new image is written.

orderedAssetsFromMeta()  : array<int, array{type?: string, imageId?: int, name?: string, data?: string, path?: string, order?: int}>

Turns `meta['orderedAssets']` of the request into the list of dropzone items in the shape {@see processOrderedAssets()} reads. Unknown keys and values of a wrong type are dropped; a present but non-text `path` stays as `''` so the file read rejects it the same way instead of silently skipping it.

orderedFilesFromMeta()  : array<int, array{type: string, fileId?: int, name?: string, data?: string, path?: string, order?: int}>

Turns `meta['files']` of the request into the list of files for `processFiles()`/`processComplaintFiles()`.

ownedAssetIds()  : array<int, int|object|null>

Returns the image owned by the category; it is released after a hard delete.

processMainImage()  : Result|null

Processes the main photo from `$meta` (sent by the admin form).

processOrderedAssets()  : Result|null

Shared template method for processing an ordered array of dropzone assets.

productImageVariantConfigs()  : array<string, array{maxWidth: int, maxHeight: int, resizeFlags: int[], useWatermark: bool}>

Variants of product images, by the usage from `getAssetVariantType()` (`eshop-products` or `eshop-product-sets`) in the image variants table; product and set each have their own.

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

releaseAsset()  : bool

Releases the old asset after an image was cleared or replaced: deletes its `cms_system_images` row and files. Without this step every replacement or removal left an orphaned row.

releaseDroppedAssets()  : void

Releases the images that disappeared from the record after the relations were replaced (removed in the gallery or form). Call only after the relations and the main image were written successfully; a shared image (still referenced) is not deleted by {@see releaseAsset()}, and a cleanup error does not fail the save.

releaseOwnedAssets()  : void

Releases the captured images after the delete commit; a shared image stays ({@see releaseAsset()} → `AssetManager::releaseAssetRow()`), an error is only logged.

removeEmptyAssetDirs()  : void

Removes the directories the delete left empty (`galleries/20/{big,original,thumb}`, `intros/14/1/…`), walking up while a directory is empty and strictly inside one of the asset roots ({@see assetCleanupRoots()}).

resolveAssetExtension()  : string|null

Normalized extension of an uploaded file, or null when the format is not allowed in this context.

saveAsset()  : string|null

Saves one base64 image; `null` means the image did not pass {@see ImageUploadPolicy}.

saveAssets()  : array<int, string>

Saves base64 images into a directory, raster images only, per {@see ImageUploadPolicy}.

saveAssetVariants()  : Asset|null

Saves the files to disk (the format processor does the work) and creates the `Asset` entity with the variant plan and real dimensions. A variant `name` in the database equals the config key and the directory on disk.

staticImageVariantConfigs()  : array<string, array{maxWidth: int, maxHeight: int, resizeFlags: int[], useWatermark: bool}>

Variants of category and parameter images, also by the usage from `getAssetVariantType()`.

storeImage()  : Asset|null

Stores an uploaded image as an `Asset` (variants) under `.../<parentId>/<variant>/`.

treeConfigForEntity()  : TreeConfig

`TreeConfig` used when `save()` computes lft/rgt of a new entity automatically ({@see SaveTrait}).

buildParameterRelEntities()  : array<int, CategoryParameterRel>

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.

captureSubtreeAssetIds()  : array<int, int>

Returns the ids of images owned by the whole subtree; empty when the manager declares no image cleanup.

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.

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.

moveTreeNode()  : Result

normalizeParameterRelsMeta()  : array<int, array{parameterId: int, order: int, required: bool, useInSearch: bool, parameterGroupId: ?int}>

Normalizes and deduplicates the rel data from `meta['parameterRels']`. A parameter may appear in a category only once (composite PK = category + `parameterId`), so a duplicate `parameterId` is dropped (the first wins).

rollbackBatch()  : void

runTreeTransaction()  : Result

The body of {@see treeTransaction()}: a transaction only when none is running, a tag bump after success, an exception means log plus rollback of the own transaction.

saveWithHooks()  : Result

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

syncCategoryParameterRels()  : Result|null

Returns `null` when nothing changed, otherwise the `Result` of the rel write.

toInt()  : int

Casts a `mixed` DBAL value to int (a direct cast of `mixed` fails PHPStan level 9).

treeService()  : TreeServiceInterface

Loud guard against silent failure: tree operations run only when the underlying service implements the method (`TreeTrait` on service, mapper and repository). A missing one is a wiring bug, so a {@see \LogicException} is thrown (logged through `treeTransaction()` / `save()`) instead of a silent `INVALID_OPERATION` that did not show where the problem is.

treeTransaction()  : Result

Wraps a tree operation in a transaction (when the service supports it): the operations rewrite lft/rgt on many rows and a partial write would break the tree.

usesAssetPathTrait()  : bool