From 33499f32d3d73f47acdb4ea0d27fc950130b313d Mon Sep 17 00:00:00 2001
From: Sara Arjona <sara@moodle.com>
Date: Wed, 15 Dec 2021 12:30:21 +0100
Subject: [PATCH] MDL-73339 globalsearch: Add block only if main feature is
 enabled

The Global search block should be added only if the global search
advanced feature is enabled.
---
 blocks/globalsearch/block_globalsearch.php    | 12 ++++
 .../globalsearch/tests/globalsearch_test.php  | 63 +++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 blocks/globalsearch/tests/globalsearch_test.php

diff --git a/blocks/globalsearch/block_globalsearch.php b/blocks/globalsearch/block_globalsearch.php
index 91892ae26eb..c10400588d5 100644
--- a/blocks/globalsearch/block_globalsearch.php
+++ b/blocks/globalsearch/block_globalsearch.php
@@ -78,4 +78,16 @@ class block_globalsearch extends block_base {
 
         return $this->content;
     }
+
+    /**
+     * This block shouldn't be added to a page if the global search advanced feature is disabled.
+     *
+     * @param moodle_page $page
+     * @return bool
+     */
+    public function can_block_be_added(moodle_page $page): bool {
+        global $CFG;
+
+        return $CFG->enableglobalsearch;
+    }
 }
diff --git a/blocks/globalsearch/tests/globalsearch_test.php b/blocks/globalsearch/tests/globalsearch_test.php
new file mode 100644
index 00000000000..ade091083a8
--- /dev/null
+++ b/blocks/globalsearch/tests/globalsearch_test.php
@@ -0,0 +1,63 @@
+<?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/>.
+
+namespace block_globalsearch\tests;
+
+use advanced_testcase;
+use block_globalsearch;
+use context_course;
+
+/**
+ * PHPUnit block_globalsearch tests
+ *
+ * @package    block_globalsearch
+ * @category   test
+ * @copyright  2021 Sara Arjona (sara@moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @coversDefaultClass \block_globalsearch
+ */
+class globalsearch_test extends advanced_testcase {
+    public static function setUpBeforeClass(): void {
+        require_once(__DIR__ . '/../../moodleblock.class.php');
+        require_once(__DIR__ . '/../block_globalsearch.php');
+    }
+
+    /**
+     * Test the behaviour of can_block_be_added() method.
+     *
+     * @covers ::can_block_be_added
+     */
+    public function test_can_block_be_added(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        // Create a course and prepare the page where the block will be added.
+        $course = $this->getDataGenerator()->create_course();
+        $page = new \moodle_page();
+        $page->set_context(context_course::instance($course->id));
+        $page->set_pagelayout('course');
+
+        $block = new block_globalsearch();
+
+        // If global search advanced feature is enabled, the method should return true.
+        set_config('enableglobalsearch', true);
+        $this->assertTrue($block->can_block_be_added($page));
+
+        // However, if the global search advanced feature is disabled, the method should return false.
+        set_config('enableglobalsearch', false);
+        $this->assertFalse($block->can_block_be_added($page));
+    }
+}