phpDocumentor updates
[squirrelmail.git] / functions / display_messages.php
index fae48f5ddc774c9cc07db568278b573d419d1226..470a5d359ab0733a8ef1d0c7707a247b538e4508 100644 (file)
@@ -3,28 +3,31 @@
 /**
  * display_messages.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This contains all messages, including information, error, and just
  * about any other message you can think of.
  *
+ * @copyright © 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
+/** @ignore */
+if (! defined('SM_PATH')) define('SM_PATH','../');
+
 /**
  * including plugin functions
  */
-require_once(SM_PATH . 'functions/plugin.php');
+include_once(SM_PATH . 'functions/plugin.php');
 
 /**
- * Find out where squirrelmail lives and try to be smart about it.
- * The only problem would be when squirrelmail lives in directories
+ * Find out where SquirrelMail lives and try to be smart about it.
+ * The only problem would be when SquirrelMail lives in directories
  * called "src", "functions", or "plugins", but people who do that need
  * to be beaten with a steel pipe anyway.
  *
- * @return string the base uri of squirrelmail installation.
+ * @return string the base uri of SquirrelMail installation.
+ * @since 1.2.6
  */
 function sqm_baseuri(){
     global $base_uri, $PHP_SELF;
@@ -40,6 +43,15 @@ function sqm_baseuri(){
     return $base_uri;
 }
 
+/**
+ * Displays error message and URL to message listing
+ * @param string $message error message
+ * @param string $mailbox mailbox name
+ * @param integer $sort sort order
+ * @param integer $startMessage first message
+ * @param array $color color theme
+ * @since 1.0
+ */
 function error_message($message, $mailbox, $sort, $startMessage, $color) {
     $urlMailbox = urlencode($mailbox);
     $string = '<tr><td align="center">' . $message . '</td></tr>'.
@@ -51,13 +63,28 @@ function error_message($message, $mailbox, $sort, $startMessage, $color) {
     error_box($string, $color);
 }
 
+/**
+ * Displays error message
+ * @param string $message error message
+ * @param array $color color theme
+ * @since 1.0
+ */
 function plain_error_message($message, $color) {
     error_box($message, $color);
 }
 
+/**
+ * Displays error when user is logged out
+ * 
+ * Error strings can be overriden by logout_error hook
+ * @param string $errString error message
+ * @param string $errTitle title of page with error message
+ * @since 1.2.6
+ */
 function logout_error( $errString, $errTitle = '' ) {
     global $frame_top, $org_logo, $org_name, $org_logo_width, $org_logo_height,
-           $hide_sm_attributions, $version, $squirrelmail_language;
+           $hide_sm_attributions, $version, $squirrelmail_language, 
+           $color, $theme, $theme_default;
 
     $base_uri = sqm_baseuri();
 
@@ -79,6 +106,10 @@ function logout_error( $errString, $errTitle = '' ) {
         $frame_top = '_top';
     }
 
+    // load default theme if possible
+    if (!isset($color) && @file_exists($theme[$theme_default]['PATH']))
+        @include ($theme[$theme_default]['PATH']);
+
     if ( !isset( $color ) ) {
         $color = array();
         $color[0]  = '#dcdcdc';  /* light gray    TitleBar               */
@@ -92,11 +123,11 @@ function logout_error( $errString, $errTitle = '' ) {
     list($junk, $errString, $errTitle) = do_hook('logout_error', $errString, $errTitle);
 
     if ( $errTitle == '' ) {
-        $errTitle = $org_name . ' - ' . $errString;
+        $errTitle = $errString;
     }
     set_up_language($squirrelmail_language, true);
 
-    displayHtmlHeader( $errTitle, '', false );
+    displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
 
     echo '<body text="'.$color[8].'" bgcolor="'.$color[4].'" link="'.$color[7].'" vlink="'.$color[7].'" alink="'.$color[7]."\">\n\n".
          '<center>';
@@ -106,8 +137,8 @@ function logout_error( $errString, $errTitle = '' ) {
              "\"$width_and_height /><br />\n";
     }
     echo ( $hide_sm_attributions ? '' :
-            '<small>' . sprintf (_("SquirrelMail version %s"), $version) . '<br />'.
-            _("By the SquirrelMail Development Team") . "<br /></small>\n" ).
+            '<small>' .  _("SquirrelMail Webmail Application") . '<br />'.
+            _("By the SquirrelMail Project Team") . "<br /></small>\n" ).
          '<table cellspacing="1" cellpadding="0" bgcolor="'.$color[1].'" width="70%">'.
          '<tr><td>'.
          '<table width="100%" border="0" bgcolor="'.$color[4].'" align="center">'.
@@ -122,6 +153,17 @@ function logout_error( $errString, $errTitle = '' ) {
          '</table></td></tr></table></center></body></html>';
 }
 
+/**
+ * Displays error message
+ * 
+ * Since 1.4.1 function checks if page header is already displayed.
+ * Since 1.4.3 and 1.5.1 function contains error_box hook.
+ * Use plain_error_message() and make sure that page header is created,
+ * if you want compatibility with 1.4.0 and older.
+ * @param string $string
+ * @param array $color
+ * @since 1.3.2
+ */
 function error_box($string, $color) {
     global $pageheader_sent;
 
@@ -163,5 +205,18 @@ function error_box($string, $color) {
          '</td></tr></table></td></tr></table>';
 }
 
+/**
+ * Adds message that informs about non fatal error that can happen while saving preferences
+ * @param string $message error message
+ * @since 1.5.1 and 1.4.5
+ */
+function error_option_save($message) {
+    global $optpage_save_error;
+
+    if (! is_array($optpage_save_error) )
+        $optpage_save_error=array();
+
+    $optpage_save_error=array_merge($optpage_save_error,array($message));
+}
 // vim: et ts=4
 ?>
\ No newline at end of file