Template for creating simple Entity.
Generate Schema Whitelist:
- bin/magento setup:db-declaration:generate-whitelist --module-name=Tada_TemplateEntity
Test note:
- Require-dev: "mockery/mockery": "^0.9.9"
- Run Unit test: ./vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist app/code/Tada/TemplateEntity/Test/Unit
- Run Integration test:
- cd dev/tests/integration
- ../../../vendor/bin/phpunit ../../../app/code/Tada/TemplateEntity/Test/Integration
Replace Instruction:
- Copy this module folder to another folder at the same vendor with name is <ModuleName>.
- Replacing in files of <ModuleName> folder :
- TemplateEntity to <ModuleName> : replace module name, and namespace
- Tada_TemplateEntity to <Vendor>_<ModuleName> : replace Registration's module name.
- template_entity to <module_name> : replac $_eventPrefix="template_entity" in model class
- tada_template_entity to <vendor>_<module_name> : replace table name
- Rename some files below:
- Api folder:
- Data/TemplateEntityInterface.php to Data/<ModuleName>Interface.php
- TemplateEntityRepositoryInterface.php to <ModuleName>RepositoryInterface.php
- Model folder:
- TemplateEntity.php to <ModuleName>.php
- TemplateEntityRepository.php to <ModuleName>Repository.php
- ResourceModel/TemplateEntity.php to ResourceModel/<ModuleName>.php
- Rename ResourceModel/TemplateEntity folder to ResourceModel/<ModuleName> folder
- Test folder:
- Integration folder:
- rename TemplateEntityRepositoryTest.php to <ModuleName>RepositoryTest.php
- rename TemplateEntityTest.php to <ModuleName>Test.php
- Unit folder:
- rename TemplateEntityRepositoryTest.php to <ModuleName>RepositoryTest.php
- Integration folder:
- Replace name attribute in composer.json:
- tada/template-entity to <vendor>/
- Api folder:
- 1.0.0 Initial version