Class Mage_Adminhtml_Block_System_Config_Form

Description
Description | Vars (details) | Methods (details) Constants (details)

System config form block

Located in /Adminhtml/Block/System/Config/Form.php (line 35) 

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Adminhtml_Block_Template
            |
            --Mage_Adminhtml_Block_Widget
               |
               --Mage_Adminhtml_Block_Widget_Form
                  |
                  --Mage_Adminhtml_Block_System_Config_Form
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
SCOPE_DEFAULT = 'default'
SCOPE_STORES = 'stores'
SCOPE_WEBSITES = 'websites'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
array $_configData
Mage_Adminhtml_Model_Config_Data $_configDataObject
Mage_Adminhtml_Model_Config $_configFields
Varien_Simplexml_Element $_configRoot
Mage_Adminhtml_Block_System_Config_Form_Field $_defaultFieldRenderer
Mage_Adminhtml_Block_System_Config_Form_Fieldset $_defaultFieldsetRenderer
array $_fieldsets
array $_scopeLabels
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Mage_Adminhtml_Block_System_Config_Form __construct ()
boolean canUseDefaultValue (Varien_Simplexml_Element $field)
boolean canUseWebsiteValue (Varien_Simplexml_Element $field)
Varien_Simplexml_Element getConfigRoot ()
string getScope ()
string getScopeCode ()
int|string getScopeId ()
string getScopeLabel (Mage_Core_Model_Config_Element $element)
string getSectionCode ()
string getStoreCode ()
string getWebsiteCode ()
Mage_Adminhtml_Block_System_Config_Form initFields (Varien_Data_Form_Element_Fieldset $fieldset, Varien_Simplexml_Element $group, Varien_Simplexml_Element $section, [string $fieldPrefix = ''], [string $labelPrefix = ''])
Mage_Adminhtml_Block_System_Config_Form initForm ()
void _afterToHtml ( $html)
bool _canShowField (Varien_Simplexml_Element $field)
array _getAdditionalElementTypes ()
Mage_Adminhtml_Block_Widget_Form_Element_Dependence _getDependence ()
Mage_Adminhtml_Block_System_Config_Form _initObjects ()
string _prepareFieldComment (Mage_Core_Model_Config_Element $element, string $helper,  $currentValue)
void _prepareFieldOriginalData (Varien_Data_Form_Element_Abstract $field, Varien_Simplexml_Element $xmlElement)
string _prepareFieldTooltip (Mage_Core_Model_Config_Element $element, string $helper)
boolean _sortForm (Varien_Simplexml_Element $a, Varien_Simplexml_Element $b)
Variables
Description | Vars (details) Constants (details) | Methods (details)
array $_configData (line 47)

Config data array

  • access: protected
Mage_Adminhtml_Model_Config_Data $_configDataObject (line 54)

Adminhtml config data instance

  • access: protected
Mage_Adminhtml_Model_Config $_configFields (line 68)

Enter description here...

  • access: protected
Varien_Simplexml_Element $_configRoot (line 61)

Enter description here...

  • access: protected
Mage_Adminhtml_Block_System_Config_Form_Field $_defaultFieldRenderer (line 82)

Enter description here...

  • access: protected
Mage_Adminhtml_Block_System_Config_Form_Fieldset $_defaultFieldsetRenderer (line 75)

Enter description here...

  • access: protected
array $_fieldsets = array() (line 89)

Enter description here...

  • access: protected
array $_scopeLabels = array() (line 96)

Translated scope labels

  • access: protected

Inherited Variables

Inherited from Mage_Adminhtml_Block_Widget_Form

Mage_Adminhtml_Block_Widget_Form::$_form

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
 Mage_Core_Block_Template::$_jsUrl
 Mage_Core_Block_Template::$_showTemplateHints
 Mage_Core_Block_Template::$_showTemplateHintsBlocks
 Mage_Core_Block_Template::$_template
 Mage_Core_Block_Template::$_viewDir
 Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
 Mage_Core_Block_Abstract::$_anonSuffix
 Mage_Core_Block_Abstract::$_childGroups
 Mage_Core_Block_Abstract::$_children
 Mage_Core_Block_Abstract::$_childrenHtmlCache
 Mage_Core_Block_Abstract::$_frameCloseTag
 Mage_Core_Block_Abstract::$_frameOpenTag
 Mage_Core_Block_Abstract::$_isAnonymous
 Mage_Core_Block_Abstract::$_layout
 Mage_Core_Block_Abstract::$_messagesBlock
 Mage_Core_Block_Abstract::$_nameInLayout
 Mage_Core_Block_Abstract::$_parent
 Mage_Core_Block_Abstract::$_parentBlock
 Mage_Core_Block_Abstract::$_request
 Mage_Core_Block_Abstract::$_sortedChildren
 Mage_Core_Block_Abstract::$_urlModel
Methods
Description | Vars (details) Constants (details) Methods (details)
Constructor __construct (line 102)

Enter description here...

  • access: public
Mage_Adminhtml_Block_System_Config_Form __construct ()
canUseDefaultValue (line 514)

Enter description here...

  • access: public
boolean canUseDefaultValue (Varien_Simplexml_Element $field)
  • Varien_Simplexml_Element $field
canUseWebsiteValue (line 531)

Enter description here...

  • access: public
boolean canUseWebsiteValue (Varien_Simplexml_Element $field)
  • Varien_Simplexml_Element $field
getConfigRoot (line 413)

Return config root node for current scope

  • access: public
Varien_Simplexml_Element getConfigRoot ()
getScope (line 571)

Retrieve current scope

  • access: public
string getScope ()
getScopeCode (line 609)

Get current scope code

  • access: public
string getScopeCode ()
getScopeId (line 631)

Get current scope code

  • access: public
int|string getScopeId ()
getScopeLabel (line 594)

Retrieve label for scope

  • access: public
string getScopeLabel (Mage_Core_Model_Config_Element $element)
getSectionCode (line 673)

Enter description here...

  • TODO: delete this methods when {^see above^} is done
  • access: public
string getSectionCode ()
getStoreCode (line 695)

Enter description here...

  • TODO: delete this methods when {^see above^} is done
  • access: public
string getStoreCode ()
getWebsiteCode (line 684)

Enter description here...

  • TODO: delete this methods when {^see above^} is done
  • access: public
string getWebsiteCode ()
initFields (line 242)

Init fieldset fields

  • access: public
Mage_Adminhtml_Block_System_Config_Form initFields (Varien_Data_Form_Element_Fieldset $fieldset, Varien_Simplexml_Element $group, Varien_Simplexml_Element $section, [string $fieldPrefix = ''], [string $labelPrefix = ''])
  • Varien_Data_Form_Element_Fieldset $fieldset
  • Varien_Simplexml_Element $group
  • Varien_Simplexml_Element $section
  • string $fieldPrefix
  • string $labelPrefix
initForm (line 140)

Enter description here...

  • access: public
Mage_Adminhtml_Block_System_Config_Form initForm ()
_afterToHtml (line 486)

Append dependence block at then end of form block

  • access: protected
void _afterToHtml ( $html)
  • $html
Redefinition of:
Mage_Core_Block_Abstract::_afterToHtml()
Processing block html after rendering
_canShowField (line 545)

Checking field visibility

  • access: protected
bool _canShowField (Varien_Simplexml_Element $field)
  • Varien_Simplexml_Element $field
_getAdditionalElementTypes (line 652)

Enter description here...

  • access: protected
array _getAdditionalElementTypes ()
Redefinition of:
Mage_Adminhtml_Block_Widget_Form::_getAdditionalElementTypes()
Retrieve predefined additional element types
_getDependence (line 223)

Return dependency block object

  • access: protected
Mage_Adminhtml_Block_Widget_Form_Element_Dependence _getDependence ()
_initObjects (line 117)

Enter description here...

  • access: protected
Mage_Adminhtml_Block_System_Config_Form _initObjects ()
_prepareFieldComment (line 445)

Support models "getCommentText" method for field note generation

  • access: protected
string _prepareFieldComment (Mage_Core_Model_Config_Element $element, string $helper,  $currentValue)
_prepareFieldOriginalData (line 427)

Set "original_data" array to the element, composed from nodes with scalar values

  • access: protected
void _prepareFieldOriginalData (Varien_Data_Form_Element_Abstract $field, Varien_Simplexml_Element $xmlElement)
  • Varien_Data_Form_Element_Abstract $field
  • Varien_Simplexml_Element $xmlElement
_prepareFieldTooltip (line 471)

Prepare additional comment for field like tooltip

  • access: protected
string _prepareFieldTooltip (Mage_Core_Model_Config_Element $element, string $helper)
_sortForm (line 502)

Enter description here...

  • access: protected
boolean _sortForm (Varien_Simplexml_Element $a, Varien_Simplexml_Element $b)
  • Varien_Simplexml_Element $a
  • Varien_Simplexml_Element $b

Inherited Methods

Inherited From Mage_Adminhtml_Block_Widget_Form

Mage_Adminhtml_Block_Widget_Form::getForm()
Mage_Adminhtml_Block_Widget_Form::getFormHtml()
Mage_Adminhtml_Block_Widget_Form::getFormObject()
Mage_Adminhtml_Block_Widget_Form::setForm()
Mage_Adminhtml_Block_Widget_Form::_addElementTypes()
Mage_Adminhtml_Block_Widget_Form::_beforeToHtml()
Mage_Adminhtml_Block_Widget_Form::_construct()
Mage_Adminhtml_Block_Widget_Form::_getAdditionalElementHtml()
Mage_Adminhtml_Block_Widget_Form::_getAdditionalElementTypes()
Mage_Adminhtml_Block_Widget_Form::_initFormValues()
Mage_Adminhtml_Block_Widget_Form::_prepareForm()
Mage_Adminhtml_Block_Widget_Form::_prepareLayout()
Mage_Adminhtml_Block_Widget_Form::_setFieldset()

Inherited From Mage_Adminhtml_Block_Widget

Mage_Adminhtml_Block_Widget::getButtonHtml()
Mage_Adminhtml_Block_Widget::getCurrentUrl()
Mage_Adminhtml_Block_Widget::getGlobalIcon()
Mage_Adminhtml_Block_Widget::getHtmlId()
Mage_Adminhtml_Block_Widget::getId()
Mage_Adminhtml_Block_Widget::_addBreadcrumb()

Inherited From Mage_Adminhtml_Block_Template

Mage_Adminhtml_Block_Template::getFormKey()
Mage_Adminhtml_Block_Template::isOutputEnabled()
Mage_Adminhtml_Block_Template::_getUrlModelClass()
Mage_Adminhtml_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::addToChildGroup()
Mage_Core_Block_Abstract::addToParentGroup()
Mage_Core_Block_Abstract::append()
Mage_Core_Block_Abstract::countChildren()
Mage_Core_Block_Abstract::escapeHtml()
Mage_Core_Block_Abstract::escapeUrl()
Mage_Core_Block_Abstract::formatDate()
Mage_Core_Block_Abstract::formatTime()
Mage_Core_Block_Abstract::getAction()
Mage_Core_Block_Abstract::getAnonSuffix()
Mage_Core_Block_Abstract::getBlockAlias()
Mage_Core_Block_Abstract::getBlockHtml()
Mage_Core_Block_Abstract::getCacheKey()
Mage_Core_Block_Abstract::getCacheKeyInfo()
Mage_Core_Block_Abstract::getCacheLifetime()
Mage_Core_Block_Abstract::getCacheTags()
Mage_Core_Block_Abstract::getChild()
Mage_Core_Block_Abstract::getChildChildHtml()
Mage_Core_Block_Abstract::getChildData()
Mage_Core_Block_Abstract::getChildGroup()
Mage_Core_Block_Abstract::getChildHtml()
Mage_Core_Block_Abstract::getHelper()
Mage_Core_Block_Abstract::getIsAnonymous()
Mage_Core_Block_Abstract::getLayout()
Mage_Core_Block_Abstract::getMessagesBlock()
Mage_Core_Block_Abstract::getModuleName()
Mage_Core_Block_Abstract::getNameInLayout()
Mage_Core_Block_Abstract::getParentBlock()
Mage_Core_Block_Abstract::getRequest()
Mage_Core_Block_Abstract::getSkinUrl()
Mage_Core_Block_Abstract::getSortedChildBlocks()
Mage_Core_Block_Abstract::getSortedChildren()
Mage_Core_Block_Abstract::getUrl()
Mage_Core_Block_Abstract::getUrlBase64()
Mage_Core_Block_Abstract::getUrlEncoded()
Mage_Core_Block_Abstract::helper()
Mage_Core_Block_Abstract::htmlEscape()
Mage_Core_Block_Abstract::insert()
Mage_Core_Block_Abstract::jsQuoteEscape()
Mage_Core_Block_Abstract::setAnonSuffix()
Mage_Core_Block_Abstract::setAttribute()
Mage_Core_Block_Abstract::setBlockAlias()
Mage_Core_Block_Abstract::setChild()
Mage_Core_Block_Abstract::setFrameTags()
Mage_Core_Block_Abstract::setIsAnonymous()
Mage_Core_Block_Abstract::setLayout()
Mage_Core_Block_Abstract::setMessagesBlock()
Mage_Core_Block_Abstract::setNameInLayout()
Mage_Core_Block_Abstract::setParentBlock()
Mage_Core_Block_Abstract::stripTags()
Mage_Core_Block_Abstract::toHtml()
Mage_Core_Block_Abstract::unsetCallChild()
Mage_Core_Block_Abstract::unsetChild()
Mage_Core_Block_Abstract::unsetChildren()
Mage_Core_Block_Abstract::urlEscape()
Mage_Core_Block_Abstract::_afterCacheUrl()
Mage_Core_Block_Abstract::_afterToHtml()
Mage_Core_Block_Abstract::_beforeCacheUrl()
Mage_Core_Block_Abstract::_beforeChildToHtml()
Mage_Core_Block_Abstract::_beforeToHtml()
Mage_Core_Block_Abstract::_construct()
Mage_Core_Block_Abstract::_getChildHtml()
Mage_Core_Block_Abstract::_getUrlModel()
Mage_Core_Block_Abstract::_getUrlModelClass()
Mage_Core_Block_Abstract::_loadCache()
Mage_Core_Block_Abstract::_prepareLayout()
Mage_Core_Block_Abstract::_saveCache()
Mage_Core_Block_Abstract::_toHtml()
Mage_Core_Block_Abstract::__()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
SCOPE_DEFAULT = 'default' (line 38)
SCOPE_STORES = 'stores' (line 40)
SCOPE_WEBSITES = 'websites' (line 39)

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Documentation generated on Fri, 11 Feb 2011 17:03:40 +0200 by phpDocumentor 1.4.3