1. Documentation
  2. API
  3. Backend
  4. Widgets
  5. SiteSwitcher

Backend\Widgets\SiteSwitcher

Overview

SiteSwitcher widget.

Extends

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected string $defaultAlias

defaultAlias to identify this widget.

protected string|null $switchHandler

switchHandler is set by setSwitchHandler.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public bindToController()

public bindToController(): void

public getBackendPreference()

public getBackendPreference(): void

public prepareVars()

public prepareVars($extraVars = []): void

prepareVars for display

public render()

public render($extraVars = []): void

render the widget's primary contents.

public renderSubmenu()

public renderSubmenu(): void

public setSwitchHandler()

public setSwitchHandler($name): void

setSwitchHandler enables the use of an AJAX handler when switching the site

public storeBackendPreference()

public storeBackendPreference($id): void

storeBackendPreference sets the editing theme

Show inherited public methods

Inherited Public Methods

Protected Methods

protected applyEditSiteAndBanner()

protected applyEditSiteAndBanner(): void

protected applyEditSiteFromHeader()

protected applyEditSiteFromHeader($id): void

protected applyEditSiteFromPreference()

protected applyEditSiteFromPreference(): void

protected applyEditSiteFromRequest()

protected applyEditSiteFromRequest($id): 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.

Show inherited protected methods

Inherited Protected Methods