define('SMOPT_TYPE_COMMENT', 7);
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('SMOPT_TYPE_STRLIST_RADIO', 14);
+
+/* Define constants for the layout scheme for edit lists. */
+define('SMOPT_EDIT_LIST_LAYOUT_LIST', 0);
+define('SMOPT_EDIT_LIST_LAYOUT_SELECT', 1);
/* Define constants for the options refresh levels. */
define('SMOPT_REFRESH_NONE', 0);
* @subpackage prefs
*/
class SquirrelOption {
+ /**
+ * The original option configuration array
+ * @var array
+ */
+ var $raw_option_array;
/**
* The name of this setting
* @var string
* @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;
+ /**
+ * Some widgets support more than one layout type
+ *
+ * @var int
+ */
+ var $layout_type;
/**
* text displayed to the user
*
/**
* Constructor function
+ * @param array $raw_option_array
* @param string $name
* @param string $caption
* @param integer $type
* @param bool $htmlencoded
*/
function SquirrelOption
- ($name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
+ ($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
/* Set the basic stuff. */
+ $this->raw_option_array = $raw_option_array;
$this->name = $name;
$this->caption = $caption;
$this->type = $type;
$this->refresh_level = $refresh_level;
$this->possible_values = $possible_values;
$this->htmlencoded = $htmlencoded;
- $this->size = SMOPT_SIZE_MEDIUM;
+ $this->size = SMOPT_SIZE_NORMAL;
$this->trailing_text = '';
+ $this->yes_text = '';
+ $this->no_text = '';
$this->comment = '';
+ $this->layout_type = 0;
$this->aExtraAttribs = array();
$this->post_script = '';
/* Check for a new value. */
if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
- $this->new_value = '';
+ $this->new_value = NULL;
}
/* Set the default save function. */
}
}
+ /** 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 layout type for this option.
+ * @param int $layout_type
+ */
+ function setLayoutType($layout_type) {
+ $this->layout_type = $layout_type;
+ }
+
/**
* 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
*/
/**
* Creates fields on option pages according to option type
*
- * Function that calls other createWidget* functions.
- * @return string html formated option field
+ * This is the function that calls all other createWidget* functions.
+ *
+ * @return string The formated option field
+ *
*/
- function createHTMLWidget() {
+ function createWidget() {
global $color;
// Use new value if available
- if (!empty($this->new_value)) {
+ if (!is_null($this->new_value)) {
$tempValue = $this->value;
$this->value = $this->new_value;
}
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_FLDRLIST_MULTI:
$result = $this->createWidget_FolderList(TRUE);
break;
+ case SMOPT_TYPE_EDIT_LIST:
+ $result = $this->createWidget_EditList();
+ break;
+ case SMOPT_TYPE_STRLIST_MULTI:
+ $result = $this->createWidget_StrList(TRUE);
+ break;
+ case SMOPT_TYPE_STRLIST_RADIO:
+ $result = $this->createWidget_StrList(FALSE, TRUE);
+ break;
default:
error_box (
sprintf(_("Option Type '%s' Not Found"), $this->type)
$result .= $this->post_script;
// put correct value back if need be
- if (!empty($this->new_value)) {
+ if (!is_null($this->new_value)) {
$this->value = $tempValue;
}
/* Now, return the created widget. */
- return ($result);
+ return $result;
}
/**
$width = 25;
}
- return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+ return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
}
/**
- * Create selection box
+ * Create selection box or radio button group
*
* When $this->htmlencoded is TRUE, the keys and values in
* $this->possible_values are assumed to be display-safe.
* Use with care!
*
- * @return string html formated selection box
+ * Note that when building radio buttons instead of a select
+ * widget, if the "size" attribute is SMOPT_SIZE_TINY, the
+ * radio buttons will be output one after another without
+ * linebreaks between them. Otherwise, each radio button
+ * goes on a line of its own.
+ *
+ * @param boolean $multiple_select When TRUE, the select widget
+ * will allow multiple selections
+ * (OPTIONAL; default is FALSE
+ * (single select list))
+ * @param boolean $radio_buttons When TRUE, the widget will
+ * instead be built as a group
+ * of radio buttons (and
+ * $multiple_select will be
+ * forced to FALSE) (OPTIONAL;
+ * default is FALSE (select widget))
+ *
+ * @return string html formated selection box or radio buttons
+ *
*/
- function createWidget_StrList() {
+ function createWidget_StrList($multiple_select=FALSE, $radio_buttons=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);
+
+ // radio buttons instead of select widget?
+ //
+ if ($radio_buttons) {
+
+ global $br, $nbsp;
+ $result = '';
+ foreach ($this->possible_values as $real_value => $disp_value) {
+ $result .= addRadioBox('new_' . $this->name, ($this->value == $real_value), $real_value, array_merge(array('id' => 'new_' . $this->name . '_' . $real_value), $this->aExtraAttribs)) . $nbsp . create_label($disp_value, 'new_' . $this->name . '_' . $real_value);
+ if ($this->size != SMOPT_SIZE_TINY)
+ $result .= $br;
+ }
+
+ return $result;
+ }
+
+
+ // everything below applies to select widgets
+ //
+ 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);
}
*/
function createWidget_FolderList($multiple_select=FALSE) {
+ 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;
+ }
+
// possible values might include a nested array of
// possible values (list of folders)
//
$option_list = array('ignore' => _("unavailable"));
- // OK to use sq_htmlspecialchars() below because addSelect() already does
- return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select) . sq_htmlspecialchars($this->trailing_text);
+ return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . 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 = $oTemplate->fetch('non_breaking_space.tpl');
+ 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);
}
return ($result);
}
+ /**
+ * Creates an edit list
+ *
+ * Note that multiple layout types are supported for this widget.
+ * $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_*
+ * constants.
+ *
+ * @return string html formated list of edit fields and
+ * their associated controls
+ */
+ function createWidget_EditList() {
+
+ global $oTemplate;
+
+ switch ($this->size) {
+ case SMOPT_SIZE_TINY:
+ $height = 3;
+ break;
+ case SMOPT_SIZE_SMALL:
+ $height = 8;
+ break;
+ case SMOPT_SIZE_MEDIUM:
+ $height = 15;
+ break;
+ case SMOPT_SIZE_LARGE:
+ $height = 25;
+ break;
+ case SMOPT_SIZE_HUGE:
+ $height = 40;
+ break;
+ case SMOPT_SIZE_NORMAL:
+ default:
+ $height = 5;
+ }
+
+ 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('possible_values', $this->possible_values);
+ $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_' . $this->name . ') == \'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_' . $this->name . ' = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput_' . $this->name . '.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);
+
+ switch ($this->layout_type) {
+ case SMOPT_EDIT_LIST_LAYOUT_SELECT:
+ return $oTemplate->fetch('edit_list_widget.tpl');
+ case SMOPT_EDIT_LIST_LAYOUT_LIST:
+ return $oTemplate->fetch('edit_list_widget_list_style.tpl');
+ default:
+ error_box(sprintf(_("Edit List Layout Type '%s' Not Found"), $layout_type));
+ }
+
+ }
+
/**
*
*/
*
*/
function changed() {
+
+ // edit lists have a lot going on, so we'll always process them
+ //
+ if ($this->type == SMOPT_TYPE_EDIT_LIST) return TRUE;
+
return ($this->value != $this->new_value);
}
} /* End of SquirrelOption class*/
/**
- * Saves option
+ * Saves the option value (this is the default save function
+ * unless overridden by the user)
+ *
* @param object $option object that holds option name and new_value
*/
function save_option($option) {
+
+ // Can't save the pref if we don't have the username
+ //
if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
- /* Can't save the pref if we don't have the username */
return;
}
+
global $data_dir;
- setPref($data_dir, $username, $option->name, $option->new_value);
+
+ // edit lists: first add new elements to list, then
+ // remove any selected ones (note that we must add
+ // before deleting because the javascript that populates
+ // the "add" textbox when selecting items in the list
+ // (for deletion))
+ //
+ 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)) {
+ $new_element = trim($new_element);
+ if (!empty($new_element)
+ && !in_array($new_element, $option->possible_values))
+ $option->possible_values[] = $new_element;
+ }
+
+ // delete selected elements if needed
+ //
+ if (is_array($option->new_value)
+ && sqGetGlobalVar('delete_' . $option->name, $ignore, SQ_POST))
+ $option->possible_values = array_diff($option->possible_values, $option->new_value);
+
+ // save full list (stored in "possible_values")
+ //
+ setPref($data_dir, $username, $option->name, serialize($option->possible_values));
+
+ // Certain option types need to be serialized because
+ // they are not scalar
+ //
+ } else if ($option->is_multiple_valued())
+ setPref($data_dir, $username, $option->name, serialize($option->new_value));
+
+ // Checkboxes, when unchecked, don't submit anything in
+ // the POST, so set to SMPREF_OFF if not found
+ //
+ else if (($option->type == SMOPT_TYPE_BOOLEAN
+ || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
+ && empty($option->new_value))
+ setPref($data_dir, $username, $option->name, SMPREF_OFF);
+
+ else
+ setPref($data_dir, $username, $option->name, $option->new_value);
+
+
+ // if a checkbox or multi select is zeroed/cleared out, it
+ // needs to have an empty value pushed into its "new_value" slot
+ //
+ if (($option->type == SMOPT_TYPE_STRLIST_MULTI
+ || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
+ && is_null($option->new_value))
+ $option->new_value = '';
+
}
/**
foreach ($grpopts as $optset) {
/* Create a new option with all values given. */
$next_option = new SquirrelOption(
+ $optset,
$optset['name'],
$optset['caption'],
$optset['type'],
$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 layout type for this option. */
+ if (isset($optset['layout_type'])) {
+ $next_option->setLayoutType($optset['layout_type']);
+ }
+
/* If provided, set the comment for this option. */
if (isset($optset['comment'])) {
$next_option->setComment($optset['comment']);
projects / squirrelmail.git / blobdiff