How to create/duplicate a module?

[Qphoria]

This guide applies to all versions of OpenCart 1.x (eg 1.3.x, 1.4.x, 1.5.x, etc)

It is very rare that this will be needed. Even when you think you have to duplicate a module like "flat rate", it is actually best done using one of the zone based options like weight-based or zone plus.

But in any case, for those that are hell bent on duplicating existing sideboxes, payment, or shipping modules. This hi-level breakdown should get you going.

1. CHOOSE THE FILES
First think of which module you new module is most similar too. In this example, we will make a clone of the "Cash on Delivery" payment module and name it "Cash on Pickup".

There are generally 6-8 files that need to be cloned for each module, and they follow a similar structure:
1. admin/controller/payment/cod.php
2. admin/language/english/payment/cod.php
3. admin/view/template/payment/cod.tpl
4. catalog/controller/payment/cod.php
5. catalog/language/english/payment/cod.php
6. catalog/model/payment/cod.php
7. catalog/view/theme/default/template/payment/cod.tpl


2. CLONE & EDIT THE FILES
Use your favorite FTP client (like ftp wanderer)
1. Goto the path for each file above
2. download the cod.* file to your local pc (e.g. c:\cop)
3. rename it to "cop" (be sure to note the extension as either .php or .tpl)
4. Use a good (free) text editor like notepad++ to edit the file.
5a. In the notepad++ menu, Goto "Search->Replace..."
- Find what: cod
- Replace with: cop
Click "REPLACE ALL"
5b. For language files, be sure to change wording as appropriate. Example "Cash on Delivery" should be changed to "Cash on Pickup".
5c. For modules that use underscores (i.e. pp_standard) You must ensure that the class name at the top of the controller & model files does NOT have this _ after doing the replace all.
Correct: class ControllerPaymentPPStandard extends
Incorrect: class ControllerPaymentPP_Standard extends
6. Save the file.
7. Now reupload the new file to the same directory path. Now you should have a cod and cop file next to it.
8. Delete the local file in c:\cop
9. Repeat for each file, one by one.

3. INSTALL THE NEW FILES
Now that we have the new files uploaded, they should likely be seen by the OpenCart payment module system.
1. In the OpenCart Admin section, goto Extension->Payment
2. If everything is right so far, you should see the new "Cash on Pickup" module waiting to be installed
3. Click Install
4. Click Edit. If there are no errors then configure it appropriately. If there are errors, you likely missed a step in the edit. Note what file the error is in and check that file, tracing back your edit steps above
5. Save the configuration
6. Goto the customer checkout process and verify there are no errors. You should see a new Cash on Pickup payment option.

Done.

[Donce]

very usefull, thanks..

[yegga]

Be sure to match case when replacing the old names with your new names.

For example: imaginetech's Your Box module uses a combination of camel-case (e.g: YourBox) and lower-case (e.g yourbox).

Suppose you wanted to change the module to be called 'My Box', you'd replace these names as 'MyBox' and 'mybox' respectively.

If using a wysiwyg text editor check the 'Match Case' option while replacing.

[moggiex]

We really need a karma button on this forum

Brill breakdown!

Matt

[jimmy_zjw]

it's awesome. Thanks very much

[dingsword]

very usefull

[madimar]

Hi all, is there a way to duplicate "categories" module/box in homepage? I explain better my need: I have two main products categories (really different and not related), i.e. "Car accessories" and "Mobile phone".
I would like to show Car products and Mobile phone products in two separate boxes in OC home page.

many thanks in advance,

Max

[Qphoria]

Yes. The same concept applies from the first post.
1. admin/controller/module/category.php
2. admin/language/english/module/category.php
3. admin/view/template/module/category.tpl
4. catalog/controller/module/category.php
5. catalog/language/english/module/category.php
6. catalog/view/theme/default/template/module/category.tpl

[madimar]

hmmm, then, how to associate some categories to first Categories box and others to second categories box?

[Qphoria]

I have this available for v1.3.4 already if you like here:
http://www.unbannable.com/ocstore/cat_box_clone

It allows you to choose which category box to assign the category to from the admin section when creating the category.

[madimar]

Interesting! It is exactly what I'm looking for. Does it work also with 1.3.2?
Anyway I will do an exercise trying to develop it by myself... or I'll let you know soon!
Thank you very much for usual support.
Max

[shadoblix]

I have followed the instructions for creating a duplicate module..... I have it installed works fine.... the one question I have is.....
the new module is "cash on pick up"
When a customer proceeds to check out they are given the payment options where they can choose cash on pickup BUT when they choose cash on pickup they are still being charged the shipping fee (which isn't necessary as they are picking up the item themselves). Is there a way to avoid the shipping charge from being applied when they choose to pay cash at time of pickup?

Thanks anyone for any help and or suggestions.

DJ

[Qphoria]

Unfortunately the horse and the carriage don't line up well here. The Cash on Pickup was just an example, but it would only work if you didn't charge shipping. Technically the COD and COP should be shipping modules. Or clone the free ship and rename it to "Pickup" then set the COP to only show IF the pickup shipping is chosen.

[des2006]

Hi Qphoria,

Thanks for the instruction. I want to duplicate a sidebox using Information module, to add in news and sub modules. Would you please advise which files I need to duplicate. Thanks in advance!

Desmond

[Qphoria]

using the info from this post:
viewtopic.php?f=22&t=6696&view=unread&sid=3f0b2b9568062f0e719452cfe9dd518e#p43198

I'll let you figure out the rest

[des2006]

Thanks Qphoria,

In fact I have done the above to duplicate information files to another ones which I called Event files. In the files, I changed all the words with information to event. In the Mysql I duplicate ocinformation and ocinformation_description to ocevent and ocevent_description. Uploaded and tested in the Admin, could install and enable the Event module.

However, the ocevent and ocevent_description had no data written in. The Catalog column (in the Admin page) did not show the Event module. Going to the Online shop just showed a blank page. Until Idisabled the Event module, the online shop resumed to normal.

Would you please advise where the problem is. Many thanks!
Desmond

using the info from this post:
viewtopic.php?f=22&t=6696&view=unread&sid=3f0b2b9568062f0e719452cfe9dd518e#p43198

I'll let you figure out the rest

[Qphoria]

Ah ok.. so you are 90% there.
The last step is the database (model) stuff. Since information has its own model file

Clone the
admin/model/catalog/information.php
file to event.php as well. That is your missing link

[Miguelito]

I've been trying to create a new shipping method based on weight based shipping. In Admin section everything is working just fine but in the Store checkout gives php errors. I've done this new shipping method as here have been instructed (5 files copied and renamed and find->replaced). What can cause these fatal errors? Is there a simple 'How-to create a new shipping method in Opencart for Dummies' ?

[Miguelito]

Could someone please give simple instructions how to create a new shipping method based on weight based shipping? I'm having gray hair with fatal errors...

[Miguelito]

I've seen a lot of new shipping methods in the contributions section so I think someone would have a clue...?