* @subpackage prefs
*/
-/**********************************************/
-/* Define constants used in the options code. */
-/**********************************************/
-
-/* Define constants for the various option types. */
-define('SMOPT_TYPE_STRING', 0);
-define('SMOPT_TYPE_STRLIST', 1);
-define('SMOPT_TYPE_TEXTAREA', 2);
-define('SMOPT_TYPE_INTEGER', 3);
-define('SMOPT_TYPE_FLOAT', 4);
-define('SMOPT_TYPE_BOOLEAN', 5);
-define('SMOPT_TYPE_HIDDEN', 6);
-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 options refresh levels. */
-define('SMOPT_REFRESH_NONE', 0);
-define('SMOPT_REFRESH_FOLDERLIST', 1);
-define('SMOPT_REFRESH_ALL', 2);
-
-/* Define constants for the options size. */
-define('SMOPT_SIZE_TINY', 0);
-define('SMOPT_SIZE_SMALL', 1);
-define('SMOPT_SIZE_MEDIUM', 2);
-define('SMOPT_SIZE_LARGE', 3);
-define('SMOPT_SIZE_HUGE', 4);
-define('SMOPT_SIZE_NORMAL', 5);
-
-define('SMOPT_SAVE_DEFAULT', 'save_option');
-define('SMOPT_SAVE_NOOP', 'save_option_noop');
-
/**
* SquirrelOption: An option for SquirrelMail.
*
* @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 $caption;
+ /**
+ * Whether or not the caption text is allowed to wrap
+ * @var boolean
+ */
+ var $caption_wrap;
/**
* The type of INPUT element
*
* @var string
*/
var $no_text;
+ /**
+ * Some widgets support more than one layout type
+ *
+ * @var int
+ */
+ var $layout_type;
+ /**
+ * Indicates if the Add widget should be included
+ * with edit lists.
+ *
+ * @var boolean
+ */
+ var $use_add_widget;
+ /**
+ * Indicates if the Delete widget should be included
+ * with edit lists.
+ *
+ * @var boolean
+ */
+ var $use_delete_widget;
/**
* 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->caption_wrap = TRUE;
$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->use_add_widget = TRUE;
+ $this->use_delete_widget = TRUE;
$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. */
$this->new_value = $new_value;
}
+ /**
+ * Set whether the caption is allowed to wrap for this option.
+ * @param boolean $caption_wrap
+ */
+ function setCaptionWrap($caption_wrap) {
+ $this->caption_wrap = $caption_wrap;
+ }
+
/**
* Set the size for this option.
* @param integer $size
$this->no_text = $no_text;
}
+ /* Set the "use add widget" value for this option. */
+ function setUseAddWidget($use_add_widget) {
+ $this->use_add_widget = $use_add_widget;
+ }
+
+ /* Set the "use delete widget" value for this option. */
+ function setUseDeleteWidget($use_delete_widget) {
+ $this->use_delete_widget = $use_delete_widget;
+ }
+
+ /**
+ * 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
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_STRLIST_RADIO:
$result = $this->createWidget_StrList(FALSE, TRUE);
break;
+ case SMOPT_TYPE_SUBMIT:
+ $result = $this->createWidget_Submit();
+ 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;
}
/**
* 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
*/
global $oTemplate;
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:
+ case SMOPT_SIZE_MEDIUM:
$height = 15;
break;
- case SMOPT_SIZE_HUGE:
+ case SMOPT_SIZE_LARGE:
$height = 25;
break;
+ case SMOPT_SIZE_HUGE:
+ $height = 40;
+ break;
case SMOPT_SIZE_NORMAL:
default:
$height = 5;
//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('use_input_widget', $this->use_add_widget);
+ $oTemplate->assign('use_delete_widget', $this->use_delete_widget);
+
$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('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);
- return $oTemplate->fetch('edit_list_widget.tpl');
+
+ 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));
+ }
+
+ }
+
+ /**
+ * Creates a submit button
+ *
+ * @return string html formated submit button widget
+ *
+ */
+ function createWidget_Submit() {
+
+ return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
}
// add element if given
//
- if (sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) {
+ if ((isset($option->use_add_widget) && $option->use_add_widget)
+ && sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) {
$new_element = trim($new_element);
if (!empty($new_element)
&& !in_array($new_element, $option->possible_values))
// delete selected elements if needed
//
- if (is_array($option->new_value)
+ if ((isset($option->use_delete_widget) && $option->use_delete_widget)
+ && is_array($option->new_value)
&& sqGetGlobalVar('delete_' . $option->name, $ignore, SQ_POST))
$option->possible_values = array_diff($option->possible_values, $option->new_value);
} 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'],
(isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false)
);
+ /* If provided, set if the caption is allowed to wrap for this option. */
+ if (isset($optset['caption_wrap'])) {
+ $next_option->setCaptionWrap($optset['caption_wrap']);
+ }
+
/* If provided, set the size for this option. */
if (isset($optset['size'])) {
$next_option->setSize($optset['size']);
$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 use_add_widget value for this option. */
+ if (isset($optset['use_add_widget'])) {
+ $next_option->setUseAddWidget($optset['use_add_widget']);
+ }
+
+ /* If provided, set the use_delete_widget value for this option. */
+ if (isset($optset['use_delete_widget'])) {
+ $next_option->setUseDeleteWidget($optset['use_delete_widget']);
+ }
+
/* If provided, set the comment for this option. */
if (isset($optset['comment'])) {
$next_option->setComment($optset['comment']);
projects / squirrelmail.git / blobdiff