1. Documentation
  2. API
  3. Cms
  4. FormWidgets
  5. PageFinder

Cms\FormWidgets\PageFinder

Overview

PageFinder renders a page finder field.

page: label: Featured Page type: pagefinder

Extends

Public Properties

public bool $singleMode

singleMode only allows items to be selected that resovle to a single URL.

public bool $showReference

showReference disables link resolution when displaying the selection for performance reasons.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected $defaultAlias

defaultAlias to identify this widget.

protected Backend\Classes\WidgetBase $selectWidget

selectWidget reference to the widget used for selecting a page.

protected PageLookupItem $lookupItem

protected bool $searchTerm

Show inherited protected properties

Inherited Protected Properties

Public Methods

public getDescriptionValue()

public getDescriptionValue(): void

public getKeyValue()

public getKeyValue(): void

public getNameValue()

public getNameValue(): void

public init()

public init(): void

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

public onClearRecord()

public onClearRecord(): void

onClearRecord AJAX handler

public onRefresh()

public onRefresh(): void

onRefresh AJAX handler

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): void

render the widget's primary contents.

public setKeyValue()

public setKeyValue($value): void

Show inherited public methods

Inherited Public Methods

Protected Methods

protected getLookupItemValue()

protected getLookupItemValue(): void

protected getSearchTerm()

protected getSearchTerm(): 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 setSearchTerm()

protected setSearchTerm($term): void

protected textMatchesSearch()

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

Show inherited protected methods

Inherited Protected Methods