Merge branch 'MDL-58490-master' of git://github.com/lameze/moodle
[moodle.git] / blocks / moodleblock.class.php
CommitLineData
ec972ade 1<?php
4ca6cfbf
PS
2// This file is part of Moodle - http://moodle.org/
3//
ec972ade 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.
4ca6cfbf 13//
ec972ade 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/>.
0f3fe4b6 16
c7e3bc51 17/**
ccd3dd0c 18 * This file contains the parent class for moodle blocks, block_base.
c7e3bc51 19 *
f25a6839 20 * @package core_block
78bfb562 21 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
c7e3bc51 22 */
23
24/// Constants
25
26/**
27 * Block type of list. Contents of block should be set as an associative array in the content object as items ($this->content->items). Optionally include footer text in $this->content->footer.
28 */
0f3fe4b6 29define('BLOCK_TYPE_LIST', 1);
c7e3bc51 30
31/**
32 * Block type of text. Contents of block should be set to standard html text in the content object as items ($this->content->text). Optionally include footer text in $this->content->footer.
33 */
0f3fe4b6 34define('BLOCK_TYPE_TEXT', 2);
7d2a0492 35/**
36 * Block type of tree. $this->content->items is a list of tree_item objects and $this->content->footer is a string.
37 */
38define('BLOCK_TYPE_TREE', 3);
c7e3bc51 39
c7e3bc51 40/**
e0134f84 41 * Class for describing a moodle block, all Moodle blocks derive from this class
c7e3bc51 42 *
43 * @author Jon Papaioannou
f25a6839 44 * @package core_block
c7e3bc51 45 */
e89d741a 46class block_base {
c7e3bc51 47
48 /**
49 * Internal var for storing/caching translated strings
50 * @var string $str
51 */
0f3fe4b6 52 var $str;
c7e3bc51 53
54 /**
f8582e3e 55 * The title of the block to be displayed in the block title area.
c7e3bc51 56 * @var string $title
57 */
9b4b78fd 58 var $title = NULL;
c7e3bc51 59
47332703
JF
60 /**
61 * The name of the block to be displayed in the block title area if the title is empty.
62 * @var string arialabel
63 */
64 var $arialabel = NULL;
65
c7e3bc51 66 /**
ccd3dd0c 67 * The type of content that this block creates. Currently support options - BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT
c7e3bc51 68 * @var int $content_type
69 */
3ef642d9 70 var $content_type = BLOCK_TYPE_TEXT;
c7e3bc51 71
72 /**
73 * An object to contain the information to be displayed in the block.
74 * @var stdObject $content
75 */
9b4b78fd 76 var $content = NULL;
c7e3bc51 77
c7e3bc51 78 /**
79 * The initialized instance of this block object.
80 * @var block $instance
81 */
9b4b78fd 82 var $instance = NULL;
c7e3bc51 83
3179b000 84 /**
85 * The page that this block is appearing on.
86 * @var moodle_page
87 */
88 public $page = NULL;
89
e92c286c 90 /**
91 * This blocks's context.
92 * @var stdClass
93 */
94 public $context = NULL;
95
c7e3bc51 96 /**
97 * An object containing the instance configuration information for the current instance of this block.
98 * @var stdObject $config
99 */
9b4b78fd 100 var $config = NULL;
101
4ca6cfbf 102 /**
f9648e77 103 * How often the cronjob should run, 0 if not at all.
104 * @var int $cron
105 */
106
107 var $cron = NULL;
108
e0134f84 109/// Class Functions
c7e3bc51 110
73554752 111 /**
112 * Fake constructor to keep PHP5 happy
113 *
114 */
115 function __construct() {
8571833f 116 $this->init();
73554752 117 }
4ca6cfbf 118
44c55d46 119 /**
120 * Function that can be overridden to do extra cleanup before
121 * the database tables are deleted. (Called once per block, not per instance!)
122 */
123 function before_delete() {
124 }
4ca6cfbf 125
c7e3bc51 126 /**
127 * Returns the block name, as present in the class name,
128 * the database, the block directory, etc etc.
129 *
130 * @return string
131 */
0f3fe4b6 132 function name() {
133 // Returns the block name, as present in the class name,
134 // the database, the block directory, etc etc.
135 static $myname;
c7e3bc51 136 if ($myname === NULL) {
0f3fe4b6 137 $myname = strtolower(get_class($this));
138 $myname = substr($myname, strpos($myname, '_') + 1);
139 }
140 return $myname;
141 }
142
c7e3bc51 143 /**
144 * Parent class version of this function simply returns NULL
145 * This should be implemented by the derived class to return
146 * the content object.
147 *
148 * @return stdObject
149 */
0f3fe4b6 150 function get_content() {
151 // This should be implemented by the derived class.
152 return NULL;
153 }
c7e3bc51 154
155 /**
156 * Returns the class $title var value.
157 *
4ca6cfbf 158 * Intentionally doesn't check if a title is set.
c7e3bc51 159 * This is already done in {@link _self_test()}
160 *
161 * @return string $this->title
162 */
0f3fe4b6 163 function get_title() {
6195e04a 164 // Intentionally doesn't check if a title is set. This is already done in _self_test()
0f3fe4b6 165 return $this->title;
166 }
c7e3bc51 167
168 /**
169 * Returns the class $content_type var value.
170 *
4ca6cfbf 171 * Intentionally doesn't check if content_type is set.
c7e3bc51 172 * This is already done in {@link _self_test()}
173 *
174 * @return string $this->content_type
175 */
0f3fe4b6 176 function get_content_type() {
6195e04a 177 // Intentionally doesn't check if a content_type is set. This is already done in _self_test()
0f3fe4b6 178 return $this->content_type;
179 }
c7e3bc51 180
3ef642d9 181 /**
182 * Returns true or false, depending on whether this block has any content to display
7e874772 183 * and whether the user has permission to view the block
3ef642d9 184 *
185 * @return boolean
186 */
187 function is_empty() {
e92c286c 188 if ( !has_capability('moodle/block:view', $this->context) ) {
7e874772 189 return true;
190 }
191
3ef642d9 192 $this->get_content();
193 return(empty($this->content->text) && empty($this->content->footer));
194 }
195
c7e3bc51 196 /**
197 * First sets the current value of $this->content to NULL
198 * then calls the block's {@link get_content()} function
199 * to set its value back.
200 *
201 * @return stdObject
202 */
0f3fe4b6 203 function refresh_content() {
204 // Nothing special here, depends on content()
205 $this->content = NULL;
206 return $this->get_content();
207 }
c7e3bc51 208
209 /**
9c14c1c5 210 * Return a block_contents object representing the full contents of this block.
d4a03c00 211 *
212 * This internally calls ->get_content(), and then adds the editing controls etc.
213 *
214 * You probably should not override this method, but instead override
215 * {@link html_attributes()}, {@link formatted_contents()} or {@link get_content()},
216 * {@link hide_header()}, {@link (get_edit_controls)}, etc.
217 *
9c14c1c5 218 * @return block_contents a representation of the block, for rendering.
d4a03c00 219 * @since Moodle 2.0.
c7e3bc51 220 */
d4a03c00 221 public function get_content_for_output($output) {
222 global $CFG;
0a0bb380 223
dd72b308 224 $bc = new block_contents($this->html_attributes());
a69a7e89 225 $bc->attributes['data-block'] = $this->name();
d4a03c00 226 $bc->blockinstanceid = $this->instance->id;
227 $bc->blockpositionid = $this->instance->blockpositionid;
c7e3bc51 228
e54f4a78 229 if ($this->instance->visible) {
230 $bc->content = $this->formatted_contents($output);
231 if (!empty($this->content->footer)) {
232 $bc->footer = $this->content->footer;
233 }
234 } else {
235 $bc->add_class('invisible');
236 }
237
d4a03c00 238 if (!$this->hide_header()) {
239 $bc->title = $this->title;
240 }
47332703 241
91d941c3
SH
242 if (empty($bc->title)) {
243 $bc->arialabel = new lang_string('pluginname', get_class($this));
47332703 244 $this->arialabel = $bc->arialabel;
91d941c3 245 }
ae42ff6f 246
d4a03c00 247 if ($this->page->user_is_editing()) {
00a24d44 248 $bc->controls = $this->page->blocks->edit_controls($this);
9c14c1c5
PS
249 } else {
250 // we must not use is_empty on hidden blocks
251 if ($this->is_empty() && !$bc->controls) {
252 return null;
253 }
f674ec86 254 }
255
0885166f
JC
256 if (empty($CFG->allowuserblockhiding)
257 || (empty($bc->content) && empty($bc->footer))
258 || !$this->instance_can_be_collapsed()) {
d4a03c00 259 $bc->collapsible = block_contents::NOT_HIDEABLE;
260 } else if (get_user_preferences('block' . $bc->blockinstanceid . 'hidden', false)) {
261 $bc->collapsible = block_contents::HIDDEN;
262 } else {
263 $bc->collapsible = block_contents::VISIBLE;
0f3fe4b6 264 }
c4d951e1 265
84192d78
SH
266 if ($this->instance_can_be_docked() && !$this->hide_header()) {
267 $bc->dockable = true;
268 }
269
40928036 270 $bc->annotation = ''; // TODO MDL-19398 need to work out what to say here.
d4a03c00 271
272 return $bc;
0f3fe4b6 273 }
89adb174 274
c7e3bc51 275 /**
d4a03c00 276 * Convert the contents of the block to HTML.
c7e3bc51 277 *
d4a03c00 278 * This is used by block base classes like block_list to convert the structured
279 * $this->content->list and $this->content->icons arrays to HTML. So, in most
280 * blocks, you probaby want to override the {@link get_contents()} method,
281 * which generates that structured representation of the contents.
282 *
283 * @param $output The core_renderer to use when generating the output.
284 * @return string the HTML that should appearn in the body of the block.
285 * @since Moodle 2.0.
c7e3bc51 286 */
d4a03c00 287 protected function formatted_contents($output) {
288 $this->get_content();
dde36f9d 289 $this->get_required_javascript();
d4a03c00 290 if (!empty($this->content->text)) {
291 return $this->content->text;
292 } else {
293 return '';
294 }
295 }
296
c7e3bc51 297 /**
298 * Tests if this block has been implemented correctly.
299 * Also, $errors isn't used right now
300 *
301 * @return boolean
302 */
4ca6cfbf 303
0f3fe4b6 304 function _self_test() {
305 // Tests if this block has been implemented correctly.
306 // Also, $errors isn't used right now
307 $errors = array();
308
309 $correct = true;
c7e3bc51 310 if ($this->get_title() === NULL) {
0f3fe4b6 311 $errors[] = 'title_not_set';
312 $correct = false;
313 }
7d2a0492 314 if (!in_array($this->get_content_type(), array(BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT, BLOCK_TYPE_TREE))) {
0f3fe4b6 315 $errors[] = 'invalid_content_type';
316 $correct = false;
317 }
4ca6cfbf 318 //following selftest was not working when roles&capabilities were used from block
35a518c5 319/* if ($this->get_content() === NULL) {
0f3fe4b6 320 $errors[] = 'content_not_set';
321 $correct = false;
35a518c5 322 }*/
2b0d60ec 323 $formats = $this->applicable_formats();
c7e3bc51 324 if (empty($formats) || array_sum($formats) === 0) {
8a47e075 325 $errors[] = 'no_formats';
0f3fe4b6 326 $correct = false;
327 }
2b0d60ec 328
0f3fe4b6 329 return $correct;
330 }
331
c7e3bc51 332 /**
333 * Subclasses should override this and return true if the
4dd79132 334 * subclass block has a settings.php file.
c7e3bc51 335 *
336 * @return boolean
337 */
0f3fe4b6 338 function has_config() {
339 return false;
340 }
c7e3bc51 341
c7e3bc51 342 /**
343 * Default behavior: save all variables as $CFG properties
344 * You don't need to override this if you 're satisfied with the above
345 *
53c74b18 346 * @deprecated since Moodle 2.9 MDL-49385 - Please use Admin Settings functionality to save block configuration.
c7e3bc51 347 */
f8582e3e 348 function config_save($data) {
94cec934 349 throw new coding_exception('config_save() can not be used any more, use Admin Settings functionality to save block configuration.');
0f3fe4b6 350 }
4ca6cfbf 351
c7e3bc51 352 /**
40928036 353 * Which page types this block may appear on.
354 *
355 * The information returned here is processed by the
356 * {@link blocks_name_allowed_in_format()} function. Look there if you need
357 * to know exactly how this works.
358 *
359 * Default case: everything except mod and tag.
360 *
361 * @return array page-type prefix => true/false.
c7e3bc51 362 */
0f3fe4b6 363 function applicable_formats() {
d232b8c7 364 // Default case: the block can be used in courses and site index, but not in activities
9591bc3c 365 return array('all' => true, 'mod' => false, 'tag' => false);
0f3fe4b6 366 }
4ca6cfbf 367
c7e3bc51 368
c7e3bc51 369 /**
370 * Default return is false - header will be shown
371 * @return boolean
372 */
0f3fe4b6 373 function hide_header() {
0f3fe4b6 374 return false;
375 }
c7e3bc51 376
377 /**
d4a03c00 378 * Return any HTML attributes that you want added to the outer <div> that
379 * of the block when it is output.
7d2a0492 380 *
381 * Because of the way certain JS events are wired it is a good idea to ensure
382 * that the default values here still get set.
383 * I found the easiest way to do this and still set anything you want is to
384 * override it within your block in the following way
385 *
386 * <code php>
387 * function html_attributes() {
388 * $attributes = parent::html_attributes();
389 * $attributes['class'] .= ' mynewclass';
390 * return $attributes;
391 * }
392 * </code>
393 *
d4a03c00 394 * @return array attribute name => value.
c7e3bc51 395 */
c5507e52 396 function html_attributes() {
9d897331 397 $attributes = array(
4ca6cfbf 398 'id' => 'inst' . $this->instance->id,
697f7bd7
SH
399 'class' => 'block_' . $this->name(). ' block',
400 'role' => $this->get_aria_role()
2f747639 401 );
dc3337b2
AG
402 if ($this->hide_header()) {
403 $attributes['class'] .= ' no-header';
404 }
d2c394f3 405 if ($this->instance_can_be_docked() && get_user_preferences('docked_block_instance_'.$this->instance->id, 0)) {
9d897331
SH
406 $attributes['class'] .= ' dock_on_load';
407 }
408 return $attributes;
c5507e52 409 }
d4a03c00 410
c7e3bc51 411 /**
40928036 412 * Set up a particular instance of this class given data from the block_insances
4ca6cfbf 413 * table and the current page. (See {@link block_manager::load_blocks()}.)
40928036 414 *
415 * @param stdClass $instance data from block_insances, block_positions, etc.
416 * @param moodle_page $the page this block is on.
c7e3bc51 417 */
3179b000 418 function _load_instance($instance, $page) {
c7e3bc51 419 if (!empty($instance->configdata)) {
9b4b78fd 420 $this->config = unserialize(base64_decode($instance->configdata));
421 }
9b4b78fd 422 $this->instance = $instance;
fe2fdd11 423 $this->context = context_block::instance($instance->id);
3179b000 424 $this->page = $page;
9b4b78fd 425 $this->specialization();
9d897331
SH
426 }
427
84192d78
SH
428 /**
429 * Allows the block to load any JS it requires into the page.
430 *
431 * By default this function simply permits the user to dock the block if it is dockable.
432 */
9d897331 433 function get_required_javascript() {
46de77b6 434 if ($this->instance_can_be_docked() && !$this->hide_header()) {
9d897331
SH
435 user_preference_allow_ajax_update('docked_block_instance_'.$this->instance->id, PARAM_INT);
436 }
9b4b78fd 437 }
59b29207 438
43038ce6 439 /**
440 * This function is called on your subclass right after an instance is loaded
441 * Use this function to act on instance data just after it's loaded and before anything else is done
67677908 442 * For instance: if your block will have different title's depending on location (site, course, blog, etc)
43038ce6 443 */
9b4b78fd 444 function specialization() {
445 // Just to make sure that this method exists.
9b4b78fd 446 }
447
c7e3bc51 448 /**
f032aa7a 449 * Is each block of this type going to have instance-specific configuration?
40928036 450 * Normally, this setting is controlled by {@link instance_allow_multiple()}: if multiple
f032aa7a 451 * instances are allowed, then each will surely need its own configuration. However, in some
452 * cases it may be necessary to provide instance configuration to blocks that do not want to
453 * allow multiple instances. In that case, make this function return true.
40928036 454 * I stress again that this makes a difference ONLY if {@link instance_allow_multiple()} returns false.
f032aa7a 455 * @return boolean
f032aa7a 456 */
457 function instance_allow_config() {
458 return false;
459 }
460
461 /**
462 * Are you going to allow multiple instances of each block?
c7e3bc51 463 * If yes, then it is assumed that the block WILL USE per-instance configuration
464 * @return boolean
c7e3bc51 465 */
9b4b78fd 466 function instance_allow_multiple() {
467 // Are you going to allow multiple instances of each block?
468 // If yes, then it is assumed that the block WILL USE per-instance configuration
469 return false;
470 }
59b29207 471
c7e3bc51 472 /**
473 * Serialize and store config data
c7e3bc51 474 */
f474a4e5 475 function instance_config_save($data, $nolongerused = false) {
a5d424df 476 global $DB;
f474a4e5 477 $DB->set_field('block_instances', 'configdata', base64_encode(serialize($data)),
e03c0c1d 478 array('id' => $this->instance->id));
9b4b78fd 479 }
480
0144a0a7 481 /**
482 * Replace the instance's configuration data with those currently in $this->config;
0144a0a7 483 */
f474a4e5 484 function instance_config_commit($nolongerused = false) {
a5d424df 485 global $DB;
f474a4e5 486 $this->instance_config_save($this->config);
0144a0a7 487 }
488
d4a03c00 489 /**
b33dd23a 490 * Do any additional initialization you may need at the time a new block instance is created
491 * @return boolean
b33dd23a 492 */
493 function instance_create() {
494 return true;
495 }
496
ad5c3230
NL
497 /**
498 * Copy any block-specific data when copying to a new block instance.
499 * @param int $fromid the id number of the block instance to copy from
500 * @return boolean
501 */
502 public function instance_copy($fromid) {
503 return true;
504 }
505
d4a03c00 506 /**
b33dd23a 507 * Delete everything related to this instance if you have been using persistent storage other than the configdata field.
508 * @return boolean
b33dd23a 509 */
510 function instance_delete() {
511 return true;
512 }
513
d4a03c00 514 /**
11306331 515 * Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
516 * The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode)
517 * but if the framework does allow it, the block can still decide to refuse.
518 * @return boolean
11306331 519 */
520 function user_can_edit() {
03d9401e
MD
521 global $USER;
522
523 if (has_capability('moodle/block:edit', $this->context)) {
524 return true;
525 }
526
527 // The blocks in My Moodle are a special case. We want them to inherit from the user context.
528 if (!empty($USER->id)
529 && $this->instance->parentcontextid == $this->page->context->id // Block belongs to this page
530 && $this->page->context->contextlevel == CONTEXT_USER // Page belongs to a user
531 && $this->page->context->instanceid == $USER->id) { // Page belongs to this user
532 return has_capability('moodle/my:manageblocks', $this->page->context);
533 }
534
535 return false;
11306331 536 }
537
d4a03c00 538 /**
11306331 539 * Allows the block class to have a say in the user's ability to create new instances of this block.
540 * The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode)
541 * but if the framework does allow it, the block can still decide to refuse.
542 * This function has access to the complete page object, the creation related to which is being determined.
10a92c39
SH
543 *
544 * @param moodle_page $page
11306331 545 * @return boolean
11306331 546 */
15a00b4b 547 function user_can_addto($page) {
03d9401e
MD
548 global $USER;
549
03d9401e
MD
550 // The blocks in My Moodle are a special case and use a different capability.
551 if (!empty($USER->id)
b291b59d 552 && $page->context->contextlevel == CONTEXT_USER // Page belongs to a user
9b06b507
MN
553 && $page->context->instanceid == $USER->id // Page belongs to this user
554 && $page->pagetype == 'my-index') { // Ensure we are on the My Moodle page
b6d7cff6
AD
555
556 // If the block cannot be displayed on /my it is ok if the myaddinstance capability is not defined.
557 $formats = $this->applicable_formats();
558 // Is 'my' explicitly forbidden?
559 // If 'all' has not been allowed, has 'my' been explicitly allowed?
560 if ((isset($formats['my']) && $formats['my'] == false)
561 || (empty($formats['all']) && empty($formats['my']))) {
562
563 // Block cannot be added to /my regardless of capabilities.
564 return false;
565 } else {
566 $capability = 'block/' . $this->name() . ':myaddinstance';
567 return $this->has_add_block_capability($page, $capability)
568 && has_capability('moodle/my:manageblocks', $page->context);
569 }
03d9401e
MD
570 }
571
464e00be
MN
572 $capability = 'block/' . $this->name() . ':addinstance';
573 if ($this->has_add_block_capability($page, $capability)
574 && has_capability('moodle/block:edit', $page->context)) {
575 return true;
576 }
577
03d9401e 578 return false;
11306331 579 }
580
b291b59d
MN
581 /**
582 * Returns true if the user can add a block to a page.
583 *
584 * @param moodle_page $page
585 * @param string $capability the capability to check
586 * @return boolean true if user can add a block, false otherwise.
587 */
588 private function has_add_block_capability($page, $capability) {
589 // Check if the capability exists.
590 if (!get_capability_info($capability)) {
591 // Debug warning that the capability does not exist, but no more than once per page.
592 static $warned = array();
593 if (!isset($warned[$this->name()])) {
594 debugging('The block ' .$this->name() . ' does not define the standard capability ' .
595 $capability , DEBUG_DEVELOPER);
596 $warned[$this->name()] = 1;
597 }
598 // If the capability does not exist, the block can always be added.
599 return true;
600 } else {
601 return has_capability($capability, $page->context);
602 }
603 }
604
324d210f 605 static function get_extra_capabilities() {
d14edf06 606 return array('moodle/block:view', 'moodle/block:edit');
f432bebf 607 }
d4a03c00 608
d8ef60bd
SH
609 /**
610 * Can be overridden by the block to prevent the block from being dockable.
9c14c1c5 611 *
d8ef60bd
SH
612 * @return bool
613 */
d2c394f3
SH
614 public function instance_can_be_docked() {
615 global $CFG;
598ee317 616 return (!empty($CFG->allowblockstodock) && $this->page->theme->enable_dock);
9d897331
SH
617 }
618
d8ef60bd 619 /**
0885166f 620 * If overridden and set to false by the block it will not be hidable when
d8ef60bd
SH
621 * editing is turned on.
622 *
623 * @return bool
624 */
625 public function instance_can_be_hidden() {
626 return true;
627 }
628
0885166f
JC
629 /**
630 * If overridden and set to false by the block it will not be collapsible.
631 *
632 * @return bool
633 */
634 public function instance_can_be_collapsed() {
635 return true;
636 }
637
1bcb7eb5 638 /** @callback callback functions for comments api */
639 public static function comment_template($options) {
640 $ret = <<<EOD
4ca6cfbf 641<div class="comment-userpicture">___picture___</div>
1bcb7eb5 642<div class="comment-content">
643 ___name___ - <span>___time___</span>
644 <div>___content___</div>
645</div>
646EOD;
647 return $ret;
648 }
649 public static function comment_permissions($options) {
650 return array('view'=>true, 'post'=>true);
651 }
652 public static function comment_url($options) {
653 return null;
654 }
a0e68ffc
DC
655 public static function comment_display($comments, $options) {
656 return $comments;
1bcb7eb5 657 }
658 public static function comment_add(&$comments, $options) {
659 return true;
660 }
697f7bd7
SH
661
662 /**
663 * Returns the aria role attribute that best describes this block.
664 *
665 * Region is the default, but this should be overridden by a block is there is a region child, or even better
666 * a landmark child.
667 *
668 * Options are as follows:
697f7bd7
SH
669 * - landmark
670 * - application
671 * - banner
672 * - complementary
673 * - contentinfo
674 * - form
675 * - main
676 * - navigation
677 * - search
697f7bd7
SH
678 *
679 * @return string
680 */
681 public function get_aria_role() {
5c4581fc 682 return 'complementary';
697f7bd7 683 }
0f3fe4b6 684}
685
c7e3bc51 686/**
3ef642d9 687 * Specialized class for displaying a block with a list of icons/text labels
688 *
d4a03c00 689 * The get_content method should set $this->content->items and (optionally)
690 * $this->content->icons, instead of $this->content->text.
691 *
3ef642d9 692 * @author Jon Papaioannou
f25a6839 693 * @package core_block
3ef642d9 694 */
695
696class block_list extends block_base {
697 var $content_type = BLOCK_TYPE_LIST;
698
699 function is_empty() {
e92c286c 700 if ( !has_capability('moodle/block:view', $this->context) ) {
25a7d980 701 return true;
702 }
703
3ef642d9 704 $this->get_content();
705 return (empty($this->content->items) && empty($this->content->footer));
706 }
707
d4a03c00 708 protected function formatted_contents($output) {
709 $this->get_content();
dde36f9d 710 $this->get_required_javascript();
d4a03c00 711 if (!empty($this->content->items)) {
712 return $output->list_block_contents($this->content->icons, $this->content->items);
3ef642d9 713 } else {
d4a03c00 714 return '';
3ef642d9 715 }
716 }
740952e4
SH
717
718 function html_attributes() {
719 $attributes = parent::html_attributes();
720 $attributes['class'] .= ' list_block';
721 return $attributes;
722 }
723
3ef642d9 724}
725
7d2a0492 726/**
727 * Specialized class for displaying a tree menu.
4ca6cfbf 728 *
7d2a0492 729 * The {@link get_content()} method involves setting the content of
730 * <code>$this->content->items</code> with an array of {@link tree_item}
731 * objects (these are the top-level nodes). The {@link tree_item::children}
732 * property may contain more tree_item objects, and so on. The tree_item class
733 * itself is abstract and not intended for use, use one of it's subclasses.
4ca6cfbf 734 *
7d2a0492 735 * Unlike {@link block_list}, the icons are specified as part of the items,
736 * not in a separate array.
737 *
738 * @author Alan Trick
f25a6839 739 * @package core_block
7d2a0492 740 * @internal this extends block_list so we get is_empty() for free
741 */
742class block_tree extends block_list {
4ca6cfbf 743
7d2a0492 744 /**
745 * @var int specifies the manner in which contents should be added to this
746 * block type. In this case <code>$this->content->items</code> is used with
747 * {@link tree_item}s.
748 */
749 public $content_type = BLOCK_TYPE_TREE;
4ca6cfbf 750
7d2a0492 751 /**
752 * Make the formatted HTML ouput.
4ca6cfbf 753 *
7d2a0492 754 * Also adds the required javascript call to the page output.
755 *
78946b9b 756 * @param core_renderer $output
7d2a0492 757 * @return string HTML
758 */
759 protected function formatted_contents($output) {
760 // based of code in admin_tree
761 global $PAGE; // TODO change this when there is a proper way for blocks to get stuff into head.
762 static $eventattached;
763 if ($eventattached===null) {
764 $eventattached = true;
765 }
766 if (!$this->content) {
767 $this->content = new stdClass;
768 $this->content->items = array();
769 }
d5cbccb3 770 $this->get_required_javascript();
7d2a0492 771 $this->get_content();
1ce15fda 772 $content = $output->tree_block_contents($this->content->items,array('class'=>'block_tree list'));
7d2a0492 773 if (isset($this->id) && !is_numeric($this->id)) {
774 $content = $output->box($content, 'block_tree_box', $this->id);
775 }
776 return $content;
777 }
a0e68ffc 778}