list_dropdown>>
Outputs an HTML dropdown object containing the different Brimbox lists available for a given layout. This method is usually used within the Brimbox required form.
Class: bb_main, called as $main
File: bb_main.php (php)
Declaration:
function list_dropdown($arr_lists, $name, $list_number, $params = array())
Usage:
$main->list_dropdown($arr_lists, $name, $list_number, $params);
Outputs: Dropdown menu of available lists, the key to the dropdown is usually is the list number.
Note: There is a archive option $archive
in the optional $params
array.
Parameter: $arr_lists (array)
Reduced lists array from the json_table
to be populated into a dropdown select tag. It should be reduced by $row_type
. The value of the dropdown is the list number and the displayed choice is the list name.
Parameter: $name (string)
Name of the HTML select object, usually called list_number.
It corresponds to the list number in the list array.
Parameter: $list_number (integer)
The list number to be currently selected in the dropdown, usually from the interface state or a postback. Causes the select tag to be selected
for list specified.
Parameter: $params (optional array)
The parameters array for passing custom parameters to the function. Parameters not reserved will be outputted as HTML attributes.
Reserved Parameters:
archive
, default false, true will include archived lists (boolean)empty
, default false, true will set an empty value of -1 (0 reserved for all) (boolean)
Updated: 2016-07-17