CoolCMS API

CommentThread extends BaseComponent

in package

• Application

uses ModalAwareTrait, PrivilegeGuardTrait

Manages the comments of one thread ({@see \App\UI\Api\Base\Models\Entities\CommentThread}) in the admin.

Table of Contents

Properties

$container  : Container

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

$adding  : bool

A new comment is being added (modal with an empty form).

$addParentId  : int|null

Parent of the comment being added (reply in the thread); null for a root.

$commentManager  : CommentManager

$editId  : int|null

Edited comment (set by `handleEditComment()` or by the submit to re-render the modal).

$justSaved  : bool

The comment was just saved, so the modal shows a confirmation instead of the form (stays open).

$threadContextProvider  : callable(): mixed|null

IMPORTANT: the hidden `threadId` field is client-editable, so it is only an echo, not the thread. The source of truth is this server-side context, supplied by the host (presenter or edit component) when it creates the component: `fn() => $this->editedArticle?->getCommentThreadId()`. It is read at signal/submit time, when the host's `action*()` has already loaded the edited entity.

$threadId  : int

Thread whose comments the component manages. Not a persistent parameter, because Nette does not reliably carry it into signals and `link('this')`; it is passed explicitly as a parameter of every signal (`{link addComment! threadId => …}`) and into the form submit via the hidden `threadId` field.

$toggleFailed  : bool

The `deleted` toggle (`toggleDeleted!`) failed, so the list renders an error message.

Methods

__call()  : mixed

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

__construct()  : mixed

createComponent()  : IComponent|null

createComponentCommentForm()  : Form

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

handleAddComment()  : void

Opens the shared modal for adding a comment (optionally as a reply to `$parentId`).

handleEditComment()  : void

Opens the shared modal for editing a comment.

handleToggleDeleted()  : void

Soft-deletes or restores a comment (toggles the `deleted` flag).

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCommentFormError()  : void

Handles failed validation (missing name/text, expired CSRF token...): redraws the modal content so the errors show. Restores the edit/add state from the submitted hidden fields.

onCommentFormSuccess()  : void

onCreate()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setThreadContext()  : static

Sets the server-side thread context: the host supplies a callback returning the thread id of the entity being edited right now. It is called on every request, so a stale value cannot linger from an earlier request.

setup()  : void

setupAppContext()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

applyCommentForm()  : string|null

The only write path of the form: context gate and save.

frontPresenter()  : BasePresenter|null

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

getModalWindow()  : ModalWindow

getTranslator()  : ITranslator

isTargetAllowed()  : bool

Returns whether the logged-in user may open the given admin target. For visibility (tiles, autocomplete, buttons); it does not throw.

requirePrivilege()  : void

Throws 403 when the logged-in user lacks the given admin privilege.

resolvePageTarget()  : string|null

Returns the RBAC key of the target page: `<presenter>:<action>`, e.g. `:Admin:System:User:show`.

setTemplateFile()  : void

setTranslator()  : self

buildNewComment()  : Comment

Builds a new comment attached to the thread (the remaining fields are filled by the success handler).

contextThreadId()  : int|null

Thread id from the host context; null when the host edits no thread (fail-closed).

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

findCommentInThread()  : Comment|null

Finds a comment always within the thread. No unscoped variant exists on purpose, so future code cannot use one by mistake.

loadCommentTree()  : array<int, array<int, Comment>>

Loads the thread's comments and groups them into a tree by `parentId` (`0` holds the roots, otherwise `parentId` => children).

renderModalContent()  : string

Renders the modal content (header and form or confirmation) to a string for `ModalWindow`.

requireContextThread()  : int

Signal gate: a `threadId` from a hand-built URL may be used only when it equals the host context; otherwise 403. A signal can be invoked by hand just like a form submit.

showModal()  : void

Fills and opens the shared admin {@see \App\UI\Admin\System\Components\ModalWindowComponent\ModalWindow} with the current state (form or confirmation). Idempotent: called again after the submit, it redraws only the modal content (the modal stays open, see `ModalWindow::open()`).

str()  : string

strOrNull()  : string|null