Differences

This shows you the differences between two versions of the page.

--- axmls:setprefix [2015/11/05 02:42] – created mnewnham
+++ axmls:setprefix [2015/12/19 16:58] – mnewnham
@@ Line 1: / Line 1: @@
-boolean SetPrefix ([string $prefix = ], [boolean $underscore = TRUE])
+====== setPrefix ======
+~~NOTOC~~
+<WRAP right box>
+== Syntax ==
+  boolean setPrefix (
+    string $prefix = ''
+    optional bool $addUnderscore=true
+    )
+</WRAP>
+===== Description =====
+Sets a prefix for database objects
+Call this method to set a standard prefix that will be prepended to all database tables and indices.
+If the optional ''$addUnderscore'' parameter is set, an underscore is automatically appended to the prefix.
+===== Usage =====
+<code php>
+/*
+* Assuming xml schema contains tables a,b,c
+*/
+$axmls->setPrefix('test');
+/*
+* tables will be created as 'test_a','test_b','test_c'
+*/
+$axmls->setPrefix('test',false);
+/*
+* tables will be created as 'testa','testb','testc'
+*/
+</code>