X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Foptions.php;h=66b4ff1681cccb1828729e07a7a767ff3719e2c3;hp=2f7d30365c12967a64f0f63a9bc2c7d8521fc13b;hb=4b4abf93a9624311afef0c385023724ee46a2b60;hpb=9962527a7289f92defa53f2efff43bfff2447c39
diff --git a/functions/options.php b/functions/options.php
index 2f7d3036..66b4ff16 100644
--- a/functions/options.php
+++ b/functions/options.php
@@ -1,143 +1,706 @@
name = $name;
$this->caption = $caption;
- $this->value = $value;
-
- /* Set the optional parameters. */
- $this->refresh_level = $refresh_level;
$this->type = $type;
- $this->value = $value;
- $this->possible_values = $possible_value;
+ $this->refresh_level = $refresh_level;
+ $this->possible_values = $possible_values;
+ $this->htmlencoded = $htmlencoded;
+ $this->size = SMOPT_SIZE_MEDIUM;
+ $this->trailing_text = '';
+ $this->comment = '';
+ $this->script = '';
+ $this->post_script = '';
+
+ /* Check for a current value. */
+ if (!empty($initial_value)) {
+ $this->value = $initial_value;
+ } else if (isset($GLOBALS[$name])) {
+ $this->value = $GLOBALS[$name];
+ } else {
+ $this->value = '';
+ }
+
+ /* Check for a new value. */
+ if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
+ $this->new_value = '';
+ }
- /* Lastly, check for a new value. */
- if (isset($GLOBALS["new_$name"])) {
- $this->new_value = $GLOBALS["new_$name"];
- $this->changed = ($this->value !== $this->new_value);
+ /* Set the default save function. */
+ if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) {
+ $this->save_function = SMOPT_SAVE_DEFAULT;
+ } else {
+ $this->save_function = SMOPT_SAVE_NOOP;
}
}
- function hasChanged() {
- return ($this->changed);
+ /**
+ * Set the value for this option.
+ * @param mixed $value
+ */
+ function setValue($value) {
+ $this->value = $value;
+ }
+
+ /**
+ * Set the new value for this option.
+ * @param mixed $new_value
+ */
+ function setNewValue($new_value) {
+ $this->new_value = $new_value;
+ }
+
+ /**
+ * Set the size for this option.
+ * @param integer $size
+ */
+ function setSize($size) {
+ $this->size = $size;
+ }
+
+ /**
+ * Set the trailing_text for this option.
+ * @param string $trailing_text
+ */
+ function setTrailingText($trailing_text) {
+ $this->trailing_text = $trailing_text;
+ }
+
+ /**
+ * Set the comment for this option.
+ * @param string $comment
+ */
+ function setComment($comment) {
+ $this->comment = $comment;
+ }
+
+ /**
+ * Set the script for this option.
+ * @param string $script
+ */
+ function setScript($script) {
+ $this->script = $script;
}
-}
-function OptionSelect( $title, $name, $data, $default, $show = '', $store = '' ) {
+ /**
+ * Set the "post script" for this option.
+ * @param string $post_script
+ */
+ function setPostScript($post_script) {
+ $this->post_script = $post_script;
+ }
+
+ /**
+ * Set the save function for this option.
+ * @param string $save_function
+ */
+ function setSaveFunction($save_function) {
+ $this->save_function = $save_function;
+ }
- echo "| $title: | " .
- " |
\n";
-}
-function OptionRadio( $title, $name, $data, $default, $show = '', $store = '', $sep = ' ' ) {
- echo "| $title: | ";
- foreach( $data as $key => $opt ) {
- if ( $store == '' ) {
- $vl = $key;
- } else{
- $vl = $opt[$store];
+ /**
+ * Create string field
+ * @return string html formated option field
+ */
+ function createWidget_String() {
+ switch ($this->size) {
+ case SMOPT_SIZE_TINY:
+ $width = 5;
+ break;
+ case SMOPT_SIZE_SMALL:
+ $width = 12;
+ break;
+ case SMOPT_SIZE_LARGE:
+ $width = 38;
+ break;
+ case SMOPT_SIZE_HUGE:
+ $width = 50;
+ break;
+ case SMOPT_SIZE_NORMAL:
+ default:
+ $width = 25;
}
- if ( $show == '' ) {
- $nm = $opt;
- } else{
- $nm = $opt[$show];
+
+ $result = "name\" value=\"" .
+ htmlspecialchars($this->value) .
+ "\" size=\"$width\" $this->script />$this->trailing_text\n";
+ return ($result);
+ }
+
+ /**
+ * Create selection box
+ * @return string html formated selection box
+ */
+ function createWidget_StrList() {
+ /* Begin the select tag. */
+ $result = " |
\n";
+
+ /**
+ * Creates hidden field
+ * @return string html formated hidden input field
+ */
+ function createWidget_Hidden() {
+ $result = 'script . ' />';
+ return ($result);
+ }
+
+ /**
+ * Creates comment
+ * @return string comment
+ */
+ function createWidget_Comment() {
+ $result = $this->comment;
+ return ($result);
+ }
+
+ /**
+ *
+ */
+ function save() {
+ $function = $this->save_function;
+ $function($this);
+ }
+
+ /**
+ *
+ */
+ function changed() {
+ return ($this->value != $this->new_value);
+ }
+} /* End of SquirrelOption class*/
+
+/**
+ * Saves option
+ * @param object $option object that holds option name and new_value
+ */
+function save_option($option) {
+ 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);
}
-function OptionText( $title, $name, $value, $size ) {
- echo "| $title: | " .
- "" .
- " |
\n";
+/**
+ * save function that does not save
+ * @param object $option
+ */
+function save_option_noop($option) {
+ /* Do nothing here... */
}
-function OptionHidden( $name, $value ) {
- echo "\n";
+/**
+ * Create hidden 'optpage' input field with value set by argument
+ * @param string $optpage identification of option page
+ * @return string html formated hidden input field
+ */
+function create_optpage_element($optpage) {
+ return create_hidden_element('optpage', $optpage);
}
-function OptionCheck( $title, $name, $value, $comment ) {
- if ( $value )
- $chk = 'checked';
- echo "| $title: | " .
- " $comment" .
- " |
\n";
+/**
+ * Create hidden 'optmode' input field with value set by argument
+ * @param string $optmode
+ * @return string html formated hidden input field
+ */
+function create_optmode_element($optmode) {
+ return create_hidden_element('optmode', $optmode);
}
-function OptionTitle( $title ) {
- echo "| $title |
\n";
+/**
+ * Create hidden field.
+ * @param string $name field name
+ * @param string $value field value
+ * @return string html formated hidden input field
+ */
+function create_hidden_element($name, $value) {
+ $result = '';
+ return ($result);
}
+/**
+ * @param array $optgrps
+ * @param array $optvals
+ * @return array
+ */
+function create_option_groups($optgrps, $optvals) {
+ /* Build a simple array with which to start. */
+ $result = array();
+
+ /* Create option group for each option group name. */
+ foreach ($optgrps as $grpkey => $grpname) {
+ $result[$grpkey] = array();
+ $result[$grpkey]['name'] = $grpname;
+ $result[$grpkey]['options'] = array();
+ }
+
+ /* Create a new SquirrelOption for each set of option values. */
+ foreach ($optvals as $grpkey => $grpopts) {
+ foreach ($grpopts as $optset) {
+ /* Create a new option with all values given. */
+ $next_option = new SquirrelOption(
+ $optset['name'],
+ $optset['caption'],
+ $optset['type'],
+ (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
+ (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
+ (isset($optset['posvals']) ? $optset['posvals'] : ''),
+ (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false)
+ );
+
+ /* If provided, set the size for this option. */
+ if (isset($optset['size'])) {
+ $next_option->setSize($optset['size']);
+ }
+
+ /* If provided, set the trailing_text for this option. */
+ if (isset($optset['trailing_text'])) {
+ $next_option->setTrailingText($optset['trailing_text']);
+ }
+
+ /* If provided, set the comment for this option. */
+ if (isset($optset['comment'])) {
+ $next_option->setComment($optset['comment']);
+ }
+
+ /* If provided, set the save function for this option. */
+ if (isset($optset['save'])) {
+ $next_option->setSaveFunction($optset['save']);
+ }
+
+ /* If provided, set the script for this option. */
+ if (isset($optset['script'])) {
+ $next_option->setScript($optset['script']);
+ }
+
+ /* If provided, set the "post script" for this option. */
+ if (isset($optset['post_script'])) {
+ $next_option->setPostScript($optset['post_script']);
+ }
+
+ /* Add this option to the option array. */
+ $result[$grpkey]['options'][] = $next_option;
+ }
+ }
+
+ /* Return our resulting array. */
+ return ($result);
+}
+
+/**
+ * @param array $option_groups
+ */
+function print_option_groups($option_groups) {
+ /* Print each option group. */
+ foreach ($option_groups as $next_optgrp) {
+ /* If it is not blank, print the name for this option group. */
+ if ($next_optgrp['name'] != '') {
+ echo html_tag( 'tr', "\n".
+ html_tag( 'td',
+ '' . $next_optgrp['name'] . '' ,
+ 'center' ,'', 'valign="middle" colspan="2" style="white-space: nowrap;"' )
+ ) ."\n";
+ }
+
+ /* Print each option in this option group. */
+ foreach ($next_optgrp['options'] as $option) {
+ if ($option->type != SMOPT_TYPE_HIDDEN) {
+ echo html_tag( 'tr', "\n".
+ html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) .
+ html_tag( 'td', $option->createHTMLWidget(), 'left' )
+ ) ."\n";
+ } else {
+ echo $option->createHTMLWidget();
+ }
+ }
+
+ /* Print an empty row after this option group. */
+ echo html_tag( 'tr',
+ html_tag( 'td', ' ', 'left', '', 'colspan="2"' )
+ ) . "\n";
+ }
+}
+
+/**
+ * Create submit button inside table row.
+ * @param string $name
+ */
function OptionSubmit( $name ) {
- echo '| | ' .
- ' |
';
+ echo html_tag( 'tr',
+ html_tag( 'td', ' ', 'right', '', 'colspan="2"' )
+ ) . "\n";
}
-?>
+// vim: et ts=4
+?>
\ No newline at end of file