Mage_Adminhtml_Block_Widget_Form Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Widget_Form:

List of all members.

Public Member Functions

__construct ()

getForm ()

getFormObject ()

getFormHtml ()

setForm (Varien_Data_Form $form)

Protected Member Functions

_prepareLayout ()

_prepareForm ()

_beforeToHtml ()

_initFormValues ()

_setFieldset ($attributes, $fieldset, $exclude=array())

_addElementTypes (Varien_Data_Form_Abstract $baseElement)

_getAdditionalElementTypes ()

_getAdditionalElementHtml ($element)

Protected Attributes

$_form

Detailed Description

Definition at line 34 of file Form.php.

Constructor & Destructor Documentation

__construct ( )

Class constructor

Reimplemented from Varien_Object.

Definition at line 48 of file Form.php.

00049     {
00050         parent::__construct();
00051         $this->setTemplate('widget/form.phtml');
00052         $this->setDestElementId('edit_form');
00053         $this->setShowGlobalIcon(false);
00054     }

Member Function Documentation

_addElementTypes ( Varien_Data_Form_Abstract $ baseElement ) [protected]

Add new element type

Parameters:

Varien_Data_Form_Abstract

$baseElement

Definition at line 210 of file Form.php.

00211     {
00212         $types = $this->_getAdditionalElementTypes();
00213         foreach ($types as $code => $className) {
00214             $baseElement->addType($code, $className);
00215         }
00216     }

_beforeToHtml ( ) [protected]

This method is called before rendering HTML

Returns:: Mage_Adminhtml_Block_Widget_Form

Reimplemented from Mage_Core_Block_Abstract.

Reimplemented in Mage_Adminhtml_Block_Api_Tab_Roleinfo, and Mage_Adminhtml_Block_Permissions_Tab_Roleinfo.

Definition at line 137 of file Form.php.

00138     {
00139         $this->_prepareForm();
00140         $this->_initFormValues();
00141         return parent::_beforeToHtml();
00142     }

_getAdditionalElementHtml ( $ element ) [protected]

Enter description here...

Parameters:

Varien_Data_Form_Element_Abstract

$element

Returns:: string

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Action_Attribute_Tab_Attributes.

Definition at line 234 of file Form.php.

00235     {
00236         return '';
00237     }

_getAdditionalElementTypes ( ) [protected]

Retrieve predefined additional element types

Returns:: array

Reimplemented in Mage_Adminhtml_Block_Catalog_Category_Tab_Attributes, Mage_Adminhtml_Block_Catalog_Category_Tab_General, Mage_Adminhtml_Block_Catalog_Product_Attribute_Edit_Tab_Main, Mage_Adminhtml_Block_Catalog_Product_Attribute_New_Product_Attributes, Mage_Adminhtml_Block_Catalog_Product_Edit_Action_Attribute_Tab_Attributes, Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Attributes, and Mage_Adminhtml_Block_System_Config_Form.

Definition at line 223 of file Form.php.

00224     {
00225         return array();
00226     }

_initFormValues ( ) [protected]

Initialize form fileds values Method will be called after prepareForm and can be used for field values initialization

Returns:: Mage_Adminhtml_Block_Widget_Form

Definition at line 150 of file Form.php.

00151     {
00152         return $this;
00153     }

_prepareForm ( ) [protected]

Prepare form before rendering HTML

Returns:: Mage_Adminhtml_Block_Widget_Form

Definition at line 127 of file Form.php.

00128     {
00129         return $this;
00130     }

_prepareLayout ( ) [protected]

Prepare block children and data

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 60 of file Form.php.

00061     {
00062         Varien_Data_Form::setElementRenderer(
00063             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_element')
00064         );
00065         Varien_Data_Form::setFieldsetRenderer(
00066             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_fieldset')
00067         );
00068         Varien_Data_Form::setFieldsetElementRenderer(
00069             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_fieldset_element')
00070         );
00071     }

_setFieldset	(	$	attributes,
		$	fieldset,
		$	exclude = `array()`
	)			`[protected]`

Set Fieldset to Form

Parameters:

	array	$attributes attributes that are to be added
	Varien_Data_Form_Element_Fieldset	$fieldset
	array	$exclude attributes that should be skipped

Definition at line 162 of file Form.php.

00163     {
00164         $this->_addElementTypes($fieldset);
00165         foreach ($attributes as $attribute) {
00166             /* @var $attribute Mage_Eav_Model_Entity_Attribute */
00167             if (!$attribute || !$attribute->getIsVisible()) {
00168                 continue;
00169             }
00170             if ( ($inputType = $attribute->getFrontend()->getInputType())
00171                  && !in_array($attribute->getAttributeCode(), $exclude)
00172                  && ('media_image' != $inputType)
00173                  ) {
00174 
00175                 $fieldType      = $inputType;
00176                 $rendererClass  = $attribute->getFrontend()->getInputRendererClass();
00177                 if (!empty($rendererClass)) {
00178                     $fieldType  = $inputType . '_' . $attribute->getAttributeCode();
00179                     $fieldset->addType($fieldType, $rendererClass);
00180                 }
00181 
00182                 $element = $fieldset->addField($attribute->getAttributeCode(), $fieldType,
00183                     array(
00184                         'name'      => $attribute->getAttributeCode(),
00185                         'label'     => __($attribute->getFrontend()->getLabel()),
00186                         'class'     => $attribute->getFrontend()->getClass(),
00187                         'required'  => $attribute->getIsRequired(),
00188                         'note'      => $attribute->getNote(),
00189                     )
00190                 )
00191                 ->setEntityAttribute($attribute);
00192 
00193                 $element->setAfterElementHtml($this->_getAdditionalElementHtml($element));
00194 
00195                 if ($inputType == 'select' || $inputType == 'multiselect') {
00196                     $element->setValues($attribute->getSource()->getAllOptions(true, true));
00197                 } elseif ($inputType == 'date') {
00198                     $element->setImage($this->getSkinUrl('images/grid-cal.gif'));
00199                     $element->setFormat(Mage::app()->getLocale()->getDateFormat(Mage_Core_Model_Locale::FORMAT_TYPE_SHORT));
00200                 }
00201             }
00202         }
00203     }

getForm ( )

Get form object

Returns:: Varien_Data_Form

Definition at line 78 of file Form.php.

00079     {
00080         return $this->_form;
00081     }

getFormHtml ( )

Get form HTML

Returns:: string

Definition at line 100 of file Form.php.

00101     {
00102         if (is_object($this->getForm())) {
00103             return $this->getForm()->getHtml();
00104         }
00105         return '';
00106     }

getFormObject ( )

Get form object

Deprecated:: deprecated since version 1.2

See also:: getForm()

Returns:: Varien_Data_Form

Definition at line 90 of file Form.php.

00091     {
00092         return $this->getForm();
00093     }

setForm ( Varien_Data_Form $ form )

Set form object

Parameters:

Varien_Data_Form

$form

Returns:: Mage_Adminhtml_Block_Widget_Form

Definition at line 114 of file Form.php.

00115     {
00116         $this->_form = $form;
00117         $this->_form->setParent($this);
00118         $this->_form->setBaseUrl(Mage::getBaseUrl());
00119         return $this;
00120     }

Member Data Documentation

$_form [protected]

Definition at line 42 of file Form.php.

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

app/code/core/Mage/Adminhtml/Block/Widget/Form.php


Public Member Functions
	__construct ()
	getForm ()
	getFormObject ()
	getFormHtml ()
	setForm (Varien_Data_Form $form)
Protected Member Functions
	_prepareLayout ()
	_prepareForm ()
	_beforeToHtml ()
	_initFormValues ()
	_setFieldset ($attributes, $fieldset, $exclude=array())
	_addElementTypes (Varien_Data_Form_Abstract $baseElement)
	_getAdditionalElementTypes ()
	_getAdditionalElementHtml ($element)
Protected Attributes
	$_form