mirror of
https://github.com/moodle/moodle.git
synced 2025-03-09 18:30:03 +01:00
71 lines
2.7 KiB
PHP
71 lines
2.7 KiB
PHP
|
<?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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Base class to make it easier to implement actions that are menuable_actions.
|
||
|
|
*
|
||
|
|
* @package core_question
|
||
|
|
* @copyright 2019 Tim Hunt
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace core_question\bank;
|
||
|
|
defined('MOODLE_INTERNAL') || die();
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Base class to make it easier to implement actions that are menuable_actions.
|
||
|
|
*
|
||
|
|
* Use this class if your action is simple (defined by just a URL, label and icon).
|
||
|
|
* If your action is not simple enough to fit into the pattern that this
|
||
|
|
* class implements, then you will have to implement the menuable_action
|
||
|
|
* interface yourself.
|
||
|
|
*
|
||
|
|
* @copyright 2019 Tim Hunt
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
abstract class menu_action_column_base extends action_column_base implements menuable_action {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the information required to display this action either as a menu item or a separate action column.
|
||
|
|
*
|
||
|
|
* If this action cannot apply to this question (e.g. because the user does not have
|
||
|
|
* permission, then return [null, null, null].
|
||
|
|
*
|
||
|
|
* @param \stdClass $question the row from the $question table, augmented with extra information.
|
||
|
|
* @return array with three elements.
|
||
|
|
* $url - the URL to perform the action.
|
||
|
|
* $icon - the icon for this action. E.g. 't/delete'.
|
||
|
|
* $label - text label to display in the UI (either in the menu, or as a tool-tip on the icon)
|
||
|
|
*/
|
||
|
|
abstract protected function get_url_icon_and_label(\stdClass $question): array;
|
||
|
|
|
||
|
|
protected function display_content($question, $rowclasses) {
|
||
|
|
[$url, $icon, $label] = $this->get_url_icon_and_label($question);
|
||
|
|
if ($url) {
|
||
|
|
$this->print_icon($icon, $label, $url);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function get_action_menu_link(\stdClass $question): ?\action_menu_link {
|
||
|
|
[$url, $icon, $label] = $this->get_url_icon_and_label($question);
|
||
|
|
if (!$url) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
return new \action_menu_link_secondary($url, new \pix_icon($icon, ''), $label);
|
||
|
|
}
|
||
|
|
}
|