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 * The initialized instance of this block object.
80 * @var block $instance
85 * The page that this block is appearing on.
91 * This blocks's context.
94 public $context = NULL;
97 * An object containing the instance configuration information for the current instance of this block.
98 * @var stdObject $config
103 * How often the cronjob should run, 0 if not at all.
112 * Fake constructor to keep PHP5 happy
115 function __construct() {
120 * Function that can be overridden to do extra cleanup before
121 * the database tables are deleted. (Called once per block, not per instance!)
123 function before_delete() {
127 * Returns the block name, as present in the class name,
128 * the database, the block directory, etc etc.
133 // Returns the block name, as present in the class name,
134 // the database, the block directory, etc etc.
136 if ($myname === NULL) {
137 $myname = strtolower(get_class($this));
138 $myname = substr($myname, strpos($myname, '_') +
1);
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.
150 function get_content() {
151 // This should be implemented by the derived class.
156 * Returns the class $title var value.
158 * Intentionally doesn't check if a title is set.
159 * This is already done in {@link _self_test()}
161 * @return string $this->title
163 function get_title() {
164 // Intentionally doesn't check if a title is set. This is already done in _self_test()
169 * Returns the class $content_type var value.
171 * Intentionally doesn't check if content_type is set.
172 * This is already done in {@link _self_test()}
174 * @return string $this->content_type
176 function get_content_type() {
177 // Intentionally doesn't check if a content_type is set. This is already done in _self_test()
178 return $this->content_type
;
182 * Returns true or false, depending on whether this block has any content to display
183 * and whether the user has permission to view the block
187 function is_empty() {
188 if ( !has_capability('moodle/block:view', $this->context
) ) {
192 $this->get_content();
193 return(empty($this->content
->text
) && empty($this->content
->footer
));
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.
203 function refresh_content() {
204 // Nothing special here, depends on content()
205 $this->content
= NULL;
206 return $this->get_content();
210 * Return a block_contents object representing the full contents of this block.
212 * This internally calls ->get_content(), and then adds the editing controls etc.
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.
218 * @return block_contents a representation of the block, for rendering.
221 public function get_content_for_output($output) {
224 $bc = new block_contents($this->html_attributes());
225 $bc->attributes
['data-block'] = $this->name();
226 $bc->blockinstanceid
= $this->instance
->id
;
227 $bc->blockpositionid
= $this->instance
->blockpositionid
;
229 if ($this->instance
->visible
) {
230 $bc->content
= $this->formatted_contents($output);
231 if (!empty($this->content
->footer
)) {
232 $bc->footer
= $this->content
->footer
;
235 $bc->add_class('invisible');
238 if (!$this->hide_header()) {
239 $bc->title
= $this->title
;
242 if (empty($bc->title
)) {
243 $bc->arialabel
= new lang_string('pluginname', get_class($this));
244 $this->arialabel
= $bc->arialabel
;
247 if ($this->page
->user_is_editing()) {
248 $bc->controls
= $this->page
->blocks
->edit_controls($this);
250 // we must not use is_empty on hidden blocks
251 if ($this->is_empty() && !$bc->controls
) {
256 if (empty($CFG->allowuserblockhiding
)
257 ||
(empty($bc->content
) && empty($bc->footer
))
258 ||
!$this->instance_can_be_collapsed()) {
259 $bc->collapsible
= block_contents
::NOT_HIDEABLE
;
260 } else if (get_user_preferences('block' . $bc->blockinstanceid
. 'hidden', false)) {
261 $bc->collapsible
= block_contents
::HIDDEN
;
263 $bc->collapsible
= block_contents
::VISIBLE
;
266 if ($this->instance_can_be_docked() && !$this->hide_header()) {
267 $bc->dockable
= true;
270 $bc->annotation
= ''; // TODO MDL-19398 need to work out what to say here.
277 * Return an object containing all the block content to be returned by external functions.
279 * If your block is returning formatted content or provide files for download, you should override this method to use the
280 * external_format_text, external_format_string functions for formatting or external_util::get_area_files for files.
282 * @param core_renderer $output the rendered used for output
283 * @return stdClass object containing the block title, central content, footer and linked files (if any).
286 public function get_content_for_external($output) {
290 $bc->contentformat
= FORMAT_HTML
;
294 if ($this->instance
->visible
) {
295 $bc->content
= $this->formatted_contents($output);
296 if (!empty($this->content
->footer
)) {
297 $bc->footer
= $this->content
->footer
;
301 if (!$this->hide_header()) {
302 $bc->title
= $this->title
;
309 * Convert the contents of the block to HTML.
311 * This is used by block base classes like block_list to convert the structured
312 * $this->content->list and $this->content->icons arrays to HTML. So, in most
313 * blocks, you probaby want to override the {@link get_contents()} method,
314 * which generates that structured representation of the contents.
316 * @param $output The core_renderer to use when generating the output.
317 * @return string the HTML that should appearn in the body of the block.
320 protected function formatted_contents($output) {
321 $this->get_content();
322 $this->get_required_javascript();
323 if (!empty($this->content
->text
)) {
324 return $this->content
->text
;
331 * Tests if this block has been implemented correctly.
332 * Also, $errors isn't used right now
337 function _self_test() {
338 // Tests if this block has been implemented correctly.
339 // Also, $errors isn't used right now
343 if ($this->get_title() === NULL) {
344 $errors[] = 'title_not_set';
347 if (!in_array($this->get_content_type(), array(BLOCK_TYPE_LIST
, BLOCK_TYPE_TEXT
, BLOCK_TYPE_TREE
))) {
348 $errors[] = 'invalid_content_type';
351 //following selftest was not working when roles&capabilities were used from block
352 /* if ($this->get_content() === NULL) {
353 $errors[] = 'content_not_set';
356 $formats = $this->applicable_formats();
357 if (empty($formats) ||
array_sum($formats) === 0) {
358 $errors[] = 'no_formats';
366 * Subclasses should override this and return true if the
367 * subclass block has a settings.php file.
371 function has_config() {
376 * Default behavior: save all variables as $CFG properties
377 * You don't need to override this if you 're satisfied with the above
379 * @deprecated since Moodle 2.9 MDL-49385 - Please use Admin Settings functionality to save block configuration.
381 function config_save($data) {
382 throw new coding_exception('config_save() can not be used any more, use Admin Settings functionality to save block configuration.');
386 * Which page types this block may appear on.
388 * The information returned here is processed by the
389 * {@link blocks_name_allowed_in_format()} function. Look there if you need
390 * to know exactly how this works.
392 * Default case: everything except mod and tag.
394 * @return array page-type prefix => true/false.
396 function applicable_formats() {
397 // Default case: the block can be used in courses and site index, but not in activities
398 return array('all' => true, 'mod' => false, 'tag' => false);
403 * Default return is false - header will be shown
406 function hide_header() {
411 * Return any HTML attributes that you want added to the outer <div> that
412 * of the block when it is output.
414 * Because of the way certain JS events are wired it is a good idea to ensure
415 * that the default values here still get set.
416 * I found the easiest way to do this and still set anything you want is to
417 * override it within your block in the following way
420 * function html_attributes() {
421 * $attributes = parent::html_attributes();
422 * $attributes['class'] .= ' mynewclass';
423 * return $attributes;
427 * @return array attribute name => value.
429 function html_attributes() {
431 'id' => 'inst' . $this->instance
->id
,
432 'class' => 'block_' . $this->name(). ' block',
433 'role' => $this->get_aria_role()
435 if ($this->hide_header()) {
436 $attributes['class'] .= ' no-header';
438 if ($this->instance_can_be_docked() && get_user_preferences('docked_block_instance_'.$this->instance
->id
, 0)) {
439 $attributes['class'] .= ' dock_on_load';
445 * Set up a particular instance of this class given data from the block_insances
446 * table and the current page. (See {@link block_manager::load_blocks()}.)
448 * @param stdClass $instance data from block_insances, block_positions, etc.
449 * @param moodle_page $the page this block is on.
451 function _load_instance($instance, $page) {
452 if (!empty($instance->configdata
)) {
453 $this->config
= unserialize(base64_decode($instance->configdata
));
455 $this->instance
= $instance;
456 $this->context
= context_block
::instance($instance->id
);
458 $this->specialization();
462 * Allows the block to load any JS it requires into the page.
464 * By default this function simply permits the user to dock the block if it is dockable.
466 function get_required_javascript() {
467 if ($this->instance_can_be_docked() && !$this->hide_header()) {
468 user_preference_allow_ajax_update('docked_block_instance_'.$this->instance
->id
, PARAM_INT
);
473 * This function is called on your subclass right after an instance is loaded
474 * Use this function to act on instance data just after it's loaded and before anything else is done
475 * For instance: if your block will have different title's depending on location (site, course, blog, etc)
477 function specialization() {
478 // Just to make sure that this method exists.
482 * Is each block of this type going to have instance-specific configuration?
483 * Normally, this setting is controlled by {@link instance_allow_multiple()}: if multiple
484 * instances are allowed, then each will surely need its own configuration. However, in some
485 * cases it may be necessary to provide instance configuration to blocks that do not want to
486 * allow multiple instances. In that case, make this function return true.
487 * I stress again that this makes a difference ONLY if {@link instance_allow_multiple()} returns false.
490 function instance_allow_config() {
495 * Are you going to allow multiple instances of each block?
496 * If yes, then it is assumed that the block WILL USE per-instance configuration
499 function instance_allow_multiple() {
500 // Are you going to allow multiple instances of each block?
501 // If yes, then it is assumed that the block WILL USE per-instance configuration
506 * Serialize and store config data
508 function instance_config_save($data, $nolongerused = false) {
510 $DB->update_record('block_instances', ['id' => $this->instance
->id
,
511 'configdata' => base64_encode(serialize($data)), 'timemodified' => time()]);
515 * Replace the instance's configuration data with those currently in $this->config;
517 function instance_config_commit($nolongerused = false) {
519 $this->instance_config_save($this->config
);
523 * Do any additional initialization you may need at the time a new block instance is created
526 function instance_create() {
531 * Copy any block-specific data when copying to a new block instance.
532 * @param int $fromid the id number of the block instance to copy from
535 public function instance_copy($fromid) {
540 * Delete everything related to this instance if you have been using persistent storage other than the configdata field.
543 function instance_delete() {
548 * Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
549 * The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode)
550 * but if the framework does allow it, the block can still decide to refuse.
553 function user_can_edit() {
556 if (has_capability('moodle/block:edit', $this->context
)) {
560 // The blocks in My Moodle are a special case. We want them to inherit from the user context.
561 if (!empty($USER->id
)
562 && $this->instance
->parentcontextid
== $this->page
->context
->id
// Block belongs to this page
563 && $this->page
->context
->contextlevel
== CONTEXT_USER
// Page belongs to a user
564 && $this->page
->context
->instanceid
== $USER->id
) { // Page belongs to this user
565 return has_capability('moodle/my:manageblocks', $this->page
->context
);
572 * Allows the block class to have a say in the user's ability to create new instances of this block.
573 * The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode)
574 * but if the framework does allow it, the block can still decide to refuse.
575 * This function has access to the complete page object, the creation related to which is being determined.
577 * @param moodle_page $page
580 function user_can_addto($page) {
583 // The blocks in My Moodle are a special case and use a different capability.
584 if (!empty($USER->id
)
585 && $page->context
->contextlevel
== CONTEXT_USER
// Page belongs to a user
586 && $page->context
->instanceid
== $USER->id
// Page belongs to this user
587 && $page->pagetype
== 'my-index') { // Ensure we are on the My Moodle page
589 // If the block cannot be displayed on /my it is ok if the myaddinstance capability is not defined.
590 $formats = $this->applicable_formats();
591 // Is 'my' explicitly forbidden?
592 // If 'all' has not been allowed, has 'my' been explicitly allowed?
593 if ((isset($formats['my']) && $formats['my'] == false)
594 ||
(empty($formats['all']) && empty($formats['my']))) {
596 // Block cannot be added to /my regardless of capabilities.
599 $capability = 'block/' . $this->name() . ':myaddinstance';
600 return $this->has_add_block_capability($page, $capability)
601 && has_capability('moodle/my:manageblocks', $page->context
);
605 $capability = 'block/' . $this->name() . ':addinstance';
606 if ($this->has_add_block_capability($page, $capability)
607 && has_capability('moodle/block:edit', $page->context
)) {
615 * Returns true if the user can add a block to a page.
617 * @param moodle_page $page
618 * @param string $capability the capability to check
619 * @return boolean true if user can add a block, false otherwise.
621 private function has_add_block_capability($page, $capability) {
622 // Check if the capability exists.
623 if (!get_capability_info($capability)) {
624 // Debug warning that the capability does not exist, but no more than once per page.
625 static $warned = array();
626 if (!isset($warned[$this->name()])) {
627 debugging('The block ' .$this->name() . ' does not define the standard capability ' .
628 $capability , DEBUG_DEVELOPER
);
629 $warned[$this->name()] = 1;
631 // If the capability does not exist, the block can always be added.
634 return has_capability($capability, $page->context
);
638 static function get_extra_capabilities() {
639 return array('moodle/block:view', 'moodle/block:edit');
643 * Can be overridden by the block to prevent the block from being dockable.
647 public function instance_can_be_docked() {
649 return (!empty($CFG->allowblockstodock
) && $this->page
->theme
->enable_dock
);
653 * If overridden and set to false by the block it will not be hidable when
654 * editing is turned on.
658 public function instance_can_be_hidden() {
663 * If overridden and set to false by the block it will not be collapsible.
667 public function instance_can_be_collapsed() {
671 /** @callback callback functions for comments api */
672 public static function comment_template($options) {
674 <div class="comment-userpicture">___picture___</div>
675 <div class="comment-content">
676 ___name___ - <span>___time___</span>
677 <div>___content___</div>
682 public static function comment_permissions($options) {
683 return array('view'=>true, 'post'=>true);
685 public static function comment_url($options) {
688 public static function comment_display($comments, $options) {
691 public static function comment_add(&$comments, $options) {
696 * Returns the aria role attribute that best describes this block.
698 * Region is the default, but this should be overridden by a block is there is a region child, or even better
701 * Options are as follows:
714 public function get_aria_role() {
715 return 'complementary';
720 * Specialized class for displaying a block with a list of icons/text labels
722 * The get_content method should set $this->content->items and (optionally)
723 * $this->content->icons, instead of $this->content->text.
725 * @author Jon Papaioannou
726 * @package core_block
729 class block_list
extends block_base
{
730 var $content_type = BLOCK_TYPE_LIST
;
732 function is_empty() {
733 if ( !has_capability('moodle/block:view', $this->context
) ) {
737 $this->get_content();
738 return (empty($this->content
->items
) && empty($this->content
->footer
));
741 protected function formatted_contents($output) {
742 $this->get_content();
743 $this->get_required_javascript();
744 if (!empty($this->content
->items
)) {
745 return $output->list_block_contents($this->content
->icons
, $this->content
->items
);
751 function html_attributes() {
752 $attributes = parent
::html_attributes();
753 $attributes['class'] .= ' list_block';
760 * Specialized class for displaying a tree menu.
762 * The {@link get_content()} method involves setting the content of
763 * <code>$this->content->items</code> with an array of {@link tree_item}
764 * objects (these are the top-level nodes). The {@link tree_item::children}
765 * property may contain more tree_item objects, and so on. The tree_item class
766 * itself is abstract and not intended for use, use one of it's subclasses.
768 * Unlike {@link block_list}, the icons are specified as part of the items,
769 * not in a separate array.
772 * @package core_block
773 * @internal this extends block_list so we get is_empty() for free
775 class block_tree
extends block_list
{
778 * @var int specifies the manner in which contents should be added to this
779 * block type. In this case <code>$this->content->items</code> is used with
780 * {@link tree_item}s.
782 public $content_type = BLOCK_TYPE_TREE
;
785 * Make the formatted HTML ouput.
787 * Also adds the required javascript call to the page output.
789 * @param core_renderer $output
790 * @return string HTML
792 protected function formatted_contents($output) {
793 // based of code in admin_tree
794 global $PAGE; // TODO change this when there is a proper way for blocks to get stuff into head.
795 static $eventattached;
796 if ($eventattached===null) {
797 $eventattached = true;
799 if (!$this->content
) {
800 $this->content
= new stdClass
;
801 $this->content
->items
= array();
803 $this->get_required_javascript();
804 $this->get_content();
805 $content = $output->tree_block_contents($this->content
->items
,array('class'=>'block_tree list'));
806 if (isset($this->id
) && !is_numeric($this->id
)) {
807 $content = $output->box($content, 'block_tree_box', $this->id
);