Varien_Data_Form_Abstract Class Reference

Inheritance diagram for Varien_Data_Form_Abstract:

List of all members.

Public Member Functions
	__construct ($attributes=array())
	addType ($type, $className)
	getElements ()
	addElement (Varien_Data_Form_Element_Abstract $element, $after=null)
	addField ($elementId, $type, $config, $after=false)
	removeField ($elementId)
	addFieldset ($elementId, $config, $after=false)
	addColumn ($elementId, $config)
	__toArray (array $arrAttributes=array())
Protected Attributes
	$_elements
	$_types = array()

---

Detailed Description

Definition at line 35 of file Abstract.php.

---

Constructor & Destructor Documentation

__construct

(

$

attributes = array()

)

Enter description here...

Parameters:

array

$attributes

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Helper_Form_Boolean, Mage_Adminhtml_Block_Catalog_Product_Helper_Form_Price, Mage_Adminhtml_Block_System_Config_Form_Field_Import, Varien_Data_Form_Element_Abstract, Varien_Data_Form_Element_Button, Varien_Data_Form_Element_Checkbox, Varien_Data_Form_Element_Checkboxes, Varien_Data_Form_Element_Column, Varien_Data_Form_Element_Date, Varien_Data_Form_Element_Editor, Varien_Data_Form_Element_Fieldset, Varien_Data_Form_Element_File, Varien_Data_Form_Element_Gallery, Varien_Data_Form_Element_Hidden, Varien_Data_Form_Element_Image, Varien_Data_Form_Element_Imagefile, Varien_Data_Form_Element_Label, Varien_Data_Form_Element_Multiline, Varien_Data_Form_Element_Multiselect, Varien_Data_Form_Element_Note, Varien_Data_Form_Element_Password, Varien_Data_Form_Element_Radio, Varien_Data_Form_Element_Radios, Varien_Data_Form_Element_Reset, Varien_Data_Form_Element_Select, Varien_Data_Form_Element_Submit, Varien_Data_Form_Element_Text, Varien_Data_Form_Element_Textarea, Varien_Data_Form_Element_Time, and Varien_Data_Form.

Definition at line 57 of file Abstract.php.

    {
        parent::__construct($attributes);
    }

---

Member Function Documentation

__toArray

(

array $

arrAttributes = array()

)

Enter description here...

Parameters:

array

$arrAttributes

Returns:

array

Reimplemented from Varien_Object.

Definition at line 181 of file Abstract.php.

    {
        $res = array();
        $res['config']  = $this->getData();
        $res['formElements']= array();
        foreach ($this->getElements() as $element) {
            $res['formElements'][] = $element->toArray();
        }
        return $res;
    }

addColumn	(	$	elementId,
		$	config
	)

Enter description here...

Parameters:

	string	$elementId
	array	$config

Returns:

Varien_Data_Form_Element_Column

Definition at line 166 of file Abstract.php.

    {
        $element = new Varien_Data_Form_Element_Column($config);
        $element->setForm($this)
            ->setId($elementId);
        $this->addElement($element);
        return $element;
    }

addElement	(	Varien_Data_Form_Element_Abstract $	element,
		$	after = null
	)

Add form element

Parameters:

Varien_Data_Form_Element_Abstract

$element

Returns:

Varien_Data_Form

Reimplemented in Varien_Data_Form_Element_Abstract, and Varien_Data_Form.

Definition at line 94 of file Abstract.php.

    {
        $element->setForm($this);
        $this->getElements()->add($element, $after);
        return $this;
    }

addField	(	$	elementId,
		$	type,
		$	config,
		$	after = false
	)

Add child element

if $after parameter is false - then element adds to end of collection if $after parameter is null - then element adds to befin of collection if $after parameter is string - then element adds after of the element with some id

Parameters:

	string	$elementId
	string	$type
	array	$config
	mixed	$after

Returns:

Varien_Data_Form_Element_Abstract

Reimplemented in Varien_Data_Form_Element_Fieldset.

Definition at line 114 of file Abstract.php.

    {
        if (isset($this->_types[$type])) {
            $className = $this->_types[$type];
        }
        else {
            $className = 'Varien_Data_Form_Element_'.ucfirst(strtolower($type));
        }
        $element = new $className($config);
        $element->setId($elementId);
        if ($element->getRequired()) {
            $element->addClass('required-entry');
        }
        $this->addElement($element, $after);
        return $element;
    }

addFieldset	(	$	elementId,
		$	config,
		$	after = false
	)

Enter description here...

Parameters:

	string	$elementId
	unknown_type	$config
	unknown_type	$after

Returns:

Varien_Data_Form_Element_Fieldset

Definition at line 151 of file Abstract.php.

    {
        $element = new Varien_Data_Form_Element_Fieldset($config);
        $element->setId($elementId);
        $this->addElement($element, $after);
        return $element;
    }

addType	(	$	type,
		$	className
	)

Enter description here...

Parameters:

	string	$type
	string	$className

Returns:

Varien_Data_Form_Abstract

Definition at line 69 of file Abstract.php.

    {
        $this->_types[$type] = $className;
        return $this;
    }

getElements

(

)

Enter description here...

Returns:

Varien_Data_Form_Element_Collection

Definition at line 80 of file Abstract.php.

    {
        if (empty($this->_elements)) {
            $this->_elements = new Varien_Data_Form_Element_Collection($this);
        }
        return $this->_elements;
    }

removeField

(

$

elementId

)

Enter description here...

Parameters:

string

$elementId

Returns:

Varien_Data_Form_Abstract

Reimplemented in Varien_Data_Form_Element_Abstract, and Varien_Data_Form.

Definition at line 137 of file Abstract.php.

    {
        $this->getElements()->remove($elementId);
        return $this;
    }

---

Member Data Documentation

$_elements [protected]

Reimplemented in Varien_Data_Form_Element_Abstract.

Definition at line 43 of file Abstract.php.

$_types = array() [protected]

Definition at line 50 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• lib/Varien/Data/Form/Abstract.php