NemoPS » virtual products

Specific payment methods for virtual products in Prestashop

Nemo — Tue, 07 Apr 2015 09:39:48 +0000

In this quick tip we will see how to enable or disable payment methods for virtual products in Prestashop

If you are selling both virtual and normal products, it might be worth displaying your customers specific payment methods depending on what they’re buying. It’s useless, for example, to allow them to pay by cash on delivery something they can download soon after purchase! Similarly, you might want to offer a specific digital payment for virtual products only.

It is important to know that the modification we are about to apply needs to be made on every single payment module you want to restrict. This means having to hard-modify core files on older prestashop versions, or using overrides on newer than 1.6.0.11. For simplicity, I will modify core files, but have a look at my tutorial on how to override Prestashop Modules’ core files.

The hookPayment method

The simplest way to restrict our payment methods is to modify the method named hookPayment, used by every single Prestashop Payment module. It’s the function responsible of displaying payment methods during the checkout, so hiding them here will prevent people from continuing the purchase with them.

We will use bankwire as an example, but any other will equally do. Since non-standard modules might have their own rules, it’s better to add these lines of code at the very beginning of the method.

Therefore, open up modules/bankwire/bankwire.php (or use overrides), and scroll to the hookPayment method, which looks like this:


	public function hookPayment($params)
	{

		if (!$this->active)
			return;
		if (!$this->checkCurrency($params['cart']))
			return;

		$this->smarty->assign(array(
			'this_path' => $this->_path,
			'this_path_bw' => $this->_path,
			'this_path_ssl' => Tools::getShopDomainSsl(true, true).__PS_BASE_URI__.'modules/'.$this->name.'/'
		));
		return $this->display(__FILE__, 'payment.tpl');
	}

First of all, we need to check which products are in the cart

$products = $this->context->cart->getProducts();

Then, we loop through them, and see if any is virtual:

		$products = $this->context->cart->getProducts();

		if($products)
		{
			foreach ($products as $product) {
				if ($product['is_virtual'])
				{
					// what to do?
				}		
			}
		}

It’s dead easy, isn’t it? Now we can choose what to do, let’s try removing bankwire for virtual products!

		$products = $this->context->cart->getProducts();

		if($products)
		{
			foreach ($products as $product) {
				if ($product['is_virtual'])
				{
					return false;
				}		
			}
		}

What happens now? This will kill the bankwire payment method whenever someone has a virtual product in the cart. It means, of course that it won’t be accessible even if there are other products there. This might lead to unwanted situations, when no method is available at all.

For example, you have two methods: bankwire, and paypal. You remove bankwire with this method on virtual products, and paypal on others. What happens when a user has both a virtual and normal product in the cart? No method will be available! We therefore need to make a choice, whether to leave a warning in the cart page (shopping-cart.tpl) or explore another way.

We might want to only hide the method if all products are virtual, for example. How to?

The easiest way is to use $this->context->cart->isVirtualCart(), which will return true if all products in it are virtual. Alternatively, we can do it manually ourselves:

	if($products)
	{
		$virtuals = 0;
		foreach ($products as $product) {
			if ($product['is_virtual'])
			{
				$virtuals++;
			}		
		}
		if($virtuals == count($products))
			return false;
	}

In this case, we use a counter to check how many virtual products we have. If all of them are virtual, we disable the module! How can we revere it then?

		$products = $this->context->cart->getProducts();

		if($products)
		{
			foreach ($products as $product) {
				if (!$product['is_virtual'])
				{
					return false;
				}		
			}
		}

This will disable bankwire whenever a non-virtual product is in the cart.

	if($products)
	{
		$nonvirtuals = 0;
		foreach ($products as $product) {
			if (!$product['is_virtual'])
			{
				$nonvirtuals++;
			}		
		}
		if($nonvirtuals == count($products))
			return false;
	}

While this other will hide it when all products are physical.

Conclusion

There are many ways to utilize the restriction, depending on your needs (such as even buying a certain number of products!). Just keep in mind that you might end up not having any payment available if you mix up the wrong conditions!

The post Specific payment methods for virtual products in Prestashop appeared first on NemoPS.

Enable Combinations for Virtual Products in Prestashop 1.6/1.5

Nemo — Tue, 14 Jan 2014 09:51:03 +0000

Prestashop 1.4 used to let you create combinations for downloadable items. It was the same file for every combinations, but we could use them, at least. This is no longer possible with Prestashop 1.5 and 1.6’s virtual products, so let’s see how to turn this feature back!

The problem: You cannot use combinations with a virtual product

If you ever tried to add attribute combinations to a virtual product, or turn into virtual a normal one that already had them, you might have run into this message. In the worst case, you just upgraded from 1.4 and discovered your products didn’t have the previous files attached anymore, if they had combinations. Despite having to re-bind all the downloadable files in the latter case, we can re-enable combinations for virtual products in Prestashop 1.5 using some overrides:

AdminProductsController
combinations.tpl (back office template file)
virtualproduct.tpl

We will simply disable a couple of checks Prestashop does, which turn off combinations if the product is virtual, and vice-versa.

The AdminProductsController Override

First of all, let’s disable the virtual product check in the product’s back office. Create a new file in override/controllers/admin and call it AdminProductsController.php. Add the following to begin with, inside php tags of course:

class AdminProductsController extends AdminProductsControllerCore
{
}

At this point, we need to extend and modify the method named initFormAttributes. Therefore, open up the original AdminProductsController.php (controllers/admin), copy initFormAttributes from there (about line 3628 in Prestashop 1.5.6), and paste the whole function inside the new override.

Then, locate the following:

if ($this->product_exists_in_shop)
			{
				if ($product->is_virtual)
				{
					$data->assign('product', $product);
					$this->displayWarning($this->l('A virtual product cannot have combinations.'));
				}
				else
				{
					$attribute_js = array();
					$attributes = Attribute::getAttributes($this->context->language->id, true);
					foreach ($attributes as $k => $attribute)
						$attribute_js[$attribute['id_attribute_group']][$attribute['id_attribute']] = $attribute['name'];
					$currency = $this->context->currency;
					$data->assign('attributeJs', $attribute_js);
					$data->assign('attributes_groups', AttributeGroup::getAttributesGroups($this->context->language->id));

					$data->assign('currency', $currency);

					$images = Image::getImages($this->context->language->id, $product->id);

					$data->assign('tax_exclude_option', Tax::excludeTaxeOption());
					$data->assign('ps_weight_unit', Configuration::get('PS_WEIGHT_UNIT'));

					$data->assign('ps_use_ecotax', Configuration::get('PS_USE_ECOTAX'));
					$data->assign('field_value_unity', $this->getFieldValue($product, 'unity'));

					$data->assign('reasons', $reasons = StockMvtReason::getStockMvtReasons($this->context->language->id));
					$data->assign('ps_stock_mvt_reason_default', $ps_stock_mvt_reason_default = Configuration::get('PS_STOCK_MVT_REASON_DEFAULT'));
					$data->assign('minimal_quantity', $this->getFieldValue($product, 'minimal_quantity') ? $this->getFieldValue($product, 'minimal_quantity') : 1);
					$data->assign('available_date', ($this->getFieldValue($product, 'available_date') != 0) ? stripslashes(htmlentities($this->getFieldValue($product, 'available_date'), $this->context->language->id)) : '0000-00-00');

					$i = 0;
					$data->assign('imageType', ImageType::getByNameNType('small_default', 'products'));
					$data->assign('imageWidth', (isset($image_type['width']) ? (int)($image_type['width']) : 64) + 25);
					foreach ($images as $k => $image)
					{
						$images[$k]['obj'] = new Image($image['id_image']);
						++$i;
					}
					$data->assign('images', $images);

					$data->assign($this->tpl_form_vars);
					$data->assign(array(
						'list' => $this->renderListAttributes($product, $currency),
						'product' => $product,
						'id_category' => $product->getDefaultCategory(),
						'token_generator' => Tools::getAdminTokenLite('AdminAttributeGenerator'),
						'combination_exists' => (Shop::isFeatureActive() && (Shop::getContextShopGroup()->share_stock) && count(AttributeGroup::getAttributesGroups($this->context->language->id)) > 0 && $product->hasAttributes())
					));
				}
			}
			else
				$this->displayWarning($this->l('You must save the product in this shop before adding combinations.'));

Can you see where it reads if ($product->is_virtual)? Get rid of this if/else, so it looks like this:

			if ($this->product_exists_in_shop)
			{
				// removed virtual product restriction
				$attribute_js = array();
				$attributes = Attribute::getAttributes($this->context->language->id, true);
				foreach ($attributes as $k => $attribute)
					$attribute_js[$attribute['id_attribute_group']][$attribute['id_attribute']] = $attribute['name'];
				$currency = $this->context->currency;
				$data->assign('attributeJs', $attribute_js);
				$data->assign('attributes_groups', AttributeGroup::getAttributesGroups($this->context->language->id));

				$data->assign('currency', $currency);

				$images = Image::getImages($this->context->language->id, $product->id);

				$data->assign('tax_exclude_option', Tax::excludeTaxeOption());
				$data->assign('ps_weight_unit', Configuration::get('PS_WEIGHT_UNIT'));

				$data->assign('ps_use_ecotax', Configuration::get('PS_USE_ECOTAX'));
				$data->assign('field_value_unity', $this->getFieldValue($product, 'unity'));

				$data->assign('reasons', $reasons = StockMvtReason::getStockMvtReasons($this->context->language->id));
				$data->assign('ps_stock_mvt_reason_default', $ps_stock_mvt_reason_default = Configuration::get('PS_STOCK_MVT_REASON_DEFAULT'));
				$data->assign('minimal_quantity', $this->getFieldValue($product, 'minimal_quantity') ? $this->getFieldValue($product, 'minimal_quantity') : 1);
				$data->assign('available_date', ($this->getFieldValue($product, 'available_date') != 0) ? stripslashes(htmlentities($this->getFieldValue($product, 'available_date'), $this->context->language->id)) : '0000-00-00');

				$i = 0;
				$type = ImageType::getByNameNType('%', 'products', 'height');
				if (isset($type['name']))
					$data->assign('imageType', $type['name']);
				else
					$data->assign('imageType', 'small_default');
				$data->assign('imageWidth', (isset($image_type['width']) ? (int)($image_type['width']) : 64) + 25);
				foreach ($images as $k => $image)
				{
					$images[$k]['obj'] = new Image($image['id_image']);
					++$i;
				}
				$data->assign('images', $images);

				$data->assign($this->tpl_form_vars);
				$data->assign(array(
					'list' => $this->renderListAttributes($product, $currency),
					'product' => $product,
					'id_category' => $product->getDefaultCategory(),
					'token_generator' => Tools::getAdminTokenLite('AdminAttributeGenerator'),
					'combination_exists' => (Shop::isFeatureActive() && (Shop::getContextShopGroup()->share_stock) && count(AttributeGroup::getAttributesGroups($this->context->language->id)) > 0 && $product->hasAttributes())
				));
				
			}
			else
				$this->displayWarning($this->l('You must save the product in this shop before adding combinations.'));

Save the file, go to cache/ and delete class_index.php. Then access the product’s back office again, load a virtual product and click on the combinations tab. Nothing! At least, it’s better than the error message. We need to tackle another step.

Editing the attribute combinations template

Inside the same folder where we placed our override, create the following structure: templates/products/. Then, reach the admin folder themes/default/template/controllers/products. Copy combinations.tpl from here into the other folder we just created.

At this point, open the newly cloned file, and right at the beginning we can read:

{if isset($product->id) && !$product->is_virtual}

Just get rid of && !$product->is_virtual. Save and access the combinations tab again!

Finishing touches

You can create combinations for a virtual product right away. However, if you try to convert an existing one into virtual, you will get the very same annoying message you got before. We need to hardcode a small fix in another couple of files, first: admin-products.js, which can be found inside the js folder. Open it up and locate the following:

				if (has_combinations)
				{
					$('#simple_product').attr('checked', true);
					$('#warn_virtual_combinations').show();
				}
				else
				{
					$('li.tab-row a[id*="VirtualProduct"]').show().click();
					$('#is_virtual').val(1);

					tabs_manager.onLoad('VirtualProduct', function(){
						$('#is_virtual_good').attr('checked', true);
						$('#virtual_good').show();
					});

					tabs_manager.onLoad('Quantities', function(){
						$('.stockForVirtualProduct').hide();
					});

					$('li.tab-row a[id*="Shipping"]').hide();

					tabs_manager.onLoad('Informations', function(){
						$('#condition').attr('disabled', true);
						$('#condition option[value=refurbished]').removeAttr('selected');
						$('#condition option[value=used]').removeAttr('selected');
					});
				}

Change it to


					$('li.tab-row a[id*="VirtualProduct"]').show().click();
					$('#is_virtual').val(1);

					tabs_manager.onLoad('VirtualProduct', function(){
						$('#is_virtual_good').attr('checked', true);
						$('#virtual_good').show();
					});

					tabs_manager.onLoad('Quantities', function(){
						$('.stockForVirtualProduct').hide();
					});

					$('li.tab-row a[id*="Shipping"]').hide();

					tabs_manager.onLoad('Informations', function(){
						$('#condition').attr('disabled', true);
						$('#condition option[value=refurbished]').removeAttr('selected');
						$('#condition option[value=used]').removeAttr('selected');
					});

Then, once more, reach the themes/default/template/controllers/products folder. This time, copy virtualproduct.tpl to the same folder where we added combinations.tpl. Open it up and inspect the following snippet:

			{* Don't display file form if the product has combinations *}
			{if empty($product->cache_default_attribute)}
				{if $product->productDownload->id}
					
				{/if}
				
					{if $is_file}
						
					{/if}
					
					{* Feature not implemented *}
					{**}
						{**}
						{**}
					{**}
				{else}
					{l s='You cannot edit your file here because you used combinations. Please edit this file in the Combinations tab.'}


					{if isset($error_product_download)}{$error_product_download}{/if}
				{/if}
Change it to:

			{if $product->productDownload->id}
				
			{/if}
			

					
						
							{l s='Upload a file'}
						
						
							
							{l s='Your server\'s maximum file-upload size is'}: {$upload_max_filesize} {l s='MB'}
						
					
					
						
					
					
						
							{if $up_filename}
								
							{/if}
							
							
								
									
								
							
						
					

							
								
								{l s='Link to the file:'}
							
							 
								{$product->productDownload->getHtmlLink(false, true)}
								
									
								
							
						

						
							{l s='Filename'}
						
						
							
							{l s='The full filename with its extension (e.g. Book.pdf)'}
						
					
					
						
							{l s='Number of allowed downloads'}
						
						
							
							{l s='Number of downloads allowed per customer. (Set to 0 for unlimited downloads)'}
						
					
					
						
							{l s='Expiration date'}
						
						
							 {l s='Format: YYYY-MM-DD'}
							{l s='If set, the file will not be downloadable after this date. Leave blank if you do not wish to attach an expiration date.'}
						
					
						
							{l s='Number of days'}
						
						
							^*
							{l s='Number of days this file can be accessed by customers'} - ({l s='Set to zero for unlimited access.'})
						
					
*}
							{*{l s='is shareable'}*}
						{* *}
							{*productDownload->is_shareable}checked="checked"{/if} />*}
							{*{l s='Please specify if the file can be shared.'}*}
						{*
					


				{if $is_file}
					
				{/if}
				
				{* Feature not implemented *}
				{**}
					{**}
					{**}
				{**}

Explanation: we basically got rid of the if/else statement which was triggering the message, instead of displaying the virtual product form.
Save, and we are done!
A note about prestashop 1.6
Iclavijos, user of the Prestashop forums, found out an additional step is needed in order to make virtual products work with combinations in Prestashop 1.6, here follows his advice
You need to override form.tpl (controllers/admin/templates/products/helpers/form) and there, comment out line 116. Basically, this is the original code:
else if (product_type == product_type_virtual)

                {

                    $('a[id*="Pack"]').hide();

                    $('a[id*="Shipping"]').hide();

                    $('a[id*="Combinations"]').hide();

                }[
and this should be the final one:
else if (product_type == product_type_virtual)

                {

                    $('a[id*="Pack"]').hide();

                    $('a[id*="Shipping"]').hide();

                    //$('a[id*="Combinations"]').hide();

                }
Thanks for your contribution!
Final note
Although we used overrides to ensure changes are preserved after an upgrade, remember to re-apply the admin-products.js fix, as we had to hardcode that one!.
The post Enable Combinations for Virtual Products in Prestashop 1.6/1.5 appeared first on NemoPS.

				
					
						{l s='Upload a file'}
					
					
						
						{l s='Your server\'s maximum file-upload size is'}: {$upload_max_filesize} {l s='MB'}
					
				
				
					
				
				
					
						{if $up_filename}
							
						{/if}
						
						
							
								
							
						
					
				

						
							
							{l s='Link to the file:'}
						
						 
							{$product->productDownload->getHtmlLink(false, true)}
							
								
							
						
					

					
						{l s='Filename'}
					
					
						
						{l s='The full filename with its extension (e.g. Book.pdf)'}
					
				
				
					
						{l s='Number of allowed downloads'}
					
					
						
						{l s='Number of downloads allowed per customer. (Set to 0 for unlimited downloads)'}
					
				
				
					
						{l s='Expiration date'}
					
					
						 {l s='Format: YYYY-MM-DD'}
						{l s='If set, the file will not be downloadable after this date. Leave blank if you do not wish to attach an expiration date.'}
					
				
					
						{l s='Number of days'}
					
					
						^*
						{l s='Number of days this file can be accessed by customers'} - ({l s='Set to zero for unlimited access.'})
					
				
*}
						{*{l s='is shareable'}*}
					{* *}
						{*productDownload->is_shareable}checked="checked"{/if} />*}
						{*{l s='Please specify if the file can be shared.'}*}
					{*

{l s='Upload a file'}	{l s='Your server\'s maximum file-upload size is'}: {$upload_max_filesize} {l s='MB'}

{if $up_filename} {/if}
{l s='Link to the file:'}	{$product->productDownload->getHtmlLink(false, true)}
{l s='Filename'}	{l s='The full filename with its extension (e.g. Book.pdf)'}
{l s='Number of allowed downloads'}	{l s='Number of downloads allowed per customer. (Set to 0 for unlimited downloads)'}
{l s='Expiration date'}	{l s='Format: YYYY-MM-DD'} {l s='If set, the file will not be downloadable after this date. Leave blank if you do not wish to attach an expiration date.'}
{l s='Number of days'}	^* {l s='Number of days this file can be accessed by customers'} - ({l s='Set to zero for unlimited access.'})
} {{l s='is shareable'}} {	} {productDownload->is_shareable}checked="checked"{/if} />} {} {