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
/**
18
 * Interface to indicate that a question bank column can go in the action menu.
19
 *
20
 * @package   core_question
21
 * @copyright 2019 Tim Hunt
22
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace core_question\local\bank;
26
 
27
/**
28
 * Interface to indicate that a question bank column can go in the action menu.
29
 *
30
 * If a question bank column implements this interface, and if the {@see edit_menu_column}
31
 * is present in the question bank view, then the 'column' will be shown as an entry in the
32
 * edit menu instead of as a separate column.
33
 *
34
 * Probably most columns that want to implement this will be subclasses of
35
 * {@see action_column_base}, and most such columns should probably implement
36
 * this interface.
37
 *
38
 * If your column is a simple action, you can probably save duplicated code by
39
 * using the base class action_column_menuable as an easy way to implement both
40
 * action_column_base and this interface.
41
 *
42
 * @copyright 2019 Tim Hunt
43
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44
 * @deprecated Since Moodle 4.3 MDL-75125 - Use question_action_base instead.
45
 * @todo MDL-78090 This interface will be deleted in Moodle 4.7
46
 */
47
interface menuable_action {
48
 
49
    /**
50
     * Return the appropriate action menu link, or null if it does not apply to this question.
51
     *
52
     * @param \stdClass $question data about the question being displayed in this row.
53
     * @return \action_menu_link|null the action, if applicable to this question.
54
     * @deprecated Since Moodle 4.3
55
     */
56
    public function get_action_menu_link(\stdClass $question): ?\action_menu_link;
57
}