Watch the screencast

Text Version

I will use PrestaShop 1.6 for the demo but the modification works in thirty bees as well. Bear in mind it DOES NOT work in PrestaShop 1.7.

Open up controllers/front/AuthController.php

Look for the following code, around line 455. If it’s not in those whereabouts, just make sure you change every instance

$customer->active = 1;

set to 0, so that the user cannot perform any action right away.

Now we also want to give the user some feedback, so let’s redirect him to a custom page. Scroll down a few lines, and where you see all these redirects:

if (($back = Tools::getValue('back')) && $back == Tools::secureReferrer($back)) {
                            Tools::redirect(html_entity_decode($back));
                        }

And add a new one before

  Tools::redirect($this->context->link->getPageLink('welcome'));

Of course this page does not exist yet but we will create it in a moment.

Before that though, we have to take care of a little issue. Since the user has been created but set to inactive, the system treats it as banned by default. Even if we are to redirect to a page, we would instantly be kicked out of the session and redirected to the login. We want to create an exception so that the welcome page can be displayed.

Let’s go ahead and open up the customer class, so classes/customer.php
Look for the following method:

public static function isBanned($id_customer)

And at the very beginning, add:

        if(Context::getContext()->controller->php_self == 'welcome')
            return false;

That’s settled! Now for our welcome page, I will create a new controller and a template file in the theme folder

Let’s head to controllers/front, and create a new PHP file first, named WelcomeController.php:

class WelcomeControllerCore extends FrontController
{
    public $php_self = 'welcome';


    public function initContent()
    {
        parent::initContent();
        $this->setTemplate(_PS_THEME_DIR_.'welcome.tpl');
    }
}

Then in the theme folder, create a new file named welcome.tpl, adding the following code inside

{capture name="path"} {l s='Welcome'}{/capture}
<h1>{l s='Welcome to'} {$shop_name}! </h1>
<hr>
<p>
	{l s='Your account is currently under review, you will receive an email as soon as it is validated'}
</p>

So let’s go ahead and try it out now… but before let’s clear cache by erasing cache/class_index.php, since we added a new controller and the system wouldn’t read it otherwise.

The next step is to send out and email when a status is changed to active for the customer, in the back office.
Open controllers/admin/admincustomerscontroller.php

We will add a new method, which is inherited from the admincontroller class:

    public function processStatus()
    {
        if($object = parent::processStatus()) {
            if(get_class($object) == 'Customer' && $object->active) // the customer has been activated, send out an email
            {
                Mail::Send($object->id_lang, 'account_activated', $this->l('Your account has been activated'),
                    ['name' => $object->firstname .' '. $object->lastname],
                $object->email,
                $object->firstname .' '. $object->lastname,
                Configuration::get('PS_SHOP_EMAIL'),
                Configuration::get('PS_SHOP_NAME'));
            }
        }

       return $object;
    }

Of course, there is no such email template so we have to create it. I suggest copying an existing one, like the order confirmation, and adding new text, just to be quicker. The code is different for every template, just bear in mind to add the {name} variable inside it, so that the customer name is displayed!

This is it for part 1, make sure you test the email as well since sometimes they do fail for odd reasons, if you don’t see it coming, triple check the template names and make sure they are located in the proper path for each language you use.

In part two we will see how to prevent orders in case a customer is not registered, which is fundamental not to break the system if you have a one page checkout, as right now it would display an error.

The post Private Orders Shop in PrestaShop and thirty bees part 1: manual customer verification appeared first on NemoPS.

Introduction

You might have come across the need to translate the price per unit field in your PrestaShop or Thirtybees, but crashed against the software’s limitation, as that’s a single language property. Any product field can be made multi-language with a simple modification, so let’s see how to do it using the Unity one as example in this tutorial!

Step 1 – Adding the new database column

In order to make the field translatable, we have to add it to the product_lang table in the database. Not only, but we also have to erase the same column in both the product and product_shop tables, to avoid conflicts when retrieving values from the database. Let’s add it first!

Using phpMyAdmin or Adminer, locate the *prefix*product_lang table in your database, and add a new column as VARCHAR, 24 characters long. Once done, it will look like this:

Next, let’s get rid of the leftovers: open the *prefix*product table and drop the unity column first, and then on the product_shop table.
We are done! We just broke the Product class though, and have to compensate by letting it know where to grab the new values from.

Step 2 – Editing the product class

We have a new column in the database, but at this point the Product class would still just ignore it. To have it lookup, and save into the correct table, we must tell it that the property we are wanting to translate is a multilanguage field. To do so, we must change its definition.

Open up Product.php, located in the classes/ folder.

Scroll down until you find the following line, part of the $definition property:

'unity'                     => ['type' => self::TYPE_STRING, 'shop' => true, 'validate' => 'isString'],

To make any field translatable, we can simply add ‘lang’ => true as follows

'unity'                     => ['type' => self::TYPE_STRING, 'shop' => true, 'validate' => 'isString', 'lang' => true],

Please notice that, as always, using an override is strongly recommended, instead of editing core files.

Step 3 – Editing the back office

The controller

This is the most complicated part, as we will have to edit both the admin controller for products, and the correct template. For our example, the template is prices.tpl, but it will be different if the field you want to translate is in another tab.

Let’s start with the controller. The prices template does not offer us any option for translating fields, and therefore misses the indispensable $languages variable.
Open up AdminProductsController, located in controllers/admin

We are interested in the method called initFormPrices, so once you find it you can simply clone that to an override, or continue editing the core.

Right after $data is assigned, at the very beginning of the function, but before $product = $obj, add the following

if (!$this->default_form_language) {
    $this->getLanguages();
}
$data->assign(array(
    'languages'=> $this->_languages,
    'id_lang' => $this->context->language->id,
    'default_form_language' => $this->default_form_language,
));

Explanation: Nothing too complex here, we are first checking if languages are loaded, and if not, assigning them to the controller. Then, we simply assign that class property to the template, along with a few other required ones. Please notice we do not use a common smarty assign, but the $data variable instead.

The template

Time to make our changes visible in the back office! For the unity field, let’s open up *admin folder*/themes/default/template/controllers/products/prices.tpl

Locate the input with id unity, which will look more or less like the following:

<input id="unity" name="unity" type="text" value="{$product->unity|htmlentitiesUTF8}"  maxlength="255" onkeyup="if (isArrowKey(event)) return ;unitySecond();" onchange="unitySecond();"/>

Instead of this input, we will use a handy template PrestaShop makes available to us. Replace the above with the following code:

{include file="controllers/products/input_text_lang.tpl"
languages=$languages
input_class="{$class_input_ajax}{if !$product->id || Configuration::get('PS_FORCE_FRIENDLY_PRODUCT')}copy2friendlyUrl{/if} updateCurrentText"
input_value=$product->unity
input_name="unity"}

Save and refresh, and you will see the new field, translatable, appearing in the prices table of the back office. Time to test it, and see if it’s saving properly.
We can take an extra step and translate the preview below as well:

<span id="unity_second">{$product->unity}</span>

to

<span id="unity_second">{$product->unity.{$id_lang}}</span>

At this point we can go ahead and test the Front Office. If everything has been done correctly, as soon as you change language, the class should automatically pick the correct translation for the field. Neat!

The post Make product fields multi-language in PrestaShop and ThirtyBees appeared first on NemoPS.

Two cases

In this tutorial, we will see how we can restrict the usage of vouchers for different categories in PrestaShop. There are two ways we can do this, depending on our needs. The first consist of simply restricting the rule to some categories, and apply discounts in the cart to products belonging to them, only.
However, if you really want to exclude the usage of specific vouchers on certain products, there is a more complex procedure to use, which involves coding.

The easy way

If you are happy with having the rule be available on all products, but only affect the ones you want, from a specific category, then the easy way will be enough.
We are assuming you already know How to use Discounts in PrestaShop, so let’s proceed from the Cart Rule configuration page:

Give the rule some generic conditions and a code (so we can test it); then, under restrictions, tick Product selection.
In the “Add a rule concerning” select box, choose categories, then hit add. A new box will appear below, where you can choose the category you want to restrict this voucher to

Then, in the action tab, if you select a discount percentage, you must make sure to check the “selected Products” box, under “Apply a discount to”. This will make sure other products are not affected by the price reduction.
This, however, limits us in the case we want to use another rule (cheapest product?) or free shipping on specific categories only. Therefore, if you have more specific needs, read on.

The advanced way

If you are not happy with the above solution, then you might want to code some extra checks in the CartRule class, to make the rule invalid if your cart contains extra products.
Open up CartRule.php, located in the classes folder, or create an override for it.
Locate the checkValidity method, then the following snippet:

...
  // gonna slow the thing down a bit

        /* This loop checks:
            - if the voucher is already in the cart
            - if a non compatible voucher is in the cart
            - if there are products in the cart (gifts excluded)
            Important note: this MUST be the last check, because if the tested cart rule has priority over a non combinable one in the cart, we will switch them
        */
        $nb_products = Cart::getNbProducts($context->cart->id);
        $otherCartRules = array();
        if ($check_carrier) {
            $otherCartRules = $context->cart->getCartRules();
        }

        ...

Right before it, we need to get products, in case the variable is not set yet, and check for our conditions

        if(!isset($products))
            $products = $context->cart->getProducts();

        if($products)
        {
            // first, let's get our current cart rule ID
            if($this->id == 1) // not thought for extensive usage
            {
                // having them hardcoded here, can be expanded
                $valid_categories = array(7); // Blouses category
            }
            
        }

This part is not thought for an extensive usage, so if you want to use more than a couple of special price rules, you might need to find another way. We are hardcoding the cart rule id, so that this condition is only applied when we are adding it. This will also make sure this rule is removed from the cart, in case other invalid products are added afterwards.
Let’s now check if all products are at least belonging to the Blouses category

        if(!isset($products))
            $products = $context->cart->getProducts();

        if($products)
        {
            // first, let's get our current cart rule ID
            if($this->id == 1) // not thought for extensive usage
            {
                // having them hardcoded here, can be expanded
                $valid_categories = array(7); // Blouses category
                foreach ($products as $prod) {
                    $prod_categories = Product::getProductCategories($prod['id_product']);
                    foreach ($valid_categories as $val_cat) {
                        if(!in_array($val_cat, $prod_categories)) // if the blouse category is not among product categories
                           return (!$display_error) ? false : Tools::displayError('One or more products in your cart are not compatible with this discount'); // we deny the voucher's usage
                    }
                }    
            }
            
        }

If the product is not in any of the valid categories (in this case, just Blouses), then we cannot add the rule. Save and refresh, then clear cache if you used an override.
You can now try adding the rule to the cart. First, with a valid product only. Then remove the rule, add an invalid product, and add the rule back again. You should see a message popping up:

If not, the condition is not triggering, and you have to go back and print a debug of the rule/categories.
If you see the error, you can erase the invalid product, add the voucher again (it should be valid this time), then add the product once more. The rule should be automatically removed from your cart, since it becomes invalid. Unfortunately, there is no way to trigger an error message when this happens.

The post Restrict Cart Rules to specific categories in PrestaShop appeared first on NemoPS.

Starting with a simple module

First, download the project file, and place the module you will find inside the “start” folder in the modules/ folder of your prestashop installation.

Open up displaybocategorytut.php, it’s just a very basic module structure.

if (!defined('_PS_VERSION_'))
	exit;

class displayBoCategoryTut extends Module
{

	protected $_errors = array();
	protected $_html = '';


	public function __construct()
	{
		$this->name = 'displaybocategorytut';
		$this->tab = 'front_office_features';
		$this->version = '1.0';
		$this->author = 'Nemo';
		$this->need_instance = 0;
		
		$this->bootstrap = true;

	 	parent::__construct();

		$this->displayName = $this->l('Display BO Category Tutorial');
		$this->description = $this->l('Displays an additional field in the category back office');
	}
	
	public function install()
	{
		if (!parent::install())
			return false;
		return true;
	}

	public function uninstall()
	{
		if (!parent::uninstall())
			return false;
		return true;
	}

}

The first thing we need is of course some additional data we want to save and retrieve. For this reason, we need an extra method to modify the database, and add a further column to the category table:

	public function alterTable($method = 'add')
	{
		if($method == 'add')
			$sql = 'ALTER TABLE ' . _DB_PREFIX_ . 'category ADD `myowninput` VARCHAR (255) NOT NULL';
		else 
			$sql = 'ALTER TABLE ' . _DB_PREFIX_ . 'category DROP COLUMN `myowninput`';

		if(!Db::getInstance()->Execute($sql))
			return false;
		return true;
	}

Explanation: since we need the extra column, we are using a single method to add and remove it. We are passing in a “method” parameter, so that we can switch between actions depending on our needs.

As mentioned, we need this column to be added when installing, and removed when uninstalling, so let’s amend the install and uninstall methods as well:

	public function install()
	{
		if (!parent::install() OR
			!$this->alterTable() OR
			!$this->registerHook('displayBackOfficeCategory') OR
			!$this->registerHook('categoryAddition') OR
			!$this->registerHook('categoryUpdate')
			)
			return false;
		return true;
	}

	public function uninstall()
	{
		if (!parent::uninstall() OR
			!$this->alterTable('remove'))
			return false;
		return true;
	}

Additionally, I am registering two hooks to update the field’s value. This would not be necessary if we had a Category class override to take care of the extra field (see more on Extending PrestaShop Objects).

Next, we will need some way to retrieve our custom field from the database

	public function getMyOwnInput($id_category)
	{
		return Db::getInstance()->getValue('SELECT myowninput FROM '._DB_PREFIX_.'category WHERE id_category = '. (int)$id_category);
	}

Then, it’s time to display something in the category back office. Let’s create the hooking method:

	public function hookDisplayBackOfficeCategory($params)
	{

		// we need an actual id, otherwise if we are just adding the category this field can be left empty
		if(Tools::getValue('id_category'))
			$myowninput = $this->getMyOwnInput(Tools::getValue('id_category'));
		else $myowninput = '';

		$this->context->smarty->assign(array(
			'myowninput'=> $myowninput
		));


		return $this->display(__FILE__, 'backoffice.tpl');
	}

Explanation: First off, we make sure we have a category ID that we can use to retrieve the value from the database. We use a switch to prevent the script from causing trouble in case there is none (that is, we are just creating a new category). Then, we assign the input value to the template, and return it. We don’t have it yet, so let’s create a new file inside views\templates\hook, naming it backoffice.tpl

Let’s add some simple markup:

<div class="form-group">
	<label class="control-label col-lg-3">
		<span class="label-tooltip">
			{l s='Custom Input' mod='displaybocategorytut'}
		</span>
	</label>
	<div class="col-lg-4">
		<input type="text" name="myowninput" value="{$myowninput}">
	</div>
	<div class="col-lg-6 col-lg-offset-3">
	</div>
</div>

We are ready to install the module! Go ahead and do it from the modules page. If everything goes smoothly as it should, reach a category and click edit (or add one). It should display our new field:

It won’t do much at the time being, since we are not saving the value on submit. For this, we need another couple of methods that will take advantage of the hooks we registered upon install:

	public function hookCategoryAddition($params)
	{
		Db::getInstance()->update('category', array('myowninput' => pSQL(Tools::getValue('myowninput'))), 'id_category = ' . $params['category']->id);
	}

	public function hookCategoryUpdate($params)
	{
		$this->hookCategoryAddition($params);
	}

Explanation: here we are using some standard code to update the database: the myowninput value is sent over via POST when submitting the page, and the $params variable passed to the method contains a useful Category object, from which we are taking the ID.

Now write something in the field and save, it should be stored in the database! To make sure everything runs smoothly, create a new category as well, adding content to our field before submitting the page.

Once everything works, you can try to expand the module with hooks, in the front office as well, and take full advantage of the new value.

Additional Resources

• Learn how to develop PrestaShop Modules with my PrestaShop Modules Course

The post Hooking modules to the Category Back Office in Prestashop appeared first on NemoPS.

Adding an extra field to PrestaShop objects

Before doing anything with CSVs or the importer, we need a field to fill with your data. If you don’t know how to add one, here is a tutorial on How to extend PrestaShop Objects, and add new fields to them.
In this example, we will use that extrafield one added in the tutorial.
As a side note, it’s not strictly necessary to add the extra field to the product object, as we will see, but it’s essential to have a database column we can use.

Two approaches

Given that the Product class override is not strictly necessary, we can proceed in two ways, depending on our needs: the first, is to complete the previous tutorial, and add the field to the Product Object; the second is to stop after adding the database column, and override an extra method of the AdminImportController, to manually update the new field. We will cover both to see how they work.

The AdminImportController override

Let’s start playing with the real file. First of all, create a new file in override/controllers/admin, and name it AdminImportController.php

Open it up, and add some standard override code within PHP tags

class AdminImportController extends AdminImportControllerCore
{

}

Next, we want to tell the Importer we have an extra field for products. To do this, we have to override the whole construct method, since it’s the one defining available fields for all entities. It’s too long to copy it here, to make sure you grab yours from the original Controller, and drop it into the override.

class AdminImportController extends AdminImportControllerCore
{
        $this->bootstrap = true;
        $this->entities = array(
            $this->l('Categories'),
            $this->l('Products'),
            $this->l('Combinations'),
            $this->l('Customers'),
            $this->l('Addresses'),
            $this->l('Manufacturers'),
            $this->l('Suppliers'),
            $this->l('Alias'),
        );
        // more code here

        $this->separator = ($separator = Tools::substr(strval(trim(Tools::getValue('separator'))), 0, 1)) ? $separator :  ';';
        $this->multiple_value_separator = ($separator = Tools::substr(strval(trim(Tools::getValue('multiple_value_separator'))), 0, 1)) ? $separator :  ',';
        AdminController::__construct();
}

Make absolutely sure you change the very last call to AdminController::__construct(); to avoid losing any modification to the product properties.

Now that the override is in place, we must let it know about our field. Locate the following snippet:

            case $this->entities[$this->l('Products')]:
                self::$validators['image'] = array(
                    'AdminImportController',
                    'split'
                );

You will notice it’s followed by an array defining available fields:

               $this->available_fields = array(
                    'no' => array('label' => $this->l('Ignore this column')),
                    'id' => array('label' => $this->l('ID')),
                    'active' => array('label' => $this->l('Active (0/1)')),
                    'name' => array('label' => $this->l('Name')),
                    'category' => array('label' => $this->l('Categories (x,y,z...)')),
                    'price_tex' => array('label' => $this->l('Price tax excluded')),
                    'price_tin' => array('label' => $this->l('Price tax included')),
                    'id_tax_rules_group' => array('label' => $this->l('Tax rules ID')),
                    'wholesale_price' => array('label' => $this->l('Wholesale price')),
                    'on_sale' => array('label' => $this->l('On sale (0/1)')),
                    'reduction_price' => array('label' => $this->l('Discount amount')),
                    'reduction_percent' => array('label' => $this->l('Discount percent')),
                    'reduction_from' => array('label' => $this->l('Discount from (yyyy-mm-dd)')),
                    'reduction_to' => array('label' => $this->l('Discount to (yyyy-mm-dd)')),
                    'reference' => array('label' => $this->l('Reference #')),
                    'supplier_reference' => array('label' => $this->l('Supplier reference #')),
                    'supplier' => array('label' => $this->l('Supplier')),
                    'manufacturer' => array('label' => $this->l('Manufacturer')),
                    'ean13' => array('label' => $this->l('EAN13')),
                    'upc' => array('label' => $this->l('UPC')),
                    'ecotax' => array('label' => $this->l('Ecotax')),
                    'width' => array('label' => $this->l('Width')),
                    'height' => array('label' => $this->l('Height')),
                    'depth' => array('label' => $this->l('Depth')),
                    'weight' => array('label' => $this->l('Weight')),
                    'quantity' => array('label' => $this->l('Quantity')),
                    'minimal_quantity' => array('label' => $this->l('Minimal quantity')),
                    'visibility' => array('label' => $this->l('Visibility')),
                    'additional_shipping_cost' => array('label' => $this->l('Additional shipping cost')),
                    'unity' => array('label' => $this->l('Unit for the unit price')),
                    'unit_price' => array('label' => $this->l('Unit price')),
                    'description_short' => array('label' => $this->l('Short description')),
                    'description' => array('label' => $this->l('Description')),
                    'tags' => array('label' => $this->l('Tags (x,y,z...)')),
                    'meta_title' => array('label' => $this->l('Meta title')),
                    'meta_keywords' => array('label' => $this->l('Meta keywords')),
                    'meta_description' => array('label' => $this->l('Meta description')),
                    'link_rewrite' => array('label' => $this->l('URL rewritten')),
                    'available_now' => array('label' => $this->l('Text when in stock')),
                    'available_later' => array('label' => $this->l('Text when backorder allowed')),
                    'available_for_order' => array('label' => $this->l('Available for order (0 = No, 1 = Yes)')),
                    'available_date' => array('label' => $this->l('Product availability date')),
                    'date_add' => array('label' => $this->l('Product creation date')),
                    'show_price' => array('label' => $this->l('Show price (0 = No, 1 = Yes)')),
                    'image' => array('label' => $this->l('Image URLs (x,y,z...)')),
                    'delete_existing_images' => array(
                        'label' => $this->l('Delete existing images (0 = No, 1 = Yes)')
                    ),
                    'features' => array('label' => $this->l('Feature (Name:Value:Position:Customized)')),
                    'online_only' => array('label' => $this->l('Available online only (0 = No, 1 = Yes)')),
                    'condition' => array('label' => $this->l('Condition')),
                    'customizable' => array('label' => $this->l('Customizable (0 = No, 1 = Yes)')),
                    'uploadable_files' => array('label' => $this->l('Uploadable files (0 = No, 1 = Yes)')),
                    'text_fields' => array('label' => $this->l('Text fields (0 = No, 1 = Yes)')),
                    'out_of_stock' => array('label' => $this->l('Action when out of stock')),
                    'shop' => array(
                        'label' => $this->l('ID / Name of shop'),
                        'help' => $this->l('Ignore this field if you don\'t use the Multistore tool. If you leave this field empty, the default shop will be used.'),
                    ),
                    'advanced_stock_management' => array(
                        'label' => $this->l('Advanced Stock Management'),
                        'help' => $this->l('Enable Advanced Stock Management on product (0 = No, 1 = Yes).')
                    ),
                    'depends_on_stock' => array(
                        'label' => $this->l('Depends on stock'),
                        'help' => $this->l('0 = Use quantity set in product, 1 = Use quantity from warehouse.')
                    ),
                    'warehouse' => array(
                        'label' => $this->l('Warehouse'),
                        'help' => $this->l('ID of the warehouse to set as storage.')
                    )
                );

This represents all of the fields, or columns, that you can map to every column of your csv file. At this point, it’s enough to append our element to the array:

                    'depends_on_stock' => array(
                        'label' => $this->l('Depends on stock'),
                        'help' => $this->l('0 = Use quantity set in product, 1 = Use quantity from warehouse.')
                    ),
                    'warehouse' => array(
                        'label' => $this->l('Warehouse'),
                        'help' => $this->l('ID of the warehouse to set as storage.')
                    ),
                    'extrafield' => array(
                        'label' => $this->l('Extrafield'),
                        'help' => $this->l('Something')
                    )
                );

Save, then reach the cache folder and delete class_index.php, so that the override file is loaded.

If you added the Product class override, you can skip to Testing The Import

Otherwise, there is a little snippet you need to add. Unfortunately, in order to do it we have to override the whole ProductImport() method. Therefore, copy and paste yours into the override file we created; then, reach the very end of it, where it reads:

        $this->closeCsvFile($handle);
        Module::processDeferedFuncCall();
        Module::processDeferedClearCache();
        Tag::updateTagCount();

Right before, add the following statement

Db::getInstance()->update('product', array('extrafield' => $info['extrafield']), 'id_product = ' . (int)$product->id);

This will manually update the field, in case it was not part of the product object.

Testing The Import

Before proceeding: Make sure you do not have a product with the same ID of the sample one, or it will be overridden.

We are ready for a test run. Download the product csv sample from Advanced Parameters > CSV Import

Open up the file in any text editor, get rid of all lines apart from the heading and first product. Then, add a new heading after “Warehouse”, and a value for it on the next line:

Save the file. Now load it up in the importer. Make sure you select Products as entity, and leave all other settings as default. Hit Next.

On the next screen, hit the next arrow until you reach the end of the file. You should see the new column popping up:

Now proceed and simply hit import to complete the process. You will probably get an error because of the broken image url, but the new field should be added to the database:

We are done! Now you can display the extra field the way you like, whether it is with a module or following the previously linked tutorial.

Additional Resources on CSV Import in PrestaShop

• How to extend PrestaShop Objects
• Prestashop: Import CSV data in 1.6

The post Adding new fields to the PrestaShop CSV Importer appeared first on NemoPS.

Last Week, forum user alexdee2007 posted an interesting override: it allows us to extend PrestaShop Modules’ controllers. Previously, we would have had to hardcode any modification within the originals, because the core system didn’t allow for such overrides. You can find a link to the original thread at the end of the tutorial.

What does the override do?

Its concept is very simple, yet smart. It extends the Dispatcher class’ Dispatch() method, modifying what the system looks for, once loading modules front controllers. Here is the core part:

if (file_exists(_PS_OVERRIDE_DIR_ . 'modules/' . $module_name . '/controllers/front/' . $this->controller . '.php')) {
    include_once(_PS_OVERRIDE_DIR_ . 'modules/' . $module_name . '/controllers/front/' . $this->controller . '.php');
    $controller_class = $module_name . $this->controller . 'ModuleFrontControllerOverride';
} else {

    $controller_class = $module_name . $this->controller . 'ModuleFrontController';
}

Basically, it looks for the existence of any file, in the override directory, with the same path and name of the original controller. If it exists, it assigns the name plus “Override” to the current class name (which is what PrestaShop does already, for modules).
This way, to extend any Module’s controller, we can simply create a file inside override/modules/*modulename*/controllers/front, named the same as the original, and then append Override to its Class name.

Video – A practical example

Additional Recources

• PrestaShop Modules Course
• The original Forum Thread

The post Overriding Modules Controllers in PrestaShop 1.6 appeared first on NemoPS.

Assigning variables to smarty from PHP

$this->context->smarty->assign('variablenameinsmarty', $myvalue); // you will be able to access this as {$variablenameinsmarty} in the template

// same as above, but in batch
$this->context->smarty->assign(array(
	'variablenameinsmarty' => $myvalue,
	'anothervariablenameinsmarty' => $myothervalue,
));

Creating translatable strings

{l s='This is my string'} // theme template
{l s='This is my string' mod='modulename'}// module template
{l s='There are %s errors' sprintf=[$account_error|@count]} // theme template with variable replacement
{l s='No file selected' js=1} // supposed to be used in a javascript script, only within addJsDef (see below)
{l s='Billing Address' pdf='true'} // only used within PDF templates

These are to be used whenever you want to create a translatable string in a template. After adding them, you can reach out the translations page in the back office and add them into other languages. “mod” ones will be found under “Installed Modules Translations”; “pdf” ones under PDF Translations; theme ones under Front Office Translations, choosing the specific template.

Adding javascript variable definitions

{addJsDef wishlistProductsIds=$wishlist_products}

{addJsDef mySliderCount=7}

{addJsDefL name='youhavelides'}{l s='You save Slides!' js=1}{/addJsDefL}

These are needed when you want to pass data from the template to any attached .js file. You will have to make sure to write any script inside a jquery ready statement if you load them in the header, or variables won’t be readily available. Notice how the first one uses the javascript variable name, while the language one sets it using name=”.

Example Usage

// will alert "You have slides!" in the current language
if(mySliderCount > 0)
	alert(youhavelides);

Displaying a formatted price

{convertPrice price=$price} // display Price in the current currency
{displayPrice price=$price currency=$id_currency} // specify the currency

These are used to format the price only. They will not take care of any conversion rate, even if the first one is named that way.

Example Usage

// default currency is $, id 2 is Euros
{convertPrice price=1} // $1.00
{displayPrice price=1 currency=2} // 1,00 €

Displaying a formatted date

{dateFormat date=$date full =1} // display a date formatted like specified in the back office

Example Usage

// chosen date format is dd/mm/yyyy H:i
{dateFormat date="2015-01-07 22:45:01" } // 07/01/2015
{dateFormat date="2015-01-07 22:45:01" full=1} // 07/01/2015 22:45

Getting a page Link

{$link->getPageLink('pagename', ssl, id_lang, "GET string or Array")}

Example Usage

// Gets a link for step 3 of the order process, with ssl
{$link->getPageLink('order', true, NULL, "step=3")}

// link to the contact us page
<a href="{$link->getPageLink('contact'}" title="{l s='Contact us'}">{l s='Contact us'}</a>

Getting a Product Image

{$link->getImageLink(link_rewrite, id_image, 'image_type')}

Example Usage

// gets the home_default image type, having a product as array
<img src="{$link->getImageLink($product.link_rewrite, $product.id_image, 'home_default')}"/>

Adding a new hook

{hook h='displaySomething'} // will process any hookDisplaySomething method
{hook h='displaySomething' parameter='my string'} // will pass a variable named "parameter" with value "my string" later available using "params['mystring']" in the hook method

Conclusion

This batch concludes our series on Useful Prestashop Functions. Bear in mind logic should be kept off the templates as much as possible, to preserve the MVC pattern (Prestashop is heading towards it with Prestashop 1.7 removing plenty of modifiers next year). Therefore, whenever possible, try using the PHP counterpart of these functions, preprocessing the output and only using template for displaying data.

Additional Resources

• Essential Prestashop Functions – Day 1
• Essential Prestashop Functions – Day 2
• Essential Prestashop Functions – Day 3
• Essential Prestashop Functions – Day 4

The post Essential Prestashop Functions – Day 5 appeared first on NemoPS.

NOTICE: Values with “=” in the declaration are optional.

Getting products of a Category

Category::getProducts($id_lang, $p, $n, $order_by = null, $order_way = null, $get_total = false, $active = true, $random = false, $random_number_products = 1, $check_access = true, Context $context = null);

This is the preferred method to get products from any category in Prestashop. It’s used not only in categories pages, but by the homefeatured module, as well as others.

Example Usage

$category = new Category(5);

// Retrieves the first 15 products of a category
$products = $category->getProducts($this->context->language->id, 1, 15);

// Retrieves the first 15 products of a category, returning the number of total products for that category as well. Ordered by price, lowest to highest
$products = $category->getProducts($this->context->language->id, 1, 15, 'price', 'asc', true);


// Gets a random number of products, in random order (yes, even if we specified it)
$products = $category->getProducts($this->context->language->id, 1, 15, 'price', 'asc', false, true);

Getting new products

Product::getNewProducts($id_lang, $page_number = 0, $nb_products = 10, $count = false, $order_by = null, $order_way = null, Context $context = null);

This method can be used statically, without having to instantiate the product class.

Example Usage

$newProducts = Product::getNewProducts((int) $this->context->language->id, 0, 10);

Getting discounted products

Product::getPricesDrop($id_lang, $page_number = 0, $nb_products = 10, $count = false,
		$order_by = null, $order_way = null, $beginning = false, $ending = false, Context $context = null);

This method can also be used statically, without having to instantiate the product class.

Example Usage

// get the last 10 prices drop, ordered by position
$price_drops = Product::getPricesDrop((int) $this->context->language->id, 0, 10);

// get the last 10 prices drops, ordered by price, but only where the offer's start date is after july 23, 2015
$price_drops =  Product::getPricesDrop((int) $this->context->language->id, 0, 10, false,
		'price', 'asc', '2015-7-23 10:45:32');

Getting Best Sales

ProductSale::getBestSales($id_lang, $page_number = 0, $nb_products = 10, $order_by = null, $order_way = null)

This method can also be used statically, without having to instantiate the product class.

Example Usage

// get 10 best selling products, ordered by best selling
$products = ProductSale::getBestSales($this->context->language->id, 0, 10);

Getting Best Sales (Light)

ProductSale::getBestSalesLight($id_lang, $page_number = 0, $nb_products = 10, Context $context = null)

Lighter and quicker version of the above method, which only retrieves strictly necessary information (not recommended to display products in the product-list template)

Example Usage

// get 5 best selling products, ordered by best selling, called from a hook method
$products = ProductSale::getBestSalesLight((int)$params['cookie']->id_lang, 0, 5))

Adding variables to the cookie object

Cookie::__set($key, $value);

Useful to store dynamic information through pages (like user preferences for the current login session)

Example Usage

// you might want to trigger this when a user clicks on the cookie loaw banner (where any), so that you are not prompting him to accept it on every page
$this->context->cookie->__set('cookielawaccepted', 1);

// The value can hold strings as well (arrays can be saved by serializing them)
$this->context->cookie->__set('mycustomoptionmode', 'test');

Checking cookie variables

Cookie::__get($key);

Gets the given key’s value from the cookie object.

Example Usage

// Following up the previous example, you can use this to avoid prompting the user again
if(!$this->context->cookie->__get('cookielawaccepted'))
{
	// display the message 
}

Clearing a cookie variable

Cookie::__unset($key);

Removes the given key from the cookie object.

Example Usage

// removes the cookie law entry,
$this->context->cookie->__unset('cookielawaccepted')

Logging a user out

Customer::logout();

Example Usage

// Clears all of the current session data for this customer
$this->context->customer->logout();

Additional Resources

• Essential Prestashop Functions – Day 1
• Essential Prestashop Functions – Day 2
• Essential Prestashop Functions – Day 3
• Essential Prestashop Functions – Day 5

The post Essential Prestashop Functions – Day 4 appeared first on NemoPS.

NOTICE: Values with “=” in the declaration are optional.

Getting a Product’s Price

// It needs an instance
Product::getPrice($tax = true, $id_product_attribute = null, $decimals = 6,
		$divisor = null, $only_reduc = false, $usereduc = true, $quantity = 1)

// Static way
Product::getPriceStatic($id_product, $usetax = true, $id_product_attribute = null, $decimals = 6, $divisor = null,
		$only_reduc = false, $usereduc = true, $quantity = 1, $force_associated_tax = false, $id_customer = null, $id_cart = null,
		$id_address = null, &$specific_price_output = null, $with_ecotax = true, $use_group_reduction = true, Context $context = null,
		$use_customer_price = true);

Both methods can be equally used to get a product’s price. While the first needs to be ran by a product instance, the second is static and can be ran from every context, as long as you provide the product id.

Example Usage

// get the product price, after instanciating a new object

$product = new Produc(4); // instanciate a product with id = 4
// get the price, but dynamically check if it needs to apply taxes or not
$product_price = $product->getPrice(Product::$_taxCalculationMethod == PS_TAX_INC);
// get the price of a specific combination, always with taxes
$product_attribute_price = $product->getPrice(true, 77);


// get price without instanciating an object
$products = array(
	0 => array('id_product' => 2),
	1 => array('id_product' => 86),
	2 => array('id_product' => 12),
);

foreach($products as $key => $product)
	$products[$key]['price'] = Product::getPriceStatic($product['id_product']);

Getting a Product’s Name

Product::getProductName($id_product, $id_product_attribute = null, $id_lang = null);

Retrieves the given product name in a single language (if not specified, the current one)

Example Usage

// Gets the name in the current language
$name = Product::getProductName(34);

// Gets the combination name in a chosen language
$name = Product::getProductName(34, 6, 2);

Getting a Product’s Quantity

Product::getQuantity($id_product, $id_product_attribute = null, $cache_is_pack = null);

// This will consider a specific warehouse
Product::getRealQuantity($id_product, $id_product_attribute = 0, $id_warehouse = 0, $id_shop = null)

They both return the product’s quantity, but the latter is to be preferred with advanced stock management in mind.

Example Usage

// gets the quantity of all products in the array
$products = array(
	0 => array('id_product' => 2),
	1 => array('id_product' => 86),
	2 => array('id_product' => 12),
);

foreach($products as $key => $product)
	$products[$key]['qty'] = Product::getQuantity($product['id_product']);


// Gets quantity for a specific combination of a product (product id = 6, combination id = 99)
$quantity = Product::getQuantity(6, 99);


// Gets the quantity in stock for the specific warehouse ID
$quantity = Product::getRealQuantity(6, 0, 1);

Getting and displaying Products Cover Image

// Returns an image ID
Product::getCover($id_product, Context $context = null);

// Uses the product rewrite and image id to get the actual image link
Link::getImageLink($name, $ids, $type = null);

These can be used in conjunction to display the product’s cover.

Example Usage

// returns an array like array('id_image' => 66)
$cover = Product::getCover(5);

if($cover) // if there is an image
{
	// notice 'ipod-nano' is the product link_rewrite field here;
	$img_link = $this->context->link->getImageLink('ipod-nano', $cover['id_image']); // remember the previous is an array
}

Getting Product Features for the front office

// Gets features so they can be properly displayed
Product::getFrontFeatures($id_lang);

// The same, but static
Product::getFrontFeaturesStatic($id_lang, $id_product);

These methods come in handy when you want to display product features with their names and values.

Example Usage

$product = new Product(10);
$features = $product->getFrontFeatures($this->context->language->id);


// static way
$features = Product::getFrontFeaturesStatic($this->context->language->id, 10);

Getting Product Categories

// Get ids of the categories this product belongs to
Product::getCategories();

// The same, Static
Product::getProductCategories($id_product);

// Get more data about categories, including name and link_rewrite
Product::getProductCategoriesFull($id_product, $id_lang = null);

// Get all parent categories, up to the root, in a single language. It will only consider the default one as starting point
Product::getParentCategories($id_lang = null);

They are all used to retrieve data about the product’s category association.

Example Usage

$product = new Product(10);
// $categories will be ids only
$categories = $product->getCategories();

// Using the same Object, get all parents
$parent_categories = $product->getParentCategories();

// Static way, getting more data in the current language
$categories = Product::getProductCategoriesFull(10, $this->context->language->id);

Additional Resources

• Essential Prestashop Functions – Day 1
• Essential Prestashop Functions – Day 2
• Essential Prestashop Functions – Day 4
• Essential Prestashop Functions – Day 5

The post Essential Prestashop Functions – Day 3 appeared first on NemoPS.

NOTICE: Values with “=” in the declaration are optionals.

Database-related Functions

// Retrieving an array of values from the given table
Db::getInstance()->executeS($sql, $array = true, $use_cache = true);

// Retrieving a single value
Db::getInstance()->getValue($sql, $use_cache = true);

// Retrieving a whole row
Db::getInstance()->getRow($sql, $use_cache = true);

// Executing a generic query, returns true if succeeded, false if failed
Db::getInstance()->execute($sql, $use_cache = true)

// Inserting a row
Db::getInstance()->insert($table, $data, $null_values = false, $use_cache = true, $type = Db::INSERT, $add_prefix = true)

// Updating values
Db::getInstance()->update($table, $data, $where = '', $limit = 0, $null_values = false, $use_cache = true, $add_prefix = true)

// Erase the given entry
Db::getInstance()->delete($table, $where = '', $limit = 0, $use_cache = true, $add_prefix = true)

// Escape data
Db::getInstance()->escape($string, $html_ok = false, $bq_sql = false)

// Get the primary key of the last item you added
Db::getInstance()->Insert_ID()

These methods serve as helpers so that we don’t have to create a new mysql connection every time we want to run a query

Example Usage

// Returns an array with each item correspinding to a single database row
// It should only be used to retrieve values, use execute or the other helpers to insert/update them
$customers = Db::getInstance()->executeS('SELECT * FROM '._DB_PREFIX_.'customers');

// Returns product data of the ones that belong to the given category only (id = 4)
$products = Db::getInstance()->executeS('
	SELECT * FROM '._DB_PREFIX_.'product p
	LEFT JOIN '._DB_PREFIX_.'category_product cp ON (cp.id_product = p.id_product)
	WHERE cp.id_category = 4
');


// Retrieving the specific product name for our current language
$product_name = Db::getInstance()->getValue('SELECT name FROM '._DB_PREFIX_.'product_lang WHERE id_product = 1 AND id_lang = ' . $this->context->language->id);

// Get the whole row for customer id = 1
$customer = Db::getInstance()->getRow('SELECT * FROM '._DB_PREFIX_.'customer WHERE id_customer = 1');


// Insert some data manually (not recommended, unless you have some really specific SQL to use)
Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'customer (id_customer, email, firstname, lastname) VALUES (9, "nemo@nemops.com", "Fabio", "Porta")');

// Inserting a row
// The $data array must be configured like 
// 		column => value

$data = array(
	'id_customer' => 1,
	'email' => "nemo@nemops.com",
	'firstname' => "Fabio",
	'lastname' => "Porta",
);
Db::getInstance()->insert('customer', $data);

// Updating values, array configured as above
$data = array(
	'id_customer' => 1,
	'email' => "nemo@nemops.com",
	'firstname' => "Fabio",
	'lastname' => "Porta",
);
Db::getInstance()->update('customer', $data, 'id_customer = 1');

// Erase customer with id = 1
Db::getInstance()->delete('customer', 'id_customer = 1');

// Escape data
$sanitized = Db::getInstance()->escape('<div class="test"><div>', true);
// will return <div class=\"test\"><div>

// Get the primary key of the last item you added

$data = array(
	'email' => "nemo@nemops.com",
	'firstname' => "Fabio",
	'lastname' => "Porta",
);
Db::getInstance()->insert('customer', $data);
$last_id = Db::getInstance()->Insert_ID()
// $last_id will be the id_customer of the entry we just added

The Query object in Prestashop

DbQuery::select($fields)
DbQuery::from($table, $alias = null)
DbQuery::join($fields)
DbQuery::leftJoin($table, $alias = null, $on = null)
DbQuery::where($restriction)
DbQuery::having($restriction)
DbQUery::orderBy($fields)
DbQUery::groupBy($fields)
DbQuery::limit($limit, $offset = 0)

All these functions are used to streamline a query creation. Inspect the DbQuery class to have a complete list.

Example Usage

	// get all products with id > 3, with relative language data

	$query = new DbQuery();
	$query->select('p.*, pl.*')
		->from('product', 'p')
		->leftJoin('product_lang', 'pl', 'p.id_product = pl.id_product')
		->where('p.id_product > 34')
		->where('pl.id_lang = ' . $this->context->language->id)
		->groupBy('p.id_product')
		->limit(5)

	$result = Db::getInstance()->getValue($query);

Quick escape in a SQL query

pSQL($string, $htmlOK = false)

Sanitize data which will be injected into SQL query

Example Usage

	$search = '2" clamps';
	// get aliases for the given search word, as you can see the above requires douple quotes to be escaped
	$aliases = Db::getInstance()->executeS('
	SELECT a.alias
	FROM `'._DB_PREFIX_.'alias` a
	WHERE `search` = \''.pSQL($search).'\'');

Wrapping it up

All of the methods we examined today are a huge time saver when dealing with the Database in Prestashop. I rarely use the query object, I admit, as I prefer relying on the other methods. However, since it’s getting more and more built into the standard workflow of core modules and methods, it’s good practice to start using that as well, and integrate it into your own Prestashop Module/Extension.

Additional Resources

• Essential Prestashop Functions – Day 1
• Essential Prestashop Functions – Day 3
• Essential Prestashop Functions – Day 4
• Essential Prestashop Functions – Day 5

The post Essential Prestashop Functions – Day 2 appeared first on NemoPS.