From f431561b688e97f8f1eb49edf8c82151e62a1795 Mon Sep 17 00:00:00 2001 From: Sam Hemelryk Date: Thu, 9 Dec 2010 16:13:05 +0800 Subject: [PATCH] Initial commit of course format output refactoring. This commit introduces the generic format renderer (core_course_generic_format_renderer) which contains primarily conversion of print_ functions from course/lib.php as well as the functions generated from the absraction of display routines common in both the weeks and topics formats. It also implements the conversion of weeks and topics formats to their own rendeers which extend the generic renderer. --- blocks/site_main_menu/block_site_main_menu.php | 5 +- .../social_activities/block_social_activities.php | 5 +- course/format/topics/format.php | 189 +---- course/format/topics/renderer.php | 133 ++++ course/format/weeks/format.php | 189 ++---- course/format/weeks/renderer.php | 120 +++ course/lib.php | 635 ++-------------- course/renderer.php | 818 +++++++++++++++++++- index.php | 5 +- lib/outputlib.php | 2 +- 10 files changed, 1215 insertions(+), 886 deletions(-) create mode 100644 course/format/topics/renderer.php create mode 100644 course/format/weeks/renderer.php diff --git a/blocks/site_main_menu/block_site_main_menu.php b/blocks/site_main_menu/block_site_main_menu.php index 3e139ac..1211730 100644 --- a/blocks/site_main_menu/block_site_main_menu.php +++ b/blocks/site_main_menu/block_site_main_menu.php @@ -64,6 +64,7 @@ class block_site_main_menu extends block_list { /// slow & hacky editing mode $ismoving = ismoving($course->id); $section = get_course_section(0, $course->id); + $renderer = $this->page->get_renderer('core_course', 'generic_format'); get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused); @@ -101,7 +102,7 @@ class block_site_main_menu extends block_list { } else { $mod->groupmode = false; } - $editbuttons = '
'.make_editing_buttons($mod, true, true).'
'; + $editbuttons = '
'.$renderer->section_module_controls($mod, true).'
'; } else { $editbuttons = ''; } @@ -148,7 +149,7 @@ class block_site_main_menu extends block_list { } if (!empty($modnames)) { - $this->content->footer = print_section_add_menus($course, 0, $modnames, true, true); + $this->content->footer = $renderer->section_add_menus($course, 0, $modnames, array('vertical'=>true)); } else { $this->content->footer = ''; } diff --git a/blocks/social_activities/block_social_activities.php b/blocks/social_activities/block_social_activities.php index bcf7d7b..fd8bbca 100644 --- a/blocks/social_activities/block_social_activities.php +++ b/blocks/social_activities/block_social_activities.php @@ -67,6 +67,7 @@ class block_social_activities extends block_list { /// slow & hacky editing mode $ismoving = ismoving($course->id); $sections = get_all_sections($course->id); + $renderer = $this->page->get_renderer('core_course', 'generic_format'); if(!empty($sections) && isset($sections[0])) { $section = $sections[0]; @@ -110,7 +111,7 @@ class block_social_activities extends block_list { } else { $mod->groupmode = false; } - $editbuttons = '
'.make_editing_buttons($mod, true, true); + $editbuttons = '
'.$renderer->section_module_controls($mod, true); } else { $editbuttons = ''; } @@ -157,7 +158,7 @@ class block_social_activities extends block_list { } if ($modnames) { - $this->content->footer = print_section_add_menus($course, 0, $modnames, true, true); + $this->content->footer = $renderer->section_add_menus($course, 0, $modnames, array('vertical'=>true)); } else { $this->content->footer = ''; } diff --git a/course/format/topics/format.php b/course/format/topics/format.php index 12611df..b022d67 100644 --- a/course/format/topics/format.php +++ b/course/format/topics/format.php @@ -49,23 +49,8 @@ if (($marker >=0) && has_capability('moodle/course:setcurrentsection', $context) $DB->set_field("course", "marker", $marker, array("id"=>$course->id)); } -$streditsummary = get_string('editsummary'); -$stradd = get_string('add'); -$stractivities = get_string('activities'); -$strshowalltopics = get_string('showalltopics'); -$strtopic = get_string('topic'); -$strgroups = get_string('groups'); -$strgroupmy = get_string('groupmy'); -$editing = $PAGE->user_is_editing(); - -if ($editing) { - $strtopichide = get_string('hidetopicfromothers'); - $strtopicshow = get_string('showtopicfromothers'); - $strmarkthistopic = get_string('markthistopic'); - $strmarkedthistopic = get_string('markedthistopic'); - $strmoveup = get_string('moveup'); - $strmovedown = get_string('movedown'); -} +$isediting = $PAGE->user_is_editing(); +$renderer = $PAGE->get_renderer('format_topics'); // Print the Your progress icon if the track completion is enabled $completioninfo = new completion_info($course); @@ -74,15 +59,16 @@ $completioninfo->print_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 "\n"; +echo html_writer::end_tag('ul'); // .topics 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); + echo $renderer->section_jumpto_menu($course->id, $sectionmenu, 'topics'); } diff --git a/course/format/topics/renderer.php b/course/format/topics/renderer.php new file mode 100644 index 0000000..600f4db --- /dev/null +++ b/course/format/topics/renderer.php @@ -0,0 +1,133 @@ +. + +/** + * This is the renderer for the topics course format. + * + * It extends and builds upon the generic format renderer. + * + * @package moodlecore + * @copyright 2010 Sam Hemelryk + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +/** + * Make sure we have included the generic format renderer. + */ +require_once($CFG->dirroot.'/course/renderer.php'); + +/** + * The renderer for the topics course format + */ +class format_topics_renderer extends core_course_generic_format_renderer { + + /** + * Generates the controls for editing a section. + * + * @param stdClass $course The current course + * @param stdClass $section The current section + * @param int $sectionnum The literal number of the section, the first section being 0 + * @return string + */ + public function section_editing_controls($course, $section, $sectionnum) { + + $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey())); + $baseurl->set_anchor('section-'.$sectionnum); + + $strtopichide = get_string('hidetopicfromothers'); + $strtopicshow = get_string('showtopicfromothers'); + $strmarkthistopic = get_string('markthistopic'); + $strmarkedthistopic = get_string('markedthistopic'); + $strmoveup = get_string('moveup'); + $strmovedown = get_string('movedown'); + + $output = ''; + + // Show the "light globe" on/off + if ($course->marker == $sectionnum) { + $url = new moodle_url($baseurl, array('marker'=>0)); + $icon = new pix_icon('i/marked', $strmarkedthistopic, 'moodle', array('class'=>'icon')); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon), array('class'=>'sectioncommand')); + } else { + $url = new moodle_url($baseurl, array('marker'=>$sectionnum)); + $icon = new pix_icon('i/marker', $strmarkthistopic, 'moodle', array('class'=>'icon')); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon), array('class'=>'sectioncommand')); + } + + // Show the hide/show eye + if ($section->visible) { + $url = new moodle_url($baseurl, array('hide'=>$sectionnum)); + $icon = new pix_icon('i/hide', $strtopichide, 'moodle', array('class'=>'icon hide')); + $attributes = array('title'=>$strtopichide); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } else { + $url = new moodle_url($baseurl, array('show'=>$sectionnum)); + $icon = new pix_icon('i/show', $strtopicshow, 'moodle', array('class'=>'icon show')); + $attributes = array('title'=>$strtopicshow); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + // Add a arrow to move section up + if ($sectionnum > 1) { + $url = new moodle_url($baseurl, array('section'=>$sectionnum, 'move'=>'-1', 'random'=>rand(1,10000))); + $url->set_anchor('section-'.($sectionnum-1)); + $icon = new pix_icon('t/up', $strmoveup, 'moodle', array('class'=>'icon up')); + $attributes = array('title'=>$strmoveup); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + // Add a arrow to move section down + if ($sectionnum < $course->numsections) { + $url = new moodle_url($baseurl, array('section'=>$sectionnum, 'move'=>'1', 'random'=>rand(1,10000))); + $url->set_anchor('section-'.($sectionnum+1)); + $icon = new pix_icon('t/down', $strmovedown, 'moodle', array('class'=>'icon down')); + $attributes = array('title'=>$strmovedown); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + return $output; + } + + /** + * Gets HTML to display zoom in or zoom out for the section. + * + * @param stdClass $course The current course + * @param stdClass $section The current section + * @param int $currentsection The literal number of the section, the first section being 0 + * @return type + */ + public function section_zoom_link($course, $section, $currentsection) { + $output = ''; + if ($currentsection == $section) { // Show the zoom boxes + $strshowalltopics = get_string('showalltopics'); + + $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'topic'=>'0')); + $url->set_anchor('section-'.($section)); + $icon = new pix_icon('i/all', $strshowalltopics, 'moodle', array('class'=>'icon')); + $attributes = array('title'=>$strshowalltopics); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand zoom')); + } else { + $strshowonlytopic = get_string("showonlytopic", "", $section); + + $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'topic'=>$section)); + $icon = new pix_icon('i/one', $strshowonlytopic, 'moodle', array('class'=>'icon')); + $attributes = array('title'=>$strshowonlytopic); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand zoom')); + } + return $output; + } + +} \ No newline at end of file diff --git a/course/format/weeks/format.php b/course/format/weeks/format.php index 9b9886a..665d246 100644 --- a/course/format/weeks/format.php +++ b/course/format/weeks/format.php @@ -41,21 +41,8 @@ defined('MOODLE_INTERNAL') || die(); } } - $streditsummary = get_string('editsummary'); - $stradd = get_string('add'); - $stractivities = get_string('activities'); - $strshowallweeks = get_string('showallweeks'); - $strweek = get_string('week'); - $strgroups = get_string('groups'); - $strgroupmy = get_string('groupmy'); - $editing = $PAGE->user_is_editing(); - - if ($editing) { - $strweekhide = get_string('hideweekfromothers'); - $strweekshow = get_string('showweekfromothers'); - $strmoveup = get_string('moveup'); - $strmovedown = get_string('movedown'); - } +$isediting = $PAGE->user_is_editing(); +$renderer = $PAGE->get_renderer('format_weeks'); $context = get_context_instance(CONTEXT_COURSE, $course->id); @@ -65,17 +52,17 @@ defined('MOODLE_INTERNAL') || die(); echo $OUTPUT->heading(get_string('weeklyoutline'), 2, 'headingblock header outline'); - echo ""; // Note, an ordered list would confuse - "1" could be the clipboard or summary. - echo "\n"; +echo html_writer::end_tag('ul'); // .weeks if (!empty($sectionmenu)) { - $select = new single_select(new moodle_url('/course/view.php', array('id'=>$course->id)), 'week', $sectionmenu); - $select->label = get_string('jumpto'); - $select->class = 'jumpmenu'; - $select->formid = 'sectionmenu'; - echo $OUTPUT->render($select); + echo $renderer->section_jumpto_menu($course->id, $sectionmenu, 'weeks'); } diff --git a/course/format/weeks/renderer.php b/course/format/weeks/renderer.php new file mode 100644 index 0000000..db4319a --- /dev/null +++ b/course/format/weeks/renderer.php @@ -0,0 +1,120 @@ +. + +/** + * This is the renderer for the weeks course format. + * + * It extends and builds upon the generic format renderer. + * + * @package moodlecore + * @copyright 2010 Sam Hemelryk + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +/** + * Make sure we have included the generic format renderer. + */ +require_once($CFG->dirroot.'/course/renderer.php'); + +/** + * The renderer for the weeks course format. + */ +class format_weeks_renderer extends core_course_generic_format_renderer { + + /** + * Generates the controls for editing a section. + * + * @param stdClass $course The current course + * @param stdClass $section The current section + * @param int $sectionnum The literal number of the section, the first section being 0 + * @return string + */ + public function section_editing_controls($course, $section, $sectionnum) { + + $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey())); + $baseurl->set_anchor('section-'.$sectionnum); + + $strweekhide = get_string('hideweekfromothers'); + $strweekshow = get_string('showweekfromothers'); + $strmoveup = get_string('moveup'); + $strmovedown = get_string('movedown'); + + $output = ''; + + // Show the hide/show eye + if ($section->visible) { + $url = new moodle_url($baseurl, array('hide'=>$sectionnum)); + $icon = new pix_icon('i/hide', $strweekhide, 'moodle', array('class'=>'icon hide')); + $attributes = array('title'=>$strweekhide); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } else { + $url = new moodle_url($baseurl, array('show'=>$sectionnum)); + $icon = new pix_icon('i/show', $strweekshow, 'moodle', array('class'=>'icon show')); + $attributes = array('title'=>$strweekshow); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + // Add a arrow to move section up + if ($sectionnum > 1) { + $url = new moodle_url($baseurl, array('section'=>$sectionnum, 'move'=>'-1', 'random'=>rand(1,10000))); + $url->set_anchor('section-'.($sectionnum-1)); + $icon = new pix_icon('t/up', $strmoveup, 'moodle', array('class'=>'icon up')); + $attributes = array('title'=>$strmoveup); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + // Add a arrow to move section down + if ($sectionnum < $course->numsections) { + $url = new moodle_url($baseurl, array('section'=>$sectionnum, 'move'=>'1', 'random'=>rand(1,10000))); + $url->set_anchor('section-'.($sectionnum+1)); + $icon = new pix_icon('t/down', $strmovedown, 'moodle', array('class'=>'icon down')); + $attributes = array('title'=>$strmovedown); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand')); + } + + return $output; + } + + /** + * Gets HTML to display zoom in or zoom out for the section. + * + * @param stdClass $course The current course + * @param stdClass $section The current section + * @param int $currentsection The literal number of the section, the first section being 0 + * @return type + */ + public function section_zoom_link($course, $section, $currentsection) { + $output = ''; + if ($currentsection == $section) { // Show the zoom boxes + $strshowallweeks = get_string('showallweeks'); + + $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'week'=>'0')); + $url->set_anchor('section-'.($section)); + $icon = new pix_icon('i/all', $strshowallweeks, 'moodle', array('class'=>'icon')); + $attributes = array('title'=>$strshowallweeks); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand zoom')); + } else { + $strshowonlyweek = get_string("showonlyweek", "", $section); + + $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'week'=>$section)); + $icon = new pix_icon('i/one', $strshowonlyweek, 'moodle', array('class'=>'icon')); + $attributes = array('title'=>$strshowonlyweek); + $output .= html_writer::tag('div', $this->output->action_icon($url, $icon, null, $attributes), array('class'=>'sectioncommand zoom')); + } + return $output; + } + +} \ No newline at end of file diff --git a/course/lib.php b/course/lib.php index a28be6d..89f4882 100644 --- a/course/lib.php +++ b/course/lib.php @@ -1252,460 +1252,53 @@ function set_section_visible($courseid, $sectionnumber, $visibility) { /** * Prints a section full of activity modules + * + * @deprecated since 2.0 + * + * @global moodle_page $PAGE + * @param stdClass $course + * @param stdClass $section + * @param array $mods + * @param array $modnamesused No longer needed + * @param bool $absolute No longer used + * @param int $width No longer used + * @param bool $hidecompletion */ function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) { - global $CFG, $USER, $DB, $PAGE, $OUTPUT; - - static $initialised; + global $PAGE; - static $groupbuttons; - static $groupbuttonslink; - static $isediting; - static $ismoving; - static $strmovehere; - static $strmovefull; - static $strunreadpostsone; - static $usetracking; - static $groupings; + $options = new stdClass; + $options->absolute = $absolute; + $options->hidecompletion = $hidecompletion; + $options->modnamesused = $modnamesused; - if (!isset($initialised)) { - $groupbuttons = ($course->groupmode or (!$course->groupmodeforce)); - $groupbuttonslink = (!$course->groupmodeforce); - $isediting = $PAGE->user_is_editing(); - $ismoving = $isediting && ismoving($course->id); - if ($ismoving) { - $strmovehere = get_string("movehere"); - $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'")); - } - include_once($CFG->dirroot.'/mod/forum/lib.php'); - if ($usetracking = forum_tp_can_track_forums()) { - $strunreadpostsone = get_string('unreadpostsone', 'forum'); + $renderer = $PAGE->get_renderer('core_course', 'generic_format'); + echo $renderer->section($course, $section, $mods, $options); } - $initialised = true; - } - - $labelformatoptions = new stdClass(); - $labelformatoptions->noclean = true; - $labelformatoptions->overflowdiv = true; - -/// Casting $course->modinfo to string prevents one notice when the field is null - $modinfo = get_fast_modinfo($course); - $completioninfo = new completion_info($course); - - //Accessibility: replace table with list