define('SMOPT_TYPE_FLDRLIST', 8);
define('SMOPT_TYPE_FLDRLIST_MULTI', 9);
define('SMOPT_TYPE_EDIT_LIST', 10);
+define('SMOPT_TYPE_STRLIST_MULTI', 11);
+define('SMOPT_TYPE_BOOLEAN_CHECKBOX', 12);
+define('SMOPT_TYPE_BOOLEAN_RADIO', 13);
/* Define constants for the options refresh levels. */
define('SMOPT_REFRESH_NONE', 0);
* @var string
*/
var $trailing_text;
+ /**
+ * Text that overrides the "Yes" label for boolean
+ * radio option widgets
+ *
+ * @var string
+ */
+ var $yes_text;
+ /**
+ * Text that overrides the "No" label for boolean
+ * radio option widgets
+ *
+ * @var string
+ */
+ var $no_text;
/**
* text displayed to the user
*
$this->htmlencoded = $htmlencoded;
$this->size = SMOPT_SIZE_MEDIUM;
$this->trailing_text = '';
+ $this->yes_text = '';
+ $this->no_text = '';
$this->comment = '';
$this->aExtraAttribs = array();
$this->post_script = '';
}
}
+ /** Convenience function that identifies which types of
+ widgets are stored as (serialized) array values. */
+ function is_multiple_valued() {
+ return ($this->type == SMOPT_TYPE_FLDRLIST_MULTI
+ || $this->type == SMOPT_TYPE_STRLIST_MULTI
+ || $this->type == SMOPT_TYPE_EDIT_LIST);
+ }
+
/**
* Set the value for this option.
* @param mixed $value
$this->trailing_text = $trailing_text;
}
+ /**
+ * Set the yes_text for this option.
+ * @param string $yes_text
+ */
+ function setYesText($yes_text) {
+ $this->yes_text = $yes_text;
+ }
+
+ /**
+ * Set the no_text for this option.
+ * @param string $no_text
+ */
+ function setNoText($no_text) {
+ $this->no_text = $no_text;
+ }
+
/**
* Set the comment for this option.
* @param string $comment
}
/**
- * Set the trailing_text for this option.
+ * Set the folder_filter for this option.
* @param string $folder_filter
* @since 1.5.1
*/
case SMOPT_TYPE_BOOLEAN:
$result = $this->createWidget_Boolean();
break;
+ case SMOPT_TYPE_BOOLEAN_CHECKBOX:
+ $result = $this->createWidget_Boolean(TRUE);
+ break;
+ case SMOPT_TYPE_BOOLEAN_RADIO:
+ $result = $this->createWidget_Boolean(FALSE);
+ break;
case SMOPT_TYPE_HIDDEN:
$result = $this->createWidget_Hidden();
break;
case SMOPT_TYPE_EDIT_LIST:
$result = $this->createWidget_EditList();
break;
+ case SMOPT_TYPE_STRLIST_MULTI:
+ $result = $this->createWidget_StrList(TRUE);
+ break;
default:
error_box (
sprintf(_("Option Type '%s' Not Found"), $this->type)
* $this->possible_values are assumed to be display-safe.
* Use with care!
*
+ * @param boolean $multiple_select When TRUE, the select widget
+ * will allow multiple selections
+ * (OPTIONAL; default is FALSE
+ * (single select list))
+ *
* @return string html formated selection box
+ *
*/
- function createWidget_StrList() {
+ function createWidget_StrList($multiple_select=FALSE) {
//FIXME: Currently, $this->htmlencoded is ignored here -- was removed when changing to template-based output; a fix is available as part of proposed centralized sanitizing patch
- return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+
+ switch ($this->size) {
+//FIXME: not sure about these sizes... seems like we could add another on the "large" side...
+ case SMOPT_SIZE_TINY:
+ $height = 3;
+ break;
+ case SMOPT_SIZE_SMALL:
+ $height = 8;
+ break;
+ case SMOPT_SIZE_LARGE:
+ $height = 15;
+ break;
+ case SMOPT_SIZE_HUGE:
+ $height = 25;
+ break;
+ case SMOPT_SIZE_NORMAL:
+ default:
+ $height = 5;
+ }
+
+ return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height, !$this->htmlencoded) . htmlspecialchars($this->trailing_text);
}
}
/**
- * Creates radio field (yes/no)
- * @return string html formated radio field
+ * Create boolean widget
+ *
+ * When creating Yes/No radio buttons, the "yes_text"
+ * and "no_text" option attributes are used to override
+ * the typical "Yes" and "No" text.
+ *
+ * @param boolean $checkbox When TRUE, the widget will be
+ * constructed as a checkbox,
+ * otherwise it will be a set of
+ * Yes/No radio buttons (OPTIONAL;
+ * default is TRUE (checkbox)).
+ *
+ * @return string html formated boolean widget
+ *
*/
- function createWidget_Boolean() {
+ function createWidget_Boolean($checkbox=TRUE) {
global $oTemplate, $nbsp;
- /* Build the yes choice. */
- $yes_option = addRadioBox('new_' . $this->name, ($this->value != SMPREF_NO), SMPREF_YES, array_merge(array('id' => 'new_' . $this->name . '_yes'), $this->aExtraAttribs)) . $nbsp . create_label(_("Yes"), 'new_' . $this->name . '_yes');
- /* Build the no choice. */
- $no_option = addRadioBox('new_' . $this->name, ($this->value == SMPREF_NO), SMPREF_NO, array_merge(array('id' => 'new_' . $this->name . '_no'), $this->aExtraAttribs)) . $nbsp . create_label(_("No"), 'new_' . $this->name . '_no');
+ // checkbox...
+ //
+ if ($checkbox) {
+ $result = addCheckbox('new_' . $this->name, ($this->value != SMPREF_NO), SMPREF_YES, array_merge(array('id' => 'new_' . $this->name), $this->aExtraAttribs)) . $nbsp . create_label($this->trailing_text, 'new_' . $this->name);
+ }
+
+ // radio buttons...
+ //
+ else {
+
+ /* Build the yes choice. */
+ $yes_option = addRadioBox('new_' . $this->name, ($this->value != SMPREF_NO), SMPREF_YES, array_merge(array('id' => 'new_' . $this->name . '_yes'), $this->aExtraAttribs)) . $nbsp . create_label((!empty($this->yes_text) ? $this->yes_text : _("Yes")), 'new_' . $this->name . '_yes');
+
+ /* Build the no choice. */
+ $no_option = addRadioBox('new_' . $this->name, ($this->value == SMPREF_NO), SMPREF_NO, array_merge(array('id' => 'new_' . $this->name . '_no'), $this->aExtraAttribs)) . $nbsp . create_label((!empty($this->no_text) ? $this->no_text : _("No")), 'new_' . $this->name . '_no');
+
+ /* Build the combined "boolean widget". */
+ $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
+
+ }
- /* Build and return the combined "boolean widget". */
- $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
return ($result);
}
*/
function createWidget_EditList() {
- global $br, $nbsp;
+ global $oTemplate;
switch ($this->size) {
//FIXME: not sure about these sizes... seems like we could add another on the "large" side...
$height = 5;
}
-//FIXME: $this->aExtraAttribs and $this->trailing_text probably should only be used in one place
-//FIXME: might be nice to have this in a template file instead of creating layout here
- return create_label(_("Add"), '')
- . $nbsp . addInput('add_' . $this->name, '', 38, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text)
- . $br . addSelect('new_' . $this->name, $this->possible_values, $this->value, FALSE, !checkForJavascript() ? $this->aExtraAttribs : array_merge(array('onchange' => 'if (typeof(window.addinput) == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' . $this->name . '\' ) { pos = j; } j++; } i++; } if( pos >= 0 ) { window.addinput = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput.value = this.options[x].value; break; } }'), $this->aExtraAttribs), TRUE, $height) . htmlspecialchars($this->trailing_text)
- . $br
- . addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs))
- . $nbsp . create_label(_("Delete Selected"), 'delete_' . $this->name);
+ if (empty($this->possible_values)) $this->possible_values = array();
+ if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
+
+//FIXME: $this->aExtraAttribs probably should only be used in one place
+ $oTemplate->assign('input_widget', addInput('add_' . $this->name, '', 38, 0, $this->aExtraAttribs));
+ $oTemplate->assign('trailing_text', $this->trailing_text);
+ $oTemplate->assign('select_widget', addSelect('new_' . $this->name, $this->possible_values, $this->value, FALSE, !checkForJavascript() ? $this->aExtraAttribs : array_merge(array('onchange' => 'if (typeof(window.addinput) == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' . $this->name . '\' ) { pos = j; } j++; } i++; } if( pos >= 0 ) { window.addinput = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput.value = this.options[x].value; break; } }'), $this->aExtraAttribs), TRUE, $height));
+ $oTemplate->assign('checkbox_widget', addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs)));
+ $oTemplate->assign('name', $this->name);
+ return $oTemplate->fetch('edit_list_widget.tpl');
}
//
if ($option->type == SMOPT_TYPE_EDIT_LIST) {
+ if (empty($option->possible_values)) $option->possible_values = array();
+ if (!is_array($option->possible_values)) $option->possible_values = array($option->possible_values);
+
// add element if given
//
if (sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) {
// Certain option types need to be serialized because
// they are not scalar
//
- } else if ($option->type == SMOPT_TYPE_FLDRLIST_MULTI)
+ } else if ($option->is_multiple_valued())
setPref($data_dir, $username, $option->name, serialize($option->new_value));
else
$next_option->setTrailingText($optset['trailing_text']);
}
+ /* If provided, set the yes_text for this option. */
+ if (isset($optset['yes_text'])) {
+ $next_option->setYesText($optset['yes_text']);
+ }
+
+ /* If provided, set the no_text for this option. */
+ if (isset($optset['no_text'])) {
+ $next_option->setNoText($optset['no_text']);
+ }
+
/* If provided, set the comment for this option. */
if (isset($optset['comment'])) {
$next_option->setComment($optset['comment']);
projects / squirrelmail.git / blobdiff