moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 18:36:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-32508 course/formats: Respect single page course display mode

Browse source 
Topics and weeks have been converted to use a shared renderer to output
their content.

Note, I started with good intentions but this renderer has mixed
paradgims due to fast and cheap winning out on the trinity.

AMOS BEGIN
   MOV [currenttopic,access],[currentsection,format_topics]
   MOV [currentweek,access],[currentsection,format_weeks]
AMOS END
This commit is contained in:
Dan Poltawski 2012-04-27 13:11:35 +08:00
parent 143d743743
commit 1804b7c1bc
11 changed files with 756 additions and 531 deletions
Download patch file Download diff file Expand all files Collapse all files

280
course/format/topics/format.php
View file

@ -1,28 +1,26 @@
<?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/>.
// Display the whole course as "topics" made of of modules
// Included from "view.php"
/**
* Evaluation topics format for course display - NO layout tables, for accessibility, etc.
* Topics course format. Display the whole course as "topics" made of modules.
*
* A duplicate course format to enable the Moodle development team to evaluate
* CSS for the multi-column layout in place of layout tables.
* Less risk for the Moodle 1.6 beta release.
* 1. Straight copy of topics/format.php
* 2. Replace <table> and <td> with DIVs; inline styles.
* 3. Reorder columns so that in linear view content is first then blocks;
* styles to maintain original graphical (side by side) view.
*
* Target: 3-column graphical view using relative widths for pixel screen sizes
* 800x600, 1024x768... on IE6, Firefox. Below 800 columns will shift downwards.
*
* http://www.maxdesign.com.au/presentation/em/ Ideal length for content.
* http://www.svendtofte.com/code/max_width_in_ie/ Max width in IE.
*
* @copyright &copy; 2006 The Open University
* @package format_topics
* @copyright 2006 The Open University
* @author N.D.Freear@open.ac.uk, and others.
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @package
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
@ -30,7 +28,7 @@ defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/filelib.php');
require_once($CFG->libdir.'/completionlib.php');
// Horrible backwards compatible parameter aliasing
// Horrible backwards compatible parameter aliasing..
if ($topic = optional_param('topic', 0, PARAM_INT)) {
$url = $PAGE->url;
$url->param('section', $topic);
@ -39,244 +37,20 @@ if ($topic = optional_param('topic', 0, PARAM_INT)) {
}
// End backwards-compatible aliasing..
$context = get_context_instance(CONTEXT_COURSE, $course->id);
$context = context_course::instance($course->id);
if (($marker >=0) && has_capability('moodle/course:setcurrentsection', $context) && confirm_sesskey()) {
$course->marker = $marker;
course_set_marker($course->id, $marker);
}
$streditsummary = get_string('editsummary');
$stradd = get_string('add');
$stractivities = get_string('activities');
$strtopic = get_string('topic');
$strgroups = get_string('groups');
$strgroupmy = get_string('groupmy');
$editing = $PAGE->user_is_editing();
$renderer = $PAGE->get_renderer('format_topics');
if ($editing) {
$strtopichide = get_string('hidefromothers', 'format_topics');
$strtopicshow = get_string('showfromothers', 'format_topics');
$strmarkthistopic = get_string('markthistopic');
$strmarkedthistopic = get_string('markedthistopic');
$strmoveup = get_string('moveup');
$strmovedown = get_string('movedown');
if (!empty($displaysection) && $course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
$renderer->print_single_section_page($course, $sections, $mods, $modnames, $modnamesused, $displaysection);
} else {
$renderer->print_multiple_section_page($course, $sections, $mods, $modnames, $modnamesused);
}
// Print the Your progress icon if the track completion is enabled
$completioninfo = new completion_info($course);
echo $completioninfo->display_help_icon();
echo $OUTPUT->heading(get_string('topicoutline'), 2, 'headingblock header outline');
// Note, an ordered list would confuse - "1" could be the clipboard or summary.
echo "<ul class='topics'>\n";
/// If currently moving a file then show the current clipboard
if (ismoving($course->id)) {
$stractivityclipboard = strip_tags(get_string('activityclipboard', '', $USER->activitycopyname));
$strcancel= get_string('cancel');
echo '<li class="clipboard">';
echo $stractivityclipboard.'&nbsp;&nbsp;(<a href="mod.php?cancelcopy=true&amp;sesskey='.sesskey().'">'.$strcancel.'</a>)';
echo "</li>\n";
}
/// Print Section 0 with general activities
$section = 0;
$thissection = $sections[$section];
unset($sections[0]);
if ($thissection->summary or $thissection->sequence or $PAGE->user_is_editing()) {
// Note, no need for a 'left side' cell or DIV.
// Note, 'right side' is BEFORE content.
echo '<li id="section-0" class="section main clearfix" >';
echo '<div class="left side">&nbsp;</div>';
echo '<div class="right side" >&nbsp;</div>';
echo '<div class="content">';
if (!is_null($thissection->name)) {
echo $OUTPUT->heading(format_string($thissection->name, true, array('context' => $context)), 3, 'sectionname');
}
echo '<div class="summary">';
$coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
$summarytext = file_rewrite_pluginfile_urls($thissection->summary, 'pluginfile.php', $coursecontext->id, 'course', 'section', $thissection->id);
$summaryformatoptions = new stdClass();
$summaryformatoptions->noclean = true;
$summaryformatoptions->overflowdiv = true;
echo format_text($summarytext, $thissection->summaryformat, $summaryformatoptions);
if ($PAGE->user_is_editing() && has_capability('moodle/course:update', $coursecontext)) {
echo '<a title="'.$streditsummary.'" '.
' href="editsection.php?id='.$thissection->id.'"><img src="'.$OUTPUT->pix_url('t/edit') . '" '.
' class="iconsmall edit" alt="'.$streditsummary.'" /></a>';
}
echo '</div>';
print_section($course, $thissection, $mods, $modnamesused);
if ($PAGE->user_is_editing()) {
print_section_add_menus($course, $section, $modnames);
}
echo '</div>';
echo "</li>\n";
}
/// Now all the normal modules by topic
/// Everything below uses "section" terminology - each "section" is a topic.
$section = 1;
$sectionmenu = array();
while ($section <= $course->numsections) {
if (!empty($sections[$section])) {
$thissection = $sections[$section];
} else {
$thissection = new stdClass;
$thissection->course = $course->id; // Create a new section structure
$thissection->section = $section;
$thissection->name = null;
$thissection->summary = '';
$thissection->summaryformat = FORMAT_HTML;
$thissection->visible = 1;
$thissection->id = $DB->insert_record('course_sections', $thissection);
}
$showsection = (has_capability('moodle/course:viewhiddensections', $context) or $thissection->visible or !$course->hiddensections);
if (!empty($displaysection) and $displaysection != $section) { // Check this topic is visible
if ($showsection) {
$sectionmenu[$section] = get_section_name($course, $thissection);
}
$section++;
continue;
}
if ($showsection) {
$currenttopic = ($course->marker == $section);
$currenttext = '';
if (!$thissection->visible) {
$sectionstyle = ' hidden';
} else if ($currenttopic) {
$sectionstyle = ' current';
$currenttext = get_accesshide(get_string('currenttopic','access'));
} else {
$sectionstyle = '';
}
echo '<li id="section-'.$section.'" class="section main clearfix'.$sectionstyle.'" >'; //'<div class="left side">&nbsp;</div>';
echo '<div class="left side">'.$currenttext.$section.'</div>';
// Note, 'right side' is BEFORE content.
echo '<div class="right side">';
if ($PAGE->user_is_editing() && has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
if ($course->marker == $section) { // Show the "light globe" on/off
echo '<a href="view.php?id='.$course->id.'&amp;marker=0&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strmarkedthistopic.'" class="editing_highlight">'.'<img src="'.$OUTPUT->pix_url('i/marked') . '" alt="'.$strmarkedthistopic.'" class="icon"/></a><br />';
} else {
echo '<a href="view.php?id='.$course->id.'&amp;marker='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strmarkthistopic.'" class="editing_highlight">'.'<img src="'.$OUTPUT->pix_url('i/marker') . '" alt="'.$strmarkthistopic.'" class="icon"/></a><br />';
}
if ($thissection->visible) { // Show the hide/show eye
echo '<a href="view.php?id='.$course->id.'&amp;hide='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strtopichide.'" class="editing_showhide">'.
'<img src="'.$OUTPUT->pix_url('i/hide') . '" class="icon hide" alt="'.$strtopichide.'" /></a><br />';
} else {
echo '<a href="view.php?id='.$course->id.'&amp;show='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strtopicshow.'" class="editing_showhide">'.
'<img src="'.$OUTPUT->pix_url('i/show') . '" class="icon hide" alt="'.$strtopicshow.'" /></a><br />';
}
if ($section > 1) { // Add a arrow to move section up
echo '<a href="view.php?id='.$course->id.'&amp;random='.rand(1,10000).'&amp;section='.$section.'&amp;move=-1&amp;sesskey='.sesskey().'#section-'.($section-1).'" title="'.$strmoveup.'" class="moveup">'.
'<img src="'.$OUTPUT->pix_url('t/up') . '" class="icon up" alt="'.$strmoveup.'" /></a><br />';
}
if ($section < $course->numsections) { // Add a arrow to move section down
echo '<a href="view.php?id='.$course->id.'&amp;random='.rand(1,10000).'&amp;section='.$section.'&amp;move=1&amp;sesskey='.sesskey().'#section-'.($section+1).'" title="'.$strmovedown.'" class="movedown">'.
'<img src="'.$OUTPUT->pix_url('t/down') . '" class="icon down" alt="'.$strmovedown.'" /></a><br />';
}
}
echo '</div>';
echo '<div class="content">';
if (!has_capability('moodle/course:viewhiddensections', $context) and !$thissection->visible) { // Hidden for students
echo get_string('notavailable');
} else {
if (!is_null($thissection->name)) {
echo $OUTPUT->heading(format_string($thissection->name, true, array('context' => $context)), 3, 'sectionname');
}
echo '<div class="summary">';
if ($thissection->summary) {
$coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
$summarytext = file_rewrite_pluginfile_urls($thissection->summary, 'pluginfile.php', $coursecontext->id, 'course', 'section', $thissection->id);
$summaryformatoptions = new stdClass();
$summaryformatoptions->noclean = true;
$summaryformatoptions->overflowdiv = true;
echo format_text($summarytext, $thissection->summaryformat, $summaryformatoptions);
} else {
echo '&nbsp;';
}
if ($PAGE->user_is_editing() && has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
echo ' <a title="'.$streditsummary.'" href="editsection.php?id='.$thissection->id.'">'.
'<img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall edit" alt="'.$streditsummary.'" /></a><br /><br />';
}
echo '</div>';
print_section($course, $thissection, $mods, $modnamesused);
echo '<br />';
if ($PAGE->user_is_editing()) {
print_section_add_menus($course, $section, $modnames);
}
}
echo '</div>';
echo "</li>\n";
}
unset($sections[$section]);
$section++;
}
if (!$displaysection and $PAGE->user_is_editing() and has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
// print stealth sections if present
$modinfo = get_fast_modinfo($course);
foreach ($sections as $section=>$thissection) {
if (empty($modinfo->sections[$section])) {
continue;
}
echo '<li id="section-'.$section.'" class="section main clearfix orphaned hidden">'; //'<div class="left side">&nbsp;</div>';
echo '<div class="left side">';
echo '</div>';
// Note, 'right side' is BEFORE content.
echo '<div class="right side">';
echo '</div>';
echo '<div class="content">';
echo $OUTPUT->heading(get_string('orphanedactivities'), 3, 'sectionname');
print_section($course, $thissection, $mods, $modnamesused);
echo '</div>';
echo "</li>\n";
}
}
echo "</ul>\n";
if (!empty($sectionmenu)) {
$select = new single_select(new moodle_url('/course/view.php', array('id'=>$course->id)), 'topic', $sectionmenu);
$select->label = get_string('jumpto');
$select->class = 'jumpmenu';
$select->formid = 'sectionmenu';
echo $OUTPUT->render($select);
}
// Include course format js module
$PAGE->requires->js('/course/format/topics/format.js');
// Include course format js module
$PAGE->requires->js('/course/format/topics/format.js');

1
course/format/topics/lang/en/format_topics.php
View file

@ -23,6 +23,7 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
$string['currentsection'] = 'This topic';
$string['sectionname'] = 'Topic';
$string['pluginname'] = 'Topics format';
$string['section0name'] = 'General';

105
course/format/topics/renderer.php Normal file
View file

@ -0,0 +1,105 @@
<?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/>.
/**
* Renderer for outputting the topics course format.
*
* @package format_topics
* @copyright 2012 Dan Poltawski
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.3
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot.'/course/format/renderer.php');
/**
* Basic renderer for topics format.
*
* @copyright 2012 Dan Poltawski
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class format_topics_renderer extends format_renderer_base {
/**
* Generate the starting container html for a list of sections
* @return string HTML to output.
*/
public function start_section_list() {
return html_writer::start_tag('ul', array('class' => 'topics'));
}
/**
* Generate the closing container html for a list of sections
* @return string HTML to output.
*/
public function end_section_list() {
return html_writer::end_tag('ul');
}
/**
* Generate the title for this section page
* @return string the page title
*/
public function page_title() {
return get_string('topicoutline');
}
/**
* Generate the edit controls of a section
*
* @param stdClass $course The course entry from DB
* @param stdClass $section The course_section entry from DB
* @param bool $onsectionpage true if being printed on a section page
* @return array of links with edit controls
*/
public function section_edit_controls($course, $section, $onsectionpage = false) {
global $PAGE;
if (!$PAGE->user_is_editing()) {
return array();
}
if (!has_capability('moodle/course:update', context_course::instance($course->id))) {
return array();
}
if ($onsectionpage) {
$url = course_get_url($course, $section->section);
} else {
$url = course_get_url($course);
}
$url->param('sesskey', sesskey());
$controls = array();
if ($course->marker == $section->section) { // Show the "light globe" on/off.
$url->param('marker', 0);
$controls[] = html_writer::link($url,
html_writer::empty_tag('img', array('src' => $this->output->pix_url('i/marked'),
'class' => 'icon ', 'alt' => get_string('markedthistopic'))),
array('title' => get_string('markedthistopic'), 'class' => 'editing_highlight'));
} else {
$url->param('marker', $section->section);
$controls[] = html_writer::link($url,
html_writer::empty_tag('img', array('src' => $this->output->pix_url('i/marker'),
'class' => 'icon', 'alt' => get_string('markthistopic'))),
array('title' => get_string('markthistopic'), 'class' => 'editing_highlight'));
}
return array_merge($controls, parent::section_edit_controls($course, $section, $onsectionpage));
}
}

6
course/format/topics/version.php
View file

@ -25,6 +25,6 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2011120100; // The current plugin version (Date: YYYYMMDDXX)
$plugin->requires = 2011120100; // Requires this Moodle version
$plugin->component = 'format_topics'; // Full name of the plugin (used for diagnostics)
$plugin->version = 2012042900; // The current plugin version (Date: YYYYMMDDXX).
$plugin->requires = 2012042800.03; // Requires this Moodle version.
$plugin->component = 'format_topics'; // Full name of the plugin (used for diagnostics).