Add phpdoc doc blocks to some files.

[squirrelmail.git] / functions / page_header.php

diff --git a/functions/page_header.php b/functions/page_header.php
index 50957d603e9444bbdec6e1614667b22b212f9719..5aca335a65c778dfddb88579cdf1a8d30e45a952 100644 (file)
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -9,14 +9,24 @@
  * Prints the page header (duh)
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** Include required files from SM */
 require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/html.php');
 require_once(SM_PATH . 'functions/imap_mailbox.php');
 require_once(SM_PATH . 'functions/global.php');
 
-/* Always set up the language before calling these functions */
+/**
+ * Output a SquirrelMail page header, from <!doctype> to </head>
+ * Always set up the language before calling these functions.
+ *
+ * @param string title the page title, default SquirrelMail.
+ * @param string xtra extra HTML to insert into the header
+ * @param bool do_hook whether to execute hooks, default true
+ * @return void
+ */
 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
     global $squirrelmail_language;
 
@@ -69,6 +79,13 @@ ECHO;
     $pageheader_sent = TRUE;
 }
 
+/**
+ * Given a path to a SquirrelMail file, return a HTML link to it
+ *
+ * @param string path the SquirrelMail file to link to
+ * @param string text the link text
+ * @param string target the target frame for this link
+ */
 function makeInternalLink($path, $text, $target='') {
     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
     if ($target != '') {
@@ -80,10 +97,24 @@ function makeInternalLink($path, $text, $target='') {
     return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
 }
 
+/**
+ * Same as makeInternalLink, but echoes it too
+ */
 function displayInternalLink($path, $text, $target='') {
     echo makeInternalLink($path, $text, $target);
 }
 
+/**
+ * Outputs a complete SquirrelMail page header, starting with <!doctype> and
+ * including the default menu bar. Uses displayHtmlHeader and takes
+ * JavaScript and locale settings into account.
+ *
+ * @param array color the array of theme colors
+ * @param string mailbox the current mailbox name to display
+ * @param string xtra extra html code to add
+ * @param bool session
+ * @return void
+ */
 function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
 
     global $hide_sm_attributions, $PHP_SELF, $frame_top,
@@ -153,8 +184,16 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
         case 'src/compose.php':
             $js = '<script language="JavaScript" type="text/javascript">' .
                  "\n<!--\n" .
-                 "function checkForm() {\n".
-                    "var f = document.forms.length;\n".
+             "function checkForm() {\n";
+
+            global $action, $reply_focus;
+            if (strpos($action, 'reply') !== FALSE && $reply_focus)
+            {
+                if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
+                else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
+            }
+            else
+                $js .= "var f = document.forms.length;\n".
                     "var i = 0;\n".
                     "var pos = -1;\n".
                     "while( pos == -1 && i < f ) {\n".
@@ -290,7 +329,14 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
         "</table><br>\n\n";
 }
 
-/* blatently copied/truncated/modified from the above function */
+/**
+ * Blatantly copied/truncated/modified from displayPageHeader.
+ * Outputs a page header specifically for the compose_in_new popup window
+ *
+ * @param array color the array of theme colors
+ * @param string mailbox the current mailbox name to display
+ * @return void
+ */
 function compose_Header($color, $mailbox) {
 
     global $javascript_on;
@@ -312,8 +358,16 @@ function compose_Header($color, $mailbox) {
         default:
             $js = '<script language="JavaScript" type="text/javascript">' .
                  "\n<!--\n" .
-                 "function checkForm() {\n".
-                    "var f = document.forms.length;\n".
+             "function checkForm() {\n";
+
+            global $action, $reply_focus;
+            if (strpos($action, 'reply') !== FALSE && $reply_focus)
+            {
+                if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
+                else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
+            }
+            else
+                $js .= "var f = document.forms.length;\n".
                     "var i = 0;\n".
                     "var pos = -1;\n".
                     "while( pos == -1 && i < f ) {\n".