path: root/includes/view-helpers/select_field.php

<?php
// SPDX-FileCopyrightText: 2021 Andrea Chirulescu <andrea.chirulescu@gmail.com>
// SPDX-FileCopyrightText: 2021 Harald Eilertsen <haraldei@anduin.net>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

namespace EternalTerror\ViewHelpers;

/**
 * Return HTML code for a selction box with the given options and preselected value.
 *
 * @param string    $name     The name attribute for the selection box
 * @param array     $opts     The options as arrays of [value, label] pairs
 * @param mixed|int $selected The value of the preselected option, or null if no
 *                            option is preselected.
 * @param string    $blank    Text to use for "no selection", defaults to "Please
 *                            select..."
 * @return string
 */
function select_field(
    string $name,
    array $opts = array(),
    $selected = null,
    string $blank = 'Please select...' ) : string {
    $body = "<option value=\"\">{$blank}</option>";
    foreach ( $opts as $opt ) {
        $sel = selected( $selected, $opt[0], false );
        $body .= "<option value=\"{$opt[0]}\"{$sel}>{$opt[1]}</option>";
    }
    return "<select name=\"{$name}\">{$body}</select>";
}