CJuiInputWidget
| Пакет | zii.widgets.jui |
|---|---|
| Наследование | абстрактный класс CJuiInputWidget » CJuiWidget » CWidget » CBaseController » CComponent |
| Подклассы | CJuiAutoComplete, CJuiButton, CJuiDatePicker, CJuiSliderInput |
| С момента | 1.1 |
| Исходный код | framework/zii/widgets/jui/CJuiInputWidget.php |
CJuiInputWidget — базовый класс для виджетов JUI, которые могут собирать пользовательский ввод.
Общественные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| attribute | строка | атрибут, связанный с этим виджетом. | CJuiInputWidget |
| controller | CController | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| cssFile | смешанный тип | имя файла CSS темы. | CJuiWidget |
| htmlOptions | массив | HTML-атрибуты, которые должны быть отображены в HTML-теге, представляющем виджет JUI. | CJuiWidget |
| id | строка | Возвращает идентификатор виджета или генерирует новый по запросу. | CWidget |
| model | CModel | модель данных, связанная с этим виджетом. | CJuiInputWidget |
| name | строка | имя входного поля. | CJuiInputWidget |
| options | массив | начальные JavaScript-опции, которые должны быть переданы плагину JUI. | CJuiWidget |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| scriptFile | смешанный тип | основной JavaScript-файл JUI. | CJuiWidget |
| scriptUrl | строка | корневой URL, который содержит все JavaScript-файлы JUI. | CJuiWidget |
| skin | смешанный тип | имя скина, которое должно использоваться этим виджетом. | CWidget |
| theme | строка | имя темы JUI. | CJuiWidget |
| themeUrl | строка | корневой URL, который содержит все папки тем JUI. | CJuiWidget |
| value | строка | значение входного поля. | CJuiInputWidget |
| viewPath | строка | Возвращает каталог, содержащий файлы представления для этого виджета. | CWidget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение по его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| actions() | Возвращает список действий, используемых этим виджетом. | CWidget |
| asa() | Возвращает объект поведения по имени. | CComponent |
| attachBehavior() | Присоединяет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| beginCache() | Начинает кэширование фрагмента. | CBaseController |
| beginClip() | Начинает запись клипа. | CBaseController |
| beginContent() | Начинает отображение содержимого, которое должно быть оформлено указанным представлением. | CBaseController |
| beginWidget() | Создаёт виджет и выполняет его. | CBaseController |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| createWidget() | Создаёт виджет и инициализирует его. | CBaseController |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые поведения к этому компоненту. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые поведения к этому компоненту. | CComponent |
| endCache() | Завершает кэширование фрагмента. | CBaseController |
| endClip() | Завершает запись клипа. | CBaseController |
| endContent() | Завершает отображение содержимого. | CBaseController |
| endWidget() | Завершает выполнение указанного виджета. | CBaseController |
| evaluateExpression() | Вычисляет выражение PHP или обратный вызов в контексте этого компонента. | CComponent |
| getController() | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| getEventHandlers() | Возвращает список присоединённых обработчиков событий для события. | CComponent |
| getId() | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getViewFile() | Ищет файл сценария представления в соответствии с именем представления. | CWidget |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли у именованного события присоединённые обработчики. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует виджет. | CJuiWidget |
| raiseEvent() | Возбуждает событие. | CComponent |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Выполняет виджет. | CWidget |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| hasModel() | Определяет, связан ли этот виджет с моделью данных. | CJuiInputWidget |
| registerCoreScripts() | Регистрирует файлы основных скриптов. | CJuiWidget |
| registerScriptFile() | Регистрирует файл JavaScript по адресу scriptUrl. | CJuiWidget |
| resolveNameID() | Разрешает имя и идентификатор входных данных. Свойство источника имени и/или свойство источника атрибута | CJuiInputWidget |
| resolvePackagePath() | Определяет путь к установке пакета JUI. | CJuiWidget |
Подробное описание свойств
attribute свойство
public string $attribute;
атрибут, связанный с этим виджетом. Имя может содержать квадратные скобки (например, 'name[1]'), которые используются для сбора входных данных табличных данных.
model свойство
public CModel $model;
модель данных, связанная с этим виджетом.
имя свойство
public string $name;
имя входного поля. Оно должно быть установлено, если model не установлено.
значение свойство
public string $value;
значение входного поля.
Подробное описание методов
hasModel() метод
protected boolean hasModel() | ||
| {return} | boolean | указывает, ассоциировано ли данное виджет с моделью данных. |
Исходный код: framework/zii/widgets/jui/CJuiInputWidget.php#76 (показать)
protected function hasModel()
{
return $this->model instanceof CModel && $this->attribute!==null;
}
resolveNameID() метод
protected array resolveNameID(string $nameProperty='name', string $attributeProperty='attribute') | ||
| $nameProperty | строка | имя свойства класса, содержащего имя элемента, которое будет использовано. Этот параметр доступен начиная с версии 1.1.14. |
| $attributeProperty | строка | имя свойства класса, содержащего имя атрибута модели, которое будет использовано. Этот параметр доступен начиная с версии 1.1.14. |
| {return} | массив | имя и ID входного поля: массив ('имя', 'id'). |
Исходный код: framework/zii/widgets/jui/CJuiInputWidget.php#50 (показать)
protected function resolveNameID($nameProperty='name',$attributeProperty='attribute')
{
if($this->$nameProperty!==null)
$name=$this->$nameProperty;
elseif(isset($this->htmlOptions[$nameProperty]))
$name=$this->htmlOptions[$nameProperty];
elseif($this->hasModel())
$name=CHtml::activeName($this->model,$this->$attributeProperty);
else
throw new CException(Yii::t('zii','{class} must specify "model" and "{attribute}" or "{name}" property values.',
array('{class}'=>get_class($this),'{attribute}'=>$attributeProperty,'{name}'=>$nameProperty)));
if(($id=$this->getId(false))===null)
{
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$id=CHtml::getIdByName($name);
}
return array($name,$id);
}
Определяет имя и ID входного поля. Свойства имени и/или атрибута можно настроить, соответствующим образом указав первый и/или второй параметр.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiInputWidget
