[wiaflos-devel] COMMIT - r257 - trunk/contrib/templates/reports

[svn at linuxrulz.org]

Author: nkukard
Date: 2008-11-08 16:44:20 +0000 (Sat, 08 Nov 2008)
New Revision: 257

Modified:
   trunk/contrib/templates/reports/README
Log:
* Documented new reporting API functions & usage


Modified: trunk/contrib/templates/reports/README
===================================================================
--- trunk/contrib/templates/reports/README	2008-11-08 16:43:39 UTC (rev 256)
+++ trunk/contrib/templates/reports/README	2008-11-08 16:44:20 UTC (rev 257)
@@ -7,3 +7,20 @@
 
 api_inventory_stock_balances - Return stock balances
 
+
+# Variables
+
+api_variable_new($variable_name,$variable_type) - Function to create a variable
+api_variable_add($variable_name,$value) - Function to add something to a variable
+api_variable_subtract($variable_name,$value) - Function to subtract something to a variable
+api_variable_get($variable_name) - Function to get variable pretty value
+api_variable_getraw($variable_name) - Function to get variable raw value
+
+api_format_amount($amount,$options) - Function to format and/or change an amount
+Options:
+	API_FMT_REVERSE - Reverse amount, multiply it by -1
+	API_FMT_NEGBRACKET - Put negative amount in brackets
+		
+
+api_dump(variable1, variable2 ...) - Dump variables to STDERR of server
+