CoolCMS API

ProductSetEdit extends BaseComponent

in package

• Application

uses AdminComponentFormTrait, ComponentPickerHostTrait, FormTrait, PickerTrait, StockOperationTrait, FormHelpersTrait, ModalAwareTrait, PriceSnapshotTrait, FeedFieldsTrait

Edits or adds a product set; hosted by `ProductSetPresenter` and `ProductPresenter`.

Table of Contents

Constants

EDIT_INCLUDES  : array<int, string> = [ 'translations', 'product.translations', 'prod...

Canonical includes list for loading the edited set; the single source of truth, also read by `ProductSetPresenter::actionEdit()`. Every object-graph save of a set needs the full includes, otherwise orphan removal deletes the missing relations.

PRIVILEGE_STOCK_CARD  : mixed = ':Admin:Store:StockItem:add'

Creating the missing stock item card of a variant writes to the warehouse (`:Api:Eshop:ProductVariant:foundStockItemCard`).

PRIVILEGE_STOCK_MOVE  : mixed = ':Admin:Store:StockDocument:add'

Stock actions of the variant editor (receipt, transfer) write a stock document, so they check the same admin privilege as the Store module. The Api enforces `:Api:Store:StockDocument:receive` / `transfer` independently; this is its admin counterpart, not a replacement.

Properties

$container  : Container

$onStockChanged  : array<int, callable(int): void>

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$appContext  : AppContext

$componentParameters  : array<string, mixed>

$currencyContext  : CurrencyContext|null

$deviceDetector  : DeviceDetector|null

$languageContext  : LanguageContext|null

$localizationContext  : LocalizationContext|null

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string

$adminLanguageManager  : LanguageManager

$apiBridge  : ApiBridge

$commentThreadFactory  : CommentThreadFactory

$contextProduct  : Product|null

Edited product in the `product-variant` mode, loaded lazily by {@see loadContextProduct()}.

$contextProductLoaded  : bool

$currencyManager  : CurrencyManager

$currencyOptions  : array<int, string|NotTranslate>

$duplicateFromSetId  : int|null

$duplicateSourceSet  : ProductSet|null

Source selling set of a duplication, loaded lazily by {@see loadDuplicateSourceSet()}.

$duplicateSourceSetLoaded  : bool

$editedSet  : ProductSet|null

Edited set (null when adding), set by {@see resolveEditedSet()}.

$editingPriceSnapshotTime  : string|null

Snapshot being edited in the modal (`publishedTime`); null when adding.

$feedManager  : FeedManager

$feedOverrideModesCache  : array<int, string>|null

Memoized value modes of the edited set, `feedParameterId => mode`. Taken from the first row of the (parameter, set) pair, like the generator does.

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

Memoized override rows of the edited set, `feedParameterId => list<value>` ordered by `r.id ASC` (the order of repetitions in the XML).

$feedOverrideStructureCache  : array<int, array{feedId: int, feedName: string, tree: list>}>|null

Memoized tab axis: feeds with their parameter trees (including saved repetition counts).

$feedParameterActionLabelsCache  : array<int, string>|null

$feedParameterActionManager  : FeedParameterActionManager

$formActionsFactory  : FormActionsFactory

$formNotices  : array<int, array{type: string, key: string}>

Result-level variant save messages (duplicate code, taken variant, cycle, generic), rendered directly in the modal content (`setEditHost`, `Default.latte`).

$itemExcludeIds  : array<int, int>|null

$langNavFactory  : LangNavFactory

$mode  : string

One of `standalone`, `product-variant`, `bundle`; see the class docblock.

$parameterGroupManager  : ParameterGroupManager

$parameterManager  : ParameterManager

$pickerFactory  : PickerFactory

$preloadedSet  : ProductSet|null

$productCategoryManager  : ProductCategoryManager

$productId  : int|null

$productManager  : ProductManager

$productSetFeeManager  : ProductSetFeeManager

$productSetLinkManager  : ProductSetLinkManager

$productSetManager  : ProductSetManager

$productStateManager  : ProductStateManager

$productStateOptions  : array<int, string|NotTranslate>

$productTagManager  : ProductTagManager

$productVariantManager  : ProductVariantManager

$ratingThreadFactory  : RatingThreadFactory

$setId  : int|null

$snapshotSet  : ProductSet|null

Set with loaded price history, loaded separately from `$editedSet` because the main set form does not load `prices`/`vats` at all (see `EDIT_INCLUDES`). Lazy.

$stockLevelManager  : StockLevelManager

$supplyKindManager  : SupplyKindManager

$supplyKindOptions  : array<int, string>

$unitManager  : UnitManager

$uploaderDropzoneFactory  : UploaderDropzoneFactory

$userGroupManager  : UserGroupManager

$userGroupOptions  : array<int, string|NotTranslate>

$variantId  : int|null

$vatManager  : VatManager

$vatOptions  : array<int, string|NotTranslate>

$vatPercents  : array<int, string>

Raw VAT rate percentages (id => "21.00") for the client-side "price with VAT" calculation in the price list; `vatOptions` holds labels with a percent sign that must not be parsed.

$warehouseManager  : WarehouseManager

Methods

__call()  : mixed

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

__construct()  : mixed

canMoveStock()  : bool

Returns whether the logged-in admin may move stock from the variant editor.

createComponent()  : IComponent|null

getAppContext()  : AppContext

getComponentParameter()  : mixed

Returns a component parameter, or null when it is not set.

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

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

getThemeContext()  : ThemeContext|null

handleAddPriceSnapshot()  : void

handleDeletePriceSnapshot()  : void

The link is not AJAX (styled `data-grid-confirm`), so after deleting a redirect (PRG) returns to the tab.

handleEditPriceSnapshot()  : void

handleOpenReceiveModal()  : void

Opens the receipt sub-modal.

handleOpenTransferModal()  : void

Opens the transfer sub-modal.

hasServiceByType()  : bool

Returns whether the container has a service of the given type.

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

onFeedOverridesFormSuccess()  : void

Saves the Feeds tab, set-scoped so it never touches the overrides of other sets ({@see \App\UI\Api\Eshop\Models\Managers\FeedManager::saveParameterRelsForSet()}).

onPriceSnapshotFormSuccess()  : void

onStockReceiveSuccess()  : void

onStockTransferSuccess()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

createAdminComponentForm()  : Form

createComponentAdminFormActions()  : FormActions

Save and back buttons of the form; own instance, as in `AdminEditFormComponentsTrait`.

createComponentAdminLangNav()  : LangNav

Language tabs of the multilingual fields; own instance, as in `AdminEditFormComponentsTrait`.

createComponentCommentThread()  : CommentThread

Set comment management for the comments tab (editing only).

createComponentEditForm()  : Form

createComponentFeedOverridesForm()  : Form

Builds the sub-form of the Feeds tab: one multiplier `feedMulti_<id>` per parameter (a non-multiple parameter is a multiplier with `maxCopies = 1` and no buttons).

createComponentImgUploader()  : UploaderDropzone

Builds the set gallery dropzone uploader.

createComponentPicker()  : Multiplier<string|int, Picker>

createComponentPriceSnapshotForm()  : Form

Builds the modal form: matrix of tier (`fromAmount`) x user group x currency to price, original price and points.

createComponentRatingThread()  : RatingThread

Set rating management for the ratings tab (editing only).

createComponentStockReceiveForm()  : Form

createComponentStockTransferForm()  : Form

currentLangId()  : int|null

Returns the current language id (for picker captions etc.), or null when unknown or not attached.

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

getFormLanguages()  : array<int, Language>

Returns the languages for multilingual form fields (admin `LanguageManager`, constructor-injected).

getModalWindow()  : ModalWindow

getTranslator()  : ITranslator

intOrNull()  : int|null

Converts a mixed value to an int or null (an empty or zero value becomes null).

parseDateTime()  : DateTime|null

Parses a `datetime-local` input or text value into a `DateTime`, or null when empty or invalid.

pickers()  : array<string, PickerConfig>

Returns the component pickers; must be pure and idempotent, it is also called on the AJAX signal `suggest!`.

productPicker()  : PickerConfig

Picker of the owning `Product`: a single top-level field outside the multiplier, so no `targetContainer` or `displayField`.

productSetAccessoryPicker()  : PickerConfig

Picker of an accessory in the `accessories` multiplier row (many-to-many `ProductSet` to `ProductSet`).

productSetFeePicker()  : PickerConfig

Picker of a fee in the `fees` multiplier row (many-to-many `ProductSet` to `ProductSetFee`).

productSetItemPicker()  : PickerConfig

Picker of a set composition item: `setItems` row targeting another set (a ready bundle too, i.e. nested sets). Links to `:Admin:Eshop:ProductSet` so the item detail opens from the row.

productSetLinkPicker()  : PickerConfig

Picker of a link in the `links` multiplier row (many-to-many `ProductSet` to `ProductSetLink`).

productSetVariantPicker()  : PickerConfig

Picker of the sold variant: top-level `variantId` of a set with `type = PRODUCT`. The 1:1 relation is guarded by the Api guard and a unique index.

productTagPicker()  : PickerConfig

Picker of a tag in the `tags` multiplier row (many-to-many `ProductSet` to `ProductTag`).

setTemplateFile()  : void

setTranslator()  : self

str()  : string

Converts a mixed form value to a string safely.

strOrNull()  : string|null

Converts a mixed value to a string or null (an empty string is stored as null).

addFeedOverrideModeSelect()  : void

Builds the value mode select: one per root node (children and repetitions of a `multiple` node do not get one).

addFeedOverrideMultiplier()  : void

Builds the multiplier of one node; a copy is one repetition of the XML node.

addInitialStockFields()  : void

Adds the per-warehouse initial stocking fields (quantity, price) and the shared currency.

addPriceGroupCurrencyFields()  : void

Adds the per-currency cells (price, original price, points) for one group; shared so that `group{id}` and the base `groupAll` have identical fields.

addProductSetBaseFields()  : void

Adds the basics: codes, unit, type, owning product, state, publication and goods parameters.

addProductSetTranslationFields()  : void

Adds the multilingual fields, one set per language (`<field>_<langId>`).

addVariantNotice()  : void

Adds a variant save message that is visible in the modal content.

applyUnit()  : void

Writes the catalog choice and, at the same time, the print abbreviation.

buildFeedOverrideDefaults()  : array<string, mixed>

Builds the prefill from {@see \App\UI\Admin\Eshop\Models\Managers\FeedManager::getParameterRelsForSet()} (order `r.id ASC`, the order of repetitions in the XML).

buildFeedParameterRenderTree()  : array<int, array<string, mixed>>

Converts parameter tree nodes into the shape used by the form and the rendering.

buildPriceSnapshotDefaults()  : array{sameForAll: bool, tiers: list>}

Builds the matrix prefill for the edited snapshot: rows of the given `publishedTime` grouped by tier (`fromAmount`), inside by group x currency (matches the multiplier containers).

buildPriceSnapshotModalContent()  : string

Renders the modal content (partial) to a string for `ModalWindow::setContent()`.

buildPriceTierMatrix()  : void

Adds the tier x group x currency matrix to the form: the `$form['tiers']` multiplier with create and remove buttons.

buildProductSetEntity()  : ProductSet

Builds the set with all its collections. On edit it works with the loaded entity (it carries associations the form does not edit, which the object-graph save would otherwise null).

buildProductSetPriceHistory()  : array<int, array{publishedTime: string, displayTime: string, future: bool, editable: bool, rowCount: int, groups: list>}>}>

Returns the read-only price list history for the tab: snapshots grouped by `publishedTime` (newest first) with an `editable` flag.

buildStockReceiveModalContent()  : string

buildStockTransferModalContent()  : string

buildVariantModeAfterSave()  : callable

Returns the post-save hook for mode `product-variant`, which does no page redirect (the modal is a dedicated shell above the presenter page): - `save` (AJAX): closes the modal (`payload->modalClose`); - `update` (AJAX): keeps the modal open and redraws the whole component (fresh `$editedSet`, see {@see saveProductVariantForm()}); always also redraws the variant list and flash on the presenter; - non-AJAX fallback (JS disabled): a full PRG to the product Variants tab ({@see prgAnchor()}).

collectFeedOverrideDefaults()  : void

Fills defaults of one node. Children are not reached by recursion: they live in the parent copy.

collectFeedOverrideNodeRows()  : void

Collects the rows of one node (see the trait docblock: why a node with children also gets a parent row and why an empty child is stored as an empty string).

collectFeedOverrideRows()  : array<int, array{feedParameterId: int, value: string, valueMode: string}>

Converts form values into flat bridge rows, in the order the repetitions must appear in the XML (the bridge stores them sequentially and the generator reads them `ORDER BY r.id`).

collectInitialStockRows()  : array<int, array{quantity: float, unitPrice: float|null}>

Collects the initial stocking rows to be sent as receipts.

collectPriceSnapshotRows()  : array<int, array{fromAmount: int, userGroupId: int, currencyId: int, price: string|float, originalPrice: string|float|null, points: int}>

Collects the matrix rows to send to the bridge; an empty price means the combination is not stored. The Api manager decides the rest (collisions, guard, denormalized recalculation).

createMultiplierComponent()  : Multiplier<string|int, IComponent>

Creates a multiplier for the component.

createNewComponentInstance()  : IComponent|null

Creates a new component instance without adding it to the presenter; used by the multiplier.

createProductSetLink()  : array{id: int, label: string}|null

Creates a link from the typed URL and returns it to the picker for selection.

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

currentStockItemId()  : int|null

Stock item id of the edited variant; null when it has no card yet ({@see ensureStockItemCard()} creates it at the first stock action).

currentUserId()  : int|null

Returns the logged-in admin id, stored as `userId` of the stock document.

ensureStockItemCard()  : void

Creates the stock item card of a legacy variant at its first stock action (receipt or transfer); no-op when the card already exists.

entityReference()  : T|null

Returns a light reference to an entity (id only) that the Api hydrator resolves as a managed entity.

extractPriceCell()  : array<string, mixed>|null

Extracts one cell (price, original price, points) from the raw tier array.

extractPriceGroupBase()  : array<string, mixed>

Returns the cells of one representative group of a tier as the base for `groupAll`; empty when no group exists (empty tier).

flashRejectedImages()  : void

Flashes gallery images that the Api rejected (type, dimensions, unreadable); the save went through without them. Uses the presenter channel (`flashMessagesSnippet` is redrawn after a save in both modes).

getDefaultUnitId()  : int|null

Returns the default unit for a new product: the first catalog unit by order.

getUnitOptions()  : array<int, NotTranslate>

Returns the unit options for the select: `unit_id => "pcs (piece)"`. Only active items: a deactivated unit is not offered for a new choice, but products that already have it keep it.

groupPriceRowsByUserGroup()  : array<int, array{userGroup: string, rows: list>}>

Turns the rows of one snapshot into one table per user group (order of `$this->userGroupOptions`, unknown groups last), sorted by currency x tier inside. The group is the table heading, so rows do not carry it.

httpRequest()  : IRequest

Returns the HTTP request through the presenter; a control has no `getHttpRequest()`.

isPriceTiersSameForAllGroups()  : bool

Returns true when every tier x currency has identical values across all user groups (a missing row is null and must match too).

isSignalRequest()  : bool

Tells whether a signal is being handled; a control has no `getSignal()`, only the presenter has.

isSnapshotEditable()  : bool

Tells whether a snapshot may be edited or deleted: only one dated today or scheduled in the future. `publishedTime` is a lexicographically comparable string.

isWizard()  : bool

Tells whether a new variant is being added: the `product-variant` mode with a new (unsaved) variant, created from scratch or as a duplicate (`$duplicateFromSetId`); in both cases `$variantId` is 0 or null.

loadAvailability()  : array{availableSets: ?int, inStock: bool, deliveryDays: ?int, infoText: ?string, attributeClass: ?string, unmappedVariantIds: list, unresolvedSetIds: list}|null

Loads the stock panel data. `available` is never cached: it is a live query on every render, even within one component instance.

loadContextProduct()  : Product|null

Loads the edited product (outside the set) in the `product-variant` mode, lazily; used for the GET prefill of new variant texts ({@see Traits\FormTrait::setProductSetFormDefaults()}) and for guards. `$productId` is server-side context from `ProductPresenter::createComponentSetEdit()`, never from the form.

loadCurrentPricePanel()  : array<int, array{price: string, originalPrice: string, points: int, fromAmount: int, currencyId: int}>

Loads the current price panel (price list tab) through `PriceResolver` (bridge action), not through the denormalized column.

loadDuplicateSourceSet()  : ProductSet|null

Loads the source selling set of a duplication, lazily; only for a new (unsaved) variant in the `product-variant` mode with the constructor context `$duplicateFromSetId` (supplied server-side by `ProductPresenter::createComponentSetEdit()`, which also ran the variant ownership guard). The GET defaults ({@see Traits\FormTrait::setProductSetFormDefaults()}, {@see Traits\ParameterFieldsTrait}) take scalars, texts, relations and parameters from it instead of the plain product name prefill. The `code`, the gallery (`assetRels`) and the stock item mapping (`stockItemId`) are not read from it, so they are not copied: a duplicate needs a new code and has no images.

loadFeedOverrideModes()  : array<int, string>

Returns the value modes of the edited set, `feedParameterId => mode`. Filled together with the rows ({@see loadFeedOverrideRows()}), it is the same bridge query.

loadFeedOverrideRows()  : array<int, array<int, string>>

Returns the override rows of the edited set across all feeds, `feedParameterId => list<value>`.

loadFeedOverrideStructure()  : array<int, array{feedId: int, feedName: string, tree: list>}>

Returns the feeds with their parameter trees, using one bridge query per feed (memoized).

loadFeedParameterActionLabels()  : array<int, string>

Returns the catalog of parameter actions, `actionId => translated name` (read-only).

loadProductSetSelectData()  : void

Loads the form axes (currencies, groups, regions, VAT, states) once per request, before the fields are built.

loadSnapshotSet()  : ProductSet|null

Returns the set with loaded price history (`includes: ['prices']`). Lazy.

loadStockLevels()  : array<int, array{warehouseName: string, quantity: string, reserved: string, available: string}>

Returns the read-only rows of the per-warehouse stock table.

loadWarehouseOptions()  : array<int, NotTranslate>

Returns the active warehouses for a select (id => "code — name"), only `activated=true`.

parsePickerName()  : array{0: string, 1: list}

Splits a picker instance name into the config key and the multiplier row indices; see {@see \App\UI\Admin\System\Presenters\Traits\Pickers\PickerHostTrait::parsePickerName()} for the full explanation of the separator.

prgAnchor()  : string

Returns the anchor for a non-AJAX PRG redirect (snapshot delete, "create card" etc.).

productLabel()  : string

Returns the product name in the current language (first non-empty as fallback).

productSetAncestorIds()  : array<int, int>

Returns the ancestors of a set in the composition tree, i.e. the sets that contain it directly or indirectly.

productSetFeeLabel()  : string

Returns the fee name in the current language (first non-empty as fallback).

productSetItemExcludeIds()  : array<int, int>

Returns the sets the composition picker must not offer: the edited set itself and all its ancestors (a set cannot contain itself). The authoritative guard is in the Api manager; this is UI prevention.

productSetLabel()  : string

Returns `<code> — <name>` in the current language (falls back to whichever part is non-empty).

productSetLinkLabel()  : string

Returns the link label: its URL in the current language (first non-empty address as fallback).

productTagLabel()  : string

Returns the tag name in the current language (first non-empty as fallback).

productVariantLabelsOf()  : array<int, string>

Returns the labels of all variants of a product: `variantId => "<product name> (#<variant id>)"`.

redrawVariantModal()  : void

Redraws the host snippet `setEditHost` on an AJAX submit error (validation or save failure).

redrawWizardStep()  : void

Redraws one wizard step: "add/remove tier" in step 2 (price matrix, `$onChange` of {@see PriceSnapshotTrait::buildPriceTierMatrix()}) invalidates only the snippet `wizardPriceStep`, not the whole component, so fields typed in other steps stay untouched in the DOM.

reloadEditedSet()  : void

Reloads `$this->editedSet` through the canonical `EDIT_INCLUDES`.

requireStockMovePrivilege()  : void

Enforces the stock privileges, one set for opening the sub-modal and for its submit.

resolveEditedSet()  : ProductSet|null

Returns `preloadedSet` (the presenter already has it from `actionEdit()`), otherwise loads the set by `setId`.

resolvePriceVatPercents()  : string|null

Returns the VAT rate for the client-side "price with VAT" computing when the form has no VAT select (the "Price list" edit modal); null when the rate is unknown (no seller or supply kind), then no preview is shown.

resolveProductLabel()  : string|null

resolveProductSetAccessoryLabel()  : string|null

resolveProductSetFeeLabel()  : string|null

resolveProductSetLinkLabel()  : string|null

resolveProductTagLabel()  : string|null

resolveProductVariantLabel()  : string|null

resolveSubmittedSnapshotTime()  : string|null

Returns the validity time from the form for the Api (`resolvePublishedTime()` takes the string as Europe/Prague).

saveProductSetForm()  : bool

saveProductVariantForm()  : bool

Saves mode `product-variant`: two entities through their own CRUD stack, in this order.

setPriceSnapshotFormDefaults()  : void

Prefills the form when editing; a new snapshot (`editingPriceSnapshotTime === null`) stays empty.

setProductSetFormDefaults()  : void

showPriceSnapshotModal()  : void

Fills the shared admin `ModalWindow` with the current form state and opens it.

showReceiveModal()  : void

showTransferModal()  : void

snapshotErrorKey()  : string

Maps a bridge response code (`OK`, `IMMUTABLE`, `TIME_COLLISION`, `NOT_FOUND`, `DENORM`, `VALIDATION`) to a message key.

suggestProducts()  : array<int, array{id: int, label: string}>

Suggests products by a `like` match on the product name.

suggestProductSetAccessories()  : array<int, array{id: int, label: string}>

Suggests sets by a `like` match on the set name, optionally without the edited set (a set cannot be its own accessory).

suggestProductSetFees()  : array<int, array{id: int, label: string}>

Suggests fees by a `like` match on the fee name.

suggestProductSetItems()  : array<int, array{id: int, label: string}>

Suggests composition items by a `like` match on the set name, excluding `$excludeIds`.

suggestProductSetLinks()  : array<int, array{id: int, label: string}>

Suggests links by a `like` match on the URL (`translations.value`) only, not on the name: names are often identical or missing, so only the address tells links apart.

suggestProductTags()  : array<int, array{id: int, label: string}>

Suggests tags by a `like` match on the tag name.

suggestProductVariants()  : array<int, array{id: int, label: string}>

Suggests variants by a `like` match on the owning product name (a variant has no text of its own).

toDateTimeLocalValue()  : string

Converts `Y-m-d H:i:s` (ORM string, UTC) to a `datetime-local` value in Prague time.

unitName()  : string

Returns the unit name in the current language, or the first non-empty translation when missing.

variantBelongsToContextProduct()  : bool

Returns whether the variant `$variantId` (deleted or not) belongs to the context product `$productId`.

warehouseLabel()  : string

Returns `code — name` (name in the current language, falling back to the first non-empty one).