Page History

...

This checks for the existence of a PrestaShop constant, and if it does not exist, it stops the module from loading. The sole purpose of this is to prevent alicious malicious visitors to load this file directly.

...

There are many more, such as getInt() or hasContext(), but these four are the ones you will most use.
As you can see, this in a very useful and easy to use object, and you will certainly use in many situations. Most modules use it too for their own settings.

Info

title	Multistore

All of By default, all these methods pertain to the current context. In the default context, these methods apply to the store which is currently being using by the administrator at the time they are called.They have work within the confines of the current store context, whether PrestaShop is using the multistore feature or not.

However, it is possible to work outside of the current context and impact other known stores. This is done using three optional parameters, which are not presented in the list above:

id_lang: enables you to force the language with which you want to work.
id_shop_group: enables you to indicate the shop group of the target store.
id_shop: enables you to indicate the the id of the target store.

By default, these three parameters use the values of the current context, but you can use them to target other stores.It is therefore possible to override these three parameters when dealing with a multistore installation, in order to work outside of the current context.

Note that it is not recommended to change the default values of these variables, even more so if the module you are writing is to be used on other stores than your own. They should only be used if the module is for your own store, and you know

You are not limited to your own variables: PrestaShop stores all its own configuration settings in the ps_configuration table. There are literally hundreds of settings, and you can access them just as easily as you would access your own. For instance:

...

Note that when using updateValue(), the content of $value can be anything, be it a string, a number, a serialized PHP array or a JSON object. As long as you properly code the data handling function, anything goes. For instance, here is how to handle a PHP array array using the Configuration object:

...

The Shop object is a new addition to PrestaShop 1.5, which helps you manage the multistore feature. We will not dive in the specifics here, but will simply present the two method methods that are used in this sample code:

...

Using the Configuration::get() method, we retrieve the value of the currently chosen language ("PS_LANG_DEFAULT"). For security reasons, we cast the variable into an integer using (int).

In preparation for the generation of the form, we must build an array of the various titles, textfields and other form specifics.
To that end, we create the $fields_form variable, which will contain a multidimensional array. Each of the arrays it features contains the detailed description of the tags the form must contain. From this variable, PrestaShop will render the HTML form as it is described.
In this example, we define three tags (<legend>, <input> and <submit>) and their attributes using arrays. The format is quite easy to get: the legend and submit arrays simply contain the attributes to each tag, while the input contains as many <input> tags are needed, each being in turn an array which contains the necessary attributes. For instance:

Code Block
'input' => array( array( 'type' => 'text', 'label' => $this->l('Configuration value'), 'name' => 'MYMODULE_NAME', 'size' => 20, 'required' => true ))

...generates the following HTML tags:

Code Block
<label>Configuration value </label> <div class="margin-form"> <input id="MYMODULE_NAME" class="" type="text" size="20" value="my friend" name="MYMODULE_NAME"> <sup>*</sup> <div class="clear"></div>

As you can see, PrestaShop is quite clever, and generates all the code that is needed to obtain a useful form.
Note that the value os of the main array is actually retrieved later in the form generation code.

We then create an instance of the HelperForm class. This section of the code is explained in the next section of this chapter.
Once the HelperForm settings are all in place, we generate the form based on the content of the $fields_form variable.

...

$helper->module: requires the instance of the module that will use the form.
$helper->name_controller: requires the name of the module.
$helper->token: requires a unique token for the module. getAdminTokenLite() helps us generate one.
$helper->currentIndex:
$helper->default_form_language: requires the default language for the shop.
$helper->allow_employee_form_lang: requires the default language for the shop.
$helper->title: requires the title for the the form.
$helper->show_toolbar: requires a boolean value – whether the toolbar is displayed or not.
$helper->toolbar_scroll: requires a boolean value – whether the toolbar is always visible when scrolling or not.
$helper->submit_action: requires the action attribute for the form's <submit> tag.
$helper->toolbar_btn: requires the buttons that are displayed in the toolbar. In our example, the "Save" button and the "Back" button.
$helper->fields_value[]: this is where we can define the value of the named tag.

...

Info

title	Translating complex code

As we can see, the basis of template file translation is to enclose them in the {l s='The string' mod='name_of_the_module'}. The changes in display.tpl and in mymodule.tpl's link and title texts are thus easy to understand. But added a trickier block of code for the "Hello World!" string: an if/else/then clause, and a text variable. Let's explore this code:

Here is the original code:

Code Block
Hello, {if isset($my_module_name) && $my_module_name} {$my_module_name} {else} World {/if} !

As you can see, we need to get the "Hello World" string translatable, but also to cater for the fact that there is a variable. As explained in the "Translations in PrestaShop 1.5" chapter, variables are to be marked using sprintf() markers, such as %s or %1$s.

Making "Hello %s!" translatable words in easy: we just need to use this code:

Code Block
{l s='Hello %s!' sprintf=$my_module_name mod='mymodule'}

But in our case, we also need to make sure that the %s is replaced by "World" in case the "my_module_name" value does not exist... and we must make "World" translatable too. This can be achieved by using Smarty {capture} function, which collects the output of the template between the tags into a variable instead of displaying, so that we can use it later on. We are going to use it in order to replace the variable with the translated "World" if the variable is empty or absent, using a temporary variable. Here is the final code:

Code Block

{if !isset($my_module_name) || !$my_module_name}
  {capture name='my_module_tempvar'}{l s='World' mod='mymodule'}{/capture}
  {assign var='my_module_name' value=$smarty.capture.my_module_tempvar}
{/if}
{l s='Hello %s!' sprintf=$my_module_name mod='mymodule'}

...

Child pages

Versions Compared

Old Version 33

New Version 34

Key