0 follower

CMaskedTextField

Package	system.web.widgets
Inheritance	class CMaskedTextField » CInputWidget » CWidget » CBaseController » CComponent
Since	1.0
Version	$Id$
Source Code	framework/web/widgets/CMaskedTextField.php

CMaskedTextField generates a masked text field.

CMaskedTextField is similar to CHtml::textField except that an input mask will be used to help users enter properly formatted data. The masked text field is implemented based on the jQuery masked input plugin (see https://digitalbush.com/projects/masked-input-plugin).

Public Properties

Hide inherited 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
charMap	array	the mapping between mask characters and the corresponding patterns.	CMaskedTextField
completed	string	a JavaScript function callback that will be invoked when user finishes the input.	CMaskedTextField
controller	CController	the controller that this widget belongs to.	CWidget
htmlOptions	array	additional HTML options to be rendered in the input tag	CInputWidget
id	string	id of the widget.	CWidget
mask	string	the input mask (e.g. '99/99/9999' for date input).	CMaskedTextField
model	CModel	the data model associated with this widget.	CInputWidget
name	string	the input name.	CInputWidget
owner	CBaseController	owner/creator of this widget.	CWidget
placeholder	string	the character prompting for user input.	CMaskedTextField
value	string	the input value	CInputWidget
viewPath	string	Returns the directory containing the view files for this widget.	CWidget

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
clientOptions	array	the options for the text field	CMaskedTextField

Public Methods

Hide inherited 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
getController()	Returns the controller that this widget belongs to.	CWidget
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()	Returns id of the widget.	CWidget
getOwner()	Returns owner/creator of this widget. It could be either a widget or a controller.	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
registerClientScript()	Registers the needed CSS and JavaScript.	CMaskedTextField
render()	Renders a view.	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	Executes the widget.	CMaskedTextField
setId()	Sets id of the widget.	CWidget
widget()	Creates a widget and executes it.	CBaseController

Protected Methods

Hide inherited methods

Method	Description	Defined By
getClientOptions()	Returns the options for the text field	CMaskedTextField
hasModel()	Determines whether this widget is associated with a data model.	CInputWidget
resolveNameID()		CInputWidget

Property Details

charMap property

public array $charMap;

the mapping between mask characters and the corresponding patterns. For example, array('~'=>'[+-]') specifies that the '~' character expects '+' or '-' input. Defaults to null, meaning using the map as described in mask.

clientOptions property read-only

protected array getClientOptions()

the options for the text field

completed property

public string $completed;

a JavaScript function callback that will be invoked when user finishes the input.

mask property

public string $mask;

the input mask (e.g. '99/99/9999' for date input). The following characters are predefined:

a: represents an alpha character (A-Z,a-z)
9: represents a numeric character (0-9)
*: represents an alphanumeric character (A-Z,a-z,0-9).

Additional characters can be defined by specifying the charMap property.

placeholder property

public string $placeholder;

the character prompting for user input. Defaults to underscore '_'.

Method Details

getClientOptions() method

protected array getClientOptions()
{return}	array	the options for the text field

Source Code: framework/web/widgets/CMaskedTextField.php#94 (show)


protected function getClientOptions()
{
    $options=array();
    if($this->placeholder!==null)
        $options['placeholder']=$this->placeholder;
    if(is_string($this->completed))
    {
        if(strncmp($this->completed,'js:',3))
            $options['completed']='js:'.$this->completed;
        else
            $options['completed']=$this->completed;
    }
    return $options;
}

registerClientScript() method (available since v1.0.1)

public void registerClientScript()

Source Code: framework/web/widgets/CMaskedTextField.php#76 (show)


public function registerClientScript()
{
    $id=$this->htmlOptions['id'];
    $miOptions=$this->getClientOptions();
    $options=$miOptions!==array() ? ','.CJavaScript::encode($miOptions) : '';
    $js='';
    if(is_array($this->charMap))
        $js.='jQuery.mask.definitions='.CJavaScript::encode($this->charMap).";\n";
    $js.="jQuery(\"#{$id}\").mask(\"{$this->mask}\"{$options});";

    $cs=Yii::app()->getClientScript();
    $cs->registerCoreScript('maskedinput');
    $cs->registerScript('Yii.CMaskedTextField#'.$id,$js);
}

Registers the needed CSS and JavaScript.

run() method

public void run()

Source Code: framework/web/widgets/CMaskedTextField.php#56 (show)


public function run()
{
    list($name,$id)=$this->resolveNameID();
    if(!isset($this->htmlOptions['id']))
        $this->htmlOptions['id']=$id;
    if(!isset($this->htmlOptions['name']))
        $this->htmlOptions['name']=$name;

    $this->registerClientScript();

    if($this->hasModel())
        echo CHtml::activeTextField($this->model,$this->attribute,$this->htmlOptions);
    else
        echo CHtml::textField($name,$this->value,$this->htmlOptions);
}

Executes the widget. This method registers all needed client scripts and renders the text field.