 |
VOOZH | about |
|
VOOZH | about |
This document provides a technical guide for developing custom modules in Maho. It covers module structure, declaration, configuration, and the implementation of core components (models, blocks, controllers, helpers). For information about extending existing functionality through event observers, see Event Observers and Hooks For creating custom CLI commands, see Custom CLI Commands
Maho modules follow a standardized directory structure that organizes code by functional component. Each module is self-contained and can be enabled/disabled independently.
Sources: app/code/core/Mage/Core/Model/Config.php15-71 app/code/core/Mage/Core/Model/App/Area.php15-23
Every module must be declared in an XML file located in app/etc/modules/. This file controls module loading order and enables/disables the module.
Create app/etc/modules/Namespace_ModuleName.xml:
| Element | Description |
|---|---|
<active> | true or false - enables/disables the module |
<codePool> | core, community, or local - determines directory location |
<depends> | Lists module dependencies - controls load order |
Maho loads modules in a specific sequence to resolve dependencies. Core modules have predefined order indices maintained in Mage_Core_Model_Config app/code/core/Mage/Core/Model/Config.php15-71 The configuration system merges these XML files into a global configuration object during initialization app/code/core/Mage/Core/Model/Config.php272-279
Sources: app/code/core/Mage/Core/Model/Config.php15-71 app/code/core/Mage/Core/Model/Config.php272-279
The config.xml file is the heart of every module, defining its structure, components, and integration points. Create this file at app/code/local/Namespace/ModuleName/etc/config.xml.
Maho configuration is organized into sections that control where components are available. These are managed by the Mage_Core_Model_App_Area class app/code/core/Mage/Core/Model/App/Area.php15-23
| Scope | Purpose | Common Uses |
|---|---|---|
<global> | Available everywhere | Models, blocks, helpers, resource models |
<frontend> | Frontend area only | Frontend routers, layout updates, translations |
<adminhtml> | Admin area only | Admin routers, menu items, ACL rules |
The following diagram bridges the XML configuration to the actual PHP class instantiation logic handled by the system.
Sources: app/code/core/Mage/Core/Model/Config.php112-116 app/code/core/Mage/Tag/Model/Tag.php38-74
Models contain business logic, while resource models handle database operations.
Models usually inherit from Mage_Core_Model_Abstract app/code/core/Mage/Tag/Model/Tag.php38 or Maho\DataObject app/code/core/Mage/Core/Model/Locale.php13
Maho supports multiple database engines including MySQL, PostgreSQL, and SQLite lib/MahoCLI/Commands/DBQuery.php50-54 Resource models define the mapping between entities and tables. The system uses Mage_Core_Model_Config to retrieve connection details for these engines lib/MahoCLI/Commands/DBQuery.php45
Sources: app/code/core/Mage/Tag/Model/Tag.php38 app/code/core/Mage/Tag/Model/Tag.php71-74 lib/MahoCLI/Commands/DBQuery.php45-54
Maho uses factory methods defined in Mage to instantiate models, utilizing a class name cache for performance app/code/core/Mage/Core/Model/Config.php112-116
Sources: app/Mage.php459-474 app/code/core/Mage/Core/Model/Config.php112-116
Blocks prepare data for templates and are referenced by aliases in layout XML. The Mage_Core_Model_Layout class manages the block registry and instantiation app/code/core/Mage/Core/Model/Layout.php23-27
Sources: app/code/core/Mage/Core/Model/Layout.php211-224 app/code/core/Mage/Core/Model/Layout.php62
Helpers provide utility functions and are often used for translations.
Sources: app/Mage.php539-553
Controllers handle HTTP requests. They typically reside in the controllers/ directory of a module.
Routers are configured in config.xml. The Mage_Core_Model_App_Area handles the initialization of different areas (frontend vs adminhtml) which dictates which routers are active app/code/core/Mage/Core/Model/App/Area.php15-18
Sources: app/code/core/Mage/Core/Model/App/Area.php15-18 app/code/core/Mage/Core/Model/App/Area.php91-114
System configuration is defined in system.xml and allows settings to be managed in the Admin Panel.
Configuration values are retrieved using paths like general/locale/code app/code/core/Mage/Core/Model/Locale.php53
Sources: app/code/core/Mage/Core/Model/Locale.php107 app/Mage.php277-280
In Maho, observers are registered using PHP 8.3 attributes directly on the observer class methods. This replaces the traditional XML-based registration in config.xml.
This pattern is used extensively in core for inventory management, gift messages, and activity logging app/code/core/Mage/CatalogInventory/Model/Observer.php44-45 app/code/core/Mage/GiftMessage/Model/Observer.php20-21 app/code/core/Maho/AdminActivityLog/Model/Observer.php48-49
Sources: app/code/core/Mage/CatalogInventory/Model/Observer.php44-45 app/code/core/Mage/GiftMessage/Model/Observer.php20-21 app/code/core/Maho/AdminActivityLog/Model/Observer.php48-49 app/code/core/Mage/Tag/Model/Tag.php194-195
Maho uses CSV files for translations. Modules initialize their translations through the area model during the request lifecycle app/code/core/Mage/Core/Model/App/Area.php131-135
Sources: app/code/core/Mage/Core/Model/App/Area.php131-135
| Component | Factory Method | Base Class | Purpose |
|---|---|---|---|
| Model | Mage::getModel() | Mage_Core_Model_Abstract | Business logic |
| Resource Model | Mage::getResourceModel() | Mage_Core_Model_Resource_Db_Abstract | Database operations |
| Block | Mage::app()->getLayout()->createBlock() | Mage_Core_Block_Abstract | View logic |
| Helper | Mage::helper() | Mage_Core_Helper_Abstract | Utilities |
Sources: app/Mage.php459-553 app/code/core/Mage/Core/Model/Layout.php211-224
Refresh this wiki