Class WidgetRegistry

__constructsource public

__construct( Cake\View\StringTemplate $templates , Cake\View\View $view , string|array $widgets [] )

Constructor

Parameters

Cake\View\StringTemplate $templates

Templates instance to use.

Cake\View\View $view

The view instance to set as a widget.

string|array $widgets optional []

See add() method for more information.

_resolveWidgetsource protected

_resolveWidget( mixed $widget )

Resolves a widget spec into an instance.

Parameters

mixed $widget

The widget to get

Returns

Cake\View\Widget\WidgetInterface
WidgetInterface

Throws

RuntimeException
when class cannot be loaded or does not implement WidgetInterface.

addsource public

add( array $widgets )

Adds or replaces existing widget instances/configuration with new ones.

Widget arrays can either be descriptions or instances. For example:

$registry->add([
  'label' => new MyLabelWidget($templates),
  'checkbox' => ['Fancy.MyCheckbox', 'label']
]);

The above shows how to define widgets as instances or as descriptions including dependencies. Classes can be defined with plugin notation, or fully namespaced class names.

Parameters

array $widgets

Array of widgets to use.

Throws

RuntimeException
When class does not implement WidgetInterface.

clearsource public

clear( )

Clear the registry and reset the widgets.

getsource public

get( string $name )

Get a widget.

Will either fetch an already created widget, or create a new instance if the widget has been defined. If the widget is undefined an instance of the _default widget will be returned. An exception will be thrown if the _default widget is undefined.

Parameters

string $name

The widget name to get.

Returns

Cake\View\Widget\WidgetInterface
widget interface class.

Throws

RuntimeException
when widget is undefined.

loadsource public

load( string $file )

Load a config file containing widgets.

Widget files should define a $config variable containing all the widgets to load. Loaded widgets will be merged with existing widgets.

Parameters

string $file

The file to load

[]