CForm

'elements'=>array(
    'username'=>array('type'=>'text', 'maxlength'=>80),
    'password'=>array('type'=>'password', 'maxlength'=>80),
)

Подробное описание свойств

action свойство

public mixed $action;

URL действия формы (см. CHtml::normalizeUrl для подробностей об этом параметре). По умолчанию пустая строка, означающая текущий URL запроса. Это свойство игнорируется, когда эта форма является дочерней.

activeForm свойство (доступно начиная с версии 1.1.1)

public array $activeForm;

Настройка, используемая для создания активной формы виджета. Виджет будет использоваться для рендеринга тега формы и сообщений об ошибках. Параметр 'class' обязателен, он указывает класс виджета. Остальные параметры будут переданы в вызов CBaseController::beginWidget(). По умолчанию массив ('class'=>'CActiveForm').

activeFormWidget свойство только для чтения (доступно начиная с версии 1.1.1)

public CActiveForm getActiveFormWidget()

Активный виджет формы, связанный с этой формой. Этот метод вернёт активный виджет формы, как указано в activeForm.

attributes свойство

public array $attributes;

Значения HTML атрибутов для тега формы. Если форма вложена в другую форму, это свойство будет использоваться для рендеринга значений HTML атрибутов для тега fieldset, окружающего дочернюю форму.

buttonElementClass свойство

public string $buttonElementClass;

Имя класса для представления элемента кнопки формы. По умолчанию 'CFormButtonElement'.

buttons свойство

public CFormElementCollection getButtons()
public void setButtons(array $buttons)

Возвращает элементы кнопок этой формы. Обратите внимание, что возвращаемый результат — объект CFormElementCollection, что означает, что вы можете использовать его как массив. Для более подробной информации см. CMap.

description свойство

public string $description;

Описание этой формы.

elements свойство

public CFormElementCollection getElements()
public void setElements(array $elements)

Возвращает элементы ввода этой формы. Это включает текстовые строки, элементы ввода и дочерние формы. Обратите внимание, что возвращаемый результат — объект CFormElementCollection, что означает, что вы можете использовать его как массив. Для более подробной информации см. CMap.

errorSummaryFooter свойство

public string|null $errorSummaryFooter;

HTML-код для добавления в список ошибок в сводке ошибок. См. CActiveForm::errorSummary().

errorSummaryHeader свойство

public string|null $errorSummaryHeader;

HTML-код для добавления перед списком ошибок в сводке ошибок. См. CActiveForm::errorSummary().

inputElementClass свойство

public string $inputElementClass;

Имя класса для представления элемента ввода формы. По умолчанию 'CFormInputElement'.

method свойство

public string $method;

Метод отправки этой формы. По умолчанию 'post'. Это свойство игнорируется, когда эта форма является дочерней.

model свойство

public CModel getModel(boolean $checkParent=true)
public void setModel(CModel $model)

Возвращает модель, с которой связана эта форма.

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

public array getModels()

Возвращает все модели, связанные с этой формой или её дочерними формами.

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

public CBaseController getOwner()

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

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

public CForm getRoot()

Главный объект формы.

showErrorSummary свойство

public boolean $showErrorSummary;

Определяет, отображать ли сводку ошибок. По умолчанию false.

showErrors свойство (доступно начиная с версии 1.1.14)

public boolean|null $showErrors;

Определяет, должны ли быть отображены элементы ошибок атрибутов формы. Возможные значения: null, true и false.

По умолчанию null, что означает использование значения $showErrorSummary. Это сделано для обеспечения обратной совместимости с существующими приложениями. Если вы хотите использовать сводку ошибок с AJAX и/или клиентской валидацией, нужно установить это свойство в true (напомним, что CActiveForm::error() необходимо вызвать для каждого атрибута, который будет валидироваться с помощью AJAX и/или клиентской валидации).

Значение false означает, что элементы ошибок атрибутов формы не будут отображаться. Значение true означает, что элементы ошибок атрибутов формы будут отображаться.

title свойство

public string $title;

Заголовок этой формы. Если он установлен, по умолчанию вокруг тела формы может быть рендеринга тег fieldset с заголовком, использующим заголовок в качестве легенды. По умолчанию null.

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

protected string getUniqueId()

Возвращает уникальный идентификатор, определяющий эту форму на текущей странице.

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

__construct() метод

public void __construct(mixed $config, CModel $model=NULL, mixed $parent=NULL)

public function __construct($config,$model=null,$parent=null)
{
    $this->setModel($model);
    if($parent===null)
        $parent=Yii::app()->getController();
    parent::__construct($config,$parent);
    if($this->showErrors===null)
        $this->showErrors=!$this->showErrorSummary;
    $this->init();
}

Конструктор. Если вы переопределяете этот метод, убедитесь, что вы не изменяете сигнатуру метода, а также что вы вызываете реализацию родителя.

addedElement() метод

public void addedElement(string $name, CFormElement $element, boolean $forButtons)

public function addedElement($name,$element,$forButtons)
{
}

Этот метод вызывается после добавления элемента в коллекцию элементов.

clicked() метод

public boolean clicked(string $name)

public function clicked($name)
{
    if(strcasecmp($this->getRoot()->method,'get'))
        return isset($_POST[$name]);
    else
        return isset($_GET[$name]);
}

Возвращает значение, указывающее, была ли нажата указанная кнопка.

evaluateVisible() метод

protected boolean evaluateVisible()

protected function evaluateVisible()
{
    foreach($this->getElements() as $element)
        if($element->getVisible())
            return true;
    return false;
}

Определяет видимость этой формы. Метод проверит видимость элементов elements. Если хотя бы один из них видим, форма считается видимой. В противном случае — нет.

getActiveFormWidget() метод (доступно начиная с версии 1.1.1)

public CActiveForm getActiveFormWidget()

public function getActiveFormWidget()
{
    if($this->_activeForm!==null)
        return $this->_activeForm;
    else
        return $this->getRoot()->_activeForm;
}

getButtons() метод

public CFormElementCollection getButtons()

public function getButtons()
{
    if($this->_buttons===null)
        $this->_buttons=new CFormElementCollection($this,true);
    return $this->_buttons;
}

Возвращает элементы кнопок этой формы. Обратите внимание, что возвращаемое значение — объект CFormElementCollection, что означает, что вы можете использовать его как массив. Подробнее см. CMap.

getElements() метод

public CFormElementCollection getElements()

public function getElements()
{
    if($this->_elements===null)
        $this->_elements=new CFormElementCollection($this,false);
    return $this->_elements;
}

Возвращает элементы ввода этой формы. Это включает текстовые строки, элементы ввода и подформы. Обратите внимание, что возвращаемое значение — объект CFormElementCollection, что означает, что вы можете использовать его как массив. Подробнее см. CMap.

getModel() метод

public CModel getModel(boolean $checkParent=true)

public function getModel($checkParent=true)
{
    if(!$checkParent)
        return $this->_model;
    $form=$this;
    while($form->_model===null && $form->getParent() instanceof self)
        $form=$form->getParent();
    return $form->_model;
}

Возвращает модель, с которой связана эта форма.

getModels() метод

public array getModels()

public function getModels()
{
    $models=array();
    if($this->_model!==null)
        $models[]=$this->_model;
    foreach($this->getElements() as $element)
    {
        if($element instanceof self)
            $models=array_merge($models,$element->getModels());
    }
    return $models;
}

Возвращает все модели, связанные с этой формой или её вложенными формами.

getOwner() метод

public CBaseController getOwner()

public function getOwner()
{
    $owner=$this->getParent();
    while($owner instanceof self)
        $owner=$owner->getParent();
    return $owner;
}

getRoot() метод

public CForm getRoot()

public function getRoot()
{
    $root=$this;
    while($root->getParent() instanceof self)
        $root=$root->getParent();
    return $root;
}

getUniqueId() метод

protected string getUniqueId()

protected function getUniqueId()
{
    if(isset($this->attributes['id']))
        return 'yform_'.$this->attributes['id'];
    else
        return 'yform_'.sprintf('%x',crc32(serialize(array_keys($this->getElements()->toArray()))));
}

Возвращает уникальный идентификатор, определяющий эту форму на текущей странице.

init() метод

protected void init()

protected function init()
{
}

Инициализирует данную форму. Этот метод вызывается в конце конструктора. Вы можете переопределить этот метод, чтобы обеспечить кастомизированную инициализацию (например, конфигурирование объекта формы).

loadData() метод

public void loadData()

public function loadData()
{
    if($this->_model!==null)
    {
        $class=CHtml::modelName($this->_model);
        if(strcasecmp($this->getRoot()->method,'get'))
        {
            if(isset($_POST[$class]))
                $this->_model->setAttributes($_POST[$class]);
        }
        elseif(isset($_GET[$class]))
            $this->_model->setAttributes($_GET[$class]);
    }
    foreach($this->getElements() as $element)
    {
        if($element instanceof self)
            $element->loadData();
    }
}

Загружает данные, отправленные с формы, в соответствующую модель (или модели). Данный метод пройдёт по всем моделям, связанным с этой формой и вложенными формами, и массово присвоит отправленные данные моделям.

offsetExists() метод

public boolean offsetExists(mixed $offset)

public function offsetExists($offset)
{
    return $this->getElements()->contains($offset);
}

Возвращает, существует ли элемент по указанному смещению. Этот метод необходим для интерфейса ArrayAccess.

offsetGet() метод

public mixed offsetGet(integer $offset)

public function offsetGet($offset)
{
    return $this->getElements()->itemAt($offset);
}

Возвращает элемент по указанному смещению. Этот метод необходим для интерфейса ArrayAccess.

offsetSet() метод

public void offsetSet(integer $offset, mixed $item)

public function offsetSet($offset,$item)
{
    $this->getElements()->add($offset,$item);
}

Устанавливает элемент по указанному смещению. Этот метод необходим для интерфейса ArrayAccess.

offsetUnset() метод

public void offsetUnset(mixed $offset)

public function offsetUnset($offset)
{
    $this->getElements()->remove($offset);
}

Удаляет элемент по указанному смещению. Этот метод необходим для интерфейса ArrayAccess.

removedElement() метод

public void removedElement(string $name, CFormElement $element, boolean $forButtons)

public function removedElement($name,$element,$forButtons)
{
}

Этот метод вызывается после удаления элемента из коллекции элементов.

render() метод

public string render()

public function render()
{
    return $this->renderBegin() . $this->renderBody() . $this->renderEnd();
}

Отображает форму. Стандартная реализация просто вызывает renderBegin, renderBody и renderEnd.

renderBegin() метод

public string renderBegin()

public function renderBegin()
{
    if($this->getParent() instanceof self)
        return '';
    else
    {
        $options=$this->activeForm;
        if(isset($options['class']))
        {
            $class=$options['class'];
            unset($options['class']);
        }
        else
            $class='CActiveForm';
        $options['action']=$this->action;
        $options['method']=$this->method;
        if(isset($options['htmlOptions']))
        {
            foreach($this->attributes as $name=>$value)
                $options['htmlOptions'][$name]=$value;
        }
        else
            $options['htmlOptions']=$this->attributes;
        ob_start();
        $this->_activeForm=$this->getOwner()->beginWidget($class, $options);
        return ob_get_clean() . "<div style=\"display:none\">".CHtml::hiddenField($this->getUniqueID(),1)."</div>\n";
    }
}

Отображает открывающий тег формы. Стандартная реализация отобразит открывающий тег формы.

renderBody() метод

public string renderBody()

public function renderBody()
{
    $output='';
    if($this->title!==null)
    {
        if($this->getParent() instanceof self)
        {
            $attributes=$this->attributes;
            unset($attributes['name'],$attributes['type']);
            $output=CHtml::openTag('fieldset', $attributes)."<legend>".$this->title."</legend>\n";
        }
        else
            $output="<fieldset>\n<legend>".$this->title."</legend>\n";
    }

    if($this->description!==null)
        $output.="<div class=\"description\">\n".$this->description."</div>\n";

    if($this->showErrorSummary && ($model=$this->getModel(false))!==null)
        $output.=$this->getActiveFormWidget()->errorSummary($model,$this->errorSummaryHeader,$this->errorSummaryFooter)."\n";

    $output.=$this->renderElements()."\n".$this->renderButtons()."\n";

    if($this->title!==null)
        $output.="</fieldset>\n";

    return $output;
}

Отображает содержимое тела формы. Этот метод в основном отображает элементы и кнопки. Если указан заголовок или описание, они также будут отображены. Если ассоциированная модель содержит ошибку, также может быть отображено резюме ошибок. Тег формы не будет отображен. Для отображения открывающего и закрывающего тегов формы вызовите renderBegin и renderEnd. Вы можете переопределить этот метод, чтобы настроить отображение формы.

renderButtons() метод

public string renderButtons()

public function renderButtons()
{
    $output='';
    foreach($this->getButtons() as $button)
        $output.=$this->renderElement($button);
    return $output!=='' ? "<div class=\"row buttons\">".$output."</div>\n" : '';
}

Отображает кнопки в этой форме.

renderElement() метод

public string renderElement(mixed $element)

public function renderElement($element)
{
    if(is_string($element))
    {
        if(($e=$this[$element])===null && ($e=$this->getButtons()->itemAt($element))===null)
            return $element;
        else
            $element=$e;
    }
    if($element->getVisible())
    {
        if($element instanceof CFormInputElement)
        {
            if($element->type==='hidden')
                return "<div style=\"display:none\">\n".$element->render()."</div>\n";
            else
                return "<div class=\"row field_{$element->name}\">\n".$element->render()."</div>\n";
        }
        elseif($element instanceof CFormButtonElement)
            return $element->render()."\n";
        else
            return $element->render();
    }
    return '';
}

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

renderElements() метод

public string renderElements()

public function renderElements()
{
    $output='';
    foreach($this->getElements() as $element)
        $output.=$this->renderElement($element);
    return $output;
}

Отображает элементы в этой форме.

renderEnd() метод

public string renderEnd()

public function renderEnd()
{
    if($this->getParent() instanceof self)
        return '';
    else
    {
        ob_start();
        $this->getOwner()->endWidget();
        return ob_get_clean();
    }
}

Отображает закрывающий тег формы.

setButtons() метод

public void setButtons(array $buttons)

public function setButtons($buttons)
{
    $collection=$this->getButtons();
    foreach($buttons as $name=>$config)
        $collection->add($name,$config);
}

Настраивает кнопки этой формы. Настройка должна быть массивом конфигураций кнопок, индексированных по имени кнопки. Каждый массив конфигурации кнопки содержит пары имя-значение, используемые для инициализации объекта CFormButtonElement.

setElements() метод

public void setElements(array $elements)

public function setElements($elements)
{
    $collection=$this->getElements();
    foreach($elements as $name=>$config)
        $collection->add($name,$config);
}

Настраивает элементы ввода этой формы. Настройка должна быть массивом конфигураций элементов ввода, индексированных по имени элемента ввода. Каждый массив конфигурации элемента ввода содержит пары имя-значение, используемые для инициализации объекта CFormStringElement (если 'type' равен 'string'), объекта CFormElement (если 'type' — строка, оканчивающаяся на 'Form') или объекта CFormInputElement во всех остальных случаях.

setModel() метод

public void setModel(CModel $model)

public function setModel($model)
{
    $this->_model=$model;
}

submitted() метод

public boolean submitted(string $buttonName='submit', boolean $loadData=true)

public function submitted($buttonName='submit',$loadData=true)
{
    $ret=$this->clicked($this->getUniqueId()) && $this->clicked($buttonName);
    if($ret && $loadData)
        $this->loadData();
    return $ret;
}

Возвращает значение, указывающее, была ли эта форма отправлена.

validate() метод

public boolean validate()

public function validate()
{
    $ret=true;
    foreach($this->getModels() as $model)
        $ret=$model->validate() && $ret;
    return $ret;
}

Проверяет модели, связанные с этой формой. Все модели, включая связанные с подформами, будут проверены. Вы можете использовать CModel::getErrors() для получения сообщений об ошибках проверки.