ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools

Trace:
v5:reference:recordset:getmenu

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
v5:reference:recordset:getmenu [2019/01/01 23:14] – mnewnhamv5:reference:recordset:getmenu [2019/11/24 00:16] (current) – Add wrap around fetch mode note dregad
Line 1: Line 1:
 ====== getMenu ====== ====== getMenu ======
 ~~NOTOC~~ ~~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> <WRAP right box>
 == See Also == == See Also ==
Line 10: Line 7:
 == Syntax == == Syntax ==
   string getMenu(   string getMenu(
-      optional string $selectName='',+      string $selectName,
       optional mixed $defaultValue=false,       optional mixed $defaultValue=false,
-      optional bool $blankFirstItem=true,+      optional mixed $blankFirstItem=true,
       optional bool $multiple=false,       optional bool $multiple=false,
       optional int $numberOfRows=0,       optional int $numberOfRows=0,
Line 22: Line 19:
 </WRAP> </WRAP>
 ===== Description ===== ===== Description =====
-The function ''getMenu()'' Generate an HTML SELECT tag string from a recordset, and return the string.  + 
-If the returned recordset has a single column, the option values and descriptions are the same. +The function ''getMenu()'' generates an HTML SELECT tag string from a recordset, and returns the string. 
-If the returned recordset has 2 cols, the 1st column is the description and the 2nd column is the value. By default, the 2nd column is matched against the defaut, if provided. + 
 +If the recordset has a single column, the option values and descriptions are the same. 
 +If it has 2 columns, the first one is the description and the second is the value. By default, the 2nd column is matched against ''$defaultValue'', if provided.  
 + 
 +Any extra column beyond the first two will be discarded. 
 + 
 +<WRAP info left> 
 +Until ADOdb 5.20.13, this method required that [[v5:reference:adodb_fetch_mode|ADODB_FETCH_MODE]] be set to ''ADODB_FETCH_NUM'' prior to execution of the SQL statement that will provide the recordset. Starting with 5.20.14, all fetch modes are supported 
 +</WRAP> 
 ===== Parameters ===== ===== Parameters =====
 ==== $selectName ===== ==== $selectName =====
Line 31: Line 37:
 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.  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 ==== ==== $blankFirstLine ====
-true to leave the 1st item in list empty+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 ==== ==== $multiple ====
 Set true to create a multi-select box Set true to create a multi-select box
Line 39: Line 51:
 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. 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.
 ==== $compareAgainstFirstCol ==== ==== $compareAgainstFirstCol ====
-If we have 2 columns, by default the default value is located by matching against the 2nd column (the value). By setting this flag to false, we can locate the selected option by matching against the 1st column (the description). +If we have 2 columns, by default the default value is located by matching against the 2nd column (the value). By setting this flag to false, we can locate the selected option by matching against the 1st column (the description). This works even if the list of selected items is an array
 ===== Usage ===== ===== Usage =====
 <code php> <code php>
v5/reference/recordset/getmenu.1546380871.txt.gz · Last modified: 2019/01/01 23:14 by mnewnham