config.xml Reference

Last modified by houtsnip on Fri, June 25, 2010 10:09
Source|Old Revisions  

This is an old revision of the document!


Path: app/code/(codepool)/(NameSpace)/(ModuleName)/etc/config.xml

Used to configure module. Defines all models, blocks, classes etc. for the specified module.

General structure

  1. <config>
  2.     <modules>
  3.          <(NameSpace_ModuleName)>
  4.              <version>version</version>
  5.              <depends>
  6.                  <(AnotherNameSpace_ModuleName) />
  7.                  <(YetAnotherNameSpace_ModuleName) />
  8.              </depends>
  9.          </(NameSpace_ModuleName>
  10.     </modules>
  11.     <global>
  12.         <models></models>
  13.         <resources></resources>
  14.         <blocks></blocks>
  15.         <(newproduct)><!-- config values --></(newproduct)>
  16.     </global>
  17.     <adminhtml>
  18.         <menu></menu>
  19.         <acl></acl>
  20.         <events></events>
  21.         <translate></translate>
  22.     </adminhtml>
  23.     <frontend>
  24.         <routers></routers>
  25.         <events></events>
  26.         <translate></translate>
  27.         <layout></layout>
  28.     </frontend>
  29.     <default>
  30.         <config_vars><!-- config values --></config_vars>
  31.     </default>
  32. </config>

Specification

Element Description
config Root element

/config/* elements specification

Element Description
modules Used to define basic information about each module such as version number, dependencies on other modules
global
adminhtml
frontend
default

modules

global

Structure

  1.     <global>
  2.         <fieldsets>
  3.             <(fieldset_name)>
  4.                 <(field_name)>?</(field_name)>
  5.             </(fieldset_name)>
  6.         </fieldsets>
  7.         <blocks>
  8.             <(modulename)>
  9.                 <class>(ClassName_Prefix)</class>
  10.             </(modulename)>
  11.         </blocks>
  12.         <models>
  13.             <checkout>
  14.                 <class>Mage_Checkout_Model</class>
  15.                 <resourceModel>checkout_mysql4</resourceModel>
  16.             </checkout>
  17.             <checkout_mysql4>
  18.                 <class>Mage_Checkout_Model_Mysql4</class>
  19.                 <entities>
  20.                     <agreement><table>checkout_agreement</table></agreement>
  21.                     <agreement_store><table>checkout_agreement_store</table></agreement_store>
  22.                 </entities>
  23.             </checkout_mysql4>
  24.         </models>
  25.         <resources>
  26.             <checkout_setup>
  27.                 <setup>
  28.                     <module>Mage_Checkout</module>
  29.                     <class>Mage_Checkout_Model_Mysql4_Setup</class>
  30.                 </setup>
  31.             </checkout_setup>
  32.         </resources>
  33.         <template>
  34.             <email>
  35.                <checkout_payment_failed_template translate="label" module="sales">
  36.                    <label>Payment Failed</label>
  37.                    <file>payment_failed.html</file>
  38.                    <type>html</type>
  39.                </checkout_payment_failed_template>
  40.             </email>
  41.         </template>
  42.     </global>

adminhtml

frontend

Structure

  1.     <frontend>
  2.         <secure_url>
  3.             <(page_handle)>/relative/url</page_handle>
  4.         </secure_url>
  5.         <events>
  6.             <(event_name)>
  7.                 <observers><!-- observers --></observers>
  8.             </(event_name)>
  9.         </events>
  10.         <routers>
  11.             <(modulename)>
  12.                 <use>[standard|admin|default]</use>
  13.                 <args>
  14.                     <module>(NameSpace_ModuleName)</module>
  15.                     <frontName>(frontname)</frontName>
  16.                 </args>
  17.             </(modulename)>
  18.         </routers>
  19.         <translate>
  20.             <modules>
  21.                 <(NameSpace_ModuleName)>
  22.                     <files>
  23.                         <default>(name_of_translation_file.csv)</default>
  24.                     </files>
  25.                 </(NameSpace_ModuleName)>
  26.             </modules>
  27.         </translate>
  28.         <layout>
  29.             <updates>
  30.                 <(modulename)>
  31.                     <file>(name_of_layout_file.xml)</file>
  32.                 </(modulename)>
  33.             </updates>
  34.         </layout>
  35.     </frontend>

default




 

Magento 2 GitHub Repository

Magento Job Board - Some sort of tag line goes here

Latest Posts| View all Jobs