MDL-22449 bumping major version to lang invalidate caches and fix phpdocs
[moodle.git] / blocks / navigation / block_navigation.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 contains classes used to manage the navigation structures in Moodle
20  * and was introduced as part of the changes occuring in Moodle 2.0
21  *
22  * @since 2.0
23  * @package blocks
24  * @copyright 2009 Sam Hemelryk
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 /**
29  * The global navigation tree block class
30  *
31  * Used to produce the global navigation block new to Moodle 2.0
32  *
33  * @package blocks
34  * @copyright 2009 Sam Hemelryk
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class block_navigation extends block_base {
39     /** @var int */
40     public static $navcount;
41     /** @var string */
42     public $blockname = null;
43     /** @var bool */
44     protected $contentgenerated = false;
45     /** @var bool|null */
46     protected $docked = null;
48     /** @var int Trim characters from the right */
49     const TRIM_RIGHT = 1;
50     /** @var int Trim characters from the left */
51     const TRIM_LEFT = 2;
52     /** @var int Trim characters from the center */
53     const TRIM_CENTER = 3;
55     /**
56      * Set the initial properties for the block
57      */
58     function init() {
59         global $CFG;
60         $this->blockname = get_class($this);
61         $this->title = get_string('pluginname', $this->blockname);
62     }
64     /**
65      * All multiple instances of this block
66      * @return bool Returns true
67      */
68     function instance_allow_multiple() {
69         return false;
70     }
72     /**
73      * Set the applicable formats for this block to all
74      * @return array
75      */
76     function applicable_formats() {
77         return array('all' => true);
78     }
80     /**
81      * Allow the user to configure a block instance
82      * @return bool Returns true
83      */
84     function instance_allow_config() {
85         return true;
86     }
88     /**
89      * The navigation block cannot be hidden by default as it is integral to
90      * the navigation of Moodle.
91      *
92      * @return false
93      */
94     function  instance_can_be_hidden() {
95         return false;
96     }
98     function instance_can_be_docked() {
99         return (parent::instance_can_be_docked() && (empty($this->config->enabledock) || $this->config->enabledock=='yes'));
100     }
102     function get_required_javascript() {
103         global $CFG;
104         user_preference_allow_ajax_update('docked_block_instance_'.$this->instance->id, PARAM_INT);
105     }
107     /**
108      * Gets the content for this block by grabbing it from $this->page
109      */
110     function get_content() {
111         global $CFG, $OUTPUT;
112         // First check if we have already generated, don't waste cycles
113         if ($this->contentgenerated === true) {
114             return $this->content;
115         }
116         $this->page->requires->yui2_lib('dom');
117         // JS for navigation moved to the standard theme, the code will probably have to depend on the actual page structure
118         // $this->page->requires->js('/lib/javascript-navigation.js');
119         // Navcount is used to allow us to have multiple trees although I dont' know why
120         // you would want to trees the same
122         block_navigation::$navcount++;
124         // Check if this block has been docked
125         if ($this->docked === null) {
126             $this->docked = get_user_preferences('nav_in_tab_panel_globalnav'.block_navigation::$navcount, 0);
127         }
129         // Check if there is a param to change the docked state
130         if ($this->docked && optional_param('undock', null, PARAM_INT)==$this->instance->id) {
131             unset_user_preference('nav_in_tab_panel_globalnav'.block_navigation::$navcount);
132             $url = $this->page->url;
133             $url->remove_params(array('undock'));
134             redirect($url);
135         } else if (!$this->docked && optional_param('dock', null, PARAM_INT)==$this->instance->id) {
136             set_user_preferences(array('nav_in_tab_panel_globalnav'.block_navigation::$navcount=>1));
137             $url = $this->page->url;
138             $url->remove_params(array('dock'));
139             redirect($url);
140         }
142         $trimmode = self::TRIM_LEFT;
143         $trimlength = 50;
145         if (!empty($this->config->trimmode)) {
146             $trimmode = (int)$this->config->trimmode;
147         }
149         if (!empty($this->config->trimlength)) {
150             $trimlength = (int)$this->config->trimlength;
151         }
153         // Initialise (only actually happens if it hasn't already been done yet
154         $this->page->navigation->initialise();
155         $navigation = clone($this->page->navigation);
156         $expansionlimit = null;
157         if (!empty($this->config->expansionlimit)) {
158             $expansionlimit = $this->config->expansionlimit;
159             $navigation->set_expansion_limit($this->config->expansionlimit);
160         }
161         $this->trim($navigation, $trimmode, $trimlength, ceil($trimlength/2));
163         // Get the expandable items so we can pass them to JS
164         $expandable = array();
165         $navigation->find_expandable($expandable);
166         if ($expansionlimit) {
167             foreach ($expandable as $key=>$node) {
168                 if ($node['type'] > $expansionlimit && !($expansionlimit == navigation_node::TYPE_COURSE && $node['type'] == $expansionlimit && $node['branchid'] == SITEID)) {
169                     unset($expandable[$key]);
170                 }
171             }
172         }
174         // Initialise the JS tree object
175         $module = array('name'=>'block_navigation', 'fullpath'=>'/blocks/navigation/navigation.js', 'requires'=>array('core_dock', 'io', 'node', 'dom', 'event-custom', 'json-parse'), 'strings'=>array(array('viewallcourses','moodle')));
176         $limit = 20;
177         if (!empty($CFG->navcourselimit)) {
178             $limit = $CFG->navcourselimit;
179         }
180         $arguments = array($this->instance->id, array('expansions'=>$expandable, 'instance'=>$this->instance->id, 'candock'=>$this->instance_can_be_docked(), 'courselimit'=>$limit));
181         $this->page->requires->js_init_call('M.block_navigation.init_add_tree', $arguments, false, $module);
183         $options = array();
184         $options['linkcategories'] = (!empty($this->config->linkcategories) && $this->config->linkcategories == 'yes');
185         
186         // Grab the items to display
187         $renderer = $this->page->get_renderer('block_navigation');
188         $this->content->text = $renderer->navigation_tree($navigation, $expansionlimit, $options);
190         // Set content generated to true so that we know it has been done
191         $this->contentgenerated = true;
193         return $this->content;
194     }
196     /**
197      * Returns the attributes to set for this block
198      *
199      * This function returns an array of HTML attributes for this block including
200      * the defaults
201      * {@link block_tree->html_attributes()} is used to get the default arguments
202      * and then we check whether the user has enabled hover expansion and add the
203      * appropriate hover class if it has
204      *
205      * @return array An array of HTML attributes
206      */
207     public function html_attributes() {
208         $attributes = parent::html_attributes();
209         if (!empty($this->config->enablehoverexpansion) && $this->config->enablehoverexpansion == 'yes') {
210             $attributes['class'] .= ' block_js_expansion';
211         }
212         return $attributes;
213     }
215     /**
216      * Trims the text and shorttext properties of this node and optionally
217      * all of its children.
218      *
219      * @param int $mode One of navigation_node::TRIM_*
220      * @param int $long The length to trim text to
221      * @param int $short The length to trim shorttext to
222      * @param bool $recurse Recurse all children
223      * @param textlib|null $textlib
224      */
225     public function trim(navigation_node $node, $mode=1, $long=50, $short=25, $recurse=true, $textlib=null) {
226         if ($textlib == null) {
227             $textlib = textlib_get_instance();
228         }
229         switch ($mode) {
230             case self::TRIM_RIGHT :
231                 if ($textlib->strlen($node->text)>($long+3)) {
232                     // Truncate the text to $long characters
233                     $node->text = $this->trim_right($textlib, $node->text, $long);
234                 }
235                 if (is_string($node->shorttext) && $textlib->strlen($node->shorttext)>($short+3)) {
236                     // Truncate the shorttext
237                     $node->shorttext = $this->trim_right($textlib, $node->shorttext, $short);
238                 }
239                 break;
240             case self::TRIM_LEFT :
241                 if ($textlib->strlen($node->text)>($long+3)) {
242                     // Truncate the text to $long characters
243                     $node->text = $this->trim_left($textlib, $node->text, $long);
244                 }
245                 if (is_string($node->shorttext) && strlen($node->shorttext)>($short+3)) {
246                     // Truncate the shorttext
247                     $node->shorttext = $this->trim_left($textlib, $node->shorttext, $short);
248                 }
249                 break;
250             case self::TRIM_CENTER :
251                 if ($textlib->strlen($node->text)>($long+3)) {
252                     // Truncate the text to $long characters
253                     $node->text = $this->trim_center($textlib, $node->text, $long);
254                 }
255                 if (is_string($node->shorttext) && strlen($node->shorttext)>($short+3)) {
256                     // Truncate the shorttext
257                     $node->shorttext = $this->trim_center($textlib, $node->shorttext, $short);
258                 }
259                 break;
260         }
261         if ($recurse && $node->children->count()) {
262             foreach ($node->children as &$child) {
263                 $this->trim($child, $mode, $long, $short, true, $textlib);
264             }
265         }
266     }
267     /**
268      * Truncate a string from the left
269      * @param textlib $textlib
270      * @param string $string The string to truncate
271      * @param int $length The length to truncate to
272      * @return string The truncated string
273      */
274     protected function trim_left($textlib, $string, $length) {
275         return '...'.$textlib->substr($string, $textlib->strlen($string)-$length);
276     }
277     /**
278      * Truncate a string from the right
279      * @param textlib $textlib
280      * @param string $string The string to truncate
281      * @param int $length The length to truncate to
282      * @return string The truncated string
283      */
284     protected function trim_right($textlib, $string, $length) {
285         return $textlib->substr($string, 0, $length).'...';
286     }
287     /**
288      * Truncate a string in the center
289      * @param textlib $textlib
290      * @param string $string The string to truncate
291      * @param int $length The length to truncate to
292      * @return string The truncated string
293      */
294     protected function trim_center($textlib, $string, $length) {
295         $trimlength = ceil($length/2);
296         $start = $textlib->substr($string, 0, $trimlength);
297         $end = $textlib->substr($string, $textlib->strlen($string)-$trimlength);
298         $string = $start.'...'.$end;
299         return $string;
300     }