MDL-40275 core Improve documentation for block_base::has_config()
[moodle.git] / blocks / moodleblock.class.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 the parent class for moodle blocks, block_base.
20  *
21  * @package    core
22  * @subpackage block
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
24  */
26 /// Constants
28 /**
29  * 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.
30  */
31 define('BLOCK_TYPE_LIST',    1);
33 /**
34  * 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.
35  */
36 define('BLOCK_TYPE_TEXT',    2);
37 /**
38  * Block type of tree. $this->content->items is a list of tree_item objects and $this->content->footer is a string.
39  */
40 define('BLOCK_TYPE_TREE',    3);
42 /**
43  * Class for describing a moodle block, all Moodle blocks derive from this class
44  *
45  * @author Jon Papaioannou
46  * @package blocks
47  */
48 class block_base {
50     /**
51      * Internal var for storing/caching translated strings
52      * @var string $str
53      */
54     var $str;
56     /**
57      * The title of the block to be displayed in the block title area.
58      * @var string $title
59      */
60     var $title         = NULL;
62     /**
63      * The name of the block to be displayed in the block title area if the title is empty.
64      * @var string arialabel
65      */
66     var $arialabel         = NULL;
68     /**
69      * The type of content that this block creates. Currently support options - BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT
70      * @var int $content_type
71      */
72     var $content_type  = BLOCK_TYPE_TEXT;
74     /**
75      * An object to contain the information to be displayed in the block.
76      * @var stdObject $content
77      */
78     var $content       = NULL;
80     /**
81      * A string generated by {@link _add_edit_controls()} to display block manipulation links when the user is in editing mode.
82      * @var string $edit_controls
83      */
84     var $edit_controls = NULL;
86     /**
87      * The initialized instance of this block object.
88      * @var block $instance
89      */
90     var $instance      = NULL;
92     /**
93      * The page that this block is appearing on.
94      * @var moodle_page
95      */
96     public $page       = NULL;
98     /**
99      * This blocks's context.
100      * @var stdClass
101      */
102     public $context    = NULL;
104     /**
105      * An object containing the instance configuration information for the current instance of this block.
106      * @var stdObject $config
107      */
108     var $config        = NULL;
110     /**
111      * How often the cronjob should run, 0 if not at all.
112      * @var int $cron
113      */
115     var $cron          = NULL;
117 /// Class Functions
119     /**
120      * Fake constructor to keep PHP5 happy
121      *
122      */
123     function __construct() {
124         $this->init();
125     }
127     /**
128      * Function that can be overridden to do extra cleanup before
129      * the database tables are deleted. (Called once per block, not per instance!)
130      */
131     function before_delete() {
132     }
134     /**
135      * Returns the block name, as present in the class name,
136      * the database, the block directory, etc etc.
137      *
138      * @return string
139      */
140     function name() {
141         // Returns the block name, as present in the class name,
142         // the database, the block directory, etc etc.
143         static $myname;
144         if ($myname === NULL) {
145             $myname = strtolower(get_class($this));
146             $myname = substr($myname, strpos($myname, '_') + 1);
147         }
148         return $myname;
149     }
151     /**
152      * Parent class version of this function simply returns NULL
153      * This should be implemented by the derived class to return
154      * the content object.
155      *
156      * @return stdObject
157      */
158     function get_content() {
159         // This should be implemented by the derived class.
160         return NULL;
161     }
163     /**
164      * Returns the class $title var value.
165      *
166      * Intentionally doesn't check if a title is set.
167      * This is already done in {@link _self_test()}
168      *
169      * @return string $this->title
170      */
171     function get_title() {
172         // Intentionally doesn't check if a title is set. This is already done in _self_test()
173         return $this->title;
174     }
176     /**
177      * Returns the class $content_type var value.
178      *
179      * Intentionally doesn't check if content_type is set.
180      * This is already done in {@link _self_test()}
181      *
182      * @return string $this->content_type
183      */
184     function get_content_type() {
185         // Intentionally doesn't check if a content_type is set. This is already done in _self_test()
186         return $this->content_type;
187     }
189     /**
190      * Returns true or false, depending on whether this block has any content to display
191      * and whether the user has permission to view the block
192      *
193      * @return boolean
194      */
195     function is_empty() {
196         if ( !has_capability('moodle/block:view', $this->context) ) {
197             return true;
198         }
200         $this->get_content();
201         return(empty($this->content->text) && empty($this->content->footer));
202     }
204     /**
205      * First sets the current value of $this->content to NULL
206      * then calls the block's {@link get_content()} function
207      * to set its value back.
208      *
209      * @return stdObject
210      */
211     function refresh_content() {
212         // Nothing special here, depends on content()
213         $this->content = NULL;
214         return $this->get_content();
215     }
217     /**
218      * Return a block_contents object representing the full contents of this block.
219      *
220      * This internally calls ->get_content(), and then adds the editing controls etc.
221      *
222      * You probably should not override this method, but instead override
223      * {@link html_attributes()}, {@link formatted_contents()} or {@link get_content()},
224      * {@link hide_header()}, {@link (get_edit_controls)}, etc.
225      *
226      * @return block_contents a representation of the block, for rendering.
227      * @since Moodle 2.0.
228      */
229     public function get_content_for_output($output) {
230         global $CFG;
232         $bc = new block_contents($this->html_attributes());
234         $bc->blockinstanceid = $this->instance->id;
235         $bc->blockpositionid = $this->instance->blockpositionid;
237         if ($this->instance->visible) {
238             $bc->content = $this->formatted_contents($output);
239             if (!empty($this->content->footer)) {
240                 $bc->footer = $this->content->footer;
241             }
242         } else {
243             $bc->add_class('invisible');
244         }
246         if (!$this->hide_header()) {
247             $bc->title = $this->title;
248         }
250         if (empty($bc->title)) {
251             $bc->arialabel = new lang_string('pluginname', get_class($this));
252             $this->arialabel = $bc->arialabel;
253         }
255         if ($this->page->user_is_editing()) {
256             $bc->controls = $this->page->blocks->edit_controls($this);
257         } else {
258             // we must not use is_empty on hidden blocks
259             if ($this->is_empty() && !$bc->controls) {
260                 return null;
261             }
262         }
264         if (empty($CFG->allowuserblockhiding)
265                 || (empty($bc->content) && empty($bc->footer))
266                 || !$this->instance_can_be_collapsed()) {
267             $bc->collapsible = block_contents::NOT_HIDEABLE;
268         } else if (get_user_preferences('block' . $bc->blockinstanceid . 'hidden', false)) {
269             $bc->collapsible = block_contents::HIDDEN;
270         } else {
271             $bc->collapsible = block_contents::VISIBLE;
272         }
274         $bc->annotation = ''; // TODO MDL-19398 need to work out what to say here.
276         return $bc;
277     }
279     /**
280      * Convert the contents of the block to HTML.
281      *
282      * This is used by block base classes like block_list to convert the structured
283      * $this->content->list and $this->content->icons arrays to HTML. So, in most
284      * blocks, you probaby want to override the {@link get_contents()} method,
285      * which generates that structured representation of the contents.
286      *
287      * @param $output The core_renderer to use when generating the output.
288      * @return string the HTML that should appearn in the body of the block.
289      * @since Moodle 2.0.
290      */
291     protected function formatted_contents($output) {
292         $this->get_content();
293         $this->get_required_javascript();
294         if (!empty($this->content->text)) {
295             return $this->content->text;
296         } else {
297             return '';
298         }
299     }
301     /**
302      * Tests if this block has been implemented correctly.
303      * Also, $errors isn't used right now
304      *
305      * @return boolean
306      */
308     function _self_test() {
309         // Tests if this block has been implemented correctly.
310         // Also, $errors isn't used right now
311         $errors = array();
313         $correct = true;
314         if ($this->get_title() === NULL) {
315             $errors[] = 'title_not_set';
316             $correct = false;
317         }
318         if (!in_array($this->get_content_type(), array(BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT, BLOCK_TYPE_TREE))) {
319             $errors[] = 'invalid_content_type';
320             $correct = false;
321         }
322         //following selftest was not working when roles&capabilities were used from block
323 /*        if ($this->get_content() === NULL) {
324             $errors[] = 'content_not_set';
325             $correct = false;
326         }*/
327         $formats = $this->applicable_formats();
328         if (empty($formats) || array_sum($formats) === 0) {
329             $errors[] = 'no_formats';
330             $correct = false;
331         }
333         $width = $this->preferred_width();
334         if (!is_int($width) || $width <= 0) {
335             $errors[] = 'invalid_width';
336             $correct = false;
337         }
338         return $correct;
339     }
341     /**
342      * Subclasses should override this and return true if the
343      * subclass block has a settings.php file.
344      *
345      * @return boolean
346      */
347     function has_config() {
348         return false;
349     }
351     /**
352      * Default behavior: save all variables as $CFG properties
353      * You don't need to override this if you 're satisfied with the above
354      *
355      * @param array $data
356      * @return boolean
357      */
358     function config_save($data) {
359         foreach ($data as $name => $value) {
360             set_config($name, $value);
361         }
362         return true;
363     }
365     /**
366      * Which page types this block may appear on.
367      *
368      * The information returned here is processed by the
369      * {@link blocks_name_allowed_in_format()} function. Look there if you need
370      * to know exactly how this works.
371      *
372      * Default case: everything except mod and tag.
373      *
374      * @return array page-type prefix => true/false.
375      */
376     function applicable_formats() {
377         // Default case: the block can be used in courses and site index, but not in activities
378         return array('all' => true, 'mod' => false, 'tag' => false);
379     }
382     /**
383      * Default return is false - header will be shown
384      * @return boolean
385      */
386     function hide_header() {
387         return false;
388     }
390     /**
391      * Return any HTML attributes that you want added to the outer <div> that
392      * of the block when it is output.
393      *
394      * Because of the way certain JS events are wired it is a good idea to ensure
395      * that the default values here still get set.
396      * I found the easiest way to do this and still set anything you want is to
397      * override it within your block in the following way
398      *
399      * <code php>
400      * function html_attributes() {
401      *    $attributes = parent::html_attributes();
402      *    $attributes['class'] .= ' mynewclass';
403      *    return $attributes;
404      * }
405      * </code>
406      *
407      * @return array attribute name => value.
408      */
409     function html_attributes() {
410         $attributes = array(
411             'id' => 'inst' . $this->instance->id,
412             'class' => 'block_' . $this->name(). '  block',
413             'role' => $this->get_aria_role()
414         );
415         if ($this->instance_can_be_docked() && get_user_preferences('docked_block_instance_'.$this->instance->id, 0)) {
416             $attributes['class'] .= ' dock_on_load';
417         }
418         return $attributes;
419     }
421     /**
422      * Set up a particular instance of this class given data from the block_insances
423      * table and the current page. (See {@link block_manager::load_blocks()}.)
424      *
425      * @param stdClass $instance data from block_insances, block_positions, etc.
426      * @param moodle_page $the page this block is on.
427      */
428     function _load_instance($instance, $page) {
429         if (!empty($instance->configdata)) {
430             $this->config = unserialize(base64_decode($instance->configdata));
431         }
432         $this->instance = $instance;
433         $this->context = context_block::instance($instance->id);
434         $this->page = $page;
435         $this->specialization();
436     }
438     function get_required_javascript() {
439         if ($this->instance_can_be_docked() && !$this->hide_header()) {
440             $this->page->requires->js_init_call('M.core_dock.init_genericblock', array($this->instance->id));
441             user_preference_allow_ajax_update('docked_block_instance_'.$this->instance->id, PARAM_INT);
442         }
443     }
445     /**
446      * This function is called on your subclass right after an instance is loaded
447      * Use this function to act on instance data just after it's loaded and before anything else is done
448      * For instance: if your block will have different title's depending on location (site, course, blog, etc)
449      */
450     function specialization() {
451         // Just to make sure that this method exists.
452     }
454     /**
455      * Is each block of this type going to have instance-specific configuration?
456      * Normally, this setting is controlled by {@link instance_allow_multiple()}: if multiple
457      * instances are allowed, then each will surely need its own configuration. However, in some
458      * cases it may be necessary to provide instance configuration to blocks that do not want to
459      * allow multiple instances. In that case, make this function return true.
460      * I stress again that this makes a difference ONLY if {@link instance_allow_multiple()} returns false.
461      * @return boolean
462      */
463     function instance_allow_config() {
464         return false;
465     }
467     /**
468      * Are you going to allow multiple instances of each block?
469      * If yes, then it is assumed that the block WILL USE per-instance configuration
470      * @return boolean
471      */
472     function instance_allow_multiple() {
473         // Are you going to allow multiple instances of each block?
474         // If yes, then it is assumed that the block WILL USE per-instance configuration
475         return false;
476     }
478     /**
479      * Default behavior: print the config_instance.html file
480      * You don't need to override this if you're satisfied with the above
481      *
482      * @deprecated since Moodle 2.0.
483      * @return boolean whether anything was done. Blocks should use edit_form.php.
484      */
485     function instance_config_print() {
486         global $CFG, $DB, $OUTPUT;
487         // Default behavior: print the config_instance.html file
488         // You don't need to override this if you're satisfied with the above
489         if (!$this->instance_allow_multiple() && !$this->instance_allow_config()) {
490             return false;
491         }
493         if (is_file($CFG->dirroot .'/blocks/'. $this->name() .'/config_instance.html')) {
494             echo $OUTPUT->box_start('generalbox boxaligncenter blockconfiginstance');
495             include($CFG->dirroot .'/blocks/'. $this->name() .'/config_instance.html');
496             echo $OUTPUT->box_end();
497         } else {
498             notice(get_string('blockconfigbad'), str_replace('blockaction=', 'dummy=', qualified_me()));
499         }
501         return true;
502     }
504     /**
505      * Serialize and store config data
506      */
507     function instance_config_save($data, $nolongerused = false) {
508         global $DB;
509         $DB->set_field('block_instances', 'configdata', base64_encode(serialize($data)),
510                 array('id' => $this->instance->id));
511     }
513     /**
514      * Replace the instance's configuration data with those currently in $this->config;
515      */
516     function instance_config_commit($nolongerused = false) {
517         global $DB;
518         $this->instance_config_save($this->config);
519     }
521     /**
522      * Do any additional initialization you may need at the time a new block instance is created
523      * @return boolean
524      */
525     function instance_create() {
526         return true;
527     }
529     /**
530      * Delete everything related to this instance if you have been using persistent storage other than the configdata field.
531      * @return boolean
532      */
533     function instance_delete() {
534         return true;
535     }
537     /**
538      * Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
539      * The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode)
540      * but if the framework does allow it, the block can still decide to refuse.
541      * @return boolean
542      */
543     function user_can_edit() {
544         global $USER;
546         if (has_capability('moodle/block:edit', $this->context)) {
547             return true;
548         }
550         // The blocks in My Moodle are a special case.  We want them to inherit from the user context.
551         if (!empty($USER->id)
552             && $this->instance->parentcontextid == $this->page->context->id   // Block belongs to this page
553             && $this->page->context->contextlevel == CONTEXT_USER             // Page belongs to a user
554             && $this->page->context->instanceid == $USER->id) {               // Page belongs to this user
555             return has_capability('moodle/my:manageblocks', $this->page->context);
556         }
558         return false;
559     }
561     /**
562      * Allows the block class to have a say in the user's ability to create new instances of this block.
563      * The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode)
564      * but if the framework does allow it, the block can still decide to refuse.
565      * This function has access to the complete page object, the creation related to which is being determined.
566      *
567      * @param moodle_page $page
568      * @return boolean
569      */
570     function user_can_addto($page) {
571         global $USER;
573         // The blocks in My Moodle are a special case and use a different capability.
574         if (!empty($USER->id)
575             && $page->context->contextlevel == CONTEXT_USER // Page belongs to a user
576             && $page->context->instanceid == $USER->id // Page belongs to this user
577             && $page->pagetype == 'my-index') { // Ensure we are on the My Moodle page
578             $capability = 'block/' . $this->name() . ':myaddinstance';
579             return $this->has_add_block_capability($page, $capability)
580                     && has_capability('moodle/my:manageblocks', $page->context);
581         }
583         $capability = 'block/' . $this->name() . ':addinstance';
584         if ($this->has_add_block_capability($page, $capability)
585                 && has_capability('moodle/block:edit', $page->context)) {
586             return true;
587         }
589         return false;
590     }
592     /**
593      * Returns true if the user can add a block to a page.
594      *
595      * @param moodle_page $page
596      * @param string $capability the capability to check
597      * @return boolean true if user can add a block, false otherwise.
598      */
599     private function has_add_block_capability($page, $capability) {
600         // Check if the capability exists.
601         if (!get_capability_info($capability)) {
602             // Debug warning that the capability does not exist, but no more than once per page.
603             static $warned = array();
604             if (!isset($warned[$this->name()])) {
605                 debugging('The block ' .$this->name() . ' does not define the standard capability ' .
606                         $capability , DEBUG_DEVELOPER);
607                 $warned[$this->name()] = 1;
608             }
609             // If the capability does not exist, the block can always be added.
610             return true;
611         } else {
612             return has_capability($capability, $page->context);
613         }
614     }
616     static function get_extra_capabilities() {
617         return array('moodle/block:view', 'moodle/block:edit');
618     }
620     // Methods deprecated in Moodle 2.0 ========================================
622     /**
623      * Default case: the block wants to be 180 pixels wide
624      * @deprecated since Moodle 2.0.
625      * @return int
626      */
627     function preferred_width() {
628         return 180;
629     }
631     /** @deprecated since Moodle 2.0. */
632     function _print_block() {
633         throw new coding_exception('_print_block is no longer used. It was a private ' .
634                 'method of the block class, only for use by the blocks system. You ' .
635                 'should not have been calling it anyway.');
636     }
638     /** @deprecated since Moodle 2.0. */
639     function _print_shadow() {
640         throw new coding_exception('_print_shadow is no longer used. It was a private ' .
641                 'method of the block class, only for use by the blocks system. You ' .
642                 'should not have been calling it anyway.');
643     }
645     /** @deprecated since Moodle 2.0. */
646     function _title_html() {
647         throw new coding_exception('_title_html is no longer used. It was a private ' .
648                 'method of the block class, only for use by the blocks system. You ' .
649                 'should not have been calling it anyway.');
650     }
652     /** @deprecated since Moodle 2.0. */
653     function _add_edit_controls() {
654         throw new coding_exception('_add_edit_controls 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.');
657     }
659     /** @deprecated since Moodle 2.0. */
660     function config_print() {
661         throw new coding_exception('config_print() can no longer be used. Blocks should use a settings.php file.');
662     }
664     /**
665      * Can be overridden by the block to prevent the block from being dockable.
666      *
667      * @return bool
668      */
669     public function instance_can_be_docked() {
670         global $CFG;
671         return (!empty($CFG->allowblockstodock) && $this->page->theme->enable_dock);
672     }
674     /**
675      * If overridden and set to false by the block it will not be hidable when
676      * editing is turned on.
677      *
678      * @return bool
679      */
680     public function instance_can_be_hidden() {
681         return true;
682     }
684     /**
685      * If overridden and set to false by the block it will not be collapsible.
686      *
687      * @return bool
688      */
689     public function instance_can_be_collapsed() {
690         return true;
691     }
693     /** @callback callback functions for comments api */
694     public static function comment_template($options) {
695         $ret = <<<EOD
696 <div class="comment-userpicture">___picture___</div>
697 <div class="comment-content">
698     ___name___ - <span>___time___</span>
699     <div>___content___</div>
700 </div>
701 EOD;
702         return $ret;
703     }
704     public static function comment_permissions($options) {
705         return array('view'=>true, 'post'=>true);
706     }
707     public static function comment_url($options) {
708         return null;
709     }
710     public static function comment_display($comments, $options) {
711         return $comments;
712     }
713     public static function comment_add(&$comments, $options) {
714         return true;
715     }
717     /**
718      * Returns the aria role attribute that best describes this block.
719      *
720      * Region is the default, but this should be overridden by a block is there is a region child, or even better
721      * a landmark child.
722      *
723      * Options are as follows:
724      *    - landmark
725      *      - application
726      *      - banner
727      *      - complementary
728      *      - contentinfo
729      *      - form
730      *      - main
731      *      - navigation
732      *      - search
733      *
734      * @return string
735      */
736     public function get_aria_role() {
737         return 'complementary';
738     }
741 /**
742  * Specialized class for displaying a block with a list of icons/text labels
743  *
744  * The get_content method should set $this->content->items and (optionally)
745  * $this->content->icons, instead of $this->content->text.
746  *
747  * @author Jon Papaioannou
748  * @package blocks
749  */
751 class block_list extends block_base {
752     var $content_type  = BLOCK_TYPE_LIST;
754     function is_empty() {
755         if ( !has_capability('moodle/block:view', $this->context) ) {
756             return true;
757         }
759         $this->get_content();
760         return (empty($this->content->items) && empty($this->content->footer));
761     }
763     protected function formatted_contents($output) {
764         $this->get_content();
765         $this->get_required_javascript();
766         if (!empty($this->content->items)) {
767             return $output->list_block_contents($this->content->icons, $this->content->items);
768         } else {
769             return '';
770         }
771     }
773     function html_attributes() {
774         $attributes = parent::html_attributes();
775         $attributes['class'] .= ' list_block';
776         return $attributes;
777     }
781 /**
782  * Specialized class for displaying a tree menu.
783  *
784  * The {@link get_content()} method involves setting the content of
785  * <code>$this->content->items</code> with an array of {@link tree_item}
786  * objects (these are the top-level nodes). The {@link tree_item::children}
787  * property may contain more tree_item objects, and so on. The tree_item class
788  * itself is abstract and not intended for use, use one of it's subclasses.
789  *
790  * Unlike {@link block_list}, the icons are specified as part of the items,
791  * not in a separate array.
792  *
793  * @author Alan Trick
794  * @package blocks
795  * @internal this extends block_list so we get is_empty() for free
796  */
797 class block_tree extends block_list {
799     /**
800      * @var int specifies the manner in which contents should be added to this
801      * block type. In this case <code>$this->content->items</code> is used with
802      * {@link tree_item}s.
803      */
804     public $content_type = BLOCK_TYPE_TREE;
806     /**
807      * Make the formatted HTML ouput.
808      *
809      * Also adds the required javascript call to the page output.
810      *
811      * @param core_renderer $output
812      * @return string HTML
813      */
814     protected function formatted_contents($output) {
815         // based of code in admin_tree
816         global $PAGE; // TODO change this when there is a proper way for blocks to get stuff into head.
817         static $eventattached;
818         if ($eventattached===null) {
819             $eventattached = true;
820         }
821         if (!$this->content) {
822             $this->content = new stdClass;
823             $this->content->items = array();
824         }
825         $this->get_required_javascript();
826         $this->get_content();
827         $content = $output->tree_block_contents($this->content->items,array('class'=>'block_tree list'));
828         if (isset($this->id) && !is_numeric($this->id)) {
829             $content = $output->box($content, 'block_tree_box', $this->id);
830         }
831         return $content;
832     }