From: scyrma <scyrma>
Date: Wed, 19 Mar 2008 07:58:40 +0000 (+0000)
Subject: MDL-12235 deprecated document_file function.  Not found anywhere in core.
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=4258003130f160e678638137d199a08ead40035c;p=moodle.git

MDL-12235 deprecated document_file function.  Not found anywhere in core.
---

diff --git a/lib/deprecatedlib.php b/lib/deprecatedlib.php
index d35c42f6e2..1c87f75d17 100644
--- a/lib/deprecatedlib.php
+++ b/lib/deprecatedlib.php
@@ -1577,4 +1577,43 @@ function sql_primary_role_subselect() {
                               ) ';
 }
 
+/**
+ * Can include a given document file (depends on second
+ * parameter) or just return info about it.
+ *
+ * @uses $CFG
+ * @param string $file ?
+ * @param bool $include ?
+ * @return ?
+ * @todo Finish documenting this function
+ */
+function document_file($file, $include=true) {
+    global $CFG;
+
+    debugging('The document_file() function is deprecated.', DEBUG_DEVELOPER);
+
+    $file = clean_filename($file);
+
+    if (empty($file)) {
+        return false;
+    }
+
+    $langs = array(current_language(), get_string('parentlanguage'), 'en');
+
+    foreach ($langs as $lang) {
+        $info = new object();
+        $info->filepath = $CFG->dirroot .'/lang/'. $lang .'/docs/'. $file;
+        $info->urlpath  = $CFG->wwwroot .'/lang/'. $lang .'/docs/'. $file;
+
+        if (file_exists($info->filepath)) {
+            if ($include) {
+                include($info->filepath);
+            }
+            return $info;
+        }
+    }
+
+    return false;
+}
+
 ?>
diff --git a/lib/moodlelib.php b/lib/moodlelib.php
index c43e863816..d01e7a0634 100644
--- a/lib/moodlelib.php
+++ b/lib/moodlelib.php
@@ -5693,44 +5693,6 @@ function get_list_of_currencies() {
 }
 
 
-
-/**
- * Can include a given document file (depends on second
- * parameter) or just return info about it.
- *
- * @uses $CFG
- * @param string $file ?
- * @param bool $include ?
- * @return ?
- * @todo Finish documenting this function
- */
-function document_file($file, $include=true) {
-    global $CFG;
-
-    $file = clean_filename($file);
-
-    if (empty($file)) {
-        return false;
-    }
-
-    $langs = array(current_language(), get_string('parentlanguage'), 'en');
-
-    foreach ($langs as $lang) {
-        $info = new object();
-        $info->filepath = $CFG->dirroot .'/lang/'. $lang .'/docs/'. $file;
-        $info->urlpath  = $CFG->wwwroot .'/lang/'. $lang .'/docs/'. $file;
-
-        if (file_exists($info->filepath)) {
-            if ($include) {
-                include($info->filepath);
-            }
-            return $info;
-        }
-    }
-
-    return false;
-}
-
 /// ENCRYPTION  ////////////////////////////////////////////////
 
 /**