Класс yii\widgets\InputWidget
| Наследование | yii\widgets\InputWidget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Подклассы | yii\bootstrap\InputWidget, yii\bootstrap\ToggleButtonGroup, yii\captcha\Captcha, yii\widgets\MaskedInput |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/InputWidget.php |
InputWidget — базовый класс для виджетов, собирающих пользовательский ввод.
Виджет ввода может быть связан с моделью данных и атрибутом или именем и значением. Если используется первый вариант, имя и значение будут сгенерированы автоматически.
Классы, расширяющие этот виджет, могут использоваться в ActiveForm с помощью метода widget(), например так:
<?= $form->field($model, 'from_date')->widget('WidgetClassName', [
// configure additional widget properties here
]) ?>
Более подробную информацию и инструкции по использованию InputWidget можно найти в статье руководства по формам.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $attribute | string | Атрибут модели, с которым связан этот виджет. | yii\widgets\InputWidget |
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $counter | integer | Счетчик, используемый для генерации идентификатора $id для виджетов. | yii\base\Widget |
| $field | yii\widgets\ActiveField | Активное поле ввода, которое запускает отрисовку этого виджета. | yii\widgets\InputWidget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $model | yii\base\Model | Модель данных, с которой связан этот виджет. | yii\widgets\InputWidget |
| $name | string | Имя поля ввода. | yii\widgets\InputWidget |
| $options | array | Атрибуты HTML для тега ввода. | yii\widgets\InputWidget |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отрисовываются (не завершены). | yii\base\Widget |
| $value | string | Значение поля ввода. | yii\widgets\InputWidget |
| $view | yii\web\View | Объект представления, который может использоваться для отрисовки представлений или файлов представления. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представления для этого виджета. | yii\base\Widget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает работу виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя квалифицированного класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к данному компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все прикреплённые к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который может использоваться для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает директорию, содержащую файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\widgets\InputWidget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\base\Widget |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| hasModel() | yii\widgets\InputWidget |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает, когда виджет инициализируется с помощью init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$attribute общедоступное свойство
Атрибут модели, с которым связан этот виджет.
public string $attribute = null
$field общедоступное свойство (доступно начиная с версии 2.0.11)
Активное поле ввода, которое инициирует рендеринг этого виджета. Это поле будет автоматически заполнено в случае создания экземпляра виджета через yii\widgets\ActiveField::widget().
public yii\widgets\ActiveField $field = null
$model общедоступное свойство
Модель данных, с которой связан этот виджет.
public yii\base\Model $model = null
$name общедоступное свойство
Имя поля ввода. Это значение должно быть установлено, если $model и $attribute не заданы.
public string $name = null
$options общедоступное свойство
HTML-атрибуты для тега ввода.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $options = []
$value общедоступное свойство
Значение поля ввода.
public string $value = null
Подробное описание методов
hasModel() защищённый метод
| защищённый boolean hasModel ( ) | ||
|---|---|---|
| возвращаемое значение | boolean |
Указывает, связан ли этот виджет с моделью данных. |
init() публичный метод
Инициализирует виджет.
Если вы переопределяете этот метод, убедитесь, что вы сначала вызываете родительскую реализацию.
| публичный void init ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-inputwidget.html
