Класс yii\jui\InputWidget
| Наследование | yii\jui\InputWidget » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Подклассы | yii\jui\AutoComplete, yii\jui\DatePicker, yii\jui\SliderInput, yii\jui\Spinner |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-jui/blob/master/InputWidget.php |
InputWidget — базовый класс для всех виджетов ввода jQuery UI.
Классы, расширяющие этот виджет, могут быть использованы в \yii\jui\yii\widgets\ActiveForm с помощью метода \yii\jui\yii\widgets\ActiveField::widget(), например, так:
<?= $form->field($model, 'from_date')->widget('WidgetClassName', [
// configure additional widget properties here
]) ?>
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $attribute | строка | Атрибут модели, с которым связан этот виджет. | yii\jui\InputWidget |
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $clientEvents | массив | Обработчики событий для базового виджета jQuery UI. | yii\jui\Widget |
| $clientOptions | массив | Параметры для базового виджета jQuery UI. | yii\jui\Widget |
| $counter | целое число | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $model | yii\base\Model | Модель данных, с которой связан этот виджет. | yii\jui\InputWidget |
| $name | строка | Имя элемента ввода. | yii\jui\InputWidget |
| $options | массив | Атрибуты HTML для тега контейнера виджета. | yii\jui\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отрисовываются (не завершены). | yii\base\Widget |
| $value | строка | Значение элемента ввода. | yii\jui\InputWidget |
| $view | yii\web\View | Объект представления, который может быть использован для отрисовки представлений или файлов представлений. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $clientEventMap | массив | Имена событий, сопоставленные с тем, что должно быть указано в `. | yii\jui\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() | Возвращает ID виджета. | 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\jui\InputWidget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\base\Widget |
| setId() | Устанавливает ID виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| hasModel() | yii\jui\InputWidget | |
| registerClientEvents() | Регистрирует определённые события jQuery UI виджета | yii\jui\Widget |
| registerClientOptions() | Регистрирует определённые опции jQuery UI виджета | yii\jui\Widget |
| registerWidget() | Регистрирует определённый пакет ресурсов jQuery UI виджета, инициализирует его опциями клиента и регистрирует связанные события | yii\jui\Widget |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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
$model открытое свойство
Модель данных, с которой связан этот виджет.
public yii\base\Model $model = null
$name открытое свойство
Имя ввода. Оно должно быть установлено, если $model и $attribute не установлены.
public string $name = null
$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-jui-inputwidget.html
