Skip to content

Commit

Permalink
Merge branch 'master_MDL-72553_qbank_quiz' of https://github.com/cata…
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyatregubov committed Dec 8, 2021
2 parents 4d2a00f + 556e2f1 commit 4de7faf
Show file tree
Hide file tree
Showing 34 changed files with 1,841 additions and 38 deletions.
1 change: 1 addition & 0 deletions lib/classes/plugin_manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -1952,6 +1952,7 @@ public static function standard_plugins_list($type) {
'qbank' => [
'bulkmove',
'comment',
'customfields',
'deletequestion',
'editquestion',
'exporttoxml',
Expand Down
4 changes: 4 additions & 0 deletions lib/classes/plugininfo/qbank.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ public static function get_manage_url(): \moodle_url {
return new \moodle_url('/admin/settings.php', ['section' => 'manageqbanks']);
}

public function get_settings_section_name() {
return $this->type . '_' . $this->name;
}

public static function get_plugins($type, $typerootdir, $typeclass, $pluginman): array {
global $CFG;

Expand Down
4 changes: 4 additions & 0 deletions lib/questionlib.php
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,10 @@ function question_delete_question($questionid) {
// Delete all tag instances.
core_tag_tag::remove_all_item_tags('core_question', 'question', $question->id);

// Delete the custom filed data for the question.
$customfieldhandler = qbank_customfields\customfield\question_handler::create();
$customfieldhandler->delete_instance($question->id);

// Now recursively delete all child questions
if ($children = $DB->get_records('question',
array('parent' => $questionid), '', 'id, qtype')) {
Expand Down
77 changes: 60 additions & 17 deletions mod/quiz/classes/question/bank/custom_view.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

namespace mod_quiz\question\bank;

use coding_exception;

/**
* Subclass to customise the view of the question bank for the quiz editing screen.
*
Expand Down Expand Up @@ -58,32 +56,77 @@ public function __construct($contexts, $pageurl, $course, $cm, $quiz) {
$this->quiz = $quiz;
}

protected function wanted_columns(): array {
$quizquestionbankcolumns = [
'mod_quiz\\question\\bank\\add_action_column',
'core_question\\local\\bank\\checkbox_column',
'qbank_viewquestiontype\\question_type_column',
'mod_quiz\\question\\bank\\question_name_text_column',
'qbank_previewquestion\\preview_action_column',
protected function get_question_bank_plugins(): array {
$questionbankclasscolumns = [];
$corequestionbankcolumns = [
'add_action_column',
'checkbox_column',
'question_type_column',
'question_name_text_column',
'preview_action_column'
];

foreach ($quizquestionbankcolumns as $fullname) {
if (!class_exists($fullname)) {
throw new coding_exception('Invalid quiz question bank column', $fullname);
if (question_get_display_preference('qbshowtext', 0, PARAM_BOOL, 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] = '';
}
$this->requiredcolumns[$fullname] = new $fullname($this);
}
return $this->requiredcolumns;
$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;
}
}
}
}

// Mitigate the error in case of any regression.
foreach ($questionbankclasscolumns as $shortname => $questionbankclasscolumn) {
if (empty($questionbankclasscolumn)) {
unset($questionbankclasscolumns[$shortname]);
}
}

return $questionbankclasscolumns;
}

protected function heading_column(): string {
return 'mod_quiz\\question\\bank\\question_name_text_column';
return 'question_name_text_column';
}

protected function default_sort(): array {
return [
'qbank_viewquestiontype\\question_type_column' => 1,
'mod_quiz\\question\\bank\\question_name_text_column' => 1,
'question_type_column' => 1,
'question_name_text_column' => 1,
];
}

Expand Down
2 changes: 1 addition & 1 deletion mod/quiz/tests/behat/editing_add.feature
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Feature: Edit quiz page - adding things
And I open the "last" add to quiz menu
And I follow "from question bank"
Then the "Add selected questions to the quiz" "button" should be disabled
And I click on "Essay 03" "checkbox"
And I click on "Select" "checkbox" in the "Essay 03" "table_row"
Then the "Add selected questions to the quiz" "button" should be enabled
And I click on "Add to quiz" "link" in the "Essay 03" "table_row"
And I should see "Essay 03" on quiz page "1"
Expand Down
10 changes: 7 additions & 3 deletions mod/quiz/tests/behat/editing_add_from_question_bank.feature
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,11 @@ Feature: Adding questions to a quiz from the question bank
And I am on the "Quiz 1" "mod_quiz > Edit" page logged in as "teacher1"
When I open the "last" add to quiz menu
And I follow "from question bank"
And I click on "Sort by Question ascending" "link"
Then "question 01 name" "text" should appear before "question 02 name" "text"
And I click on "Sort by Question descending" "link"
And "question 03 name" "text" should appear before "question 01 name" "text"
And I follow "Sort by Question type ascending"
Then "question 01 name" "text" should appear before "question 03 name" "text"
And I follow "Sort by Question type descending"
Then "question 03 name" "checkbox" should appear before "question 01 name" "checkbox"
And I follow "Sort by Question ascending"
And "question 01 name" "checkbox" should appear before "question 02 name" "checkbox"
Then "question 03 name" "text" should appear before "question 01 name" "text"
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?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/>.

/**
* Provides the information to backup question custom field.
*
* @package qbank_customfields
* @copyright 2021 Catalyst IT Australia Pty Ltd
* @author Matt Porritt <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class backup_qbank_customfields_plugin extends \backup_qbank_plugin {

/**
* Returns the comment information to attach to question element.
*
* @return backup_plugin_element The backup plugin element
*/
protected function define_question_plugin_structure(): backup_plugin_element {

// Define the virtual plugin element with the condition to fulfill.
$plugin = $this->get_plugin_element();

// Create one standard named plugin element (the visible container).
$pluginwrapper = new backup_nested_element($this->get_recommended_name());

// Connect the visible container ASAP.
$plugin->add_child($pluginwrapper);

$customfields = new backup_nested_element('customfields');
$customfield = new backup_nested_element('customfield', ['id'], ['shortname', 'type', 'value', 'valueformat']);

$pluginwrapper->add_child($customfields);
$customfields->add_child($customfield);

$customfield->set_source_sql("SELECT cfd.id, cff.shortname, cff.type, cfd.value, cfd.valueformat
FROM {customfield_data} cfd
JOIN {customfield_field} cff ON cff.id = cfd.fieldid
JOIN {customfield_category} cfc ON cfc.id = cff.categoryid
WHERE cfc.component = 'qbank_customfields'
AND cfc.area = 'question'
AND cfd.instanceid = ?",
[
backup::VAR_PARENTID
]);

// Don't need to annotate ids nor files.

return $plugin;
}
}
Original file line number Diff line number Diff line change
@@ -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/>.

/**
* Restore plugin class that provides the necessary information needed to restore comments for questions.
*
* @package qbank_customfields
* @copyright 2021 Catalyst IT Australia Pty Ltd
* @author Matt Porritt <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_qbank_customfields_plugin extends restore_qbank_plugin {

/**
* Returns the paths to be handled by the plugin at question level.
*
* @return restore_path_element[] The restore path element array.
*/
protected function define_question_plugin_structure(): array {
return [new restore_path_element('customfield', $this->get_pathfor('/customfields/customfield'))];
}

/**
* Process the question custom field element.
*
* @param array $data The custom field data to restore.
*/
public function process_customfield(array $data) {
global $DB;

$newquestion = $this->get_new_parentid('question');

if (!empty($data->contextid) && $newcontextid = $this->get_mappingid('context', $data->contextid)) {
$fieldcontextid = $newcontextid;
} else {
// Get the category, so we can then later get the context.
$categoryid = $this->get_new_parentid('question_category');
if (empty($this->cachedcategory) || $this->cachedcategory->id != $categoryid) {
$this->cachedcategory = $DB->get_record('question_categories', ['id' => $categoryid]);
}
$fieldcontextid = $this->cachedcategory->contextid;
}

$data['newquestion'] = $newquestion;
$data['fieldcontextid'] = $fieldcontextid;

$customfieldhandler = qbank_customfields\customfield\question_handler::create();
$customfieldhandler->restore_instance_data_from_backup($this->task, $data);
}
}
91 changes: 91 additions & 0 deletions question/bank/customfields/classes/custom_field_column.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<?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_customfields;

use core_question\local\bank\column_base;

/**
* A column type for the name of the question creator.
*
* @package qbank_customfields
* @copyright 2021 Catalyst IT Australia Pty Ltd
* @author Matt Porritt <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class custom_field_column extends column_base {

/** @var \core_customfield\field_controller The custom field this column is displaying. */
protected $field;

/**
* Constructor.
*
* @param view $qbank the question bank view we are helping to render.
* @param \core_customfield\field_controller $field The custom field this column is displaying.
*/
public function __construct(\core_question\local\bank\view $qbank, \core_customfield\field_controller $field) {
parent::__construct($qbank);
$this->field = $field;
}

/**
* Get the internal name for this column. Used as a CSS class name,
* and to store information about the current sort. Must match PARAM_ALPHA.
*
* @return string column name.
*/
public function get_name(): string {
return 'customfield';
}

/**
* Get the name of this column. This must be unique.
* When using the inherited class to make many columns from one parent,
* ensure each instance returns a unique value.
*
* @return string The unique name;
*/
public function get_column_name(): string {
return 'custom_field_column\\' . $this->field->get('shortname');
}

/**
* Title for this column. Not used if is_sortable returns an array.
*
* @return string
*/
protected function get_title(): string {
return $this->field->get_formatted_name();
}

/**
* Output the contents of this column.
*
* @param object $question the row from the $question table, augmented with extra information.
* @param string $rowclasses CSS class names that should be applied to this row of output.
*/
protected function display_content($question, $rowclasses): void {
$fieldhandler = $this->field->get_handler();
if ($fieldhandler->can_view($this->field, $question->id)) {
$fielddata = $fieldhandler->get_field_data($this->field, $question->id);
echo $fieldhandler->display_custom_field_table($fielddata);
} else {
echo '';
}
}

}
Loading

0 comments on commit 4de7faf

Please sign in to comment.