12611df72ff1b4b5468aa5e13e51a02c2a242b92
[moodle.git] / course / format / topics / format.php
1 <?php
3 // Display the whole course as "topics" made of of modules
4 // Included from "view.php"
5 /**
6  * Evaluation topics format for course display - NO layout tables, for accessibility, etc.
7  *
8  * A duplicate course format to enable the Moodle development team to evaluate
9  * CSS for the multi-column layout in place of layout tables.
10  * Less risk for the Moodle 1.6 beta release.
11  *   1. Straight copy of topics/format.php
12  *   2. Replace <table> and <td> with DIVs; inline styles.
13  *   3. Reorder columns so that in linear view content is first then blocks;
14  * styles to maintain original graphical (side by side) view.
15  *
16  * Target: 3-column graphical view using relative widths for pixel screen sizes
17  * 800x600, 1024x768... on IE6, Firefox. Below 800 columns will shift downwards.
18  *
19  * http://www.maxdesign.com.au/presentation/em/ Ideal length for content.
20  * http://www.svendtofte.com/code/max_width_in_ie/ Max width in IE.
21  *
22  * @copyright &copy; 2006 The Open University
23  * @author N.D.Freear@open.ac.uk, and others.
24  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
25  * @package
26  */
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->libdir.'/completionlib.php');
33 $topic = optional_param('topic', -1, PARAM_INT);
35 if ($topic != -1) {
36     $displaysection = course_set_display($course->id, $topic);
37 } else {
38     if (isset($USER->display[$course->id])) {
39         $displaysection = $USER->display[$course->id];
40     } else {
41         $displaysection = course_set_display($course->id, 0);
42     }
43 }
45 $context = get_context_instance(CONTEXT_COURSE, $course->id);
47 if (($marker >=0) && has_capability('moodle/course:setcurrentsection', $context) && confirm_sesskey()) {
48     $course->marker = $marker;
49     $DB->set_field("course", "marker", $marker, array("id"=>$course->id));
50 }
52 $streditsummary  = get_string('editsummary');
53 $stradd          = get_string('add');
54 $stractivities   = get_string('activities');
55 $strshowalltopics = get_string('showalltopics');
56 $strtopic         = get_string('topic');
57 $strgroups       = get_string('groups');
58 $strgroupmy      = get_string('groupmy');
59 $editing         = $PAGE->user_is_editing();
61 if ($editing) {
62     $strtopichide = get_string('hidetopicfromothers');
63     $strtopicshow = get_string('showtopicfromothers');
64     $strmarkthistopic = get_string('markthistopic');
65     $strmarkedthistopic = get_string('markedthistopic');
66     $strmoveup   = get_string('moveup');
67     $strmovedown = get_string('movedown');
68 }
70 // Print the Your progress icon if the track completion is enabled
71 $completioninfo = new completion_info($course);
72 $completioninfo->print_help_icon();
74 echo $OUTPUT->heading(get_string('topicoutline'), 2, 'headingblock header outline');
76 // Note, an ordered list would confuse - "1" could be the clipboard or summary.
77 echo "<ul class='topics'>\n";
79 /// If currently moving a file then show the current clipboard
80 if (ismoving($course->id)) {
81     $stractivityclipboard = strip_tags(get_string('activityclipboard', '', $USER->activitycopyname));
82     $strcancel= get_string('cancel');
83     echo '<li class="clipboard">';
84     echo $stractivityclipboard.'&nbsp;&nbsp;(<a href="mod.php?cancelcopy=true&amp;sesskey='.sesskey().'">'.$strcancel.'</a>)';
85     echo "</li>\n";
86 }
88 /// Print Section 0 with general activities
90 $section = 0;
91 $thissection = $sections[$section];
92 unset($sections[0]);
94 if ($thissection->summary or $thissection->sequence or $PAGE->user_is_editing()) {
96     // Note, no need for a 'left side' cell or DIV.
97     // Note, 'right side' is BEFORE content.
98     echo '<li id="section-0" class="section main clearfix" >';
99     echo '<div class="left side">&nbsp;</div>';
100     echo '<div class="right side" >&nbsp;</div>';
101     echo '<div class="content">';
102     if (!is_null($thissection->name)) {
103         echo $OUTPUT->heading($thissection->name, 3, 'sectionname');
104     }
105     echo '<div class="summary">';
107     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
108     $summarytext = file_rewrite_pluginfile_urls($thissection->summary, 'pluginfile.php', $coursecontext->id, 'course', 'section', $thissection->id);
109     $summaryformatoptions = new stdClass();
110     $summaryformatoptions->noclean = true;
111     $summaryformatoptions->overflowdiv = true;
112     echo format_text($summarytext, $thissection->summaryformat, $summaryformatoptions);
114     if ($PAGE->user_is_editing() && has_capability('moodle/course:update', $coursecontext)) {
115         echo '<a title="'.$streditsummary.'" '.
116              ' href="editsection.php?id='.$thissection->id.'"><img src="'.$OUTPUT->pix_url('t/edit') . '" '.
117              ' class="icon edit" alt="'.$streditsummary.'" /></a>';
118     }
119     echo '</div>';
121     print_section($course, $thissection, $mods, $modnamesused);
123     if ($PAGE->user_is_editing()) {
124         print_section_add_menus($course, $section, $modnames);
125     }
127     echo '</div>';
128     echo "</li>\n";
132 /// Now all the normal modules by topic
133 /// Everything below uses "section" terminology - each "section" is a topic.
135 $timenow = time();
136 $section = 1;
137 $sectionmenu = array();
139 while ($section <= $course->numsections) {
141     if (!empty($sections[$section])) {
142         $thissection = $sections[$section];
144     } else {
145         $thissection = new stdClass;
146         $thissection->course  = $course->id;   // Create a new section structure
147         $thissection->section = $section;
148         $thissection->name    = null;
149         $thissection->summary  = '';
150         $thissection->summaryformat = FORMAT_HTML;
151         $thissection->visible  = 1;
152         $thissection->id = $DB->insert_record('course_sections', $thissection);
153     }
155     $showsection = (has_capability('moodle/course:viewhiddensections', $context) or $thissection->visible or !$course->hiddensections);
157     if (!empty($displaysection) and $displaysection != $section) {  // Check this topic is visible
158         if ($showsection) {
159             $sectionmenu[$section] = get_section_name($course, $thissection);
160         }
161         $section++;
162         continue;
163     }
165     if ($showsection) {
167         $currenttopic = ($course->marker == $section);
169         $currenttext = '';
170         if (!$thissection->visible) {
171             $sectionstyle = ' hidden';
172         } else if ($currenttopic) {
173             $sectionstyle = ' current';
174             $currenttext = get_accesshide(get_string('currenttopic','access'));
175         } else {
176             $sectionstyle = '';
177         }
179         echo '<li id="section-'.$section.'" class="section main clearfix'.$sectionstyle.'" >'; //'<div class="left side">&nbsp;</div>';
181             echo '<div class="left side">'.$currenttext.$section.'</div>';
182         // Note, 'right side' is BEFORE content.
183         echo '<div class="right side">';
185         if ($displaysection == $section) {    // Show the zoom boxes
186             echo '<a href="view.php?id='.$course->id.'&amp;topic=0#section-'.$section.'" title="'.$strshowalltopics.'">'.
187                  '<img src="'.$OUTPUT->pix_url('i/all') . '" class="icon" alt="'.$strshowalltopics.'" /></a><br />';
188         } else {
189             $strshowonlytopic = get_string("showonlytopic", "", $section);
190             echo '<a href="view.php?id='.$course->id.'&amp;topic='.$section.'" title="'.$strshowonlytopic.'">'.
191                  '<img src="'.$OUTPUT->pix_url('i/one') . '" class="icon" alt="'.$strshowonlytopic.'" /></a><br />';
192         }
194         if ($PAGE->user_is_editing() && has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
196             if ($course->marker == $section) {  // Show the "light globe" on/off
197                 echo '<a href="view.php?id='.$course->id.'&amp;marker=0&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strmarkedthistopic.'">'.'<img src="'.$OUTPUT->pix_url('i/marked') . '" alt="'.$strmarkedthistopic.'" /></a><br />';
198             } else {
199                 echo '<a href="view.php?id='.$course->id.'&amp;marker='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strmarkthistopic.'">'.'<img src="'.$OUTPUT->pix_url('i/marker') . '" alt="'.$strmarkthistopic.'" /></a><br />';
200             }
202             if ($thissection->visible) {        // Show the hide/show eye
203                 echo '<a href="view.php?id='.$course->id.'&amp;hide='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strtopichide.'">'.
204                      '<img src="'.$OUTPUT->pix_url('i/hide') . '" class="icon hide" alt="'.$strtopichide.'" /></a><br />';
205             } else {
206                 echo '<a href="view.php?id='.$course->id.'&amp;show='.$section.'&amp;sesskey='.sesskey().'#section-'.$section.'" title="'.$strtopicshow.'">'.
207                      '<img src="'.$OUTPUT->pix_url('i/show') . '" class="icon hide" alt="'.$strtopicshow.'" /></a><br />';
208             }
209             if ($section > 1) {                       // Add a arrow to move section up
210                 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.'">'.
211                      '<img src="'.$OUTPUT->pix_url('t/up') . '" class="icon up" alt="'.$strmoveup.'" /></a><br />';
212             }
214             if ($section < $course->numsections) {    // Add a arrow to move section down
215                 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.'">'.
216                      '<img src="'.$OUTPUT->pix_url('t/down') . '" class="icon down" alt="'.$strmovedown.'" /></a><br />';
217             }
218         }
219         echo '</div>';
221         echo '<div class="content">';
222         if (!has_capability('moodle/course:viewhiddensections', $context) and !$thissection->visible) {   // Hidden for students
223             echo get_string('notavailable');
224         } else {
225             if (!is_null($thissection->name)) {
226                 echo $OUTPUT->heading($thissection->name, 3, 'sectionname');
227             }
228             echo '<div class="summary">';
229             if ($thissection->summary) {
230                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
231                 $summarytext = file_rewrite_pluginfile_urls($thissection->summary, 'pluginfile.php', $coursecontext->id, 'course', 'section', $thissection->id);
232                 $summaryformatoptions = new stdClass();
233                 $summaryformatoptions->noclean = true;
234                 $summaryformatoptions->overflowdiv = true;
235                 echo format_text($summarytext, $thissection->summaryformat, $summaryformatoptions);
236             } else {
237                echo '&nbsp;';
238             }
240             if ($PAGE->user_is_editing() && has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
241                 echo ' <a title="'.$streditsummary.'" href="editsection.php?id='.$thissection->id.'">'.
242                      '<img src="'.$OUTPUT->pix_url('t/edit') . '" class="icon edit" alt="'.$streditsummary.'" /></a><br /><br />';
243             }
244             echo '</div>';
246             print_section($course, $thissection, $mods, $modnamesused);
247             echo '<br />';
248             if ($PAGE->user_is_editing()) {
249                 print_section_add_menus($course, $section, $modnames);
250             }
251         }
253         echo '</div>';
254         echo "</li>\n";
255     }
257     unset($sections[$section]);
258     $section++;
261 if (!$displaysection and $PAGE->user_is_editing() and has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $course->id))) {
262     // print stealth sections if present
263     $modinfo = get_fast_modinfo($course);
264     foreach ($sections as $section=>$thissection) {
265         if (empty($modinfo->sections[$section])) {
266             continue;
267         }
269         echo '<li id="section-'.$section.'" class="section main clearfix orphaned hidden">'; //'<div class="left side">&nbsp;</div>';
271         echo '<div class="left side">';
272         echo '</div>';
273         // Note, 'right side' is BEFORE content.
274         echo '<div class="right side">';
275         echo '</div>';
276         echo '<div class="content">';
277         echo $OUTPUT->heading(get_string('orphanedactivities'), 3, 'sectionname');
278         print_section($course, $thissection, $mods, $modnamesused);
279         echo '</div>';
280         echo "</li>\n";
281     }
285 echo "</ul>\n";
287 if (!empty($sectionmenu)) {
288     $select = new single_select(new moodle_url('/course/view.php', array('id'=>$course->id)), 'topic', $sectionmenu);
289     $select->label = get_string('jumpto');
290     $select->class = 'jumpmenu';
291     $select->formid = 'sectionmenu';
292     echo $OUTPUT->render($select);