79 lines
2.3 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/>.
/**
* This file contains general functions for the course format Topic
*
* @since 2.0
* @package moodlecore
* @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Indicates this format uses sections.
*
* @return bool Returns true
*/
function callback_topics_uses_sections() {
return true;
}
/**
* Used to display the course structure for a course where format=topic
*
* This is called automatically by {@link load_course()} if the current course
* format = weeks.
*
* @param array $path An array of keys to the course node in the navigation
* @param stdClass $modinfo The mod info object for the current course
* @return bool Returns true
*/
function callback_topics_load_content(&$navigation, $course, $coursenode) {
return $navigation->load_generic_course_sections($course, $coursenode, 'topics');
}
/**
* The string that is used to describe a section of the course
* e.g. Topic, Week...
*
* @return string
*/
function callback_topics_definition() {
return get_string('topic');
}
/**
* The GET argument variable that is used to identify the section being
* viewed by the user (if there is one)
*
* @return string
*/
function callback_topics_request_key() {
return 'topic';
}
function callback_topics_get_section_name($course, $section) {
// We can't add a node without any text
if (!empty($section->name)) {
return $section->name;
} else if ($section->section == 0) {
return get_string('section0name', 'format_topics');
} else {
return get_string('topic').' '.$section->section;
}
}