{"id":2440,"date":"2024-07-04T11:13:27","date_gmt":"2024-07-04T11:13:27","guid":{"rendered":"https:\/\/www.rcvtechnologies.com\/blog\/?p=2440"},"modified":"2024-09-13T12:09:32","modified_gmt":"2024-09-13T12:09:32","slug":"how-to-create-a-module-in-opencart-4","status":"publish","type":"post","link":"https:\/\/www.rcvtechnologies.com\/blog\/how-to-create-a-module-in-opencart-4\/","title":{"rendered":"How to create a module in Opencart 4"},"content":{"rendered":"

Module in Opencart 4<\/b><\/h2>\n

We have our folder structure<\/a> in place. Let\u2019s start creating an extension.<\/span><\/p>\n

First we have to crate language file.<\/p>\n

Language<\/b><\/h3>\n

admin\/language\/en-gb\/module\/itmindslab_module.php<\/strong><\/p>\n

In this file, we assign the language of the indexes of an array. The array\u2019s name is $_, the language that will be necessary for creating the module.<\/span><\/p>\n

\n\t\t\t
\n
\n
\n
<\/div>\n
<\/div>\n
<\/div>\n <\/div>\n
\n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n 
<\/p>\n
<?php\r\n\r\n$_['heading_title']     = 'Itmindslab Module';\r\n$_['entry_status']      = 'Status';\r\n\r\n$_['text_extension']    = 'Extension';\r\n$_['text_edit']         = 'Edit Module';\r\n$_['text_success']\t\t= 'Success: You have modified module!';\r\n\r\n$_['help_status']\t\t= 'Enable or disable the module';\r\n\r\n$_['error_permission']\t= 'Warning: You do not have permission to modify this module!';<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
Controller<\/b><\/h3>\n
After creating the language, we will head towards the controller. So, we will create a file named itmindslab_module.php in admin->controller->module folder.<\/span><\/p>\n
admin\/controller\/module\/itmindslab_module.php<\/strong><\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
<?php\r\n\r\nnamespace Opencart\\Admin\\Controller\\Extension\\Itmindslabmodule\\Module;\r\n\r\nclass Itmindslabmodule extends \\Opencart\\System\\Engine\\Controller{\r\n    public function index(){\r\n        $this->load->language('extension\/itmindslab_module\/module\/itmindslab_module');\r\n\r\n        $this->document->setTitle($this->language->get('heading_title'));\r\n\r\n        $data['breadcrumbs'] = [];\r\n\r\n        $data['breadcrumbs'][] =[\r\n            'text' => $this->language->get('text_home'),\r\n            'href' => $this->url->link('common\/dashbord', 'user_token=' .$this->session->data['user_token'])\r\n        ];\r\n\r\n        $data['breadcrumbs'][] = [\r\n            'text' =>$this->language->get('text_extension'),\r\n            'href' => $this->url->link('marketplace\/extension', 'user_token=' .$this->session->data['user_token'] . '&type=module')\r\n        ];\r\n\r\n        $data['breadcrumbs'][] = [\r\n            'text' => $this->language->get('heading_title'),\r\n            'href' => $this->url->link('extension\/itmindslab_module\/module\/itmindslab_module', 'user_token=' .$this->session->data['user_token'])\r\n        ];\r\n\r\n        $data['save'] = $this->url->link('extension\/itmindslab_module\/module\/itmindslab_module.save', 'user_token=' . $this->session->data['user_token']);\r\n\r\n        $data['back'] = $this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=module');\r\n\r\n        $data['module_itmindslab_module_status'] = $this->config->get('module_itmindslab_module_status');\r\n\r\n        $data['header'] = $this->load->controller('common\/header');\r\n        $data['column_left'] = $this->load->controller('common\/column_left');\r\n        $data['footer'] = $this->load->view('common\/footer');\r\n\r\n        $this->response->setOutput($this->load->view('extension\/itmindslab_module\/module\/itmindslab_module', $data));\r\n    }\r\n\r\n    public function save(){\r\n        $this->load->language('extension\/itmindslab_module\/module\/itmindslab_module');\r\n\r\n        $json = [];\r\n\r\n        if(!$this->user->hasPermission('modify','extension\/itmindslab_module\/module\/itmindslab_module')){\r\n            $json['error'] = $this->language->get('error_permission');\r\n        }\r\n\r\n        if(!$json){\r\n            $this->load->model('setting\/setting');\r\n            $this->model_setting_setting->editSetting('module_itmindslab_module', $this->request->post);\r\n            $json['success'] = $this->language->get('text_success');\r\n        }\r\n        $this->response->addHEader('content-Type: application\/json');\r\n        $this->response->setOutput(json_encode($json));\r\n    }\r\n}<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
View<\/b><\/h3>\n
After the controller, we have to go for the view file. So, we will create a file named itmindslab_module.twig in admin->view->template->module folder.<\/span><\/p>\n
admin\/view\/template\/module\/itmindslab_module.twig<\/strong><\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
{{ header }}{{ column_left }}\r\n<div id=\"content\">\r\n    <div class=\"page-header\">\r\n        <div class=\"container-fluid\">\r\n            <div class=\"float-end\">\r\n                <button type=\"submit\" form=\"form-module\" data-bs-toggle=\"tooltip\" title=\"{{ button_save }}\" class=\"btn btn-primary\"><i class=\"fa-solid fa-save\"><\/i><\/button>\r\n                <a href=\"{{ back }}\" data-bs-toggle=\"tooltip\" title=\"{{ button_back }}\" class=\"btn btn-light\"><i class=\"fa-solid fa-reply\"><\/i><\/a><\/div>\r\n                <h1>{{ heading_title }}<\/h1>\r\n                <ol class=\"breadcrumb\">\r\n                    {% for breadcrumb in breadcrumbs %}\r\n\t\t\t            <li class=\"breadcrumb-item\">\r\n                            <a href=\"{{ breadcrumb.href }}\">{{ breadcrumb.text }}<\/a>\r\n                        <\/li>\r\n\t\t            {% endfor %}\r\n                <\/ol>\r\n            <\/div>\r\n        <\/div>\r\n    <div class=\"container-fluid\">\r\n        <div class=\"card\">\r\n            <div class=\"card-header\"><i class=\"fa-solid fa-pencil\"><\/i> {{ text_edit }}\r\n            <\/div>\r\n            <div class=\"card-body\">\r\n                <form id=\"form-module\" action=\"{{ save }}\" method=\"post\" data-oc-toggle=\"ajax\">\r\n                    <div class=\"row mb-3\">\r\n                        <label class=\"col-sm-2 col-form-label\">{{ entry_status }}<\/label>\r\n                        <div class=\"col-sm-10\">\r\n                            <div class=\"form-check form-switch form-switch-lg\">\r\n                                <input type=\"hidden\" name=\"module_itmindslab_module_status\" value=\"0\"\/>\r\n                                <input type=\"checkbox\" name=\"module_itmindslab_module_status\" value=\"1\" id=\"input-status\" class=\"form-check-input\"{% if module_itmindslab_module_status %} checked{% endif %}\/>\r\n                            <\/div>\r\n                        <\/div>\r\n                    <\/div>\r\n                <\/form>\r\n            <\/div>\r\n        <\/div>\r\n    <\/div>\r\n<\/div>\r\n{{ footer }}<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
Once you have created the extension, you will need to include some information within the module\u2019s \u201cinstall.json\u201d<\/strong> file. This file supports the following keys: name, code, version, author, and link.<\/span><\/p>\n
Inastall.json<\/strong> file will create inside the module folder.<\/span><\/p>\n
Install.json<\/b><\/h3>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
{\r\n    \"name\": \"Itmindslab Module\",\r\n    \"code\": \"itmindslab_module\",\r\n    \"version\": \"1.0\",\r\n    \"author\": \"itmindslab\",\r\n    \"link\":\"https:\/\/www.itmindslab.com\/\"\r\n}<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
Once install.json is inside the directory, you can zip it and name it that ends with .ocmod.zip, then upload it from the Opencart extension installer.<\/span><\/p>\n
Steps to Install and Configure The Module<\/h3>\n
Upload & Install Zip<\/strong><\/h4>\n
Go to Opencart’s Admin panel -> Extension -> Installer.<\/p>\n
\"\"<\/p>\n
Configure<\/strong><\/h3>\n
1:- Admin panel -> Extensions -> Extensions -> Modules.<\/p>\n
\"\"<\/p>\n
<\/h2>\n
2:- Install and edit the module.<\/p>\n
\"\"<\/p>\n
<\/h2>\n
3:- Enable the status of the module.<\/p>\n
\"\"<\/p>\n
So, here we complete the module installation and configuration part.<\/span><\/p>\n
Now Allow Permissions<\/strong><\/h3>\n
1:- Admin panel -> System -> Users -> User Groups.<\/p>\n
Select user group for allow permissions<\/p>\n
\"\"<\/p>\n
 <\/p>\n
2:- Select check box to allow permissions and save.<\/p>\n
\"\"<\/p>\n
This is all about admin side module Code, its installation, configuration and permissions. I hope you learn something from this blog.<\/span><\/p>\n
Keep following our blog, to know more about Opencart Version 4<\/strong><\/a>.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
Module in Opencart 4 We have our folder structure in place. Let\u2019s start creating an extension. First we have to crate language file. Language admin\/language\/en-gb\/module\/itmindslab_module.php In this file, we assign the language of the indexes of an array. The array\u2019s name is $_, the language that will be necessary for creating the module. Controller After […]<\/p>\n","protected":false},"author":3,"featured_media":3491,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_uf_show_specific_survey":0,"_uf_disable_surveys":false,"footnotes":""},"categories":[136],"tags":[138,140,139],"class_list":["post-2440","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-opencart","tag-opencart-4","tag-php","tag-software-development"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/2440","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/comments?post=2440"}],"version-history":[{"count":43,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/2440\/revisions"}],"predecessor-version":[{"id":3583,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/2440\/revisions\/3583"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/media\/3491"}],"wp:attachment":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/media?parent=2440"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/categories?post=2440"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/tags?post=2440"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}