auth/imap/settings.php

   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  * Admin settings and defaults.
  19  *
  20  * @package auth_imap
  21  * @copyright  2017 Stephen Bourget
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die;
  26
  27 if ($ADMIN->fulltree) {
  28
  29     // Introductory explanation.
  30     $settings->add(new admin_setting_heading('auth_imap/pluginname', '', new lang_string('auth_imapdescription', 'auth_imap')));
  31
  32     // Host.
  33     $settings->add(new admin_setting_configtext('auth_imap/host', get_string('auth_imaphost_key', 'auth_imap'),
  34             get_string('auth_imaphost', 'auth_imap') . ' ' .get_string('auth_multiplehosts', 'auth'),
  35             '127.0.0.1', PARAM_RAW));
  36
  37     // Type.
  38     $imapoptions = array();
  39     $imaptypes = array('imap', 'imapssl', 'imapcert', 'imapnosslcert', 'imaptls');
  40     foreach ($imaptypes as $imaptype) {
  41         $imapoptions[$imaptype] = $imaptype;
  42     }
  43
  44     $settings->add(new admin_setting_configselect('auth_imap/type',
  45         new lang_string('auth_imaptype_key', 'auth_imap'),
  46         new lang_string('auth_imaptype', 'auth_imap'), 'imap', $imapoptions));
  47
  48     // Port.
  49     $settings->add(new admin_setting_configtext('auth_imap/port', get_string('auth_imapport_key', 'auth_imap'),
  50             get_string('auth_imapport', 'auth_imap'), '143', PARAM_INT));
  51
  52     // Password change URL.
  53     $settings->add(new admin_setting_configtext('auth_imap/changepasswordurl',
  54             get_string('auth_imapchangepasswordurl_key', 'auth_imap'),
  55             get_string('changepasswordhelp', 'auth'), '', PARAM_URL));
  56
  57     // Display locking / mapping of profile fields.
  58     $authplugin = get_auth_plugin('imap');
  59     display_auth_lock_options($settings, $authplugin->authtype, $authplugin->userfields,
  60             get_string('auth_fieldlocks_help', 'auth'), false, false);
  61
  62 }