Extensions for the Advanced Ordernumbers Plugin for VirtueMart

All these plugins are "normal" Joomla plugins of plugin type "vmshopper" and need to be installed via the Joomla extension manager. Upon installation they should be automatically published by the installer and their functionality should be available in the Advanced Ordernumbers plugin for VirtueMart immediately.

Please note that the plugin feature was added only in version 2.1 (and extended in version 4.0.1) of the Advanced Ordernumbers plugins, so you need to have at least that version installed.

Template for Ordernumber Extensions Plugins

This is a template for developers who want to write their own plugins to extend the Advanced Ordernumbers for VirtueMart plugin. It can be installed, but does not provide any useful functionality, unless a programmer implements the corresponding functions.

Sometimes, order/invoice numbers have to depend on properties (e.g. custom field values, awocoupon discounts, etc.) that are not by default provided by this plugin. Starting with version 2.1, the Advanced Ordernumbers plugin can be extended with plugins of type "vmshopper". Such extensions can add new variables, modify existing variables or post-process the generated order/invoice number. 

The template available for download has the complete file and code structure, which you can use as a starting point for such a plugin. You will need to adjust the file names, the .xml file and the class names. 

There are two triggers in the plugin class that can be reimplemented to provide/modify variables and add new functions:

function onVmOrdernumberGetVariables(&$reps, $fmt, $nrtype, $details)

function onVmOrdernumberGetVariables(&$reps, $fmt, $nrtype, $details) {
  // As an example add a variable [type] that contains the number type:
  switch ($nrtype) {
    case 0: $reps['[type]'] = "Order"; break;
    case 1: $reps['[type]'] = "Invoice"; break;
    case 2: $reps['[type]'] = "Customer"; break;
    case 3: $reps['[type]'] = "OrderPassword"; break;
  }
 
 // Another example: set the ip address:
  if (isset($details->ip_address)) $reps["[ipaddress]"] = $details->ip_address;

  // You can also modify existing variables:
  $reps['[second]'] = $reps['[second]'] + 15;
}

function onVmOrdernumberPostprocessNumber(&$number, $type, $order)

function onVmOrdernumberPostprocessNumber(&$number, $type, $order) {
  // Example: Append the length of the number to the number
  if ($type=="order_number") {
    $checksum=strlen($number);
    $number .= $checksum;
  }
  // Example 2: Store the invoice number in an external bookkeeping system
  if ($type=="invoice_number") {
    // simply take $number and trigger a webservice call sending that value 
    // (and e.g. the order ID stored in the $order object) to the bookkeeping system
  }
}

Checksum Plugin

This plugin post-processes the order number to append its length as a checksum. Typically, other types of checksum are desired, so you might need to modify the onVmOrdernumberPostprocessNumber function (see below for the API documentation).

This plugin has no configuration settings.

Demo Server

Support Forum

License

These plugins are licenced unter the GNU GPLv3.