Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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
declare(strict_types=1);
18
 
19
namespace mod_url\completion;
20
 
21
use core_completion\activity_custom_completion;
22
 
23
/**
24
 * Activity custom completion subclass for the url resource.
25
 *
26
 * Class for defining mod_url's custom completion rules and fetching the completion statuses
27
 * of the custom completion rules for a given url instance and a user.
28
 *
29
 * @package    mod_url
30
 * @copyright  2021 Huong Nguyen <huongn@moodle.com>
31
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32
 */
33
class custom_completion extends activity_custom_completion {
34
 
35
    /**
36
     * Fetches the completion state for a given completion rule.
37
     *
38
     * @param string $rule The completion rule.
39
     * @return int The completion state.
40
     */
41
    public function get_state(string $rule): int {
42
        return COMPLETION_UNKNOWN;
43
    }
44
 
45
    /**
46
     * Fetch the list of custom completion rules that this module defines.
47
     *
48
     * @return array
49
     */
50
    public static function get_defined_custom_rules(): array {
51
        // This activity/resource do not have any custom rules.
52
        return [];
53
    }
54
 
55
    /**
56
     * Returns an associative array of the descriptions of custom completion rules.
57
     *
58
     * @return array
59
     */
60
    public function get_custom_rule_descriptions(): array {
61
        // This activity/resource do not have any custom rule descriptions.
62
        return [];
63
    }
64
 
65
    /**
66
     * Show the manual completion or not regardless of the course's showcompletionconditions setting.
67
     *
68
     * @return bool
69
     */
70
    public function manual_completion_always_shown(): bool {
71
        global $CFG;
72
        require_once($CFG->libdir.'/resourcelib.php');
73
 
74
        $display = $this->cm->customdata['display'] ?? null;
75
 
76
        $displaytypes = [
77
                RESOURCELIB_DISPLAY_NEW,
78
                RESOURCELIB_DISPLAY_OPEN,
79
                RESOURCELIB_DISPLAY_POPUP
80
        ];
81
 
82
        return in_array($display, $displaytypes);
83
    }
84
 
85
    /**
86
     * Returns an array of all completion rules, in the order they should be displayed to users.
87
     *
88
     * @return array
89
     */
90
    public function get_sort_order(): array {
91
        // This module only supports manual completion.
92
        return [];
93
    }
94
}