661ab1469c19c579d59f489392977e5994b01cde
[moodle.git] / lib / ajax / getnavbranch.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file is used to deliver a branch from the navigation structure
20  * in XML format back to a page from an AJAX call
21  *
22  * @since 2.0
23  * @package moodlecore
24  * @copyright 2009 Sam Hemelryk
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 /** Include config */
29 require_once(dirname(__FILE__) . '/../../config.php');
30 /** Include course lib for its functions */
31 require_once($CFG->dirroot.'/course/lib.php');
33 try {
34     // Start buffer capture so that we can `remove` any errors
35     ob_start();
36     // Require id This is the key for whatever branch we want to get
37     $branchid = required_param('id', PARAM_INT);
38     // This identifies the type of the branch we want to get
39     $branchtype = required_param('type', PARAM_INT);
40     // This identifies the block instance requesting AJAX extension
41     $instanceid = optional_param('instance', null, PARAM_INT);
43     // Create a global nav object
44     $navigation = new global_navigation_for_ajax($PAGE);
46     // If set to true then we need to call toggle display
47     $toggledisplay = false;
48     if ($instanceid!==null) {
49         // Get the db record for the block instance
50         $blockrecords = $DB->get_record('block_instances', array('id'=>$instanceid,'blockname'=>'navigation'));
51         if ($blockrecords!=false) {
52                 // Instantiate a block_instance object so we can access congif
53             $block = block_instance('navigation', $blockrecords);
54             // Check if the expansion limit config option has been set and isn't the default [everything]
55             if (empty($block->config->showemptybranches) || $block->config->showemptybranches=='no') {
56                 $navigation->showemptybranches = false;
57             }
58         }
59     }
61     // Create a navigation object to use, we can't guarantee PAGE will be complete
62     $expandable = $navigation->initialise($branchtype, $branchid);
63     $converter = new navigation_json();
64     
65     // Find the actuall branch we are looking for
66     $branch = $navigation->find($branchid, $branchtype);
68     // Stop buffering errors at this point
69     $html = ob_get_contents();
70     ob_end_clean();
71 } catch (Exception $e) {
72     die('Error: '.$e->getMessage());
73 }
75 // Check if the buffer contianed anything if it did ERROR!
76 if (trim($html) !== '') {
77     die('Errors were encountered while producing the navigation branch'."\n\n\n".$html);
78 }
79 // Check that branch isn't empty... if it is ERROR!
80 if (empty($branch) || $branch->nodetype !== navigation_node::NODETYPE_BRANCH) {
81     die('No further information available for this branch');
82 }
84 // Prepare an XML converter for the branch
85 $converter->set_expandable($expandable);
86 // Set XML headers
87 header('Content-type: text/plain');
88 // Convert and output the branch as XML
89 echo $converter->convert($branch);