From: martinlanghoff <martinlanghoff>
Date: Wed, 27 Feb 2008 02:52:28 +0000 (+0000)
Subject: MDL-90 weblib: Introducing mdie() - close sibling of Perl's die()
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=7cfb11db0b17ed99f5a3328ad56053b20016cdc6;p=moodle.git

MDL-90 weblib: Introducing mdie() - close sibling of Perl's die()

So that commandline scripts can die with a message and
a nonzero errorcode
---

diff --git a/lib/weblib.php b/lib/weblib.php
index e96ca62287..6b53188506 100644
--- a/lib/weblib.php
+++ b/lib/weblib.php
@@ -5771,6 +5771,23 @@ function print_error ($errorcode, $module='', $link='', $a=NULL) {
                  get_string('moreinformation').'</a></p>';
     error($message, $link);
 }
+
+/**
+ * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
+ * Default errorcode is 1.
+ *
+ * Very useful for perl-like error-handling:
+ * 
+ * do_somethting() or mdie("Something went wrong");
+ *
+ * @param string  $msg       Error message
+ * @param integer $errorcode Error code to emit 
+ */
+function mdie($msg='', $errorcode=1) {
+    trigger_error($msg);
+    exit($errorcode);
+}
+
 /**
  * Returns a string of html with an image of a help icon linked to a help page on a number of help topics.
  * Should be used only with htmleditor or textarea.