CubeCartForums.org Documentation Area

CubeCartForums.org for CubeCart third-party documentation, modifications, skins and services
Permanent Link   Print This Page
Introduction CubeCart v3 CubeCart v4 CubeCart v5 Appendix Search

CubeCart Version 4 Documentation - Module Installer

Google Translate:

Module Installer

What is it?

A great feature of version 4 is the ability to easily upload and install modules. These will be either updates or additional modules released by Devellion on CubeCart.com, or third-party modules from this site.



Modules for affiliate, gateway, language and shipping can be installed or updated using this method.


Installing or updating a Module

Click on browse and select the ZIP file containing the update. Then click on upload, and the following dialog (or something similar) will appear indicating it has been uploaded.



There may be additional requirements to installing the module, for example removing a previous version first. If there are this will be included in instructions available with the download.


Module ZIP file structure

Advanced Users Only

The file structure of the files within the module are as follows:

Module Files Details
/Module_Name/ (change as applicable)
admin/
             index.inc.php
             logo.gif
This file is displayed in the Admin control panel.
classes/ (Optional) Contain PHP classes which are unique to the module.
language/ (Optional)
             default.lang.php
             [isocode].lang.php (Optional)
Translations for the module, which is based on the current store default language. The language default to the values in default.lang.php if a localisation is not available.
(module files) Additional module files.
package.conf.inc Contains a serialized array of information relating to the module. More information is available below.



package.conf.inc

The serialised array in the following format:

type
name
version
description
=> affiliate / gateway / language / shipping
=> (string) e.g. My Module
=> e.g 1.0, 1.1, 2.0beta
=> (string)

An example is the Canadian Post module...
a:4:{s:4:"type";s:8:"shipping";s:4:"name";s:11:"Canada Post";s:7:"version";s:3:"1.0";s:11:"description";s:58:"Shipping module for accessing the Canada Post pricing API.";}




Comments, Feedback, Suggestions and Documentation Submissions please post in the Documentation Chat Forum.