Spec-Zone.ru › Yii 1.1

CFormStringElement

Package system.web.form
Inheritance class CFormStringElement » CFormElement » CComponent
Since 1.1
Source Code framework/web/form/CFormStringElement.php
CFormStringElement представляет строку в форме.

Общественные свойства

Свойство Тип Описание Определено
attributes массив список атрибутов (имя=>значение) для HTML-элемента, представленного этим объектом. CFormElement
content строка содержимое строки CFormStringElement
on строка Возвращает значение, указывающее, в каких сценариях эта строка отображается. CFormStringElement
parent смешанный непосредственный родитель этого элемента. CFormElement
visible логическое значение Возвращает значение, указывающее, виден ли этот элемент и следует ли его отображать. CFormElement

Общественные методы

Метод Описание Определено
__call() Вызывает именованный метод, который не является методом класса. CComponent
__construct() Конструктор. CFormElement
__get() Возвращает значение свойства или атрибута. CFormElement
__isset() Проверяет наличие или непустоту значения свойства или атрибута. CFormElement
__set() Устанавливает значение свойства или атрибута. CFormElement
__toString() Преобразует объект в строку. CFormElement
__unset() Устанавливает свойство компонента в null. CComponent
asa() Возвращает объект поведения с заданным именем. CComponent
attachBehavior() Прикрепляет поведение к этому компоненту. CComponent
attachBehaviors() Прикрепляет список поведений к компоненту. CComponent
attachEventHandler() Прикрепляет обработчик событий к событию. CComponent
canGetProperty() Определяет, может ли свойство быть прочитано. CComponent
canSetProperty() Определяет, может ли свойство быть установлено. CComponent
configure() Настраивает этот объект начальными значениями свойств. CFormElement
detachBehavior() Открепляет поведение от компонента. CComponent
detachBehaviors() Открепляет все поведения от компонента. CComponent
detachEventHandler() Открепляет существующий обработчик событий. CComponent
disableBehavior() Отключает прикреплённое поведение. CComponent
disableBehaviors() Отключает все прикрепленные поведения к этому компоненту. CComponent
enableBehavior() Включает прикрепленное поведение. CComponent
enableBehaviors() Включает все прикрепленные поведения к этому компоненту. CComponent
evaluateExpression() Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. CComponent
getEventHandlers() Возвращает список прикрепленных обработчиков событий для события. CComponent
getOn() Возвращает значение, указывающее, в каких сценариях эта строка отображается. CFormStringElement
getParent() Возвращает непосредственного родителя этого элемента. Это может быть объект CForm или CBaseController (контроллер или виджет). CFormElement
getVisible() Возвращает значение, указывающее, виден ли этот элемент и следует ли его отображать. CFormElement
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, имеет ли указанное событие прикрепленные обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
raiseEvent() Вызывает событие. CComponent
render() Отображает этот элемент. CFormStringElement
setOn() Устанавливает имена сценариев, разделённые запятыми. CFormStringElement
setVisible() Устанавливает, виден ли этот элемент и следует ли его отображать. CFormElement

Защищённые методы

Метод Описание Определено
evaluateVisible() Оценивает видимость этого элемента. CFormStringElement

Подробности свойств

content свойство

public string $content;

содержимое строки

on свойство

public string getOn()
public void setOn(string $value)

Возвращает значение, указывающее, в каких сценариях эта строка отображается. Если значение пустое, это означает, что строка отображается во всех сценариях. В противном случае, строка отображается только тогда, когда модель находится в сценарии, имя которого содержится в этом значении. См. CModel::scenario для получения дополнительной информации о сценариях модели.

Подробности методов

evaluateVisible() метод

protected boolean evaluateVisible()
{return} логическое значение является ли этот элемент видимым.
Исходный код: framework/web/form/CFormStringElement.php#66 (показать)
protected function evaluateVisible()
{
    return empty(
$this->_on) || in_array($this->getParent()->getModel()->getScenario(),$this->_on);
}

Оценивает видимость этого элемента. Этот метод проверяет свойство on, чтобы проверить, находится ли модель в сценарии, в котором должна отображаться эта строка.

getOn() метод

public string getOn()
{return} строка имена сценариев, разделённые запятыми. По умолчанию равно null.
Исходный код: framework/web/form/CFormStringElement.php#37 (показать)
public function getOn()
{
    return 
$this->_on;
}

Возвращает значение, указывающее, в каких сценариях эта строка отображается. Если значение пустое, это означает, что строка отображается во всех сценариях. В противном случае, строка будет отображаться только тогда, когда модель находится в сценарии, имя которого можно найти в этом значении. Смотрите CModel::scenario для получения дополнительной информации о сценариях модели.

render() метод

public string render()
{return} строка содержимое строки
Исходный код: framework/web/form/CFormStringElement.php#55 (показать)
public function render()
{
    return 
$this->content;
}

Отображает этот элемент. По умолчанию просто возвращает содержимое.

setOn() метод

public void setOn(string $value)
$value строка имена сценариев, разделенных запятыми.
Исходный код: framework/web/form/CFormStringElement.php#45 (показать)
public function setOn($value)
{
    
$this->_on=preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
}

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CFormStringElement

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API