course/reset_form.php

   1 <?php
   2 if (!defined('MOODLE_INTERNAL')) {
   3     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
   4 }
   5
   6 require_once $CFG->libdir.'/formslib.php';
   7
   8 class course_reset_form extends moodleform {
   9     function definition (){
  10         global $CFG, $COURSE, $DB;
  11
  12         $mform =& $this->_form;
  13
  14         $mform->addElement('header', 'generalheader', get_string('general'));
  15
  16         $mform->addElement('date_selector', 'reset_start_date', get_string('startdate'), array('optional'=>true));
  17         $mform->addHelpButton('reset_start_date', 'startdate');
  18         $mform->addElement('checkbox', 'reset_events', get_string('deleteevents', 'calendar'));
  19         $mform->addElement('checkbox', 'reset_notes', get_string('deletenotes', 'notes'));
  20         $mform->addElement('checkbox', 'reset_comments', get_string('deleteallcomments', 'moodle'));
  21         $mform->addElement('checkbox', 'reset_completion', get_string('deletecompletiondata', 'completion'));
  22         $mform->addElement('checkbox', 'delete_blog_associations', get_string('deleteblogassociations', 'blog'));
  23         $mform->addHelpButton('delete_blog_associations', 'deleteblogassociations', 'blog');
  24
  25
  26         $mform->addElement('header', 'rolesheader', get_string('roles'));
  27
  28         $roles = get_assignable_roles(context_course::instance($COURSE->id));
  29         $roles[0] = get_string('noroles', 'role');
  30         $roles = array_reverse($roles, true);
  31
  32         $mform->addElement('select', 'unenrol_users', get_string('unenrolroleusers', 'enrol'), $roles, array('multiple' => 'multiple'));
  33         $mform->addElement('checkbox', 'reset_roles_overrides', get_string('deletecourseoverrides', 'role'));
  34         $mform->setAdvanced('reset_roles_overrides');
  35         $mform->addElement('checkbox', 'reset_roles_local', get_string('deletelocalroles', 'role'));
  36
  37
  38         $mform->addElement('header', 'gradebookheader', get_string('gradebook', 'grades'));
  39
  40         $mform->addElement('checkbox', 'reset_gradebook_items', get_string('removeallcourseitems', 'grades'));
  41         $mform->addElement('checkbox', 'reset_gradebook_grades', get_string('removeallcoursegrades', 'grades'));
  42         $mform->disabledIf('reset_gradebook_grades', 'reset_gradebook_items', 'checked');
  43
  44
  45         $mform->addElement('header', 'groupheader', get_string('groups'));
  46
  47         $mform->addElement('checkbox', 'reset_groups_remove', get_string('deleteallgroups', 'group'));
  48         $mform->setAdvanced('reset_groups_remove');
  49         $mform->addElement('checkbox', 'reset_groups_members', get_string('removegroupsmembers', 'group'));
  50         $mform->setAdvanced('reset_groups_members');
  51         $mform->disabledIf('reset_groups_members', 'reset_groups_remove', 'checked');
  52
  53         $mform->addElement('checkbox', 'reset_groupings_remove', get_string('deleteallgroupings', 'group'));
  54         $mform->setAdvanced('reset_groupings_remove');
  55         $mform->addElement('checkbox', 'reset_groupings_members', get_string('removegroupingsmembers', 'group'));
  56         $mform->setAdvanced('reset_groupings_members');
  57         $mform->disabledIf('reset_groupings_members', 'reset_groupings_remove', 'checked');
  58
  59         $unsupported_mods = array();
  60         if ($allmods = $DB->get_records('modules') ) {
  61             foreach ($allmods as $mod) {
  62                 $modname = $mod->name;
  63                 $modfile = $CFG->dirroot."/mod/$modname/lib.php";
  64                 $mod_reset_course_form_definition = $modname.'_reset_course_form_definition';
  65                 $mod_reset__userdata = $modname.'_reset_userdata';
  66                 if (file_exists($modfile)) {
  67                     if (!$DB->count_records($modname, array('course'=>$COURSE->id))) {
  68                         continue; // Skip mods with no instances
  69                     }
  70                     include_once($modfile);
  71                     if (function_exists($mod_reset_course_form_definition)) {
  72                         $mod_reset_course_form_definition($mform);
  73                     } else if (!function_exists($mod_reset__userdata)) {
  74                         $unsupported_mods[] = $mod;
  75                     }
  76                 } else {
  77                     debugging('Missing lib.php in '.$modname.' module');
  78                 }
  79             }
  80         }
  81         // mention unsupported mods
  82         if (!empty($unsupported_mods)) {
  83             $mform->addElement('header', 'unsupportedheader', get_string('resetnotimplemented'));
  84             foreach($unsupported_mods as $mod) {
  85                 $mform->addElement('static', 'unsup'.$mod->name, get_string('modulenameplural', $mod->name));
  86                 $mform->setAdvanced('unsup'.$mod->name);
  87             }
  88         }
  89
  90         $mform->addElement('hidden', 'id', $COURSE->id);
  91         $mform->setType('id', PARAM_INT);
  92
  93         $buttonarray = array();
  94         $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('resetcourse'));
  95         $buttonarray[] = &$mform->createElement('submit', 'selectdefault', get_string('selectdefault'));
  96         $buttonarray[] = &$mform->createElement('submit', 'deselectall', get_string('deselectall'));
  97         $buttonarray[] = &$mform->createElement('cancel');
  98         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
  99         $mform->closeHeaderBefore('buttonar');
 100     }
 101
 102     function load_defaults() {
 103         global $CFG, $COURSE, $DB;
 104
 105         $mform =& $this->_form;
 106
 107         $defaults = array ('reset_events'=>1, 'reset_roles_local'=>1, 'reset_gradebook_grades'=>1, 'reset_notes'=>1);
 108
 109         // Set student as default in unenrol user list, if role with student archetype exist.
 110         if ($studentrole = get_archetype_roles('student')) {
 111             $defaults['unenrol_users'] = array_keys($studentrole);
 112         }
 113
 114         if ($allmods = $DB->get_records('modules') ) {
 115             foreach ($allmods as $mod) {
 116                 $modname = $mod->name;
 117                 $modfile = $CFG->dirroot."/mod/$modname/lib.php";
 118                 $mod_reset_course_form_defaults = $modname.'_reset_course_form_defaults';
 119                 if (file_exists($modfile)) {
 120                     @include_once($modfile);
 121                     if (function_exists($mod_reset_course_form_defaults)) {
 122                         if ($moddefs = $mod_reset_course_form_defaults($COURSE)) {
 123                             $defaults = $defaults + $moddefs;
 124                         }
 125                     }
 126                 }
 127             }
 128         }
 129
 130         foreach ($defaults as $element=>$default) {
 131             $mform->setDefault($element, $default);
 132         }
 133     }
 134 }