Creating a ProductController override in PrestaShop

The cleanest and standard compliant method for assigning the proper variables in PrestaShop, is to use a controller. We need to add content to the product page, so the one we are interested in is the ProductController. Additionally, in order to make sure our modification is upgrade-safe, we need to use an override instead of modifying the original.

Let’s get started!

Create a new file inside override/controllers/front/ and name it ProductController.php

Open it up, and within php tags add the following:

Class ProductController extends ProductControllerCore
{

}

We want to extend the initContent() method, so let’s do it:

Class ProductController extends ProductControllerCore
{
	public function initContent()
    {
        parent::initContent();
    }
}

We are calling the parent’s initContent as well, to make sure all the needed variables are loaded. At this point, before the parent is called, let’s first check if the current user is a registered customer, as we will never be able to tell what a guest has bought:

Class ProductController extends ProductControllerCore
{
	public function initContent()
    {

    	if($this->context->customer->id) // only if logged in
        {
			$bought_products = $this->context->customer->getBoughtProducts(); // only valid orders
        }
        parent::initContent();
    }
}

If it is, we get all the products he bought. Please notice only valid(paid) orders are considered. If you wish to include them all, you must remove the condition “valid = 1″ in the getBoughtProducts method, Customer class.

Now let’s cycle through them. If the current product’s id is matched, we assign a date variable to the template:

    if($this->context->customer->id) // only if logged in
    {
        $bought_products = $this->context->customer->getBoughtProducts(); // only valid orders
        if($bought_products)
        {
            foreach ($bought_products as $prod) {

                if($prod['product_id'] = $this->product->id)
                {
                    $this->context->smarty->assign(array(
                        'bought_on'=> $prod['date_add']
                    ));
                }
            }
        }
    }

We are done with php, the next step will be showing our custom text in the product.tpl file. Before proceeding, make sure to erase your class_index.php file, located in the cache/ folder.

Adding a bought product text to the product page

Open up product.tpl, located in the theme folder. Please notice your code will be different if you use a custom template, as I am using default-bootstrap for this demonstration. I decided to add the info box at the top of the page, above the product image.
If you want to pick the same spot, locate the div with class pb-left-column, and add the following right before it:

		{if isset($bought_on)}
			<div class="col-xs-12">
				<div class="bought_on alert alert-info">
					{l s='You purchased this product on'} {dateFormat date=$bought_on}
				</div>	
			</div>
		{/if}

Save and refresh, we are done! You should see something like this:

The post Display a “Bought product” label in PrestaShop appeared first on NemoPS.

Creating a simple module

The best way to add new elements to the order confirmation page, in Prestashop, is through a very simple module that hooks to orderConfirmation. Even if you are not familiar with advanced coding, this very step should be pretty simple to follow.

First off, download the sample module archive you find at the beginning of the article. Open it and place the first psconfresume folder you see inside modules/.

Navigate to it, and open psconfresume.php in your favorite code editor, then paste in the following, inside php tags:

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

class psConfResume extends Module
{

	protected $_errors = array();


	public function __construct()
	{
		$this->name = 'psconfresume';
		$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('psconfresume');
		$this->description = $this->l('Adds a block.');
		$this->confirmUninstall = $this->l('Are you sure you want to delete this module?');
	}
	
	public function install()
	{
		if (!parent::install() OR
			!$this->registerHook('orderConfirmation')
			)
			return false;
		return true;
	}
	
	public function uninstall()
	{
		if (!parent::uninstall())
			return false;
		return true;
	}
}

These are just the barebones of a module. Just make sure you register the orderConfirmation hook if you do it from scratch.

Assigning parameters to the hook

Once done with the basic setup, we need to do something with the hook. Add the following as last method:

	public function hookOrderConfirmation($params)
	{

		$order = $params['objOrder'];
		$products = $order->getProducts();

		$this->context->smarty->assign(array(
			'order'=> $order,
			'order_products' => $products
		));
		
		return $this->display(__FILE__, 'confirmation.tpl');
	}

There is nothing too fancy going on here. First, we take advantage of the order object, which comes through the $params array, and use it to get more details on the ordered products. Then, we simply assign both variables to the template, returning it in the end. Make sure this .tpl file is located inside the module’s folder, views/templates/hook.

The order resume table

At this point, we are just throwing in an empty template, so we need to fill it with data. Open up views/templates/hook/confirmation.tpl and paste the following (yeah it’s long):

<table class="std">
	<thead>
		<tr>
			<th>{l s='Product' mod='psconfresume'}</th>
			<th>{l s='Price' mod='psconfresume'}</th>
			<th>{l s='Qty' mod='psconfresume'}</th>
		</tr>
	</thead>
	<tbody>
		{foreach from=$order_products item=product}
			<tr>
				<td>{$product.product_name}</td>
				<td>
					{if $use_taxes}
						{displayPrice price=$product.total_price_tax_incl}
					{else}
						{displayPrice price=$product.total_price_tax_excl}
					{/if}
				</td>
				<td>{$product.product_quantity}</td>
			</tr>
		{/foreach}
	</tbody>
	<tfoot>
		<tr>
			<td style="text-align:right">
				{l s='Products Total' mod='psconfresume'}
			</td>
			<td colspan="2">
				{if $use_taxes}
					{displayPrice price=$order->total_products_wt}
				{else}
					{displayPrice price=$order->total_products}
				{/if}
				
			</td>
		</tr>	
		<tr>
			<td style="text-align:right">
				{l s='Shipping' mod='psconfresume'}
			</td>
			<td colspan="2">
				{if $use_taxes}
					{displayPrice price=$order->total_shipping_tax_incl}
				{else}
					{displayPrice price=$order->total_shipping_tax_excl}
				{/if}
				
			</td>
		</tr>
		{if $order->total_discounts != '0.00'}
			<tr>
				<td style="text-align:right">
					{l s='Discounts' mod='psconfresume'}
				</td>
				<td colspan="2">-
					{if $use_taxes}
						{displayPrice price=$order->total_discounts_tax_incl}
					{else}
						{displayPrice price=$order->total_discounts_tax_excl}
					{/if}
				</td>
			</tr>
		{/if}
		{if $use_taxes}
			<tr>
				<td style="text-align:right">
					{l s='Taxes Paid' mod='psconfresume'}
				</td>
				<td colspan="2">
					{$taxamt = $order->total_paid_tax_incl - $order->total_paid_tax_excl}
					{displayPrice price=$taxamt}

				</td>
			</tr>
		{/if}
		<tr>
			<td style="text-align:right">
				{l s='TOTAL' mod='psconfresume'}
			</td>
			<td colspan="2">
				{if $use_taxes}
					{displayPrice price=$order->total_paid_tax_incl}
				{else}
					{displayPrice price=$order->total_paid_tax_excl}
				{/if}
			</td>
		</tr>
	</tfoot>
</table>

I didn’t break it into steps because it’s quite simple: we create a table with Product name, price and quantity as headers. Then, in the body, we loop through products themselves and display what we need. Lastly, we take care of shipping, discounts, taxes and total in the tfoot element. Please notice I used the $use_taxes variable to detect whether or not we have to display the taxed amount. You might want to tweak these parts depending on your needs, such as adding gift wrap as well or using DIV tags instead of a table.

That is basically it, create and order and see if everything works:

The post Displaying the order resume at the Order Confirmation in Prestashop appeared first on NemoPS.

Version used: Prestashop 1.6

Setting the Free Shipping amount

To keep thing simple, in this tutorial we will only consider the “Free shipping starts at” value that we can configure in the back office, instead of dealing with all the 0-fee weight or price ranges that it’s possible to setup for each carrier.

Therefore, before starting, head to Shipping -> Preferences and set “Free shipping starts at” to any value you like. Please notice this represent the price in the default currency, and it’s not possible to set up one for each, at the time being.

Retrieving the Free shipping value – 2 approaches

When dealing with an MVC pattern, the best approach is usually to keep logic and display code separated. Prestashop, however, allows us to retrieve the previously set configuration value in templates too, saving us the trouble to create an override and extend the default OrderController, in order to assign the value we need.

Therefore, given that the best way to go would be to create an override, grab the configuration value, and assign it to the template, for simplicity reasons I will get it directly in the template, so it’s ready to use.

Amending the template: shopping-cart.tpl

Reach your theme folder and open up shopping-cart.tpl. We will be adding our small advertisement right below the cart summary. This is the perfect chance to apply some cross-selling principles; therefore, if you use the cross-selling module in the cart page, the best spot to maximize your cross-selling rate is right above it, before the shopping cart hook .

Locate:

<div id="HOOK_SHOPPING_CART">{$HOOK_SHOPPING_CART}</div>

And right before it, add the following

{assign var='freeshipping_price' value=Configuration::get('PS_SHIPPING_FREE_PRICE')}

Explanation: as I mentioned before, I am grabbing the free shipping value directly from the tpl file, and assigning it to a variable that can be used within our Prestashop template.

Then, we need to check if it is actually holding a value

	{assign var='freeshipping_price' value=Configuration::get('PS_SHIPPING_FREE_PRICE')}
	{if $freeshipping_price}
		{assign var='freeshipping_price_converted' value={toolsConvertPrice price=$freeshipping_price}}	
	{/if}

Explanation: if the value exists, we need to convert it to the current currency (which might be other than the default). Therefore, we use the very handy toolsConvertPrice method to make sure the value is correctly set to the actual customer currency.

What’s next? We need to compare the total cart value without shipping to the free shipping one, and display a message in case it’s positive:

	
	{assign var='freeshipping_price' value=Configuration::get('PS_SHIPPING_FREE_PRICE')}

	{if $freeshipping_price}
		{assign var='freeshipping_price_converted' value={toolsConvertPrice price=$freeshipping_price}}


		{math equation='a-b' a=$total_price b=$total_shipping assign='total_without_shipping'}
		{math equation='a-b' a=$freeshipping_price_converted b=$total_without_shipping assign='remaining_to_spend'}

		{if $remaining_to_spend > 0}
			<p>{l s='Your total (without shipping) is'} {convertPrice price=$total_without_shipping}</p>
			<p><strong>{l s='You will be eligible for free shipping if you spend another'} {convertPrice price=$remaining_to_spend}</strong></p>
		{/if}
	

	{/if}

Explanation: first, we subtract the total shipping price from the overall total, which is the value taken in consideration by Prestashop when deciding if a cart is eligible or not, and then we simply subtract it from our minimum free shipping threshold. If the result is positive, we tell our customers how much is left to get rid of the shipping charge!

The post How to show “spend X to get Free Shipping” in Prestashop appeared first on NemoPS.

Ordering Prestashop Features by name

In order to change the features’ order we need to amend the method called getFrontFeaturesStatic, of the Product class. As it’s best practice, let’s use an override!

Go to override/classes and create a file named Product.php. Inside, add the following:

class Product extends ProductCore
{
}

Then, let’s have a look at the original getFrontFeaturesStatic, located in the code Product.php file, found in the classes/ folder.

	public static function getFrontFeaturesStatic($id_lang, $id_product)
	{
		if (!Feature::isFeatureActive())
			return array();
		if (!array_key_exists($id_product.'-'.$id_lang, self::$_frontFeaturesCache))
		{
			self::$_frontFeaturesCache[$id_product.'-'.$id_lang] = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
				SELECT name, value, pf.id_feature
				FROM '._DB_PREFIX_.'feature_product pf
				LEFT JOIN '._DB_PREFIX_.'feature_lang fl ON (fl.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature_value_lang fvl ON (fvl.id_feature_value = pf.id_feature_value AND fvl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature f ON (f.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				'.Shop::addSqlAssociation('feature', 'f').'
				WHERE pf.id_product = '.(int)$id_product.'
				ORDER BY f.position ASC'
			);
		}
		return self::$_frontFeaturesCache[$id_product.'-'.$id_lang];
	}

Pay close attention to the ORDER BY clause. It currently says: f.position. We want to order by name, which is a column of the feature_lang table! Therefore, copy this whole method to the new override:

class Product extends ProductCore
{

	public static function getFrontFeaturesStatic($id_lang, $id_product)
	{
		if (!Feature::isFeatureActive())
			return array();
		if (!array_key_exists($id_product.'-'.$id_lang, self::$_frontFeaturesCache))
		{
			self::$_frontFeaturesCache[$id_product.'-'.$id_lang] = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
				SELECT name, value, pf.id_feature
				FROM '._DB_PREFIX_.'feature_product pf
				LEFT JOIN '._DB_PREFIX_.'feature_lang fl ON (fl.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature_value_lang fvl ON (fvl.id_feature_value = pf.id_feature_value AND fvl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature f ON (f.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				'.Shop::addSqlAssociation('feature', 'f').'
				WHERE pf.id_product = '.(int)$id_product.'
				ORDER BY f.position ASC'
			);
		}
		return self::$_frontFeaturesCache[$id_product.'-'.$id_lang];
	}

}

And change the ORDER BY clause as follows:

ORDER BY fl.name ASC

Done! If you are using a version newer than 1.5.3, go to the cache/ folder and delete the class_index.php file in order for the new changes to take place!

The final override:

class Product extends ProductCore
{

	public static function getFrontFeaturesStatic($id_lang, $id_product)
	{
		if (!Feature::isFeatureActive())
			return array();
		if (!array_key_exists($id_product.'-'.$id_lang, self::$_frontFeaturesCache))
		{
			self::$_frontFeaturesCache[$id_product.'-'.$id_lang] = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
				SELECT name, value, pf.id_feature
				FROM '._DB_PREFIX_.'feature_product pf
				LEFT JOIN '._DB_PREFIX_.'feature_lang fl ON (fl.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature_value_lang fvl ON (fvl.id_feature_value = pf.id_feature_value AND fvl.id_lang = '.(int)$id_lang.')
				LEFT JOIN '._DB_PREFIX_.'feature f ON (f.id_feature = pf.id_feature AND fl.id_lang = '.(int)$id_lang.')
				'.Shop::addSqlAssociation('feature', 'f').'
				WHERE pf.id_product = '.(int)$id_product.'
				ORDER BY fl.name ASC'
			);
		}
		return self::$_frontFeaturesCache[$id_product.'-'.$id_lang];
	}

}

The post Flash Tip: Order Prestashop Features by name appeared first on NemoPS.