MDL-43675 navigation: courses branch is now recognised as expandable
[moodle.git] / lib / ajax / getnavbranch.php
CommitLineData
7d2a0492 1<?php
2
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/>.
17
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
4a3ecbb2 23 * @package core
7d2a0492 24 * @copyright 2009 Sam Hemelryk
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
a70eb30f
SH
28define('AJAX_SCRIPT', true);
29
7d2a0492 30/** Include config */
31require_once(dirname(__FILE__) . '/../../config.php');
32/** Include course lib for its functions */
33require_once($CFG->dirroot.'/course/lib.php');
7d2a0492 34
507a7a9a
SH
35try {
36 // Start buffer capture so that we can `remove` any errors
37 ob_start();
b9c87ef8
SH
38 // Require id This is the key for whatever branch we want to get.
39 // This accepts alphanum because the courses and my courses branches don't have numerical keys.
40 // For those branches we return the alphanum key, courses and mycourses.
58b602da 41 $branchid = required_param('id', PARAM_ALPHANUM);
507a7a9a
SH
42 // This identifies the type of the branch we want to get
43 $branchtype = required_param('type', PARAM_INT);
44 // This identifies the block instance requesting AJAX extension
45 $instanceid = optional_param('instance', null, PARAM_INT);
7d2a0492 46
b0c6dc1c 47 $PAGE->set_context(context_system::instance());
4766a50c 48
507a7a9a 49 // Create a global nav object
246a9b05 50 $navigation = new global_navigation_for_ajax($PAGE, $branchtype, $branchid);
507a7a9a 51
480f906e 52 $linkcategories = false;
8a7703ce 53
507a7a9a
SH
54 if ($instanceid!==null) {
55 // Get the db record for the block instance
88f77c3c
SH
56 $blockrecord = $DB->get_record('block_instances', array('id'=>$instanceid,'blockname'=>'navigation'));
57 if ($blockrecord!=false) {
a9535f79
SH
58
59 // Instantiate a block_instance object so we can access config
88f77c3c 60 $block = block_instance('navigation', $blockrecord);
a9535f79
SH
61
62 $trimmode = block_navigation::TRIM_RIGHT;
63 $trimlength = 50;
64
65 // Set the trim mode
66 if (!empty($block->config->trimmode)) {
67 $trimmode = (int)$block->config->trimmode;
68 }
69 // Set the trim length
70 if (!empty($block->config->trimlength)) {
71 $trimlength = (int)$block->config->trimlength;
507a7a9a 72 }
480f906e
SH
73 if (!empty($block->config->linkcategories) && $block->config->linkcategories == 'yes') {
74 $linkcategories = true;
75 }
7d2a0492 76 }
77 }
7d2a0492 78
507a7a9a 79 // Create a navigation object to use, we can't guarantee PAGE will be complete
ca787a92 80 if (!isloggedin()) {
4766a50c
SH
81 $navigation->set_expansion_limit(navigation_node::TYPE_COURSE);
82 } else {
83 if (isset($block) && !empty($block->config->expansionlimit)) {
84 $navigation->set_expansion_limit($block->config->expansionlimit);
85 }
88f77c3c 86 }
a9535f79
SH
87 if (isset($block)) {
88 $block->trim($navigation, $trimmode, $trimlength, ceil($trimlength/2));
89 }
507a7a9a 90 $converter = new navigation_json();
8a7703ce 91
58b602da
SH
92 // Find the actual branch we are looking for
93 if ($branchtype != 0) {
94 $branch = $navigation->find($branchid, $branchtype);
95 } else if ($branchid === 'mycourses' || $branchid === 'courses') {
96 $branch = $navigation->find($branchid, navigation_node::TYPE_ROOTNODE);
97 } else {
98 throw new coding_exception('Invalid branch type/id passed to AJAX call to load branches.');
99 }
8a7703ce 100
480f906e
SH
101 // Remove links to categories if required.
102 if (!$linkcategories) {
103 foreach ($branch->find_all_of_type(navigation_node::TYPE_CATEGORY) as $category) {
104 $category->action = null;
105 }
3b42c973
MG
106 foreach ($branch->find_all_of_type(navigation_node::TYPE_MY_CATEGORY) as $category) {
107 $category->action = null;
108 }
480f906e 109 }
8a7703ce 110
507a7a9a
SH
111 // Stop buffering errors at this point
112 $html = ob_get_contents();
113 ob_end_clean();
114} catch (Exception $e) {
956e2e8a 115 throw new coding_exception('Error: '.$e->getMessage());
507a7a9a 116}
7d2a0492 117
118// Check if the buffer contianed anything if it did ERROR!
507a7a9a 119if (trim($html) !== '') {
956e2e8a 120 throw new coding_exception('Errors were encountered while producing the navigation branch'."\n\n\n".$html);
7d2a0492 121}
122// Check that branch isn't empty... if it is ERROR!
956e2e8a
SH
123if (empty($branch) || ($branch->nodetype !== navigation_node::NODETYPE_BRANCH && !$branch->isexpandable)) {
124 throw new coding_exception('No further information available for this branch');
7d2a0492 125}
126
127// Prepare an XML converter for the branch
246a9b05 128$converter->set_expandable($navigation->get_expandable());
7d2a0492 129// Set XML headers
8a7703ce 130header('Content-type: text/plain; charset=utf-8');
7d2a0492 131// Convert and output the branch as XML
117bd748 132echo $converter->convert($branch);