X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Foptions.php;h=8e96b60a5f76e02497b7981dd9193325fc313cc5;hp=d7d8b625e2c4671498c443d96d9f2f5d0563084f;hb=8a6b8e1f25781423b7788700c5dd1e7998e0ad1f;hpb=b6a08d2dbd26a27ecc114fa5dd922f6de03e064d diff --git a/functions/options.php b/functions/options.php index d7d8b625..8e96b60a 100644 --- a/functions/options.php +++ b/functions/options.php @@ -5,55 +5,13 @@ * * Functions needed to display the options pages. * - * @copyright © 1999-2007 The SquirrelMail Project Team + * @copyright © 1999-2009 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail * @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('SMOPT_TYPE_SUBMIT', 15); - -/* 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); -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. * @@ -76,6 +34,11 @@ class SquirrelOption { * @var string */ var $caption; + /** + * Whether or not the caption text is allowed to wrap + * @var boolean + */ + var $caption_wrap; /** * The type of INPUT element * @@ -133,6 +96,13 @@ class SquirrelOption { * @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 * @@ -212,6 +182,7 @@ class SquirrelOption { $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; @@ -223,6 +194,7 @@ class SquirrelOption { $this->comment = ''; $this->layout_type = 0; $this->use_add_widget = TRUE; + $this->use_delete_widget = TRUE; $this->aExtraAttribs = array(); $this->post_script = ''; @@ -241,7 +213,9 @@ class SquirrelOption { } /* Set the default save function. */ - if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) { + if ($type != SMOPT_TYPE_HIDDEN + && $type != SMOPT_TYPE_INFO + && $type != SMOPT_TYPE_COMMENT) { $this->save_function = SMOPT_SAVE_DEFAULT; } else { $this->save_function = SMOPT_SAVE_NOOP; @@ -272,6 +246,14 @@ class SquirrelOption { $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 @@ -309,6 +291,11 @@ class SquirrelOption { $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 @@ -377,6 +364,9 @@ class SquirrelOption { /* Get the widget for this option type. */ switch ($this->type) { + case SMOPT_TYPE_PASSWORD: + $result = $this->createWidget_String(TRUE); + break; case SMOPT_TYPE_STRING: $result = $this->createWidget_String(); break; @@ -425,6 +415,9 @@ class SquirrelOption { case SMOPT_TYPE_SUBMIT: $result = $this->createWidget_Submit(); break; + case SMOPT_TYPE_INFO: + $result = $this->createWidget_Info(); + break; default: error_box ( sprintf(_("Option Type '%s' Not Found"), $this->type) @@ -443,11 +436,25 @@ class SquirrelOption { return $result; } + /** + * Creates info block + * @return string html formated output + */ + function createWidget_Info() { + return sq_htmlspecialchars($this->value); + } + /** * Create string field + * + * @param boolean $password When TRUE, the text in the input + * widget will be obscured (OPTIONAL; + * default = FALSE). + * * @return string html formated option field + * */ - function createWidget_String() { + function createWidget_String($password=FALSE) { switch ($this->size) { case SMOPT_SIZE_TINY: $width = 5; @@ -466,7 +473,11 @@ class SquirrelOption { $width = 25; } - return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); +//TODO: might be better to have a separate template file for all widgets, because then the layout of the widget and the "trailing text" can be customized - they are still hard coded here + if ($password) + return addPwField('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . htmlspecialchars($this->trailing_text); + else + return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . htmlspecialchars($this->trailing_text); } /** @@ -754,6 +765,7 @@ class SquirrelOption { //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('possible_values', $this->possible_values); @@ -844,7 +856,8 @@ function save_option($option) { // 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); @@ -937,6 +950,11 @@ function create_option_groups($optgrps, $optvals) { (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']); @@ -967,6 +985,11 @@ function create_option_groups($optgrps, $optvals) { $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']);