CoolCMS API

CommentThread extends BaseComponent

in package

• Application

uses InitializationTrait, FormTrait

Generic comment thread component for any commentable content (articles, events, news, ...).

Table of Contents

Constants

MODAL_TARGET  : mixed = 'commentThreadReply'

Properties

$commentPage  : int

Page of top-level comments (only thread types with a per-page setting, see `ThreadType::commentPerPageSetting()`).

$container  : Container

$routerDispatcher  : RouterDispatcher

$threadId  : int

$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

$commentManager  : CommentManager

$commentThreadManager  : CommentThreadManager

$eventDispatcher  : EventDispatcher

$loginRequired  : bool|null

Memo of {@see isLoginRequired()} for the current request.

$modalRegistry  : ModalRegistry

$replyTo  : int|null

$threadType  : ThreadType|null|false

Memo of the thread type (false = not loaded yet).

$userManager  : UserManager

Methods

__call()  : mixed

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

__construct()  : mixed

commentsPerPage()  : int

Top-level comments per page; 0 = no paging (the module has no such setting).

createComponent()  : IComponent|null

createComponentReplyForm()  : Form

Reply form (in the modal).

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

getReplyTo()  : int|null

Returns `replyTo` (used by `FormTrait`).

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

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

getThemeContext()  : ThemeContext|null

handleCommentPage()  : void

AJAX paging of top-level comments.

handleShowReplyForm()  : void

Signal that shows the reply form in a modal.

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

isLoginRequired()  : bool

Returns whether the current visitor is a guest and the thread type allows comments only to logged-in users (`ThreadType::commentLoginSetting()`, e.g. Discussion `comment.onlyForLoggedIn`).

onCreate()  : void

onFormError()  : void

Validation errors: the modal is filled from the registry, so its content is rebuilt with the errors (the template lists `$form->errors`, field errors included). Without it an AJAX submit with an empty name or text ended with no response at all.

onSubmit()  : void

Form submit handler.

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.

frontPresenter()  : BasePresenter|null

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

getModalTarget()  : string

Returns `MODAL_TARGET` (used by `FormTrait`).

getTranslator()  : ITranslator

setTemplateFile()  : void

setTranslator()  : self

createModalContent()  : string

Builds the modal HTML content (the form).

createModalEvent()  : ModalWindowEvent

Creates a `ModalWindowEvent` with the given options.

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

createSuccessContent()  : string

Builds the content shown after a successful submit.

handleSubmitError()  : void

Handles a submit error.

handleSubmitSuccess()  : void

Handles a successful submit.

initializeRender()  : void

Loads comments from the database and prepares them for the template.

initializeUsers()  : void

Loads avatars of the users who contributed to the discussion.

sortMessageList()  : void

Sorts comments by parent id for tree display.

threadType()  : ThreadType|null

Type of the current thread, loaded once per request.

updateModalContent()  : void

Updates the modal content.