forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
coursecatlib_test.php
773 lines (668 loc) · 39.9 KB
/
coursecatlib_test.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
<?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/>.
/**
* Tests for class coursecat from lib/coursecatlib.php
*
* @package core
* @category phpunit
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->libdir . '/coursecatlib.php');
/**
* Functional test for coursecatlib.php
*/
class core_coursecatlib_testcase extends advanced_testcase {
protected $roles;
protected function setUp() {
parent::setUp();
$this->resetAfterTest();
$user = $this->getDataGenerator()->create_user();
$this->setUser($user);
}
protected function get_roleid($context = null) {
global $USER;
if ($context === null) {
$context = context_system::instance();
}
if (is_object($context)) {
$context = $context->id;
}
if (empty($this->roles)) {
$this->roles = array();
}
if (empty($this->roles[$USER->id])) {
$this->roles[$USER->id] = array();
}
if (empty($this->roles[$USER->id][$context])) {
$this->roles[$USER->id][$context] = create_role('Role for '.$USER->id.' in '.$context, 'role'.$USER->id.'-'.$context, '-');
role_assign($this->roles[$USER->id][$context], $USER->id, $context);
}
return $this->roles[$USER->id][$context];
}
protected function assign_capability($capability, $permission = CAP_ALLOW, $contextid = null) {
if ($contextid === null) {
$contextid = context_system::instance();
}
if (is_object($contextid)) {
$contextid = $contextid->id;
}
assign_capability($capability, $permission, $this->get_roleid($contextid), $contextid, true);
accesslib_clear_all_caches_for_unit_testing();
}
public function test_create_coursecat() {
// Create the category.
$data = new stdClass();
$data->name = 'aaa';
$data->description = 'aaa';
$data->idnumber = '';
$category1 = coursecat::create($data);
// Initially confirm that base data was inserted correctly.
$this->assertSame($data->name, $category1->name);
$this->assertSame($data->description, $category1->description);
$this->assertSame($data->idnumber, $category1->idnumber);
$this->assertGreaterThanOrEqual(1, $category1->sortorder);
// Create two more categories and test the sortorder worked correctly.
$data->name = 'ccc';
$category2 = coursecat::create($data);
$data->name = 'bbb';
$category3 = coursecat::create($data);
$this->assertGreaterThan($category1->sortorder, $category2->sortorder);
$this->assertGreaterThan($category2->sortorder, $category3->sortorder);
}
public function test_name_idnumber_exceptions() {
try {
coursecat::create(array('name' => ''));
$this->fail('Missing category name exception expected in coursecat::create');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
$cat1 = coursecat::create(array('name' => 'Cat1', 'idnumber' => '1'));
try {
$cat1->update(array('name' => ''));
$this->fail('Missing category name exception expected in coursecat::update');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
try {
coursecat::create(array('name' => 'Cat2', 'idnumber' => '1'));
$this->fail('Duplicate idnumber exception expected in coursecat::create');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
$cat2 = coursecat::create(array('name' => 'Cat2', 'idnumber' => '2'));
try {
$cat2->update(array('idnumber' => '1'));
$this->fail('Duplicate idnumber exception expected in coursecat::update');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
// Test that duplicates with an idnumber of 0 cannot be created.
coursecat::create(array('name' => 'Cat3', 'idnumber' => '0'));
try {
coursecat::create(array('name' => 'Cat4', 'idnumber' => '0'));
$this->fail('Duplicate idnumber "0" exception expected in coursecat::create');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
// Test an update cannot make a duplicate idnumber of 0.
try {
$cat2->update(array('idnumber' => '0'));
$this->fail('Duplicate idnumber "0" exception expected in coursecat::update');
} catch (Exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
}
public function test_visibility() {
$this->assign_capability('moodle/category:viewhiddencategories');
$this->assign_capability('moodle/category:manage');
// Create category 1 initially hidden.
$category1 = coursecat::create(array('name' => 'Cat1', 'visible' => 0));
$this->assertEquals(0, $category1->visible);
$this->assertEquals(0, $category1->visibleold);
// Create category 2 initially hidden as a child of hidden category 1.
$category2 = coursecat::create(array('name' => 'Cat2', 'visible' => 0, 'parent' => $category1->id));
$this->assertEquals(0, $category2->visible);
$this->assertEquals(0, $category2->visibleold);
// Create category 3 initially visible as a child of hidden category 1.
$category3 = coursecat::create(array('name' => 'Cat3', 'visible' => 1, 'parent' => $category1->id));
$this->assertEquals(0, $category3->visible);
$this->assertEquals(1, $category3->visibleold);
// Show category 1 and make sure that category 2 is hidden and category 3 is visible.
$category1->show();
$this->assertEquals(1, coursecat::get($category1->id)->visible);
$this->assertEquals(0, coursecat::get($category2->id)->visible);
$this->assertEquals(1, coursecat::get($category3->id)->visible);
// Create visible category 4.
$category4 = coursecat::create(array('name' => 'Cat4'));
$this->assertEquals(1, $category4->visible);
$this->assertEquals(1, $category4->visibleold);
// Create visible category 5 as a child of visible category 4.
$category5 = coursecat::create(array('name' => 'Cat5', 'parent' => $category4->id));
$this->assertEquals(1, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
// Hide category 4 and make sure category 5 is hidden too.
$category4->hide();
$this->assertEquals(0, $category4->visible);
$this->assertEquals(0, $category4->visibleold);
$category5 = coursecat::get($category5->id); // We have to re-read from DB.
$this->assertEquals(0, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
// Show category 4 and make sure category 5 is visible too.
$category4->show();
$this->assertEquals(1, $category4->visible);
$this->assertEquals(1, $category4->visibleold);
$category5 = coursecat::get($category5->id); // We have to re-read from DB.
$this->assertEquals(1, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
// Move category 5 under hidden category 2 and make sure it became hidden.
$category5->change_parent($category2->id);
$this->assertEquals(0, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
// Re-read object for category 5 from DB and check again.
$category5 = coursecat::get($category5->id);
$this->assertEquals(0, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
// Rricky one! Move hidden category 5 under visible category ("Top") and make sure it is still hidden-
// WHY? Well, different people may expect different behaviour here. So better keep it hidden.
$category5->change_parent(0);
$this->assertEquals(0, $category5->visible);
$this->assertEquals(1, $category5->visibleold);
}
public function test_hierarchy() {
$this->assign_capability('moodle/category:viewhiddencategories');
$this->assign_capability('moodle/category:manage');
$category1 = coursecat::create(array('name' => 'Cat1'));
$category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id));
$category3 = coursecat::create(array('name' => 'Cat3', 'parent' => $category1->id));
$category4 = coursecat::create(array('name' => 'Cat4', 'parent' => $category2->id));
// Check function get_children().
$this->assertEquals(array($category2->id, $category3->id), array_keys($category1->get_children()));
// Check function get_parents().
$this->assertEquals(array($category1->id, $category2->id), $category4->get_parents());
// Can not move category to itself or to it's children.
$this->assertFalse($category1->can_change_parent($category2->id));
$this->assertFalse($category2->can_change_parent($category2->id));
// Can move category to grandparent.
$this->assertTrue($category4->can_change_parent($category1->id));
try {
$category2->change_parent($category4->id);
$this->fail('Exception expected - can not move category');
} catch (moodle_exception $e) {
$this->assertInstanceOf('moodle_exception', $e);
}
$category4->change_parent(0);
$this->assertEquals(array(), $category4->get_parents());
$this->assertEquals(array($category2->id, $category3->id), array_keys($category1->get_children()));
$this->assertEquals(array(), array_keys($category2->get_children()));
}
public function test_update() {
$category1 = coursecat::create(array('name' => 'Cat1'));
$timecreated = $category1->timemodified;
$this->assertSame('Cat1', $category1->name);
$this->assertTrue(empty($category1->description));
$this->waitForSecond();
$testdescription = 'This is cat 1 а также русский текст';
$category1->update(array('description' => $testdescription));
$this->assertSame($testdescription, $category1->description);
$category1 = coursecat::get($category1->id);
$this->assertSame($testdescription, $category1->description);
cache_helper::purge_by_event('changesincoursecat');
$category1 = coursecat::get($category1->id);
$this->assertSame($testdescription, $category1->description);
$this->assertGreaterThan($timecreated, $category1->timemodified);
}
public function test_delete() {
global $DB;
$this->assign_capability('moodle/category:manage');
$this->assign_capability('moodle/course:create');
$initialcatid = $DB->get_field_sql('SELECT max(id) from {course_categories}');
$category1 = coursecat::create(array('name' => 'Cat1'));
$category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id));
$category3 = coursecat::create(array('name' => 'Cat3'));
$category4 = coursecat::create(array('name' => 'Cat4', 'parent' => $category2->id));
$course1 = $this->getDataGenerator()->create_course(array('category' => $category2->id));
$course2 = $this->getDataGenerator()->create_course(array('category' => $category4->id));
$course3 = $this->getDataGenerator()->create_course(array('category' => $category4->id));
$course4 = $this->getDataGenerator()->create_course(array('category' => $category1->id));
// Now we have
// $category1
// $category2
// $category4
// $course2
// $course3
// $course1
// $course4
// $category3
// structure.
// Login as another user to test course:delete capability (user who created course can delete it within 24h even without cap).
$this->setUser($this->getDataGenerator()->create_user());
// Delete category 2 and move content to category 3.
$this->assertFalse($category2->can_move_content_to($category3->id)); // No luck!
// Add necessary capabilities.
$this->assign_capability('moodle/course:create', CAP_ALLOW, context_coursecat::instance($category3->id));
$this->assign_capability('moodle/category:manage');
$this->assertTrue($category2->can_move_content_to($category3->id)); // Hurray!
$category2->delete_move($category3->id);
// Make sure we have:
// $category1
// $course4
// $category3
// $category4
// $course2
// $course3
// $course1
// structure.
$this->assertNull(coursecat::get($category2->id, IGNORE_MISSING, true));
$this->assertEquals(array(), $category1->get_children());
$this->assertEquals(array($category4->id), array_keys($category3->get_children()));
$this->assertEquals($category4->id, $DB->get_field('course', 'category', array('id' => $course2->id)));
$this->assertEquals($category4->id, $DB->get_field('course', 'category', array('id' => $course3->id)));
$this->assertEquals($category3->id, $DB->get_field('course', 'category', array('id' => $course1->id)));
// Delete category 3 completely.
$this->assertFalse($category3->can_delete_full()); // No luck!
// Add necessary capabilities.
$this->assign_capability('moodle/course:delete', CAP_ALLOW, context_coursecat::instance($category3->id));
$this->assertTrue($category3->can_delete_full()); // Hurray!
$category3->delete_full();
// Make sure we have:
// $category1
// $course4
// structure.
// Note that we also have default 'Miscellaneous' category and default 'site' course.
$this->assertEquals(1, $DB->get_field_sql('SELECT count(*) FROM {course_categories} WHERE id > ?', array($initialcatid)));
$this->assertEquals($category1->id, $DB->get_field_sql('SELECT max(id) FROM {course_categories}'));
$this->assertEquals(1, $DB->get_field_sql('SELECT count(*) FROM {course} WHERE id <> ?', array(SITEID)));
$this->assertEquals(array('id' => $course4->id, 'category' => $category1->id),
(array)$DB->get_record_sql('SELECT id, category from {course} where id <> ?', array(SITEID)));
}
public function test_get_children() {
$category1 = coursecat::create(array('name' => 'Cat1'));
$category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id));
$category3 = coursecat::create(array('name' => 'Cat3', 'parent' => $category1->id, 'visible' => 0));
$category4 = coursecat::create(array('name' => 'Cat4', 'idnumber' => '12', 'parent' => $category1->id));
$category5 = coursecat::create(array('name' => 'Cat5', 'idnumber' => '11', 'parent' => $category1->id, 'visible' => 0));
$category6 = coursecat::create(array('name' => 'Cat6', 'idnumber' => '10', 'parent' => $category1->id));
$category7 = coursecat::create(array('name' => 'Cat0', 'parent' => $category1->id));
$children = $category1->get_children();
// User does not have the capability to view hidden categories, so the list should be
// 2, 4, 6, 7.
$this->assertEquals(array($category2->id, $category4->id, $category6->id, $category7->id), array_keys($children));
$this->assertEquals(4, $category1->get_children_count());
$children = $category1->get_children(array('offset' => 2));
$this->assertEquals(array($category6->id, $category7->id), array_keys($children));
$this->assertEquals(4, $category1->get_children_count());
$children = $category1->get_children(array('limit' => 2));
$this->assertEquals(array($category2->id, $category4->id), array_keys($children));
$children = $category1->get_children(array('offset' => 1, 'limit' => 2));
$this->assertEquals(array($category4->id, $category6->id), array_keys($children));
$children = $category1->get_children(array('sort' => array('name' => 1)));
// Must be 7, 2, 4, 6.
$this->assertEquals(array($category7->id, $category2->id, $category4->id, $category6->id), array_keys($children));
$children = $category1->get_children(array('sort' => array('idnumber' => 1, 'name' => -1)));
// Must be 2, 7, 6, 4.
$this->assertEquals(array($category2->id, $category7->id, $category6->id, $category4->id), array_keys($children));
// Check that everything is all right after purging the caches.
cache_helper::purge_by_event('changesincoursecat');
$children = $category1->get_children();
$this->assertEquals(array($category2->id, $category4->id, $category6->id, $category7->id), array_keys($children));
$this->assertEquals(4, $category1->get_children_count());
}
/**
* Test the countall function
*/
public function test_count_all() {
global $DB;
// Dont assume there is just one. An add-on might create a category as part of the install.
$numcategories = $DB->count_records('course_categories');
$this->assertEquals($numcategories, coursecat::count_all());
$category1 = coursecat::create(array('name' => 'Cat1'));
$category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id));
$category3 = coursecat::create(array('name' => 'Cat3', 'parent' => $category2->id, 'visible' => 0));
// Now we've got three more.
$this->assertEquals($numcategories + 3, coursecat::count_all());
cache_helper::purge_by_event('changesincoursecat');
// We should still have 4.
$this->assertEquals($numcategories + 3, coursecat::count_all());
}
/**
* Test a categories ability to resort courses.
*/
public function test_resort_courses() {
$this->resetAfterTest(true);
$generator = $this->getDataGenerator();
$category = $generator->create_category();
$course1 = $generator->create_course(array(
'category' => $category->id,
'idnumber' => '006-01',
'shortname' => 'Biome Study',
'fullname' => '<span lang="ar" class="multilang">'.'دراسة منطقة إحيائية'.'</span><span lang="en" class="multilang">Biome Study</span>',
'timecreated' => '1000000001'
));
$course2 = $generator->create_course(array(
'category' => $category->id,
'idnumber' => '007-02',
'shortname' => 'Chemistry Revision',
'fullname' => 'Chemistry Revision',
'timecreated' => '1000000002'
));
$course3 = $generator->create_course(array(
'category' => $category->id,
'idnumber' => '007-03',
'shortname' => 'Swiss Rolls and Sunflowers',
'fullname' => 'Aarkvarks guide to Swiss Rolls and Sunflowers',
'timecreated' => '1000000003'
));
$course4 = $generator->create_course(array(
'category' => $category->id,
'idnumber' => '006-04',
'shortname' => 'Scratch',
'fullname' => '<a href="test.php">Basic Scratch</a>',
'timecreated' => '1000000004'
));
$c1 = (int)$course1->id;
$c2 = (int)$course2->id;
$c3 = (int)$course3->id;
$c4 = (int)$course4->id;
$coursecat = coursecat::get($category->id);
$this->assertTrue($coursecat->resort_courses('idnumber'));
$this->assertSame(array($c1, $c4, $c2, $c3), array_keys($coursecat->get_courses()));
$this->assertTrue($coursecat->resort_courses('shortname'));
$this->assertSame(array($c1, $c2, $c4, $c3), array_keys($coursecat->get_courses()));
$this->assertTrue($coursecat->resort_courses('timecreated'));
$this->assertSame(array($c1, $c2, $c3, $c4), array_keys($coursecat->get_courses()));
try {
// Enable the multilang filter and set it to apply to headings and content.
filter_manager::reset_caches();
filter_set_global_state('multilang', TEXTFILTER_ON);
filter_set_applies_to_strings('multilang', true);
$expected = array($c3, $c4, $c1, $c2);
} catch (coding_exception $ex) {
$expected = array($c3, $c4, $c2, $c1);
}
$this->assertTrue($coursecat->resort_courses('fullname'));
$this->assertSame($expected, array_keys($coursecat->get_courses()));
}
public function test_get_search_courses() {
$cat1 = coursecat::create(array('name' => 'Cat1'));
$cat2 = coursecat::create(array('name' => 'Cat2', 'parent' => $cat1->id));
$c1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 3', 'summary' => ' ', 'idnumber' => 'ID3'));
$c2 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 1', 'summary' => ' ', 'visible' => 0));
$c3 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Математика', 'summary' => ' Test '));
$c4 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 4', 'summary' => ' ', 'idnumber' => 'ID4'));
$c5 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 5', 'summary' => ' '));
$c6 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Дискретная Математика', 'summary' => ' '));
$c7 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 7', 'summary' => ' ', 'visible' => 0));
$c8 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 8', 'summary' => ' '));
// Get courses in category 1 (returned visible only because user is not enrolled).
$res = $cat1->get_courses(array('sortorder' => 1));
$this->assertEquals(array($c4->id, $c3->id, $c1->id), array_keys($res)); // Courses are added in reverse order.
$this->assertEquals(3, $cat1->get_courses_count());
// Get courses in category 1 recursively (returned visible only because user is not enrolled).
$res = $cat1->get_courses(array('recursive' => 1));
$this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c6->id, $c5->id), array_keys($res));
$this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1)));
// Get courses sorted by fullname.
$res = $cat1->get_courses(array('sort' => array('fullname' => 1)));
$this->assertEquals(array($c1->id, $c4->id, $c3->id), array_keys($res));
$this->assertEquals(3, $cat1->get_courses_count(array('sort' => array('fullname' => 1))));
// Get courses sorted by fullname recursively.
$res = $cat1->get_courses(array('recursive' => 1, 'sort' => array('fullname' => 1)));
$this->assertEquals(array($c1->id, $c4->id, $c5->id, $c8->id, $c6->id, $c3->id), array_keys($res));
$this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1, 'sort' => array('fullname' => 1))));
// Get courses sorted by fullname recursively, use offset and limit.
$res = $cat1->get_courses(array('recursive' => 1, 'offset' => 1, 'limit' => 2, 'sort' => array('fullname' => -1)));
$this->assertEquals(array($c6->id, $c8->id), array_keys($res));
// Offset and limit do not affect get_courses_count().
$this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1, 'offset' => 1, 'limit' => 2, 'sort' => array('fullname' => 1))));
// Calling get_courses_count without prior call to get_courses().
$this->assertEquals(3, $cat2->get_courses_count(array('recursive' => 1, 'sort' => array('idnumber' => 1))));
// Search courses.
// Search by text.
$res = coursecat::search_courses(array('search' => 'Test'));
$this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c5->id), array_keys($res));
$this->assertEquals(5, coursecat::search_courses_count(array('search' => 'Test')));
// Search by text with specified offset and limit.
$options = array('sort' => array('fullname' => 1), 'offset' => 1, 'limit' => 2);
$res = coursecat::search_courses(array('search' => 'Test'), $options);
$this->assertEquals(array($c4->id, $c5->id), array_keys($res));
$this->assertEquals(5, coursecat::search_courses_count(array('search' => 'Test'), $options));
// IMPORTANT: the tests below may fail on some databases
// case-insensitive search.
$res = coursecat::search_courses(array('search' => 'test'));
$this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c5->id), array_keys($res));
$this->assertEquals(5, coursecat::search_courses_count(array('search' => 'test')));
// Non-latin language search.
$res = coursecat::search_courses(array('search' => 'Математика'));
$this->assertEquals(array($c3->id, $c6->id), array_keys($res));
$this->assertEquals(2, coursecat::search_courses_count(array('search' => 'Математика'), array()));
$this->setUser($this->getDataGenerator()->create_user());
// Add necessary capabilities.
$this->assign_capability('moodle/course:create', CAP_ALLOW, context_coursecat::instance($cat2->id));
// Do another search with restricted capabilities.
$reqcaps = array('moodle/course:create');
$res = coursecat::search_courses(array('search' => 'test'), array(), $reqcaps);
$this->assertEquals(array($c8->id, $c5->id), array_keys($res));
$this->assertEquals(2, coursecat::search_courses_count(array('search' => 'test'), array(), $reqcaps));
}
public function test_course_contacts() {
global $DB, $CFG;
$teacherrole = $DB->get_record('role', array('shortname'=>'editingteacher'));
$managerrole = $DB->get_record('role', array('shortname'=>'manager'));
$studentrole = $DB->get_record('role', array('shortname'=>'student'));
$oldcoursecontact = $CFG->coursecontact;
$CFG->coursecontact = $managerrole->id. ','. $teacherrole->id;
/*
* User is listed in course contacts for the course if he has one of the
* "course contact" roles ($CFG->coursecontact) AND is enrolled in the course.
* If the user has several roles only the highest is displayed.
*/
// Test case:
//
// == Cat1 (user2 has teacher role)
// == Cat2
// -- course21 (user2 is enrolled as manager) | [Expected] Manager: F2 L2
// -- course22 (user2 is enrolled as student) | [Expected] Teacher: F2 L2
// == Cat4 (user2 has manager role)
// -- course41 (user4 is enrolled as teacher, user5 is enrolled as manager) | [Expected] Manager: F5 L5, Teacher: F4 L4
// -- course42 (user2 is enrolled as teacher) | [Expected] Manager: F2 L2
// == Cat3 (user3 has manager role)
// -- course31 (user3 is enrolled as student) | [Expected] Manager: F3 L3
// -- course32 | [Expected]
// -- course11 (user1 is enrolled as teacher) | [Expected] Teacher: F1 L1
// -- course12 (user1 has teacher role) | [Expected]
// also user4 is enrolled as teacher but enrolment is not active
$category = $course = $enrol = $user = array();
$category[1] = coursecat::create(array('name' => 'Cat1'))->id;
$category[2] = coursecat::create(array('name' => 'Cat2', 'parent' => $category[1]))->id;
$category[3] = coursecat::create(array('name' => 'Cat3', 'parent' => $category[1]))->id;
$category[4] = coursecat::create(array('name' => 'Cat4', 'parent' => $category[2]))->id;
foreach (array(1, 2, 3, 4) as $catid) {
foreach (array(1, 2) as $courseid) {
$course[$catid][$courseid] = $this->getDataGenerator()->create_course(array('idnumber' => 'id'.$catid.$courseid,
'category' => $category[$catid]))->id;
$enrol[$catid][$courseid] = $DB->get_record('enrol', array('courseid'=>$course[$catid][$courseid], 'enrol'=>'manual'), '*', MUST_EXIST);
}
}
foreach (array(1, 2, 3, 4, 5) as $userid) {
$user[$userid] = $this->getDataGenerator()->create_user(array('firstname' => 'F'.$userid, 'lastname' => 'L'.$userid))->id;
}
$manual = enrol_get_plugin('manual');
// Nobody is enrolled now and course contacts are empty.
$allcourses = coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true, 'sort' => array('idnumber' => 1)));
foreach ($allcourses as $onecourse) {
$this->assertEmpty($onecourse->get_course_contacts());
}
// Cat1 (user2 has teacher role)
role_assign($teacherrole->id, $user[2], context_coursecat::instance($category[1]));
// course21 (user2 is enrolled as manager)
$manual->enrol_user($enrol[2][1], $user[2], $managerrole->id);
// course22 (user2 is enrolled as student)
$manual->enrol_user($enrol[2][2], $user[2], $studentrole->id);
// Cat4 (user2 has manager role)
role_assign($managerrole->id, $user[2], context_coursecat::instance($category[4]));
// course41 (user4 is enrolled as teacher, user5 is enrolled as manager)
$manual->enrol_user($enrol[4][1], $user[4], $teacherrole->id);
$manual->enrol_user($enrol[4][1], $user[5], $managerrole->id);
// course42 (user2 is enrolled as teacher)
$manual->enrol_user($enrol[4][2], $user[2], $teacherrole->id);
// Cat3 (user3 has manager role)
role_assign($managerrole->id, $user[3], context_coursecat::instance($category[3]));
// course31 (user3 is enrolled as student)
$manual->enrol_user($enrol[3][1], $user[3], $studentrole->id);
// course11 (user1 is enrolled as teacher)
$manual->enrol_user($enrol[1][1], $user[1], $teacherrole->id);
// -- course12 (user1 has teacher role)
// also user4 is enrolled as teacher but enrolment is not active
role_assign($teacherrole->id, $user[1], context_course::instance($course[1][2]));
$manual->enrol_user($enrol[1][2], $user[4], $teacherrole->id, 0, 0, ENROL_USER_SUSPENDED);
$allcourses = coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true, 'sort' => array('idnumber' => 1)));
// Simplify the list of contacts for each course (similar as renderer would do).
$contacts = array();
foreach (array(1, 2, 3, 4) as $catid) {
foreach (array(1, 2) as $courseid) {
$tmp = array();
foreach ($allcourses[$course[$catid][$courseid]]->get_course_contacts() as $contact) {
$tmp[] = $contact['rolename']. ': '. $contact['username'];
}
$contacts[$catid][$courseid] = join(', ', $tmp);
}
}
// Assert:
// -- course21 (user2 is enrolled as manager) | Manager: F2 L2
$this->assertSame('Manager: F2 L2', $contacts[2][1]);
// -- course22 (user2 is enrolled as student) | Teacher: F2 L2
$this->assertSame('Teacher: F2 L2', $contacts[2][2]);
// -- course41 (user4 is enrolled as teacher, user5 is enrolled as manager) | Manager: F5 L5, Teacher: F4 L4
$this->assertSame('Manager: F5 L5, Teacher: F4 L4', $contacts[4][1]);
// -- course42 (user2 is enrolled as teacher) | [Expected] Manager: F2 L2
$this->assertSame('Manager: F2 L2', $contacts[4][2]);
// -- course31 (user3 is enrolled as student) | Manager: F3 L3
$this->assertSame('Manager: F3 L3', $contacts[3][1]);
// -- course32 |
$this->assertSame('', $contacts[3][2]);
// -- course11 (user1 is enrolled as teacher) | Teacher: F1 L1
$this->assertSame('Teacher: F1 L1', $contacts[1][1]);
// -- course12 (user1 has teacher role) |
$this->assertSame('', $contacts[1][2]);
// Suspend user 4 and make sure he is no longer in contacts of course 1 in category 4.
$manual->enrol_user($enrol[4][1], $user[4], $teacherrole->id, 0, 0, ENROL_USER_SUSPENDED);
$allcourses = coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true, 'sort' => array('idnumber' => 1)));
$contacts = $allcourses[$course[4][1]]->get_course_contacts();
$this->assertCount(1, $contacts);
$contact = reset($contacts);
$this->assertEquals('F5 L5', $contact['username']);
$CFG->coursecontact = $oldcoursecontact;
}
public function test_overview_files() {
global $CFG;
$this->setAdminUser();
$cat1 = coursecat::create(array('name' => 'Cat1'));
// Create course c1 with one image file.
$dratid1 = $this->fill_draft_area(array('filename.jpg' => 'Test file contents1'));
$c1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id,
'fullname' => 'Test 1', 'overviewfiles_filemanager' => $dratid1));
// Create course c2 with two image files (only one file will be added because of settings).
$dratid2 = $this->fill_draft_area(array('filename21.jpg' => 'Test file contents21', 'filename22.jpg' => 'Test file contents22'));
$c2 = $this->getDataGenerator()->create_course(array('category' => $cat1->id,
'fullname' => 'Test 2', 'overviewfiles_filemanager' => $dratid2));
// Create course c3 without files.
$c3 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 3'));
// Change the settings to allow multiple files of any types.
$CFG->courseoverviewfileslimit = 3;
$CFG->courseoverviewfilesext = '*';
// Create course c5 with two image files.
$dratid4 = $this->fill_draft_area(array('filename41.jpg' => 'Test file contents41', 'filename42.jpg' => 'Test file contents42'));
$c4 = $this->getDataGenerator()->create_course(array('category' => $cat1->id,
'fullname' => 'Test 4', 'overviewfiles_filemanager' => $dratid4));
// Create course c6 with non-image file.
$dratid5 = $this->fill_draft_area(array('filename51.zip' => 'Test file contents51'));
$c5 = $this->getDataGenerator()->create_course(array('category' => $cat1->id,
'fullname' => 'Test 5', 'overviewfiles_filemanager' => $dratid5));
// Reset default settings.
$CFG->courseoverviewfileslimit = 1;
$CFG->courseoverviewfilesext = '.jpg,.gif,.png';
$courses = $cat1->get_courses();
$this->assertTrue($courses[$c1->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c2->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c3->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c4->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c5->id]->has_course_overviewfiles()); // Does not validate the filetypes.
$this->assertEquals(1, count($courses[$c1->id]->get_course_overviewfiles()));
$this->assertEquals(1, count($courses[$c2->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c3->id]->get_course_overviewfiles()));
$this->assertEquals(1, count($courses[$c4->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c5->id]->get_course_overviewfiles())); // Validate the filetypes.
// Overview files are not allowed, all functions return empty values.
$CFG->courseoverviewfileslimit = 0;
$this->assertFalse($courses[$c1->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c2->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c3->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c4->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c5->id]->has_course_overviewfiles());
$this->assertEquals(0, count($courses[$c1->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c2->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c3->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c4->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c5->id]->get_course_overviewfiles()));
// Multiple overview files are allowed but still limited to images.
$CFG->courseoverviewfileslimit = 3;
$this->assertTrue($courses[$c1->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c2->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c3->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c4->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c5->id]->has_course_overviewfiles()); // Still does not validate the filetypes.
$this->assertEquals(1, count($courses[$c1->id]->get_course_overviewfiles()));
$this->assertEquals(1, count($courses[$c2->id]->get_course_overviewfiles())); // Only 1 file was actually added.
$this->assertEquals(0, count($courses[$c3->id]->get_course_overviewfiles()));
$this->assertEquals(2, count($courses[$c4->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c5->id]->get_course_overviewfiles()));
// Multiple overview files of any type are allowed.
$CFG->courseoverviewfilesext = '*';
$this->assertTrue($courses[$c1->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c2->id]->has_course_overviewfiles());
$this->assertFalse($courses[$c3->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c4->id]->has_course_overviewfiles());
$this->assertTrue($courses[$c5->id]->has_course_overviewfiles());
$this->assertEquals(1, count($courses[$c1->id]->get_course_overviewfiles()));
$this->assertEquals(1, count($courses[$c2->id]->get_course_overviewfiles()));
$this->assertEquals(0, count($courses[$c3->id]->get_course_overviewfiles()));
$this->assertEquals(2, count($courses[$c4->id]->get_course_overviewfiles()));
$this->assertEquals(1, count($courses[$c5->id]->get_course_overviewfiles()));
}
/**
* Creates a draft area for current user and fills it with fake files
*
* @param array $files array of files that need to be added to filearea, filename => filecontents
* @return int draftid for the filearea
*/
protected function fill_draft_area(array $files) {
global $USER;
$usercontext = context_user::instance($USER->id);
$draftid = file_get_unused_draft_itemid();
foreach ($files as $filename => $filecontents) {
// Add actual file there.
$filerecord = array('component' => 'user', 'filearea' => 'draft',
'contextid' => $usercontext->id, 'itemid' => $draftid,
'filename' => $filename, 'filepath' => '/');
$fs = get_file_storage();
$fs->create_file_from_string($filerecord, $filecontents);
}
return $draftid;
}
}