| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace tool_usertours\local\filter;
|
|
|
18 |
|
|
|
19 |
use tool_usertours\tour;
|
|
|
20 |
use context;
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Course format filter.
|
|
|
24 |
*
|
|
|
25 |
* @package tool_usertours
|
|
|
26 |
* @copyright 2017 The Open University
|
|
|
27 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
28 |
*/
|
|
|
29 |
class courseformat extends base {
|
|
|
30 |
/**
|
|
|
31 |
* The name of the filter.
|
|
|
32 |
*
|
|
|
33 |
* @return string
|
|
|
34 |
*/
|
|
|
35 |
public static function get_filter_name() {
|
|
|
36 |
return 'courseformat';
|
|
|
37 |
}
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Retrieve the list of available filter options.
|
|
|
41 |
*
|
|
|
42 |
* @return array An array whose keys are the valid options
|
|
|
43 |
* And whose values are the values to display
|
|
|
44 |
*/
|
|
|
45 |
public static function get_filter_options() {
|
|
|
46 |
$options = [];
|
|
|
47 |
$courseformats = get_sorted_course_formats(true);
|
|
|
48 |
foreach ($courseformats as $courseformat) {
|
|
|
49 |
$options[$courseformat] = get_string('pluginname', "format_$courseformat");
|
|
|
50 |
}
|
|
|
51 |
return $options;
|
|
|
52 |
}
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Check whether the filter matches the specified tour and/or context.
|
|
|
56 |
*
|
|
|
57 |
* @param tour $tour The tour to check
|
|
|
58 |
* @param context $context The context to check
|
|
|
59 |
* @return boolean
|
|
|
60 |
*/
|
|
|
61 |
public static function filter_matches(tour $tour, context $context) {
|
|
|
62 |
global $COURSE;
|
|
|
63 |
$values = $tour->get_filter_values('courseformat');
|
|
|
64 |
if (empty($values)) {
|
|
|
65 |
// There are no values configured, meaning all.
|
|
|
66 |
return true;
|
|
|
67 |
}
|
|
|
68 |
if (empty($COURSE->format)) {
|
|
|
69 |
return false;
|
|
|
70 |
}
|
|
|
71 |
return in_array($COURSE->format, $values);
|
|
|
72 |
}
|
|
|
73 |
}
|