Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402]

   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   * Testing outgoing mail configuration form
  19   *
  20   * @package    core
  21   * @copyright  2019 Victor Deniz <victor@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_admin\form;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  require_once($CFG->libdir.'/formslib.php');
  30  
  31  /**
  32   * Test mail form
  33   *
  34   * @package    core
  35   * @copyright 2019 Victor Deniz <victor@moodle.com>
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class testoutgoingmailconf_form extends \moodleform {
  39      /**
  40       * Add elements to form
  41       */
  42      public function definition() {
  43          $mform = $this->_form;
  44  
  45          // Recipient.
  46          $options = ['maxlength' => '100', 'size' => '25', 'autocomplete' => 'email'];
  47          $mform->addElement('text', 'recipient', get_string('testoutgoingmailconf_toemail', 'admin'), $options);
  48          $mform->setType('recipient', PARAM_EMAIL);
  49          $mform->addRule('recipient', get_string('required'), 'required');
  50  
  51          // From user.
  52          $options = ['maxlength' => '100', 'size' => '25'];
  53          $mform->addElement('text', 'from', get_string('testoutgoingmailconf_fromemail', 'admin'), $options);
  54          $mform->setType('from', PARAM_TEXT);
  55          $mform->addHelpButton('from', 'testoutgoingmailconf_fromemail', 'admin');
  56  
  57          // Additional subject text.
  58          $options = ['size' => '25'];
  59          $mform->addElement('text', 'additionalsubject', get_string('testoutgoingmailconf_subjectadditional', 'admin'), $options);
  60          $mform->setType('additionalsubject', PARAM_TEXT);
  61  
  62          $buttonarray = array();
  63          $buttonarray[] = $mform->createElement('submit', 'send', get_string('testoutgoingmailconf_sendtest', 'admin'));
  64          $buttonarray[] = $mform->createElement('cancel');
  65  
  66          $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
  67          $mform->closeHeaderBefore('buttonar');
  68  
  69      }
  70  
  71      /**
  72       * Validate Form field, should be a valid email format or a username that matches with a Moodle user.
  73       *
  74       * @param array $data
  75       * @param array $files
  76       * @return array
  77       * @throws \dml_exception|\coding_exception
  78       */
  79      public function validation($data, $files): array {
  80          $errors = parent::validation($data, $files);
  81  
  82          if (isset($data['from']) && $data['from']) {
  83              $userfrom = \core_user::get_user_by_username($data['from']);
  84  
  85              if (!$userfrom && !validate_email($data['from'])) {
  86                  $errors['from'] = get_string('testoutgoingmailconf_fromemail_invalid', 'admin');
  87              }
  88          }
  89  
  90          return $errors;
  91      }
  92  }