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.

Watch the screencast

Text Version

All of the modifications need to be applied to AdminOrdersController.php, located in controllers/admin
Add to $this->_select (do not forget the comma!):

od.product_quantity_return as has_returned,

Add to $this->_join:

LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON (od.`id_order` = a.`id_order`)

Right after the join variable is set, add:

$this->_group = 'GROUP BY a.id_order';

This way we avoid duplicates in the order list.

In the next step we will add the actual column, scroll down to around line 130, and add the following to the $this->fields_list variable:

                'has_returned'            => [
                    'title'      => $this->l('Return'),
                    'align'      => 'text-center',
                    'type'       => 'bool',
                    'callback'       => 'getIsReturned',
                ],

Lastly, out of the construct method (it can be anywhere, right after it or at the end of the file) we will add the callback function:

    public function getIsReturned($a, $order)
    {
        $has_returned = Db::getInstance()->getValue('SELECT product_quantity_return FROM '._DB_PREFIX_.'order_detail WHERE id_order =' .(int)$order['id_order'] .' AND product_quantity_return > 0');

        $class = $has_returned ? 'icon-check' : 'icon-remove';
        return '<i class="'.$class.'"></i>';

    }

The post Mark orders with returned products in the order list of ThirtyBees and PrestaShop appeared first on NemoPS.

Watch the screencast

Text Version

This tutorial can be applied to ThirtyBees as well!

To filter the PrestaShop order list we simply have to add conditions to the “where” clause of the AdminOrdersController.php, located at controllers/admin.
What we want to do is append the extra conditions to the construct method, around line 68:

if($this->context->employee->id_profile == 1)
        {
            $this->_where .= ' AND os.id_order_state = 2';
            $this->_where .= ' AND country.id_country = 21';
            $this->_where .= ' AND a.module = "bankwire"';
        }

The first condition will filter orders by current status, in this case “Payment Accepted”; The second will only display orders shipping to the United States; the third one will narrow the results to the ones paid by bank wire.
We are using the employee’s profile ID to trigger the conditions, so that only the selected department will be affected.

These snippets will be enough in most cases, but if you want to be extra careful, it’s better to also prevent direct access to the single order view, by editing the renderView method:

// At the beginning of the renderView method, after the $order variable has been validated, we can use this to prevent access if the order is not set to payment accepted. We can do the same with the bankwire method as we saw above, by simply changing the property name from current_state to module
if($this->context->employee->id_profile == 1)
        {

            if($order->current_state != 2)
            {
                $this->errors[] = Tools::displayError('You are not authorized to see this page.');
                return;
            }
        }

We can also do the same for the country condition, around line 1650, after $addressDelivery has been declared:

        if($this->context->employee->id_profile == 1) 
        {
            if($addressDelivery->id_country != 21)
            {
                $this->errors[] = Tools::displayError('You are not authorized to see this page.');
                return;
            }
        }

The post Filter orders by employee in the PrestaShop Back Office appeared first on NemoPS.

Watch the Screencast

Text Version

There is just one quick step to take, in order to replace the new odd reference number, and that is amending the generateReference method of the Order class.

Let’s create an override for it! Create a new file inside override/classes/order and name it Order.php.
Add the usual override code inside:

Class Order extends OrderCore
{

}

Then, inside it, let’s paste the generateReference method:

	public static function generateReference()
	{
		return strtoupper(Tools::passwdGen(9, 'NO_NUMERIC'));
	}

We want to grab the very last order ID, then increase it by one, increase it by one and pad it so all the new references have the same length in terms of characters

	public static function generateReference()
	{
		$last_id = Db::getInstance()->getValue('
			SELECT MAX(id_order)
			FROM '._DB_PREFIX_.'orders');
		return str_pad((int)$last_id + 1, 9, '000000000', STR_PAD_LEFT);

	}

The post Quick Tip: Replace Order References with IDs in Prestashop appeared first on NemoPS.

Before proceeding, be aware that this method is not ideal in case you are offering multi shipping (that is, if the same order is associated to multiple carriers and tracking numbers), as it would be set to shipped even if not all of the items have been.

That said, open up AdminOrdersController.php located in the controllers/admin folder. Locate the following:

if (Tools::isSubmit('submitShippingNumber') && isset($order))
		{
			..

Inside this conditional, we are going to plug in our code, and the ideal spot for it would be right before

// Send mail to customer
	$customer = new Customer((int)$order->id_customer);
	$carrier = new Carrier((int)$order->id_carrier, $order->id_lang);

As at this point the tracking number has already been set. Therefore, let’s start by adding some lines of code (my line is around 465, in Prestashop 1.6.0.14:)

$shipped_status = Configuration::get('PS_OS_SHIPPING');
if($order->current_state != $shipped_status && $order->current_state != Configuration::get('PS_OS_CANCELED'))
{
	// todo
}

Explanation: First, we are grabbing the shipped status from the database configuration, then we check that the current order has not been shipped already (it would be redundant to add another identical status!). We also make sure it’s not canceled, to avoid any conflict if we accidentally (or necessarily) update the tracking after canceling an order

Inside our new condition, add

	$history = new OrderHistory();
	$history->id_order = $order->id;
	$history->id_employee = (int)$this->context->employee->id;

	$history->changeIdOrderState((int)$shipped_status, $order);
 

So that we effectively modify the status. Now that the order is changed, we can do two things: sending an extra email to the customer (For the “shipped” status) and updating stock in case we use advanced stock management.

	$carrier = new Carrier($order->id_carrier, $order->id_lang);
	$templateVars = array();
	if ($order->shipping_number)
		$templateVars = array('{followup}' => str_replace('@', $order->shipping_number, $carrier->url));

	if ($history->addWithemail(true, $templateVars))
	{
		if (Configuration::get('PS_ADVANCED_STOCK_MANAGEMENT'))
			foreach ($order->getProducts() as $product)
				if (StockAvailable::dependsOnStock($product['product_id']))
					StockAvailable::synchronize($product['product_id'], (int)$product['id_shop']);
	}	
 

Bear in mind that, if you don’t want to send out any email, you migh as well just paste in the last part:

 	if (Configuration::get('PS_ADVANCED_STOCK_MANAGEMENT'))
			foreach ($order->getProducts() as $product)
				if (StockAvailable::dependsOnStock($product['product_id']))
					StockAvailable::synchronize($product['product_id'], (int)$product['id_shop']);
 

The post Set the order status to Shipped when adding a tracking code in Prestashop appeared first on NemoPS.

• Running Time: 26 mins / 23 mins

Watch the screencast – 1.6 version

Watch the screencast – 1.5 version

All series’ lessons

Prestashop 1.6

• Prestashop 101 Day 1 – Introducing and installing Prestashop
• Prestashop 101 Day 2 – Basic Prestashop Configuration
• Prestashop 101 Day 3 – Prestashop categories and products
• Prestashop 101 Day 4 – Prestashop attributes combinations
• Prestashop 101 Day 5 – Prestashop Upgrade
• Prestashop 101 Day 6 – Prestashop Modules
• Prestashop 101 Day 7 – Prestashop Shipping, Zones and Countries
• Prestashop 101 Day 8 – Taxes, Currencies, Payments
• Prestashop 101 Day 9 – Order Management
• Prestashop 101 Day 10 – Prestashop Customers
• Prestashop 101 Day 11 – Prestashop Discounts (Cart rules)

Prestashop 1.5

• Prestashop 101 Day 1 – Introducing and installing Prestashop
• Prestashop 101 Day 2 – Basic Prestashop Configuration
• Prestashop 101 Day 3 – Prestashop categories and products
• Prestashop 101 Day 4 – Prestashop attributes combinations
• Prestashop 101 Day 5 – Prestashop Upgrade
• Prestashop 101 Day 6 – Prestashop Modules
• Prestashop 101 Day 7 – Prestashop Shipping, Zones and Countries
• Prestashop 101 Day 8 – Taxes, Currencies, Payments
• Prestashop 101 Day 9 – Order Management
• Prestashop 101 Day 10 – Prestashop Customers
• Prestashop 101 Day 11 – Prestashop Discounts (Cart rules)
• Prestashop 101 Day 12 – Prestashop Themes and visual tweaks
• Prestashop 101 Day 13 – Prestashop CMS
• Prestashop 101 Day 14 – Prestashop SEO and Preferences
• Prestashop 101 Day 15 – Prestashop Multistore
• Prestashop 101 Day 16 – Employees and Languages

The post Prestashop 101 Day 9 – Order Management appeared first on NemoPS.

Action Plan

Before starting with any modification, it’s important to have a clear action plan. There are three files we need to amend/extend, in order to paginate the customer order history:

• Order.php (the Order class)
• HistoryController.php (the controller ran in the order history page)
• history.tpl (the template used to display orders)

In terms of hard modifications, we will only be directly editing the history.tpl file (although you can also decide to create a new theme instead of modifying the base one). For the Order class and History controllers we will, as I always recommend, place a couple of overrides. To extend the default functionality. Therefore, if you don’t know much about overrides, have a look at the Official Prestashop Documentation on overrides.

1. Extending the Order Class

Create a new file inside override/classes/Order (or simply override/classes/) and name it Order.php, then paste the following base override code inside php tags:

class Order extends OrderCore
{
}

The method we need to override is Order::GetCustomerOrders, and looks like the following in Prestashop 1.6.0.8:

	public static function getCustomerOrders($id_customer, $showHiddenStatus = false, Context $context = null)
	{
		if (!$context)
			$context = Context::getContext();

		$res = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
		SELECT o.*, (SELECT SUM(od.`product_quantity`) FROM `'._DB_PREFIX_.'order_detail` od WHERE od.`id_order` = o.`id_order`) nb_products
		FROM `'._DB_PREFIX_.'orders` o
		WHERE o.`id_customer` = '.(int)$id_customer.'
		GROUP BY o.`id_order`
		ORDER BY o.`date_add` DESC');
		if (!$res)
			return array();

		foreach ($res as $key => $val)
		{
			$res2 = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
				SELECT os.`id_order_state`, osl.`name` AS order_state, os.`invoice`, os.`color` as order_state_color
				FROM `'._DB_PREFIX_.'order_history` oh
				LEFT JOIN `'._DB_PREFIX_.'order_state` os ON (os.`id_order_state` = oh.`id_order_state`)
				INNER JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$context->language->id.')
			WHERE oh.`id_order` = '.(int)($val['id_order']).(!$showHiddenStatus ? ' AND os.`hidden` != 1' : '').'
				ORDER BY oh.`date_add` DESC, oh.`id_order_history` DESC
			LIMIT 1');

			if ($res2)
				$res[$key] = array_merge($res[$key], $res2[0]);

		}
		return $res;
	}

As you can see, there is no reference whatsoever to any kind of pagination. That’s what we need, so copy the whole method inside the override, then start by adding two extra parameters to the method itself

	public static function getCustomerOrders($id_customer, $showHiddenStatus = false, Context $context = null, $p = 1, $n = 5)
	{
		...
	}

$p will hold the page number, while $n will be the number of orders per page we want to grab. We are also setting defaults as the base method doesn’t have such values, and this would create issues with standard calls.

The next step is to take care of 0 values, just in case, so if $p is 0, for any reason, we set it’s value back to one.

	public static function getCustomerOrders($id_customer, $showHiddenStatus = false, Context $context = null, $p = 1, $n = 5)
	{
		if (!$context)
			$context = Context::getContext();
		if ($p < 1) $p = 1;
		
		$res = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
		SELECT o.*, (SELECT SUM(od.`product_quantity`) FROM `'._DB_PREFIX_.'order_detail` od WHERE od.`id_order` = o.`id_order`) nb_products
		FROM `'._DB_PREFIX_.'orders` o
		WHERE o.`id_customer` = '.(int)$id_customer.'
		GROUP BY o.`id_order`
		ORDER BY o.`date_add` DESC');
		if (!$res)
			return array();

		...

	}

Then, the real deal, let’s limit the $res query results depending on the chosen page:

	public static function getCustomerOrders($id_customer, $showHiddenStatus = false, Context $context = null, $p = 1, $n = 5)
	{
		if (!$context)
			$context = Context::getContext();
		if ($p < 1) $p = 1;
		
		$res = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
		SELECT o.*, (SELECT SUM(od.`product_quantity`) FROM `'._DB_PREFIX_.'order_detail` od WHERE od.`id_order` = o.`id_order`) nb_products
		FROM `'._DB_PREFIX_.'orders` o
		WHERE o.`id_customer` = '.(int)$id_customer.'
		GROUP BY o.`id_order`
		ORDER BY o.`date_add` DESC LIMIT '.(((int)$p - 1) * (int)$n).','.(int)$n );
		if (!$res)
			return array();

		...

	}

The important part here is the LIMIT clause:

...
ORDER BY o.`date_add` DESC LIMIT '.(((int)$p - 1) * (int)$n).','.(int)$n );
...

Which is simply a 1:1 copy of the category pagination code, as it multiplies the current page, minus one, for the number or items per page, and grabs as many of them as specified by the number itself.

This is as far as we need to go for the current override. The final code will look like:

class Order extends OrderCore
{
	
	public static function getCustomerOrders($id_customer, $showHiddenStatus = false, Context $context = null, $p = 1, $n = 5)
	{
		if (!$context)
			$context = Context::getContext();

		if ($p < 1) $p = 1;
		
		$res = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
		SELECT o.*, (SELECT SUM(od.`product_quantity`) FROM `'._DB_PREFIX_.'order_detail` od WHERE od.`id_order` = o.`id_order`) nb_products
		FROM `'._DB_PREFIX_.'orders` o
		WHERE o.`id_customer` = '.(int)$id_customer.'
		GROUP BY o.`id_order`
		ORDER BY o.`date_add` DESC LIMIT '.(((int)$p - 1) * (int)$n).','.(int)$n );
		if (!$res)
			return array();


		foreach ($res as $key => $val)
		{
			$res2 = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
				SELECT os.`id_order_state`, osl.`name` AS order_state, os.`invoice`, os.`color` as order_state_color
				FROM `'._DB_PREFIX_.'order_history` oh
				LEFT JOIN `'._DB_PREFIX_.'order_state` os ON (os.`id_order_state` = oh.`id_order_state`)
				INNER JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$context->language->id.')
			WHERE oh.`id_order` = '.(int)($val['id_order']).(!$showHiddenStatus ? ' AND os.`hidden` != 1' : '').'
				ORDER BY oh.`date_add` DESC, oh.`id_order_history` DESC
			LIMIT 1');

			if ($res2)
				$res[$key] = array_merge($res[$key], $res2[0]);

		}
		return $res;
	}
}

2. Extending the order History Override

This part is the trickiest. We need to add a fair amount of code to this controller, so that all pagination variables are set in the template too. As a first step, let’s create the override itself in override/controllers/front/, declare the base class information, and then paste in the original initContent() method:

class HistoryController extends HistoryControllerCore
{
	
	public function initContent()
	{
		parent::initContent();

		if ($orders = Order::getCustomerOrders($this->context->customer->id))
			foreach ($orders as &$order)
			{
				$myOrder = new Order((int)$order['id_order']);
				if (Validate::isLoadedObject($myOrder))
					$order['virtual'] = $myOrder->isVirtual(false);
			}
		$this->context->smarty->assign(array(
			'orders' => $orders,
			'invoiceAllowed' => (int)(Configuration::get('PS_INVOICE')),
			'reorderingAllowed' => !(int)(Configuration::get('PS_DISALLOW_HISTORY_REORDERING')),
			'slowValidation' => Tools::isSubmit('slowvalidation')
		));

		$this->setTemplate(_PS_THEME_DIR_.'history.tpl');
	}

}

The first thing we want to do is take advantage of our new pagination variables in the getCustomerOrders method:

class HistoryController extends HistoryControllerCore
{
	
	public function initContent()
	{
		parent::initContent();

		$p = Tools::getValue('p');
		$n = 5;


		if ($orders = Order::getCustomerOrders($this->context->customer->id, false, null, $p, $n))
			foreach ($orders as &$order)
			{
				$myOrder = new Order((int)$order['id_order']);
				if (Validate::isLoadedObject($myOrder))
					$order['virtual'] = $myOrder->isVirtual(false);
			}
		...
	}

}

Notice we are hard setting the number of orders per page to 5, using the $n variable.

At this point, we can already test out our modifications. Reach the cache/ folder and erase class_index.php. Some recent versions have a small bug that prevents it from being created. If you run into this issue, try this autoload fix.

Then, reach the order history page and try various settings for $n and $p to see if it works. To test pagination you can also add ?p=3 or any number to the url. Of course, you will get no orders if you go above the total order number with the page.

Setting up pagination in the controller

As we cannot ask customers to input a page number in the url, we need to prepare the template to receive pagination variables. RIght after the previous code, add:

		// to paginate, get the total order number 
		$nb_orders = Order::getCustomerNbOrders($this->context->customer->id);
		$pages_nb = ceil($nb_orders / (int)$n);

		$range = 2; /* how many pages around page selected */
		$start = (int)($p - $range);
		if ($start < 1)
			$start = 1;
		$stop = (int)($p + $range);
		if ($stop > $pages_nb)
			$stop = (int)$pages_nb;

		if (!$p) $p = 1;


		$this->context->smarty->assign(array(
			'pages_nb' => $pages_nb,
			'prev_p' => $p != 1 ? $p - 1 : 1,
			'next_p' => (int)$p + 1  > $pages_nb ? $pages_nb : $p + 1,
			'requestPage' => $this->context->link->getPageLink('history'),
			'p' => $p,
			'n' => $n,
			'range' => $range,
			'start' => $start,
			'stop' => $stop,
		));

Explanation: we are getting some of these pagination variables directly from the default pagination system. We need to know the total number of orders, the number of pages, and the range around the current page for which we can show links (so we are not displaying ALL available pages, but we use dots). Then, we simply assign all these (and a couple more, like the request page, the previous and next numbers.

The final override:

/**
* History Controller Override to allow pagination
*/

class HistoryController extends HistoryControllerCore
{
	
	public function initContent()
	{
		parent::initContent();

		$p = Tools::getValue('p');
		$n = 10;


		if ($orders = Order::getCustomerOrders($this->context->customer->id, false, null, $p, $n))
			foreach ($orders as &$order)
			{
				$myOrder = new Order((int)$order['id_order']);
				if (Validate::isLoadedObject($myOrder))
					$order['virtual'] = $myOrder->isVirtual(false);
			}


		// to paginate, get the total order number 
		$nb_orders = Order::getCustomerNbOrders($this->context->customer->id);
		$pages_nb = ceil($nb_orders / (int)$n);

		$range = 2; /* how many pages around page selected */
		$start = (int)($p - $range);
		if ($start < 1)
			$start = 1;
		$stop = (int)($p + $range);
		if ($stop > $pages_nb)
			$stop = (int)$pages_nb;

		if (!$p) $p = 1;

		$this->context->smarty->assign(array(
			'pages_nb' => $pages_nb,
			'prev_p' => $p != 1 ? $p - 1 : 1,
			'next_p' => (int)$p + 1  > $pages_nb ? $pages_nb : $p + 1,
			'requestPage' => $this->context->link->getPageLink('history'),
			'p' => $p,
			'n' => $n,
			'range' => $range,
			'start' => $start,
			'stop' => $stop,
		));

		$this->context->smarty->assign(array(
			'orders' => $orders,
			'invoiceAllowed' => (int)(Configuration::get('PS_INVOICE')),
			'reorderingAllowed' => !(int)(Configuration::get('PS_DISALLOW_HISTORY_REORDERING')),
			'slowValidation' => Tools::isSubmit('slowvalidation')
		));

		$this->setTemplate(_PS_THEME_DIR_.'history.tpl');
	}

}

Adding pagination to the template

This will be the easiest part. Unless your version is really different (major release) from the one used in this tutorial (1.6.0.8), you should be able to get away with this by simply copying and pasting the provided snippet. First, open up history.tpl, and place the cursor right before

<div id="block-order-detail" class="unvisible">&nbsp;</div>

But after the closing table tag. Then simply paste in the following:

		{if $start!=$stop}
			<ul class="pagination">
				{if $p != 1 && $p}
					{assign var='p_previous' value=$p-1}
					<li id="pagination_previous{if isset($paginationId)}_{$paginationId}{/if}" class="pagination_previous">
						<a rel="nofollow" href="{$requestPage}?p={$prev_p}">
							<i class="icon-chevron-left"></i> <b>{l s='Previous'}</b>
						</a>
					</li>
				{else}
					<li id="pagination_previous{if isset($paginationId)}_{$paginationId}{/if}" class="disabled pagination_previous">
						<span>
							<i class="icon-chevron-left"></i> <b>{l s='Previous'}</b>
						</span>
					</li>
				{/if}
				{if $start==3}
					<li>
						<a rel="nofollow"  href="{$link->goPage($requestPage, 1)}">
							<span>1</span>
						</a>
					</li>
					<li>
						<a rel="nofollow"  href="{$link->goPage($requestPage, 2)}">
							<span>2</span>
						</a>
					</li>
				{/if}
				{if $start==2}
					<li>
						<a rel="nofollow"  href="{$link->goPage($requestPage, 1)}">
							<span>1</span>
						</a>
					</li>
				{/if}
				{if $start>3}
					<li>
						<a rel="nofollow"  href="{$link->goPage($requestPage, 1)}">
							<span>1</span>
						</a>
					</li>
					<li class="truncate">
						<span>
							<span>...</span>
						</span>
					</li>
				{/if}
				{section name=pagination start=$start loop=$stop+1 step=1}
					{if $p == $smarty.section.pagination.index}
						<li class="active current">
							<span>
								<span>{$p|escape:'html':'UTF-8'}</span>
							</span>
						</li>
					{else}
						<li>
							<a rel="nofollow" href="{$link->goPage($requestPage, $smarty.section.pagination.index)}">
								<span>{$smarty.section.pagination.index|escape:'html':'UTF-8'}</span>
							</a>
						</li>
					{/if}
				{/section}
				{if $pages_nb>$stop+2}
					<li class="truncate">
						<span>
							<span>...</span>
						</span>
					</li>
					<li>
						<a href="{$link->goPage($requestPage, $pages_nb)}">
							<span>{$pages_nb|intval}</span>
						</a>
					</li>
				{/if}
				{if $pages_nb==$stop+1}
					<li>
						<a href="{$link->goPage($requestPage, $pages_nb)}">
							<span>{$pages_nb|intval}</span>
						</a>
					</li>
				{/if}
				{if $pages_nb==$stop+2}
					<li>
						<a href="{$link->goPage($requestPage, $pages_nb-1)}">
							<span>{$pages_nb-1|intval}</span>
						</a>
					</li>
					<li>
						<a href="{$link->goPage($requestPage, $pages_nb)}">
							<span>{$pages_nb|intval}</span>
						</a>
					</li>
				{/if}
				{if $pages_nb > 1 AND $p != $pages_nb}
					{assign var='p_next' value=$p+1}
					<li id="pagination_next{if isset($paginationId)}_{$paginationId}{/if}" class="pagination_next">
						<a rel="nofollow" href="{$requestPage}?p={$next_p}">
							<b>{l s='Next'}</b> <i class="icon-chevron-right"></i>
						</a>
					</li>
				{else}
					<li id="pagination_next{if isset($paginationId)}_{$paginationId}{/if}" class="disabled pagination_next">
						<span>
							<b>{l s='Next'}</b> <i class="icon-chevron-right"></i>
						</span>
					</li>
				{/if}
			</ul>
		{/if}

And save. It’s a bit troublesome to explain everything going on here. It’s basically a 1:1 copy from the default pagination, where I removed most of the useless variables.

Make sure the order number is more than the orders per page you setup in the controller, or pagination will not show up!

The post Adding pagination to the Prestashop Order History appeared first on NemoPS.

Introduction

Last year, we saw how to filter by country in the Prestashop order list, which is indeed useful when your customer base is spread around the world. Today, we will add another parameter to the orders table, showing us which products are part of the order, effectively saving us a lot of time in many situations when we only need to know what is to be shipped.

One override will be enough to achieve this result: AdminOrdersController.

Overriding the AdminOrdersController

To start off, create a new file in override/controllers/admin and call it AdminOrderController.php. We need to override the construct method; therefore start by adding the following inside php tags:

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{

	}
}

If you don’t know anything about overrides, have a look at how to override Prestashop classes and controllers at Prestashop’s Doc.

Now let’s add some base parameter. Have a look at your own original AdminOrdersController file (controllers/admin) if you use a version different from 1.5.6.x.

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{
		$this->table = 'order';
		$this->className = 'Order';
		$this->lang = false;
		$this->addRowAction('view');
		$this->explicitSelect = true;
		$this->allow_export = true;
		$this->deleted = false;
		$this->context = Context::getContext();
	}
}

We didn’t do anything special here, just setting up the module’s basics by copying the original method. Time to extend the SELECT statement!

Selecting products within the order query

Right after the object definition we added before, we need to extend the $this->_select variable in order to grab products as well. Here is how it looks in the original order controller:

	$this->_select = '
		a.id_currency,
		a.id_order AS id_pdf,
		CONCAT(LEFT(c.`firstname`, 1), \'. \', c.`lastname`) AS `customer`,
		osl.`name` AS `osname`,
		os.`color`,
		IF((SELECT COUNT(so.id_order) FROM `'._DB_PREFIX_.'orders` so WHERE so.id_customer = a.id_customer) > 1, 0, 1) as new';

So, grab this, add it after the last lines we wrote, and change it to:

		$this->_select = '
		a.id_currency,
		a.id_order AS id_pdf,
		CONCAT(LEFT(c.`firstname`, 1), \'. \', c.`lastname`) AS `customer`,
		osl.`name` AS `osname`,
		os.`color`,
		(SELECT GROUP_CONCAT(odd.product_name SEPARATOR ", ") FROM `'._DB_PREFIX_.'order_detail` odd WHERE odd.id_order = a.id_order) as products,
		IF((SELECT COUNT(so.id_order) FROM `'._DB_PREFIX_.'orders` so WHERE so.id_customer = a.id_customer) > 1, 0, 1) as new';

As you can see, we added: (SELECT GROUP_CONCAT(odd.product_name SEPARATOR “, “) FROM `’._DB_PREFIX_.’order_detail` odd WHERE odd.id_order = a.id_order) as products,. This is the subquery that will grab products from the order_detail table, given that the order id is the current one, of course! Using GROUP_CONCAT will ensure all products will br shown, separated by a comma and space. You can use any separator you prefer, of course.

Our override so far:

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{
		$this->table = 'order';
		$this->className = 'Order';
		$this->lang = false;
		$this->addRowAction('view');
		$this->explicitSelect = true;
		$this->allow_export = true;
		$this->deleted = false;
		$this->context = Context::getContext();

		$this->_select = '
		a.id_currency,
		a.id_order AS id_pdf,
		CONCAT(LEFT(c.`firstname`, 1), \'. \', c.`lastname`) AS `customer`,
		osl.`name` AS `osname`,
		os.`color`,
		(SELECT GROUP_CONCAT(odd.product_name SEPARATOR ", ") FROM `'._DB_PREFIX_.'order_detail` odd WHERE odd.id_order = a.id_order) as products,
		IF((SELECT COUNT(so.id_order) FROM `'._DB_PREFIX_.'orders` so WHERE so.id_customer = a.id_customer) > 1, 0, 1) as new';

}

We don’t need extra stuff for the query, so right after the select variable, add:

		$this->_join = '
		LEFT JOIN `'._DB_PREFIX_.'customer` c ON (c.`id_customer` = a.`id_customer`)
		LEFT JOIN `'._DB_PREFIX_.'order_state` os ON (os.`id_order_state` = a.`current_state`)
		LEFT JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$this->context->language->id.')';
		$this->_orderBy = 'id_order';
		$this->_orderWay = 'DESC';

		$statuses_array = array();
		$statuses = OrderState::getOrderStates((int)$this->context->language->id);

		foreach ($statuses as $status)
			$statuses_array[$status['id_order_state']] = $status['name'];

In any casy, copy everything after your original controller’s select variable, down to before $this->fields_list.

Let’s now more to showing products!

Displaying the selected products

To add new fields in the orders table, we need to extend $this->fields_list. Therefore, grab the definition from the original controller, and paste it after the last foreach we added. On 1.5.6.x, it looks like this:

		$this->fields_list = array(
		'id_order' => array(
			'title' => $this->l('ID'),
			'align' => 'center',
			'width' => 25
		),
		'reference' => array(
			'title' => $this->l('Reference'),
			'align' => 'center',
			'width' => 65
		),
		'new' => array(
			'title' => $this->l('New'),
			'width' => 25,
			'align' => 'center',
			'type' => 'bool',
			'tmpTableFilter' => true,
			'icon' => array(
				0 => 'blank.gif',
				1 => array(
					'src' => 'note.png',
					'alt' => $this->l('First customer order'),
				)
			),
			'orderby' => false
		),
		'customer' => array(
			'title' => $this->l('Customer'),
			'havingFilter' => true,
		),
		'total_paid_tax_incl' => array(
			'title' => $this->l('Total'),
			'width' => 70,
			'align' => 'right',
			'prefix' => '<b>',
			'suffix' => '</b>',
			'type' => 'price',
			'currency' => true
		),
		'payment' => array(
			'title' => $this->l('Payment: '),
			'width' => 100
		),
		'osname' => array(
			'title' => $this->l('Status'),
			'color' => 'color',
			'width' => 280,
			'type' => 'select',
			'list' => $statuses_array,
			'filter_key' => 'os!id_order_state',
			'filter_type' => 'int',
			'order_key' => 'osname'
		),
		'date_add' => array(
			'title' => $this->l('Date'),
			'width' => 130,
			'align' => 'right',
			'type' => 'datetime',
			'filter_key' => 'a!date_add'
		),
		'id_pdf' => array(
			'title' => $this->l('PDF'),
			'width' => 35,
			'align' => 'center',
			'callback' => 'printPDFIcons',
			'orderby' => false,
			'search' => false,
			'remove_onclick' => true)
		);

Where to add the product list? I chose to add it right after the customer name. We have to add the new field as an array, like this:

		'products' => array(
			'title' => $this->l('Products'),
			'havingFilter' => true,
			'filter_key' => 'products',
			'width' => 370,
		),	

In the order, we have the column title (of little importance, it’s the one shown to the viewer); the possibility to filter by those parameters; the name of the filter key (caution! it must be the same as the name of the parameter we grabbed in the select statement!); the column width in pixels.

At this point, add it to the array:

		$this->fields_list = array(
		'id_order' => array(
			'title' => $this->l('ID'),
			'align' => 'center',
			'width' => 25
		),
		'reference' => array(
			'title' => $this->l('Reference'),
			'align' => 'center',
			'width' => 65
		),
		'new' => array(
			'title' => $this->l('New'),
			'width' => 25,
			'align' => 'center',
			'type' => 'bool',
			'tmpTableFilter' => true,
			'icon' => array(
				0 => 'blank.gif',
				1 => array(
					'src' => 'note.png',
					'alt' => $this->l('First customer order'),
				)
			),
			'orderby' => false
		),
		'customer' => array(
			'title' => $this->l('Customer'),
			'havingFilter' => true,
		),
		'products' => array(
			'title' => $this->l('Products'),
			'havingFilter' => true,
			'filter_key' => 'products',
			'width' => 370,
		),	
		'total_paid_tax_incl' => array(
			'title' => $this->l('Total'),
			'width' => 70,
			'align' => 'right',
			'prefix' => '<b>',
			'suffix' => '</b>',
			'type' => 'price',
			'currency' => true
		),
		'payment' => array(
			'title' => $this->l('Payment: '),
			'width' => 100
		),
		'osname' => array(
			'title' => $this->l('Status'),
			'color' => 'color',
			'width' => 280,
			'type' => 'select',
			'list' => $statuses_array,
			'filter_key' => 'os!id_order_state',
			'filter_type' => 'int',
			'order_key' => 'osname'
		),
		'date_add' => array(
			'title' => $this->l('Date'),
			'width' => 130,
			'align' => 'right',
			'type' => 'datetime',
			'filter_key' => 'a!date_add'
		),
		'id_pdf' => array(
			'title' => $this->l('PDF'),
			'width' => 35,
			'align' => 'center',
			'callback' => 'printPDFIcons',
			'orderby' => false,
			'search' => false,
			'remove_onclick' => true)
		);

We are almost done!

Finishing off the override

The rest of the override is basically identical to the original file, so from that one, grab everything you find after the fields list in the construct method, and paste it into the override:

		$this->shopLinkType = 'shop';
		$this->shopShareDatas = Shop::SHARE_ORDER;

		if (Tools::isSubmit('id_order'))
		{
			// Save context (in order to apply cart rule)
			$order = new Order((int)Tools::getValue('id_order'));
			if (!Validate::isLoadedObject($order))
				throw new PrestaShopException('Cannot load Order object');
			$this->context->cart = new Cart($order->id_cart);
			$this->context->customer = new Customer($order->id_customer);
		}

		parent::__construct();

Lastly, since we don’t want our new fields list to be overridden by the original one, change parent::__construct(); to AdminController::__construct.

Save, go to cache/ and delete the class_index.php file so that our override can take place. We are done!

The final override

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{
		$this->table = 'order';
		$this->className = 'Order';
		$this->lang = false;
		$this->addRowAction('view');
		$this->explicitSelect = true;
		$this->allow_export = true;
		$this->deleted = false;
		$this->context = Context::getContext();

		$this->_select = '
		a.id_currency,
		a.id_order AS id_pdf,
		CONCAT(LEFT(c.`firstname`, 1), \'. \', c.`lastname`) AS `customer`,
		osl.`name` AS `osname`,
		os.`color`,
		(SELECT GROUP_CONCAT(odd.product_name SEPARATOR ", ") FROM `'._DB_PREFIX_.'order_detail` odd WHERE odd.id_order = a.id_order) as products,
		IF((SELECT COUNT(so.id_order) FROM `'._DB_PREFIX_.'orders` so WHERE so.id_customer = a.id_customer) > 1, 0, 1) as new';


		$this->_join = '
		LEFT JOIN `'._DB_PREFIX_.'customer` c ON (c.`id_customer` = a.`id_customer`)
		LEFT JOIN `'._DB_PREFIX_.'order_state` os ON (os.`id_order_state` = a.`current_state`)
		LEFT JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$this->context->language->id.')';
		$this->_orderBy = 'id_order';
		$this->_orderWay = 'DESC';

		$statuses_array = array();
		$statuses = OrderState::getOrderStates((int)$this->context->language->id);

		foreach ($statuses as $status)
			$statuses_array[$status['id_order_state']] = $status['name'];



		$this->fields_list = array(
		'id_order' => array(
			'title' => $this->l('ID'),
			'align' => 'center',
			'width' => 25
		),
		'reference' => array(
			'title' => $this->l('Reference'),
			'align' => 'center',
			'width' => 65
		),
		'new' => array(
			'title' => $this->l('New'),
			'width' => 25,
			'align' => 'center',
			'type' => 'bool',
			'tmpTableFilter' => true,
			'icon' => array(
				0 => 'blank.gif',
				1 => array(
					'src' => 'note.png',
					'alt' => $this->l('First customer order'),
				)
			),
			'orderby' => false
		),
		'customer' => array(
			'title' => $this->l('Customer'),
			'havingFilter' => true,
		),
		'products' => array(
			'title' => $this->l('Products'),
			'havingFilter' => true,
			'filter_key' => 'products',
			'width' => 370,
		),	
		'total_paid_tax_incl' => array(
			'title' => $this->l('Total'),
			'width' => 70,
			'align' => 'right',
			'prefix' => '<b>',
			'suffix' => '</b>',
			'type' => 'price',
			'currency' => true
		),
		'payment' => array(
			'title' => $this->l('Payment: '),
			'width' => 100
		),
		'osname' => array(
			'title' => $this->l('Status'),
			'color' => 'color',
			'width' => 280,
			'type' => 'select',
			'list' => $statuses_array,
			'filter_key' => 'os!id_order_state',
			'filter_type' => 'int',
			'order_key' => 'osname'
		),
		'date_add' => array(
			'title' => $this->l('Date'),
			'width' => 130,
			'align' => 'right',
			'type' => 'datetime',
			'filter_key' => 'a!date_add'
		),
		'id_pdf' => array(
			'title' => $this->l('PDF'),
			'width' => 35,
			'align' => 'center',
			'callback' => 'printPDFIcons',
			'orderby' => false,
			'search' => false,
			'remove_onclick' => true)
		);

		$this->shopLinkType = 'shop';
		$this->shopShareDatas = Shop::SHARE_ORDER;

		if (Tools::isSubmit('id_order'))
		{
			// Save context (in order to apply cart rule)
			$order = new Order((int)Tools::getValue('id_order'));
			if (!Validate::isLoadedObject($order))
				throw new PrestaShopException('Cannot load Order object');
			$this->context->cart = new Cart($order->id_cart);
			$this->context->customer = new Customer($order->id_customer);
		}

		AdminController::__construct();
	}
}

Additional Resources

• How to filter by country in the Prestashop order list
• How to override Prestashop classes and controllers at Prestashop’s Doc.

The post Add bought products to the Prestashop Order list in the back office appeared first on NemoPS.

• Compatibility: Prestashop 1.5

Why asking customers if they received an order?

Depending on the type of business you run, you might want to be sure some items have actually been delivered to your customers, whether you ship with tracked carriers or free postage (without tracking number).

Unless you integrated the carrier’s API into Prestashop, so that an order status can automatically be updated upon destination reach (impossible in the latter case, anyway), you’d find yourself having to manually check each and every order, to make sure it has actually been received. Giving customers the chance to manually notify themselves whether an order was delivered or not can save us a huge amount of time, and partially overcome the non-tracked carrier’s flaws.

In this tutorial, we will make use of one override, and modify 2 theme files. Specifically:

• OrderDetailController Override
• order-detail.tpl
• history.js

We will make use of the default order statuses Shipped and Delivered for the given example, but feel free to use your own, keeping in mind their ids as we add the necessary code snippets.

Next thing to notice is that, by default, the order detail page is grabbed using javascript, directly from the history page, and thus we have to account for an ajax call that points to the controller override.

Lastly, please note that the following applies to registered customers only, not to guests.

Step 1 – Adding the “I received this order” button

The very first thing we need to do is add some kind of button the customer can click. The ideal page for this is, of course, the order detail one, which can be accessed via the user account panel:

As you can see, this order has been shipped already, and thus the customer should be able to tell us if it was delivered or not. Since there is a step-by-step order follow section already, let’s add our button there. After making sure you got a theme’s backup in case of failure, open order-detail.tpl, located, in my case, in themes/default/.

Look for:

<h3>{l s='Follow your order\'s status step-by-step'}</h3>

And add the following right after, but before the table_block div:

{if $order_history.0.id_order_state == 4}
	<form action="{$link->getPageLink('order-detail', true)|escape:'html'}" method="post" class="std" id="markAsReceived">
		<input type="hidden" class="hidden" value="{$order->id|intval}" name="id_order" />
		<input type="submit" class="exclusive" name="markAsReceived" id="markAsReceivedBtn" value="{l s='I have received this order'}">
		<p class="clear"></p>
	</form>

{/if}

Explanation: Remember we mentioned the default order statuses at the beginning of the article? Well, in this conditional if statement, we are taking advantage of the Shipped status, which has 4 as status ID. Therefore, customers will only see the button if the current order has been set to Shipped. We access it using the variable $order_history, which is an array. Therefore, we get the most recent element’s status (which is the first one of the stack).
Then, we open a form that points to the order-detail page (and relative controller), so that our markAsReceived parameter is sent to it. We also need to pass the order id to this form, as the system needs to know which order’s status needs to be updated later.

We are basically done with the template part. We’ll come back later to add a confirmation message upon successful order status change.

How to check order status IDs?

If you do not wish to use the default statuses, you can easily create your own, and check their IDs from the back office Orders > Statuses.

The IDs are, needless to say, the ones under the ID column.

Step 2 – OrderDetailController override

Create a new php file in override/controllers/front and call it OrderDetailController.php. Inside it, add the following within php tags:

class OrderDetailController extends OrderDetailControllerCore
{

	public function postProcess()
	{
		parent::postProcess();

		if (Tools::isSubmit('markAsReceived'))
		{
			$idOrder = (int)(Tools::getValue('id_order'));
			$order = new Order($idOrder);

			if(Validate::isLoadedObject($order))
			{
				if($order->getCurrentState() == 4) // if the order is shipped
				{
					$new_history = new OrderHistory();
					$new_history->id_order = (int)$order->id;
					$new_history->changeIdOrderState(5, $order); // 5: delivered
					$new_history->addWithemail(true);	
				}

				$this->context->smarty->assign('receipt_confirmation', true);

			} else $this->_errors[] = Tools::displayError('Error: Invalid order number');
			
		}		

	}


}

Explanation: uh, quite a heavy jump! However, nothing special here, really. We are overriding the core’s postProcess method, which occurs right after having loaded the controller’s basic properties, so that other data can be collected and stored. In this case, we first make sure to refer back to the original postProcess(), then check if our markAsReceived button has been pressed.
If it has, we grab the order ID we passed, then create a new order object using it. It’s fundamental to always make sure a Prestashop Object was correctly loaded every time, using Validate::isLoadedObject($object).

If it is a valid object, and then if the current state is shipped (ID = 4) we can add a new order status. To do this, we use the OrderHistory class, setting the current order id ($new_history->id_order = (int)$order->id;) and then changing its status to 5 (delivered). Lastly, we submit the order change with $new_history->addWithemail(true). In case an email is to be sent out, it will. After this, we confirm the order has been received and assign a variable to the template, in order to show a confirmation message.

On the other end, we display an error in case the order object was not valid, for any reason.

At this point, we can already test out the form. But remember to delete the class_index file, located inside the /cache/ folder first, for the override to take place.

If you did everything correctly, the whole page will be refreshed, redirecting you to the order-detail controller, but with the ‘delivered’ status added.

“It’s fundamental to always make sure a Prestashop Object was correctly loaded every time, using Validate::isLoadedObject($object)”

The confirmation message

As we want to be polite to our customers, right before the form we added to order-detail.tpl, insert the following snippets, to thank them for their feedback.

{if isset($receipt_confirmation) && $receipt_confirmation}
	<p class="success">
		{l s='Thank you for your feedback!'}
	</p>
{/if}

So it looks like:

<h3>{l s='Follow your order\'s status step-by-step'}</h3>
{if isset($receipt_confirmation) && $receipt_confirmation}
	<p class="success">
		{l s='Thank you for your feedback!'}
	</p>
{/if}
{if $order_history.0.id_order_state == 4}
	<form action="{$link->getPageLink('order-detail', true)|escape:'html'}" method="post" class="std" id="markAsReceived">


		<input type="hidden" class="hidden" value="{$order->id|intval}" name="id_order" />
		<input type="submit" class="exclusive" name="markAsReceived" id="markAsReceivedBtn" value="{l s='I have received this order'}">
		<p class="clear"></p>
	</form>

{/if}

We could stop here; however, to give our customers a better user experience, we will integrate this button to the ajax style of the order history page.

Step 3 – Adding some Ajax to history.js

Open up history.js, located in the theme folder, /js/. We have to catch the submit event of the new form first. a suitable place for this is right after the following:

				$('form#sendOrderMessage').submit(function(){
					return sendOrderMessage();
				
				});

That catches the submission of the “Send a message” form. You can find it at line 73 in Prestashop 1.5.6.2. Right after, add:

				$('form#markAsReceived').submit(function(){
					return markAsReceived();
				});

Okay, we are returning a function instead of submitting the page. We don’t have it yet, so let’s use the sendOrderMessage() one as a base for ours. Add this at the end of the file:

				
function markAsReceived()
{
	paramString = "ajax=true";
	$('#markAsReceived').find('input').each(function(){
		paramString += '&' + $(this).attr('name') + '=' + encodeURIComponent($(this).val());
	});
	$.ajax({
		type: "POST",
		headers: { "cache-control": "no-cache" },
		url: $('#markAsReceived').attr("action") + '?rand=' + new Date().getTime(),
		data: paramString,
		success: function (msg){
			$('#block-order-detail').fadeOut('slow', function() {
				$(this).html(msg);
				//catch the submit event of sendOrderMessage form
				
				$(this).find('#markAsReceivedBtn').fadeOut;
				$(this).fadeIn('slow');
			});
		}
	});
	return false;
}

Explanation: despite having a scary look, there is not much going on under the hood. We first tell the script we will be using ajax, then add each parameter in the form to the POST call we’ll do. In this case, they will be markAsReceived and id_order, as we need them in the controller.
Then, we do an ajax call to our override (the url being called is the same of the action property of the form!), passing a random parameter to avoid duplicate calls. At this point, all the previously mentioned operations occur. Upon success, we fade out the entire order detail block, change its content with the one retrieved from the ajax call, fade out the mark as received button and show the order detail block again. Don’t forget to return false, or call e.preventDefault() at the end, to avoid the page refresh!

Save & test, no page refresh will now occur anymore!

TIP: instead of creating dozens of new orders for testing purposes, after the status is set to delivered, take it back to shipped so our button is visible again! (as i did in the following image)

Conclusion

Customers can now inform us when they receive an order. However, an ideal extension to this would be an automated system that sends out emails to all customers who have “shipped” but not “delivered” orders. Well, we might do it in another tutorial!

The post Adding a “I received my order” button in Prestashop appeared first on NemoPS.

• Version used: Prestashop 1.5.6

Once more, in this tutorial we will make use of overrides. To be specific, we will extend the AdminOrdersController constructor to first grab all the country related data from our database, and then display the new column. To make some room, we will get rid of the invoice column, but feel free to simply add the new one, if you need that, or even replace another which is not useful to you. Let’s get started!

Extending the AdminOrders Controller

As I always want to stress, when adding new functions to Prestashop, it’s fundamental not to touch the core, to avoid loosing all modifications at the next upgrade. Therefore, head over to override/controllers/admin and create a new file called AdminOrdersController.php. Go back to Prestashop’s root folder, then cache/ and delete class_index.php to make sure our beloved e-commerce software can read the new override.

Back to the new file, let’s start by adding some preliminary class code inside php tags:

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{
		AdminController::__construct();
	}
}

Note: As you can see, we are calling the current class’s grandfather, instead of direct parent. Why? If we were to use parent::_construct, the original adminOrdersController data and settings would have overridden again our modifications, which would have never taken place. Thus, we skip the call to the original class constructor and call AdminController::__construct directly.

At this point, if you visit the order list page, you will have nothing but a blank page. Don’t freak out! this is just the beginning.

Grabbing all data we need for the new column

Now, let’s copy a bunch of properties from the original AdminOrdersController:

class AdminOrdersController extends AdminOrdersControllerCore
{

	public function __construct()
	{
		$this->table = 'order';
		$this->className = 'Order';
		$this->lang = false;
		$this->addRowAction('view');
		$this->explicitSelect = true;
		$this->allow_export = true;
		$this->deleted = false;
		$this->context = Context::getContext();

		
		AdminController::__construct();
	}

}

Make sure the grandpa’s call stays at the very bottom of the constructor! Then, it’s time to tell this class which fields we want to grab. It’s pretty much the same as the default, with a slight addition. Add the following right before the grandfather’s constructor’s call:

		$this->_select = '
		a.id_currency,
		a.id_order AS id_pdf,
		cl.name as country,
		CONCAT(LEFT(c.`firstname`, 1), \'. \', c.`lastname`) AS `customer`,
		osl.`name` AS `osname`,
		os.`color`,
		IF((SELECT COUNT(so.id_order) FROM `'._DB_PREFIX_.'orders` so WHERE so.id_customer = a.id_customer) > 1, 0, 1) as new';

The only addition here is cl.name as country,. Now, we need to join all tables we need, of course!

		$this->_join = '
		LEFT JOIN `'._DB_PREFIX_.'customer` c ON (c.`id_customer` = a.`id_customer`)
		LEFT JOIN `'._DB_PREFIX_.'address` ad ON (ad.`id_address` = a.`id_address_delivery`)
		LEFT JOIN `'._DB_PREFIX_.'country_lang` cl ON (cl.`id_country` = ad.`id_country` AND cl.`id_lang` = '.(int)$this->context->language->id.')
		LEFT JOIN `'._DB_PREFIX_.'order_state` os ON (os.`id_order_state` = a.`current_state`)
		LEFT JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$this->context->language->id.')';

Compared to the original one, this has two new joins:

		$this->_join = '
		LEFT JOIN `'._DB_PREFIX_.'address` ad ON (ad.`id_address` = a.`id_address_delivery`)
		LEFT JOIN `'._DB_PREFIX_.'country_lang` cl ON (cl.`id_country` = ad.`id_country` AND cl.`id_lang` = '.(int)$this->context->language->id.')

Why do we need two? Because, as the first table we are grabbing data from is ps_orders, whose alias is a, we only have access to the address ID (id_address_delivery). This tells us which address the customer used to checkout. I deliberately chose this one, but you can use id_address_invoice instead, if you prefer. At this point, having the address id, we grab the country associated to this very address, by joining the ps_country_lang table to get the real name of it.

So, the logical ‘table lookup’ to get the country name is ps_orders.id_address_delivery » ps_address.id_address – ps_address.id_country » ps_country_lang.id_country – ps_country_lang.name.

We have all data we need, what’s left at this point is copying a bunch of rows from the original controller, and add the new column to the fields list.

Adding the new column to the fields_list

First things first, right after the last code snippet, add the following, grabbed directly from the original AdminOrdersController:

		$this->_orderBy = 'id_order';
		$this->_orderWay = 'DESC';

		$statuses_array = array();
		$statuses = OrderState::getOrderStates((int)$this->context->language->id);

		foreach ($statuses as $status)
			$statuses_array[$status['id_order_state']] = $status['name'];


		$this->fields_list = array(
		'id_order' => array(
			'title' => $this->l('ID'),
			'align' => 'center',
			'width' => 25
		),
		'reference' => array(
			'title' => $this->l('Reference'),
			'align' => 'center',
			'width' => 65
		),
		'new' => array(
			'title' => $this->l('New'),
			'width' => 25,
			'align' => 'center',
			'type' => 'bool',
			'tmpTableFilter' => true,
			'icon' => array(
				0 => 'blank.gif',
				1 => array(
					'src' => 'note.png',
					'alt' => $this->l('First customer order'),
				)
			),
			'orderby' => false
		),
		'customer' => array(
			'title' => $this->l('Customer'),
			'havingFilter' => true,
		),
		'total_paid_tax_incl' => array(
			'title' => $this->l('Total'),
			'width' => 70,
			'align' => 'right',
			'prefix' => '<b>',
			'suffix' => '</b>',
			'type' => 'price',
			'currency' => true
		),
		'payment' => array(
			'title' => $this->l('Payment: '),
			'width' => 100
		),
		'osname' => array(
			'title' => $this->l('Status'),
			'color' => 'color',
			'width' => 280,
			'type' => 'select',
			'list' => $statuses_array,
			'filter_key' => 'os!id_order_state',
			'filter_type' => 'int'
		),
		'date_add' => array(
			'title' => $this->l('Date'),
			'width' => 130,
			'align' => 'right',
			'type' => 'datetime',
			'filter_key' => 'a!date_add'
		),
		'id_pdf' => array(
			'title' => $this->l('PDF'),
			'width' => 35,
			'align' => 'center',
			'callback' => 'printPDFIcons',
			'orderby' => false,
			'search' => false,
			'remove_onclick' => true)
		);

The important part to notice here is the fields_list assignment. This contains all columns of the order table, and tells to each one how to behave. As mentioned at the beginning of the tutorial, I will get rid of the last field, id_pdf, in order to make some room for countries. Once more, feel free to simply add the new one.

Here is the array that needs to be added:

'country' => array(
			'title' => $this->l('CT'),
			'width' => 60,
			'align' => 'center',
			'filter_key' => 'cl!name')

Explanation: For lists of objects in the back office, Prestashop uses its own helper to build the table. Each of the keys of the fields_list array is the name property of the input box, which will be used to filter this column. Of course, provided that you actually want to filter it. The array values determine properties for the table column, in this case: the text displayed at the top, the column’s width, whether the text needs to be centered, and the name of the key I want to use as filter. As I mentioned a couple of lines above, by default Prestashop uses the array key to look for a value to filter. If we specify a filter_key in the values array, we can alter the lookup to our content. In this case, if somebody enters a value, say ‘Italy’ for the country column, and hits filter, Prestashop will look for ‘Italy’ in cl.name (notice an exclamation mark must be used in place of the dot here). Simply put: the filter_key value must reflect the database field you want to target when filtering. Once more, in this case, the Country Name.

“For lists of objects in the back office, Prestashop uses its own helper to build the table. ”

Going through all the properties of the table helper is beyond the scope of this tutorial, but if you want to dive into it, I suggest you have a look at the various admin controllers Prestashop has, especially the product and category ones. Unfortunately, there is no real documentation about this subject, except for a few lines on using templates for helpers within a controller at doc.prestashop.com.

In any case, here is how the fields_list should look after adding our own dataset:

		$this->fields_list = array(
		'id_order' => array(
			'title' => $this->l('ID'),
			'align' => 'center',
			'width' => 25
		),
		'reference' => array(
			'title' => $this->l('Reference'),
			'align' => 'center',
			'width' => 65
		),
		'new' => array(
			'title' => $this->l('New'),
			'width' => 25,
			'align' => 'center',
			'type' => 'bool',
			'tmpTableFilter' => true,
			'icon' => array(
				0 => 'blank.gif',
				1 => array(
					'src' => 'note.png',
					'alt' => $this->l('First customer order'),
				)
			),
			'orderby' => false
		),
		'customer' => array(
			'title' => $this->l('Customer'),
			'havingFilter' => true,
		),
		'total_paid_tax_incl' => array(
			'title' => $this->l('Total'),
			'width' => 70,
			'align' => 'right',
			'prefix' => '<b>',
			'suffix' => '</b>',
			'type' => 'price',
			'currency' => true
		),
		'payment' => array(
			'title' => $this->l('Payment: '),
			'width' => 100
		),
		'osname' => array(
			'title' => $this->l('Status'),
			'color' => 'color',
			'width' => 280,
			'type' => 'select',
			'list' => $statuses_array,
			'filter_key' => 'os!id_order_state',
			'filter_type' => 'int'
		),
		'date_add' => array(
			'title' => $this->l('Date'),
			'width' => 130,
			'align' => 'right',
			'type' => 'datetime',
			'filter_key' => 'a!date_add'
		),
		'country' => array(
			'title' => $this->l('CT'),
			'width' => 60,
			'align' => 'center',
			'filter_key' => 'cl!name')
		);

We are done, as the only thing left is to copy over a tiny snippet grabbed directly from the original controller, right after the fields_list:

		$this->shopLinkType = 'shop';
		$this->shopShareDatas = Shop::SHARE_ORDER;

		if (Tools::isSubmit('id_order'))
		{
			// Save context (in order to apply cart rule)
			$order = new Order((int)Tools::getValue('id_order'));
			if (!Validate::isLoadedObject($order))
				throw new PrestaShopException('Cannot load Order object');
			$this->context->cart = new Cart($order->id_cart);
			$this->context->customer = new Customer($order->id_customer);
		}

Save, reload the page and try to filter the column. We are done!

The post Filtering by country on the Prestashop order list appeared first on NemoPS.