php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-21 09:01:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed comments and code style

Browse Source
This commit is contained in:
Antonio Ramirez
2013-05-21 16:08:54 +02:00
parent f0f19e338a
commit 8d1a745192
1 changed files with 19 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
yii/bootstrap/TypeAhead.php
View File

@@ -18,12 +18,12 @@ use yii\widgets\ActiveForm;
* *
* ```php * ```php
* echo TypeAhead::widget(array( * echo TypeAhead::widget(array(
* 'form' => $form, * 'form' => $form,
* 'model' => $model, * 'model' => $model,
* 'attribute' => 'country', * 'attribute' => 'country',
* 'pluginOptions' => array( * 'pluginOptions' => array(
* 'source' => array('USA', 'ESP'), * 'source' => array('USA', 'ESP'),
* ), * ),
* )); * ));
* ``` * ```
* *
@@ -31,10 +31,10 @@ use yii\widgets\ActiveForm;
* *
* ```php * ```php
* echo TypeAhead::widget(array( * echo TypeAhead::widget(array(
* 'name' => 'country', * 'name' => 'country',
* 'pluginOptions' => array( * 'pluginOptions' => array(
* 'source' => array('USA', 'ESP'), * 'source' => array('USA', 'ESP'),
* ), * ),
* )); * ));
*``` *```
* *
@@ -59,7 +59,7 @@ class TypeAhead extends Widget
public $attribute; public $attribute;
/** /**
* @var string the input name. This must be set if [[TypeAhead::$form]] is not set. * @var string the input name. This must be set if [[form]] is not set.
*/ */
public $name; public $name;
@@ -70,7 +70,7 @@ class TypeAhead extends Widget
public function init() public function init()
{ {
parent::init(); parent::init();
echo "\n" . $this->renderField(); echo "\n" . $this->renderField() . "\n";
} }
/** /**
@@ -82,12 +82,13 @@ class TypeAhead extends Widget
} }
/** /**
* Renders the TypeAhead field. If [[TypeAhead::form]] has been specified then it will render an active field. * Renders the TypeAhead field. If [[form]] has been specified then it will render an active field.
* Please, note that function will only check whether the form has been set, model and attributes will not. * Please, note that function will only check whether the form has been set, model and attributes will not.
* If [[TypeAhead::form]] is null not from an [[ActiveForm]] instance, then the field will be rendered according to * If [[form]] is null not from an [[ActiveForm]] instance, then the field will be rendered according to
* the `name` key setting of [[TypeAhead::options]] array attribute. * the `name` key setting of [[options]] array attribute.
* @return string the rendering result * @return string the rendering result
* @throws InvalidParamException * @throws InvalidParamException when none of the required attributes are set to render the textInput. That is,
* if [[form]], [[model]] and [[attribute]] are not set, then [[name]] is required.
*/ */
public function renderField() public function renderField()
{ {
@@ -100,7 +101,7 @@ class TypeAhead extends Widget
'class' => 'yii\widgets\ActiveField', 'class' => 'yii\widgets\ActiveField',
'model' => $this->model, 'model' => $this->model,
'attribute' => $this->attribute, 'attribute' => $this->attribute,
'form' => $this->form 'form' => $this->form,
) )
)->textInput(); )->textInput();
} }