Differences

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

--- v5:dictionary:structure:introduction [2016/04/09 21:35] – mnewnham
+++ v5:dictionary:structure:introduction [2021/08/26 10:11] (current) – typos peterdd
@@ Line 9: / Line 9: @@
 [[v5:dictionary:structure:addindexitemobject|addIndexItemObject()]]\\
 [[v5:dictionary:structure:setnewname|setNewName()]]\\
-[[v5:dictionary:structure:complex_sample|Complex Example]]\\
+[[v5:dictionary:structure:platform|The Platform Keyword]]\\
+[[v5:dictionary:structure:sample_usage|Sample Usage]]\\
 </WRAP>
 ===== Description =====
 From ADOdb Version 5.21, A new method of managing changes to the schema has been added. This method is called //**Structured**// schema management to signify the more formal method of managing elements. The original method, referred to as //**Simple**//, remains unchanged.
-In Structured schema management, the elements that can be modified through the dictionary management routines such as [[v5:dictionary:createindexsql|createIndexSql()]],[[v5:dictionary:dropcolumnsql|dropSql()]] and [[v5:dictionary:createtablesql|createtableSql()]] can be created and represented as objects prior to them being passed to the methods that create the SQL necessary to create them in the database. The concept is built on [[v5:axmls:axmls_index|AXMLS]] and contains some feature overlap.
+In Structured schema management, the elements that can be modified through the dictionary management routines such as [[v5:dictionary:createindexsql|createIndexSql()]], [[v5:dictionary:dropcolumnsql|dropColumnSql()]] and [[v5:dictionary:createtablesql|createTableSql()]] can be created and represented as objects prior to them being passed to the methods that create the SQL necessary to create them in the database. The concept is built on [[v5:axmls:axmls_index|AXMLS]] and contains some feature overlap.
 These objects can then be easily stored through the use of technologies such as JSON, which can easily be manipulated through 3rd party tools and reprocessed.
-Each table, and element of a table (such as a column or index) is represented by a PHP object called a //**metaObjectStructure**//. Each of these objects can store an unlimited number of additional attributes that represent configuration items for the element. The attributes themselves can be defined as platform-specific.
+Each table and element of a table (such as a column or index) is represented by a PHP object called a //**metaObjectStructure**//. Each of these objects can store an unlimited number of additional attributes that represent configuration items for the element. The attributes themselves can be defined as platform-specific.
 ===== Construction Of The Structure =====
@@ Line 43: / Line 44: @@
 The structure is not automatically sent to createTableSql, it must be deliberately passed on. This is important because it allows the returned object be to re-used or stored, for example by serializing or JSON-encoding it. Conceivably, a JSON-encoded object could be passed in by a 3rd party application and used.
-In this example, we create a table 'TEST' with a single column 'COL1', and extract the structure
+In this example, we create a table 'test' with a single column 'COL1', and extract the structure
 <code php>
 $dict = newDataDictionary($db);
-$t = new metaObjectStructure($dict,'test');
+$t = new metaObjectStructure($dict, 'test');
 /*
 * Make sure the table is transactional in MySQL
 */
-$t->addAttribute('ENGINE INNODB','mysql');
+$t->addAttribute('ENGINE INNODB', 'mysql');
 /*
 * Add the column
 */
-$t->addColumnObject('COL1','I');
+$t->addColumnObject('COL1', 'I');
 /*