CoolCMS API

DataGrid extends BaseComponent

in package

• Application

uses InitializationTrait, FormTrait, HandleTrait, CsvExportTrait, TreeStateTrait, TreeMoveTrait

Generic admin datagrid: a table overview of the records of any Admin manager ({@see Manager}).

$grid = $this->dataGridFactory->create();
$grid->setDataSource($this->pageManager)->setIncludes(['translations']);
$grid->addColumn(Column::create('name')->setProperty('translations.name')->setSortable());
$grid->addRowAction(RowAction::create('edit')->setLink(':Admin:System:Page:edit', ['id' => 'id']));

Table of Contents

Constants

CONFIRM_FIELD  : string = '_confirmed'

POST flag of a confirmed delete; the confirmation modal (`datagrid.js`) adds it, the server deletes nothing without it ({@see HandleTrait::requireDeleteConfirmation()}).

PER_PAGE_OPTIONS  : mixed = [25, 50, 100]

Page-size choices (header links; "Default" is null).

TREE_CHILDREN_LIMIT  : mixed = 500

Default cap of children of one parent in a tree; see {@see setTreeChildrenLimit()}.

TREE_FULL_LIMIT  : mixed = 500

A tree up to this many nodes (within the scope) opens fully expanded on first view, "Expand all" is refused above it, and a non-collapsible tree ({@see setTreeCollapsible()}) behaves as collapsible above it as a safeguard.

TREE_SESSION_MAX_IDS  : mixed = 5000

At most this many expanded node ids are kept in the session (guard against bloat).

VIEW_LIST  : mixed = 'list'

VIEW_TREE  : mixed = 'tree'

CSV_BATCH_SIZE  : int = 500

Batch size for reading `findAll()` incrementally.

CSV_DELIMITER  : string = ';'

Field delimiter: a semicolon (Czech Excel convention), not a comma.

Properties

$container  : Container

$dir  : string|null

Sort direction `asc`|`desc`.

$filters  : array<string, mixed>

Values of the search fields keyed by column name. Range stores `['from' => …, 'to' => …]`, multiselect an array of values.

$orderBy  : string|null

Column name the list is sorted by (click on the heading).

$page  : int

$perPage  : int|null

User override of rows per page; null means the default (`setItemsPerPage()`).

$reorder  : bool

"Reorder" mode: switches a tree grid from the flat table (arrows) to the nested drag & drop view ({@see isDragView()}). The user turns it on with a toolbar button; it applies only in the tree view.

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$treeRoot  : int|null

Tree focus: the grid shows only the subtree of the node with this id (children are the first level) and a breadcrumb above it. Persistent so the URL can be shared; the expansion state is kept in the session instead ({@see TreeStateTrait}). null means the whole tree.

$view  : string|null

Tree grid view: `list` is the flat paged list with a "Path" column (default), `tree` the hierarchy with ▸/▾ and focus. The choice is remembered in the session per grid ({@see TreeStateTrait::isTreeViewChosen()}); null means session / default.

$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|null

$addDestination  : string|null

$addParams  : array<string, mixed>

$addPrivilege  : string|null

Privilege key of the "add" button; `null` derives it, `''` never hides. See {@see setAddLink()}.

$columns  : array<string, BaseColumn>

$csvExportEnabled  : bool

Whether the CSV export button is shown in the grid toolbar; off by default. Enabled by {@see enableCsvExport()}, served by {@see CsvExportTrait::handleCsvExport()}.

$csvExportFileName  : string|null

$dataSource  : Manager<BaseEntity, ServiceInterface<string|int, BaseEntity>>|null

$defaultFilters  : array<string|int, Filter>

$defaultOrder  : array<string, bool>

$defaultOrderCustomized  : bool

Whether the presenter already overrode the default order; see {@see self::setDefaultOrder()}.

$deleteMethod  : string

Name of the manager method called by the `delete!` signal ({@see HandleTrait::handleDelete()}) and the group action 'delete' ({@see FormTrait::processGroupAction()}). Defaults to `'delete'` (hard delete).

$dragDrop  : bool

Drag & drop move of tree nodes; enabled via {@see enableDragDrop()}.

$dragFlat  : bool

Flat drag mode: SortableJS runs only over the root list of siblings and nested lists (drop targets for changing the parent) are not initialized. For grids that may only reorder, not change the parent (e.g. main parameters).

$explainedDeleteFailures  : array<int, true>

Delete result codes whose message from the `results` domain is shown to the admin instead of the generic failure message, see {@see explainDeleteFailures()}.

$explainedUpdateFailures  : array<int, true>

Inline update (toggle, select) result codes whose message from the `results` domain is shown instead of the generic failure, see {@see explainUpdateFailures()}.

$filterControlNames  : array<string, string>|null

Column => name of its filter control; computed lazily once.

$groupActions  : array<string, GroupAction>

$highlightId  : int|null

Highlighted row, the target of the "Show in tree" action. The `highlight` parameter is one-shot (not persistent): only the action link carries it, other grid links do not, and the JS removes it from the URL after scrolling the row into view, so a reload does not highlight.

$includes  : array<string|int, string>

$initialized  : bool

$itemIdentifier  : string

$items  : array<int, object>

$itemsById  : array<int, object>

$itemsPerPage  : int

$moveNode  : object|null

Node being moved in this request (signal or modal submit).

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

Messages inside the modal; per request, not a session flash, which would resurface on the next open.

$pendingConfirmation  : array{message: ?string, actionLabel: ?string, ids: list, action: string, fields: list}|null

Delete waiting for confirmation (no flag in the POST): message of the action, record ids, the URL and the POST fields to repeat. `render()` then draws the confirmation page.

$pickerData  : array<string, string>

$pickerExcludeId  : int|null

Id of the record that cannot be picked (self-reference); its row gets no "Select".

$pickerExcludeSubtreeLft  : int|null

lft/rgt of the whole subtree that cannot be picked (moving a node under its descendant).

$pickerExcludeSubtreeRgt  : int|null

$pickerFactory  : PickerFactory|null

$pickerLabelCallback  : callable(object): string|null

$pickerLabelProperty  : string|null

$pickerMode  : bool

Picker mode: the grid serves as a record picker for a foreign form.

$pickerName  : string

$rowActions  : array<string|int, RowAction>

$rowDecorator  : callable(array<int, object> $items): void|null

Optional decorator of the loaded page of records. It is called once with the whole page (not per row), so it can run one batch query and write the values into `#[Transient]` entity properties via setters. For columns that cannot be computed from one entity (an aggregate over a foreign table, e.g. stock summed over warehouses) without the grid knowing JOIN/GROUP BY.

$totalCount  : int

$tree  : bool

$treeChildrenLimit  : int

$treeCollapsible  : bool

Collapsible tree (▸/▾, focus, session); `false` means always fully expanded (menu).

$treeDefaultView  : string

Default view of a tree grid until the user switches it.

$treeLimitLogged  : bool

The non-collapsible tree safeguard has already logged (render and signal in one request).

$treeMeta  : array<int, array{level: int, parentId: int, hasChildren: bool, expanded: bool, up: bool, down: bool}>

Metadata of the visible tree nodes ({@see TreeRowsBuilder}).

$treeMoreAfter  : array<int, array<int, array{parentId: int, count: int, level: int}>>

$treeNested  : array<int, array{id: int, children: array, more: int}>

$treeNodeCount  : int|null

$treeOrderProperty  : string

$treeParentProperty  : string

$treePaths  : array<int, array{full: string, short: string, segments: list}>

Paths of the rows of the current flat list page ({@see loadTreePaths()}).

$treePositionFactory  : TreePositionFactory|null

$treeRightProperty  : string|null

$treeRootMissing  : bool

The focused node from the URL does not exist (deleted or foreign scope); the template shows a notice.

$treeRootMore  : int

How many children of the view root did not fit under the cap.

$treeRootNode  : object|null

$treeRootResolved  : bool

$treeScope  : array<string, scalar|null>

Methods

__call()  : mixed

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

__construct()  : mixed

addColumn()  : self

addDefaultFilter()  : self

Core filter applied on every load (grid scope).

addGroupAction()  : self

addRowAction()  : self

buildCellHref()  : string|null

Returns the href the cell content is wrapped in when the column has a link ({@see BaseColumn::setLink()}). Parameters are mapped from row properties. In picker mode links are suppressed because a selection must not leave the modal. When a required parameter ({@see BaseColumn::getLinkRequiredParams()}) is missing (null / ''), no link is generated, a guard against broken links and a crash on a missing id.

buildRowActionHref()  : string

Row action URL (a presenter link, or a grid signal with the record id).

buildShowInTreeHref()  : string

Builds the "Show in tree" link: cancels search, ordering and page, focuses the parent of the row (a root means no focus; a non-collapsible tree has no focus) and highlights the row once.

canMoveNodes()  : bool

Tells whether "Move to..." is offered; same gate as drag and drop (a flat drag must not change the parent).

canReorder()  : bool

Returns whether the "Reorder" view can be switched on. Drag & drop over a tree outside picker mode is enough; the button is available also with user sorting or a filter (flat table).

canSortChildren()  : bool

Tells whether "sort children alphabetically" is offered.

createComponent()  : IComponent|null

enableCsvExport()  : self

Enables the "Export CSV" button in the grid toolbar; opt-in, without the call the grid is unchanged and no export code runs. The export reads the current filter and sort state and all rows (no paging, in batches; see {@see CsvExportTrait}); columns are the visible grid columns (not actions).

enableDragDrop()  : self

Enables drag & drop move of nodes in a tree grid. Works only when {@see setTreeStructure()} is set and the manager implements {@see \App\Core\Traits\Api\Models\Managers\TreeTrait::moveSubtreeTo()}.

explainDeleteFailures()  : self

Opts in to showing domain reasons for a rejected delete to the admin (e.g. a job cannot be deleted because it contains invoiced work sheets).

explainUpdateFailures()  : self

Opts in to showing the domain reason of a refused inline update (e.g. the only default PDF layout cannot be turned off). Same rules as {@see explainDeleteFailures()}: each code needs a `results.<camelCase>` translation in cs/en/sk, generic codes do not belong here.

getAppContext()  : AppContext

getAttachedPresenter()  : Presenter

Presenter of the grid; the component is always attached during render and signals.

getBodySnippetNames()  : array{string, string}

Returns the whole body snippet and the area with `row-<id>` rows for the current view.

getColumn()  : BaseColumn|null

getComponentParameter()  : mixed

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

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getDataSource()  : Manager<BaseEntity, ServiceInterface<string|int, BaseEntity>>|null

getFilterControlName()  : string

Returns the form control name of the filter of the given column.

getHighlightId()  : int|null

getItemId()  : int

Record primary key.

getItemParentId()  : int

Parent id of a tree node (0 is the real root).

getItemsPerPage()  : int

Effective rows per page (user override, otherwise the default).

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getMoveNotices()  : array<int, array{key: string, type: string}>

Returns the messages for the modal; the template translates them by the full grid domain key.

getNestedItems()  : array<int, array{item: object, children: array, more: int, meta: array}>

Returns the list items as a nested tree for the drag & drop template; SortableJS Nested Sortables needs genuine `<ul>/<li>` nesting, not a flat table. Built from the same data as the table ({@see \App\UI\Admin\System\Components\DataGridComponent\Utils\TreeRowsBuilder}); `more` is the number of children above the cap, `meta` the expansion / has-children state.

getPickerData()  : string

Row data for picking in picker mode; JSON `{key: value}` for `data-pick-data`.

getPickerLabel()  : string

Row label for picking in picker mode; returned to the opener (hidden + text).

getRouterDispatcher()  : RouterDispatcher

getRowLabel()  : string

Returns the accessible name of a row for the bulk-action checkbox: same source as {@see getPickerLabel()} (first non-id column / picker label property or callback) but with a different fallback: an empty label becomes "#<id>", never a bare anonymous `ids[]`.

getSettingContext()  : SettingContext

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

getThemeContext()  : ThemeContext|null

getTreeLabel()  : string

Returns the node label for breadcrumbs: the value of the indented column, otherwise the picker label.

getTreePath()  : array{full: string, short: string, segments: list}|null

groupActionPrivilege()  : string|null

Returns the privilege that governs the given group action, or null when it has none.

handleCollapse()  : void

handleCollapseAll()  : void

Collapses everything, also outside the focus (nothing visible there is lost by collapsing).

handleCsvExport()  : void

handleDelete()  : void

handleDragDrop()  : void

Moves a node in the tree by drag and drop, changing the parent and the position among siblings.

handleExpand()  : void

handleExpandAll()  : void

Expands the whole current (focused) subtree, only up to {@see DataGrid::TREE_FULL_LIMIT} nodes in total; above it a "focus a smaller branch" message is shown and the state stays unchanged.

handleInlineUpdate()  : void

handleMoveDown()  : void

handleMoveModal()  : void

Opens the "Move to..." modal for a node (AJAX; without JS it just returns to the list).

handleMoveUp()  : void

handleRelationToggle()  : void

Toggles a join table link, a {@see RelationColumn} cell (a flag from a related collection picked by `scope`, e.g. a role in the RBAC matrix).

handleSortChildren()  : void

Sorts the direct children of a parent by label (current language collation) in one operation under the tree lock. `parentId` 0 is the root level of the view (the real roots without focus).

handleTreeRefresh()  : void

Only redraws the tree body; the JS calls it after a rejected move (`TREE_STALE`) or a parent change.

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

isActionAllowed()  : bool

Returns whether the user has the privilege for the given action (`del`, `export`…) in this list.

isCsvExportEnabled()  : bool

isDeleteAllowed()  : bool

Returns whether the user may delete in this list; one answer for the whole grid.

isDragDropEnabled()  : bool

isDragFlat()  : bool

Flat drag mode (reordering only, no parent change); see {@see enableDragDrop()}.

isDragView()  : bool

Returns whether the tree drag & drop view is active: a nested `<ul>/<li>` list with SortableJS Nested Sortables. It requires a tree ({@see canReorder()}) and the user having switched on "Reorder" (persistent `reorder`).

isPickerMode()  : bool

isPickerSelectable()  : bool

Whether the row can be picked in picker mode (false when excluded, e.g. self-reference or descendant).

isTreeCollapsible()  : bool

Tells whether the tree can be collapsed.

isTreePathVisible()  : bool

Tells whether the flat list shows the "Path" column and the "Show in tree" action: only a tree grid with a right bound (ancestors are found from `lft/rgt`) outside the tree view, where indentation and breadcrumbs carry the path.

isTreeViewChosen()  : bool

Tells whether the tree view is chosen: the `view` URL parameter (stored in the session), otherwise the session, otherwise the grid default. The picker modal (parent selection) and a tree without a right bound ("has children" cannot be told, so always whole) always use the tree.

loadState()  : void

Validates the persistent parameters from the URL.

onCreate()  : void

prepareCell()  : array{template: string, vars: array, link: ?string, linkTarget: ?string}

Prepares a cell: the column value plus renderer variables for the template `Templates/Default/Cells/<template>.latte`. `link` is the href the template wraps the cell content in ({@see BaseColumn::setLink()}), or null.

render()  : void

setAddLink()  : self

"Add" button above the table; not shown unless set.

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setDataSource()  : self

Manager the grid reads data from (`findAll()`) and saves changes to.

setDefaultOrder()  : self

Default list order. The first call drops the built-in `id DESC`, further calls add another level (`setDefaultOrder('type')->setDefaultOrder('name')`).

setDeleteMethod()  : self

Switches the delete signal and group action to another manager method; see {@see $deleteMethod}.

setIncludes()  : self

setItemIdentifier()  : self

Property with the record primary key (default `id`).

setItemsPerPage()  : self

Default rows per page; the user can override it with the 25/50/100 links.

setLanguageContext()  : $this

setLocalizationContext()  : $this

setPickerData()  : self

Further data carried by the "Select" button (`data-pick-data` JSON); JS spreads it into the opener's fields by the picker `fieldMap`. Fills several fields at once (not only the label), e.g. a user's e-mail and company.

setPickerExcludeId()  : self

Id of the record that cannot be picked in picker mode (self-reference); its row gets no "Select" button. 0 / null means no exclusion.

setPickerExcludeSubtree()  : self

lft/rgt range of the subtree that cannot be picked in picker mode. Excludes the root and all descendants (a node cannot be moved under its descendant). The entity must support `getLft()` (duck typing).

setPickerLabelCallback()  : self

Label for "Select" computed from the whole entity; use it when one property is not enough (empty for some records, or several fields must be combined). Takes precedence over {@see setPickerLabelProperty()}.

setPickerLabelProperty()  : self

Property for the "Select" button label (what is returned to the opener); defaults to the first non-id column.

setPickerMode()  : self

Picker mode: the grid serves as a record picker for a foreign form (a modal opened by {@see \App\UI\Admin\System\Components\PickerComponent\Picker}). Hides add, row checkboxes, edit/delete actions and group actions, and gives each row a "Select" action ({@see Templates/Default/Parts/_body.latte}). Filtering, sorting and paging stay; inside the modal they run via AJAX (`picker.js` swaps the dialog body) and the persistent parameter `picker` stays in links because the grid links to `this`.

setRowDecorator()  : self

Decorator called once after the current page is loaded (see {@see $rowDecorator}).

setSettingContext()  : $this

setThemeContext()  : $this

setTreeChildrenLimit()  : self

Cap of children of one parent (default {@see TREE_CHILDREN_LIMIT}). Above it the first N children and a row "… N more — use search" are rendered; in "Reorder" a node cannot be dropped at the end of the truncated list (the server would reject the position as TREE_STALE).

setTreeCollapsible()  : self

Collapsible tree (default `true`): ▸/▾ at the indented column, focus on a subtree, "Expand/Collapse all", expansion state in the session. Data is loaded per parent.

setTreeDefaultView()  : self

Default view of a tree grid ({@see self::VIEW_LIST} / {@see self::VIEW_TREE}) until the user switches; the choice is then kept in the session.

setTreeMoveFactories()  : self

Component factories of the modal, injected by {@see \App\UI\Admin\System\Components\DataGridComponent\DataGridFactory}.

setTreeScope()  : self

Tree scope filter for several trees in one table (e.g. menuItem.menuId). It is added to the list filters (only that tree) and to the move SQL queries (the lft/rgt recalculation does not touch other trees). Empty means a single tree (pages).

setTreeStructure()  : self

Records form a tree (page, menuItem, category…): the list is ordered depth-first by the order property, indented by level, and rows get arrows to move among siblings.

setup()  : void

setupAppContext()  : void

sortIdsByLabel()  : array<int, int>

Returns ids sorted by label using `Collator` (`strnatcasecmp` without intl). Equal labels keep their original order (stable sort), so sorting again changes nothing.

typedComponent()  : T

Returns a subcomponent with a verified type.

createComponentGridForm()  : Form

createComponentMoveForm()  : Form

createComponentMoveParentPicker()  : Picker

Parent in the modal: a suggest field with the path plus a modal with the same grid in picker mode (without the node and its subtree).

createComponentMovePosition()  : TreePosition

frontPresenter()  : BasePresenter|null

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

getLangId()  : int|null

getTranslator()  : ITranslator

setTemplateFile()  : void

setTranslator()  : self

addFilterControls()  : void

addMoveNotice()  : void

buildMoveTargetParams()  : array<string, mixed>

Builds the redirect parameters after success so that the moved node is highlighted and visible.

buildNestedLevel()  : array<int, array{item: object, children: array, more: int, meta: array}>

buildParentFilter()  : Filter

Builds `parentId IS NULL` (roots) or `= focused node`, plus children of expanded nodes.

buildStateFilters()  : array<string|int, Filter>

Converts search field values into Core filters via the column filter definitions.

buildSubtreeFilters()  : array<string|int, Filter>

Returns filters of the focused node subtree (descendants have `lft` inside its bounds); empty without focus.

buildTreeConfig()  : TreeConfig

`TreeConfig` for the model layer (moves), from the tree configuration and scope.

buildTreeCrumbs()  : array<int, array{id: int|null, label: string}>

Returns the breadcrumbs of the focused node: ancestors from the bounds (`lft < x and rgt > x`, one query).

callDeleteMethod()  : Result

Calls the delete method of the manager configured via {@see setDeleteMethod()} (default `'delete'`); the only place that knows its name, shared by the `delete!` signal ({@see HandleTrait::handleDelete()}) and the group action 'delete' ({@see FormTrait::processGroupAction()}).

confirmDelete()  : bool

Server-side half of the delete confirmation: a delete runs only with the confirmation flag ({@see DataGrid::CONFIRM_FIELD}) in the POST.

countTreeNodes()  : int

Returns the number of tree nodes within the scope (one count query, cached per request).

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

decorateItems()  : void

Calls {@see DataGrid::setRowDecorator()} on the current page when it is set.

deleteFlashType()  : string

Returns the flash color for {@see deleteResultKey()}; an explained success with a caveat carries the level of its code.

deleteResultKey()  : string

Returns the flash key for a delete result.

deleteTreeNodes()  : Result

Deletes nodes of a tree grid in bulk; each node is deleted with its subtree ({@see \App\Core\Traits\Api\Models\Services\TreeTrait::deleteTreeNode()}).

derivedAddPrivilege()  : string|null

`:Admin:<Module>:<Presenter>:<action>` from the attached presenter; `null` when it cannot be derived.

filterControlNames()  : array<string, string>

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

findMoveNode()  : object|null

findTreeParentIds()  : array<int, int>|null

Returns ids of nodes with children within the filters, or null when more than {@see DataGrid::TREE_FULL_LIMIT} nodes are in range (expanding all would render too much).

finishTreeSignal()  : void

Finishes a tree signal: AJAX outside picker redraws the body (plus flash); otherwise it redirects, which `picker.js` follows.

flashTranslated()  : void

Flashes a message by key; the admin layout translates `{_'//' . $flash->message}`, so the full path including the component domain is needed.

flattenPost()  : array<int, array{0: string, 1: string}>

Flattens POST data into `name => value` pairs for hidden fields (`ids[]` and nested arrays keep their bracket names); the confirmation flag itself is left out.

getNodeBounds()  : array{int, int}

getPageCount()  : int

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

Paging steps: the neighborhood of the current page plus evenly spread pages (like {@see \App\UI\Front\System\Components\PaginatorComponent\Paginator}).

getTreeSessionKey()  : string

State key: presenter, component and scope (each menu has its own).

getTreeSessionSection()  : SessionSection

hasFilterRow()  : bool

initializeData()  : void

isAddAllowed()  : bool

Returns whether the logged-in user may see the "add" button.

isExplainedDeleteOutcome()  : bool

isTreeView()  : bool

Tells whether the tree list applies: only in the chosen tree view ({@see TreeStateTrait::isTreeViewChosen()}) and until the user searches or sorts by a column, which breaks the hierarchy and switches the grid to the flat list. The default view is the flat paged list.

loadExpandedIds()  : array<int, int>|null

loadFlatData()  : void

loadTreeData()  : void

Loads the tree list by parents: one query `parentId IN (root or focused node + expanded)` ordered by `lft`, without paging.

loadTreePaths()  : void

Loads the ancestors of the flat list page rows in one query within the scope: `lft < max(lft) and rgt > min(rgt) and (lft < l1 and rgt > r1 or ...)`, one pair of bounds per parent ({@see TreePathBuilder::pickQueryBounds()}).

moveDialogErrorKey()  : string

moveNode()  : void

Moves a node up or down by delegating to the manager model layer ({@see \App\Core\Traits\Shared\Models\Managers\TreeTrait}). The tree configuration (lft/rgt/parent properties and scope) comes from {@see \App\UI\Admin\System\Components\DataGridComponent\DataGrid::buildTreeConfig()}.

moveResultKey()  : string

Returns the flash key of a move result. A rejected contract (`TREE_STALE`) and a lock (`TREE_LOCKED`) are not plain failures: the user should know to reload or wait a moment.

prepareTreePathTemplate()  : void

"Path" column and "In tree" action in the flat tree list: the path goes after the indented column (node name), without one after the last column. Row highlighting applies only in the tree.

prepareTreeTemplate()  : void

Tree variables for the template: row metadata, toggles, focus and breadcrumbs, URLs for JS.

processGroupAction()  : void

Handles a group action submit: passes the checkbox ids to the action callback; `delete` without a callback deletes through the manager.

processMoveForm()  : void

processSearch()  : void

Handles the search submit: stores field values in the persistent state and redirects.

reloadMoveNodeFromForm()  : void

requireDataSource()  : Manager<BaseEntity, ServiceInterface<string|int, BaseEntity>>

Returns the grid manager; signals and actions run after the presenter configured the grid, so a missing data source is a programmer error.

requireDeletePrivilege()  : void

IMPORTANT: server-side gate for bulk delete, key `…:del`.

requireEditPrivilege()  : void

IMPORTANT: server-side gate for writes in the grid: inline editing, relation toggles and tree moves.

requireGroupActionPrivilege()  : void

Gate for any group action; the action declares its own privilege ({@see GroupAction::setPrivilege()}), `delete` has it built in.

requireOfferedDeletion()  : void

IMPORTANT: server-side delete gate; responds 403 when the grid does not offer deletion in this request.

requireTreeMoveAllowed()  : void

resolveCollatorLocale()  : string

Returns the collation locale by the admin language (`cs` to `cs_CZ`), Czech by default.

resolveExpandedIds()  : array<int, int>

Returns the expanded nodes: the session, otherwise the default state (a small tree means all nodes with children).

resolveMoveNode()  : object|null

Returns the node being moved: from the form value (submit) or from the signal parameter (open).

resolveMoveParentLabel()  : string|null

resolveOrderBys()  : array<string, bool>

Returns the ordering for `findAll()`; user ordering takes precedence over the default.

resolveRowLabel()  : string

Shared core of {@see getPickerLabel()} and {@see getRowLabel()}: the first meaningful text of the row.

resolveTreeLabelProperty()  : string|null

Returns the property of the indented column (node name), which the parent suggest searches by.

resolveTreeParentId()  : int|null

resolveTreeRootNode()  : object|null

Returns the focused node (`treeRoot`) as an entity, or null for the whole tree.

rowDeleteConfirmText()  : string|null

Confirmation text of the row delete action (the same the modal shows).

showMoveModal()  : void

Fills and opens the shared modal with the current form state (idempotent).

slugifyColumnName()  : string

stateToString()  : string

Converts a persistent state value (mixed, from the URL) to a string for form defaults.

storeExpandedIds()  : void

stringify()  : string

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

Suggests parents: LIKE over the name column property, without the node and its subtree, with the path in the label so that equal names can be told apart.

t()  : string

Translates a key in the component domain.

updateResultKey()  : string

Returns the flash key for an inline update result; an explained refusal carries the message of its code (absolute key into the `results` domain).

if ($this->isAllowed(':Admin:System:UserGroup:del')) {
    $grid->addRowAction(RowAction::create('delete')->setSignal('delete'));
}