Let’s create a module called DEMO. For any module, you need three files
catalog/language/en-gb/extension/module/demo.phpcatalog/controller/extension/module/demo.phpcatalog/view/theme/default/template/extension/module/demo.tplOptionally, you could also have a Model file, if your module needs to pass some new queries to the database that aren’t defined anywhere else.
The language file gets the all the static text. The idea behind keeping it in a separate file is so that it could be easily translated. The same module can work in different languages by using different language files.
1<?php
2// Language
3// path: catalog/language/en-gb/extension/module/demo.php
4
5$_['title'] = 'Demo!';
A Controller needs to do three things in order to work
index() function. this is the default function that runs when you view the module$data 1// Controller
2// path: catalog/controller/extension/module/demo.php
3<?php
4class ControllerProductDemo extends Controller {
5 public function index() {
6 $this->load->language('product/demo');
7
8 $data['title'] = $this->language->get('title');
9
10 $this->response->setOutput($this->load->view('product/demo', $data));
11 }
12}
In your View file, you can reference any value that was passed as part of the $data object
1// View
2// path: catalog/view/theme/default/template/extension/module/demo.tpl
3<h1><?php echo $title; ?></h1>
That’s it. At this point you have created a basic module and accomplished passing data between the Language, Controller and View files.
You can now view your module by going to
site.com/index.php?route=extension/module/demo
The route is based on the folder structure and file name. If you called your module demo and placed it in the catalog/product folder, the route will become product/demo and the URL where you can view the module will become site.com/index.php?route=product/demo.
The files generally have the same name for all files, only the extension is different. Controller and Language files are .php while the View file is .tpl
The Controller class that you’re going to create in your custom module is also going to be named based on the folder structure. The class name for a controller file in catalog/product folder calleddemo.php will become ControllerProductDemo (It follows the ControllerFolderFile pattern..)
The module above, while fully functional, does very little and only has the very basics. If you view the module in the browser, you’ll only see a heading saying Demo!
You can add more stuff to the controller to make it more useful. For example, let’s add our header and footer templates (which are defined in their own Controller files) to our Demo controller. Once they’re available in the controller and added to $data, we’ll be able to use them in the View
1<?php
2class ControllerProductDemo extends Controller {
3 public function index() {
4 // Load our language file
5 $this->load->language('product/demo');
6
7
8 // Get a value from the language file we just loaded, assign it to a 'key' on an object we're going to call 'data'
9 // Through the rest of this controller, we'll keep tagging stuff to this $data we just defined
10 // fyi: it doesn't have to be called 'data', call it whatever you want, calling it data is just common practice
11 // $data['key'] = whatever;
12 $data['title'] = $this->language->get('title');
13
14 // Let's use the 'title' we just defined to set the module page's HTML <title> tag
15 $this->document->setTitle($data['title']);
16
17
18 // Add the Header and Footer Controllers to $data (which we're going to pass to the View)
19 $data['header'] = $this->load->controller('common/header');
20 $data['footer'] = $this->load->controller('common/footer');
21
22 // Set our View template, and pass it the entire $data object
23 // In our View, we'll be able to access stuff from $data with their 'key' names
24 $this->response->setOutput($this->load->view('product/demo', $data));
25 }
26
27}
And in our View, we can now use these header and footer templates
1<?php echo $header; ?>
2<h1><?php echo $title; ?></h1>
3<?php echo $footer; ?>
If you view the module now, you’ll see a page with the site’s header and the site’s footer and the Demo text in the middle where content usually goes.
In the same way, you can also add column_left and column_right if you want to show them on your module page
Throughout our module we’ll be calling different methods that have already been defined in OpenCart to accomplish various things. For example, here are a few methods and what they do.
1$this->response->setOutput($output) // sets the output
2$this->load->view($route, $data = array()) // loads a Template to View
3$this->load->controller($route, $data = array()) // loads a controller
4$this->load->language($route) // loads a Language file
5$this->language->get($key) // gets a value from the language file using it's key name
6$this->document->setTitle($title) // sets the '<title>' for the HTML page
These methods are defined in the files in the system/library and system/engine folders. Figuring out what these methods do is usually pretty straight forward based on their naming. How many guesses do you need to figure out what $this->cart->getProducts() will do? It’ll get the products that are in a customer’s cart, obviously.
You need to
The modules that are added to the Layouts via Admin > Design > Layouts show up in the four pre-defined positions content_top, content_bottom, column_left and column_right.
In order to show any modules added to these positions, you need to add their Controllers to your Modules’s Controller
1<?php
2// CONTROLLER
3
4class ControllerProductDemo extends Controller {
5 public function index() {
6 $this->load->language('product/demo');
7
8 $data['title'] = $this->language->get('title');
9
10 $this->document->setTitle($data['title']);
11
12 $data['header'] = $this->load->controller('common/header');
13 $data['footer'] = $this->load->controller('common/footer');
14
15 // Add the Controllers for the Layout positions
16 $data['column_left'] = $this->load->controller('common/column_left');
17 $data['column_right'] = $this->load->controller('common/column_right');
18 $data['content_top'] = $this->load->controller('common/content_top');
19 $data['content_bottom'] = $this->load->controller('common/content_bottom');
20
21 $this->response->setOutput($this->load->view('product/demo', $data));
22 }
23}
1<!-- VIEW -->
2<?php echo $header; ?>
3
4<div class="container">
5 <h1><?php echo $title; ?></h1>
6
7 <?php echo $column_left; ?>
8 <?php echo $content_top; ?>
9 <?php echo $content_bottom; ?>
10 <?php echo $column_right; ?>
11</div>
12
13<?php echo $footer; ?>
At this point, you can use the module as a Layout page, where you can add any module you want (e.g. Latest, Featured, Bestsellers etc.)