Theme development fundamentals

Table of contents

/*<![CDATA[*/ div.rbtoc1597308500846 {padding: 0px;} div.rbtoc1597308500846 ul {list-style: disc;margin-left: 0px;} div.rbtoc1597308500846 li {margin-left: 0px;padding-left: 0px;} /*]]>*/

• Theme development fundamentals

  • Concepts

  • PrestaShop's technical architecture

    • Model

    • View

    • Controller

  • Concepts and technical information

    • Best practices

    • How a theme works

    • Theme-specific folders

    • Overview of a theme's folder

Theme development fundamentals

Concepts

PrestaShop's theme system is based on a template engine, called Smarty (http://www.smarty.net/), which allows web-designers and developers to easily build their own theme, with little technical knowledge.

All web-designers and developers should use the following developer browser extensions:

• Firefox: install Firebug (http://getfirebug.com/), a free extension for easy comparison and debugging between your CSS and the output.

• Firefox/Chrome: install the Web Developer (http://chrispederick.com/work/web-developer/), a free extension adds many handy web developer tools to your browser.

• Safari 5+: use the Web Inspector (see http://developer.apple.com/library/safari/#documentation/AppleApplications/Conceptual/Safari_Developer_Guide/2SafariDeveloperTools/SafariDeveloperTools.html).

• Chrome: use the Developer Tools (see https://developers.google.com/chrome-developer-tools/docs/overview).

• Opera 9.5+: use Dragonfly, a fully-featured debugging environment (see http://www.opera.com/dragonfly/).

• Internet Explorer 8+: use the Developer Tools (see http://msdn.microsoft.com/en-us/library/dd565628%28v=vs.85%29.aspx).

• Internet Explorer 6 and 7: install the IE Developer Toolbar (see http://www.microsoft.com/en-us/download/details.aspx?id=18359), or use Firebug Lite (see https://getfirebug.com/firebuglite).

They provide a lot of useful tools, among which DOM explorer, CSS editors, network inspector, etc., and are a huge help when debugging HTML, CSS, JavaScript, and even Ajax requests.

PrestaShop's technical architecture

PrestaShop is based on a 3-tier architecture:

• Data tier (data objects). Database access is controlled through files in the /classes folder.

• Application tier (data control). User-provided content is controlled by files in the root folder.

• Presentation tier (design). All of the theme's files are in the /themes folder.

See Wikpedia for more information: http://en.wikipedia.org/wiki/Multitier_architecture#Three-tier_architecture

This is the same principle as the Model–View–Controller (MVC) architecture, only in a simpler and more accessible way. Learn more about MVC on Wikipedia: http://en.wikipedia.org/wiki/Model-view-controller

Our developer team chose not to use a PHP framework, such as Zend Framework, Symfony or CakePHP, so as to allow for better readability, and thus faster editing.

This also makes for better performances, since the software is only made of the lines of code it requires, and does not contain a bunch of supplemental generic libraries.

A 3-tier architecture has many advantages:

• It is easier to read the software's code.

• Developers can add and edit code faster.

• Graphic designer and HTML integrators can work with the confines of the /themes folder without having to understand or even read a single line of PHP code.

• Developers can work on additional data and modules that the HTML integrators can make use of.

Model

A model represents the application's behavior: data processing, database interaction, etc.

It describes or contains the data that have been processed by the application. It manages this data and guarantees its integrity.

View

A view is the interface with which the user interacts.

Its first role is to display the data that is been provided by the model. Its second role is to handle all the actions from the user (mouse click, element selection, buttons, etc.), and send these events to the controller.

The View does not do any processing; it only displays the result of the processing performed by the model, and interacts with the user.

Controller

The Controller manages synchronization events between the Model and the View, and updates both as needed. It receives all the user events and triggers the actions to perform.

If an action needs data to be changed, the Controller will "ask" the Model to change the data, and in turn the Model will notify the View that the data has been changed, so that the View can update itself.

Concepts and technical information

Best practices

Here is a non-exhaustive list of best practices that you should follow when creating a theme:

1. Do not mix HTML and PHP code; use Smarty tags in order to get a dynamic page.

2. Do not mix HTML and CSS code; put the CSS code in a separate .css file.

3. Always validate your HTML and CSS code using the W3C validators: http://validator.w3.org/ for HTML and XHTML, http://jigsaw.w3.org/css-validator/ for CSS.

4. Do not make SQL queries from a PHP controller (.php file at the root of PrestaShop); use the existing methods from the PrestaShop classes, or create new methods for these classes.

5. Always check if a method you need already exists in the available classes.

6. Do not ever edit PrestaShop's own files; always build your code into modules in order to facilitate updates.

7. Make sure to always produce a clear and readable code, making it easy to maintain that code for anyone in the foreseeable future.

8. Do comment your code, and write both method names and comments in plain English.

9. When editing the theme on a production site, always put the shop in Maintenance Mode first, via the back-office' "Maintenance" preference page.

10. Use modern browsers, such as Firefox, Google Chrome, IE10 or Opera (and make sure your friends and family members do too).

11. Whenever possible, use CSS sprites (read http://www.alistapart.com/articles/sprites and http://www.alistapart.com/articles/sprites2/).

How a theme works

A PrestaShop theme is a set of files which you can edit in order to change the look of your online shop.

Here are a few important tidbits:

• All themes have their files located in the /themes root folder.

• Each theme has its own sub-folder, in the main themes folder.

• Each theme is made of template files (.tpl), image files (.gif, .jpg, .png), one or more CSS files (.css), and sometimes even JavaScript files (.js).

• Each theme has a 180*200 preview.jpg image file in its folder, enabling the shop-owner to see what the theme looks like directly from the back-office, and select the theme appropriately.

Theme-specific folders

As a theme developer, there are mostly 5 PrestaShop folders you must be aware of:

• /modules: this is where all the modules are located. A module has templates files, can also redefine theme parts.

• /themes: this is where all the themes are located. The default 1.5 theme is in the /default folder (in 1.4, it was /prestashop).

• /mails: this is where all the e-mail templates are located. E-mail templates should ideally reflect the style and design of the main theme. Each sub-folder contains language-specific templates

• /img: this is where all the store's images are located. Theme-specific images are stored in the theme's own /img folder.

• /pdf: this is where all the document models are located.

Overview of a theme's folder

Here is an overview of the file structure of a PrestaShop theme (here, the default one):

• The /css folder contains all CSS files.

• The /img folder contains all images.

• The /js folder contains all the JavaScript files.

• The /lang folder contains the theme's translations. Its access rights should be set at CHMOD 666 (for instance), so that the back-office translation tool can read and write into it.

• The root of the folder contains TPL files only (Smarty files), as well as the preview.jpg file.

The /css, /img and /js folder are optional, the theme can perfectly work without them, it's up to you to create them.