composer require webkul\/code-generator<\/strong><\/code><\/p>\n\n\n\nYou can download it from GitHub https:\/\/github.com\/webkul\/magento2-code-generator<\/a> also. Then run the php bin\/magento setup:upgrade<\/code> and php bin\/magento setup:di:compile<\/code> to successfully install it.<\/p>\n\n\n\n<\/p>AutoMageDev – Snippets and AutoComplete<\/a><\/strong>
Advanced Magento 2 AutoSuggestion extension for Visual Studio Code.<\/cite><\/blockquote><\/figure>\n\n\n\nNow let’s check out how we can use this module to generate codes.<\/p>\n\n\n\n
Note<\/strong>: Now this module also works for interactive cli, you need to pass only the type in the command. Ex: php bin\/magento generate:code --type=new-module<\/code><\/p>\n\n\n\n![\"Screenshot-3\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/Screenshot-3.png\")
<\/figure>\n\n\n\nCreate New Module<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName --type=new-module<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=new-module<\/code><\/p>\n\n\n\n![\"image-131\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-131.png\")
<\/figure>\n\n\n\nIt will create the directory Webkul\/ModuleName under app\/code folder and also create the required files which are registration.php and module.xml.<\/p>\n\n\n\n
Create Models<\/strong><\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=model \n--table="wk_modulename_testdata" \n--name=TestData<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=model
--table=\"table_name\"
--name=ModelName
<\/code>
<\/strong>I have manually created InstallSchema.php<\/em> to create a table named wk_modulename_testdata<\/em>.<\/p>\n\n\n\n![\"image-132\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-132.png\")
<\/figure>\n<\/div>\n\n\nWhen we run the command it will create the model, resource model, collection classes and api data interface for that table. And if you are using db_schema.xml<\/a> file to create the table then it will also generate a getter and setter.<\/p>\n\n\n\nCreate Repository<\/strong><\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=repository \n--name=TestDataRepository \n--model-class="\\Webkul\\ModuleName\\Model\\TestData" \n--collection-class="\\Webkul\\ModuleName\\Model\\ResourceModel\\TestData\\Collection"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=repository
--name=RepositoryClassName
--model-class=ModelClassFullName
--collection-class=CollectionClassFullName<\/code>
<\/p>\n\n\n\n![\"image-133\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-133.png\")
<\/figure>\n<\/div>\n\n\nIt will create the repository class and the interface.<\/p>\n\n\n\n
Create Controller<\/strong><\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=controller \n--name=Index \n--area=frontend \n--path=Test \n--router=test<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=controller
--name=ControllerName
--area=frontend|adminhtml
--path=RelativeToModuleControllerFolder
--router=RouteName<\/code>
<\/p>\n\n\n\n![\"image-134\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-134.png\")
<\/figure>\n<\/div>\n\n\nIt will create the controller class and also create the routes.xml<\/em> if it is not available. If you want to create a controller for the admin end then you must adminhtml in the area parameter. In that case, the path<\/em> parameter will be relative to Controller\/Adminhtml folder as shown below,<\/p>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=controller \n--name=Index \n--area=adminhtml \n--path=Test \n--router=test<\/pre>\n\n\n\n![\"image-135\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-135.png\")
<\/figure>\n<\/div>\n\n\nCreate Helper<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName --type=helper --name=Data<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=helper
--name=HelperName<\/code><\/p>\n\n\n\n![\"image-136\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-136.png\")
<\/figure>\n<\/div>\n\n\nThis command creates the Helper class in the Helper folder.<\/p>\n\n\n\n
Create Plugin<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName\n--type=plugin\n--name=ProductAttributesUpdater\n--plugin="\\Magento\\Catalog\\Model\\Product"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=plugin
--name=PluginName
--plugin=FullClassName
--area=frontend|adminhtml<\/code> (Optional, default area is all<\/em>)<\/strong><\/p>\n\n\n\n![\"image-137\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-137.png\")
<\/figure>\n<\/div>\n\n\nThis will create the Plugin class in the Plugin folder and add the plugin entry in the di.xml<\/em> file. If di.xml is not already available then it will create a new di.xml file. <\/p>\n\n\n\nThe area<\/em> parameter is optional, if it is not provided then it will create di.xml directly under the etc folder and if provided then it will create the di.xml under the given area folder which will be under the etc folder.<\/p>\n\n\n\nCreate Observer<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=observer \n--name=SalesOrderPlaceAfterObserver \n--event=checkout_submit_all_after<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=observer
--name=ObserverName
--event=event_name
--area=frontend|adminhtml<\/code> (Optional, default area is all<\/em>)<\/strong><\/p>\n\n\n\n![\"image-145\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-145.png\")
<\/figure>\n<\/div>\n\n\nThe observer command will create the Observer class in the Observer folder and create events.xml if events.xml is not already created. Otherwise it will add the entry in the existing events.xml file. <\/p>\n\n\n\n
The area parameter is optional, if it is not provided then it will create events.xml directly under the etc folder and if provided then it will create the events.xml under the given area folder which will be under the etc folder.<\/p>\n\n\n\n
Create Cron<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName\n--type=cron\n--name=SendStatement\n--schedule="0 1 * * *"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=cron
--name=CronName
--schedule=\"0 1 * * *\"<\/code> (Optional, default schedule is “0 1 * * *”)<\/em><\/strong>
<\/p>\n\n\n\n![\"image-146\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-146.png\")
<\/figure>\n<\/div>\n\n\nIt will create the Cron class in the Cron folder and will create the crontab.xml<\/em> file if does not exist else it will just add the entry.<\/p>\n\n\n\nCreate Custom Logger<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=logger \n--name="customlogfile"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=logger
--name=loggerfilename<\/code> (Optional, default name is vendorname_modulename.log)<\/em><\/strong><\/p>\n\n\n\n![\"image-144\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-144.png\")
<\/figure>\n<\/div>\n\n\nWhen we run the command it will create the required files for a custom logger<\/a>. Then you can use the logger class which is \\Webkul\\ModuleName\\Logger\\Logger<\/em> in our case to log data in your custom logger file. Note-<\/em><\/strong> No need to add .log extension in the –name<\/em> param.<\/p>\n\n\n\nCreate Command<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=command \n--name=PrintHello \n--command='test:hello'<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=command
--name=CommandClass
--command='test:hello'<\/code><\/p>\n\n\n\n![\"image-143\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-143.png\")
<\/figure>\n<\/div>\n\n\nIt will create the command class in Console\/Command<\/em> folder. So when we run php bin\/magento test:hello<\/em> (in our case) it will run the execute method of the command class.<\/p>\n\n\n\nCreate Override of classes like Block, Model, Controller, etc<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName \n--type=rewrite \n--name=ProductView \n--rewrite="Magento\\Catalog\\Controller\\Product\\View" \n--path="Rewrite\/Controller"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=rewrite
--name=ClassName
--rewrite='OverriddenClass'
--path=RelativeToModuleFolder<\/code> (Optional, if not provided it will create the class in Rewrite folder)<\/em><\/strong>
<\/p>\n\n\n\n![\"image-142\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-142.png\")
<\/figure>\n<\/div>\n\n\nIt will create a class with the name as in –name<\/em> param and it will be created in a folder that has been provided in –path<\/em> param. <\/p>\n\n\n\nIf no –path<\/em> param is provided then it will be created in the Rewrite folder by default. The class which has to be overridden must be provided in –rewrite<\/em> param. The preference entry will be added in the di.xml file.<\/p>\n\n\n\nCreate View<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName\n--type=create-view\n--name=test_test_index\n--area=frontend\n--block-class=MainData\n--template=test.phtml\n--layout-type=2columns-left\n\n<strong>Available Params:<\/strong>\n<code>--type=create-view\n--name=route_controller_action\n--area=frontend|adminhtml\n--block-class=Main<\/code> <strong><em>(Optional, default value is Main)<\/em><\/strong><code>\n--template=content.phtml<\/code><strong><em>(Optional, default value is content.phtml)<\/em><\/strong><code>\n--layout-type=empty|1column|2columns-left|2columns-right|3columns|admin-empty|admin-1column|admin-2columns-left<\/code> <strong><em>(Optional) <\/em><\/strong><\/pre>\n\n\n\n![\"image-141\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-141.png\")
<\/figure>\n<\/div>\n\n\nThis command will create the block class, layout file and the template file under respective directories. You can generate view for both frontend and backend with this command.<\/p>\n\n\n\n
Create Email Template<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_ModuleName\n--type=email\n--name="Email Label"\n--id="modulename_email_test"\n--template="test"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=email
--name=\"Label\"
--id=\"modulename_email_label\"<\/code> (Optional, default value is modulename_email_label)<\/em><\/strong>
--template=\"label\"<\/code> (Optional, default value is label.phtml)<\/em><\/strong><\/p>\n\n\n\n![\"image-140\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-140.png\")
<\/figure>\n<\/div>\n\n\nThis will create the template file in view\/frontend\/email<\/em> folder and add the entry for the email in email_templates.xml file which will be created automatically if not exist. You can check more about emails on blog<\/a>.<\/p>\n\n\n\nCreate Payment Method<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_CustomPay\n--type=payment\n--payment-code=CustomPayPOD\n--name="Custom Pay POD"<\/pre>\n\n\n\nAvailable Params:<\/strong>
--type=payment
--payment-code=PaymentCode<\/code>
--name=\"Payment Name\"<\/code> (Optional, default value is “Custom Payment”)<\/em><\/strong><\/p>\n\n\n\n![\"image-139\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-139.png\")
<\/figure>\n<\/div>\n\n\nThe payment creates command will create the necessary files for creating a payment method. It will add an entry in system.xml<\/em> to show it in the Payment Methods section.<\/p>\n\n\n\nAlso, the files required to show and modify the payment method on the checkout page will be created. You just need to edit the model class.<\/p>\n\n\n\n
Create Shipping Method<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_CustomShip\n--type=shipping\n--shipping-code=custom_shipping\n--name="Custom Shipping"<\/pre>\n\n\n\nAvailable Params:
<\/strong>--type=shipping
--shipping-code=shipping_code<\/code>
--name=\"Custom Shipping\"<\/code> (Optional, default value is “Custom Shipping”)<\/em><\/strong><\/p>\n\n\n\n![\"image-138\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/image-138.png\")
<\/figure>\n<\/div>\n\n\nIt will add an entry in system.xml <\/em>to show it in the Shipping Methods section. Also, the Carrier Class will be created where you can modify the collectRates<\/em> method.<\/p>\n\n\n\nCreate Unit Test<\/h4>\n\n\n\nphp bin\/magento generate:code Module_Name --type=unit-test<\/pre>\n\n\n\nAvailable Params:<\/strong>
–type=unit-test
This will generate the Unit Test Classes under the Test\/Unit<\/em> folder. To check out more about the Unit Test please follow our blog Unit Test Implementation in Magento 2 custom module<\/a>.<\/p>\n\n\n\nCreate Ui Component Listing<\/h4>\n\n\n\nphp bin\/magento generate:code Webkul_TestModule\n--type=ui_component_listing\n--name=test_test\n--columns_name=test_column\n--model_class_name=TestData\n--table=test_table<\/pre>\n\n\n\nAvailable Params:<\/strong><\/h4>\n\n\n\n--type=ui_component_listing\n--name=Ui Grid Listing File Name\n--columns_name=Listing Columns Name\n--model_class_name=Model Class Name for getCollection\n--table=Table Name for Get Column<\/pre>\n\n\n\nIt will add an entry in the di.xml <\/em> file and create the listing file in the view\/adminhtml\/ui_component<\/em> folder.<\/p>\n\n\n\nCreate Ui Component Form<\/h4>\n\n\n\nphp bin\/magento generate:code Module_Name\n--type=ui_component_form \n-name="test_test_form"\n--provider_name="Data Provider Name"\n--model_class_name="Model Class Name"\n--fieldset_name="Field Set Name"\n--fieldset_label="Field Set Label"\n--submit_url="Form Submit Url"\n--form_field="Form Fields in Json Format"<\/pre>\n\n\n\nAvailable Params:<\/strong><\/h4>\n\n\n\n--type=ui_component_form\n--name=Ui Form File Name\n--provider_name=Data Provider Class Name\n--model_class_name=Model Class Name for getCollection\n--fieldset_name=Field Set Name for Field\n--fieldset_label=Field Set Label\n--submit_url=Form submit url (test\/test\/save)\n--form_field=[{"field_name": "test_input_field", "field_type": "input", "field_label": "Test Input Field", "is_required": "true"}]<\/pre>\n\n\n\nNote<\/strong>: The form will accept the (input, select, multiselect, imageUploader<\/strong>) field types.<\/p>\n\n\n\nIt will create the save and back button for the form and also add a DataProvider for the form data in Ui\/DataProvider<\/em> folder after that it will create a UI component form in the view\/adminhtml\/ui_component<\/em> folder<\/p>\n\n\n\nFor technical assistance, please contact us via email at support@webkul.com.<\/a> Additionally, explore a variety of solutions to improve your online store by visiting the Adobe Commerce extensions<\/a> page.<\/p>\n\n\n\nFor professional advice or to develop customized features, consider hiring Adobe Commerce Developers<\/a> for your project.<\/p>\n\n\n\nThanks for reading the blog.<\/p>\n","protected":false},"excerpt":{"rendered":"