ADOdb

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== getMenu3 ======
~~NOTOC~~
<WRAP info>
This method requires that ADODB_FETCH_MODE be set to ADODB_FETCH_NUM prior to execution of the SQL statement that will provide the recordset.
</WRAP>
<WRAP right box>
== See Also ==
[[v5:reference:recordset:getmenu|getMenu()]]\\
[[v5:reference:recordset:getmenu2|getMenu2()]]\\

== Syntax ==
  string getMenu3(
      optional string $selectName='',
      optional mixed $defaultValue=false,
      optional mixed $blankFirstItem=true,
      optional bool $multiple=false,
      optional int $numberOfRows=0,
      optional string $optionalAttributes=''
      )
  
  
</WRAP>
===== Description =====
The function ''getMenu3()'' Generates an HTML OPTGROUP select string from a recordset, and returns the string. The recordset requires 3 columns, the 3rd being used for the optgroup. The select can be defined as either a single or multiple select.

In order for the optgroup to work correctly, the SQL statement used must be ORDERED by some order that begins with the 3rd column in the SELECT. 
If more than 3 columns are returned, the 4th and greater columns are discarded.
===== Parameters =====
==== $selectName =====
name of SELECT tag
==== $defaultValue ====
The value to highlight. Use either a string for a single value to match, or a numeric array if a multiselect box is going to be built and there are multiple matching defaults. 
==== $blankFirstLine ====
This parameter has the following available options:

  * true (default) - creates an empty ''<option></option>'' tag
  * false - does not creates an empty ''<option></option>'' tag
  * string value - creates an ''<option value=``>STRING</option>'' tag
  * string value format ''value:description'' - creates an ''<option value='value'>description</option>'' tag

==== $multiple ====
Set true to create a multi-select box
==== $numberOfRows ====
Number of rows to show for multi-select box. If not a multi-select, this field has no meaning.
==== $optionalAttributes ====
Additional attributes to defined for SELECT tag, useful for holding javascript onChange='...' handlers or class information. Note that by default, the select box is generated without an id, so this should be included here.
===== Usage =====
<code php>
/*
* Connect to DB2 Sample Database
*/
$db->setFetchMode(ADODB_FETCH_NUM);
$SQL = "SELECT actdesc,actno,actgroup FROM act ORDER BY actgroup, actno
$result = $db->execute($SQL);

$html = $result->getMenu3('mySelect',
                          array('30','40','50'),
                          true,
                          true,
                          10,
                          'id="mySelect" class="myclass-1 myclass-2");

print $html

</code>

<code html>
<select name="mySelect[]" multiple size="10" id="mySelect" class="myclass-1 myclass-2">
<option></option>
<optgroup label='ANALYSIS/DESIGN'>
<option value='10'>MANAGE/ADVISE</option>
<option value='20'>ESTIMATE COST</option>
<option selected='selected' value='30'>DEFINE SPECS</option>
<option selected='selected' value='40'>LEAD PROGRAM/DESIGN</option>
<option selected='selected' value='50'>WRITE SPECS</option>
<option value='60'>DESCRIBE LOGIC</option>
</optgroup>
<optgroup label='PROGRAM/TEST/INSTALL'>
<option value='70'>CODE PROGRAMS</option>
<option value='80'>TEST PROGRAMS</option>
<option value='90'>ADM QUERY SYSTEM</option>
</optgroup>
<optgroup label='POST INSTALLATION'>
<option value='100'>TEACH CLASSES</option>
<option value='110'>DEVELOP COURSES</option>
<option value='120'>PERS AND STAFFING</option>
<option value='130'>OPER COMPUTER SYS</option>
<option value='140'>MAINT SOFTWARE SYS</option>
<option value='150'>ADM OPERATING SYS</option>
<option value='160'>ADM DATA BASES</option>
<option value='170'>ADM DATA COMM</option>
<option value='180'>DOCUMENT</option>
</optgroup>
</select>
</code>