From 361d6e1bb008cfb3320a9d6c2d49511f884108e2 Mon Sep 17 00:00:00 2001
From: pdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Sun, 25 Jul 2004 13:40:52 +0000
Subject: [PATCH] Added 'trailing text' for options that SM builds, which is
 placed after a text input or select list.  One less reason for plugin authors
 to build their own HTML.

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@7772 7612ce4b-ef26-0410-bec9-ea0150e637f0
---
 ChangeLog             |  2 ++
 doc/plugin.txt        |  3 +++
 functions/options.php | 16 ++++++++++++++--
 3 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 27de1429..7831dc2f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -70,6 +70,8 @@ Version 1.5.1 -- CVS
   - Security: fix SQL injection vulnerability in addressbook
     (CVE ID: CAN-2004-0521).
   - Removed html_top and html_bottom hooks.  No longer used/needed.
+  - Added "trailing text" for options built by SquirrelMail (text placed
+    after text and select list inputs on options pages)
 
 Version 1.5.0
 --------------------
diff --git a/doc/plugin.txt b/doc/plugin.txt
index 404506a0..938edb21 100644
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -598,6 +598,9 @@ for you.  This is the preferred method of building options lists going forward.
                         setting in the user's preferences
          caption        The text that prefaces this setting on the preferences
                         page
+         trailing_text  Text that follows a text input or select list input on
+                        the preferences page (useful for indicating units,
+                        meanings of special values, etc.)
          type           The type of INPUT element, which should be one of:
                            SMOPT_TYPE_STRING     String/text input
                            SMOPT_TYPE_STRLIST    Select list input
diff --git a/functions/options.php b/functions/options.php
index 3a3ed2ee..7fadcbc6 100644
--- a/functions/options.php
+++ b/functions/options.php
@@ -62,6 +62,7 @@ class SquirrelOption {
     var $type;
     var $refresh_level;
     var $size;
+    var $trailing_text;
     var $comment;
     var $script;
     var $post_script;
@@ -83,6 +84,7 @@ class SquirrelOption {
         $this->refresh_level = $refresh_level;
         $this->possible_values = $possible_values;
         $this->size = SMOPT_SIZE_MEDIUM;
+        $this->trailing_text = '';
         $this->comment = '';
         $this->script = '';
         $this->post_script = '';
@@ -124,6 +126,11 @@ class SquirrelOption {
         $this->size = $size;
     }
 
+    /* Set the trailing_text for this option. */
+    function setTrailingText($trailing_text) {
+        $this->trailing_text = $trailing_text;
+    }
+
     /* Set the comment for this option. */
     function setComment($comment) {
         $this->comment = $comment;
@@ -210,7 +217,7 @@ class SquirrelOption {
 
         $result = "<input type=\"text\" name=\"new_$this->name\" value=\"" .
             htmlspecialchars($this->value) . 
-            "\" size=\"$width\" $this->script />\n";
+            "\" size=\"$width\" $this->script />$this->trailing_text\n";
         return ($result);
     }
 
@@ -237,7 +244,7 @@ class SquirrelOption {
         }
 
         /* Close the select tag and return our happy result. */
-        $result .= "</select>\n";
+        $result .= "</select>$this->trailing_text\n";
         return ($result);
     }
 
@@ -436,6 +443,11 @@ function create_option_groups($optgrps, $optvals) {
                 $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']);
-- 
2.25.1