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
namespace core_question\local\bank;
18
 
19
/**
20
 * Base class to implement actions that can be performed on any column.
21
 *
22
 * A plugin should define subclasses of this for each action it provides, and return an instance of each from
23
 * plugin_feature::get_column_actions(). The action returned from {@see get_action_menu_link()} will be displayed in each column
24
 * header.
25
 *
26
 * @package   core_question
27
 * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
28
 * @author    Mark Johnson <mark.johnson@catalyst-eu.net>
29
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30
 */
31
abstract class column_action_base extends view_component {
32
    /**
33
     * A chance for subclasses to initialise themselves, for example to load lang strings,
34
     * without having to override the constructor.
35
     */
36
    protected function init(): void {
37
    }
38
 
39
    /**
40
     * Return the action menu link for this action on the supplied column.
41
     *
42
     * @param column_base $column The column we are providing the action for.
43
     * @return ?\action_menu_link The action to display in the column header.
44
     */
45
    abstract public function get_action_menu_link(column_base $column): ?\action_menu_link;
46
}