Add docs for function
[squirrelmail.git] / templates / default / edit_list_widget.tpl
CommitLineData
cb606dfd 1<?php
2
3/**
4 * edit_list_widget.tpl
5 *
6 * Template for constructing an edit list.
7 *
8 * The following variables are available in this template:
9 *
b6a08d2d 10 * string $name The name of the edit list
11 * string $input_widget A preconstructed input text box used
12 * for adding new elements to the edit list
13 * boolean $use_input_widget Whether or not to present the $input_widget
de4c101c 14 * boolean $use_delete_widget Whether or not to present the $checkbox_widget
15 * string $select_widget A preconstructed select widget containing
16 * all the elements in the list
17 * string $checkbox_widget A preconstructed checkbox used for deleting
18 * elements from the edit list
b6a08d2d 19 * string $trailing_text Any text given by the caller to be displayed
20 * after the edit list input
21 * array $possible_values The original list of options in the edit list,
22 * for use constructing layouts alternative to
23 * the select widget
282f8e7c 24 * mixed $current_value The currently selected value(s)
cb606dfd 25 *
22387c8d 26 * @copyright 1999-2017 The SquirrelMail Project Team
cb606dfd 27 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
01144ffd 28 * @version $Id$
cb606dfd 29 * @package squirrelmail
30 * @subpackage templates
31 */
32
33
34// retrieve the template vars
35//
36extract($t);
37
38
b6a08d2d 39if ($use_input_widget)
40 echo _("Add") . '&nbsp;' . $input_widget . '<br />';
41
de4c101c 42echo $select_widget;
43
44if (!empty($possible_values) && $use_delete_widget)
45 echo '<br />' . $checkbox_widget . '&nbsp;<label for="delete_' . $name . '">'
46 . _("Delete Selected") . '</label>';