From fc9fc9fb306f8a4bae15bb0d886a17ec6fad3ead Mon Sep 17 00:00:00 2001
From: Rajesh Taneja <rajesh@moodle.com>
Date: Fri, 2 Aug 2013 13:48:11 +0800
Subject: [PATCH] MDL-41000 Events: Fixed phpdoc for get_name and
 get_description in \core\event\base class

---
 lang/en/error.php          |  1 +
 lib/classes/event/base.php | 12 ++++--------
 2 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/lang/en/error.php b/lang/en/error.php
index 6bc3ac12c1c..a2508b4f514 100644
--- a/lang/en/error.php
+++ b/lang/en/error.php
@@ -503,6 +503,7 @@ $string['unknowncourse'] = 'Unknown course named "{$a}"';
 $string['unknowncourseidnumber'] = 'Unknown course ID "{$a}"';
 $string['unknowncoursesection'] = 'Unknown course section in course "{$a}"';
 $string['unknowncourserequest'] = 'Unknown course request';
+$string['unknownevent'] = 'Unknown event';
 $string['unknownfiletype'] = 'Error unknown filtertype';
 $string['unknowngroup'] = 'Unknown group "{$a}"';
 $string['unknownhelp'] = 'Unknown help topic {$a}';
diff --git a/lib/classes/event/base.php b/lib/classes/event/base.php
index fd031d4dbb0..ecd42e3831a 100644
--- a/lib/classes/event/base.php
+++ b/lib/classes/event/base.php
@@ -234,25 +234,21 @@ abstract class base implements \IteratorAggregate {
      *
      * Override in subclass, we can not make it static and abstract at the same time.
      *
-     * TODO: MDL-37658
-     *
-     * @return string|\lang_string
+     * @return string
      */
     public static function get_name() {
         // Override in subclass with real lang string.
         $parts = explode('\\', __CLASS__);
         if (count($parts) !== 3) {
-            return 'unknown event';
+            return get_string('unknownevent', 'error');
         }
         return $parts[0].': '.str_replace('_', ' ', $parts[2]);
     }
 
     /**
-     * Returns localised description of what happened.
+     * Returns non-localised event description with id's for admin use only.
      *
-     * TODO: MDL-37658
-     *
-     * @return string|\lang_string
+     * @return string
      */
     public function get_description() {
         return null;