#48 Added task and settings responsible for emailing certificates

classes/output/email/renderer.php

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Email certificate as html renderer.
+ *
+ * @package    mod_customcert
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_customcert\output\email;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Email certificate as html renderer.
+ *
+ * @package    mod_customcert
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class renderer extends \mod_customcert\output\renderer {
+
+    /**
+     * The template name for this renderer.
+     *
+     * @return string
+     */
+    public function get_template_name() {
+        return 'email_certificate_html';
+    }
+}

classes/output/email/renderer_textemail.php

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Email certificate as text renderer.
+ *
+ * @package    mod_customcert
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_customcert\output\email;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Email certificate as text renderer.
+ *
+ * @package    mod_customcert
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class renderer_textemail extends \mod_customcert\output\renderer {
+
+    /**
+     * The template name for this renderer.
+     *
+     * @return string
+     */
+    public function get_template_name() {
+        return 'email_certificate_text';
+    }
+}

classes/output/email_certificate.php

@@ -0,0 +1,108 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Email certificate renderable.
+ *
+ * @package    mod_customcert
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_customcert\output;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Email certificate renderable.
+ *
+ * @copyright  2017 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class email_certificate implements \renderable, \templatable {
+
+    /**
+     * @var bool Are we emailing the student?
+     */
+    public $isstudent;
+
+    /**
+     * @var string The name of the user who owns the certificate.
+     */
+    public $userfullname;
+
+    /**
+     * @var string The course full name.
+     */
+    public $coursefullname;
+
+    /**
+     * @var int The certificate name.
+     */
+    public $certificatename;
+
+    /**
+     * @var int The course module id.
+     */
+    public $cmid;
+
+    /**
+     * Constructor.
+     *
+     * @param bool $isstudent Are we emailing the student?
+     * @param string $userfullname The name of the user who owns the certificate.
+     * @param string $coursefullname The name of the course.
+     * @param string $certificatename The name of the certificate.
+     * @param string $cmid The course module id.
+     */
+    public function __construct($isstudent, $userfullname, $coursefullname, $certificatename, $cmid) {
+        $this->isstudent = $isstudent;
+        $this->userfullname = $userfullname;
+        $this->coursefullname = $coursefullname;
+        $this->certificatename = $certificatename;
+        $this->cmid = $cmid;
+    }
+
+    /**
+     * Export this data so it can be used as the context for a mustache template.
+     *
+     * @param \renderer_base $renderer The render to be used for formatting the email
+     * @return \stdClass The data ready for use in a mustache template
+     */
+    public function export_for_template(\renderer_base $renderer) {
+        $data = new \stdClass();
+
+        // Used for the body text.
+        $info = new \stdClass();
+        $info->userfullname = $this->userfullname;
+        $info->certificatename = $this->certificatename;
+        $info->coursefullname = $this->coursefullname;
+
+        if ($this->isstudent) {
+            $data->emailgreeting = get_string('emailstudentgreeting', 'customcert', $this->userfullname);
+            $data->emailbody = get_string('emailstudentbody', 'customcert', $info);
+            $data->emailcertificatelink = new \moodle_url('/mod/customcert/view.php', array('id' => $this->cmid));
+            $data->emailcertificatetext = get_string('emailstudentcertificatelinktext', 'customcert');
+        } else {
+            $data->emailgreeting = get_string('emailnonstudentgreeting', 'customcert');
+            $data->emailbody = get_string('emailnonstudentbody', 'customcert', $info);
+            $data->emailcertificatelink = new \moodle_url('/mod/customcert/report.php', array('id' => $this->cmid));
+            $data->emailcertificatetext = get_string('emailnonstudentcertificatelinktext', 'customcert');
+        }
+
+        return $data;
+    }
+}

classes/output/renderer.php

@@ -49,4 +49,15 @@ class renderer extends plugin_renderer_base {
         $data = $page->export_for_template($this);
         return parent::render_from_template('mod_customcert/verify_certificate_results', $data);
     }
+
+    /**
+     * Formats the email used to send the certificate by the email_certificate_task.
+     *
+     * @param email_certificate $certificate The certificate to email
+     * @return string
+     */
+    public function render_email_certificate(email_certificate $certificate) {
+        $data = $certificate->export_for_template($this);
+        return $this->render_from_template('mod_customcert/' . $this->get_template_name(), $data);
+    }
 }