Differences

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

--- v5:dictionary:structure:addindexitemobject [2016/04/09 19:04] – created mnewnham
+++ v5:dictionary:structure:addindexitemobject [2016/04/09 19:15] (current) – mnewnham
@@ Line 11: / Line 11: @@
       string $columnName,
       optional string $platform=''
+  )
-      )
 </WRAP>
 The method ''addIndexItemObject()'' is part of the **//Structured Schema Management//** suite, and adds an index item to the current [[v5:dictionary:structure:addindexobject|Index]] object.
@@ Line 21: / Line 21: @@
 ==== $columnName ====
 The column name must be the name of a previously defined [[v5:dictionary:structure:addcolumnobject|column]] object.
-==== Platform ====
+==== $platform ====
-The platform parameter can be any parameter recognized by the [[v5:dictionary:structure:platform|Platform]] keyword.
+The platform parameter can be any parameter recognized by the [[v5:dictionary:structure:platform|Platform]] keyword. If provided, the column would not be added to any platform that did not match the value provided.
 ===== Usage =====
-In the following example, a table **//employees//** is to be created. The table has 2 columns, COL1 and COL2 and an index COL1-IDX will be created, holding COL1.
+In the following example, a table **//employees//** is to be created. The table has 2 columns, COL1 and COL2 and an index COL1-IDX will be created, holding COL1 and COL2.
 <code php>
@@ Line 36: / Line 36: @@
 $i->addIndexItemObject('COL1-IDX','COL1')
+$i->addIndexItemObject('COL1-IDX','COL2')
 </code>