The post Display products from subcategories in PrestaShop 1.6 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.

Overriding the Top Horizontal Menu Module

To make our modification scalable and have it preserve in future upgrades, of not only PrestaShop, but the module itself, we will create an override of it. Please notice overrides are only available for version 1.6.0.11 and newer. If you are using an older PrestaShop version, you will have to amend the core files directly.

Create a new folder named blocktopmenu inside override/modules. Within it, create a new file and name it blocktopmenu.php. Open it up in your favorite code editor and add some generic override code inside php tags:

class BlockTopMenuOverride extends BlockTopMenu
{

}

We want to override a method named generateCategoriesMenu. It’s a protected function so we can easily extend it. Make sure you copy and paste the original one from your module here, as mine might differ even slightly:

	protected function generateCategoriesMenu($categories, $is_children = 0)
	{
		$html = '';

		foreach ($categories as $key => $category)
		{
			if ($category['level_depth'] > 1)
			{
				$cat = new Category($category['id_category']);
				$link = Tools::HtmlEntitiesUTF8($cat->getLink());
			}
			else
				$link = $this->context->link->getPageLink('index');

			$html .= '<li'.(($this->page_name == 'category'
				&& (int)Tools::getValue('id_category') == (int)$category['id_category']) ? ' class="sfHoverForce"' : '').'>';
			$html .= '<a href="'.$link.'" title="'.$category['name'].'">'.$category['name'].'</a>';

			if ($category['level_depth'] < 4 && isset($category['children']) && !empty($category['children']))
			{
				$html .= '<ul>';
				$html .= $this->generateCategoriesMenu($category['children'], 1);

				if ((int)$category['level_depth'] > 1 && !$is_children)
				{
					$files = scandir(_PS_CAT_IMG_DIR_);

					if (count($files) > 0)
					{
						$html .= '<li class="category-thumbnail">';

						foreach ($files as $file)
							if (preg_match('/^'.$category['id_category'].'-([0-9])?_thumb.jpg/i', $file) === 1)
								$html .= '<div><img src="'.$this->context->link->getMediaLink(_THEME_CAT_DIR_.$file)
								.'" alt="'.Tools::SafeOutput($category['name']).'" title="'
								.Tools::SafeOutput($category['name']).'" class="imgm" /></div>';

						$html .= '</li>';
					}
				}

				$html .= '</ul>';
			}

			$html .= '</li>';
		}

		return $html;
	}

We are interested in the following line:

			$html .= '<a href="'.$link.'" title="'.$category['name'].'">'.$category['name'].'</a>';

Which is the one responsible for displaying the link to each category. However, if we were to remove the anchor as it is, it would get rid of all the links, and we want to keep the ones inside mega menus. We need to add a condition that first checks we are dealing with our top level. How can we do it?
The most logical way would be to check the “level_depth” property of the current category. This might work, in case your top menu categories all belong to the same depth level.

However, we can use another, more reliable variable: $is_children. It’s passed to each iteration of the loop used to generate the category tree, and checks whether we are in the top level or not, so it’s ideal for our purpose. Knowing that, we can replace the previous line with some logic:

if ($is_children == 0)
	$html .= '<a>'.$category['name'].'</a>';
else
	$html .= '<a href="'.$link.'" title="'.$category['name'].'">'.$category['name'].'</a>';

Please notice it needs an anchor wrapper in any case, to retain its style. Save the override, then reach the cache folder and get rid of class_index.php so that the override takes place. Depending on your configuration, you might as well need to go to Advanced Parameters, Performance, and clear cache.

The post Removing links from the top level in the PrestaShop top Menu 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.

• Prestashop version: any 1.6 (used: 1.6.0.9, should equally apply to 1.5, though not tested)

Introduction

Before starting, it’s worth noticing this tutorial implies quite a lot of modifications and overrides, and it’s therefore recommended that you have a solid knowledge of php before doing anything. As always, refer to the Official Prestashop documentation on Overrides if you are new to the subject. That said, these are the files we need to override/modify:

• AdminCategoriesController.php: here is where most of the magic will occur, to upload and delete the new image
• Category.php: the category class, as we have to implement the new field and image file deletion
• category.tpl: to display the new image for subcategories
• .htaccess: only needed if you use Friendly urls, otherwise no image will be shown

Extending the AdminCategoriesController file

The categories’ admin controller is the file we will be mostly dealing with. Although we could modify it directly, it’s always best practice to use an override. Therefore, create a new file in /override/controllers/admin named AdminCategoriesController.php, and paste the following inside php tags:

class AdminCategoriesController extends AdminCategoriesControllerCore
{
}

Then, reach the original AdminCategoriesController located within /controllers/admin, open it, locate and copy the whole renderForm method. Then, paste it inside the new override:

class AdminCategoriesController extends AdminCategoriesControllerCore
{


	public function renderForm()
	{
		$this->initToolbar();
		$obj = $this->loadObject(true);
		$id_shop = Context::getContext()->shop->id;
		$selected_categories = array((isset($obj->id_parent) && $obj->isParentCategoryAvailable($id_shop))? (int)$obj->id_parent : (int)Tools::getValue('id_parent', Category::getRootCategory()->id));
		$unidentified = new Group(Configuration::get('PS_UNIDENTIFIED_GROUP'));
		$guest = new Group(Configuration::get('PS_GUEST_GROUP'));
		$default = new Group(Configuration::get('PS_CUSTOMER_GROUP'));

		$unidentified_group_information = sprintf($this->l('%s - All people without a valid customer account.'), '<b>'.$unidentified->name[$this->context->language->id].'</b>');
		$guest_group_information = sprintf($this->l('%s - Customer who placed an order with the guest checkout.'), '<b>'.$guest->name[$this->context->language->id].'</b>');
		$default_group_information = sprintf($this->l('%s - All people who have created an account on this site.'), '<b>'.$default->name[$this->context->language->id].'</b>');

		if (!($obj = $this->loadObject(true)))
			return;

		$image = _PS_CAT_IMG_DIR_.$obj->id.'.jpg';
		$image_url = ImageManager::thumbnail($image, $this->table.'_'.(int)$obj->id.'.'.$this->imageType, 350,
			$this->imageType, true, true);
		$image_size = file_exists($image) ? filesize($image) / 1000 : false;

		$this->fields_form = array(
			'tinymce' => true,
			'legend' => array(
				'title' => $this->l('Category'),
				'icon' => 'icon-tags'
			),
			'input' => array(
				array(
					'type' => 'text',
					'label' => $this->l('Name'),
					'name' => 'name',
					'lang' => true,
					'required' => true,
					'class' => 'copy2friendlyUrl',
					'hint' => $this->l('Invalid characters:').' <>;=#{}',
				),
				array(
					'type' => 'switch',
					'label' => $this->l('Displayed'),
					'name' => 'active',
					'required' => false,
					'is_bool' => true,
					'values' => array(
						array(
							'id' => 'active_on',
							'value' => 1,
							'label' => $this->l('Enabled')
						),
						array(
							'id' => 'active_off',
							'value' => 0,
							'label' => $this->l('Disabled')
						)
					)
				),
				array(
					'type'  => 'categories',
					'label' => $this->l('Parent category'),
					'name'  => 'id_parent',
					'tree'  => array(
						'id'                  => 'categories-tree',
						'selected_categories' => $selected_categories,
						'disabled_categories' => !Tools::isSubmit('add'.$this->table) ? array($this->_category->id) : null
					)
				),
				array(
					'type' => 'textarea',
					'label' => $this->l('Description'),
					'name' => 'description',
					'autoload_rte' => true,
					'lang' => true,
					'hint' => $this->l('Invalid characters:').' <>;=#{}'
				),
				array(
					'type' => 'file',
					'label' => $this->l('Image'),
					'name' => 'image',
					'display_image' => true,
					'image' => $image_url ? $image_url : false,
					'size' => $image_size,
					'delete_url' => self::$currentIndex.'&'.$this->identifier.'='.$this->_category->id.'&token='.$this->token.'&deleteImage=1',
					'hint' => $this->l('Upload a category logo from your computer.'),
				),
				array(
					'type' => 'text',
					'label' => $this->l('Meta title'),
					'name' => 'meta_title',
					'lang' => true,
					'hint' => $this->l('Forbidden characters:').' <>;=#{}'
				),
				array(
					'type' => 'text',
					'label' => $this->l('Meta description'),
					'name' => 'meta_description',
					'lang' => true,
					'hint' => $this->l('Forbidden characters:').' <>;=#{}'
				),
				array(
					'type' => 'tags',
					'label' => $this->l('Meta keywords'),
					'name' => 'meta_keywords',
					'lang' => true,
					'hint' => $this->l('To add "tags," click in the field, write something, and then press "Enter."').'&nbsp;'.$this->l('Forbidden characters:').' <>;=#{}'
				),
				array(
					'type' => 'text',
					'label' => $this->l('Friendly URL'),
					'name' => 'link_rewrite',
					'lang' => true,
					'required' => true,
					'hint' => $this->l('Only letters, numbers, underscore (_) and the minus (-) character are allowed.')
				),
				array(
					'type' => 'group',
					'label' => $this->l('Group access'),
					'name' => 'groupBox',
					'values' => Group::getGroups(Context::getContext()->language->id),
					'info_introduction' => $this->l('You now have three default customer groups.'),
					'unidentified' => $unidentified_group_information,
					'guest' => $guest_group_information,
					'customer' => $default_group_information,
					'hint' => $this->l('Mark all of the customer groups which you would like to have access to this category.')
				)
			),
			'submit' => array(
				'title' => $this->l('Save'),
				'name' => 'submitAdd'.$this->table.($this->_category->is_root_category && !Tools::isSubmit('add'.$this->table) && !Tools::isSubmit('add'.$this->table.'root') ? '': 'AndBackToParent')
			)
		);

		$this->tpl_form_vars['shared_category'] = Validate::isLoadedObject($obj) && $obj->hasMultishopEntries();
		$this->tpl_form_vars['PS_ALLOW_ACCENTED_CHARS_URL'] = (int)Configuration::get('PS_ALLOW_ACCENTED_CHARS_URL');
		$this->tpl_form_vars['displayBackOfficeCategory'] = Hook::exec('displayBackOfficeCategory');

		// Display this field only if multistore option is enabled
		if (Configuration::get('PS_MULTISHOP_FEATURE_ACTIVE') && Tools::isSubmit('add'.$this->table.'root'))
		{
			$this->fields_form['input'][] = array(
				'type' => 'switch',
				'label' => $this->l('Root Category'),
				'name' => 'is_root_category',
				'required' => false,
				'is_bool' => true,
				'values' => array(
					array(
						'id' => 'is_root_on',
						'value' => 1,
						'label' => $this->l('Yes')
					),
					array(
						'id' => 'is_root_off',
						'value' => 0,
						'label' => $this->l('No')
					)
				)
			);
			unset($this->fields_form['input'][2],$this->fields_form['input'][3]);
		}
		// Display this field only if multistore option is enabled AND there are several stores configured
		if (Shop::isFeatureActive())
			$this->fields_form['input'][] = array(
				'type' => 'shop',
				'label' => $this->l('Shop association'),
				'name' => 'checkBoxShopAsso',
			);

		// remove category tree and radio button "is_root_category" if this category has the root category as parent category to avoid any conflict
		if ($this->_category->id_parent == Category::getTopCategory()->id && Tools::isSubmit('updatecategory'))
			foreach ($this->fields_form['input'] as $k => $input)
				if (in_array($input['name'], array('id_parent', 'is_root_category')))
					unset($this->fields_form['input'][$k]);

		if (!($obj = $this->loadObject(true)))
			return;

		$image = ImageManager::thumbnail(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg', $this->table.'_'.(int)$obj->id.'.'.$this->imageType, 350, $this->imageType, true);

		$this->fields_value = array(
			'image' => $image ? $image : false,
			'size' => $image ? filesize(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg') / 1000 : false
		);

		// Added values of object Group
		$category_groups_ids = $obj->getGroups();

		$groups = Group::getGroups($this->context->language->id);
		// if empty $carrier_groups_ids : object creation : we set the default groups
		if (empty($category_groups_ids))
		{
			$preselected = array(Configuration::get('PS_UNIDENTIFIED_GROUP'), Configuration::get('PS_GUEST_GROUP'), Configuration::get('PS_CUSTOMER_GROUP'));
			$category_groups_ids = array_merge($category_groups_ids, $preselected);
		}
		foreach ($groups as $group)
			$this->fields_value['groupBox_'.$group['id_group']] = Tools::getValue('groupBox_'.$group['id_group'], (in_array($group['id_group'], $category_groups_ids)));

		$this->fields_value['is_root_category'] = (bool)Tools::isSubmit('add'.$this->table.'root');

		return parent::renderForm();
	}
	
}

Notice the last row, return parent::renderForm();. Change it to return AdminController::renderForm();. if we didn’t take this counter-measure, all of our changes would have been overridden by the original controller. To make sure the override works, reach the cache/ and erase class_index.php to enable the new file. Then login to the back office, and check the single category view works as expected. If so, read on.

Adding the new field

First off, we will need to add the code that displays any eventual image we upload. To do so, locate the following:

		$image = _PS_CAT_IMG_DIR_.$obj->id.'.jpg';
		$image_url = ImageManager::thumbnail($image, $this->table.'_'.(int)$obj->id.'.'.$this->imageType, 350,
			$this->imageType, true, true);
		$image_size = file_exists($image) ? filesize($image) / 1000 : false;

Right after it, add

		$image2 = _PS_CAT_IMG_DIR_.$obj->id.'_second.jpg';
		$image_url2 = ImageManager::thumbnail($image2, $this->table.'_'.(int)$obj->id.'_second.'.$this->imageType, 350,
			$this->imageType, true, true);
		$image_size2 = file_exists($image2) ? filesize($image2) / 1000 : false;

Which is basically the same with modified names. Next, right below we have the fields list. We need to add our file input here, so that we can later upload the image. Therefore, locate:

				array(
					'type' => 'file',
					'label' => $this->l('Image'),
					'name' => 'image',
					'display_image' => true,
					'image' => $image_url ? $image_url : false,
					'size' => $image_size,
					'delete_url' => self::$currentIndex.'&'.$this->identifier.'='.$this->_category->id.'&token='.$this->token.'&deleteImage=1',
					'hint' => $this->l('Upload a category logo from your computer.'),
				),

And add the following right after it

				array(
					'type' => 'file',
					'label' => $this->l('Image2'),
					'name' => 'image2',
					'display_image' => true,
					'image' => $image_url2 ? $image_url2 : false,
					'size' => $image_size2,
					'delete_url' => self::$currentIndex.'&'.$this->identifier.'='.$this->_category->id.'&token='.$this->token.'&deleteImage2=1',
					'hint' => $this->l('Upload a secondary category logo from your computer.'),
				),

Once again, same code, different names. And, lastly, change this:

		$image = ImageManager::thumbnail(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg', $this->table.'_'.(int)$obj->id.'.'.$this->imageType, 350, $this->imageType, true);

		$this->fields_value = array(
			'image' => $image ? $image : false,
			'size' => $image ? filesize(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg') / 1000 : false
		);

Into this

		$image = ImageManager::thumbnail(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg', $this->table.'_'.(int)$obj->id.'.'.$this->imageType, 350, $this->imageType, true);
		$image2 = ImageManager::thumbnail(_PS_CAT_IMG_DIR_.'/'.$obj->id.'_second.jpg', $this->table.'_'.(int)$obj->id.'_second.'.$this->imageType, 350, $this->imageType, true);

		$this->fields_value = array(
			'image' => $image ? $image : false,
			'size' => $image ? filesize(_PS_CAT_IMG_DIR_.'/'.$obj->id.'.jpg') / 1000 : false,
			'image2' => $image2 ? $image2 : false,
			'size2' => $image2 ? filesize(_PS_CAT_IMG_DIR_.'/'.$obj->id.'_second.jpg') / 1000 : false
		);

Useless to mention we are doing the same, once more. We are done with renderForm, let’s deal with postImage() now!

Managing the new image upload and removal

Trying to fill in the new file input would not produce anything, at the moment. The whole upload magic is held through a method named postImage(), which we are going to override and extend. Thus, copy it from the original AdminCategoriesController, and paste it inside the override file. It should look like the following:

	protected function postImage($id)
	{
		$ret = parent::postImage($id);
		if (($id_category = (int)Tools::getValue('id_category')) &&
			isset($_FILES) && count($_FILES) && $_FILES['image']['name'] != null &&
			file_exists(_PS_CAT_IMG_DIR_.$id_category.'.jpg'))
		{
			$images_types = ImageType::getImagesTypes('categories');
			foreach ($images_types as $k => $image_type)
			{
				ImageManager::resize(
					_PS_CAT_IMG_DIR_.$id_category.'.jpg',
					_PS_CAT_IMG_DIR_.$id_category.'-'.stripslashes($image_type['name']).'.jpg',
					(int)$image_type['width'], (int)$image_type['height']
				);
			}
		}

		return $ret;
	}

Get rid of return $ret;, and add the following instead:

		$ret2 = $this->uploadImage($id.'_second', 'image2', $this->fieldImageSettings['dir'].'/');
		if (($id_category = (int)Tools::getValue('id_category')) &&
			isset($_FILES) && count($_FILES) && $_FILES['image2']['name'] != null &&
			file_exists(_PS_CAT_IMG_DIR_.$id_category.'_second.jpg'))
		{
			$images_types = ImageType::getImagesTypes('categories');
			foreach ($images_types as $k => $image_type)
			{
				ImageManager::resize(
					_PS_CAT_IMG_DIR_.$id_category.'_second.jpg',
					_PS_CAT_IMG_DIR_.$id_category.'_second-'.stripslashes($image_type['name']).'.jpg',
					(int)$image_type['width'], (int)$image_type['height']
				);
			}
		}

		return $ret && $ret2;

Explanation: first, we are grabbing some code directly from the adminController. We have to use a custom name for the image upload, which is the category id plus _second, using the field “image2″. The rest is simply a copy/paste of the above, with, again, changes in the name only. Lastly, we make sure that we return true only if both eventual uploads were successful.

We have a problem though. At the time being, Prestashop still thinks we only have one image for the category entity. Thus, when uploading any other image for it (excluding thumbs), it will erase the previous one. We can test it right away: upload a new image for the image2 field, you will notice the original category image will be erased. As we don’t want this, we have to grab imageUpload() directly from the AdminController.php file, and extend it. Locate the method, and paste it inside our override. In Prestashop 1.6.0.9, it looks like this:

	protected function uploadImage($id, $name, $dir, $ext = false, $width = null, $height = null)
	{
		if (isset($_FILES[$name]['tmp_name']) && !empty($_FILES[$name]['tmp_name']))
		{
			// Delete old image
			if (Validate::isLoadedObject($object = $this->loadObject()))
				$object->deleteImage();
			else
				return false;

			// Check image validity
			$max_size = isset($this->max_image_size) ? $this->max_image_size : 0;
			if ($error = ImageManager::validateUpload($_FILES[$name], Tools::getMaxUploadSize($max_size)))
				$this->errors[] = $error;

			$tmp_name = tempnam(_PS_TMP_IMG_DIR_, 'PS');
			if (!$tmp_name)
				return false;

			if (!move_uploaded_file($_FILES[$name]['tmp_name'], $tmp_name))
				return false;

			// Evaluate the memory required to resize the image: if it's too much, you can't resize it.
			if (!ImageManager::checkImageMemoryLimit($tmp_name))
				$this->errors[] = Tools::displayError('Due to memory limit restrictions, this image cannot be loaded. Please increase your memory_limit value via your server\'s configuration settings. ');

			// Copy new image
			if (empty($this->errors) && !ImageManager::resize($tmp_name, _PS_IMG_DIR_.$dir.$id.'.'.$this->imageType, (int)$width, (int)$height, ($ext ? $ext : $this->imageType)))
				$this->errors[] = Tools::displayError('An error occurred while uploading the image.');

			if (count($this->errors))
				return false;
			if ($this->afterImageUpload())
			{
				unlink($tmp_name);
				return true;
			}
			return false;
		}
		return true;
	}

Pay attention at this snippet:

			// Delete old image
			if (Validate::isLoadedObject($object = $this->loadObject()))
				$object->deleteImage();
			else
				return false;

It’s where the original image gets erased to make room for a new one. Change it to:

			// Delete old image
			if (Validate::isLoadedObject($object = $this->loadObject()))
			{
				if($name == 'image2')
					$object->deleteImage2();
				else $object->deleteImage();
			} else
				return false;

It won’t work yet as didn’t override the Category class and added the deleteImage2 method. Before leaving this file, we need to extend one, last function, postProcess(). Copy it again from the original AdminCategoriesController, it should be something like:

	public function postProcess()
	{
		if (!in_array($this->display, array('edit', 'add')))
			$this->multishop_context_group = false;
		if (Tools::isSubmit('forcedeleteImage') || (isset($_FILES['image']) && $_FILES['image']['size'] > 0) || Tools::getValue('deleteImage'))
		{
			$this->processForceDeleteImage();
			if (Tools::isSubmit('forcedeleteImage'))
				Tools::redirectAdmin(self::$currentIndex.'&token='.Tools::getAdminTokenLite('AdminCategories').'&conf=7');
		}

		return parent::postProcess();
	}

We need to take care of the secondary image deletion:

	public function postProcess()
	{
		if (!in_array($this->display, array('edit', 'add')))
			$this->multishop_context_group = false;
		if (Tools::isSubmit('forcedeleteImage') || (isset($_FILES['image']) && $_FILES['image']['size'] > 0) || Tools::getValue('deleteImage'))
		{
			$this->processForceDeleteImage();
			if (Tools::isSubmit('forcedeleteImage'))
				Tools::redirectAdmin(self::$currentIndex.'&token='.Tools::getAdminTokenLite('AdminCategories').'&conf=7');
		} else if(Tools::getValue('deleteImage2'))
		{
			$category = $this->loadObject(true);

			if (Validate::isLoadedObject($category))
				if($category->deleteImage2(true))
					Tools::redirectAdmin(self::$currentIndex.'&token='.Tools::getAdminTokenLite('AdminCategories').'&updatecategory&id_category='.$category->id.'&conf=7');
		}

		return parent::postProcess();
	}

And we are done with this file, let’s extend the Category class now.

Overriding the category class

Create a new file inside override/classes and name it Category.php (or use an existing override if you have it). First of all, we need to test it the back office functionality, so let’s add that deleteImage2() method:

Class Category extends CategoryCore
{


	public function deleteImage2($force_delete = false)
	{
		if (!$this->id)
			return false;
		
		if ($force_delete || !$this->hasMultishopEntries())
		{
			/* Deleting object images and thumbnails (cache) */
			if ($this->image_dir)
			{
				if (file_exists($this->image_dir.$this->id.'_second.'.$this->image_format)
					&& !unlink($this->image_dir.$this->id.'_second.'.$this->image_format))
					return false;
			}
			if (file_exists(_PS_TMP_IMG_DIR_.$this->def['table'].'_'.$this->id.'_second.'.$this->image_format)
				&& !unlink(_PS_TMP_IMG_DIR_.$this->def['table'].'_'.$this->id.'_second.'.$this->image_format))
				return false;
			if (file_exists(_PS_TMP_IMG_DIR_.$this->def['table'].'_mini_'.$this->id.'_second.'.$this->image_format)
				&& !unlink(_PS_TMP_IMG_DIR_.$this->def['table'].'_mini_'.$this->id.'_second.'.$this->image_format))
				return false;
	
			$types = ImageType::getImagesTypes();
			foreach ($types as $image_type)
				if (file_exists($this->image_dir.$this->id.'_second-'.stripslashes($image_type['name']).'.'.$this->image_format)
				&& !unlink($this->image_dir.$this->id.'_second-'.stripslashes($image_type['name']).'.'.$this->image_format))
					return false;
		}
		return true;
	}
}

To create it, I simply copied the original deleteImage from the objectModel, and modified the name of each entry to reflect our convention (_second).

Time to test the back office! Access the categories tab, then open up one of them and try adding an image. Then, delete this image to check if that works as well. Then again add one, and one immediately after to check it gets over-written. Lastly, make sure the original one isn’t erased during this process, and the new one is not affected by any operation on the first onee.

After checking this, it’s time too display the new thumb. Since we will use it in subcategories, we need to assign it at the time they are retrieved for the template display. This is held through the getSubcategories() method of the Category class. Thus, copy the original one and paste it inside our override:

	public function getSubCategories($id_lang, $active = true)
	{
		$sql_groups_where = '';
		$sql_groups_join = '';
		if (Group::isFeatureActive())
		{
			$sql_groups_join = 'LEFT JOIN `'._DB_PREFIX_.'category_group` cg ON (cg.`id_category` = c.`id_category`)';
			$groups = FrontController::getCurrentCustomerGroups();
			$sql_groups_where = 'AND cg.`id_group` '.(count($groups) ? 'IN ('.implode(',', $groups).')' : '='.(int)Group::getCurrent()->id);
		}

		$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
		SELECT c.*, cl.id_lang, cl.name, cl.description, cl.link_rewrite, cl.meta_title, cl.meta_keywords, cl.meta_description
		FROM `'._DB_PREFIX_.'category` c
		'.Shop::addSqlAssociation('category', 'c').'
		LEFT JOIN `'._DB_PREFIX_.'category_lang` cl ON (c.`id_category` = cl.`id_category` AND `id_lang` = '.(int)$id_lang.' '.Shop::addSqlRestrictionOnLang('cl').')
		'.$sql_groups_join.'
		WHERE `id_parent` = '.(int)$this->id.'
		'.($active ? 'AND `active` = 1' : '').'
		'.$sql_groups_where.'
		GROUP BY c.`id_category`
		ORDER BY `level_depth` ASC, category_shop.`position` ASC');

		foreach ($result as &$row)
		{
			
			$row['legend'] = 'no picture';
		}
		return $result;
	}

Then, right after this:

$row['id_image'] = Tools::file_exists_cache(_PS_CAT_IMG_DIR_.$row['id_category'].'.jpg') ? (int)$row['id_category'] : Language::getIsoById($id_lang).'-default';

Add our new image definition

$row['id_image2'] = Tools::file_exists_cache(_PS_CAT_IMG_DIR_.$row['id_category'].'_second.jpg') ? (int)$row['id_category'] .'_second' : Language::getIsoById($id_lang).'-default';

And we are done with php!

Display the new image in the template

We are almost there. Open category.tpl, located in the theme’s folder. Locate:

{if $subcategory.id_image}
	<img class="replace-2x" src="{$link->getCatImageLink($subcategory.link_rewrite, $subcategory.id_image, 'medium_default')|escape:'html':'UTF-8'}" alt="" width="{$mediumSize.width}" height="{$mediumSize.height}" />
{else}

And change it to

{if $subcategory.id_image2}
	<img class="replace-2x" src="{$link->getCatImageLink($subcategory.link_rewrite, $subcategory.id_image2, 'medium_default')|escape:'html':'UTF-8'}" alt="" width="{$mediumSize.width}" height="{$mediumSize.height}" />
{else}

This will be enough if friendly urls are not enabled. But what if we are using rewritten URLs?. Sadly, we need to hardcode one, last modification in the .htaccess file. It is not exactly bulletproof, but it worked out well in all my tests. Therefore, open your .htaccess, and add the following at the very beginning, right BEFORE “# ~~start~~ Do not remove this comment, Prestashop will keep automatically the code outside this comment when .htaccess will be generated again”

<IfModule mod_rewrite.c>
RewriteRule ^c/([0-9]+)_second(\-[\.*_a-zA-Z0-9-]*)(-[0-9]+)?/.+\.jpg$ %{ENV:REWRITEBASE}img/c/$1_second$2$3.jpg [L]
</IfModule>

This will make sure our “_second” text in the image path won’t be treated as part of the category ID, thus making it impossible to retrieve the picture.

Conclusion

Despite being a bit cumbersome, adding a secondary image for categories (or actually any other entity such as manufacturers or suppliers) is indeed possible by using this technique. The final trick for rewritten-url environments is to make sure the proper regEx is added right at the beginning of the .htaccess file.

The post Adding a second image for Prestashop categories appeared first on NemoPS.