<?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/>.
/**
* Defines the custom question bank view used on the Edit quiz page.
*
* @package mod_quiz
* @category question
* @copyright 1999 onwards Martin Dougiamas and others {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_quiz\question\bank;
> defined('MOODLE_INTERNAL') || die();
use core_question\local\bank\question_version_status;
>
use mod_quiz\question\bank\filter\custom_category_condition;
> use core\output\datafilter;
> use core_question\local\bank\column_base;
/**
> use core_question\local\bank\condition;
* Subclass to customise the view of the question bank for the quiz editing screen.
> use core_question\local\bank\column_manager_base;
*
> use qbank_managecategories\category_condition;
* @copyright 2009 Tim Hunt
> require_once($CFG->dirroot . '/mod/quiz/locallib.php');
* @author 2021 Safat Shahin <safatshahin@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class custom_view extends \core_question\local\bank\view {
/** @var int number of questions per page to show in the add from question bank modal. */
const DEFAULT_PAGE_SIZE = 20;
/** @var bool $quizhasattempts whether the quiz this is used by has been attemptd. */
protected $quizhasattempts = false;
/** @var \stdClass $quiz the quiz settings. */
protected $quiz = false;
< /** @var int The maximum displayed length of the category info. */
< const MAX_TEXT_LENGTH = 200;
> /**
> * @var string $component the component the api is used from.
> */
> public $component = 'mod_quiz';
/**
* Constructor.
* @param \core_question\local\bank\question_edit_contexts $contexts
* @param \moodle_url $pageurl
* @param \stdClass $course course settings
* @param \stdClass $cm activity settings.
* @param \stdClass $quiz quiz settings.
*/
< public function __construct($contexts, $pageurl, $course, $cm, $quiz) {
< parent::__construct($contexts, $pageurl, $course, $cm);
< $this->quiz = $quiz;
< $this->pagesize = self::DEFAULT_PAGE_SIZE;
< }
<
< protected function get_question_bank_plugins(): array {
< $questionbankclasscolumns = [];
< $corequestionbankcolumns = [
< 'add_action_column',
< 'checkbox_column',
< 'question_type_column',
< 'question_name_text_column',
< 'preview_action_column'
> public function __construct($contexts, $pageurl, $course, $cm, $params, $extraparams) {
> // Default filter condition.
> if (!isset($params['filter'])) {
> $params['filter'] = [];
> [$categoryid, $contextid] = custom_category_condition::validate_category_param($params['cat']);
> if (!is_null($categoryid)) {
> $category = custom_category_condition::get_category_record($categoryid, $contextid);
> $params['filter']['category'] = [
> 'jointype' => custom_category_condition::JOINTYPE_DEFAULT,
> 'values' => [$category->id],
> 'filteroptions' => ['includesubcategories' => false],
];
<
< if (question_get_display_preference('qbshowtext', 0, PARAM_INT, new \moodle_url(''))) {
< $corequestionbankcolumns[] = 'question_text_row';
}
<
< foreach ($corequestionbankcolumns as $fullname) {
< $shortname = $fullname;
< if (class_exists('mod_quiz\\question\\bank\\' . $fullname)) {
< $fullname = 'mod_quiz\\question\\bank\\' . $fullname;
< $questionbankclasscolumns[$shortname] = new $fullname($this);
< } else if (class_exists('core_question\\local\\bank\\' . $fullname)) {
< $fullname = 'core_question\\local\\bank\\' . $fullname;
< $questionbankclasscolumns[$shortname] = new $fullname($this);
< } else {
< $questionbankclasscolumns[$shortname] = '';
< }
< }
< $plugins = \core_component::get_plugin_list_with_class('qbank', 'plugin_feature', 'plugin_feature.php');
< foreach ($plugins as $componentname => $plugin) {
< $pluginentrypointobject = new $plugin();
< $plugincolumnobjects = $pluginentrypointobject->get_question_columns($this);
< // Don't need the plugins without column objects.
< if (empty($plugincolumnobjects)) {
< unset($plugins[$componentname]);
< continue;
< }
< foreach ($plugincolumnobjects as $columnobject) {
< $columnname = $columnobject->get_column_name();
< foreach ($corequestionbankcolumns as $key => $corequestionbankcolumn) {
< if (!\core\plugininfo\qbank::is_plugin_enabled($componentname)) {
< unset($questionbankclasscolumns[$columnname]);
< continue;
< }
< // Check if it has custom preference selector to view/hide.
< if ($columnobject->has_preference() && !$columnobject->get_preference()) {
< continue;
< }
< if ($corequestionbankcolumn === $columnname) {
< $questionbankclasscolumns[$columnname] = $columnobject;
}
>
}
> $this->init_columns($this->wanted_columns(), $this->heading_column());
}
> parent::__construct($contexts, $pageurl, $course, $cm, $params, $extraparams);
}
> [$this->quiz, ] = get_module_from_cmid($cm->id);
> $this->set_quiz_has_attempts(quiz_has_attempts($this->quiz->id));
// Mitigate the error in case of any regression.
> $this->pagesize = self::DEFAULT_PAGE_SIZE;
foreach ($questionbankclasscolumns as $shortname => $questionbankclasscolumn) {
>
if (empty($questionbankclasscolumn)) {
> /**
unset($questionbankclasscolumns[$shortname]);
> * Just use the base column manager in this view.
}
> *
}
> * @return void
> */
return $questionbankclasscolumns;
> protected function init_column_manager(): void {
}
> $this->columnmanager = new column_manager_base();
>
protected function heading_column(): string {
> /**
return 'mod_quiz\\question\\bank\\question_name_text_column';
> * Don't display plugin controls.
}
> *
> * @param \core\context $context
protected function default_sort(): array {
> * @param int $categoryid
// Using the extended class for quiz specific sort.
> * @return string
return [
> */
'qbank_viewquestiontype\\question_type_column' => 1,
> protected function get_plugin_controls(\core\context $context, int $categoryid): string {
'mod_quiz\\question\\bank\\question_name_text_column' => 1,
> return '';
< // Mitigate the error in case of any regression.
< foreach ($questionbankclasscolumns as $shortname => $questionbankclasscolumn) {
< if (empty($questionbankclasscolumn)) {
< unset($questionbankclasscolumns[$shortname]);
> protected function get_question_bank_plugins(): array {
> $questionbankclasscolumns = [];
> $customviewcolumns = [
> 'mod_quiz\question\bank\add_action_column' . column_base::ID_SEPARATOR . 'add_action_column',
> 'core_question\local\bank\checkbox_column' . column_base::ID_SEPARATOR . 'checkbox_column',
> 'qbank_viewquestiontype\question_type_column' . column_base::ID_SEPARATOR . 'question_type_column',
> 'mod_quiz\question\bank\question_name_text_column' . column_base::ID_SEPARATOR . 'question_name_text_column',
> 'mod_quiz\question\bank\preview_action_column' . column_base::ID_SEPARATOR . 'preview_action_column',
> ];
>
> foreach ($customviewcolumns as $columnid) {
> [$columnclass, $columnname] = explode(column_base::ID_SEPARATOR, $columnid, 2);
> if (class_exists($columnclass)) {
> $questionbankclasscolumns[$columnid] = $columnclass::from_column_name($this, $columnname);
< 'qbank_viewquestiontype\\question_type_column' => 1,
< 'mod_quiz\\question\\bank\\question_name_text_column' => 1,
> 'qbank_viewquestiontype__question_type_column' => SORT_ASC,
> 'mod_quiz__question__bank__question_name_text_column' => SORT_ASC,
* should be displayed.
*
* @param bool $quizhasattempts whether the quiz has attempts.
*/
< public function set_quiz_has_attempts($quizhasattempts): void {
> private function set_quiz_has_attempts($quizhasattempts): void {
$this->quizhasattempts = $quizhasattempts;
if ($quizhasattempts && isset($this->visiblecolumns['addtoquizaction'])) {
unset($this->visiblecolumns['addtoquizaction']);
}
}
/**
< * Question preview url.
< *
< * @param \stdClass $question
< * @return \moodle_url
< */
< public function preview_question_url($question) {
< return quiz_question_preview_url($this->quiz, $question);
< }
<
< /**
* URL of add to quiz.
*
* @param $questionid
* @return \moodle_url
*/
public function add_to_quiz_url($questionid) {
$params = $this->baseurl->params();
$params['addquestion'] = $questionid;
$params['sesskey'] = sesskey();
> $params['cmid'] = $this->cm->id;
return new \moodle_url('/mod/quiz/edit.php', $params);
}
/**
* Renders the html question bank (same as display, but returns the result).
*
* Note that you can only output this rendered result once per page, as
* it contains IDs which must be unique.
*
* @param array $pagevars
* @param string $tabname
* @return string HTML code for the form
*/
public function render($pagevars, $tabname): string {
ob_start();
< $this->display($pagevars, $tabname);
> $this->display();
$out = ob_get_contents();
ob_end_clean();
return $out;
}
protected function display_bottom_controls(\context $catcontext): void {
$cmoptions = new \stdClass();
$cmoptions->hasattempts = !empty($this->quizhasattempts);
$canuseall = has_capability('moodle/question:useall', $catcontext);
echo \html_writer::start_tag('div', ['class' => 'pt-2']);
if ($canuseall) {
// Add selected questions to the quiz.
$params = [
'type' => 'submit',
'name' => 'add',
'class' => 'btn btn-primary',
'value' => get_string('addselectedquestionstoquiz', 'quiz'),
'data-action' => 'toggle',
'data-togglegroup' => 'qbank',
'data-toggle' => 'action',
'disabled' => true,
];
echo \html_writer::empty_tag('input', $params);
}
echo \html_writer::end_tag('div');
}
> /**
protected function create_new_question_form($category, $canadd): void {
> * Override the base implementation in \core_question\local\bank\view
// Don't display this.
> * because we don't want to print new question form in the fragment
}
> * for the modal.
> *
/**
> * @param false|mixed|\stdClass $category
* Override the base implementation in \core_question\local\bank\view
> * @param bool $canadd
* because we don't want to print the headers in the fragment
> */
< // Don't display this.
*/
protected function display_question_bank_header(): void {
}
< /**
< * Override the base implementation in \core_question\bank\view
< * because we don't want it to read from the $_POST global variables
< * for the sort parameters since they are not present in a fragment.
< *
< * Unfortunately the best we can do is to look at the URL for
< * those parameters (only marginally better really).
< */
< protected function init_sort_from_params(): void {
< $this->sort = [];
< for ($i = 1; $i <= self::MAX_SORTS; $i++) {
< if (!$sort = $this->baseurl->param('qbs' . $i)) {
< break;
< }
< // Work out the appropriate order.
< $order = 1;
< if ($sort[0] == '-') {
< $order = -1;
< $sort = substr($sort, 1);
< if (!$sort) {
< break;
< }
< }
< // Deal with subsorts.
< list($colname) = $this->parse_subsort($sort);
< $this->get_column_type($colname);
< $this->sort[$sort] = $order;
< }
< }
<
protected function build_query(): void {
// Get the required tables and fields.
< $joins = [];
< $fields = ['qv.status', 'qc.id as categoryid', 'qv.version', 'qv.id as versionid', 'qbe.id as questionbankentryid'];
< if (!empty($this->requiredcolumns)) {
< foreach ($this->requiredcolumns as $column) {
< $extrajoins = $column->get_extra_joins();
< foreach ($extrajoins as $prefix => $join) {
< if (isset($joins[$prefix]) && $joins[$prefix] != $join) {
< throw new \coding_exception('Join ' . $join . ' conflicts with previous join ' . $joins[$prefix]);
< }
< $joins[$prefix] = $join;
< }
< $fields = array_merge($fields, $column->get_required_fields());
< }
< }
< $fields = array_unique($fields);
> [$fields, $joins] = $this->get_component_requirements(array_merge($this->requiredcolumns, $this->questionactions));
// Build the order by clause.
$sorts = [];
< foreach ($this->sort as $sort => $order) {
< list($colname, $subsort) = $this->parse_subsort($sort);
< $sorts[] = $this->requiredcolumns[$colname]->sort_expression($order < 0, $subsort);
> foreach ($this->sort as $sortname => $sortorder) {
> [$colname, $subsort] = $this->parse_subsort($sortname);
> $sorts[] = $this->requiredcolumns[$colname]->sort_expression($sortorder == SORT_DESC, $subsort);
}
// Build the where clause.
$latestversion = 'qv.version = (SELECT MAX(v.version)
FROM {question_versions} v
JOIN {question_bank_entries} be
ON be.id = v.questionbankentryid
WHERE be.id = qbe.id)';
< $readyonly = "qv.status = '" . question_version_status::QUESTION_STATUS_READY . "' ";
< $tests = ['q.parent = 0', $latestversion, $readyonly];
> $onlyready = '((' . "qv.status = '" . question_version_status::QUESTION_STATUS_READY . "'" .'))';
$this->sqlparams = [];
> $conditions = [];
foreach ($this->searchconditions as $searchcondition) {
if ($searchcondition->where()) {
< $tests[] = '((' . $searchcondition->where() .'))';
> $conditions[] = '((' . $searchcondition->where() .'))';
}
if ($searchcondition->params()) {
$this->sqlparams = array_merge($this->sqlparams, $searchcondition->params());
}
}
> $majorconditions = ['q.parent = 0', $latestversion, $onlyready];
// Build the SQL.
> // Get higher level filter condition.
$sql = ' FROM {question} q ' . implode(' ', $joins);
> $jointype = isset($this->pagevars['jointype']) ? (int)$this->pagevars['jointype'] : condition::JOINTYPE_DEFAULT;
$sql .= ' WHERE ' . implode(' AND ', $tests);
> $nonecondition = ($jointype === datafilter::JOINTYPE_NONE) ? ' NOT ' : '';
$this->countsql = 'SELECT count(1)' . $sql;
> $separator = ($jointype === datafilter::JOINTYPE_ALL) ? ' AND ' : ' OR ';
< $sql .= ' WHERE ' . implode(' AND ', $tests);
> $sql .= ' WHERE ' . implode(' AND ', $majorconditions);
> if (!empty($conditions)) {
> $sql .= ' AND ' . $nonecondition . ' ( ';
> $sql .= implode($separator, $conditions);
> $sql .= ' ) ';
> }
}
< public function wanted_filters($cat, $tagids, $showhidden, $recurse, $editcontexts, $showquestiontext): void {
< global $CFG;
< list(, $contextid) = explode(',', $cat);
< $catcontext = \context::instance_by_id($contextid);
< $thiscontext = $this->get_most_specific_context();
< // Category selection form.
< $this->display_question_bank_header();
<
< // Display tag filter if usetags setting is enabled/enablefilters is true.
< if ($this->enablefilters) {
< if (is_array($this->customfilterobjects)) {
< foreach ($this->customfilterobjects as $filterobjects) {
< $this->searchconditions[] = $filterobjects;
< }
< } else {
< if ($CFG->usetags) {
< array_unshift($this->searchconditions,
< new \core_question\bank\search\tag_condition([$catcontext, $thiscontext], $tagids));
< }
<
< array_unshift($this->searchconditions, new \core_question\bank\search\hidden_condition(!$showhidden));
< array_unshift($this->searchconditions, new custom_category_condition(
< $cat, $recurse, $editcontexts, $this->baseurl, $this->course));
> public function add_standard_search_conditions(): void {
> foreach ($this->plugins as $componentname => $plugin) {
> if (\core\plugininfo\qbank::is_plugin_enabled($componentname)) {
> $pluginentrypointobject = new $plugin();
> if ($componentname === 'qbank_managecategories') {
> $pluginentrypointobject = new quiz_managecategories_feature();
> }
> if ($componentname === 'qbank_viewquestiontext' || $componentname === 'qbank_deletequestion') {
> continue;
> }
> $pluginobjects = $pluginentrypointobject->get_question_filters($this);
> foreach ($pluginobjects as $pluginobject) {
> $this->add_searchcondition($pluginobject, $pluginobject->get_condition_key());
> }
> }
}
}
< $this->display_options_form($showquestiontext);
>
> /**
> * Return the quiz settings for the quiz this question bank is displayed in.
> *
> * @return bool|\stdClass
> */
> public function get_quiz() {
> return $this->quiz;
}
}