style police

[squirrelmail.git] / functions / tree.php

diff --git a/functions/tree.php b/functions/tree.php
index 9871d45a6e30d907446b29eea764a55f88371033..5d9657943c8db0cc2e1955194da26d71f56ae00c 100644 (file)
--- a/functions/tree.php
+++ b/functions/tree.php
@@ -1,15 +1,41 @@
 <?php
 
-   /* $Id$ */
+/**
+ * tree.php
+ *
+ * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This code provides various string manipulation functions that are
+ * used by the rest of the Squirrelmail code.
+ *
+ * $Id$
+ */
 
-   $tree_php = true;
+/*****************************************************************/
+/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
+/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
+/***    + Base level indent should begin at left margin, as    ***/
+/***      the require_once below.                              ***/
+/***    + All identation should consist of four space blocks   ***/
+/***    + Tab characters are evil.                             ***/
+/***    + all comments should use "slash-star ... star-slash"  ***/
+/***      style -- no pound characters, no slash-slash style   ***/
+/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
+/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
+/***    + Please use ' instead of ", when possible. Note "     ***/
+/***      should always be used in _( ) function calls.        ***/
+/*** Thank you for your help making the SM code more readable. ***/
+/*****************************************************************/
 
-   if (!isset($imap_php))
-      include('../functions/imap.php');
-   if (!isset($config_php))
-      include('../config/config.php');
+require_once('../functions/imap.php');
+
+/**
+ * findParentForChild
+ *
+ * Recursive function to find the correct parent for a new node
+ */
 
-   // Recursive function to find the correct parent for a new node
    function findParentForChild($value, $treeIndexToStart, $tree) {
       // is $value in $tree[$treeIndexToStart]['value']
       if ((isset($tree[$treeIndexToStart])) && (strstr($value, $tree[$treeIndexToStart]['value']))) {
@@ -91,29 +117,29 @@
       }
    }
 
-   function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tree, $dm, $topFolderName) {
-      global $trash_folder;
+   function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tree, $topFolderName) {
+      global $trash_folder, $delimiter;
 
-      $position = strrpos($topFolderName, $dm) + 1;
+      $position = strrpos($topFolderName, $delimiter) + 1;
       $subFolderName = substr($tree[$index]['value'], $position);
 
       if ($tree[$index]['doIHaveChildren']) {
-         sqimap_mailbox_create($imap_stream, $trash_folder . $dm . $subFolderName, "");
+         sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, "");
          sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
         
          $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]['value']);
          if ($messageCount > 0)
-            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $dm . $subFolderName);
+            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $delimiter . $subFolderName);
          
          for ($j = 0;$j < count($tree[$index]['subNodes']); $j++)
-            walkTreeInPostOrderCreatingFoldersUnderTrash($tree[$index]['subNodes'][$j], $imap_stream, $tree, $dm, $topFolderName);
+            walkTreeInPostOrderCreatingFoldersUnderTrash($tree[$index]['subNodes'][$j], $imap_stream, $tree, $topFolderName);
       } else {
-         sqimap_mailbox_create($imap_stream, $trash_folder . $dm . $subFolderName, '');
+         sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, '');
          sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
          
          $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]['value']);
          if ($messageCount > 0)
-            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $dm . $subFolderName);
+            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $delimiter . $subFolderName);
       }
    }
 
@@ -127,4 +153,4 @@
          echo $tree[$index]['value'] . '<br>';
       }
    }
-?>
\ No newline at end of file
+?>