Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

< /** < * Tests for the block_manager class in ../blocklib.php. < * < * @package core < * @category phpunit < * @copyright 2009 Tim Hunt < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */
> namespace core;
defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->libdir . '/pagelib.php'); require_once($CFG->libdir . '/blocklib.php'); require_once($CFG->dirroot . '/blocks/moodleblock.class.php');
<
> require_once(__DIR__ . '/fixtures/block_ablocktype.php'); > require_once(__DIR__ . '/fixtures/testable_block_manager.php');
/**
< * Test various block related classes.
> * Tests for the block_manager class in ../blocklib.php. > * > * @package core > * @category test > * @copyright 2009 Tim Hunt > * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
< class core_blocklib_testcase extends advanced_testcase {
> class blocklib_test extends \advanced_testcase {
protected $testpage; protected $blockmanager; protected $isediting = null;
< protected function setUp() {
> protected function setUp(): void {
parent::setUp();
< $this->testpage = new moodle_page(); < $this->testpage->set_context(context_system::instance());
> $this->testpage = new \moodle_page(); > $this->testpage->set_context(\context_system::instance());
$this->testpage->set_pagetype('phpunit-block-test');
< $this->blockmanager = new testable_block_manager($this->testpage);
> $this->blockmanager = new \testable_block_manager($this->testpage);
}
< protected function tearDown() {
> protected function tearDown(): void {
$this->testpage = null; $this->blockmanager = null; parent::tearDown(); } protected function purge_blocks() { global $DB; $this->resetAfterTest(); $bis = $DB->get_records('block_instances'); foreach ($bis as $instance) { blocks_delete_instance($instance); } } /** * Gets the last block created. * * @return stdClass a record from block_instances */ protected function get_last_created_block() { global $DB; // The newest block should be the record with the highest id. $records = $DB->get_records('block_instances', [], 'id DESC', '*', 0, 1); $return = null; foreach ($records as $record) { // There should only be one. $return = $record; } return $return; } public function test_no_regions_initially() { // Exercise SUT & Validate. $this->assertEquals(array(), $this->blockmanager->get_regions()); } public function test_add_region() { // Exercise SUT. $this->blockmanager->add_region('a-region-name', false); // Validate. $this->assertEquals(array('a-region-name'), $this->blockmanager->get_regions()); } public function test_add_regions() { // Set up fixture. $regions = array('a-region', 'another-region'); // Exercise SUT. $this->blockmanager->add_regions($regions, false); // Validate.
< $this->assertEquals($regions, $this->blockmanager->get_regions(), '', 0, 10, true);
> $this->assertEqualsCanonicalizing($regions, $this->blockmanager->get_regions());
} public function test_add_region_twice() { // Exercise SUT. $this->blockmanager->add_region('a-region-name', false); $this->blockmanager->add_region('another-region', false); // Validate.
< $this->assertEquals(array('a-region-name', 'another-region'), $this->blockmanager->get_regions(), '', 0, 10, true);
> $this->assertEqualsCanonicalizing(array('a-region-name', 'another-region'), $this->blockmanager->get_regions());
}
< /** < * @expectedException coding_exception < */
public function test_cannot_add_region_after_loaded() { // Set up fixture. $this->blockmanager->mark_loaded(); // Exercise SUT.
> $this->expectException(\coding_exception::class);
$this->blockmanager->add_region('too-late', false); } /** * Testing adding a custom region. */ public function test_add_custom_region() { global $SESSION; // Exercise SUT. $this->blockmanager->add_region('a-custom-region-name'); // Validate. $this->assertEquals(array('a-custom-region-name'), $this->blockmanager->get_regions()); $this->assertTrue(isset($SESSION->custom_block_regions)); $this->assertArrayHasKey('phpunit-block-test', $SESSION->custom_block_regions); $this->assertTrue(in_array('a-custom-region-name', $SESSION->custom_block_regions['phpunit-block-test'])); } /** * Test adding two custom regions using add_regions method. */ public function test_add_custom_regions() { global $SESSION; // Set up fixture. $regions = array('a-region', 'another-custom-region'); // Exercise SUT. $this->blockmanager->add_regions($regions); // Validate.
< $this->assertEquals($regions, $this->blockmanager->get_regions(), '', 0, 10, true);
> $this->assertEqualsCanonicalizing($regions, $this->blockmanager->get_regions());
$this->assertTrue(isset($SESSION->custom_block_regions)); $this->assertArrayHasKey('phpunit-block-test', $SESSION->custom_block_regions); $this->assertTrue(in_array('another-custom-region', $SESSION->custom_block_regions['phpunit-block-test'])); } /** * Test adding two custom block regions. */ public function test_add_custom_region_twice() { // Exercise SUT. $this->blockmanager->add_region('a-custom-region-name'); $this->blockmanager->add_region('another-custom-region'); // Validate.
< $this->assertEquals(
> $this->assertEqualsCanonicalizing(
array('a-custom-region-name', 'another-custom-region'),
< $this->blockmanager->get_regions(), < '', 0, 10, true < );
> $this->blockmanager->get_regions());
} /** * Test to ensure that we cannot add a region after the blocks have been loaded.
< * @expectedException coding_exception
*/ public function test_cannot_add_custom_region_after_loaded() { // Set up fixture. $this->blockmanager->mark_loaded(); // Exercise SUT.
> $this->expectException(\coding_exception::class);
$this->blockmanager->add_region('too-late'); } public function test_set_default_region() { // Set up fixture. $this->blockmanager->add_region('a-region-name', false); // Exercise SUT. $this->blockmanager->set_default_region('a-region-name'); // Validate. $this->assertEquals('a-region-name', $this->blockmanager->get_default_region()); }
< /** < * @expectedException coding_exception < */
public function test_cannot_set_unknown_region_as_default() { // Exercise SUT.
> $this->expectException(\coding_exception::class);
$this->blockmanager->set_default_region('a-region-name'); }
< /** < * @expectedException coding_exception < */
public function test_cannot_change_default_region_after_loaded() { // Set up fixture. $this->blockmanager->mark_loaded(); // Exercise SUT.
> $this->expectException(\coding_exception::class);
$this->blockmanager->set_default_region('too-late'); } public function test_matching_page_type_patterns() {
< $this->assertEquals(array('site-index', 'site-index-*', 'site-*', '*'), < matching_page_type_patterns('site-index'), '', 0, 10, true);
> $this->assertEqualsCanonicalizing(array('site-index', 'site-index-*', 'site-*', '*'), > matching_page_type_patterns('site-index'));
< $this->assertEquals(array('mod-quiz-report-overview', 'mod-quiz-report-overview-*', 'mod-quiz-report-*', 'mod-quiz-*', 'mod-*', '*'), < matching_page_type_patterns('mod-quiz-report-overview'), '', 0, 10, true);
> $this->assertEqualsCanonicalizing(array('mod-quiz-report-overview', 'mod-quiz-report-overview-*', 'mod-quiz-report-*', 'mod-quiz-*', 'mod-*', '*'), > matching_page_type_patterns('mod-quiz-report-overview'));
< $this->assertEquals(array('mod-forum-view', 'mod-*-view', 'mod-forum-view-*', 'mod-forum-*', 'mod-*', '*'), < matching_page_type_patterns('mod-forum-view'), '', 0, 10, true);
> $this->assertEqualsCanonicalizing(array('mod-forum-view', 'mod-*-view', 'mod-forum-view-*', 'mod-forum-*', 'mod-*', '*'), > matching_page_type_patterns('mod-forum-view'));
< $this->assertEquals(array('mod-forum-index', 'mod-*-index', 'mod-forum-index-*', 'mod-forum-*', 'mod-*', '*'), < matching_page_type_patterns('mod-forum-index'), '', 0, 10, true);
> $this->assertEqualsCanonicalizing(array('mod-forum-index', 'mod-*-index', 'mod-forum-index-*', 'mod-forum-*', 'mod-*', '*'), > matching_page_type_patterns('mod-forum-index'));
} protected function get_a_page_and_block_manager($regions, $context, $pagetype, $subpage = '') {
< $page = new moodle_page;
> $page = new \moodle_page;
$page->set_context($context); $page->set_pagetype($pagetype); $page->set_subpage($subpage);
< $page->set_url(new moodle_url('/'));
> $page->set_url(new \moodle_url('/'));
< $blockmanager = new testable_block_manager($page);
> $blockmanager = new \testable_block_manager($page);
$blockmanager->add_regions($regions, false); $blockmanager->set_default_region($regions[0]); return array($page, $blockmanager); } protected function get_a_known_block_type() { global $DB;
< $block = new stdClass;
> $block = new \stdClass;
$block->name = 'ablocktype'; $DB->insert_record('block', $block); return $block->name; } protected function assertContainsBlocksOfType($typearray, $blockarray) { if (!$this->assertEquals(count($typearray), count($blockarray), "Blocks array contains the wrong number of elements %s.")) { return; } $types = array_values($typearray); $i = 0; foreach ($blockarray as $block) { $blocktype = $types[$i]; $this->assertEquals($blocktype, $block->name(), "Block types do not match at postition $i %s."); $i++; } } public function test_empty_initially() { $this->purge_blocks(); // Set up fixture. list($page, $blockmanager) = $this->get_a_page_and_block_manager(array('a-region'),
< context_system::instance(), 'page-type');
> \context_system::instance(), 'page-type');
// Exercise SUT. $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_loaded_blocks(); $this->assertEquals(array('a-region' => array()), $blocks); } public function test_adding_and_retrieving_one_block() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); // Exercise SUT. $blockmanager->add_block($blockname, $regionname, 0, false); $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array($blockname), $blocks); } public function test_adding_and_retrieving_two_blocks() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); // Exercise SUT. $blockmanager->add_block($blockname, $regionname, 0, false); $blockmanager->add_block($blockname, $regionname, 1, false); $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array($blockname, $blockname), $blocks); } public function test_adding_blocks() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->add_blocks(array($regionname => array($blockname, $blockname)), null, null, false, 3); $blockmanager->load_blocks(); $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertEquals('3', $blocks[0]->instance->weight); $this->assertEquals('4', $blocks[1]->instance->weight); } /** * Test block instances. * * @return null */ public function test_block_instances() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->add_blocks(array($regionname => array($blockname, $blockname)), null, null, false, 3); $blockmanager->load_blocks(); $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertInstanceOf('\block_base', block_instance($blockname, $blocks[0]->instance)); $this->assertInstanceOf('\block_base', block_instance_by_id($blocks[0]->instance->id)); } public function test_block_not_included_in_different_context() { $this->purge_blocks(); // Set up fixture.
< $syscontext = context_system::instance();
> $syscontext = \context_system::instance();
$cat = $this->getDataGenerator()->create_category(array('name' => 'testcategory'));
< $fakecontext = context_coursecat::instance($cat->id);
> $fakecontext = \context_coursecat::instance($cat->id);
$regionname = 'a-region'; $blockname = $this->get_a_known_block_type(); list($addpage, $addbm) = $this->get_a_page_and_block_manager(array($regionname), $fakecontext, 'page-type'); list($viewpage, $viewbm) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type'); $addbm->add_block($blockname, $regionname, 0, false); // Exercise SUT. $viewbm->load_blocks(); // Validate. $blocks = $viewbm->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array(), $blocks); } public function test_block_included_in_sub_context() { $this->purge_blocks(); // Set up fixture.
< $syscontext = context_system::instance(); < $childcontext = context_coursecat::instance(1);
> $syscontext = \context_system::instance(); > $childcontext = \context_coursecat::instance(1);
$regionname = 'a-region'; $blockname = $this->get_a_known_block_type(); list($addpage, $addbm) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type'); list($viewpage, $viewbm) = $this->get_a_page_and_block_manager(array($regionname), $childcontext, 'page-type'); $addbm->add_block($blockname, $regionname, 0, true); // Exercise SUT. $viewbm->load_blocks(); // Validate. $blocks = $viewbm->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array($blockname), $blocks); } public function test_block_not_included_on_different_page_type() { $this->purge_blocks(); // Set up fixture.
< $syscontext = context_system::instance();
> $syscontext = \context_system::instance();
$regionname = 'a-region'; $blockname = $this->get_a_known_block_type(); list($addpage, $addbm) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type'); list($viewpage, $viewbm) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'other-page-type'); $addbm->add_block($blockname, $regionname, 0, true); // Exercise SUT. $viewbm->load_blocks(); // Validate. $blocks = $viewbm->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array(), $blocks); } public function test_block_not_included_on_different_sub_page() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $syscontext = context_system::instance();
> $syscontext = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type', 'sub-page'); $blockmanager->add_block($blockname, $regionname, 0, true, $page->pagetype, 'other-sub-page'); // Exercise SUT. $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array(), $blocks); } public function test_block_included_with_explicit_sub_page() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $syscontext = context_system::instance();
> $syscontext = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type', 'sub-page'); $blockmanager->add_block($blockname, $regionname, 0, true, $page->pagetype, $page->subpage); // Exercise SUT. $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array($blockname), $blocks); } public function test_block_included_with_page_type_pattern() { $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $syscontext = context_system::instance();
> $syscontext = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'page-type', 'sub-page'); $blockmanager->add_block($blockname, $regionname, 0, true, 'page-*', $page->subpage); // Exercise SUT. $blockmanager->load_blocks(); // Validate. $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertContainsBlocksOfType(array($blockname), $blocks); } public function test_matching_page_type_patterns_from_pattern() { $pattern = '*'; $expected = array('*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'admin-*'; $expected = array('admin-*', 'admin', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'blog-index'; $expected = array('blog-index', 'blog-index-*', 'blog-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'course-index-*'; $expected = array('course-index-*', 'course-index', 'course-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'course-index-category'; $expected = array('course-index-category', 'course-index-category-*', 'course-index-*', 'course-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'mod-assign-view'; $expected = array('mod-assign-view', 'mod-*-view', 'mod-assign-view-*', 'mod-assign-*', 'mod-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'mod-assign-index'; $expected = array('mod-assign-index', 'mod-*-index', 'mod-assign-index-*', 'mod-assign-*', 'mod-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'mod-forum-*'; $expected = array('mod-forum-*', 'mod-forum', 'mod-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'mod-*-view'; $expected = array('mod-*-view', 'mod', 'mod-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'mod-*-index'; $expected = array('mod-*-index', 'mod', 'mod-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'my-index'; $expected = array('my-index', 'my-index-*', 'my-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); $pattern = 'user-profile'; $expected = array('user-profile', 'user-profile-*', 'user-*', '*'); $this->assertEquals($expected, array_values(matching_page_type_patterns_from_pattern($pattern))); } public function test_delete_instances() { global $DB; $this->purge_blocks(); $this->setAdminUser(); $regionname = 'a-region'; $blockname = $this->get_a_known_block_type();
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->add_blocks(array($regionname => array($blockname, $blockname, $blockname)), null, null, false, 3); $blockmanager->load_blocks(); $blocks = $blockmanager->get_blocks_for_region($regionname); $blockids = array(); $preferences = array(); // Create block related data. foreach ($blocks as $block) { $instance = $block->instance; $pref = 'block' . $instance->id . 'hidden'; set_user_preference($pref, '123', 123); $preferences[] = $pref; $pref = 'docked_block_instance_' . $instance->id; set_user_preference($pref, '123', 123); $preferences[] = $pref; blocks_set_visibility($instance, $page, 1); $blockids[] = $instance->id; } // Confirm what has been set. $this->assertCount(3, $blockids); list($insql, $inparams) = $DB->get_in_or_equal($blockids); $this->assertEquals(3, $DB->count_records_select('block_positions', "blockinstanceid $insql", $inparams)); list($insql, $inparams) = $DB->get_in_or_equal($preferences); $this->assertEquals(6, $DB->count_records_select('user_preferences', "name $insql", $inparams)); // Keep a block on the side. $allblockids = $blockids; $tokeep = array_pop($blockids); // Delete and confirm what should have happened. blocks_delete_instances($blockids); // Reload the manager. list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->load_blocks(); $blocks = $blockmanager->get_blocks_for_region($regionname); $this->assertCount(1, $blocks); list($insql, $inparams) = $DB->get_in_or_equal($allblockids); $this->assertEquals(1, $DB->count_records_select('block_positions', "blockinstanceid $insql", $inparams)); list($insql, $inparams) = $DB->get_in_or_equal($preferences); $this->assertEquals(2, $DB->count_records_select('user_preferences', "name $insql", $inparams));
< $this->assertFalse(context_block::instance($blockids[0], IGNORE_MISSING)); < $this->assertFalse(context_block::instance($blockids[1], IGNORE_MISSING)); < context_block::instance($tokeep); // Would throw an exception if it was deleted.
> $this->assertFalse(\context_block::instance($blockids[0], IGNORE_MISSING)); > $this->assertFalse(\context_block::instance($blockids[1], IGNORE_MISSING)); > \context_block::instance($tokeep); // Would throw an exception if it was deleted.
} public function test_create_all_block_instances() { global $CFG, $PAGE, $DB; $this->setAdminUser(); $this->resetAfterTest(); $regionname = 'side-pre';
< $context = context_system::instance();
> $context = \context_system::instance();
$PAGE->reset_theme_and_output(); $CFG->theme = 'boost'; list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->load_blocks(); $blockmanager->create_all_block_instances(); $blocks = $blockmanager->get_blocks_for_region($regionname); // Assert that we no auto created blocks in boost by default. $this->assertEmpty($blocks); // There should be no blocks in the DB. $PAGE->reset_theme_and_output(); // Change to a theme with undeletable blocks. $CFG->theme = 'classic'; list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->show_only_fake_blocks(true); $blockmanager->load_blocks(); $blockmanager->create_all_block_instances(); $blocks = $blockmanager->get_blocks_for_region($regionname); // Assert that we no auto created blocks when viewing a fake blocks only page. $this->assertEmpty($blocks); $PAGE->reset_theme_and_output(); list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->show_only_fake_blocks(false); $blockmanager->load_blocks(); $blockmanager->create_all_block_instances(); $blocks = $blockmanager->get_blocks_for_region($regionname); // Assert that we get the required block for this theme auto-created. $this->assertCount(2, $blocks); $PAGE->reset_theme_and_output(); list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->protect_block('html'); $blockmanager->load_blocks(); $blockmanager->create_all_block_instances(); $blocks = $blockmanager->get_blocks_for_region($regionname); // Assert that protecting a block does not make it auto-created. $this->assertCount(2, $blocks); $requiredbytheme = $blockmanager->get_required_by_theme_block_types(); foreach ($requiredbytheme as $blockname) { $instance = $DB->get_record('block_instances', array('blockname' => $blockname)); $this->assertEquals(1, $instance->requiredbytheme); } // Switch back and those auto blocks should not be returned. $PAGE->reset_theme_and_output(); $CFG->theme = 'boost'; list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); $blockmanager->load_blocks(); $blockmanager->create_all_block_instances(); $blocks = $blockmanager->get_blocks_for_region($regionname); // Assert that we do not return requiredbytheme blocks when they are not required. $this->assertEmpty($blocks); // But they should exist in the DB. foreach ($requiredbytheme as $blockname) { $count = $DB->count_records('block_instances', array('blockname' => $blockname)); $this->assertEquals(1, $count); } } /** * Test the block instance time fields (timecreated, timemodified). */ public function test_block_instance_times() { global $DB; $this->purge_blocks(); // Set up fixture. $regionname = 'a-region'; $blockname = 'html';
< $context = context_system::instance();
> $context = \context_system::instance();
list($page, $blockmanager) = $this->get_a_page_and_block_manager(array($regionname), $context, 'page-type'); // Add block to page. $before = time(); $blockmanager->add_block($blockname, $regionname, 0, false); $after = time(); // Check database table to ensure it contains created/modified times. $blockdata = $DB->get_record('block_instances', ['blockname' => 'html']); $this->assertTrue($blockdata->timemodified >= $before && $blockdata->timemodified <= $after); $this->assertTrue($blockdata->timecreated >= $before && $blockdata->timecreated <= $after); // Get block from manager. $blockmanager->load_blocks(); $blocks = $blockmanager->get_blocks_for_region($regionname); $block = reset($blocks); // Wait until at least the next second. while (time() === $after) { usleep(100000); } // Update block settings. $this->setAdminUser(); $data = (object)['text' => ['text' => 'New text', 'itemid' => 0, 'format' => FORMAT_HTML]]; $before = time(); $block->instance_config_save($data); $after = time(); // Check time modified updated, but time created didn't. $newblockdata = $DB->get_record('block_instances', ['blockname' => 'html']); $this->assertTrue( $newblockdata->timemodified >= $before && $newblockdata->timemodified <= $after && $newblockdata->timemodified > $blockdata->timemodified); $this->assertEquals($blockdata->timecreated, $newblockdata->timecreated); // Also try repositioning the block. while (time() === $after) { usleep(100000); } $before = time(); $blockmanager->reposition_block($blockdata->id, $regionname, 10); $after = time(); $blockdata = $newblockdata; $newblockdata = $DB->get_record('block_instances', ['blockname' => 'html']); $this->assertTrue( $newblockdata->timemodified >= $before && $newblockdata->timemodified <= $after && $newblockdata->timemodified > $blockdata->timemodified); $this->assertEquals($blockdata->timecreated, $newblockdata->timecreated); } /** * Tests that dashboard pages get their blocks loaded correctly. */ public function test_default_dashboard() { global $CFG, $PAGE, $DB; $storedpage = $PAGE; require_once($CFG->dirroot . '/my/lib.php'); $this->purge_blocks(); $regionname = 'a-region'; $blockname = $this->get_a_known_block_type(); $user = self::getDataGenerator()->create_user();
< $syscontext = context_system::instance(); < $usercontext = context_user::instance($user->id);
> $syscontext = \context_system::instance(); > $usercontext = \context_user::instance($user->id);
// Add sitewide 'sticky' blocks. The page is not setup exactly as a site page would be... // but it does seem to mean that the bloacks are added correctly. list($sitepage, $sitebm) = $this->get_a_page_and_block_manager(array($regionname), $syscontext, 'site-index'); $sitebm->add_block($blockname, $regionname, 0, true, '*'); $sitestickyblock1 = $this->get_last_created_block(); $sitebm->add_block($blockname, $regionname, 1, true, '*'); $sitestickyblock2 = $this->get_last_created_block(); $sitebm->add_block($blockname, $regionname, 8, true, '*'); $sitestickyblock3 = $this->get_last_created_block(); // Blocks that should not be picked up by any other pages in this unit test. $sitebm->add_block($blockname, $regionname, -8, true, 'site-index-*'); $sitebm->add_block($blockname, $regionname, -9, true, 'site-index'); $sitebm->load_blocks(); // This repositioning should not be picked up. $sitebm->reposition_block($sitestickyblock3->id, $regionname, 9); // Setup the default dashboard page. This adds the blocks with the correct parameters, but seems to not be // an exact page/blockmanager setup for the default dashboard setup page. $defaultmy = my_get_page(null, MY_PAGE_PRIVATE); list($defaultmypage, $defaultmybm) = $this->get_a_page_and_block_manager(array($regionname), null, 'my-index', $defaultmy->id); $PAGE = $defaultmypage; $defaultmybm->add_block($blockname, $regionname, -2, false, $defaultmypage->pagetype, $defaultmypage->subpage); $defaultblock1 = $this->get_last_created_block(); $defaultmybm->add_block($blockname, $regionname, 3, false, $defaultmypage->pagetype, $defaultmypage->subpage); $defaultblock2 = $this->get_last_created_block(); $defaultmybm->load_blocks(); $defaultmybm->reposition_block($sitestickyblock1->id, $regionname, 4); // Setup the user's dashboard. $usermy = my_copy_page($user->id); list($mypage, $mybm) = $this->get_a_page_and_block_manager(array($regionname), $usercontext, 'my-index', $usermy->id); $PAGE = $mypage; $mybm->add_block($blockname, $regionname, 5, false, $mypage->pagetype, $mypage->subpage); $block1 = $this->get_last_created_block(); $mybm->load_blocks(); $mybm->reposition_block($sitestickyblock2->id, $regionname, -1); // Reload the blocks in the managers.
< context_helper::reset_caches();
> \context_helper::reset_caches();
$defaultmybm->reset_caches(); $this->assertNull($defaultmybm->get_loaded_blocks()); $defaultmybm->load_blocks(); $this->assertNotNull($defaultmybm->get_loaded_blocks()); $defaultbr = $defaultmybm->get_blocks_for_region($regionname); $mybm->reset_caches(); $this->assertNull($mybm->get_loaded_blocks()); $mybm->load_blocks(); $this->assertNotNull($mybm->get_loaded_blocks()); $mybr = $mybm->get_blocks_for_region($regionname); // Test that a user dashboard when forced to use the default finds the correct blocks. list($forcedmypage, $forcedmybm) = $this->get_a_page_and_block_manager(array($regionname), $usercontext, 'my-index', $defaultmy->id); $forcedmybm->load_blocks(); $forcedmybr = $forcedmybm->get_blocks_for_region($regionname); // Check that the default page is in the expected order. $this->assertCount(5, $defaultbr); $this->assertEquals($defaultblock1->id, $defaultbr[0]->instance->id); $this->assertEquals('-2', $defaultbr[0]->instance->weight); $this->assertEquals($sitestickyblock2->id, $defaultbr[1]->instance->id); $this->assertEquals('1', $defaultbr[1]->instance->weight); $this->assertEquals($defaultblock2->id, $defaultbr[2]->instance->id); $this->assertEquals('3', $defaultbr[2]->instance->weight); $this->assertEquals($sitestickyblock1->id, $defaultbr[3]->instance->id); $this->assertEquals('4', $defaultbr[3]->instance->weight); $this->assertEquals($sitestickyblock3->id, $defaultbr[4]->instance->id); $this->assertEquals('8', $defaultbr[4]->instance->weight); // Check that the correct block are present in the expected order for a. $this->assertCount(5, $forcedmybr); $this->assertEquals($defaultblock1->id, $forcedmybr[0]->instance->id); $this->assertEquals('-2', $forcedmybr[0]->instance->weight); $this->assertEquals($sitestickyblock2->id, $forcedmybr[1]->instance->id); $this->assertEquals('1', $forcedmybr[1]->instance->weight); $this->assertEquals($defaultblock2->id, $forcedmybr[2]->instance->id); $this->assertEquals('3', $forcedmybr[2]->instance->weight); $this->assertEquals($sitestickyblock1->id, $forcedmybr[3]->instance->id); $this->assertEquals('4', $forcedmybr[3]->instance->weight); $this->assertEquals($sitestickyblock3->id, $forcedmybr[4]->instance->id); $this->assertEquals('8', $forcedmybr[4]->instance->weight); // Check that the correct blocks are present in the standard my page. $this->assertCount(6, $mybr); $this->assertEquals('-2', $mybr[0]->instance->weight); $this->assertEquals($sitestickyblock2->id, $mybr[1]->instance->id); $this->assertEquals('-1', $mybr[1]->instance->weight); $this->assertEquals('3', $mybr[2]->instance->weight); // Test the override on the first sticky block was copied and picked up. $this->assertEquals($sitestickyblock1->id, $mybr[3]->instance->id); $this->assertEquals('4', $mybr[3]->instance->weight); $this->assertEquals($block1->id, $mybr[4]->instance->id); $this->assertEquals('5', $mybr[4]->instance->weight); $this->assertEquals($sitestickyblock3->id, $mybr[5]->instance->id); $this->assertEquals('8', $mybr[5]->instance->weight); $PAGE = $storedpage; }
< }
/**
< * Test-specific subclass to make some protected things public. < */ < class testable_block_manager extends block_manager { < /** < * Resets the caches in the block manager. < * This allows blocks to be reloaded correctly.
> * Test get_unaddable_by_theme_block_types() method to return expected result depending on the theme. > * > * @covers \block_manager::get_unaddable_by_theme_block_types
*/
< public function reset_caches() { < $this->birecordsbyregion = null; < $this->blockinstances = array(); < $this->visibleblockcontent = array(); < } < public function mark_loaded() { < $this->birecordsbyregion = array(); < } < public function get_loaded_blocks() { < return $this->birecordsbyregion; < } < }
> public function test_get_unaddable_by_theme_block_types(): void { > global $CFG, $PAGE;
< /** < * Test-specific subclass to make some protected things public. < */ < class block_ablocktype extends block_base { < public function init() {
> $this->setAdminUser(); > $this->resetAfterTest(); > $regionname = 'side-pre'; > $context = \context_system::instance(); > > $PAGE->reset_theme_and_output(); > $CFG->theme = 'boost'; > > list($page, $blockmanager) = $this->get_a_page_and_block_manager([$regionname], $context, 'page-type'); > $blockmanager->load_blocks(); > $blocks = $blockmanager->get_unaddable_by_theme_block_types(); > // Assert that a few blocks are excluded for boost theme. > $this->assertCount(4, $blocks); > $this->assertContains('navigation', $blocks); > $this->assertContains('settings', $blocks); > $this->assertContains('course_list', $blocks); > $this->assertContains('section_links', $blocks); > > // Change to a theme without unaddable blocks. > $PAGE->reset_theme_and_output(); > $CFG->theme = 'classic'; > > list($page, $blockmanager) = $this->get_a_page_and_block_manager([$regionname], $context, 'page-type'); > $blockmanager->load_blocks(); > $blocks = $blockmanager->get_unaddable_by_theme_block_types(); > // Assert that no blocks are excluded for classic theme. > $this->assertEmpty($blocks);
} }