CoolCMS API

ProductPresenter extends BasePresenter

in package

• Application

uses ProductFormTrait, ProductCategoryPickerTrait, PickerHostTrait, CatalogExportDownloadTrait, ImageUploadComponentTrait, AdminFormHelpersTrait, AdminEditFormComponentsTrait

Product card administration (`/admin/eshop/product`): a pivot form.

Table of Contents

Constants

LOGIN_BACKLINK  : string = 'backlink'

Login page parameter with the key of the stored request to return to ({@see loginReturnArgs()}).

DEFAULT_ITEMS_PER_PAGE  : mixed = 20

Items per page of admin lists when the DB setting is missing.

FORM_BACK_SUBSECTION  : mixed = 'formBack'

Session subsection mapping a key to the previous page URL of edit forms.

SESSION_NAMESPACE  : mixed = 'admin'

BLOCKED_EXTENSIONS  : mixed = ['php', 'php3', 'php4', 'php5', 'php7', 'php8',...

Extensions that must not be uploaded into the web-served folder; otherwise an editor upload would mean running foreign code on the server. It is no content whitelist (the editor uploads what is needed), only a safeguard against executable files.

EDITOR_PAGE_LIMIT  : mixed = 500

Listing cap; the dialog is a suggester, not a paged list.

EDITOR_PAGE_TARGETS  : mixed = ['front:system:page:show']

Routes the editor may link to: text pages only.

EDITOR_UPLOAD_FOLDER  : mixed = 'editorUploads'

Editor root (relative to the `uploads/` root). Changing it to `''` would open the whole `uploads/` tree to the manager; the editor user could then reach (and delete) files of other modules such as products and avatars.

IMAGE_EXTENSIONS  : mixed = ['jpg', 'jpeg', 'png', 'gif', 'webp', 'avif', '...

Extensions the file manager shows as a preview instead of a document icon.

LOCALE_MAP  : mixed = ['cs' => 'cs_CZ', 'en' => 'en_US', 'sk' => 'sk_...

Maps the short language code to the full locale of the registered NEON sources.

Properties

$accessTokenValidator  : AccessTokenValidator

Signature and expiry alone are not enough: a revoked token (`jti` on the deny-list) that has not expired yet would keep the session logged in although the Api guard rejects the same token. Same contract as {@see \App\Core\Traits\Api\Presenters\JwtAuthTrait::checkJwtAuth()}, one implementation.

$activeSetEditVariantId  : int

Active key of the variant edit modal: 0 is a new, not yet created variant, otherwise the id of an existing variant. Selects the `{control "setEdit-<key>"}` instance in the modal shell (snippet `setEditHost`).

$adminFormActionsFactory  : FormActionsFactory

$adminLangNavFactory  : LangNavFactory

$adminLanguageManager  : LanguageManager

$adminPageManager  : AdminPageManager

$authManager  : AuthManager

$authStorageManager  : AuthStorageManager

$authUserManager  : UserManager

Admin `UserManager` for {@see UserManager::login()}. A module must not read through another module, so admin has its own `login()` that calls the same Api endpoint (`api/system/auth/login`).

$catalogExportManager  : ProductImportManager

$columnSchema  : ColumnSchema

Limits of the real database columns for {@see guardColumns()}.

$container  : Container

$deviceDetector  : DeviceDetector

$duplicateFromVariantId  : int

Id of the source variant when the active modal instance (key 0, a new unsaved variant) was opened by duplicating a variant; 0 means no duplicate context. `createComponentSetEdit()` resolves it server-side (guarded by `ownsVariant()`) to the source sellable set id.

$editorAutosaveScope  : EditorAutosaveScope

Scope of the editor autosave drafts, see {@see \App\Core\Security\EditorAutosaveScope}.

$editorLinkPageManager  : PageManager

NOTE: own property name. `$pageManager` already exists on presenters (`PagePickerTrait`), and two `#[Inject]` properties of the same name would collide in the trait composition.

$editorUploadManager  : FileSystemManager

NOTE: own property name, not `$fileSystemManager`.

$eventDispatcher  : EventDispatcher

$formSubmissionGuard  : FormSubmissionGuard

One-time submission tokens of "add" forms, see {@see guardFormSubmitOnce()}.

$imageUploadFactory  : ImageUploadFactory

$jwtManager  : JwtManager

$languageContext  : LanguageContext

$languageManager  : LanguageManager

$localizationContext  : LocalizationContext

$localizationManager  : LocalizationManager

$loginDeviceCookie  : LoginDeviceCookie

Cookie of a known device for the password login throttle ({@see self::rememberLoginDevice()}).

$modalWindowFactory  : ModalWindowFactory

Injected through Nette presenter inject (after construction), not the constructor.

$picker  : string

Picker mode of a list; when not empty, the presenter renders its `show` grid as a selection modal (no add/edit/delete/checkboxes, each row has a select button) in the minimal `@picker.latte` layout.

$pickerExclude  : int

Id of the record that cannot be selected in picker mode (its select button is hidden).

$pickerExcludeSubtreeLft  : int

`lft`/`rgt` bounds of a whole subtree whose nodes cannot be selected in picker mode.

$pickerExcludeSubtreeRgt  : int

$presenterContext  : PresenterContext

$privilegeManager  : PrivilegeManager

$queryCacheContext  : QueryCacheContext

Query cache policy for the whole admin request; `startup()` disables it.

$routerDispatcher  : RouterDispatcher

$settingContext  : SettingContext

$settingManager  : SettingManager

$themeContext  : ThemeContext

$themeManager  : ThemeManager

$themeResolver  : DefaultThemeResolver

$translator  : ITranslator

$translatorSessionResolver  : Session

$userManager  : UserManager

$adminPageEntity  : AdminPage|null

$debugMode  : bool

$productionMode  : bool

$savedEntityId  : int|null

Id of the record just saved; set by the `$processData` callback in `createForm()` after a successful save.

$translatorDomain  : string

$currencyManager  : CurrencyManager

$currencyOptions  : array<int, string>

$dataGridFactory  : DataGridFactory

$editedProduct  : Product|null

Edited product (null when adding).

$isLoggingIn  : bool

$pickerFactory  : PickerFactory

$producerManager  : ProducerManager

$producerOptions  : array<int, string|NotTranslate>

$productCategoryManager  : ProductCategoryManager

$productManager  : ProductManager

$productSetEditFactory  : ProductSetEditFactory

$productSetManager  : ProductSetManager

$productStatisticsFactory  : ProductStatisticsFactory

$productTypeManager  : ProductTypeManager

$productTypeOptions  : array<int, string|NotTranslate>

$productVariantManager  : ProductVariantManager

$theme  : Theme|null

$userPrivileges  : array<int, string>

Methods

__construct()  : mixed

actionAdd()  : void

actionEdit()  : void

actionStatistics()  : void

Product statistics (`/admin/eshop-produkt/statistiky?id=…`).

beforeRender()  : void

createComponent()  : IComponent|null

flashFormOwnErrors()  : void

Flashes form-level errors (`$form->getOwnErrors()`) as `danger` messages.

flashRejectedUploads()  : void

Flashes one `warning` listing the files the Api rejected (type, dimensions, unreadable) after a successful save of a form with a dropzone ({@see UploadRejection}).

formatLayoutTemplateFiles()  : array<string|int, mixed>

Admin version of {@see \App\Core\Traits\Front\Presenters\ThemeInitTrait::formatLayoutTemplateFiles()}.

getAdminPageEntity()  : AdminPage|null

getContainer()  : Container

getFormBackUrl()  : string

Returns the stored previous page URL for the key, used by the `cancel` link in the template.

getModalWindow()  : ModalWindow

getRouterDispatcher()  : RouterDispatcher

getTranslator()  : ITranslator

guardFormSubmitOnce()  : void

Protects a form against a double submit: one rendered form saves at most once.

handleChangeLocale()  : void

handleDeleteVariant()  : void

Deletes a variant from the variant list: hard delete without history; with an order, complaint or gift it is only hidden (`deleted=1`, cascaded to its type 1 set), see {@see ProductVariantManager::deleteOrHide()}. A non-AJAX link (`data-grid-confirm`), so it always ends with a full redirect back to the tab, not a redraw.

handleDuplicateProduct()  : void

Duplicates a product from the products grid (a grid signal on the `show` page).

handleDuplicateVariant()  : void

Duplicates a variant from the variant list: opens the modal as a new variant (key 0) in the duplicate context, so the component defaults are loaded from the source variant `$variantId` instead of a bare product name prefill. See {@see handleOpenSetEdit()}.

handleEditorCreateFolder()  : void

Creates a subfolder in `folder` (path relative to the editor root).

handleEditorDelete()  : void

Deletes a file or (recursively) a folder. An empty path would point to the editor root, which cannot be deleted.

handleEditorFiles()  : void

Sends the folder listing for the editor file manager. The `folder` parameter is a path relative to the editor root (empty means the root).

handleEditorPages()  : void

Sends the page list for the link dialog as JSON `{"pages": [{id, label, url}, ...]}` sorted by label.

handleEditorRename()  : void

Renames a file or folder (`path` relative to the editor root).

handleEditorUpload()  : void

Accepts a file from the editor (field `file`, multipart POST; optional `folder` = subfolder of the editor root) and sends JSON `{"location": "/www/uploads/editorUploads/..."}`, the format TinyMCE expects from `images_upload_handler`.

handleLogout()  : void

handleOpenSetEdit()  : void

Opens the variant edit modal: switches the persistent active key and lets the AJAX response show the shared shell (`product-set-edit-modal`).

handleSignOut()  : void

handleToggleVariantActivated()  : void

Toggles the activation of the variant sellable set from the variant list (data stay, the row is only greyed out). Uses the same path as `ToggleRenderer` of the grid (`updateColumn`), outside a DataGrid because the variant list is not a grid.

hasServiceByType()  : bool

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

initializeTranslator()  : void

isAddAction()  : bool

Tells whether the current action creates a record: `add` and the `add<Something>` actions (`addMenu`, `addKey`). Derived from the server context only, like {@see formSubmitPrivilege()}.

isAllowed()  : bool

Returns whether the logged-in user has the given privilege.

isSubmitOnceForm()  : bool

Tells whether the form was protected by {@see guardFormSubmitOnce()}.

loginWithCredentials()  : void

Logs in with username and password; called only by the login form (after validation and CSRF).

publishFieldErrors()  : void

Publishes element errors of a failed submit to the client.

redirectToFormBack()  : void

Redirects to the stored previous page and discards the key.

renderAdd()  : void

renderEdit()  : void

renderShow()  : void

renderStatistics()  : void

resolveFormBackKey()  : string

Returns the previous-page key: from the URL if present (survives the update redirect), otherwise on a plain GET render of the edit page stores `Referer` in the session under a new random key.

runSubmitOnce()  : bool|null

Runs a saving step of a form under its one-time token (a form without the token just runs it).

setConfigParameters()  : void

setTranslator()  : $this

startup()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

authorize()  : void

Authorization hook; by default requires the `:Admin` privilege.

authorizeFormSubmit()  : void

Gate for writing presenter forms built by `createForm()`.

authorizeListing()  : void

Gate for reading lists.

checkAdminAccess()  : void

Entry gate to the admin: a guest is sent to login; a logged-in user without `:Admin` is sent to login with an error.

checkAuthentication()  : void

checkCurrentPrivilege()  : void

Builds the key from the current request (`:Admin:<Module>:<Presenter>:<action>`) and checks it. `getName()` already contains the `Admin:...` prefix, so only one leading colon is added.

checkPrivilege()  : void

Checks a specific privilege; throws 403 when denied.

createComponentAdminFormActions()  : FormActions

createComponentAdminLangNav()  : LangNav

createComponentEditForm()  : Form

createComponentGrid()  : DataGrid

createComponentImageUpload()  : ImageUpload

createComponentModalWindow()  : ModalWindow

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

createComponentSetEdit()  : Multiplier<string|int, ProductSetEdit>

Variant edit modal (Multiplier key is `variantId` or 0). Only one active instance is rendered at a time (persistent key, see `$activeSetEditVariantId`). `productId` comes from `getParameter('id')`, not from `$editedProduct`, so it does not depend on the order of `actionEdit()` and AJAX signals such as `openSetEdit!`.

createComponentStatistics()  : ProductStatisticsControl

Product statistics component scoped to the edited product.

createForm()  : Form

Creates an edit form with the standard actions and a return to the previous page.

currentLangId()  : int|null

Returns the current language id (for picker labels etc.), null when unknown.

domainTranslator()  : PrefixedTranslator|null

Returns a translator prefixed with the presenter domain, or `null` (empty domain or a translator other than Contributte).

formSubmitPrivilege()  : string

Returns the privilege key required to save a form built by `createForm()`.

getAdminItemsPerPage()  : int

Returns the default items per page of admin lists from the DB setting `admin.itemsPerPage` (module System = 1), falling back to {@see DEFAULT_ITEMS_PER_PAGE}.

getAdminLayout()  : string

Returns the layout name; in picker mode ({@see $picker}) the `show` grid uses the minimal `@picker.latte` (no sidebar/header) so the opener fetch returns only the table.

getFormBackFallback()  : string

Returns the return URL when the previous page is unknown; override in a presenter without a `show` action.

getFormLanguages()  : array<int, Language>

Returns the languages for multilingual form fields (admin `LanguageManager`).

getSessionKey()  : string

Returns a session key string, e.g. 'front.auth.step1'.

getSessionSection()  : SessionSection

Returns a Nette\SessionSection instance using a dynamically built session key.

guardColumns()  : void

Gates every text and number field of the form by the real column it writes to ({@see \App\Core\Forms\ColumnGate::guard()}): an oversized value is an error at the field, never a database error that closes the entity manager (admin walkthrough A1, A14).

initializePresenterContext()  : void

intOrNull()  : int|null

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

isSameSiteRequest()  : bool

Tells whether the request comes from the own site (Nette SameSite cookie); protects GET actions with a side effect.

loadUserPrivileges()  : void

Loads all privileges of the logged-in user with one database query. Call it right after `checkAdminAccess()` in `startup()` (the user is guaranteed to be logged in by then).

logout()  : void

parseDateTime()  : DateTime|null

Converts a `datetime-local` input or text value to `DateTime`, or null when empty or unparsable.

pickers()  : array<string, PickerConfig>

Presenter pickers. They sit in the category multiplier row (`targetContainer`), so Latte renders them as `{control "picker-<key>_{$row->getName()}"}`. Must stay side-effect free: it is also called by the AJAX signal `suggest!`, when the form may not be built yet.

productCategoryMultiPicker()  : PickerConfig

Category picker for a multiplier row (M:N product to category), like {@see \App\UI\Admin\Bazaar\Presenters\Traits\Forms\AdvertCategoryFieldsTrait::categoryMultiPicker()}.

productCategoryParentPicker()  : PickerConfig

Parent category picker (single field, self-reference), like {@see \App\UI\Admin\Blog\Presenters\Traits\Pickers\CategoryPickerTrait::categoryParentPicker()}.

sendCatalogExport()  : void

setTranslatorDomain()  : void

setupTemplateTranslator()  : void

Sets a translator prefixed with the presenter domain into the template (as Front components do, see {@see \App\Core\Base\BaseComponent::setup()}).

str()  : string

Safely converts a mixed form value to string.

strOrNull()  : string|null

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

addProductBaseFields()  : void

Basics: producer, type, activation, main photo.

addProductCategoryFields()  : void

Categories (M:N): multiplier of rows with a Picker. A row is a hidden `categoryId` + a text label `category` (rendered by the Picker itself; {@see \App\UI\Admin\Eshop\Presenters\Traits\Pickers\ProductCategoryPickerTrait}).

addProductTranslationFields()  : void

Multilingual fields: one set per language (`<field>_<langId>`), active per checkbox.

buildDuplicateProduct()  : Product

Builds a product copy from the source entity, see {@see handleDuplicateProduct()}.

buildProductCategories()  : ArrayCollection<int, ProductCategory>

Categories as light id references: Api `hydrateForPersist` looks them up as managed entities and syncs the join table.

buildProductEntity()  : Product

Product + texts + categories. On edit it works with the loaded entity (it carries associations the form does not edit, which the object-graph save would otherwise null; `variants` is in Api `defaultSkipFields`, so this save never touches it).

categoryName()  : string

Returns the category name in the current language (falls back to the first non-empty one).

collectProductImageMeta()  : array<string, mixed>

Main photo for `$meta`: a new image (base64) and/or the delete flag. The Api makes an Asset (variants) from it and sets the FK.

createIdentity()  : SimpleIdentity|null

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.

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

editorBreadcrumb()  : array<int, array{label: string, path: string}>

Builds the breadcrumb navigation: cumulative segment paths.

editorLinkLangId()  : int

Returns the language used to pick labels and URLs (default 1, Czech).

editorPageLabel()  : string

Returns the page label: title, otherwise name, otherwise `#id`.

editorPageRoute()  : Route|null

Returns the first page route the editor may link to. A page may have several (many-to-many); the whitelisted one is taken, not the first in order, so a page with both `Page:show` and `Page:form` ends up on the right one.

editorPageUrl()  : string|null

Returns the front end address of a page. The router builds it from the page route, so `/o-nas` and any prefix come out on their own.

editorParentFolder()  : string|null

Returns the parent folder (null in the editor root).

editorPath()  : string|null

Converts a client path (relative to the editor root) to an Api path (relative to the `uploads/` root).

editorUploadName()  : string|null

Builds a safe and unique file name. Sanitization copies the Api layer rules (webalize of the base and of the extension), so the name returned in the URL is exactly the name the file is stored under. The random suffix prevents collisions: `writeFile()` overwrites the same name without asking, so two different `obrazek.jpg` files would overwrite each other.

editorUploadUrl()  : string

Returns the public URL of a file. `$path` is relative to the `uploads/` root (so it includes `editorUploads/`), the same shape as other uploads in the system.

ensureEditorRoot()  : void

Creates the editor root folder; when it already exists the Api returns false and nothing happens.

expireIdleLogin()  : bool

Returns whether the login expired from inactivity. If so, revokes the tokens (like a logout), clears the `auth` section, logs out the Nette identity and returns true; otherwise moves the activity stamp forward.

findSellableSet()  : ProductSet|null

Returns the sellable set (type 1, not deleted) of the variant, or null.

finishVariantAction()  : void

Redraws the list and flash on AJAX, otherwise does a full redirect.

flashGuardError()  : void

formatAvailabilityText()  : string

getClientIp()  : string

initializeMetaTags()  : void

Fills the template with the title, meta tags and HTML text of the page from the translation (`PageText`) of the current language, for the layout (like the Front {@see \App\Core\Traits\Front\Presenters\PageInitTrait}).

initializePage()  : void

isDevelopment()  : bool

loadCurrencyOptions()  : void

Loads currency labels for the current price in the variant list, once per request.

loadLocalization()  : Localization|null

loadProductSelectData()  : void

Form axes (producers, product types), once per request, before building fields and defaults.

loadVariantListRows()  : array<int, array{variantId: int, hasSet: bool, setId: ?int, code: ?string, name: ?string, price: ?string, availabilityText: ?string, activated: bool}>

Builds the variant list rows (Variants tab): product variants (not deleted) and their type 1 sellable sets in one query (no N+1). Includes are only `translations` and `variant`: a plain read, saving is done solely by the modal component.

localizationCurrencyKey()  : string|null

Admin ignores the localization currency (it takes the language only).

loginReturnArgs()  : array<string, string>

Remembers the request of a logged-out user so the login can return to it ({@see storeRequest()}, `backlink` of the login page, restored by `AuthStorageTrait::redirectAfterLoginAction()`).

logoutNetteUser()  : void

ownsVariant()  : bool

Tells whether the variant belongs to the edited product, judged from the loaded entity, not the request.

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

Splits a picker instance name into the config key plus row indexes (multiplier and nested multiplier). `parentId` -> `['parentId', []]`; `address_2` -> `['address', ['2']]`; `parameter_1_0` -> `['parameter', ['1','0']]` (nested).

persistProduct()  : Product|null

Shared save logic of `save`/`update` and `saveAndVariants`: builds the entity, saves it (object graph + main photo meta) and flashes the result. Returns the saved entity (with id) or null on error.

processFailedLogin()  : void

processInvalidToken()  : void

processLogin()  : void

processLoginException()  : void

processMissingToken()  : void

processSuccessfulLogin()  : void

processValidToken()  : void

productName()  : string

Returns the product name in the current language (falls back to the first non-empty one, then `#id`).

readLoginDeviceToken()  : string|null

Returns the raw known-device cookie for the Api login (the Api verifies its signature).

redirectAfterLoginAction()  : void

After a login attempt: a successful login returns to the request remembered before the login (`backlink`, {@see PrivilegeCheckTrait::loginReturnArgs()}), otherwise to the dashboard; a failed one stays on the login page and keeps the way back.

referenceOrNull()  : T|null

Light entity reference (id only); the hydrator looks it up as managed on the Api side.

refreshNetteIdentity()  : bool

Refreshes the token of the same logged-in user: identity data (token, name, email) are overwritten in the stored object without `login()`, so neither the session id nor the form CSRF tokens change. The identity is stored in the session section as an object; the change is written at the end of the request.

rememberLoginDevice()  : void

After a successful login (password or OAuth) issues or renews the known-device cookie ({@see LoginDeviceCookie}): a signed proof that this browser has already logged in to the account. The next login sends it to the Api ({@see self::processLogin()}), and above the account limit the password from this browser is still verified, so foreign attempts do not lock out the owner. HttpOnly, SameSite=Lax, Secure on HTTPS; lifetime from `ratelimit.loginDevice.cookieLifetime`.

resolveCatalogExportPath()  : string|null

Builds the path the same way as the import (`ProductImportEditTrait::resolveImportPrivatePath()`), in a different subdirectory.

resolveCategoryLabel()  : string|null

resolveDuplicateFromSetId()  : int|null

Resolves the source sellable set for `$duplicateFromVariantId`. It comes only from the persistent presenter context (never from the form), guarded by `ownsVariant()`. Key 0 without an active duplicate context returns null (a plain "add variant").

resolveLoginErrorMessage()  : string

Resolves the flash message of a failed login.

revokeTokensOnLogout()  : void

Calls the Api logout (revokes the refresh family and deny-lists the access `jti`) for the tokens of the current session. Fail-open on purpose: any failure is only logged, because the local logout must not stay unfinished.

saveProductAndManageVariants()  : void

"Save product first" button: its own onClick outside the save/update gate (see the comment at `$saveAndVariants` in `createComponentEditForm()`). Shares the save logic with `saveProductForm()` via `persistProduct()` and on success also navigates to the edit (the right column switches from the gate button to the variant list).

saveProductForm()  : bool

setNetteUser()  : void

setProductFormDefaults()  : void

storeEditorUpload()  : bool

Stores a file; the target folder may not exist (first upload into the root), so after a failure the root is created once and the write is retried. Deeper subfolders are created by the editor user through `editorCreateFolder`.

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

Suggests categories by a LIKE match on the name, optionally without the excluded node and its whole subtree (parent self-reference).

tryRefresh()  : bool

Tries an auto-refresh for an expired access token. If the session holds a refresh token and the Api accepts it, stores the new pair in the session and returns true; otherwise returns false and the caller cancels the session.

variantSetName()  : string

Returns the sellable set name in the current language (falls back to the first non-empty one).