PHPackages oxid-esales/module-generator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. oxid-esales/module-generator AbandonedArchivedLibrary[Utility & Helpers](/categories/utility) oxid-esales/module-generator ============================ Folders structure, empty classes and metadata generation for new OXID eShop modules. v6.x-dev(8y ago)121953[1 PRs](https://github.com/OXID-eSales/module_skeleton_generator/pulls)GPL-3.0-onlyPHPPHP >=5.6 Since Mar 20Pushed 4y ago9 watchersCompare [ Source](https://github.com/OXID-eSales/module_skeleton_generator)[ Packagist](https://packagist.org/packages/oxid-esales/module-generator)[ Docs](https://www.oxid-esales.com/en/home.html)[ RSS](/packages/oxid-esales-module-generator/feed)WikiDiscussions master Synced 4w ago READMEChangelog (1)DependenciesVersions (7)Used By (0) OXID Module Skeleton Generator ============================== [](#oxid-module-skeleton-generator) --- Folders structure, empty classes and metadata generation for new OXID eShop modules. ### Concentrate only on features - let OXID Module Skeleton Generator create all the rest! [](#concentrate-only-on-features---let-oxid-module-skeleton-generator-create-all-the-rest) - **Enter Your copyright data in the module settings** - **Open an easy to use Module Generator Wizard** - **Enter new module name and optional components** - **Press "Generate New Module" and its done - new module is now ready to be activated and filled with features!** OXID Module Skeleton Generator features --------------------------------------- [](#oxid-module-skeleton-generator-features) - Fully configurable vendor/author parameters for new modules creation - Vendor folder and vendor metadata automatic creation - Standard module folders structure creation - Completely filled module medatada file generation - Naming based on vendor data and module name - Created modules follow OXID standards - Automatic creation of pre-filled README file - Generation of PHP files comments with all vendor and module data - Main module class is included in each generated module - It contains activation/deactivation events - Support automatic SQL execution on the events - The class "knows" about its module and provides useful methods - Generation of skeleton files for... - Overloaded (extend) classes - New controllers (also templates are created) - Model classes - List model classes (linked with item model classes) - Widgets (also with templates) - Smarty blocks metadata and templates generation - Module settings metadata and translations generation - Translation files creation - Module version - Automatic checkout of tests folder - And generation of pre-filled tests classes for each new module class - Configurable GIT repository URL to get tests folder from - Learning mode - Creation of hints and to do tasks inside generated files to help proceed with development - Sample source code generation to give a hint what each class could/should contain - Generated module is immediately working - Activate it and events, settings, blocks, controllers, etc. will already be in action! Installation ------------ [](#installation) - Copy the content of `copy_this/` folder to OXID eShop root folder - Activate the module in administration area - Set eShop `modules/` folder writable while generating new modules Usage ----- [](#usage) - Make sure eShop `modules/` folder (and also Your vendor sub-folder, if it exists) is writable - Log in to eShop administration area - (for first run) Go to *Extensions -> Modules -> OXID Module Skeleton Generator -> Settings -> Vendor and Copyright Settings* and enter Your vendor, copyright and author data - Open *Module Generator -> Wizard* (refresh page if it did not appear after module activation) - Enter a name for a new module in "UpperCamelCase" format, e.g. "MyModule" - (optionally) Enter any other options required in a new module (refer to help hints for more info) - Press "Generate New Module" button - The module skeleton source is now available in Your vendor sub-folder - And the module could be activated already in *Extensions -> Modules* To do and nice to have features for future releases --------------------------------------------------- [](#to-do-and-nice-to-have-features-for-future-releases) - Refactor longer classes to move some methods elsewhere - Extend blocks definition validation and blocks templates naming - EDIT mode feature: for existing modules, generate/add extra stuff - Create nice looking generation form with JS/AJAX events to validate and help enter proper values (auto-complete) - Admin interface presets generation, also with menu.xml - Generate picture with PNG text overlay with real module name - PHPStorm style schemes (or some code beautifier) integration - after generation do code formatting - Copy not all folders, but only required ones (Refactor copyDir by providing "copy scenario" array) - dbEvent fail on multi-shops and multi-lang in real life projects - need PHP based DB installation ### Health Score 28 — LowBetter than 52% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity19 Limited adoption so far Community18 Small or concentrated contributor base Maturity48 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 3018d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID) --- Top Contributors [![SvenBrunk](https://avatars.githubusercontent.com/u/4963144?v=4)](https://github.com/SvenBrunk "SvenBrunk (5 commits)")[![MantasVaitkunas](https://avatars.githubusercontent.com/u/623436?v=4)](https://github.com/MantasVaitkunas "MantasVaitkunas (3 commits)")[![druteika](https://avatars.githubusercontent.com/u/3693160?v=4)](https://github.com/druteika "druteika (2 commits)")[![OXID-Admin](https://avatars.githubusercontent.com/u/10544667?v=4)](https://github.com/OXID-Admin "OXID-Admin (1 commits)")[![robertblank](https://avatars.githubusercontent.com/u/7868142?v=4)](https://github.com/robertblank "robertblank (1 commits)")[![Sieg](https://avatars.githubusercontent.com/u/98882?v=4)](https://github.com/Sieg "Sieg (1 commits)") --- Tags oxid-esalesoxid-modulephpgeneratorOXIDmodulesstructureSkeletoneshop ### Embed Badge ![Health badge](/badges/oxid-esales-module-generator/health.svg) ``` [![Health](https://phpackages.com/badges/oxid-esales-module-generator/health.svg)](https://phpackages.com/packages/oxid-esales-module-generator) ``` ### Alternatives [ddoe/wysiwyg-editor-module Summernote WYSIWYG Editor for OXID eShop. 191.0M5](/packages/ddoe-wysiwyg-editor-module)[oxid-esales/gdpr-optin-module This is the GDPR opt-in module for the OXID eShop. 20468.4k3](/packages/oxid-esales-gdpr-optin-module)[oxid-professional-services/countryvatadministration country vat administration 1732.9k](/packages/oxid-professional-services-countryvatadministration)[oxid-esales/geo-blocking-module The module enables OXID eShop to be compliant with the EU geo-blocking regulations. 194.4k](/packages/oxid-esales-geo-blocking-module)[oxid-esales/evat-module This is eVat module for OXID eShop. 193.3k](/packages/oxid-esales-evat-module) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)