Add FIXME

[squirrelmail.git] / src / options.php

diff --git a/src/options.php b/src/options.php
index 480dde5ce0d2c3d01fd177205b991eb7d870e344..facbe529f2cfebd483d3a30098e589ce4dbfc63b 100644 (file)
--- a/src/options.php
+++ b/src/options.php
@@ -13,6 +13,9 @@
  * @subpackage prefs
  */
 
+/** This is the options page */
+define('PAGE_NAME', 'options');
+
 /**
  * Include the SquirrelMail initialization file.
  */
@@ -40,6 +43,19 @@ define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
 define('SMOPT_PAGE_FOLDER', 'folder');
 define('SMOPT_PAGE_ORDER', 'order');
 
+/**
+  * Save submitted options and calculate the most 
+  * we need to refresh the page
+  *
+  * @param string $optpage      The name of the page being submitted
+  * @param array  $optpage_data An array of all the submitted options
+  *
+  * @return int The highest level of screen refresh needed per
+  *             the options that were changed.  This value will
+  *             correspond to the SMOPT_REFRESH_* constants found
+  *             in functions/options.php.
+  *
+  */
 function process_optionmode_submit($optpage, $optpage_data) {
     /* Initialize the maximum option refresh level. */
     $max_refresh = SMOPT_REFRESH_NONE;
@@ -62,6 +78,7 @@ function process_optionmode_submit($optpage, $optpage_data) {
             echo "name = '$option->name', "
                . "value = '$option->value', "
                . "new_value = '$option->new_value'\n";
+//FIXME: NO HTML IN THE CORE!
             echo "<br />";
             */
             if ($option->changed()) {
@@ -197,6 +214,7 @@ if (isset($optpage_name) && ($optpage_name != '')) {
 /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
 /*******************************************************************/
 
+//FIXME: let's remove these finally in 1.5.2..... but first, are there any plugins using them?
 /* If in submit mode, select a save hook name and run it. */
 if ($optmode == SMOPT_MODE_SUBMIT) {
     /* Select a save hook name. */
@@ -374,40 +392,33 @@ if ($optpage == SMOPT_PAGE_MAIN) {
 /* If we are not looking at the main option page, display the page here. */
 /*************************************************************************/
 } else {
-    /* Set the inside_hook_name and submit_name. */
+    /* Set the bottom_hook_name and submit_name. */
     switch ($optpage) {
         case SMOPT_PAGE_PERSONAL:
-            $inside_hook_name = 'options_personal_inside';
             $bottom_hook_name = 'options_personal_bottom';
             $submit_name = 'submit_personal';
             break;
         case SMOPT_PAGE_DISPLAY:
-            $inside_hook_name = 'options_display_inside';
             $bottom_hook_name = 'options_display_bottom';
             $submit_name = 'submit_display';
             break;
         case SMOPT_PAGE_COMPOSE:
-            $inside_hook_name = 'options_compose_inside';
             $bottom_hook_name = 'options_compose_bottom';
             $submit_name = 'submit_compose';
             break;
         case SMOPT_PAGE_HIGHLIGHT:
-            $inside_hook_name = 'options_highlight_inside';
             $bottom_hook_name = 'options_highlight_bottom';
             $submit_name = 'submit_highlight';
             break;
         case SMOPT_PAGE_FOLDER:
-            $inside_hook_name = 'options_folder_inside';
             $bottom_hook_name = 'options_folder_bottom';
             $submit_name = 'submit_folder';
             break;
         case SMOPT_PAGE_ORDER:
-            $inside_hook_name = 'options_order_inside';
             $bottom_hook_name = 'options_order_bottom';
             $submit_name = 'submit_order';
             break;
         default:
-            $inside_hook_name = '';
             $bottom_hook_name = '';
             $submit_name = 'submit';
     }
@@ -417,12 +428,6 @@ if ($optpage == SMOPT_PAGE_MAIN) {
        . create_optpage_element($optpage)
        . create_optmode_element(SMOPT_MODE_SUBMIT);
 
-//FIXME: NO HTML IN THE CORE!!
-    // Wrap the template in a table to keep from breaking the hooks below
-    echo "<table cellspacing=\"0\" class=\"table_blank\">\n" .
-         " <tr>\n" .
-         "  <td colspan=\"2\">\n";
-
     // This is the only variable that is needed by *just* the template.
     $oTemplate->assign('options', $optpage_data['options']);
     
@@ -433,38 +438,21 @@ if ($optpage == SMOPT_PAGE_MAIN) {
             sprintf(_("Welcome to %s. Please supply your full name and email address."), $org_name) );
     }
     
-    /**
-     * The variables below should not be needed by the template since all plugin
-     * hooks are called here, not in the template.  If we find otherwise, these
-     * variables can be passed to the template.  Commenting out for now.
-     */
-/*
+    // These variables are not specifically needed by the template,
+    // but they are relevant to the page being built, so we'll add
+    // them in case some plugin is modifying the page, etc....
+    //
     $oTemplate->assign('max_refresh', isset($max_refresh) ? $max_refresh : NULL);
     $oTemplate->assign('page_title', $optpage_title);
-    $oTemplate->assign('optpage',$optpage);
-    $oTemplate->assign('optpage_name',$optpage_name);
-    $oTemplate->assign('optmode',$optmode);
-    $oTemplate->assign('optpage_data',$optpage_data);
-*/
-    /**
-     * END comment block
-     */    
+    $oTemplate->assign('optpage', $optpage);
+    $oTemplate->assign('optpage_name', $optpage_name);
+    $oTemplate->assign('optmode', $optmode);
+    $oTemplate->assign('optpage_data', $optpage_data);
      
     $oTemplate->assign('submit_name', $submit_name);
     $oTemplate->display('options.tpl');
 
-//FIXME: need to remove HTML from here!
-    echo "  </td>\n" .
-         " </tr>\n";
-
-    /* If it is not empty, trigger the inside hook. */
-    if ($inside_hook_name != '') {
-        do_hook($inside_hook_name, $null);
-    }
-
-//FIXME: need to remove HTML from here!
-    echo "</table>\n" .
-         "</form>\n";
+    $oTemplate->display('form_close.tpl');
 
     /* If it is not empty, trigger the bottom hook. */
     if ($bottom_hook_name != '') {