You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
206 lines
8.6 KiB
206 lines
8.6 KiB
<?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/>.
|
|
|
|
/**
|
|
* LDAP enrolment plugin admin setting classes
|
|
*
|
|
* @package enrol_ldap
|
|
* @author Iñaki Arenaza
|
|
* @copyright 2010 Iñaki Arenaza <iarenaza@eps.mondragon.edu>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
class admin_setting_configtext_trim_lower extends admin_setting_configtext {
|
|
/* @var boolean whether to lowercase the value or not before writing in to the db */
|
|
private $lowercase;
|
|
|
|
/**
|
|
* Constructor: uses parent::__construct
|
|
*
|
|
* @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
|
|
* @param string $visiblename localised
|
|
* @param string $description long localised info
|
|
* @param string $defaultsetting default value for the setting
|
|
* @param boolean $lowercase if true, lowercase the value before writing it to the db.
|
|
* @param boolean $enabled if true, the input field is enabled, otherwise it's disabled.
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $lowercase=false, $enabled=true) {
|
|
$this->lowercase = $lowercase;
|
|
$this->enabled = $enabled;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Saves the setting(s) provided in $data
|
|
*
|
|
* @param array $data An array of data, if not array returns empty str
|
|
* @return mixed empty string on useless data or success, error string if failed
|
|
*/
|
|
public function write_setting($data) {
|
|
if ($this->paramtype === PARAM_INT and $data === '') {
|
|
// do not complain if '' used instead of 0
|
|
$data = 0;
|
|
}
|
|
|
|
// $data is a string
|
|
$validated = $this->validate($data);
|
|
if ($validated !== true) {
|
|
return $validated;
|
|
}
|
|
if ($this->lowercase) {
|
|
$data = core_text::strtolower($data);
|
|
}
|
|
if (!$this->enabled) {
|
|
return '';
|
|
}
|
|
return ($this->config_write($this->name, trim($data)) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
}
|
|
|
|
class admin_setting_ldap_rolemapping extends admin_setting {
|
|
|
|
/**
|
|
* Constructor: uses parent::__construct
|
|
*
|
|
* @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
|
|
* @param string $visiblename localised
|
|
* @param string $description long localised info
|
|
* @param string $defaultsetting default value for the setting (actually unused)
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Returns the current setting if it is set
|
|
*
|
|
* @return mixed null if null, else an array
|
|
*/
|
|
public function get_setting() {
|
|
$roles = role_fix_names(get_all_roles());
|
|
$result = array();
|
|
foreach ($roles as $role) {
|
|
$contexts = $this->config_read('contexts_role'.$role->id);
|
|
$memberattribute = $this->config_read('memberattribute_role'.$role->id);
|
|
$result[] = array('id' => $role->id,
|
|
'name' => $role->localname,
|
|
'contexts' => $contexts,
|
|
'memberattribute' => $memberattribute);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Saves the setting(s) provided in $data
|
|
*
|
|
* @param array $data An array of data, if not array returns empty str
|
|
* @return mixed empty string on useless data or success, error string if failed
|
|
*/
|
|
public function write_setting($data) {
|
|
if(!is_array($data)) {
|
|
return ''; // ignore it
|
|
}
|
|
|
|
$result = '';
|
|
foreach ($data as $roleid => $data) {
|
|
if (!$this->config_write('contexts_role'.$roleid, trim($data['contexts']))) {
|
|
$return = get_string('errorsetting', 'admin');
|
|
}
|
|
if (!$this->config_write('memberattribute_role'.$roleid, core_text::strtolower(trim($data['memberattribute'])))) {
|
|
$return = get_string('errorsetting', 'admin');
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML field(s) as required by choices
|
|
*
|
|
* Relies on data being an array should data ever be another valid vartype with
|
|
* acceptable value this may cause a warning/error
|
|
* if (!is_array($data)) would fix the problem
|
|
*
|
|
* @todo Add vartype handling to ensure $data is an array
|
|
*
|
|
* @param array $data An array of checked values
|
|
* @param string $query
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$return = html_writer::start_tag('div', array('style' =>'float:left; width:auto; margin-right: 0.5em;'));
|
|
$return .= html_writer::tag('div', get_string('roles', 'role'), array('style' => 'height: 2em;'));
|
|
foreach ($data as $role) {
|
|
$return .= html_writer::tag('div', s($role['name']), array('style' => 'height: 2em;'));
|
|
}
|
|
$return .= html_writer::end_tag('div');
|
|
|
|
$return .= html_writer::start_tag('div', array('style' => 'float:left; width:auto; margin-right: 0.5em;'));
|
|
$return .= html_writer::tag('div', get_string('contexts', 'enrol_ldap'), array('style' => 'height: 2em;'));
|
|
foreach ($data as $role) {
|
|
$contextid = $this->get_id().'['.$role['id'].'][contexts]';
|
|
$contextname = $this->get_full_name().'['.$role['id'].'][contexts]';
|
|
$return .= html_writer::start_tag('div', array('style' => 'height: 2em;'));
|
|
$return .= html_writer::label(get_string('role_mapping_context', 'enrol_ldap', $role['name']), $contextid, false, array('class' => 'accesshide'));
|
|
$attrs = array('type' => 'text', 'size' => '40', 'id' => $contextid, 'name' => $contextname,
|
|
'value' => s($role['contexts']), 'class' => 'text-ltr');
|
|
$return .= html_writer::empty_tag('input', $attrs);
|
|
$return .= html_writer::end_tag('div');
|
|
}
|
|
$return .= html_writer::end_tag('div');
|
|
|
|
$return .= html_writer::start_tag('div', array('style' => 'float:left; width:auto; margin-right: 0.5em;'));
|
|
$return .= html_writer::tag('div', get_string('memberattribute', 'enrol_ldap'), array('style' => 'height: 2em;'));
|
|
foreach ($data as $role) {
|
|
$memberattrid = $this->get_id().'['.$role['id'].'][memberattribute]';
|
|
$memberattrname = $this->get_full_name().'['.$role['id'].'][memberattribute]';
|
|
$return .= html_writer::start_tag('div', array('style' => 'height: 2em;'));
|
|
$return .= html_writer::label(get_string('role_mapping_attribute', 'enrol_ldap', $role['name']), $memberattrid, false, array('class' => 'accesshide'));
|
|
$attrs = array('type' => 'text', 'size' => '15', 'id' => $memberattrid, 'name' => $memberattrname,
|
|
'value' => s($role['memberattribute']), 'class' => 'text-ltr');
|
|
$return .= html_writer::empty_tag('input', $attrs);
|
|
$return .= html_writer::end_tag('div');
|
|
}
|
|
$return .= html_writer::end_tag('div');
|
|
$return .= html_writer::tag('div', '', array('style' => 'clear:both;'));
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return,
|
|
$this->description, true, '', '', $query);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class implements new specialized setting for course categories that are loaded
|
|
* only when required
|
|
* @author Darko Miletic
|
|
*
|
|
*/
|
|
class enrol_ldap_admin_setting_category extends admin_setting_configselect {
|
|
public function __construct($name, $visiblename, $description) {
|
|
parent::__construct($name, $visiblename, $description, 1, null);
|
|
}
|
|
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
|
|
$this->choices = make_categories_options();
|
|
return true;
|
|
}
|
|
}
|
|
|