Differences

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

--- axmls:axmls_functions [2015/11/05 02:28] – mnewnham
+++ v5:axmls:axmls_functions [2016/01/13 02:26] (current) – ↷ Links adapted because of a move operation mnewnham
@@ Line 1: / Line 1: @@
 ====== AXMLS Function Reference ======
-===== Variables =====
+<WRAP tip>
-| [[reference:$ADODB_COUNTRECS]]         | In database drivers that do not support native recordset counting, controls whether to emulate the functionality                       |
+Unlike core ADOdb methods, AXMLS methods that accept boolean arguments, also require that the type of the argument passed be boolean (true/false). Passing an implied boolean value (1/0 or 'value'/'') may cause unexpected results.
-===== Constants =====
-|[[reference:ADODB_ASSOC_CASE]]|Controls the case-specifity of recordset keys returned as associative arrays|
-===== Methods =====
-| [[reference:adonewconnection|adoNewConnection() ]]  | Create a new connection object |
-| [[axmls:adoSchema|adoSchema]]| (object &$db)||
-| [[axmls:continueonerror|continueOnError()]]  |bool ContinueOnError ([bool $mode = NULL])|
+This behaviour may change in later versions of ADOdb.
-| [[axmls:convertschemafile|convertSchemaFile()]]|  string ConvertSchemaFile (string $filename, [string $newVersion = NULL], [string $newFile = NULL])|
+</WRAP>
-| [[axmls:convertschemastring|convertSchemaString()]]|  string ConvertSchemaString (string $schema, [string $newVersion = NULL], [string $newFile = NULL])|
-| [[axmls:destroy|destroy()]]|  void Destroy ()|
+===== Methods =====
-| [[axmls:executeinline|executeInLine()]]|  bool ExecuteInline ([bool $mode = NULL])|
+| [[v5:axmls:adoschema|adoSchema]]                        | Creates a new AXMLS Object                                                      |
-| [[axmls:executeschema|executeSchema()]]|  integer ExecuteSchema ([array $sqlArray = NULL], [boolean $continueOnErr = NULL])|
+| [[v5:axmls:convertschemafile|convertSchemaFile()]]      | Converts an XML schema file to the specified DTD version.                       |
-| [[axmls:extractschema|extractSchema()]]|  string ExtractSchema ([boolean $data = FALSE])|
+| [[v5:axmls:convertschemastring|convertSchemaString()]]  | Converts an XML schema string to the specified DTD version.                     |
-| [[axmls:parseschma|parseSchema()]]|  array ParseSchema (mixed $filename, [bool $returnSchema = FALSE], string $file)|
+| [[v5:axmls:destroy|destroy()]]                          | Destroys an adoSchema object.                                                   |
-| [[axmls:parseschemafile|parseSchemaFile()]]|  array ParseSchemaFile (mixed $filename, [bool $returnSchema = FALSE], string $file)|
+| [[v5:axmls:executeinline|executeInLine()]]              | Enables/disables inline SQL execution.                                          |
-| [[axmls:parseschemastring|parseSchemaString()]]|  array ParseSchemaString (string $xmlstring, [bool $returnSchema = FALSE])|
+| [[v5:axmls:executeschema|executeSchema()]]              | Applies the current XML schema to the database (post execution).                |
-| [[axmls:printsql|printSql()]]|  array PrintSQL ([string $format = 'NONE'])|
+| [[v5:axmls:extractschema|extractSchema()]]              | Extracts an XML schema from an existing database.                               |
-| [[axmls:removeschema|removeSchema()]]|  array RemoveSchema (mixed $filename, [bool $returnSchema = FALSE], string $file)|
+| [[v5:axmls:parseschema|parseSchema()]]                  | Loads an XML schema from a file and converts it to SQL.                         |
-| [[axmls:removeschemastring|removeSchemaString()]]|  array RemoveSchemaString (string $schema, [bool $returnSchema = FALSE])|
+| [[v5:axmls:parseschemafile|parseSchemaFile()]]          | Loads an XML schema from a file and converts it to SQL.                         |
-| [[axmls:savesql|saveSql()]]|  boolean SaveSQL ([string $filename = './schema.sql'])|
+| [[v5:axmls:parseschemastring|parseSchemaString()]]      | Converts an XML schema string to SQL.                                           |
-| [[axmls:schemafileversion|schemaFileVersion()]]|  string SchemaFileVersion (string $filename)|
+| [[v5:axmls:printsql|printSql()]]                        | Returns the current SQL array.                                                  |
-| [[axmls:schemastringversion|schemaStringVersion()]]|  string SchemaStringVersion (string $xmlstring)|
+| [[v5:axmls:removeschema|removeSchema()]]                | Loads an XML schema from a file and converts it to uninstallation SQL.          |
-| [[axmls:setprefix|setPrefix()]]|  boolean SetPrefix ([string $prefix = ''], [boolean $underscore = TRUE])|
+| [[v5:axmls:removeschemastring|removeSchemaString()]]    | Converts an XML schema string to uninstallation SQL.                            |
-| [[axmls:setupgrademethod|setUpgradeMethod()]]|  string SetUpgradeMethod ([string $method = ''])|
+| [[v5:axmls:savesql|saveSql()]]                          | Saves the current SQL array to the local filesystem as a list of SQL queries.`  |
-| [[axmls:transformschema|transformSchema()]]|  void TransformSchema (mixed $schema, mixed $xsl, [mixed $schematype = 'string'])|
+| [[v5:axmls:schemafileversion|schemaFileVersion()]]      | Returns the AXMLS Schema Version of the requested XML schema file.              |
+| [[v5:axmls:schemastringversion|schemaStringVersion()]]  | Returns the AXMLS Schema Version of the provided XML schema string.             |
+| [[v5:axmls:setprefix|setPrefix()]]                      | Sets a prefix for database objects                                              |
+| [[v5:axmls:setupgrademethod|setUpgradeMethod()]]        | Sets the method to be used for upgrading an existing database                   |