DashboardManager manages custom dashboard widgets.

Protected Properties

protected string[] $dashboardWidgets

Public Methods

public getWidget()

public getWidget(
    string $className,
    Controller $controller
): ?DashboardWidgetBase 

getWidget returns a dashboard widget instance by its class name.

public static instance()

public static instance(): static 

instance creates a new instance of this singleton

public listVueWidgetGroups()

public listVueWidgetGroups(): array 

listVueWidgetGroups returns Vue component, group and widget names.

public listWidgetClasses()

public listWidgetClasses(): array 

Returns class names and registration parameters of registered dashboard widgets.

public registerWidget()

public registerWidget(
    string $className,
    string $displayName,
    string $groupName
): void 

Registers a dashboard widget component.