[Summary view] [Print] [Text view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Email failed event.
  19   *
  20   * @package    core
  21   * @since      Moodle 2.7
  22   * @copyright  2013 Mark Nelson <[email protected]>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core\event;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Email failed event class.
  32   *
  33   * @package    core
  34   * @since      Moodle 2.7
  35   * @copyright  2013 Mark Nelson <[email protected]>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class email_failed extends base {
  39  
  40      /**
  41       * Initialise the event data.
  42       */
  43      protected function init() {
  44          $this->data['crud'] = 'c';
  45          $this->data['edulevel'] = self::LEVEL_OTHER;
  46      }
  47  
  48      /**
  49       * Returns localised general event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventemailfailed');
  55      }
  56  
  57      /**
  58       * Returns non-localised description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "Failed to send an email from the user with id '$this->userid' to the user with id '$this->relateduserid'
  64              due to the following error: \"{$this->other['errorinfo']}\".";
  65      }
  66  
  67      /**
  68       * Return legacy data for add_to_log().
  69       *
  70       * @return array
  71       */
  72      protected function get_legacy_logdata() {
  73          return array(SITEID, 'library', 'mailer', qualified_me(), 'ERROR: ' . $this->other['errorinfo']);
  74      }
  75  
  76      /**
  77       * Custom validation.
  78       *
  79       * @throws \coding_exception
  80       */
  81      protected function validate_data() {
  82          parent::validate_data();
  83  
  84          if (!isset($this->relateduserid)) {
  85              throw new \coding_exception('The \'relateduserid\' must be set.');
  86          }
  87          if (!isset($this->other['subject'])) {
  88              throw new \coding_exception('The \'subject\' value must be set in other.');
  89          }
  90          if (!isset($this->other['message'])) {
  91              throw new \coding_exception('The \'message\' value must be set in other.');
  92          }
  93          if (!isset($this->other['errorinfo'])) {
  94              throw new \coding_exception('The \'errorinfo\' value must be set in other.');
  95          }
  96      }
  97  }