Moving template utilities... help appreciated moving the other util files too
authorpdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Sat, 30 Dec 2006 20:29:59 +0000 (20:29 +0000)
committerpdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Sat, 30 Dec 2006 20:29:59 +0000 (20:29 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@12017 7612ce4b-ef26-0410-bec9-ea0150e637f0

functions/template.php [deleted file]
functions/template/template.php [moved from templates/util_global.php with 58% similarity]

diff --git a/functions/template.php b/functions/template.php
deleted file mode 100644 (file)
index c6b46a1..0000000
+++ /dev/null
@@ -1,79 +0,0 @@
-<?php
-
-/**
- * template.php
- *
- * This file is intended to contain helper functions for template sets
- * that would like to use them.
-FIXME: potentially create a separate directory and separate functions into different files?
- *
- * @copyright &copy; 1999-2006 The SquirrelMail Project Team
- * @license http://opensource.org/licenses/gpl-license.php GNU Public License
- * @version $Id$
- * @package squirrelmail
- */
-
-
-/**
-  * Create stylesheet links that will work for multiple browsers
-  *
-  * @param string  $uri       The URI to the linked stylesheet.
-  * @param string  $name      The title of the stylesheet (optional; default empty).
-  * @param boolean $alt       Whether or not this is an alternate 
-  *                           stylesheet (optional; default TRUE).
-  * @param string  $mtype     The target media display type (optional; default "screen").
-  * @param string  $xhtml_end The XHTML-compliant close tag syntax to 
-  *                           use (optional; default "/")
-  *
-  * @return string The full text of the stylesheet link.
-  *
-  */
-function create_css_link($uri, $name='', $alt=TRUE, $mtype='screen', $xhtml_end='/') {
-// FIXME: Add closing / to link and meta elements only after 
-//        switching to xhtml 1.0 Transitional.
-//        It is not compatible with html 4.01 Transitional
-$xhtml_end='';
-
-    if (empty($uri)) {
-        return '';
-    }
-
-    // set to lower case to avoid errors
-    //
-    sqGetGlobalVar('HTTP_USER_AGENT', $browser_user_agent, SQ_SERVER);
-    $browser_user_agent = strtolower($browser_user_agent);
-
-    if (stristr($browser_user_agent, "msie 4")) {
-        $browser = 'msie4';
-        $dom_browser = false;
-        $is_IE = true;
-    } elseif (stristr($browser_user_agent, "msie") 
-           && stristr($browser_user_agent, 'opera') === FALSE) {
-        $browser = 'msie';
-        $dom_browser = true;
-        $is_IE = true;
-    }
-
-    if ((strpos($uri, '-ie')!== false) and !$is_IE) {
-        //not IE, so don't render this sheet
-        return;
-    }
-
-    if ( strpos($uri, 'print') !== false )
-        $mtype = 'print';
-
-    $href  = 'href="'.$uri.'" ';
-    $media = 'media="'.$mtype.'" ';
-
-    if ( empty($name) ) {
-        $title = '';
-        $rel   = 'rel="stylesheet" ';
-    } else {
-        $title = 'title="'.$name.'" ';
-        $rel   = 'rel="'.( $alt ? 'alternate ' : '' ).'stylesheet" ';
-    }
-
-    return '<link '.$media.$title.$rel.'type="text/css" '.$href." $xhtml_end>\n";
-}
-
-
similarity index 58%
rename from templates/util_global.php
rename to functions/template/template.php
index 56c832c..aeaea5b 100644 (file)
@@ -1,20 +1,86 @@
 <?php
+
 /**
- * util_global.php
+ * template.php
  *
- * Utility functions for use with all templates.  Do not echo output here!
+ * This file is intended to contain helper functions for template sets
+ * that would like to use them.
+FIXME: potentially create a separate directory and separate functions into different files?
  *
  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
- * @subpackage templates
  */
+
+
+/**
+  * Create stylesheet links that will work for multiple browsers
+  *
+  * @param string  $uri       The URI to the linked stylesheet.
+  * @param string  $name      The title of the stylesheet (optional; default empty).
+  * @param boolean $alt       Whether or not this is an alternate 
+  *                           stylesheet (optional; default TRUE).
+  * @param string  $mtype     The target media display type (optional; default "screen").
+  * @param string  $xhtml_end The XHTML-compliant close tag syntax to 
+  *                           use (optional; default "/")
+  *
+  * @return string The full text of the stylesheet link.
+  *
+  */
+function create_css_link($uri, $name='', $alt=TRUE, $mtype='screen', $xhtml_end='/') {
+// FIXME: Add closing / to link and meta elements only after 
+//        switching to xhtml 1.0 Transitional.
+//        It is not compatible with html 4.01 Transitional
+$xhtml_end='';
+
+    if (empty($uri)) {
+        return '';
+    }
+
+    // set to lower case to avoid errors
+    //
+    sqGetGlobalVar('HTTP_USER_AGENT', $browser_user_agent, SQ_SERVER);
+    $browser_user_agent = strtolower($browser_user_agent);
+
+    if (stristr($browser_user_agent, "msie 4")) {
+        $browser = 'msie4';
+        $dom_browser = false;
+        $is_IE = true;
+    } elseif (stristr($browser_user_agent, "msie") 
+           && stristr($browser_user_agent, 'opera') === FALSE) {
+        $browser = 'msie';
+        $dom_browser = true;
+        $is_IE = true;
+    }
+
+    if ((strpos($uri, '-ie')!== false) and !$is_IE) {
+        //not IE, so don't render this sheet
+        return;
+    }
+
+    if ( strpos($uri, 'print') !== false )
+        $mtype = 'print';
+
+    $href  = 'href="'.$uri.'" ';
+    $media = 'media="'.$mtype.'" ';
+
+    if ( empty($name) ) {
+        $title = '';
+        $rel   = 'rel="stylesheet" ';
+    } else {
+        $title = 'title="'.$name.'" ';
+        $rel   = 'rel="'.( $alt ? 'alternate ' : '' ).'stylesheet" ';
+    }
+
+    return '<link '.$media.$title.$rel.'type="text/css" '.$href." $xhtml_end>\n";
+}
+
+
 /**
  * Checks for an image icon and returns a complete HTML img tag or a text
  * string with the text icon based on what is found and user prefs.
- * 
+ *
  * @param string $icon_theme_path User's chosen icon set
  * @param string $icon_name File name of the desired icon
  * @param string $text_icon Text-based icon to display if desired
@@ -45,14 +111,15 @@ function getIcon($icon_theme_path, $icon_name, $text_icon, $alt_text='', $w=NULL
             $icon = $text_icon;
         }
     }
-    return $icon;    
+    return $icon;
 }
 
+
 /**
  * Gets the path to the specified icon or returns NULL if the image is not
  * found.  This has been separated from getIcon to allow the path to be fetched
  * for use w/ third party packages, e.g. dTree.
- * 
+ *
  * @param string $icon_theme_path User's chosen icon set
  * @param string $icon_name File name of the desired icon
  * @return string $icon String containing path to icon that can be used in
@@ -65,40 +132,43 @@ function getIconPath ($icon_theme_path, $icon_name) {
 
     if (is_null($icon_theme_path))
         return NULL;
-    
+
     // Desired icon exists in the current theme?
     if (is_file($icon_theme_path . $icon_name)) {
         return $icon_theme_path . $icon_name;
-        
+
     // Icon not found, check for the admin-specified fallback
     } elseif (!is_null($fallback_icon_theme_path) && is_file($fallback_icon_theme_path . $icon_name)) {
         return $fallback_icon_theme_path . $icon_name;
-        
+
     // Icon not found, return the SQM default icon
     } elseif (is_file(SM_PATH . 'images/themes/default/'.$icon_name)) {
         return SM_PATH . 'images/themes/default/'.$icon_name;
-    } 
-    
+    }
+
     return NULL;
 }
 
+
 /**
  * Display error messages for use in footer.tpl
- * 
+ *
  * @author Steve Brown
  * @since 1.5.2
  **/
 function displayErrors () {
     global $oErrorHandler;
-    
+
     if ($oErrorHandler) {
         $oErrorHandler->displayErrors();
     }
 }
 
+
 /**
  * Make the internal show_readable_size() function available to templates.
- * 
+//FIXME: I think this is needless since there is no reason templates cannot just call directly to show_readable_size
+ *
  * @param int size to be converted to human-readable
  * @return string human-readable form
  * @since 1.5.2
@@ -107,3 +177,4 @@ function humanReadableSize ($size) {
     return show_readable_size($size);
 }
 
+