MDL-28583 Redirect in Scorm course format before output
[moodle.git] / course / format / scorm / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains main class for the course format SCORM
19  *
20  * @since     2.0
21  * @package   format_scorm
22  * @copyright 2009 Sam Hemelryk
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot. '/course/format/lib.php');
29 /**
30  * Main class for the Scorm course format
31  *
32  * @package    format_scorm
33  * @copyright  2012 Marina Glancy
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class format_scorm extends format_base {
38     /**
39      * The URL to use for the specified course
40      *
41      * @param int|stdClass $section Section object from database or just field course_sections.section
42      *     if null the course view page is returned
43      * @param array $options options for view URL. At the moment core uses:
44      *     'navigation' (bool) if true and section has no separate page, the function returns null
45      *     'sr' (int) used by multipage formats to specify to which section to return
46      * @return null|moodle_url
47      */
48     public function get_view_url($section, $options = array()) {
49         if (!empty($options['navigation']) && $section !== null) {
50             return null;
51         }
52         return new moodle_url('/course/view.php', array('id' => $this->courseid));
53     }
55     /**
56      * Loads all of the course sections into the navigation
57      *
58      * @param global_navigation $navigation
59      * @param navigation_node $node The course node within the navigation
60      */
61     public function extend_course_navigation($navigation, navigation_node $node) {
62         // Scorm course format does not extend course navigation
63     }
65     /**
66      * Returns the list of blocks to be automatically added for the newly created course
67      *
68      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
69      *     each of values is an array of block names (for left and right side columns)
70      */
71     public function get_default_blocks() {
72         return array(
73             BLOCK_POS_LEFT => array(),
74             BLOCK_POS_RIGHT => array('news_items', 'recent_activity', 'calendar_upcoming')
75         );
76     }
78     /**
79      * Allows course format to execute code on moodle_page::set_course()
80      *
81      * If user is on course view page and there is no scorm module added to the course
82      * and the user has 'moodle/course:update' capability, redirect to create module
83      * form. This function is executed before the output starts
84      *
85      * @param moodle_page $page instance of page calling set_course
86      */
87     public function page_set_course(moodle_page $page) {
88         global $PAGE;
89         if ($PAGE == $page && $page->has_set_url() &&
90                 $page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
91             $modinfo = get_fast_modinfo($this->courseid);
92             if (empty($modinfo->instances['scorm'])
93                     && has_capability('moodle/course:update', context_course::instance($this->courseid))) {
94                 // Redirect to create a new activity
95                 $url = new moodle_url('/course/modedit.php',
96                         array('course' => $this->courseid, 'section' => 0, 'add' => 'scorm'));
97                 redirect($url);
98             }
99         }
100     }