Coding standards
Security in ResourceSpace
Developer reference
Database
Action functions
Admin functions
Ajax functions
Annotation functions
API functions
Collections functions
Comment functions
Config functions
CSV export functions
Dash functions
Debug functions
Encryption functions
Facial recognition functions
File functions
General functions
Language functions
Log functions
Login functions
Message functions
Migration functions
Node functions
PDF functions
Plugin functions
Render functions
Reporting functions
Request functions
Research functions
Slideshow functions
Theme permission functions
User functions
Video functions
Database functions
Metadata functions
Resource functions
Search functions
Map functions
Job functions
Tab functions
Test functions

config_boolean_select()

Description

Generate an html boolean select block

to array('False', 'True') in the local language.
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 boolean The current value (true or false) of the config variable being set.
$choices ''
$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
$help string '' Help text to display for this question
$reload_page boolean false Reload the page after saving, useful for large CSS changes.
array string $choices Array of the text to display for the two choices: False and True. Defaults

Location

include/config_functions.php lines 842 to 906

Definition

 
function config_boolean_select(
    $name,
    $label,
    $current,
    $choices = '',
    $width = 420,
    $title = null,
    $autosave = false,
    $on_change_js = null,
    $hidden = false,
    string $help = '',
    bool $reload_page = false
)
    {
    global $lang;

    $help = trim($help);

    if($choices == '')
        {
        $choices = $lang['false-true'];
        }

    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']);
        }
    
    $html_question_id = "question_{$name}";
    ?>
    <div class="Question" id=" echo escape($html_question_id); ?>"  if ($hidden){echo "style=\"display:none;\"";} ?> >
        <label for=" echo escape($name); ?>" title=" echo escape($title); ?>">
             echo strip_tags_and_attributes($label, ['a'], ['href', 'target']); ?>
        </label>

        
        if($autosave)
            {
            ?>
            <div class="AutoSaveStatus">
                <span id="AutoSaveStatus- echo escape($name); ?>" style="display:none;"></span>
            </div>
            
            }
            ?>
        <select id=" echo escape($name); ?>"
                name=" echo escape($name); ?>"
                 if($autosave) { ?>
                    onChange=" echo $on_change_js; ?>AutoSaveConfigOption(' echo escape($name); ?>' echo $reload_page ? ", true" : ""?>);"
                 } ?>
                style="width: echo (int) $width; ?>px">
            <option value="1" if($current == '1') { ?> selected } ?>> echo $choices[1]; ?></option>
            <option value="0" if($current == '0') { ?> selected } ?>> echo $choices[0]; ?></option>
        </select>
        
        if ($help !== '')
            {
            render_question_form_helper($help, $html_question_id, []);
            }
        ?>
        <div class="clearerleft"></div>
    </div>
    
    }

This article was last updated 4th December 2024 09:05 Europe/London time based on the source file dated 13th November 2024 15:50 Europe/London time.