1. Documentation
  2. API
  3. Backend
  4. FormWidgets
  5. Sensitive

Backend\FormWidgets\Sensitive

Overview

Sensitive widget renders a password field that can be optionally made visible

Extends

Public Properties

public bool $readOnly

readOnly if the sensitive field cannot be edited, but can be toggled

public bool $disabled

disabled if the sensitive field is disabled

public bool $allowCopy

allowCopy if a button will be available to copy the value

public string $displayMode

displayMode determines how the widget is displayed. Modes: text, textarea

public string $hiddenPlaceholder

hiddenPlaceholder string used as a placeholder for an unrevealed sensitive value

public bool $hideOnTabChange

hideOnTabChange if the sensitive input will be hidden if the user changes to another tab

Show inherited public properties

Inherited Public Properties

Protected Properties

protected $defaultAlias

defaultAlias to identify this widget.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public getSaveValue()

public getSaveValue($value): void

getSaveValue processes the postback value for this widget. If the value is omitted from postback data, the form widget will be skipped.

public init()

public init(): void

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

public onShowValue()

public onShowValue(): void

onShowValue reveals the value of a hidden, unmodified sensitive field

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): void

render the widget's primary contents.

Show inherited public methods

Inherited Public Methods

Protected Methods

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.

Show inherited protected methods

Inherited Protected Methods