V1.12: Implement custom counter format, given in the number format string after a pipe.

This feature finally allows e.g. a yearly counter when the order number contains the month, too.

Makefile

 BASE=ordernumber
 PLUGINTYPE=vmshopper
-VERSION=1.11
+VERSION=1.12
 
 PLUGINFILES=$(BASE).php $(BASE).script.php $(BASE).xml index.html
 

language/de-DE/de-DE.plg_vmshopper_ordernumber.ini

@@ -12,7 +12,7 @@ PLG_ORDERNUMBER_ORDERNR="<b>Auftragsgsnummern</b>"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE="Auftragsnummern anpassen"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Auftragsnummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_ORDERNR_FMT="Format der Auftragsnummern"
-PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Auftragsnummern angeben."
+PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Auftragsnummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_ORDERNR_COUNTER="Zähler"
 PLG_ORDERNUMBER_ORDERNR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_ORDERNR_PADDING="Mindestziffern für den Zähler"
@@ -28,7 +28,7 @@ PLG_ORDERNUMBER_INVOICENR="<b>Rechnungsnummern</b>"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE="Rechnungsnummern anpassen"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Rechnungsnummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_INVOICENR_FMT="Format der Rechnungsnummern"
-PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Hier können Sie Ihr eigenes Format für Rechnungsnummern angeben."
+PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Hier können Sie Ihr eigenes Format für Rechnungsnummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_INVOICENR_COUNTER="Zähler"
 PLG_ORDERNUMBER_INVOICENR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_INVOICENR_PADDING="Mindestziffern für den Zähler"
@@ -38,7 +38,7 @@ PLG_ORDERNUMBER_CUSTOMERNR="<b>Kundennummern</b>"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE="Kundennummern anpassen"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Kundennummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_CUSTOMERNR_FMT="Format der Kundennummern"
-PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Kundennummern angeben."
+PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Kundennummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER="Zähler"
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_CUSTOMERNR_PADDING="Mindestziffern für den Zähler"

language/de-DE/de-DE.plg_vmshopper_ordernumber.sys.ini

@@ -12,7 +12,7 @@ PLG_ORDERNUMBER_ORDERNR="<b>Auftragsgsnummern</b>"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE="Auftragsnummern anpassen"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Auftragsnummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_ORDERNR_FMT="Format der Auftragsnummern"
-PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Auftragsnummern angeben."
+PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Auftragsnummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_ORDERNR_COUNTER="Zähler"
 PLG_ORDERNUMBER_ORDERNR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_ORDERNR_PADDING="Mindestziffern für den Zähler"
@@ -28,7 +28,7 @@ PLG_ORDERNUMBER_INVOICENR="<b>Rechnungsnummern</b>"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE="Rechnungsnummern anpassen"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Rechnungsnummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_INVOICENR_FMT="Format der Rechnungsnummern"
-PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Hier können Sie Ihr eigenes Format für Rechnungsnummern angeben."
+PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Hier können Sie Ihr eigenes Format für Rechnungsnummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_INVOICENR_COUNTER="Zähler"
 PLG_ORDERNUMBER_INVOICENR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_INVOICENR_PADDING="Mindestziffern für den Zähler"
@@ -38,7 +38,7 @@ PLG_ORDERNUMBER_CUSTOMERNR="<b>Kundennummern</b>"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE="Kundennummern anpassen"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE_DESC="Hier ankreuzen, wenn Sie Ihre Kundennummern anpassen möchten und nicht die Standardeinstellung benutzen möchten."
 PLG_ORDERNUMBER_CUSTOMERNR_FMT="Format der Kundennummern"
-PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Kundennummern angeben."
+PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Hier können Sie Ihr eigenes Format für Kundennummern angeben. Variablennamen müssen in eckige Klammern gesetzt werden, z.B. [year]. Für sehr fortgeschrittene Anwendungen (normalerweise nicht nötig!) kann ein eigenes Format für den Zählernamen nach einem senkrechten Strich (|) angegeben werden. Standardmäßig wird das Format auch für den Zahler benutzt."
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER="Zähler"
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER_DESC="Wählen Sie aus, ob der Zähler global oder pro Formatwert laufen soll. Z.B. beginnt bei einem Format '[year]-#' und einem Zähler pro Formatwert der Zähler jedes Jahr bei 1."
 PLG_ORDERNUMBER_CUSTOMERNR_PADDING="Mindestziffern für den Zähler"

language/en-GB/en-GB.plg_vmshopper_ordernumber.ini

@@ -13,7 +13,7 @@ PLG_ORDERNUMBER_ORDERNR="<b>Order numbers</b>"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE="Customize order numbers"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE_DESC="Check here if you want customized order number formats rather than the default."
 PLG_ORDERNUMBER_ORDERNR_FMT="Format for order numbers"
-PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Here you can customize the order number"
+PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Here you can customize the order number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_ORDERNR_COUNTER="Counter"
 PLG_ORDERNUMBER_ORDERNR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the order count will be within the year only."
 PLG_ORDERNUMBER_ORDERNR_PADDING="Minimum digits for the counter"
@@ -29,7 +29,7 @@ PLG_ORDERNUMBER_INVOICENR="<b>Invoice numbers</b>"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE="Customize invoice numbers"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE_DESC="Check here if you want customized invoice number formats rather than the default."
 PLG_ORDERNUMBER_INVOICENR_FMT="Format for invoice numbers"
-PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Here you can customize the invoice number"
+PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Here you can customize the invoice number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_INVOICENR_COUNTER="Counter"
 PLG_ORDERNUMBER_INVOICENR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the invoice count will be within the year only."
 PLG_ORDERNUMBER_INVOICENR_PADDING="Minimum digits for the counter"
@@ -39,7 +39,7 @@ PLG_ORDERNUMBER_CUSTOMERNR="<b>Customer numbers</b>"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE="Customize customer numbers"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE_DESC="Check here if you want customized customer number formats rather than the default."
 PLG_ORDERNUMBER_CUSTOMERNR_FMT="Format for customer numbers"
-PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Here you can customize the customer number"
+PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Here you can customize the customer number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER="Counter"
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the customer count will be within the year only."
 PLG_ORDERNUMBER_CUSTOMERNR_PADDING="Minimum digits for the counter"

language/en-GB/en-GB.plg_vmshopper_ordernumber.sys.ini

@@ -13,7 +13,7 @@ PLG_ORDERNUMBER_ORDERNR="<b>Order numbers</b>"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE="Customize order numbers"
 PLG_ORDERNUMBER_ORDERNR_CUSTOMIZE_DESC="Check here if you want customized order number formats rather than the default."
 PLG_ORDERNUMBER_ORDERNR_FMT="Format for order numbers"
-PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Here you can customize the order number"
+PLG_ORDERNUMBER_ORDERNR_FMT_DESC="Here you can customize the order number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_ORDERNR_COUNTER="Counter"
 PLG_ORDERNUMBER_ORDERNR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the order count will be within the year only."
 PLG_ORDERNUMBER_ORDERNR_PADDING="Minimum digits for the counter"
@@ -29,7 +29,7 @@ PLG_ORDERNUMBER_INVOICENR="<b>Invoice numbers</b>"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE="Customize invoice numbers"
 PLG_ORDERNUMBER_INVOICENR_CUSTOMIZE_DESC="Check here if you want customized invoice number formats rather than the default."
 PLG_ORDERNUMBER_INVOICENR_FMT="Format for invoice numbers"
-PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Here you can customize the invoice number"
+PLG_ORDERNUMBER_INVOICENR_FMT_DESC="Here you can customize the invoice number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_INVOICENR_COUNTER="Counter"
 PLG_ORDERNUMBER_INVOICENR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the invoice count will be within the year only."
 PLG_ORDERNUMBER_INVOICENR_PADDING="Minimum digits for the counter"
@@ -39,7 +39,7 @@ PLG_ORDERNUMBER_CUSTOMERNR="<b>Customer numbers</b>"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE="Customize customer numbers"
 PLG_ORDERNUMBER_CUSTOMERNR_CUSTOMIZE_DESC="Check here if you want customized customer number formats rather than the default."
 PLG_ORDERNUMBER_CUSTOMERNR_FMT="Format for customer numbers"
-PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Here you can customize the customer number"
+PLG_ORDERNUMBER_CUSTOMERNR_FMT_DESC="Here you can customize the customer number. All variables need to be enclosed in square brackets like [year]. For very advanced uses (usually not needed!) it is possible to give a separate counter name format after a pipe symbol (|). By default the format string will also be the counter name."
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER="Counter"
 PLG_ORDERNUMBER_CUSTOMERNR_COUNTER_DESC="Choose whether you want one global counter or per-format value counters. E.g. with a format of '[year]-#' and the latter option checked, the customer count will be within the year only."
 PLG_ORDERNUMBER_CUSTOMERNR_PADDING="Minimum digits for the counter"

ordernumber.php

@@ -137,27 +137,33 @@ class plgVmShopperOrdernumber extends vmShopperPlugin {
         // First, replace all variables:
         $nr = $this->replace_fields ($fmt, $nrtype, $details);
 
+        // Split at a | to get the number format and a possibly different counter increment format
+        // If a separate counter format is given after the |, use it, otherwise reuse the number format itself as counter format
+        $parts = explode ("|", $nr);
+        $format = $parts[0];
+        $counterfmt = $parts[(count($parts)>1)?1:0];
+
         // Look up the current counter
         $db = JFactory::getDBO();
         /* prevent sql injection attacks by escaping the user-entered format! Empty for global counter... */
         /* For global counting, simply read the empty number_format entries! */
-        $nr_escaped = $global?"":$db->getEscaped ($nr);
-        $q = 'SELECT `count` FROM `'.$this->_tablename.'` WHERE `number_type`='.(int)$nrtype.' AND `number_format`="'.$nr_escaped.'"';
-        $db->setQuery($q);
+        $counterfmt = $global?"":$db->getEscaped ($counterfmt);
+        $q1 = 'SELECT `count` FROM `'.$this->_tablename.'` WHERE `number_type`='.(int)$nrtype.' AND `number_format`="'.$counterfmt.'"';
+        $db->setQuery($q1);
         $existing = $db->loadResult();
         $count = $existing?($existing+1):1;
 
         // Insert new counter value into the db
         if ($existing) {
-            $q = 'UPDATE `'.$this->_tablename.'` SET `count`= "'.$count.'" WHERE `number_type`='.(int)$nrtype.' AND `number_format`="'.$nr_escaped.'"';
+            $q = 'UPDATE `'.$this->_tablename.'` SET `count`= "'.$count.'" WHERE `number_type`='.(int)$nrtype.' AND `number_format`="'.$counterfmt.'"';
         } else {
-            $q = 'INSERT INTO `'.$this->_tablename.'` (`count`, `number_type`, `number_format`) VALUES ('.(int)$count.','.(int)$nrtype.', "'.$nr_escaped.'")';
+            $q = 'INSERT INTO `'.$this->_tablename.'` (`count`, `number_type`, `number_format`) VALUES ('.(int)$count.','.(int)$nrtype.', "'.$counterfmt.'")';
         }
         $db->setQuery( $q );
         $db->query();
 
         // return the format with the counter inserted
-        return str_replace ("#", sprintf('%0' . $padding . 's', $count), $nr);
+        return str_replace ("#", sprintf('%0' . $padding . 's', $count), $format);
     }
 
 

ordernumber.xml

@@ -7,8 +7,8 @@
     <authorUrl>http://www.open-tools.net/</authorUrl>
     <copyright>Copyright (C) 2012-2014 Reinhold Kainhofer. All rights reserved.</copyright>
     <license>http://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3</license>
-    <version>1.11</version>
-    <releaseDate>2014-08-31</releaseDate>
+    <version>1.12</version>
+    <releaseDate>2014-10-04</releaseDate>
     <releaseType>Minor update</releaseType>
     <downloadUrl>http://www.open-tools.net/virtuemart-2-extensions/vm2-ordernumber-plugin.html</downloadUrl>