Install Guide for Noodlemans Europe VAT Plugin for CubeCart 5

This install guide has been written for version 5.2.2 of CubeCart and all references to skin modifications have been made using the Kurouto skin. if you are installing in another version or using another skin the line numbers referenced may be different. If there is any doubt open a support ticket for assistance. You will need a demo license key to be able to use this plugin, please request one from support if you do not have one.

SUPPORT IS AVAILABLE FROM http://www.noodleman.co.uk/support

1. Disable Store Cache

   Log into your store admin area, navigate to "Store Settings -> Advanced" and set "Enable Caching" to Disabled. Save the change

   
   
   
   
2. Extract Files

   Extract the files from the .zip file to your servers "modules/plugins" directory. The final path should be "modules/plugins/Europe_VAT"

   
   
   
   
3. Add Items To Your Skin

   Open the file "skins/<YOURSKIN>/templates/content.register.php" with your favourite text editor. The javascript code below enables the live checking of VAT numbers.

Around line number 2 FIND: <p>{$LANG.account.register_text}</p>
AFTER ADD ON A NEW LINE: {if isset($VAT_JQUERY_URL)} <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> <script type="text/javascript"> $( document ).ready(function() { $('#register-taxexemptcustomerdetails').blur(function() { $.ajax({ type: "GET", dataType: "json", url: "{$VAT_JQUERY_URL}", data: "vat_number=" + $(this).val(), beforeSend: function(html) { // this happen before actual call $('#vat_status').attr("src", 'images/icons/spinner.gif'); }, success: function(json){ var status = json.status; if(status == 'Valid'){ $('#vat_status').attr("src", 'images/icons/1.png'); }else{ $('#vat_status').attr("src", 'images/icons/0.png'); } }, error: function(json){ $('#vat_status').attr("src", 'images/icons/0.png'); } }); }); }); </script> {/if}



4. Add Items To Your Skin

   Open the file "skins/<YOURSKIN>/templates/content.register.php" with your favourite text editor. The code below adds the extra form item to your skin. You can place this anywhere within your form, but for reference an example line has been given.

Around line number 52 FIND: <div><label for="register-passconf">{$LANG.account.password_confirm}</label><span><input type="password" autocomplete="off" name="passconf" id="register-passconf" value="" class="required" /> *</span></div>
AFTER ADD ON A NEW LINE: {if isset($VAT_CUSTOMERS_DETAILS)} {$VAT_CUSTOMERS_DETAILS} {/if}



5. Add Items To Your Skin

   Open the file "skins/<YOURSKIN>/templates/content.checkout.confirm.php" with your favourite text editor. The javascript code below enables the live checking of VAT numbers.

Around line number 25 FIND: </p> {/if} {else}
AFTER ADD ON A NEW LINE: {if isset($VAT_JQUERY_URL)} <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> <script type="text/javascript"> $( document ).ready(function() { $('#register-taxexemptcustomerdetails').blur(function() { $.ajax({ type: "GET", dataType: "json", url: "{$VAT_JQUERY_URL}", data: "vat_number=" + $(this).val(), beforeSend: function(html) { // this happen before actual call $('#vat_status').attr("src", 'images/icons/spinner.gif'); }, success: function(json){ var status = json.status; if(status == 'Valid'){ $('#vat_status').attr("src", 'images/icons/1.png'); }else{ $('#vat_status').attr("src", 'images/icons/0.png'); } }, error: function(json){ $('#vat_status').attr("src", 'images/icons/0.png'); } }); }); }); </script> {/if}



6. Add Items To Your Skin

   Open the file "skins/<YOURSKIN>/templates/content.checkout.confirm.php" with your favourite text editor. The code below adds the extra form item to your skin. You can place this anywhere within your form, but for reference an example line has been given.

Around line number 71 FIND: <div><label for="user_mobile">{$LANG.address.mobile}</label><span><input type="text" name="user[mobile]" id="user_mobile" class="textbox" value="{$USER.mobile}" /></span></div>
AFTER ADD ON A NEW LINE: {if isset($VAT_CUSTOMERS_DETAILS)} {$VAT_CUSTOMERS_DETAILS} {/if}



7. Add a new hook

   Open the file "classes/user.class.php" with your favourite text editor. The code below adds a new hook to CubeCart

Around line number 338 FIND: $customer_id = $GLOBALS['db']->insertid();
AFTER ADD ON A NEW LINE: foreach ($GLOBALS['hooks']->load('class.user.register_user.insertedAgain') as $hook) include $hook;



8. Add a new hook

   Open the file "admin/sources/customers.index.inc.php" with your favourite text editor. The code below adds a new hook to CubeCart

Around line number 312 FIND: $GLOBALS['gui']->addBreadcrumb(sprintf('%s %s', $customer['first_name'], $customer['last_name']), currentPage(array('address_id')));
AFTER ADD ON A NEW LINE: foreach ($GLOBALS['hooks']->load('admin.customer.noodle.edit') as $hook) include $hook;



9. Add Items To Your Skin

   Open the file "admin/skins/default/templates/customers.index.php" with your favourite text editor. The javascript code below enables the live checking of VAT numbers and adds new fields to the edit customer screen.

Around line number 133 FIND: <div><label for="cust-passconf">{$LANG.user.password_confirm}</label><span><input type="password" autocomplete="off" name="customer[passconf]" id="cust-passconf" rel="cust-password" class="textbox confirm" /></span></div> </fieldset>
AFTER ADD ON A NEW LINE: <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> <script type="text/javascript"> $( document ).ready(function() { $('#cust-vat_number1').blur(function() { $.ajax({ type: "GET", dataType: "json", url: "{$VAT_JQUERY_URL1}", data: "vat_number=" + $(this).val(), beforeSend: function(html) { // this happen before actual call $('#vat_status').attr("src", 'images/icons/spinner.gif'); }, success: function(json){ var status = json.status; if(status == 'Valid'){ $('#vat_status').attr("src", 'images/icons/1.png'); }else{ $('#vat_status').attr("src", 'images/icons/0.png'); } }, error: function(json){ $('#vat_status').attr("src", 'images/icons/0.png'); } }); }); }); </script> <fieldset><legend>Europe VAT</legend> <div><label for="cust-vat_number">VAT Number</label><span><input type="text" autocomplete="off" name="customer[vat_number1]" id="cust-vat_number1" class="textbox" value="{$CUSTOMER.vat_countryCode}{$CUSTOMER.vat_number}" /><img src="{$VAT_DEFAULT_IMAGE}" id="vat_status" /></span></div> </fieldset> <fieldset><legend>Europe VAT (Info Only)</legend> <div><label for="cust-vat_countryCode1">Country Code</label><span><input type="text" autocomplete="off" id="cust-vat_countryCode1" class="textbox" value="{$CUSTOMER.vat_countryCode}" readonly /></span></div> <div><label for="cust-vat_number1">Vat Number</label><span><input type="text" autocomplete="off" id="cust-vat_number1" class="textbox" value="{$CUSTOMER.vat_number}" readonly /></span></div> <div><label for="cust-vat_validated1">Vat Number Validated</label><span><input type="text" autocomplete="off" id="cust-vat_validated1" class="textbox" value="{if $CUSTOMER.vat_validated == 1}Yes{else}No{/if}" readonly /></span></div> <div><label for="cust-vat_name1">Registered Name</label><span><input type="text" autocomplete="off" id="cust-vat_name1" class="textbox" value="{$CUSTOMER.vat_officialName}" readonly /></span></div> <div><label for="cust-vat_address1">Registered Address</label><span><textarea style="width:300px; height:100px;" readonly>{$CUSTOMER.vat_officialAddress}</textarea></span></div> <div><label for="cust-vat_validated1">Auto Added to Customer Group</label><span><input type="text" autocomplete="off" id="cust-vat_validated1" class="textbox" value="{if $CUSTOMER.vat_addedToGroup == 1}Yes{else}No{/if}" readonly /></span></div> </fieldset>



10. Add a new hook

    Open the file "classes/cart.class.php" with your favourite text editor. The code below adds a new hook to CubeCart

Around line number 785 FIND: $GLOBALS['tax']->productTax($this->_shipping, $this->basket['shipping']['tax_id'], false, $this->basket[$tax_on]['state_id'], 'shipping');
REPLACE WITH: foreach ($GLOBALS['hooks']->load('class.cart.shippingtax') as $hook) include $hook;



11. Add a new hook

    Open the file "classes/tax.class.php" with your favourite text editor. The code below adds a new hook to CubeCart

Around line number 95 FIND: $taxes[] = $tax_data; }
AFTER ADD: foreach ($GLOBALS['hooks']->load('class.tax.get.tax') as $hook) include $hook;



12. Enable The Plugin

    Logged into the admin area, navigate to "Modules --> Plugins", Enable the Europe VAT plugin and save the settings.

13. Configure The Plugin

    Logged into the admin area, navigate to "Modules --> Plugins --> Europe VAT". Add your license key and enter the form option name.

14. Refresh Hooks

    Logged into the admin area, navigate to "Settings --> Manage Hooks --> Europe VAT". Press the Save button. This step ensures that all the hooks are active.