mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
locallib.php
5104 lines (4406 loc) · 199 KB
/
locallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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/>.
/**
* This file contains the definition for the class assignment
*
* This class provides all the functionality for the new assign module.
*
* @package mod_assign
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Assignment submission statuses
*/
define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft'); // student thinks it is a draft
define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted'); // student thinks it is finished
/**
* Search filters for grading page
*/
define('ASSIGN_FILTER_SUBMITTED', 'submitted');
define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
/** Include accesslib.php */
require_once($CFG->libdir.'/accesslib.php');
/** Include formslib.php */
require_once($CFG->libdir.'/formslib.php');
/** Include repository/lib.php */
require_once($CFG->dirroot . '/repository/lib.php');
/** Include local mod_form.php */
require_once($CFG->dirroot.'/mod/assign/mod_form.php');
/** gradelib.php */
require_once($CFG->libdir.'/gradelib.php');
/** grading lib.php */
require_once($CFG->dirroot.'/grade/grading/lib.php');
/** Include feedbackplugin.php */
require_once($CFG->dirroot.'/mod/assign/feedbackplugin.php');
/** Include submissionplugin.php */
require_once($CFG->dirroot.'/mod/assign/submissionplugin.php');
/** Include renderable.php */
require_once($CFG->dirroot.'/mod/assign/renderable.php');
/** Include gradingtable.php */
require_once($CFG->dirroot.'/mod/assign/gradingtable.php');
/** Include eventslib.php */
require_once($CFG->libdir.'/eventslib.php');
/** Include portfolio caller.php */
require_once($CFG->libdir . '/portfolio/caller.php');
/**
* Standard base class for mod_assign (assignment types).
*
* @package mod_assign
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class assign {
/** @var stdClass the assignment record that contains the global settings for this assign instance */
private $instance;
/** @var context the context of the course module for this assign instance (or just the course if we are
creating a new one) */
private $context;
/** @var stdClass the course this assign instance belongs to */
private $course;
/** @var stdClass the admin config for all assign instances */
private $adminconfig;
/** @var assign_renderer the custom renderer for this module */
private $output;
/** @var stdClass the course module for this assign instance */
private $coursemodule;
/** @var array cache for things like the coursemodule name or the scale menu - only lives for a single
request */
private $cache;
/** @var array list of the installed submission plugins */
private $submissionplugins;
/** @var array list of the installed feedback plugins */
private $feedbackplugins;
/** @var string action to be used to return to this page (without repeating any form submissions etc.) */
private $returnaction = 'view';
/** @var array params to be used to return to this page */
private $returnparams = array();
/** @var string modulename prevents excessive calls to get_string */
private static $modulename = null;
/** @var string modulenameplural prevents excessive calls to get_string */
private static $modulenameplural = null;
/**
* Constructor for the base assign class
*
* @param mixed $coursemodulecontext context|null the course module context (or the course context if the coursemodule has not been created yet)
* @param mixed $coursemodule the current course module if it was already loaded - otherwise this class will load one from the context as required
* @param mixed $course the current course if it was already loaded - otherwise this class will load one from the context as required
*/
public function __construct($coursemodulecontext, $coursemodule, $course) {
global $PAGE;
$this->context = $coursemodulecontext;
$this->coursemodule = $coursemodule;
$this->course = $course;
$this->cache = array(); // temporary cache only lives for a single request - used to reduce db lookups
$this->submissionplugins = $this->load_plugins('assignsubmission');
$this->feedbackplugins = $this->load_plugins('assignfeedback');
}
/**
* Set the action and parameters that can be used to return to the current page
*
* @param string $action The action for the current page
* @param array $params An array of name value pairs which form the parameters to return to the current page
* @return void
*/
public function register_return_link($action, $params) {
$this->returnaction = $action;
$this->returnparams = $params;
}
/**
* Return an action that can be used to get back to the current page
* @return string action
*/
public function get_return_action() {
return $this->returnaction;
}
/**
* Based on the current assignment settings should we display the intro
* @return bool showintro
*/
private function show_intro() {
if ($this->get_instance()->alwaysshowdescription ||
time() > $this->get_instance()->allowsubmissionsfromdate) {
return true;
}
return false;
}
/**
* Return a list of parameters that can be used to get back to the current page
* @return array params
*/
public function get_return_params() {
return $this->returnparams;
}
/**
* Set the submitted form data
* @param stdClass $data The form data (instance)
*/
public function set_instance(stdClass $data) {
$this->instance = $data;
}
/**
* Set the context
* @param context $context The new context
*/
public function set_context(context $context) {
$this->context = $context;
}
/**
* Set the course data
* @param stdClass $course The course data
*/
public function set_course(stdClass $course) {
$this->course = $course;
}
/**
* get list of feedback plugins installed
* @return array
*/
public function get_feedback_plugins() {
return $this->feedbackplugins;
}
/**
* get list of submission plugins installed
* @return array
*/
public function get_submission_plugins() {
return $this->submissionplugins;
}
/**
* Is blind marking enabled and reveal identities not set yet?
*
* @return bool
*/
public function is_blind_marking() {
return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
}
/**
* Does an assignment have submission(s) or grade(s) already?
*
* @return bool
*/
public function has_submissions_or_grades() {
$allgrades = $this->count_grades();
$allsubmissions = $this->count_submissions();
if (($allgrades == 0) && ($allsubmissions == 0)) {
return false;
}
return true;
}
/**
* get a specific submission plugin by its type
* @param string $subtype assignsubmission | assignfeedback
* @param string $type
* @return mixed assign_plugin|null
*/
public function get_plugin_by_type($subtype, $type) {
$shortsubtype = substr($subtype, strlen('assign'));
$name = $shortsubtype . 'plugins';
if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
return null;
}
$pluginlist = $this->$name;
foreach ($pluginlist as $plugin) {
if ($plugin->get_type() == $type) {
return $plugin;
}
}
return null;
}
/**
* Get a feedback plugin by type
* @param string $type - The type of plugin e.g comments
* @return mixed assign_feedback_plugin|null
*/
public function get_feedback_plugin_by_type($type) {
return $this->get_plugin_by_type('assignfeedback', $type);
}
/**
* Get a submission plugin by type
* @param string $type - The type of plugin e.g comments
* @return mixed assign_submission_plugin|null
*/
public function get_submission_plugin_by_type($type) {
return $this->get_plugin_by_type('assignsubmission', $type);
}
/**
* Load the plugins from the sub folders under subtype
* @param string $subtype - either submission or feedback
* @return array - The sorted list of plugins
*/
private function load_plugins($subtype) {
global $CFG;
$result = array();
$names = get_plugin_list($subtype);
foreach ($names as $name => $path) {
if (file_exists($path . '/locallib.php')) {
require_once($path . '/locallib.php');
$shortsubtype = substr($subtype, strlen('assign'));
$pluginclass = 'assign_' . $shortsubtype . '_' . $name;
$plugin = new $pluginclass($this, $name);
if ($plugin instanceof assign_plugin) {
$idx = $plugin->get_sort_order();
while (array_key_exists($idx, $result)) $idx +=1;
$result[$idx] = $plugin;
}
}
}
ksort($result);
return $result;
}
/**
* Display the assignment, used by view.php
*
* The assignment is displayed differently depending on your role,
* the settings for the assignment and the status of the assignment.
* @param string $action The current action if any.
* @return void
*/
public function view($action='') {
$o = '';
$mform = null;
$notices = array();
// Handle form submissions first.
if ($action == 'savesubmission') {
$action = 'editsubmission';
if ($this->process_save_submission($mform, $notices)) {
$action = 'view';
}
} else if ($action == 'lock') {
$this->process_lock();
$action = 'grading';
} else if ($action == 'reverttodraft') {
$this->process_revert_to_draft();
$action = 'grading';
} else if ($action == 'unlock') {
$this->process_unlock();
$action = 'grading';
} else if ($action == 'confirmsubmit') {
$action = 'submit';
if ($this->process_submit_for_grading($mform)) {
$action = 'view';
}
} else if ($action == 'gradingbatchoperation') {
$action = $this->process_grading_batch_operation($mform);
} else if ($action == 'submitgrade') {
if (optional_param('saveandshownext', null, PARAM_RAW)) {
//save and show next
$action = 'grade';
if ($this->process_save_grade($mform)) {
$action = 'nextgrade';
}
} else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
$action = 'previousgrade';
} else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
//show next button
$action = 'nextgrade';
} else if (optional_param('savegrade', null, PARAM_RAW)) {
//save changes button
$action = 'grade';
if ($this->process_save_grade($mform)) {
$action = 'grading';
}
} else {
//cancel button
$action = 'grading';
}
} else if ($action == 'quickgrade') {
$message = $this->process_save_quick_grades();
$action = 'quickgradingresult';
} else if ($action == 'saveoptions') {
$this->process_save_grading_options();
$action = 'grading';
} else if ($action == 'saveextension') {
$action = 'grantextension';
if ($this->process_save_extension($mform)) {
$action = 'grading';
}
} else if ($action == 'revealidentitiesconfirm') {
$this->process_reveal_identities();
$action = 'grading';
}
$returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT));
$this->register_return_link($action, $returnparams);
// Now show the right view page.
if ($action == 'previousgrade') {
$mform = null;
$o .= $this->view_single_grade_page($mform, -1);
} else if ($action == 'quickgradingresult') {
$mform = null;
$o .= $this->view_quickgrading_result($message);
} else if ($action == 'nextgrade') {
$mform = null;
$o .= $this->view_single_grade_page($mform, 1);
} else if ($action == 'grade') {
$o .= $this->view_single_grade_page($mform);
} else if ($action == 'viewpluginassignfeedback') {
$o .= $this->view_plugin_content('assignfeedback');
} else if ($action == 'viewpluginassignsubmission') {
$o .= $this->view_plugin_content('assignsubmission');
} else if ($action == 'editsubmission') {
$o .= $this->view_edit_submission_page($mform, $notices);
} else if ($action == 'grading') {
$o .= $this->view_grading_page();
} else if ($action == 'downloadall') {
$o .= $this->download_submissions();
} else if ($action == 'submit') {
$o .= $this->check_submit_for_grading($mform);
} else if ($action == 'grantextension') {
$o .= $this->view_grant_extension($mform);
} else if ($action == 'revealidentities') {
$o .= $this->view_reveal_identities_confirm($mform);
} else if ($action == 'plugingradingbatchoperation') {
$o .= $this->view_plugin_grading_batch_operation($mform);
} else if ($action == 'viewpluginpage') {
$o .= $this->view_plugin_page();
} else if ($action == 'viewcourseindex') {
$o .= $this->view_course_index();
} else {
$o .= $this->view_submission_page();
}
return $o;
}
/**
* Add this instance to the database
*
* @param stdClass $formdata The data submitted from the form
* @param bool $callplugins This is used to skip the plugin code
* when upgrading an old assignment to a new one (the plugins get called manually)
* @return mixed false if an error occurs or the int id of the new instance
*/
public function add_instance(stdClass $formdata, $callplugins) {
global $DB;
$err = '';
// add the database record
$update = new stdClass();
$update->name = $formdata->name;
$update->timemodified = time();
$update->timecreated = time();
$update->course = $formdata->course;
$update->courseid = $formdata->course;
$update->intro = $formdata->intro;
$update->introformat = $formdata->introformat;
$update->alwaysshowdescription = $formdata->alwaysshowdescription;
$update->submissiondrafts = $formdata->submissiondrafts;
$update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
$update->sendnotifications = $formdata->sendnotifications;
$update->sendlatenotifications = $formdata->sendlatenotifications;
$update->duedate = $formdata->duedate;
$update->cutoffdate = $formdata->cutoffdate;
$update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
$update->grade = $formdata->grade;
$update->completionsubmit = !empty($formdata->completionsubmit);
$update->teamsubmission = $formdata->teamsubmission;
$update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
$update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
$update->blindmarking = $formdata->blindmarking;
$returnid = $DB->insert_record('assign', $update);
$this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
// cache the course record
$this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
if ($callplugins) {
// call save_settings hook for submission plugins
foreach ($this->submissionplugins as $plugin) {
if (!$this->update_plugin_instance($plugin, $formdata)) {
print_error($plugin->get_error());
return false;
}
}
foreach ($this->feedbackplugins as $plugin) {
if (!$this->update_plugin_instance($plugin, $formdata)) {
print_error($plugin->get_error());
return false;
}
}
// in the case of upgrades the coursemodule has not been set so we need to wait before calling these two
// TODO: add event to the calendar
$this->update_calendar($formdata->coursemodule);
// TODO: add the item in the gradebook
$this->update_gradebook(false, $formdata->coursemodule);
}
$update = new stdClass();
$update->id = $this->get_instance()->id;
$update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
$DB->update_record('assign', $update);
return $returnid;
}
/**
* Delete all grades from the gradebook for this assignment
*
* @return bool
*/
private function delete_grades() {
global $CFG;
return grade_update('mod/assign', $this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, 0, NULL, array('deleted'=>1)) == GRADE_UPDATE_OK;
}
/**
* Delete this instance from the database
*
* @return bool false if an error occurs
*/
public function delete_instance() {
global $DB;
$result = true;
foreach ($this->submissionplugins as $plugin) {
if (!$plugin->delete_instance()) {
print_error($plugin->get_error());
$result = false;
}
}
foreach ($this->feedbackplugins as $plugin) {
if (!$plugin->delete_instance()) {
print_error($plugin->get_error());
$result = false;
}
}
// delete files associated with this assignment
$fs = get_file_storage();
if (! $fs->delete_area_files($this->context->id) ) {
$result = false;
}
// delete_records will throw an exception if it fails - so no need for error checking here
$DB->delete_records('assign_submission', array('assignment'=>$this->get_instance()->id));
$DB->delete_records('assign_grades', array('assignment'=>$this->get_instance()->id));
$DB->delete_records('assign_plugin_config', array('assignment'=>$this->get_instance()->id));
// delete items from the gradebook
if (! $this->delete_grades()) {
$result = false;
}
// delete the instance
$DB->delete_records('assign', array('id'=>$this->get_instance()->id));
return $result;
}
/**
* Actual implementation of the reset course functionality, delete all the
* assignment submissions for course $data->courseid.
*
* @param $data the data submitted from the reset course.
* @return array status array
*/
public function reset_userdata($data) {
global $CFG,$DB;
$componentstr = get_string('modulenameplural', 'assign');
$status = array();
$fs = get_file_storage();
if (!empty($data->reset_assign_submissions)) {
// Delete files associated with this assignment.
foreach ($this->submissionplugins as $plugin) {
$fileareas = array();
$plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
$fileareas = $plugin->get_file_areas();
foreach ($fileareas as $filearea) {
$fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
}
if (!$plugin->delete_instance()) {
$status[] = array('component'=>$componentstr,
'item'=>get_string('deleteallsubmissions','assign'),
'error'=>$plugin->get_error());
}
}
foreach ($this->feedbackplugins as $plugin) {
$fileareas = array();
$plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
$fileareas = $plugin->get_file_areas();
foreach ($fileareas as $filearea) {
$fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
}
if (!$plugin->delete_instance()) {
$status[] = array('component'=>$componentstr,
'item'=>get_string('deleteallsubmissions','assign'),
'error'=>$plugin->get_error());
}
}
$assignssql = "SELECT a.id
FROM {assign} a
WHERE a.course=:course";
$params = array ("course" => $data->courseid);
$DB->delete_records_select('assign_submission', "assignment IN ($assignssql)", $params);
$status[] = array('component'=>$componentstr,
'item'=>get_string('deleteallsubmissions','assign'),
'error'=>false);
if (empty($data->reset_gradebook_grades)) {
// Remove all grades from gradebook.
require_once($CFG->dirroot.'/mod/assign/lib.php');
assign_reset_gradebook($data->courseid);
}
}
// Updating dates - shift may be negative too.
if ($data->timeshift) {
shift_course_mod_dates('assign',
array('duedate', 'allowsubmissionsfromdate','cutoffdate'),
$data->timeshift,
$data->courseid);
$status[] = array('component'=>$componentstr,
'item'=>get_string('datechanged'),
'error'=>false);
}
return $status;
}
/**
* Update the settings for a single plugin
*
* @param assign_plugin $plugin The plugin to update
* @param stdClass $formdata The form data
* @return bool false if an error occurs
*/
private function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
if ($plugin->is_visible()) {
$enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
if ($formdata->$enabledname) {
$plugin->enable();
if (!$plugin->save_settings($formdata)) {
print_error($plugin->get_error());
return false;
}
} else {
$plugin->disable();
}
}
return true;
}
/**
* Update the gradebook information for this assignment
*
* @param bool $reset If true, will reset all grades in the gradbook for this assignment
* @param int $coursemoduleid This is required because it might not exist in the database yet
* @return bool
*/
public function update_gradebook($reset, $coursemoduleid) {
global $CFG;
/** Include lib.php */
require_once($CFG->dirroot.'/mod/assign/lib.php');
$assign = clone $this->get_instance();
$assign->cmidnumber = $coursemoduleid;
$param = null;
if ($reset) {
$param = 'reset';
}
return assign_grade_item_update($assign, $param);
}
/** Load and cache the admin config for this module
*
* @return stdClass the plugin config
*/
public function get_admin_config() {
if ($this->adminconfig) {
return $this->adminconfig;
}
$this->adminconfig = get_config('assign');
return $this->adminconfig;
}
/**
* Update the calendar entries for this assignment
*
* @param int $coursemoduleid - Required to pass this in because it might not exist in the database yet
* @return bool
*/
public function update_calendar($coursemoduleid) {
global $DB, $CFG;
require_once($CFG->dirroot.'/calendar/lib.php');
// special case for add_instance as the coursemodule has not been set yet.
if ($this->get_instance()->duedate) {
$event = new stdClass();
if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id))) {
$event->name = $this->get_instance()->name;
$event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
$event->timestart = $this->get_instance()->duedate;
$calendarevent = calendar_event::load($event->id);
$calendarevent->update($event);
} else {
$event = new stdClass();
$event->name = $this->get_instance()->name;
$event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
$event->courseid = $this->get_instance()->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'assign';
$event->instance = $this->get_instance()->id;
$event->eventtype = 'due';
$event->timestart = $this->get_instance()->duedate;
$event->timeduration = 0;
calendar_event::create($event);
}
} else {
$DB->delete_records('event', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id));
}
}
/**
* Update this instance in the database
*
* @param stdClass $formdata - the data submitted from the form
* @return bool false if an error occurs
*/
public function update_instance($formdata) {
global $DB;
$update = new stdClass();
$update->id = $formdata->instance;
$update->name = $formdata->name;
$update->timemodified = time();
$update->course = $formdata->course;
$update->intro = $formdata->intro;
$update->introformat = $formdata->introformat;
$update->alwaysshowdescription = $formdata->alwaysshowdescription;
$update->submissiondrafts = $formdata->submissiondrafts;
$update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
$update->sendnotifications = $formdata->sendnotifications;
$update->sendlatenotifications = $formdata->sendlatenotifications;
$update->duedate = $formdata->duedate;
$update->cutoffdate = $formdata->cutoffdate;
$update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
$update->grade = $formdata->grade;
$update->completionsubmit = !empty($formdata->completionsubmit);
$update->teamsubmission = $formdata->teamsubmission;
$update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
$update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
$update->blindmarking = $formdata->blindmarking;
$result = $DB->update_record('assign', $update);
$this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
// load the assignment so the plugins have access to it
// call save_settings hook for submission plugins
foreach ($this->submissionplugins as $plugin) {
if (!$this->update_plugin_instance($plugin, $formdata)) {
print_error($plugin->get_error());
return false;
}
}
foreach ($this->feedbackplugins as $plugin) {
if (!$this->update_plugin_instance($plugin, $formdata)) {
print_error($plugin->get_error());
return false;
}
}
// update the database record
// update all the calendar events
$this->update_calendar($this->get_course_module()->id);
$this->update_gradebook(false, $this->get_course_module()->id);
$update = new stdClass();
$update->id = $this->get_instance()->id;
$update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
$DB->update_record('assign', $update);
return $result;
}
/**
* add elements in grading plugin form
*
* @param mixed $grade stdClass|null
* @param MoodleQuickForm $mform
* @param stdClass $data
* @param int $userid - The userid we are grading
* @return void
*/
private function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
foreach ($this->feedbackplugins as $plugin) {
if ($plugin->is_enabled() && $plugin->is_visible()) {
$mform->addElement('header', 'header_' . $plugin->get_type(), $plugin->get_name());
if (!$plugin->get_form_elements_for_user($grade, $mform, $data, $userid)) {
$mform->removeElement('header_' . $plugin->get_type());
}
}
}
}
/**
* Add one plugins settings to edit plugin form
*
* @param assign_plugin $plugin The plugin to add the settings from
* @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
* @return void
*/
private function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform) {
global $CFG;
if ($plugin->is_visible()) {
// enabled
//tied disableIf rule to this select element
$mform->addElement('selectyesno', $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $plugin->get_name());
$mform->addHelpButton($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', 'enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
$default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
if ($plugin->get_config('enabled') !== false) {
$default = $plugin->is_enabled();
}
$mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
$plugin->get_settings($mform);
}
}
/**
* Add settings to edit plugin form
*
* @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
* @return void
*/
public function add_all_plugin_settings(MoodleQuickForm $mform) {
$mform->addElement('header', 'general', get_string('submissionsettings', 'assign'));
foreach ($this->submissionplugins as $plugin) {
$this->add_plugin_settings($plugin, $mform);
}
$mform->addElement('header', 'general', get_string('feedbacksettings', 'assign'));
foreach ($this->feedbackplugins as $plugin) {
$this->add_plugin_settings($plugin, $mform);
}
}
/**
* Allow each plugin an opportunity to update the defaultvalues
* passed in to the settings form (needed to set up draft areas for
* editor and filemanager elements)
* @param array $defaultvalues
*/
public function plugin_data_preprocessing(&$defaultvalues) {
foreach ($this->submissionplugins as $plugin) {
if ($plugin->is_visible()) {
$plugin->data_preprocessing($defaultvalues);
}
}
foreach ($this->feedbackplugins as $plugin) {
if ($plugin->is_visible()) {
$plugin->data_preprocessing($defaultvalues);
}
}
}
/**
* Get the name of the current module.
*
* @return string the module name (Assignment)
*/
protected function get_module_name() {
if (isset(self::$modulename)) {
return self::$modulename;
}
self::$modulename = get_string('modulename', 'assign');
return self::$modulename;
}
/**
* Get the plural name of the current module.
*
* @return string the module name plural (Assignments)
*/
protected function get_module_name_plural() {
if (isset(self::$modulenameplural)) {
return self::$modulenameplural;
}
self::$modulenameplural = get_string('modulenameplural', 'assign');
return self::$modulenameplural;
}
/**
* Has this assignment been constructed from an instance?
*
* @return bool
*/
public function has_instance() {
return $this->instance || $this->get_course_module();
}
/**
* Get the settings for the current instance of this assignment
*
* @return stdClass The settings
*/
public function get_instance() {
global $DB;
if ($this->instance) {
return $this->instance;
}
if ($this->get_course_module()) {
$this->instance = $DB->get_record('assign', array('id' => $this->get_course_module()->instance), '*', MUST_EXIST);
}
if (!$this->instance) {
throw new coding_exception('Improper use of the assignment class. Cannot load the assignment record.');
}
return $this->instance;
}
/**
* Get the context of the current course
* @return mixed context|null The course context
*/
public function get_course_context() {
if (!$this->context && !$this->course) {
throw new coding_exception('Improper use of the assignment class. Cannot load the course context.');
}
if ($this->context) {
return $this->context->get_course_context();
} else {
return context_course::instance($this->course->id);
}
}
/**
* Get the current course module
*
* @return mixed stdClass|null The course module
*/
public function get_course_module() {
if ($this->coursemodule) {
return $this->coursemodule;
}
if (!$this->context) {
return null;
}
if ($this->context->contextlevel == CONTEXT_MODULE) {
$this->coursemodule = get_coursemodule_from_id('assign', $this->context->instanceid, 0, false, MUST_EXIST);
return $this->coursemodule;
}
return null;
}
/**
* Get context module
*
* @return context
*/
public function get_context() {
return $this->context;
}
/**
* Get the current course
* @return mixed stdClass|null The course
*/
public function get_course() {