CoolCMS API

ParameterPresenter extends AbstractParameterPresenter

in package

• Application

Eshop parameter administration (`/admin/eshop/parameter`): a thin leaf over the shared {@see AbstractParameterPresenter}, which holds the behavior (level-1 grid with a flat drag-and-drop mode, add/edit form, options, display rules).

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.

DISPLAY_EDITOR_MODAL_ID  : mixed = 'display-rule-editor-modal'

DOM id of the display rule editor modal (a shell separate from the options one).

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.

RESERVED_PARAMETER_KEYS  : array<int, string> = ['search']

Parameter keys reserved by the form layer; no parameter may use them, in any module.

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.

$activeDisplayEditorRuleId  : int

Rule active in the display rule modal (0 means a new rule).

$activeEditorRuleId  : int

Rule active in the editor modal (0 means a new rule); selects the `ruleEditor-<id>` control instance.

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

$columnSchema  : ColumnSchema

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

$container  : Container

$deviceDetector  : DeviceDetector

$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

$assetManager  : AssetManager

$dataGridFactory  : DataGridFactory

$debugMode  : bool

$editedParameter  : ParameterInterface)|null

Edited parameter (null when adding); the module's `Parameter` entity, see {@see parameterEntityClass()}.

$pickerFactory  : PickerFactory

$productionMode  : bool

$savedEntityId  : int|null

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

$translatorDomain  : string

$displayRuleOptionNameCache  : array<int, string>

Option (child parameter) names by id for the rule summaries of one render.

$editedParameterOptionsCache  : array<int, BaseEntity|ParameterInterface>|null

$isLoggingIn  : bool

$optionRulesFactory  : OptionRulesFactory

$parameterGroupManager  : ParameterGroupManager

$parameterManager  : ParameterManager

$parameterRuleManager  : ParameterRuleManager

$ruleEditorFactory  : RuleEditorFactory

$theme  : Theme|null

$userPrivileges  : array<int, string>

Methods

__construct()  : mixed

actionAdd()  : void

actionEdit()  : void

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

formatTemplateFiles()  : array<int, string>

Adds the shared fallback `Templates/<Name>/<view>.latte` after the theme and leaf paths.

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

handleDeleteDisplayRule()  : void

Deletes a rule from the pool (the FK cascade removes its conditions, values, sources and targets everywhere), then redirects back.

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

handleOpenDisplayEditor()  : void

Opens the display rule modal on the given rule (0 means a new rule).

handleOpenEditor()  : void

Opens the editor modal on the given rule (0 means a new rule), switching the active instance.

handleSignOut()  : void

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

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.

addDisplayRuleControl()  : void

Adds the staged `CheckboxList displayRules` (the whole rule pool) to the form; default = rules currently applied to the target.

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.

buildDisplayRulePool()  : array<int, array{ruleId: int, summary: string, isShared: bool}>

Builds the list rows for the whole rule pool: condition summary and whether the rule is used elsewhere too.

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

createComponentDisplayRuleEditor()  : Multiplier<string|int, RuleEditor>

Builds the display-rule editor in "conditions only" mode (`selectId=0`) with its own modal shell.

createComponentEditForm()  : Form

createComponentGrid()  : DataGrid

createComponentImageUpload()  : ImageUpload

createComponentModalWindow()  : ModalWindow

createComponentOptionRules()  : AbstractOptionRules

Immediate-save management of rules for options (`SHOW_SELECT_OPTIONS`) of the edited select.

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

createComponentRuleEditor()  : Multiplier<string|int, RuleEditor>

Builds the option rule editor as a Nette Multiplier: the key is the rule id (0 = new), so each rule gets its own isolated {@see RuleEditor} instance (prefilled by key). `selectId` comes from a closure over the edited parameter. Rendered live into the modal.

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.

displayRulesDomain()  : string

displayTargetColumn()  : string

Target column of display rules for this presenter (the parameter).

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

operatorsDomain()  : string

parameterEntityClass()  : string

parameterGroupManager()  : ParameterGroupManager

parameterManager()  : ParameterManager

parameterRuleManager()  : AbstractParameterRuleManager

parameterTextEntityClass()  : string

parseDateTime()  : DateTime|null

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

pickers()  : array<string, PickerConfig>

Returns no presenter-level pickers; the condition picker (source parameter) is hosted by the RuleEditor component itself.

requireRuleHostEditPrivilege()  : void

IMPORTANT: host `edit` gate for managing the global rule pool; call it as the first statement.

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

supportsBlacklistedWords()  : bool

supportsCoordinates()  : bool

supportsRules()  : bool

Tells whether the module uses parameter rules (dependent selects, display rules, option rules).

syncDisplayRuleControl()  : void

Writes the staged rule selection (form `displayRules`) into the targets of the given target.

addBasicFields()  : void

Key, input types, group and default values.

addBehaviorFields()  : void

Parameter behavior flags (checkboxes). "Always regenerate" (coordinates computed from the address on every save) only where adverts carry coordinates ({@see supportsCoordinates()}).

addContentFilterFields()  : void

Content filter (replacement of URL and forbidden words), a three-state {@see ContentFilterMode}.

addFileFields()  : void

Limits of uploaded files (relevant for the file and image types).

addOptionFields()  : void

Options section: flat multiplier of options (child parameters).

addOptionRowControls()  : void

Adds the fields of one option row: stable id, active flag, name and label per language, default flags.

addOptionsFields()  : void

Parameter options: the "has options" toggle in the Options tab.

addSearchConsistencyRules()  : void

IMPORTANT: "in the default filter" without a search field type makes the parameter invisible.

addTranslationFields()  : void

Multilingual parameter texts (one block of fields per language).

applyOptionsDefaults()  : void

Prefills the options editor on GET from the child parameters of the edited parameter.

buildOptionsMeta()  : array<int, array{optionId: int, active: bool, default: bool, searchDefault: bool, texts: array}>

Builds `meta['options']` from the multiplier values as flat options for the Api sync.

collectParameterImageMeta()  : array<string, mixed>

Builds `$meta` for saving: a new icon (base64) and/or the delete flag.

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

displayRuleName()  : string

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

displayRuleOperatorLabel()  : string

Returns the operator (validator) label for the rule summary.

displayRuleOptionNameById()  : string

Returns the option (child parameter) name by id.

displayRuleSharedBeyond()  : bool

Returns whether the rule has a target outside this display target (stricter delete confirm).

displayRuleSummary()  : string

Summarizes the rule conditions as "<source> <operator> <values>", joined with " + ".

editedParameterOptions()  : array<int, BaseEntity|ParameterInterface>

Returns the options (child parameters) of the edited parameter, with translations, ordered by `lft`.

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.

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

loadLocalization()  : Localization|null

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

optionRowField()  : mixed

optionRowInt()  : int

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

prepareContentFilterModeOptions()  : array<int, string>

Returns content filter options as `value => translation key` (off, onSave, onRender).

prepareParameterGroupOptions()  : array<int, NotTranslate>

Returns parameter group options as `id => name` (current language, falls back to the first non-empty one).

prepareTypeOptions()  : array<int, NotTranslate>

Returns parameter input types (ParameterType): key = constant, label = type name.

processFailedLogin()  : void

processInvalidToken()  : void

processLogin()  : void

processLoginException()  : void

processMissingToken()  : void

processSuccessfulLogin()  : void

processValidToken()  : void

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.

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

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.

saveParameterForm()  : bool

setNetteUser()  : void

setParameterFormDefaults()  : 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`.

translatedEntityName()  : string

Name of an entity with `translations` in the given language (falls back to the first non-empty one).

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.