1. Documentation
  2. API
  3. Cms
  4. Widgets
  5. SnippetLookup

Cms\Widgets\SnippetLookup

Overview

SnippetLookup widget

Extends

Public Properties

public string $title

title text to display for the title of the popup list form

public string $noRecordsMessage

Show inherited public properties

Inherited Public Properties

Protected Properties

protected string $defaultAlias

defaultAlias to identify this widget.

protected bool $searchTerm

Show inherited protected properties

Inherited Protected Properties

Public Methods

public init()

public init(): void

init the widget, called by the constructor and free from its parameters.

public onGetInspectorConfiguration()

public onGetInspectorConfiguration(): void

public onInspectableGetOptions()

public onInspectableGetOptions(): void

public onLoadPopup()

public onLoadPopup(): void

onLoadPopup AJAX handler

public onLoadSnippetDetails()

public onLoadSnippetDetails(): void

public onSearch()

public onSearch(): void

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): string

Renders the widget.

Show inherited public methods

Inherited Public Methods

Protected Methods

protected getData()

protected getData(): void

protected getSearchTerm()

protected getSearchTerm(): void

protected getSession()

protected getSession($key = null, $default = null): void

protected getTheme()

protected getTheme(): void

getTheme returns the theme to source snippets

protected getThemeSessionKey()

protected getThemeSessionKey($prefix): void

protected loadAssets()

protected loadAssets(): void

loadAssets adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

protected putSession()

protected putSession($key, $value): void

protected setSearchTerm()

protected setSearchTerm($term): void

protected textMatchesSearch()

protected textMatchesSearch(&$words, $text): void

protected updateList()

protected updateList(): void

Show inherited protected methods

Inherited Protected Methods