mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 17:06:53 +02:00
c59d3d7496
We can use the Moodle language format for tour's name and description now. Also, several existing bugs were fixed in this commit when we use the Moodle language format for step's title and content. Now, it will display the translated text in the breadcrumb, editing page instead of displaying the [identifier][component]
115 lines
3.6 KiB
PHP
115 lines
3.6 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/>.
|
|
|
|
/**
|
|
* Tour.
|
|
*
|
|
* @package tool_usertours
|
|
* @copyright 2016 Andrew Nicols <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
use core\output\inplace_editable;
|
|
use tool_usertours\helper;
|
|
|
|
/**
|
|
* Manage inplace editable saves.
|
|
*
|
|
* @param string $itemtype The type of item.
|
|
* @param int $itemid The ID of the item.
|
|
* @param mixed $newvalue The new value
|
|
* @return inplace_editable
|
|
*/
|
|
function tool_usertours_inplace_editable($itemtype, $itemid, $newvalue) {
|
|
$context = \context_system::instance();
|
|
external_api::validate_context($context);
|
|
require_capability('tool/usertours:managetours', $context);
|
|
|
|
if ($itemtype === 'tourname') {
|
|
$tour = helper::get_tour($itemid);
|
|
$tour->set_name($newvalue)->persist();
|
|
|
|
return helper::render_tourname_inplace_editable($tour);
|
|
} else if ($itemtype === 'tourdescription') {
|
|
$tour = helper::get_tour($itemid);
|
|
$tour->set_description($newvalue)->persist();
|
|
|
|
return helper::render_tourdescription_inplace_editable($tour);
|
|
} else if ($itemtype === 'tourenabled') {
|
|
$tour = helper::get_tour($itemid);
|
|
$tour->set_enabled(!!$newvalue)->persist();
|
|
return helper::render_tourenabled_inplace_editable($tour);
|
|
} else if ($itemtype === 'stepname') {
|
|
$step = helper::get_step($itemid);
|
|
$step->set_title($newvalue)->persist();
|
|
|
|
return helper::render_stepname_inplace_editable($step);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Extend the user navigation to bootstrap tours.
|
|
*/
|
|
function tool_usertours_extend_navigation_user() {
|
|
\tool_usertours\helper::bootstrap();
|
|
}
|
|
|
|
/**
|
|
* Add JS to bootstrap tours. Only in Moodle 3.3+
|
|
*/
|
|
function tool_usertours_before_footer() {
|
|
\tool_usertours\helper::bootstrap();
|
|
}
|
|
|
|
/**
|
|
* Map icons for font-awesome themes.
|
|
*/
|
|
function tool_usertours_get_fontawesome_icon_map() {
|
|
return [
|
|
'tool_usertours:t/export' => 'fa-download',
|
|
'tool_usertours:i/reload' => 'fa-refresh',
|
|
'tool_usertours:t/filler' => 'fa-spacer',
|
|
];
|
|
}
|
|
|
|
|
|
/**
|
|
* Serves any files associated with the user tour content.
|
|
*
|
|
* @param stdClass $course Course object
|
|
* @param stdClass $cm Course module object
|
|
* @param context $context Context
|
|
* @param string $filearea File area for data privacy
|
|
* @param array $args Arguments
|
|
* @param bool $forcedownload If we are forcing the download
|
|
* @param array $options More options
|
|
* @return bool Returns false if we don't find a file.
|
|
*/
|
|
function tool_usertours_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = []): bool {
|
|
if ($context->contextlevel != CONTEXT_SYSTEM) {
|
|
return false;
|
|
}
|
|
|
|
$fs = get_file_storage();
|
|
$file = $fs->get_file($context->id, 'tool_usertours', $filearea, $args[0], '/', $args[1]);
|
|
if (!$file) {
|
|
return false; // No such file.
|
|
}
|
|
send_stored_file($file, null, 0, $forcedownload, $options);
|
|
return true;
|
|
}
|