CoolCMS API

CategorySuggest extends BaseComponent
in package
uses InitTrait, SignalTrait

FinalYes

Category field: a suggest box for categories of any module.

Shared front component (Bazaar and Comcat). The host creates it as createComponentCategorySuggest(), passes the data source (InitTrait::setProvider(), the module's front CategoryManager) and, at render time, the value carrier (category_id) and optionally its own text control. The markup follows the contract of the bundled picker.js (data-picker-*); the suggest! signal returns JSON items {id, label, name, meta} (meta = ancestor path).

Table of Contents

Constants

SUGGEST_CACHE_SECONDS  : int = 3600
The response depends only on `q`, language and module, not on the session, so the browser may cache it.

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
$currentLabel  : string
Label of the stored value for the component's own field (without `$display`). The host knows it from the entity, so the component does not call the Api for it.
$provider  : CategorySuggestProviderInterface|null

Methods

__call()  : mixed
Dispatches `renderXyz()` to `render('Xyz', ...$args)`.
__construct()  : mixed
createComponent()  : IComponent|null
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
handleSuggest()  : void
`picker.js` sends the query as a bare `q=...` (without the component prefix); Nette passes it to the presenter, so `q` is read from the presenter too (same as `RegionSuggest`).
hasServiceByType()  : bool
Returns whether the container has a service of the given type.
initializeAllContexts()  : void
injectDeviceDetector()  : void
onCreate()  : void
render()  : void
setAppContext()  : $this
setComponentParameter()  : void
Sets a component parameter.
setCurrencyContext()  : $this
setCurrentLabel()  : self
setLanguageContext()  : $this
setLocalizationContext()  : $this
setProvider()  : self
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).
getTranslator()  : ITranslator
setTemplateFile()  : void
setTranslator()  : self
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).
prepareTemplate()  : void
resolveLanguageId()  : int

Constants

SUGGEST_CACHE_SECONDS

The response depends only on `q`, language and module, not on the session, so the browser may cache it.

private int SUGGEST_CACHE_SECONDS = 3600

private, not public: the front response carries the session Set-Cookie.

Properties

$componentParameters

protected array<string, mixed> $componentParameters = []

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'front.base.components.categorySuggest'

$currentLabel

Label of the stored value for the component's own field (without `$display`). The host knows it from the entity, so the component does not call the Api for it.

private string $currentLabel = ''

Methods

__call()

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

public __call(string $name, array<string|int, mixed> $args) : mixed

Called only when the component has no renderXyz() method of its own.

Parameters
$name : string
$args : array<string|int, mixed>

createComponent()

public createComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

getComponentParameter()

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

public getComponentParameter(string $name) : mixed
Parameters
$name : string

getContainer()

public getContainer() : Container
Return values
Container

getSettings()

public getSettings() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

handleSuggest()

`picker.js` sends the query as a bare `q=...` (without the component prefix); Nette passes it to the presenter, so `q` is read from the presenter too (same as `RegionSuggest`).

public handleSuggest([string $q = '' ]) : void

A GET without side effects, so CSRF is not handled. The Api enforces the rate limit (CategorySuggestTrait, 60/min/IP); above it the response is HTTP 429 with empty items.

Parameters
$q : string = ''

hasServiceByType()

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

public hasServiceByType(string $className) : bool

The name is composed dynamically (module plus component), so class_exists() runs first, and a true result guarantees a valid type.

Parameters
$className : string
Tags
phpstan-assert-if-true

class-string $className

Return values
bool

render()

public render(BaseControl $input[, BaseControl|null $display = null ]) : void
Parameters
$input : BaseControl

value carrier (category_id), a hidden control of the host form

$display : BaseControl|null = null

host text control used as the suggest field (lets the server detect "typed but not selected"); null means the component renders its own field

setComponentParameter()

Sets a component parameter.

public setComponentParameter(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

setCurrentLabel()

public setCurrentLabel(string $currentLabel) : self
Parameters
$currentLabel : string
Return values
self

typedComponent()

Returns a subcomponent with a verified type.

public typedComponent(string $name, T> $type) : T

Use it instead of an inline @var above $this['x'] (which does not narrow the type) and instead of the generic IComponent that $this['x'] returns. See Form::typedComponent().

Parameters
$name : string
$type : T>
Tags
template
Return values
T

frontPresenter()

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

protected frontPresenter() : BasePresenter|null
Return values
BasePresenter|null

getTranslator()

protected getTranslator() : ITranslator
Return values
ITranslator

setTemplateFile()

protected setTemplateFile(string $dir, string $filename) : void
Parameters
$dir : string
$filename : string

setTranslator()

protected setTranslator(ITranslator $translator) : self
Parameters
$translator : ITranslator
Return values
self

createMultiplierComponent()

Creates a multiplier for the component.

private createMultiplierComponent(string $name) : Multiplier<string|int, IComponent>
Parameters
$name : string
Return values
Multiplier<string|int, IComponent>

createNewComponentInstance()

Creates a new component instance without adding it to the presenter; used by the multiplier.

private createNewComponentInstance(string $baseName[, int|string|null $uniqueKey = null ]) : IComponent|null
Parameters
$baseName : string
$uniqueKey : int|string|null = null
Return values
IComponent|null

createStandardComponent()

Creates a standard component (not a multiplier).

private createStandardComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

prepareTemplate()

private prepareTemplate(BaseControl $input) : void
Parameters
$input : BaseControl

resolveLanguageId()

private resolveLanguageId() : int
Return values
int
On this page

Search results