]> git.mjollnir.org Git - moodle.git/commitdiff
MDL-12235 deprecated document_file function. Not found anywhere in core.
authorscyrma <scyrma>
Wed, 19 Mar 2008 07:58:40 +0000 (07:58 +0000)
committerscyrma <scyrma>
Wed, 19 Mar 2008 07:58:40 +0000 (07:58 +0000)
lib/deprecatedlib.php
lib/moodlelib.php

index d35c42f6e2879040e64cb67dfb0891a88794f7a4..1c87f75d179042c56881206ffe3ce3694dfb64ce 100644 (file)
@@ -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;
+}
+
 ?>
index c43e8638164440d4eca7735642688079faaeefd1..d01e7a06345f6ba8c2439cfb6ac5caec8a732ff7 100644 (file)
@@ -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  ////////////////////////////////////////////////
 
 /**