Collections functions
Encryption functions
General functions
Render functions
Theme permission functions
Video functions
Resource functions

config_single_select()

Description

Generate an html single-select + options block

are used as the values of the options, and the values are the alternatives the user sees. (But
see $usekeys, below.) Usually a $lang entry whose value is an array of strings.
to false the values from $choices will be used for both the values of the options and the text
the user sees. Defaulted to true.
Note: onChange event will call AutoSaveConfigOption([option name])

Parameters

ColumnTypeDefaultDescription
$name string The name of the select block. Usually the name of the config variable being set.
$label string The user text displayed to label the select block. Usually a $lang string.
$current string The current value of the config variable being set.
$choices
$usekeys boolean true Tells whether to use the keys from $choices as the values of the options. If set
$width integer 420 The width of the input field in pixels. Default: 420.
$title string null Title to be used for the label title. Default: null
$autosave boolean false Flag to say whether the there should be an auto save message feedback through JS. Default: false
$on_change_js null
$hidden false
array string $choices The array of the alternatives -- the options in the select block. The keys

Location

include/config_functions.php lines 602 to 639

Definition

 
function config_single_select($name$label$current$choices$usekeys true$width 420$title null$autosave false$on_change_js=null,$hidden=false)
    {
    global 
$lang;
    
    if(
is_null($title))
        {
        
// This is how it was used on plugins setup page. Makes sense for developers when trying to debug and not much for non-technical users
        
$title str_replace('%cvn'$name$lang['plugins-configvar']);
        }
    
?>
    <div class="Question" id="question_ echo $name?> if ($hidden){echo "style=\"display:none;\"";} ?> >
        <label for=" echo $name?>" title=" echo $title?>"> echo $label?></label>
        
        
if($autosave)
            {
            
?>
            <div class="AutoSaveStatus">
                <span id="AutoSaveStatus- echo $name?>" style="display:none;"></span>
            </div>
            
            
}
        
?>
        <select id=" echo $name?>"
                name=" echo $name?>"
                 if($autosave) { ?> onChange=" echo $on_change_js?>AutoSaveConfigOption(' echo $name?>');" ?>
                style="width: echo $width?>px">
        
        
foreach($choices as $key => $choice)
            {
            
$value $usekeys $key $choice;
            echo 
'<option value="' $value '"' . (($current == $value) ? ' selected' '') . ">$choice</option>";
            }
        
?>
        </select>
     <div class="clearerleft"></div>
    </div>
    
    
}

This article was last updated 26th November 2020 03:05 Europe/London time based on the source file dated 6th October 2020 10:25 Europe/London time.