Add yes_text and no_text option attributes that allow the overriding of the Yes/No...

[squirrelmail.git] / functions / options.php

diff --git a/functions/options.php b/functions/options.php
index 036e43c7589f9278435e5d10964cc1a5847f3599..6de0efffa0fd9647f73f38b0d0f30e314cf04307 100644 (file)
--- a/functions/options.php
+++ b/functions/options.php
@@ -29,6 +29,8 @@ 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 constants for the options refresh levels. */
 define('SMOPT_REFRESH_NONE', 0);
@@ -93,6 +95,20 @@ class SquirrelOption {
      * @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;
     /**
      * text displayed to the user
      *
@@ -176,6 +192,8 @@ class SquirrelOption {
         $this->htmlencoded = $htmlencoded;
         $this->size = SMOPT_SIZE_MEDIUM;
         $this->trailing_text = '';
+        $this->yes_text = '';
+        $this->no_text = '';
         $this->comment = '';
         $this->aExtraAttribs = array();
         $this->post_script = '';
@@ -202,6 +220,14 @@ class SquirrelOption {
         }
     }
 
+    /** 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
@@ -234,6 +260,22 @@ class SquirrelOption {
         $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 comment for this option.
      * @param string $comment
@@ -267,7 +309,7 @@ class SquirrelOption {
     }
 
     /**
-     * Set the trailing_text for this option.
+     * Set the folder_filter for this option.
      * @param string $folder_filter
      * @since 1.5.1
      */
@@ -312,6 +354,12 @@ class SquirrelOption {
             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;
@@ -527,21 +575,47 @@ class SquirrelOption {
     }
 
     /**
-     * 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;
 
-        /* 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);
     }
 
@@ -673,8 +747,7 @@ function save_option($option) {
     // Certain option types need to be serialized because
     // they are not scalar
     //
-    } else if ($option->type == SMOPT_TYPE_FLDRLIST_MULTI
-            || $option->type == SMOPT_TYPE_STRLIST_MULTI)
+    } else if ($option->is_multiple_valued())
         setPref($data_dir, $username, $option->name, serialize($option->new_value));
 
     else
@@ -748,6 +821,16 @@ function create_option_groups($optgrps, $optvals) {
                 $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 comment for this option. */
             if (isset($optset['comment'])) {
                 $next_option->setComment($optset['comment']);