ELIS-9111: Update calls to Moodle API email_to_user() to include all required user properties.

Author: brentboghosian

lib.php

@@ -1153,28 +1153,6 @@ function rlip_get_notification_emails($plugin) {
     return array_values($result);
 }
 
-/**
- * Obtain an object that we can use as the target user in email_to_user
- *
- * @param string $email Email of the target recipient
- * @return object A user object, either from the db, or a simulated user record
- *                for non-moodle emails
- */
-function rlip_get_email_recipient($email) {
-    global $DB;
-
-    if ($result = $DB->get_record('user', array('email' => $email))) {
-        //user exists, so use their user record
-        return $result;
-    }
-
-    //fake user record for non-moodle recipient
-    $result = new stdClass;
-    $result->email = $email;
-
-    return $result;
-}
-
 /**
  * Send a log email to a specific recipient
  *
@@ -1204,7 +1182,7 @@ function rlip_send_log_email($plugin, $recipient, $archive_name) {
  * @param boolean $manual True if manual, false if scheduled
  */
 function rlip_send_log_emails($plugin, $logids, $manual = false) {
-    global $CFG;
+    global $CFG, $USER;
 
     //obtain the sanitized list of emails
     $emails = rlip_get_notification_emails($plugin);
@@ -1216,14 +1194,21 @@ function rlip_send_log_emails($plugin, $logids, $manual = false) {
         return false;
     }
 
-    //send to all appropriate users
+    // send to all appropriate users
+    // A valid $user->id & all other fields now required by Moodle 2.6+ email_to_user() API which also calls fullname($user).
+    $duser = new stdClass;
+    $allfields = get_all_user_name_fields();
+    foreach ($allfields as $field) {
+        $duser->$field = null;
+    }
+    $duser->id = $USER->id; // let's just use this user as default (TBD)
+    $duser->mailformat = 1;
     foreach ($emails as $email) {
-        $recipient = rlip_get_email_recipient($email);
-        rlip_send_log_email($plugin, $recipient, $archive_name);
+        $duser->email = trim($email);
+        rlip_send_log_email($plugin, $duser, $archive_name);
     }
 
     @unlink($CFG->dataroot.'/'.$archive_name);
-
     return true;
 }
 

tests/utility_methods_test.php

@@ -1384,34 +1384,6 @@ public function test_getnoficiationemailsremovesinvalidemails() {
         $this->assertEquals($emails, $expectedresult);
     }
 
-    /**
-     * Validate that email recipient retrieval creates a mock user record for
-     * an email address that is not within Moodle
-     */
-    public function test_getemailrecipientreturnsmockuserfornonexistentemailaddress() {
-        $recipient = rlip_get_email_recipient('[email protected]');
-
-        $expectedresult = new stdClass;
-        $expectedresult->email = '[email protected]';
-
-        $this->assertEquals($recipient, $expectedresult);
-    }
-
-    /**
-     * Validate that the email recipient retrieval uses an existing user record
-     * for an email address that is within Moodle
-     */
-    public function test_getemailrecipientreturnsvaliduserforexistingemailaddress() {
-        global $DB;
-
-        $this->create_complete_test_user();
-
-        $recipient = rlip_get_email_recipient('[email protected]');
-
-        $expectedresult = $DB->get_record('user', array('username' => 'rlipusername'));
-        $this->assertEquals($recipient, $expectedresult);
-    }
-
     /**
      * Validate zip file name construction for logging emails related to an
      * import plugin