Class Widget

Class Widget

CWidget

Extended by

foundation\widgets\base\Widget

Direct known subclasses

foundation\widgets\Alert, foundation\widgets\base\Input, foundation\widgets\Reveal, foundation\widgets\Section, foundation\widgets\Tooltip, foundation\widgets\TopBar, foundation\widgets\Breadcrumbs, foundation\widgets\Clearing, foundation\widgets\Dropdown, foundation\widgets\FlexVideo, foundation\widgets\Interchange, foundation\widgets\JoyRide, foundation\widgets\Magellan, foundation\widgets\Orbit

Indirect known subclasses

foundation\widgets\SwitchButton

Namespace: foundation\widgets\base
Package: foundation\widgets\base
Located at widgets/base/Widget.php

Methods summary

`public`	# `init( )` Initializes the widget Initializes the widget
`public`	# `registerPlugin( string $name, string $selector, array $options = array(), integer $position = \CClientScript::POS_READY )` Registers a specific plugin using the given selector and options. Registers a specific plugin using the given selector and options. Parameters `$name` `string` $name the plugin name. `$selector` `string` $selector the CSS selector. `$options` `array` $options the JavaScript options for the plugin. `$position` `integer` $position the position of the JavaScript code.
`public`	# `registerEvents( string $selector, string[] $events, integer $position = \CClientScript::POS_READY )` Registers events using the given selector. Registers events using the given selector. Parameters `$selector` `string` $selector the CSS selector. `$events` `string[]` $events the JavaScript event configuration (name=>handler). `$position` `integer` $position the position of the JavaScript code.
`public`	# `registerAssets( )` Registers the assets. Makes sure the assets pre-existed on the published folder prior registration. Registers the assets. Makes sure the assets pre-existed on the published folder prior registration.
`public static string`	# `display( array $config = array() )` Ported from Yii2 widget's function. Creates a widget instance and runs it. We cannot use 'widget' name as it conflicts with CBaseController component. Ported from Yii2 widget's function. Creates a widget instance and runs it. We cannot use 'widget' name as it conflicts with CBaseController component. The widget rendering result is returned by this method. Parameters `$config` `array` $config name-value pairs that will be used to initialize the object properties Returns `string` the rendering result of the widget.

Magic methods summary

Properties summary

`public array`	`$htmlOptions`	# the HTML attributes for the breadcrumbs. the HTML attributes for the breadcrumbs.
`public array`	`$links`	# list of links to appear in the breadcrumbs. list of links to appear in the breadcrumbs.
`public array`	`$assets`	# list of the assets the plugin requires. it holds the following format: 'assets' => array( 'css' => 'file.css', 'js' => 'file.js') ), ... 'assets' => array( 'css' => array( 'file1.css', 'file2.css' ), 'js' => array( 'file1.js', 'file2.js' ) ) list of the assets the plugin requires. it holds the following format: 'assets' => array( 'css' => 'file.css', 'js' => 'file.js') ), ... 'assets' => array( 'css' => array( 'file1.css', 'file2.css' ), 'js' => array( 'file1.js', 'file2.js' ) )