CInputWidget
| Package | system.web.widgets |
|---|---|
| Inheritance | abstract class CInputWidget » CWidget » CBaseController » CComponent |
| Subclasses | CAutoComplete, CMaskedTextField, CMultiFileUpload, CStarRating |
| Since | 1.0 |
| Source Code | framework/web/widgets/CInputWidget.php |
CInputWidget is the base class for widgets that collect user inputs.
CInputWidget declares properties common among input widgets. An input widget can be associated with a data model and an attribute, or a name and a value. If the former, the name and the value will be generated automatically. Child classes may use resolveNameID and hasModel.
CInputWidget declares properties common among input widgets. An input widget can be associated with a data model and an attribute, or a name and a value. If the former, the name and the value will be generated automatically. Child classes may use resolveNameID and hasModel.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| attribute | string | the attribute associated with this widget. | CInputWidget |
| controller | CController | Returns the controller that this widget belongs to. | CWidget |
| htmlOptions | array | additional HTML options to be rendered in the input tag | CInputWidget |
| id | string | Returns the ID of the widget or generates a new one if requested. | CWidget |
| model | CModel | the data model associated with this widget. | CInputWidget |
| name | string | the input name. | CInputWidget |
| owner | CBaseController | Returns the owner/creator of this widget. | CWidget |
| skin | mixed | the name of the skin to be used by this widget. | CWidget |
| value | string | the input value | CInputWidget |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getController() | Returns the controller that this widget belongs to. | CWidget |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | Returns the ID of the widget or generates a new one if requested. | CWidget |
| getOwner() | Returns the owner/creator of this widget. | 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() | Sets the ID of the widget. | CWidget |
| widget() | Creates a widget and executes it. | CBaseController |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| hasModel() | Determines whether this widget is associated with a data model. | CInputWidget |
| resolveNameID() | CInputWidget |
Property Details
attribute property
public string $attribute;
the attribute associated with this widget. The name can contain square brackets (e.g. 'name[1]') which is used to collect tabular data input.
htmlOptions property
public array $htmlOptions;
additional HTML options to be rendered in the input tag
model property
public CModel $model;
the data model associated with this widget.
name property
public string $name;
the input name. This must be set if model is not set.
value property
public string $value;
the input value
Method Details
hasModel() method
protected boolean hasModel() | ||
| {return} | boolean | whether this widget is associated with a data model. |
Source Code: framework/web/widgets/CInputWidget.php#77 (show)
protected function hasModel()
{
return $this->model instanceof CModel && $this->attribute!==null;
}
resolveNameID() method
protected array resolveNameID() | ||
| {return} | array | the name and the ID of the input. |
Source Code: framework/web/widgets/CInputWidget.php#52 (show)
protected function resolveNameID()
{
if($this->name!==null)
$name=$this->name;
elseif(isset($this->htmlOptions['name']))
$name=$this->htmlOptions['name'];
elseif($this->hasModel())
$name=CHtml::activeName($this->model,$this->attribute);
else
throw new CException(Yii::t('yii','{class} must specify "model" and "attribute" or "name" property values.',array('{class}'=>get_class($this))));
if(($id=$this->getId(false))===null)
{
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$id=CHtml::getIdByName($name);
}
return array($name,$id);
}
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CInputWidget