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/>.

namespace qbank_bulkmove;

use core_question\local\bank\question_edit_contexts;

defined('MOODLE_INTERNAL') || die();

global $CFG;
require_once($CFG->dirroot . '/question/editlib.php');

/**
 * Bulk move helper tests.
 *
 * @package    qbank_bulkmove
 * @copyright  2021 Catalyst IT Australia Pty Ltd
 * @author     Safat Shahin <safatshahin@catalyst-au.net>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @coversDefaultClass \qbank_bulkmove\helper
 */
class helper_test extends \advanced_testcase {

    /**
     * @var false|object|\stdClass|null $cat
     */
    protected $cat;

    /**
     * @var \stdClass $questiondata1
     */
    protected $questiondata1;

    /**
     * @var \stdClass $questiondata2
     */
    protected $questiondata2;

    /**
     * @var bool|\context|\context_course $context
     */
    protected $context;

    /**
     * @var \core_question\local\bank\question_edit_contexts $contexts
     */
    protected $contexts;

    /**
     * @var \stdClass $course
     */
    protected $course;

    /**
     * @var array $rawdata
     */
    protected $rawdata;

    /**
     * @var object $secondcategory
     */
    protected $secondcategory;

    /**
     * Setup the test.
     */
    protected function helper_setup(): void {
        $this->resetAfterTest();
        $this->setAdminUser();
        $generator = $this->getDataGenerator();
        /** @var \core_question_generator $questiongenerator */
        $questiongenerator = $generator->get_plugin_generator('core_question');

        // Create a course.
        $this->course = $generator->create_course();
        $this->context = \context_course::instance($this->course->id);

        // Create a question in the default category.
        $this->contexts = new question_edit_contexts($this->context);
        $this->cat = question_make_default_categories($this->contexts->all());
        $this->questiondata1 = $questiongenerator->create_question('numerical', null,
            ['name' => 'Example question', 'category' => $this->cat->id]);

        // Create a second category to move questions.
        $this->secondcategory = $questiongenerator->create_question_category(['contextid' => $this->context->id,
            'parent' => $this->cat->id]);

        // Ensure the question is not in the cache.
        $cache = \cache::make('core', 'questiondata');
        $cache->delete($this->questiondata1->id);

        $this->questiondata2 = $questiongenerator->create_question('numerical', null,
            ['name' => 'Example question second', 'category' => $this->cat->id]);

        // Ensure the question is not in the cache.
        $cache = \cache::make('core', 'questiondata');
        $cache->delete($this->questiondata2->id);

        // Posted raw data.
        $this->rawdata = [
            'courseid' => $this->course->id,
            'cat' => "{$this->cat->id},{$this->context->id}",
            'qpage' => '0',
            "q{$this->questiondata1->id}" => '1',
            "q{$this->questiondata2->id}" => '1',
            'move' => 'Move to'
        ];
    }

    /**
> * Count how many questions in the list belong to the given category. * Test bulk move of questions. > * * > * @param string $categoryid a category id * @covers ::bulk_move_questions > * @param array $questionids list of question ids */ > * @return int public function test_bulk_move_questions() { > */ $this->helper_setup(); > private function count_category_questions(string $categoryid, array $questionids): int { // Verify that the questions are available in the current view. > global $DB; $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); > $this->assertNotEmpty($questionids); ob_start(); > list($insql, $inparams) = $DB->get_in_or_equal($questionids, SQL_PARAMS_NAMED); $pagevars = [ > $sql = "SELECT COUNT(q.id) 'qpage' => 0, > FROM {question} q 'qperpage' => DEFAULT_QUESTIONS_PER_PAGE, > JOIN {question_versions} qv ON qv.questionid = q.id 'cat' => $this->cat->id . ',' . $this->context->id, > JOIN {question_bank_entries} qbe ON qbe.id = qv.questionbankentryid 'recurse' => false, > JOIN {question_categories} qc ON qc.id = qbe.questioncategoryid 'showhidden' => false, > WHERE qc.id = :categoryid 'qbshowtext' => false > AND q.id $insql"; ]; > $view->display($pagevars, 'editq'); > return $DB->count_records_sql($sql, array_merge(['categoryid' => $categoryid], $inparams)); $html = ob_get_clean(); > } $this->assertStringContainsString('Example question', $html); > $this->assertStringContainsString('Example question second', $html); > /** > * Assert that the given category contains following questions // Get the processed question ids. > * $questionlist = $this->process_question_ids_test(); > * @param string $categoryid a category id > * @param array $questionids list of question ids helper::bulk_move_questions($questionlist, $this->secondcategory); > * @return void > */ // Verify the questions are not in the current category. > protected function assert_category_contains_questions(string $categoryid, array $questionids) { $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); > // The category need to contain all the questions. ob_start(); > $this->assertEquals(count($questionids), $this->count_category_questions($categoryid, $questionids)); $pagevars = [ > } 'qpage' => 0, > 'qperpage' => DEFAULT_QUESTIONS_PER_PAGE, > /** 'cat' => $this->cat->id . ',' . $this->context->id, > * Assert that the given category does not contain following questions 'recurse' => false, > * 'showhidden' => false, > * @param string $categoryid a category id 'qbshowtext' => false > * @param array $questionids list of question ids ]; > * @return void $view->display($pagevars, 'editq'); > */ $html = ob_get_clean(); > protected function assert_category_does_not_contain_questions(string $categoryid, array $questionids) { $this->assertStringNotContainsString('Example question', $html); > // The category does not contain any question. $this->assertStringNotContainsString('Example question second', $html); > $this->assertEquals(0, $this->count_category_questions($categoryid, $questionids)); > } // Verify the questions are in the new category. > $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); > /**
ob_start();
> global $DB;
< // Verify that the questions are available in the current view. < $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); < ob_start(); < $pagevars = [ < 'qpage' => 0, < 'qperpage' => DEFAULT_QUESTIONS_PER_PAGE, < 'cat' => $this->cat->id . ',' . $this->context->id, < 'recurse' => false, < 'showhidden' => false, < 'qbshowtext' => false < ]; < $view->display($pagevars, 'editq'); < $html = ob_get_clean(); < $this->assertStringContainsString('Example question', $html); < $this->assertStringContainsString('Example question second', $html);
/**
> $questionids = array_map('intval', explode(',', $questionlist));
* Test the question processing and return the question list.
> // Verify that the questions are available in the current view. * > $this->assert_category_contains_questions($this->cat->id, $questionids);
< $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); < ob_start(); < $pagevars = [ < 'qpage' => 0, < 'qperpage' => DEFAULT_QUESTIONS_PER_PAGE, < 'cat' => $this->cat->id . ',' . $this->context->id, < 'recurse' => false, < 'showhidden' => false, < 'qbshowtext' => false < ]; < $view->display($pagevars, 'editq'); < $html = ob_get_clean(); < $this->assertStringNotContainsString('Example question', $html); < $this->assertStringNotContainsString('Example question second', $html);
> $this->assert_category_does_not_contain_questions($this->cat->id, $questionids);
< $view = new \core_question\local\bank\view($this->contexts, new \moodle_url('/'), $this->course); < ob_start(); < $pagevars = [ < 'qpage' => 0, < 'qperpage' => DEFAULT_QUESTIONS_PER_PAGE, < 'cat' => $this->secondcategory->id . ',' . $this->context->id, < 'category' => $this->secondcategory->id . ',' . $this->context->id, < 'recurse' => false, < 'showhidden' => false, < 'qbshowtext' => false < ]; < $view->display($pagevars, 'editq'); < $html = ob_get_clean(); < $this->assertStringContainsString('Example question', $html); < $this->assertStringContainsString('Example question second', $html);
> $this->assert_category_contains_questions($this->secondcategory->id, $questionids);