2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * This file contains the parent class for moodle blocks, block_base.
21 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
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.
29 define('BLOCK_TYPE_LIST', 1);
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.
34 define('BLOCK_TYPE_TEXT', 2);
36 * Block type of tree. $this->content->items is a list of tree_item objects and $this->content->footer is a string.
38 define('BLOCK_TYPE_TREE', 3);
41 * Class for describing a moodle block, all Moodle blocks derive from this class
43 * @author Jon Papaioannou
49 * Internal var for storing/caching translated strings
55 * The title of the block to be displayed in the block title area.
61 * The name of the block to be displayed in the block title area if the title is empty.
62 * @var string arialabel
64 var $arialabel = NULL;
67 * The type of content that this block creates. Currently support options - BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT
68 * @var int $content_type
70 var $content_type = BLOCK_TYPE_TEXT
;
73 * An object to contain the information to be displayed in the block.
74 * @var stdObject $content
79 * A string generated by {@link _add_edit_controls()} to display block manipulation links when the user is in editing mode.
80 * @var string $edit_controls
82 var $edit_controls = NULL;
85 * The initialized instance of this block object.
86 * @var block $instance
91 * The page that this block is appearing on.
97 * This blocks's context.
100 public $context = NULL;
103 * An object containing the instance configuration information for the current instance of this block.
104 * @var stdObject $config
109 * How often the cronjob should run, 0 if not at all.
118 * Fake constructor to keep PHP5 happy
121 function __construct() {
126 * Function that can be overridden to do extra cleanup before
127 * the database tables are deleted. (Called once per block, not per instance!)
129 function before_delete() {
133 * Returns the block name, as present in the class name,
134 * the database, the block directory, etc etc.
139 // Returns the block name, as present in the class name,
140 // the database, the block directory, etc etc.
142 if ($myname === NULL) {
143 $myname = strtolower(get_class($this));
144 $myname = substr($myname, strpos($myname, '_') +
1);
150 * Parent class version of this function simply returns NULL
151 * This should be implemented by the derived class to return
152 * the content object.
156 function get_content() {
157 // This should be implemented by the derived class.
162 * Returns the class $title var value.
164 * Intentionally doesn't check if a title is set.
165 * This is already done in {@link _self_test()}
167 * @return string $this->title
169 function get_title() {
170 // Intentionally doesn't check if a title is set. This is already done in _self_test()
175 * Returns the class $content_type var value.
177 * Intentionally doesn't check if content_type is set.
178 * This is already done in {@link _self_test()}
180 * @return string $this->content_type
182 function get_content_type() {
183 // Intentionally doesn't check if a content_type is set. This is already done in _self_test()
184 return $this->content_type
;
188 * Returns true or false, depending on whether this block has any content to display
189 * and whether the user has permission to view the block
193 function is_empty() {
194 if ( !has_capability('moodle/block:view', $this->context
) ) {
198 $this->get_content();
199 return(empty($this->content
->text
) && empty($this->content
->footer
));
203 * First sets the current value of $this->content to NULL
204 * then calls the block's {@link get_content()} function
205 * to set its value back.
209 function refresh_content() {
210 // Nothing special here, depends on content()
211 $this->content
= NULL;
212 return $this->get_content();
216 * Return a block_contents object representing the full contents of this block.
218 * This internally calls ->get_content(), and then adds the editing controls etc.
220 * You probably should not override this method, but instead override
221 * {@link html_attributes()}, {@link formatted_contents()} or {@link get_content()},
222 * {@link hide_header()}, {@link (get_edit_controls)}, etc.
224 * @return block_contents a representation of the block, for rendering.
227 public function get_content_for_output($output) {
230 $bc = new block_contents($this->html_attributes());
231 $bc->attributes
['data-block'] = $this->name();
232 $bc->blockinstanceid
= $this->instance
->id
;
233 $bc->blockpositionid
= $this->instance
->blockpositionid
;
235 if ($this->instance
->visible
) {
236 $bc->content
= $this->formatted_contents($output);
237 if (!empty($this->content
->footer
)) {
238 $bc->footer
= $this->content
->footer
;
241 $bc->add_class('invisible');
244 if (!$this->hide_header()) {
245 $bc->title
= $this->title
;
248 if (empty($bc->title
)) {
249 $bc->arialabel
= new lang_string('pluginname', get_class($this));
250 $this->arialabel
= $bc->arialabel
;
253 if ($this->page
->user_is_editing()) {
254 $bc->controls
= $this->page
->blocks
->edit_controls($this);
256 // we must not use is_empty on hidden blocks
257 if ($this->is_empty() && !$bc->controls
) {
262 if (empty($CFG->allowuserblockhiding
)
263 ||
(empty($bc->content
) && empty($bc->footer
))
264 ||
!$this->instance_can_be_collapsed()) {
265 $bc->collapsible
= block_contents
::NOT_HIDEABLE
;
266 } else if (get_user_preferences('block' . $bc->blockinstanceid
. 'hidden', false)) {
267 $bc->collapsible
= block_contents
::HIDDEN
;
269 $bc->collapsible
= block_contents
::VISIBLE
;
272 if ($this->instance_can_be_docked() && !$this->hide_header()) {
273 $bc->dockable
= true;
276 $bc->annotation
= ''; // TODO MDL-19398 need to work out what to say here.
282 * Convert the contents of the block to HTML.
284 * This is used by block base classes like block_list to convert the structured
285 * $this->content->list and $this->content->icons arrays to HTML. So, in most
286 * blocks, you probaby want to override the {@link get_contents()} method,
287 * which generates that structured representation of the contents.
289 * @param $output The core_renderer to use when generating the output.
290 * @return string the HTML that should appearn in the body of the block.
293 protected function formatted_contents($output) {
294 $this->get_content();
295 $this->get_required_javascript();
296 if (!empty($this->content
->text
)) {
297 return $this->content
->text
;
304 * Tests if this block has been implemented correctly.
305 * Also, $errors isn't used right now
310 function _self_test() {
311 // Tests if this block has been implemented correctly.
312 // Also, $errors isn't used right now
316 if ($this->get_title() === NULL) {
317 $errors[] = 'title_not_set';
320 if (!in_array($this->get_content_type(), array(BLOCK_TYPE_LIST
, BLOCK_TYPE_TEXT
, BLOCK_TYPE_TREE
))) {
321 $errors[] = 'invalid_content_type';
324 //following selftest was not working when roles&capabilities were used from block
325 /* if ($this->get_content() === NULL) {
326 $errors[] = 'content_not_set';
329 $formats = $this->applicable_formats();
330 if (empty($formats) ||
array_sum($formats) === 0) {
331 $errors[] = 'no_formats';
335 $width = $this->preferred_width();
336 if (!is_int($width) ||
$width <= 0) {
337 $errors[] = 'invalid_width';
344 * Subclasses should override this and return true if the
345 * subclass block has a settings.php file.
349 function has_config() {
354 * Default behavior: save all variables as $CFG properties
355 * You don't need to override this if you 're satisfied with the above
360 function config_save($data) {
361 foreach ($data as $name => $value) {
362 set_config($name, $value);
368 * Which page types this block may appear on.
370 * The information returned here is processed by the
371 * {@link blocks_name_allowed_in_format()} function. Look there if you need
372 * to know exactly how this works.
374 * Default case: everything except mod and tag.
376 * @return array page-type prefix => true/false.
378 function applicable_formats() {
379 // Default case: the block can be used in courses and site index, but not in activities
380 return array('all' => true, 'mod' => false, 'tag' => false);
385 * Default return is false - header will be shown
388 function hide_header() {
393 * Return any HTML attributes that you want added to the outer <div> that
394 * of the block when it is output.
396 * Because of the way certain JS events are wired it is a good idea to ensure
397 * that the default values here still get set.
398 * I found the easiest way to do this and still set anything you want is to
399 * override it within your block in the following way
402 * function html_attributes() {
403 * $attributes = parent::html_attributes();
404 * $attributes['class'] .= ' mynewclass';
405 * return $attributes;
409 * @return array attribute name => value.
411 function html_attributes() {
413 'id' => 'inst' . $this->instance
->id
,
414 'class' => 'block_' . $this->name(). ' block',
415 'role' => $this->get_aria_role()
417 if ($this->hide_header()) {
418 $attributes['class'] .= ' no-header';
420 if ($this->instance_can_be_docked() && get_user_preferences('docked_block_instance_'.$this->instance
->id
, 0)) {
421 $attributes['class'] .= ' dock_on_load';
427 * Set up a particular instance of this class given data from the block_insances
428 * table and the current page. (See {@link block_manager::load_blocks()}.)
430 * @param stdClass $instance data from block_insances, block_positions, etc.
431 * @param moodle_page $the page this block is on.
433 function _load_instance($instance, $page) {
434 if (!empty($instance->configdata
)) {
435 $this->config
= unserialize(base64_decode($instance->configdata
));
437 $this->instance
= $instance;
438 $this->context
= context_block
::instance($instance->id
);
440 $this->specialization();
444 * Allows the block to load any JS it requires into the page.
446 * By default this function simply permits the user to dock the block if it is dockable.
448 function get_required_javascript() {
449 if ($this->instance_can_be_docked() && !$this->hide_header()) {
450 user_preference_allow_ajax_update('docked_block_instance_'.$this->instance
->id
, PARAM_INT
);
455 * This function is called on your subclass right after an instance is loaded
456 * Use this function to act on instance data just after it's loaded and before anything else is done
457 * For instance: if your block will have different title's depending on location (site, course, blog, etc)
459 function specialization() {
460 // Just to make sure that this method exists.
464 * Is each block of this type going to have instance-specific configuration?
465 * Normally, this setting is controlled by {@link instance_allow_multiple()}: if multiple
466 * instances are allowed, then each will surely need its own configuration. However, in some
467 * cases it may be necessary to provide instance configuration to blocks that do not want to
468 * allow multiple instances. In that case, make this function return true.
469 * I stress again that this makes a difference ONLY if {@link instance_allow_multiple()} returns false.
472 function instance_allow_config() {
477 * Are you going to allow multiple instances of each block?
478 * If yes, then it is assumed that the block WILL USE per-instance configuration
481 function instance_allow_multiple() {
482 // Are you going to allow multiple instances of each block?
483 // If yes, then it is assumed that the block WILL USE per-instance configuration
488 * Default behavior: print the config_instance.html file
489 * You don't need to override this if you're satisfied with the above
491 * @deprecated since Moodle 2.0.
492 * @return boolean whether anything was done. Blocks should use edit_form.php.
494 function instance_config_print() {
495 global $CFG, $DB, $OUTPUT;
496 // Default behavior: print the config_instance.html file
497 // You don't need to override this if you're satisfied with the above
498 if (!$this->instance_allow_multiple() && !$this->instance_allow_config()) {
502 if (is_file($CFG->dirroot
.'/blocks/'. $this->name() .'/config_instance.html')) {
503 echo $OUTPUT->box_start('generalbox boxaligncenter blockconfiginstance');
504 include($CFG->dirroot
.'/blocks/'. $this->name() .'/config_instance.html');
505 echo $OUTPUT->box_end();
507 notice(get_string('blockconfigbad'), str_replace('blockaction=', 'dummy=', qualified_me()));
514 * Serialize and store config data
516 function instance_config_save($data, $nolongerused = false) {
518 $DB->set_field('block_instances', 'configdata', base64_encode(serialize($data)),
519 array('id' => $this->instance
->id
));
523 * Replace the instance's configuration data with those currently in $this->config;
525 function instance_config_commit($nolongerused = false) {
527 $this->instance_config_save($this->config
);
531 * Do any additional initialization you may need at the time a new block instance is created
534 function instance_create() {
539 * Delete everything related to this instance if you have been using persistent storage other than the configdata field.
542 function instance_delete() {
547 * Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
548 * The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode)
549 * but if the framework does allow it, the block can still decide to refuse.
552 function user_can_edit() {
555 if (has_capability('moodle/block:edit', $this->context
)) {
559 // The blocks in My Moodle are a special case. We want them to inherit from the user context.
560 if (!empty($USER->id
)
561 && $this->instance
->parentcontextid
== $this->page
->context
->id
// Block belongs to this page
562 && $this->page
->context
->contextlevel
== CONTEXT_USER
// Page belongs to a user
563 && $this->page
->context
->instanceid
== $USER->id
) { // Page belongs to this user
564 return has_capability('moodle/my:manageblocks', $this->page
->context
);
571 * Allows the block class to have a say in the user's ability to create new instances of this block.
572 * The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode)
573 * but if the framework does allow it, the block can still decide to refuse.
574 * This function has access to the complete page object, the creation related to which is being determined.
576 * @param moodle_page $page
579 function user_can_addto($page) {
582 // The blocks in My Moodle are a special case and use a different capability.
583 if (!empty($USER->id
)
584 && $page->context
->contextlevel
== CONTEXT_USER
// Page belongs to a user
585 && $page->context
->instanceid
== $USER->id
// Page belongs to this user
586 && $page->pagetype
== 'my-index') { // Ensure we are on the My Moodle page
588 // If the block cannot be displayed on /my it is ok if the myaddinstance capability is not defined.
589 $formats = $this->applicable_formats();
590 // Is 'my' explicitly forbidden?
591 // If 'all' has not been allowed, has 'my' been explicitly allowed?
592 if ((isset($formats['my']) && $formats['my'] == false)
593 ||
(empty($formats['all']) && empty($formats['my']))) {
595 // Block cannot be added to /my regardless of capabilities.
598 $capability = 'block/' . $this->name() . ':myaddinstance';
599 return $this->has_add_block_capability($page, $capability)
600 && has_capability('moodle/my:manageblocks', $page->context
);
604 $capability = 'block/' . $this->name() . ':addinstance';
605 if ($this->has_add_block_capability($page, $capability)
606 && has_capability('moodle/block:edit', $page->context
)) {
614 * Returns true if the user can add a block to a page.
616 * @param moodle_page $page
617 * @param string $capability the capability to check
618 * @return boolean true if user can add a block, false otherwise.
620 private function has_add_block_capability($page, $capability) {
621 // Check if the capability exists.
622 if (!get_capability_info($capability)) {
623 // Debug warning that the capability does not exist, but no more than once per page.
624 static $warned = array();
625 if (!isset($warned[$this->name()])) {
626 debugging('The block ' .$this->name() . ' does not define the standard capability ' .
627 $capability , DEBUG_DEVELOPER
);
628 $warned[$this->name()] = 1;
630 // If the capability does not exist, the block can always be added.
633 return has_capability($capability, $page->context
);
637 static function get_extra_capabilities() {
638 return array('moodle/block:view', 'moodle/block:edit');
641 // Methods deprecated in Moodle 2.0 ========================================
644 * Default case: the block wants to be 180 pixels wide
645 * @deprecated since Moodle 2.0.
648 function preferred_width() {
652 /** @deprecated since Moodle 2.0. */
653 function _print_block() {
654 throw new coding_exception('_print_block is no longer used. It was a private ' .
655 'method of the block class, only for use by the blocks system. You ' .
656 'should not have been calling it anyway.');
659 /** @deprecated since Moodle 2.0. */
660 function _print_shadow() {
661 throw new coding_exception('_print_shadow is no longer used. It was a private ' .
662 'method of the block class, only for use by the blocks system. You ' .
663 'should not have been calling it anyway.');
666 /** @deprecated since Moodle 2.0. */
667 function _title_html() {
668 throw new coding_exception('_title_html is no longer used. It was a private ' .
669 'method of the block class, only for use by the blocks system. You ' .
670 'should not have been calling it anyway.');
673 /** @deprecated since Moodle 2.0. */
674 function _add_edit_controls() {
675 throw new coding_exception('_add_edit_controls is no longer used. It was a private ' .
676 'method of the block class, only for use by the blocks system. You ' .
677 'should not have been calling it anyway.');
680 /** @deprecated since Moodle 2.0. */
681 function config_print() {
682 throw new coding_exception('config_print() can no longer be used. Blocks should use a settings.php file.');
686 * Can be overridden by the block to prevent the block from being dockable.
690 public function instance_can_be_docked() {
692 return (!empty($CFG->allowblockstodock
) && $this->page
->theme
->enable_dock
);
696 * If overridden and set to false by the block it will not be hidable when
697 * editing is turned on.
701 public function instance_can_be_hidden() {
706 * If overridden and set to false by the block it will not be collapsible.
710 public function instance_can_be_collapsed() {
714 /** @callback callback functions for comments api */
715 public static function comment_template($options) {
717 <div class="comment-userpicture">___picture___</div>
718 <div class="comment-content">
719 ___name___ - <span>___time___</span>
720 <div>___content___</div>
725 public static function comment_permissions($options) {
726 return array('view'=>true, 'post'=>true);
728 public static function comment_url($options) {
731 public static function comment_display($comments, $options) {
734 public static function comment_add(&$comments, $options) {
739 * Returns the aria role attribute that best describes this block.
741 * Region is the default, but this should be overridden by a block is there is a region child, or even better
744 * Options are as follows:
757 public function get_aria_role() {
758 return 'complementary';
763 * Specialized class for displaying a block with a list of icons/text labels
765 * The get_content method should set $this->content->items and (optionally)
766 * $this->content->icons, instead of $this->content->text.
768 * @author Jon Papaioannou
769 * @package core_block
772 class block_list
extends block_base
{
773 var $content_type = BLOCK_TYPE_LIST
;
775 function is_empty() {
776 if ( !has_capability('moodle/block:view', $this->context
) ) {
780 $this->get_content();
781 return (empty($this->content
->items
) && empty($this->content
->footer
));
784 protected function formatted_contents($output) {
785 $this->get_content();
786 $this->get_required_javascript();
787 if (!empty($this->content
->items
)) {
788 return $output->list_block_contents($this->content
->icons
, $this->content
->items
);
794 function html_attributes() {
795 $attributes = parent
::html_attributes();
796 $attributes['class'] .= ' list_block';
803 * Specialized class for displaying a tree menu.
805 * The {@link get_content()} method involves setting the content of
806 * <code>$this->content->items</code> with an array of {@link tree_item}
807 * objects (these are the top-level nodes). The {@link tree_item::children}
808 * property may contain more tree_item objects, and so on. The tree_item class
809 * itself is abstract and not intended for use, use one of it's subclasses.
811 * Unlike {@link block_list}, the icons are specified as part of the items,
812 * not in a separate array.
815 * @package core_block
816 * @internal this extends block_list so we get is_empty() for free
818 class block_tree
extends block_list
{
821 * @var int specifies the manner in which contents should be added to this
822 * block type. In this case <code>$this->content->items</code> is used with
823 * {@link tree_item}s.
825 public $content_type = BLOCK_TYPE_TREE
;
828 * Make the formatted HTML ouput.
830 * Also adds the required javascript call to the page output.
832 * @param core_renderer $output
833 * @return string HTML
835 protected function formatted_contents($output) {
836 // based of code in admin_tree
837 global $PAGE; // TODO change this when there is a proper way for blocks to get stuff into head.
838 static $eventattached;
839 if ($eventattached===null) {
840 $eventattached = true;
842 if (!$this->content
) {
843 $this->content
= new stdClass
;
844 $this->content
->items
= array();
846 $this->get_required_javascript();
847 $this->get_content();
848 $content = $output->tree_block_contents($this->content
->items
,array('class'=>'block_tree list'));
849 if (isset($this->id
) && !is_numeric($this->id
)) {
850 $content = $output->box($content, 'block_tree_box', $this->id
);