CoolCMS API

RatingThread extends BaseComponent

in package

• Application

uses ModalAwareTrait, PrivilegeGuardTrait

Manages the ratings of one thread ({@see \App\UI\Api\Base\Models\Entities\RatingThread}) 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 rating is being added (modal with an empty form).

$editId  : int|null

Edited rating (set by `handleEditRating()` or by the submit to re-render the modal).

$justSaved  : bool

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

$ratingManager  : RatingManager

$threadContextProvider  : callable(): mixed|null

IMPORTANT: the hidden `threadId` field is a client-editable echo; the authority is the server-side host context (`fn() => $this->editedArticle?->getRatingThreadId()`). It is read at signal/submit time, when the host's `action*()` has already loaded the edited entity.

$threadId  : int

Thread whose ratings 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 addRating! 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

createComponentRatingForm()  : 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

handleAddRating()  : void

Opens the shared modal for adding a rating.

handleEditRating()  : void

Opens the shared modal for editing a rating.

handleToggleDeleted()  : void

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

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

onRatingFormError()  : void

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

onRatingFormSuccess()  : 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 supplied by the host.

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

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

buildNewRating()  : Rating

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

buildSummary()  : array{count: int, average: float, distribution: array}

Builds the thread summary for the detail view (average, count, distribution by stars).

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

findRatingInThread()  : Rating|null

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

intInRange()  : int

listToText()  : string

Converts a list of strings to a textarea value (one item per line).

loadRatings()  : array<int, Rating>

Loads the thread's ratings (flat list, newest first).

prepareValueItems()  : array<int, string>

Returns the star select items (5 to 1).

renderModalContent()  : string

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

requireContextThread()  : int

Signal gate: a `threadId` from the URL may be used only when it equals the host context; otherwise 403.

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

textToList()  : array<int, string>|null

Converts a textarea (one item per line) to a list of strings; empty input gives null.