moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 08:56:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-37459 admin: Code improvements for admin defaults.

Browse source 
Split apply_admin_defaults_after_data so the defaults are set before
set_data is called.

Change function from private to protected.

Change check for if module for is an add or an update.
This commit is contained in:
Damyon Wiese 2013-06-12 14:10:55 +08:00
parent fa358a83ad
commit c30371168f
1 changed files with 43 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

81
course/moodleform_mod.php
View file

@ -50,16 +50,10 @@ abstract class moodleform_mod extends moodleform {
protected $_outcomesused; protected $_outcomesused;
/** /**
* @var bool A flag used to indicate that this module should get it's defaults from admin settings. * @var bool A flag used to indicate that this module should lock settings
* based on admin settings flags in definition_after_data.
*/ */
protected $applyadmindefaults = false; protected $applyadminlockedflags = false;
/**
* @var array A list of date offsets to apply to defaults for datetime settings.
* This is a named array where the keys are the shortnames of the settings and
* the values are integers representing the relative time offset.
*/
protected $admindefaultdateoffsets = array();
function moodleform_mod($current, $section, $cm, $course) { function moodleform_mod($current, $section, $cm, $course) {
$this->current = $current; $this->current = $current;
@ -292,7 +286,7 @@ abstract class moodleform_mod extends moodleform {
} }
// Freeze admin defaults if required (and not different from default) // Freeze admin defaults if required (and not different from default)
$this->apply_admin_defaults_after_data(); $this->apply_admin_locked_flags();
} }
// form verification // form verification
@ -887,21 +881,56 @@ abstract class moodleform_mod extends moodleform {
* *
* @return void * @return void
*/ */
private function apply_admin_defaults_after_data() { protected function apply_admin_locked_flags() {
global $OUTPUT; global $OUTPUT;
if (!$this->applyadmindefaults) { if (!$this->applyadminlockedflags) {
return; return;
} }
$datetimeoffsets = $this->admindefaultdateoffsets;
$settings = get_config($this->_modname); $settings = get_config($this->_modname);
$mform = $this->_form; $mform = $this->_form;
$lockedicon = html_writer::tag('span', $lockedicon = html_writer::tag('span',
$OUTPUT->pix_icon('t/locked', get_string('locked', 'admin')), $OUTPUT->pix_icon('t/locked', get_string('locked', 'admin')),
array('class' => 'action-icon')); array('class' => 'action-icon'));
foreach ($settings as $name => $value) {
if (strpos('_', $name) !== false) {
continue;
}
if ($mform->elementExists($name)) {
$element = $mform->getElement($name);
$lockedsetting = $name . '_locked';
if (!empty($settings->$lockedsetting)) {
$value = $mform->getElement($name)->getValue();
$value = reset($value);
if ($value == $settings->$name) {
$mform->setConstant($name, $settings->$name);
$element->setLabel($element->getLabel() . $lockedicon);
// Do not use hardfreeze because we need the hidden input to check dependencies.
$element->freeze();
}
}
}
}
}
/**
* Get the list of admin settings for this module and apply any defaults/advanced/locked settings.
*
* @param $datetimeoffsets array - If passed, this is an array of fieldnames => times that the
* default date/time value should be relative to. If not passed, all
* date/time fields are set relative to the users current midnight.
* @return void
*/
public function apply_admin_defaults($datetimeoffsets = array()) {
// This flag triggers the settings to be locked in apply_admin_locked_flags().
$this->applyadminlockedflags = true;
$settings = get_config($this->_modname);
$mform = $this->_form;
$usermidnight = usergetmidnight(time()); $usermidnight = usergetmidnight(time());
$isupdate = !empty($this->current->id); $isupdate = !empty($this->_cm);
foreach ($settings as $name => $value) { foreach ($settings as $name => $value) {
if (strpos('_', $name) !== false) { if (strpos('_', $name) !== false) {
@ -929,33 +958,9 @@ abstract class moodleform_mod extends moodleform {
if (!empty($settings->$advancedsetting)) { if (!empty($settings->$advancedsetting)) {
$mform->setAdvanced($name); $mform->setAdvanced($name);
} }
$lockedsetting = $name . '_locked';
if (!empty($settings->$lockedsetting)) {
$value = $mform->getElement($name)->getValue();
$value = reset($value);
if ($value == $settings->$name) {
$mform->setConstant($name, $settings->$name);
$element->setLabel($element->getLabel() . $lockedicon);
// Do not use hardfreeze because we need the hidden input to check dependencies.
$element->freeze();
}
}
} }
} }
} }
/**
* Get the list of admin settings for this module and apply any defaults/advanced/locked settings.
*
* @param $datetimeoffsets array - If passed, this is an array of fieldnames => times that the
* default date/time value should be relative to. If not passed, all
* date/time fields are set relative to the users current midnight.
* @return void
*/
public function apply_admin_defaults($datetimeoffsets = array()) {
$this->applyadmindefaults = true;
$this->admindefaultdateoffsets = $datetimeoffsets;
}
} }