CoolCMS API

Search extends BaseComponent
in package
uses PrivilegeGuardTrait

Admin suggester: searches only the names (titles) of admin pages and returns links to them, same as {@see \App\UI\Admin\System\Components\MenuComponent\Menu}.

Renders the search field in the admin header; typing triggers the AJAX signal suggest!, which returns JSON with the found pages. The client (www/themes/admin/default/desktop/assets/js/components/admin-search.js) builds a dropdown of links from it. The look follows the UI demo ui-demo/34-autocompletes.html (classes .autocomplete-*).

The link target is built like in the menu component, from AdminPage::getPresenter() + getAction() through presenter->link() into a pretty admin URL; pages whose presenter does not exist yet or whose action needs a parameter (edit/add with id) are silently skipped.

Table of Contents

Constants

MainAction  : mixed = 'show'
The only action the suggester may link to (main list of a presenter).
MinChars  : mixed = 2
Minimum number of query characters before the suggester starts.
ResultLimit  : mixed = 8
Maximum number of listed results.

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
$adminPageManager  : AdminPageManager

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
Suggester (AJAX): JSON with the found pages `{items:[{name, href}]}`.
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
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).
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
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).
presenterClass()  : string
Converts a Nette presenter target (`:Admin:System:Page`) into the full class name (`App\UI\Admin\System\Presenters\PagePresenter`).
resolveLink()  : string|null
Resolves the page target (presenter + action) into a pretty admin URL. Returns null for a page without a presenter, a presenter that does not exist yet, or an action that needs a parameter we cannot supply.
resolveName()  : string
Returns the page name: the translation title in the current language, falling back to the first available translation.
search()  : array<int, array{name: string, href: string}>
Finds admin pages whose name (title in the current language) contains the query and returns them as `['name' => ..., 'href' => ...]` arrays ready for JSON.

Constants

MainAction

The only action the suggester may link to (main list of a presenter).

private mixed MainAction = 'show'

MinChars

Minimum number of query characters before the suggester starts.

private mixed MinChars = 2

ResultLimit

Maximum number of listed results.

private mixed ResultLimit = 8

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'admin.system.components.search'

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

Suggester (AJAX): JSON with the found pages `{items:[{name, href}]}`.

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

admin-search.js sends the query as a bare q=.... Nette routes such an unprefixed parameter to the presenter parameters, not the component's, so the signal argument would stay empty; q is therefore read directly from the presenter in that case (same as Picker::handleSuggest()).

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

setComponentParameter()

Sets a component parameter.

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

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

isTargetAllowed()

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

protected isTargetAllowed(string|null $key) : bool

IMPORTANT: fail-closed like requirePrivilege(): an empty key and a presenter without isAllowed() both mean no. A component that skips this question lists the target to everyone.

Parameters
$key : string|null
Return values
bool

requirePrivilege()

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

protected requirePrivilege(string $key) : void

Call it as the first statement of a mutating signal, before loading data, so the check cannot be bypassed by something being written first.

Parameters
$key : string

resolvePageTarget()

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

protected static resolvePageTarget(object|null $page) : string|null

Same interpretation as Menu::filterByPrivileges(), BasePresenter::authorizeListing() and PrivilegeCheckTrait::checkCurrentPrivilege(). The key is derived from the page target only, never from a file or class name.

Returns null when the page is missing or has no presenter, so there is nothing to allow.

Parameters
$page : object|null

AdminPage entity (hydrated, hence just object)

Return values
string|null

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

presenterClass()

Converts a Nette presenter target (`:Admin:System:Page`) into the full class name (`App\UI\Admin\System\Presenters\PagePresenter`).

private presenterClass(string $presenter) : string
Parameters
$presenter : string
Return values
string

resolveLink()

Resolves the page target (presenter + action) into a pretty admin URL. Returns null for a page without a presenter, a presenter that does not exist yet, or an action that needs a parameter we cannot supply.

private resolveLink(AdminPage $page) : string|null
Parameters
$page : AdminPage
Return values
string|null

resolveName()

Returns the page name: the translation title in the current language, falling back to the first available translation.

private resolveName(AdminPage $page, int $lang) : string
Parameters
$page : AdminPage
$lang : int
Return values
string

search()

Finds admin pages whose name (title in the current language) contains the query and returns them as `['name' => ..., 'href' => ...]` arrays ready for JSON.

private search(string $q) : array<int, array{name: string, href: string}>
Parameters
$q : string
Return values
array<int, array{name: string, href: string}>
On this page

Search results