1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Adminhtml
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Admin form widget
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_Adminhtml
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Adminhtml_Block_Widget_Form extends Mage_Adminhtml_Block_Widget
 35: {
 36: 
 37:     /**
 38:      * Form Object
 39:      *
 40:      * @var Varien_Data_Form
 41:      */
 42:     protected $_form;
 43: 
 44:     /**
 45:      * Class constructor
 46:      *
 47:      */
 48:     protected function _construct()
 49:     {
 50:         parent::_construct();
 51:         $this->setTemplate('widget/form.phtml');
 52:         $this->setDestElementId('edit_form');
 53:         $this->setShowGlobalIcon(false);
 54:     }
 55: 
 56:     /**
 57:      * Preparing global layout
 58:      *
 59:      * You can redefine this method in child classes for changin layout
 60:      *
 61:      * @return Mage_Core_Block_Abstract
 62:      */
 63:     protected function _prepareLayout()
 64:     {
 65:         Varien_Data_Form::setElementRenderer(
 66:             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_element')
 67:         );
 68:         Varien_Data_Form::setFieldsetRenderer(
 69:             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_fieldset')
 70:         );
 71:         Varien_Data_Form::setFieldsetElementRenderer(
 72:             $this->getLayout()->createBlock('adminhtml/widget_form_renderer_fieldset_element')
 73:         );
 74: 
 75:         return parent::_prepareLayout();
 76:     }
 77: 
 78:     /**
 79:      * Get form object
 80:      *
 81:      * @return Varien_Data_Form
 82:      */
 83:     public function getForm()
 84:     {
 85:         return $this->_form;
 86:     }
 87: 
 88:     /**
 89:      * Get form object
 90:      *
 91:      * @deprecated deprecated since version 1.2
 92:      * @see getForm()
 93:      * @return Varien_Data_Form
 94:      */
 95:     public function getFormObject()
 96:     {
 97:         return $this->getForm();
 98:     }
 99: 
100:     /**
101:      * Get form HTML
102:      *
103:      * @return string
104:      */
105:     public function getFormHtml()
106:     {
107:         if (is_object($this->getForm())) {
108:             return $this->getForm()->getHtml();
109:         }
110:         return '';
111:     }
112: 
113:     /**
114:      * Set form object
115:      *
116:      * @param Varien_Data_Form $form
117:      * @return Mage_Adminhtml_Block_Widget_Form
118:      */
119:     public function setForm(Varien_Data_Form $form)
120:     {
121:         $this->_form = $form;
122:         $this->_form->setParent($this);
123:         $this->_form->setBaseUrl(Mage::getBaseUrl());
124:         return $this;
125:     }
126: 
127:     /**
128:      * Prepare form before rendering HTML
129:      *
130:      * @return Mage_Adminhtml_Block_Widget_Form
131:      */
132:     protected function _prepareForm()
133:     {
134:         return $this;
135:     }
136: 
137:     /**
138:      * This method is called before rendering HTML
139:      *
140:      * @return Mage_Adminhtml_Block_Widget_Form
141:      */
142:     protected function _beforeToHtml()
143:     {
144:         $this->_prepareForm();
145:         $this->_initFormValues();
146:         return parent::_beforeToHtml();
147:     }
148: 
149:     /**
150:      * Initialize form fields values
151:      * Method will be called after prepareForm and can be used for field values initialization
152:      *
153:      * @return Mage_Adminhtml_Block_Widget_Form
154:      */
155:     protected function _initFormValues()
156:     {
157:         return $this;
158:     }
159: 
160:     /**
161:      * Set Fieldset to Form
162:      *
163:      * @param array $attributes attributes that are to be added
164:      * @param Varien_Data_Form_Element_Fieldset $fieldset
165:      * @param array $exclude attributes that should be skipped
166:      */
167:     protected function _setFieldset($attributes, $fieldset, $exclude=array())
168:     {
169:         $this->_addElementTypes($fieldset);
170:         foreach ($attributes as $attribute) {
171:             /* @var $attribute Mage_Eav_Model_Entity_Attribute */
172:             if (!$attribute || ($attribute->hasIsVisible() && !$attribute->getIsVisible())) {
173:                 continue;
174:             }
175:             if ( ($inputType = $attribute->getFrontend()->getInputType())
176:                  && !in_array($attribute->getAttributeCode(), $exclude)
177:                  && ('media_image' != $inputType)
178:                  ) {
179: 
180:                 $fieldType      = $inputType;
181:                 $rendererClass  = $attribute->getFrontend()->getInputRendererClass();
182:                 if (!empty($rendererClass)) {
183:                     $fieldType  = $inputType . '_' . $attribute->getAttributeCode();
184:                     $fieldset->addType($fieldType, $rendererClass);
185:                 }
186: 
187:                 $element = $fieldset->addField($attribute->getAttributeCode(), $fieldType,
188:                     array(
189:                         'name'      => $attribute->getAttributeCode(),
190:                         'label'     => $attribute->getFrontend()->getLabel(),
191:                         'class'     => $attribute->getFrontend()->getClass(),
192:                         'required'  => $attribute->getIsRequired(),
193:                         'note'      => $attribute->getNote(),
194:                     )
195:                 )
196:                 ->setEntityAttribute($attribute);
197: 
198:                 $element->setAfterElementHtml($this->_getAdditionalElementHtml($element));
199: 
200:                 if ($inputType == 'select') {
201:                     $element->setValues($attribute->getSource()->getAllOptions(true, true));
202:                 } else if ($inputType == 'multiselect') {
203:                     $element->setValues($attribute->getSource()->getAllOptions(false, true));
204:                     $element->setCanBeEmpty(true);
205:                 } else if ($inputType == 'date') {
206:                     $element->setImage($this->getSkinUrl('images/grid-cal.gif'));
207:                     $element->setFormat(Mage::app()->getLocale()->getDateFormatWithLongYear());
208:                 } else if ($inputType == 'multiline') {
209:                     $element->setLineCount($attribute->getMultilineCount());
210:                 }
211:             }
212:         }
213:     }
214: 
215:     /**
216:      * Add new element type
217:      *
218:      * @param Varien_Data_Form_Abstract $baseElement
219:      */
220:     protected function _addElementTypes(Varien_Data_Form_Abstract $baseElement)
221:     {
222:         $types = $this->_getAdditionalElementTypes();
223:         foreach ($types as $code => $className) {
224:             $baseElement->addType($code, $className);
225:         }
226:     }
227: 
228:     /**
229:      * Retrieve predefined additional element types
230:      *
231:      * @return array
232:      */
233:     protected function _getAdditionalElementTypes()
234:     {
235:         return array();
236:     }
237: 
238:     /**
239:      * Enter description here...
240:      *
241:      * @param Varien_Data_Form_Element_Abstract $element
242:      * @return string
243:      */
244:     protected function _getAdditionalElementHtml($element)
245:     {
246:         return '';
247:     }
248: 
249: }
250: