Widgets
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
Initialize this singleton.
No description
No description
No description
Returns a class name from a list action widget code Normalizes a class name or converts an code to it's class name.
Returns a list of registered form widgets.
Registers a single form form widget.
Manually registers form widget for consideration.
Returns a class name from a form widget code Normalizes a class name or converts an code to it's class name.
Returns a list of registered dashboard widgets.
No description
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
at line 103
registerBulkActionWidgets(callable $definitions)
No description
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.
at line 144
array
listFormWidgets()
Returns a list of registered form widgets.
at line 179
void
registerFormWidget(string $className, array $widgetInfo = null)
Registers a single form form widget.
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' ]); });
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.
at line 246
array
listDashboardWidgets()
Returns a list of registered dashboard widgets.
at line 276
registerDashboardWidget($className, $widgetInfo)
No description
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' ]); });