Spec-Zone.ru › Yii 1.1

CFormElement

Пакет system.web.form
Наследование абстрактный класс CFormElement » CComponent
Подклассы CForm, CFormButtonElement, CFormInputElement, CFormStringElement
С версии 1.1
Исходный код framework/web/form/CFormElement.php
CFormElement — базовый класс для представления всех видов элементов формы.

CFormElement реализует способ получения и установки произвольных атрибутов.

Свойства public

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

Методы public

Метод Описание Определено
__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
getParent() Возвращает непосредственного родителя этого элемента. Может быть объектом CForm или CBaseController (контроллер или виджет). CFormElement
getVisible() Возвращает значение, указывающее, является ли этот элемент видимым и должен ли он быть отображён. CFormElement
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли у события прикреплённые обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
raiseEvent() Возбуждает событие. CComponent
render() Отображает этот элемент. CFormElement
setVisible() Устанавливает, является ли этот элемент видимым и должен ли он быть отображён. CFormElement

Методы protected

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

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

attributes свойство

public array $attributes;

список атрибутов (имя=>значение) для HTML-элемента, представленного этим объектом.

parent свойство только для чтения

public mixed getParent()

прямой родитель этого элемента. Может быть объектом CForm или CBaseController (контроллера или виджета).

visible свойство

public boolean getVisible()
public void setVisible(boolean $value)

Возвращает значение, указывающее, является ли этот элемент видимым и должен ли он быть отображен. Этот метод вызывает evaluateVisible для определения видимости этого элемента.

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

__construct() метод

public void __construct(mixed $config, mixed $parent)
$config смешанный конфигурация для этого элемента.
$parent смешанный прямой родитель этого элемента.
Исходный код: framework/web/form/CFormElement.php#46 (показать)
public function __construct($config,$parent)
{
    
$this->configure($config);
    
$this->_parent=$parent;
}

Конструктор.

См. также

  • configure

__get() метод

public mixed __get(string $name)
$name строка имя свойства или атрибута
{return} смешанный значение свойства или атрибута
Исходный код: framework/web/form/CFormElement.php#77 (показать)
public function __get($name)
{
    
$getter='get'.$name;
    if(
method_exists($this,$getter))
        return 
$this->$getter();
    elseif(isset(
$this->attributes[$name]))
        return 
$this->attributes[$name];
    else
        throw new 
CException(Yii::t('yii','Property "{class}.{property}" is not defined.',
            array(
'{class}'=>get_class($this), '{property}'=>$name)));
}

Возвращает значение свойства или атрибута. Не вызывайте этот метод. Это магический PHP-метод, который мы переопределяем, чтобы разрешить использование следующего синтаксиса для чтения свойства или атрибута:

$value=$element->propertyName;
$value=$element->attributeName;

См. также

  • __set

__isset() метод

public boolean __isset(string $name)
$name строка имя свойства или атрибута
{return} логическое значение
Исходный код: framework/web/form/CFormElement.php#99 (показать)
public function __isset($name)
{
    
$getter='get'.$name;
    if(
method_exists($this,$getter))
        return 
$this->$getter()!==null;
    elseif(isset(
$this->attributes[$name]))
        return isset(
$this->attributes[$name]);
    else
        return 
false;
}

Проверяет существование или ненулевое значение свойства или атрибута. Не вызывайте этот метод. Это магический метод PHP, который мы переопределяем, чтобы разрешить использование следующего синтаксиса для чтения свойства или атрибута:

isset($element->propertyName);

__set() метод

public void __set(string $name, mixed $value)
$name строка имя свойства или атрибута
$value смешанный тип значение свойства или атрибута
Исходный код: framework/web/form/CFormElement.php#122 (показать)
public function __set($name,$value)
{
    
$setter='set'.$name;
    if(
method_exists($this,$setter))
        
$this->$setter($value);
    else
        
$this->attributes[$name]=$value;
}

Устанавливает значение свойства или атрибута. Не вызывайте этот метод. Это магический метод PHP, который мы переопределяем, чтобы разрешить использование следующего синтаксиса для установки свойства или атрибута.

$this->propertyName=$value;
$this->attributeName=$value;

См. также

  • __get

__toString() метод

public string __toString()
{return} строка строковое представление этого объекта.
Исходный код: framework/web/form/CFormElement.php#59 (показать)
public function __toString()
{
    return 
$this->render();
}

Преобразует объект в строку. Это магический метод PHP. По умолчанию выполняется вызов render и возвращается результат рендеринга.

configure() метод

public void configure(mixed $config)
$config смешанный тип конфигурация для данного объекта. Это может быть массив, представляющий имена свойств и их начальные значения. Также это может быть имя файла PHP-скрипта, возвращающего массив конфигурации.
Исходный код: framework/web/form/CFormElement.php#138 (показать)
public function configure($config)
{
    if(
is_string($config))
        
$config=require(Yii::getPathOfAlias($config).'.php');
    if(
is_array($config))
    {
        foreach(
$config as $name=>$value)
            
$this->$name=$value;
    }
}

Настраивает этот объект с начальными значениями свойств.

evaluateVisible() метод

protected boolean evaluateVisible()
{return} логическое значение видимость этого элемента. По умолчанию true.
Исходный код: framework/web/form/CFormElement.php#184 (показать)
protected function evaluateVisible()
{
    return 
true;
}

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

getParent() метод

public mixed getParent()
{return} смешанный тип прямой родитель этого элемента. Это может быть объект CForm или CBaseController (контроллер или виджет).
Исходный код: framework/web/form/CFormElement.php#173 (показать)
public function getParent()
{
    return 
$this->_parent;
}

getVisible() метод

public boolean getVisible()
{return} логическое значение видимость этого элемента и нужно ли его рендерить.
Исходный код: framework/web/form/CFormElement.php#154 (показать)
public function getVisible()
{
    if(
$this->_visible===null)
        
$this->_visible=$this->evaluateVisible();
    return 
$this->_visible;
}

Возвращает значение, указывающее, видимость этого элемента и нужно ли его рендерить. Этот метод вызовет evaluateVisible для определения видимости этого элемента.

render() метод

abstract public string render()
{return} строка результат рендеринга
Исходный код: framework/web/form/CFormElement.php#38 (показать)
abstract function render();

Отображает этот элемент.

setVisible() метод

public void setVisible(boolean $value)
$value логическое значение видимость этого элемента и нужно ли его рендерить.
Исходный код: framework/web/form/CFormElement.php#164 (показать)
public function setVisible($value)
{
    
$this->_visible=$value;
}

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

Spec-Zone.ru

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