CWidget
| 包 | system.web.widgets |
|---|---|
| 继承 | class CWidget » CBaseController » CComponent |
| 子类 | CBasePager, CCaptcha, CClipWidget, CFilterWidget, CFlexWidget, CInputWidget, CMultiFileUpload, CTabView, CTreeView |
| 可用自 | 1.0 |
| 版本 | $Id$ |
A widget is a self-contained component that may generate presentation based on model data. It can be viewed as a micro-controller that embeds into the controller-managed views.
Compared with controller, a widget has neither actions nor filters.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| controller | CController | the controller that this widget belongs to. | CWidget |
| id | string | id of the widget. | CWidget |
| owner | CBaseController | owner/creator of this widget. | CWidget |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CWidget |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| actions() | Returns a list of actions that are used by this widget. | CWidget |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| beginCache() | Begins fragment caching. | CBaseController |
| beginClip() | Begins recording a clip. | CBaseController |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
| beginWidget() | Creates a widget and executes it. | CBaseController |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| endCache() | Ends fragment caching. | CBaseController |
| endClip() | Ends recording a clip. | CBaseController |
| endContent() | Ends the rendering of content. | CBaseController |
| endWidget() | Ends the execution of the named widget. | CBaseController |
| getController() | CWidget | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CWidget | |
| getOwner() | CWidget | |
| getViewFile() | Looks for the view script file according to the view name. | CWidget |
| getViewPath() | Returns the directory containing the view files for this widget. | CWidget |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the widget. | CWidget |
| raiseEvent() | Raises an event. | CComponent |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Executes the widget. | CWidget |
| setId() | CWidget | |
| widget() | Creates a widget and executes it. | CBaseController |
属性详情
the prefix to the IDs of the actions. When a widget is declared an action provider in CController::actions, a prefix can be specified to differentiate its action IDs from others. The same prefix should then also be used to configure this property when the widget is used in a view of the controller.
the controller that this widget belongs to.
id of the widget.
owner/creator of this widget. It could be either a widget or a controller.
Returns the directory containing the view files for this widget. The default implementation returns the 'views' subdirectory of the directory containing the widget class file.
方法详情
|
public void __construct(CBaseController $owner=NULL)
| ||
| $owner | CBaseController | owner/creator of this widget. It could be either a widget or a controller. |
Constructor.
|
public static void actions()
|
Returns a list of actions that are used by this widget.
The structure of this method's return value is similar to
that returned by CController::actions.
When a widget uses several actions, you can declare these actions using
this method. The widget will then become an action provider, and the actions
can be easily imported into a controller.
Note, when creating URLs referring to the actions listed in this method,
make sure the action IDs are prefixed with actionPrefix.
|
public CController getController()
| ||
| {return} | CController | the controller that this widget belongs to. |
|
public string getId(boolean $autoGenerate=true)
| ||
| $autoGenerate | boolean | whether to generate an ID if it is not set previously |
| {return} | string | id of the widget. |
|
public CBaseController getOwner()
| ||
| {return} | CBaseController | owner/creator of this widget. It could be either a widget or a controller. |
|
public string getViewFile(string $viewName)
| ||
| $viewName | string | name of the view (without file extension) |
| {return} | string | the view file path. False if the view file does not exist |
Looks for the view script file according to the view name. This method will look for the view under the widget's viewPath. The view script file is named as "ViewName.php". A localized view file may be returned if internationalization is needed. See CApplication::findLocalizedFile for more details. Since version 1.0.2, the view name can also refer to a path alias if it contains dot characters.
|
public string getViewPath()
| ||
| {return} | string | the directory containing the view files for this widget. |
Returns the directory containing the view files for this widget. The default implementation returns the 'views' subdirectory of the directory containing the widget class file.
|
public void init()
|
Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized.
|
public string render(string $view, array $data=NULL, boolean $return=false)
| ||
| $view | string | name of the view to be rendered. See getViewFile for details about how the view script is resolved. |
| $data | array | data to be extracted into PHP variables and made available to the view script |
| $return | boolean | whether the rendering result should be returned instead of being displayed to end users |
| {return} | string | the rendering result. Null if the rendering result is not required. |
Renders a view.
The named view refers to a PHP script (resolved via getViewFile)
that is included by this method. If $data is an associative array,
it will be extracted as PHP variables and made available to the script.
参见
|
public void run()
|
Executes the widget. This method is called by CBaseController::endWidget.
|
public void setId(string $value)
| ||
| $value | string | id of the widget. |