Widgets - Revision history

Demitri: /* Creating a widget */

2012-10-25T01:29:08Z

‎Creating a widget

2012-10-25T01:28:40Z

‎Adding the widget to the registry

2012-10-25T01:28:22Z

‎Adding the widget to the registry

2012-10-25T01:28:05Z

‎Adding the widget to the registry

2012-10-25T01:24:43Z

‎Widget Templates

2012-10-25T01:24:12Z

‎Widget Templates

2012-10-25T01:23:20Z

‎Widget Templates

2012-10-25T01:22:25Z

‎Widget Templates

2012-10-24T22:55:33Z

‎Widget Templates

2012-10-24T22:54:59Z

‎Widget Markup

@@ Line 6: / Line 6: @@
 = Creating a widget =
 The first step to creating a new widget is to make a new PHP class that extends [[x2doc:X2Widget|X2Widget]], name the file after the class, and to place the widget in the <tt>protected/components</tt> directory. Note the inheritance of properties from [[yii:CWidget|CWidget]], the parent class of X2Widget. A complete widget should contain, at minimum, an override of the [[yii:CWidget#run-detail|CWidget::run()]] method that constructs the markup associated with that widget.
 == Adding the widget to the app ==
@@ Line 29: / Line 40: @@
 Thus, to enable or disable a widget, add or remove an entry from that array.

@@ Line 7: / Line 7: @@
 The first step to creating a new widget is to make a new PHP class that extends [[x2doc:X2Widget|X2Widget]], name the file after the class, and to place the widget in the <tt>protected/components</tt> directory. Note the inheritance of properties from [[yii:CWidget|CWidget]], the parent class of X2Widget. A complete widget should contain, at minimum, an override of the [[yii:CWidget#run-detail|CWidget::run()]] method that constructs the markup associated with that widget.
-== Adding the widget to the registry ==
+== Adding the widget to the app ==
 Widgets are loaded by [[x2propdoc:class-x2base.html#_filterSetPortlets|x2base::filterSetPortlets()]], and the widgets that are loaded depend on the application configuration parameter "registeredWidgets" (in <tt>protected/config/main.php</tt>), which is an array in the format "WidgetClassName" => "Widget Title":

@@ Line 28: / Line 28: @@
 </syntaxhighlight>
-To enable or disable a widget, add or remove an entry from that array.
+Thus, to enable or disable a widget, add or remove an entry from that array.
 == Widget Templates ==

@@ Line 8: / Line 8: @@
 == Adding the widget to the registry ==
-Widgets loaded by <tt>filterSetPortlets</tt> are loaded are contained in the application configuration parameter "registeredWidgets" (in <tt>protected/config/main.php</tt>), in the format "ClassName" => "Widget Title":
+Widgets are loaded by [[x2propdoc:class-x2base.html#_filterSetPortlets|x2base::filterSetPortlets()]], and the widgets that are loaded depend on the application configuration parameter "registeredWidgets" (in <tt>protected/config/main.php</tt>), which is an array in the format "WidgetClassName" => "Widget Title":
 <syntaxhighlight lang="php">
@@ Line 27: / Line 27: @@
 		),
 </syntaxhighlight>
 == Widget Templates ==

@@ Line 37: / Line 37: @@
 	'complete' => $complete,
 ));</syntaxhighlight>
-In this example, the menu would open and render <tt>protected/components/views/actionMenu.php</tt>, inside of which the local variables <tt>$total</tt>, <tt>$unfinished</tt>, <tt>$overdue</tt> and <tt>$complete</tt> would be available.
+In this example, the menu would open and render <tt>protected/components/views/actionMenu.php</tt>, inside of which the local variables <tt>$total</tt>, <tt>$unfinished</tt>, <tt>$overdue</tt> and <tt>$complete</tt> would be available as part of the template's dynamic content.

← Older revision		Revision as of 01:23, 25 October 2012
Line 37:		Line 37:
	'complete' => $complete,		'complete' => $complete,
	));</syntaxhighlight>		));</syntaxhighlight>
		+	In this example, the menu would open and render <tt>protected/components/views/actionMenu.php</tt>.

@@ Line 29: / Line 29: @@
 == Widget Templates ==
-Like controllers, widgets use view files to generate the final HTML. By default, widgets look for view files in <tt>protected/components/views</tt>. The markup associated with a widget can therefore be placed in such a view file, then rendered in the widget's <tt>run()</tt> method, passing it any parameters needed in the view. For example, the action menu widget's run method contains the following:
+Widgets use view files to generate the final HTML that comprises their front-end. By default, widgets look for view files in <tt>protected/components/views</tt>. The markup associated with a widget can therefore be placed in such a view file, then rendered in the widget's <tt>run()</tt> method, passing it any parameters needed in the view. For example, the action menu widget's run method contains the following:
 <syntaxhighlight lang="php">
 $this->render('actionMenu', array(