Home - UltimateModuleCreator/umc-crud GitHub Wiki
Umc_Crud magento module
Purpose
This module is intended for Magento 2 developers, in order to reduce the boilerplate code when creating a CRUD extension.
What it does
By itself, this module does nothing. It's just a collection of classes that can be used in your own custom CRUD modules to avoid writing the same code over and over again and seeing the static tests (which I assume you run constantly) complain about code duplication.
Compatibility
This module was developed an tested on Magento Open Source 2.3.4. I plan to support this for later versions also. It may work for versions before 2.3.4, but I didn't test.
Target audience
This module is intended for experienced Magento 2 developers. It IS NOT suited for junior developers.
In order to be able to properly use this you need to know the following:
- how a CRUD module works in general
- How DI works in magento 2
- What a virtual type is.
- Code generation
Example of use
- How to use composite classes
An example on how to use can be found here: https://github.com/UltimateModuleCreator/umc-crud-sample.
The example above contains 2 custom entities called very creatively "Something" and "SomethingElse". The entity "SomethingElse" contains 2 fields name
and is_active
. The entity "Something" contains all types of fields (selects, texts, textareas with and without wysiwyg editor, file uploads, dynamic rows).
This documentation will explain how the Umc_Crud module works and how you can create your module using this.