class Widgets

Widget manager

Adapted from october\backend\classes\WidgetManager

Traits

Singleton trait.

Properties

static protected $instance from  Singleton
protected array $bulkActionWidgets
protected array $bulkActionWidgetCallbacks
protected array $formWidgets
protected array $formWidgetCallbacks
protected array $formWidgetHints
protected array $dashboardWidgets
protected array $dashboardWidgetCallbacks
protected ExtensionManager $extensionManager

Methods

static 
instance()

Create a new instance of this singleton.

static 
forgetInstance()

Forget this singleton's instance if it exists

__construct()

Constructor.

initialize()

Initialize this singleton.

__clone()

No description

__wakeup()

No description

listBulkActionWidgets()

No description

registerBulkActionWidget($className, $widgetInfo)

No description

registerBulkActionWidgets(callable $definitions)

No description

string
resolveBulkActionWidget(string $name)

Returns a class name from a list action widget code Normalizes a class name or converts an code to it's class name.

array
listFormWidgets()

Returns a list of registered form widgets.

void
registerFormWidget(string $className, array $widgetInfo = null)

Registers a single form form widget.

registerFormWidgets(callable $definitions)

Manually registers form widget for consideration.

string
resolveFormWidget(string $name)

Returns a class name from a form widget code Normalizes a class name or converts an code to it's class name.

array
listDashboardWidgets()

Returns a list of registered dashboard widgets.

registerDashboardWidget($className, $widgetInfo)

No description

registerDashboardWidgets(callable $definitions)

Manually registers dashboard widget for consideration.

Details

in Singleton at line 18
final static instance()

Create a new instance of this singleton.

in Singleton at line 28
final static forgetInstance()

Forget this singleton's instance if it exists

in Singleton at line 36
final protected __construct()

Constructor.

at line 60
protected initialize()

Initialize this singleton.

in Singleton at line 48
__clone()

No description

in Singleton at line 53
__wakeup()

No description

at line 69
listBulkActionWidgets()

No description

at line 91
registerBulkActionWidget($className, $widgetInfo)

No description

Parameters

$className
$widgetInfo

at line 103
registerBulkActionWidgets(callable $definitions)

No description

Parameters

callable $definitions

at line 116
string resolveBulkActionWidget(string $name)

Returns a class name from a list action widget code Normalizes a class name or converts an code to it's class name.

Parameters

string $name

Class name or form widget code.

Return Value

string

The class name resolved, or the original name.

at line 144
array listFormWidgets()

Returns a list of registered form widgets.

Return Value

array

Array keys are class names.

at line 179
void registerFormWidget(string $className, array $widgetInfo = null)

Registers a single form form widget.

Parameters

string $className

Widget class name.

array $widgetInfo

Registration information, can contain an 'code' key.

Return Value

void

at line 205
registerFormWidgets(callable $definitions)

Manually registers form widget for consideration.

Usage:

  WidgetManager::registerFormWidgets(function($manager){
      $manager->registerFormWidget('Backend\FormWidgets\CodeEditor', [
          'name' => 'Code editor',
          'code'  => 'codeeditor'
      ]);
  });

Parameters

callable $definitions

at line 218
string resolveFormWidget(string $name)

Returns a class name from a form widget code Normalizes a class name or converts an code to it's class name.

Parameters

string $name

Class name or form widget code.

Return Value

string

The class name resolved, or the original name.

at line 246
array listDashboardWidgets()

Returns a list of registered dashboard widgets.

Return Value

array

Array keys are class names.

at line 276
registerDashboardWidget($className, $widgetInfo)

No description

Parameters

$className
$widgetInfo

at line 295
registerDashboardWidgets(callable $definitions)

Manually registers dashboard widget for consideration.

Usage:

  Widgets::registerDashboardWidgets(function($manager){
      $manager->registerDashboardWidget('IgniterLab\GoogleAnalytics\DashboardWidgets\TrafficOverview', [
          'name'=>'Google Analytics traffic overview',
          'context'=>'dashboard'
      ]);
  });

Parameters

callable $definitions