MDL-71516 core_question: Class movement for moodle autoloading
Movement of classes to classes/local/bank and additional todo addition to all the existing ones to align with future tracker for class renaming. This commit does not contain any class renaming of the old or deprecated classes. MDL-72004 will be used to rename, remove or deprecate old classes after integrating all the qbank plugins.
This commit is contained in:
safatshahin
committed by
Safat Shahin
Safat Shahin
parent
036800d99d
commit
86bdf87966
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
abstract class action_column_base extends column_base {
|
||||
|
||||
|
||||
@@ -32,6 +32,7 @@ use core\output\checkbox_toggleall;
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
class checkbox_column extends column_base {
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Base class for representing a column in a {@link question_bank_view}.
|
||||
* Base class for representing a column in a {@see question_bank_view}.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 1999 onwards Martin Dougiamas and others {@link http://moodle.com}
|
||||
@@ -27,12 +27,14 @@ defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* Base class for representing a column in a {@link question_bank_view}.
|
||||
* Base class for representing a column in a {@see question_bank_view}.
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
abstract class column_base {
|
||||
|
||||
/**
|
||||
* @var view $qbank the question bank view we are helping to render.
|
||||
*/
|
||||
@@ -42,10 +44,10 @@ abstract class column_base {
|
||||
protected $isheading = false;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* @param view $qbank the question bank view we are helping to render.
|
||||
* Constructor for the question bank view we are helping to render.
|
||||
* @param view $qbank
|
||||
*/
|
||||
public function __construct(view $qbank) {
|
||||
public function __construct($qbank) {
|
||||
$this->qbank = $qbank;
|
||||
$this->init();
|
||||
}
|
||||
@@ -68,6 +70,27 @@ abstract class column_base {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the row has an extra preference to view/hide.
|
||||
*/
|
||||
public function has_preference(): bool {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the preference key of the row.
|
||||
*/
|
||||
public function get_preference_key(): string {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the preference of the row.
|
||||
*/
|
||||
public function get_preference(): bool {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Output the column header cell.
|
||||
*/
|
||||
@@ -272,7 +295,7 @@ abstract class column_base {
|
||||
/**
|
||||
* Load the tags for each question.
|
||||
*
|
||||
* Helper that can be used from {@link load_additional_data()};
|
||||
* Helper that can be used from {@see load_additional_data()};
|
||||
*
|
||||
* @param array $questions
|
||||
*/
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2013 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class copy_action_column extends menu_action_column_base {
|
||||
/** @var string avoids repeated calls to get_string('duplicate'). */
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class creator_name_column extends column_base {
|
||||
public function get_name() {
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class delete_action_column extends menu_action_column_base {
|
||||
protected $strdelete;
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class edit_action_column extends menu_action_column_base {
|
||||
protected $stredit;
|
||||
|
||||
@@ -36,6 +36,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2019 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
class edit_menu_column extends column_base {
|
||||
/**
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2019 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class export_xml_action_column extends menu_action_column_base {
|
||||
/** @var string avoids repeated calls to get_string('duplicate'). */
|
||||
|
||||
@@ -36,6 +36,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
abstract class menu_action_column_base extends action_column_base implements menuable_action {
|
||||
|
||||
|
||||
@@ -43,6 +43,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
interface menuable_action {
|
||||
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class modifier_name_column extends column_base {
|
||||
public function get_name() {
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class preview_action_column extends action_column_base implements menuable_action {
|
||||
/**
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class question_name_column extends column_base {
|
||||
protected $checkboxespresent = null;
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2019 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class question_name_idnumber_tags_column extends question_name_column {
|
||||
public function get_name() {
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class question_text_row extends row_base {
|
||||
protected $formatoptions;
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class question_type_column extends column_base {
|
||||
public function get_name() {
|
||||
|
||||
@@ -41,6 +41,7 @@ namespace core_question\bank;
|
||||
*
|
||||
* @copyright 2015 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
class random_question_loader {
|
||||
/** @var \qubaid_condition which usages to consider previous attempts from. */
|
||||
|
||||
@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
abstract class row_base extends column_base {
|
||||
public function is_extra_row() {
|
||||
|
||||
@@ -30,6 +30,7 @@ defined('MOODLE_INTERNAL') || die();
|
||||
*
|
||||
* @copyright 2018 Simey Lameze <[email protected]>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to the plugin
|
||||
*/
|
||||
class tags_action_column extends action_column_base implements menuable_action {
|
||||
/**
|
||||
|
||||
@@ -48,6 +48,7 @@ use core_question\bank\search\condition;
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-72004 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
class view {
|
||||
const MAX_SORTS = 3;
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* A base class for actions that are an icon that lets you manipulate the question in some way.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* A base class for actions that are an icon that lets you manipulate the question in some way.
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
abstract class action_column_base extends column_base {
|
||||
|
||||
protected function get_title() {
|
||||
return ' ';
|
||||
}
|
||||
|
||||
public function get_extra_classes() {
|
||||
return array('iconcol');
|
||||
}
|
||||
|
||||
protected function print_icon($icon, $title, $url) {
|
||||
global $OUTPUT;
|
||||
echo '<a title="' . $title . '" href="' . $url . '">' . $OUTPUT->pix_icon($icon, $title) . '</a>';
|
||||
}
|
||||
|
||||
public function get_extra_joins() {
|
||||
return array('qc' => 'JOIN {question_categories} qc ON qc.id = q.category');
|
||||
}
|
||||
|
||||
public function get_required_fields() {
|
||||
// Createdby is required for permission checks.
|
||||
// Qtype so we can easily avoid applying actions to question types that
|
||||
// are no longer installed.
|
||||
return ['q.id', 'q.qtype', 'q.createdby', 'qc.contextid'];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* A column with a checkbox for each question with name q{questionid}.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
use core\output\checkbox_toggleall;
|
||||
|
||||
|
||||
/**
|
||||
* A column with a checkbox for each question with name q{questionid}.
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class checkbox_column extends column_base {
|
||||
|
||||
public function get_name() {
|
||||
return 'checkbox';
|
||||
}
|
||||
|
||||
protected function get_title() {
|
||||
global $OUTPUT;
|
||||
|
||||
$mastercheckbox = new checkbox_toggleall('qbank', true, [
|
||||
'id' => 'qbheadercheckbox',
|
||||
'name' => 'qbheadercheckbox',
|
||||
'value' => '1',
|
||||
'label' => get_string('selectall'),
|
||||
'labelclasses' => 'accesshide',
|
||||
]);
|
||||
|
||||
return $OUTPUT->render($mastercheckbox);
|
||||
}
|
||||
|
||||
protected function get_title_tip() {
|
||||
return get_string('selectquestionsforbulk', 'question');
|
||||
}
|
||||
|
||||
protected function display_content($question, $rowclasses) {
|
||||
global $OUTPUT;
|
||||
|
||||
$checkbox = new checkbox_toggleall('qbank', false, [
|
||||
'id' => "checkq{$question->id}",
|
||||
'name' => "q{$question->id}",
|
||||
'value' => '1',
|
||||
'label' => get_string('select'),
|
||||
'labelclasses' => 'accesshide',
|
||||
]);
|
||||
|
||||
echo $OUTPUT->render($checkbox);
|
||||
}
|
||||
|
||||
public function get_required_fields() {
|
||||
return array('q.id');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,369 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Base class for representing a column in a {@see question_bank_view}.
|
||||
*
|
||||
* @package core_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 core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* Base class for representing a column in a {@see question_bank_view}.
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @todo MDL-71516 delete the class and add it to lib/db/renameclasses.php pointing to core_question/local/bank
|
||||
*/
|
||||
abstract class column_base {
|
||||
|
||||
/**
|
||||
* @var view $qbank the question bank view we are helping to render.
|
||||
*/
|
||||
protected $qbank;
|
||||
|
||||
/** @var bool determine whether the column is td or th. */
|
||||
protected $isheading = false;
|
||||
|
||||
/**
|
||||
* Constructor for the question bank view we are helping to render.
|
||||
* @param view $qbank
|
||||
*/
|
||||
public function __construct($qbank) {
|
||||
$this->qbank = $qbank;
|
||||
$this->init();
|
||||
}
|
||||
|
||||
/**
|
||||
* A chance for subclasses to initialise themselves, for example to load lang strings,
|
||||
* without having to override the constructor.
|
||||
*/
|
||||
protected function init() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the column as heading
|
||||
*/
|
||||
public function set_as_heading() {
|
||||
$this->isheading = true;
|
||||
}
|
||||
|
||||
public function is_extra_row() {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the row has an extra preference to view/hide.
|
||||
*/
|
||||
public function has_preference(): bool {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the preference key of the row.
|
||||
*/
|
||||
public function get_preference_key(): string {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the preference of the row.
|
||||
*/
|
||||
public function get_preference(): bool {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Output the column header cell.
|
||||
*/
|
||||
public function display_header() {
|
||||
echo '<th class="header ' . $this->get_classes() . '" scope="col">';
|
||||
$sortable = $this->is_sortable();
|
||||
$name = get_class($this);
|
||||
$title = $this->get_title();
|
||||
$tip = $this->get_title_tip();
|
||||
if (is_array($sortable)) {
|
||||
if ($title) {
|
||||
echo '<div class="title">' . $title . '</div>';
|
||||
}
|
||||
$links = array();
|
||||
foreach ($sortable as $subsort => $details) {
|
||||
$links[] = $this->make_sort_link($name . '-' . $subsort,
|
||||
$details['title'], isset($details['tip']) ? $details['tip'] : '', !empty($details['reverse']));
|
||||
}
|
||||
echo '<div class="sorters">' . implode(' / ', $links) . '</div>';
|
||||
} else if ($sortable) {
|
||||
echo $this->make_sort_link($name, $title, $tip);
|
||||
} else {
|
||||
if ($tip) {
|
||||
echo '<span title="' . $tip . '">';
|
||||
}
|
||||
echo $title;
|
||||
if ($tip) {
|
||||
echo '</span>';
|
||||
}
|
||||
}
|
||||
echo "</th>\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Title for this column. Not used if is_sortable returns an array.
|
||||
*/
|
||||
protected abstract function get_title();
|
||||
|
||||
/**
|
||||
* @return string a fuller version of the name. Use this when get_title() returns
|
||||
* something very short, and you want a longer version as a tool tip.
|
||||
*/
|
||||
protected function get_title_tip() {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a link that changes the sort order, and indicates the current sort state.
|
||||
* @param string $sort the column to sort on.
|
||||
* @param string $title the link text.
|
||||
* @param string $tip the link tool-tip text. If empty, defaults to title.
|
||||
* @param bool $defaultreverse whether the default sort order for this column is descending, rather than ascending.
|
||||
* @return string HTML fragment.
|
||||
*/
|
||||
protected function make_sort_link($sort, $title, $tip, $defaultreverse = false) {
|
||||
$currentsort = $this->qbank->get_primary_sort_order($sort);
|
||||
$newsortreverse = $defaultreverse;
|
||||
if ($currentsort) {
|
||||
$newsortreverse = $currentsort > 0;
|
||||
}
|
||||
if (!$tip) {
|
||||
$tip = $title;
|
||||
}
|
||||
if ($newsortreverse) {
|
||||
$tip = get_string('sortbyxreverse', '', $tip);
|
||||
} else {
|
||||
$tip = get_string('sortbyx', '', $tip);
|
||||
}
|
||||
$link = '<a href="' . $this->qbank->new_sort_url($sort, $newsortreverse) . '" title="' . $tip . '">';
|
||||
$link .= $title;
|
||||
if ($currentsort) {
|
||||
$link .= $this->get_sort_icon($currentsort < 0);
|
||||
}
|
||||
$link .= '</a>';
|
||||
return $link;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an icon representing the corrent sort state.
|
||||
* @param bool $reverse sort is descending, not ascending.
|
||||
* @return string HTML image tag.
|
||||
*/
|
||||
protected function get_sort_icon($reverse) {
|
||||
global $OUTPUT;
|
||||
if ($reverse) {
|
||||
return $OUTPUT->pix_icon('t/sort_desc', get_string('desc'), '', array('class' => 'iconsort'));
|
||||
} else {
|
||||
return $OUTPUT->pix_icon('t/sort_asc', get_string('asc'), '', array('class' => 'iconsort'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Output 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.
|
||||
*/
|
||||
public function display($question, $rowclasses) {
|
||||
$this->display_start($question, $rowclasses);
|
||||
$this->display_content($question, $rowclasses);
|
||||
$this->display_end($question, $rowclasses);
|
||||
}
|
||||
|
||||
/**
|
||||
* Output the opening column tag. If it is set as heading, it will use <th> tag instead of <td>
|
||||
*
|
||||
* @param \stdClass $question
|
||||
* @param string $rowclasses
|
||||
*/
|
||||
protected function display_start($question, $rowclasses) {
|
||||
$tag = 'td';
|
||||
$attr = array('class' => $this->get_classes());
|
||||
if ($this->isheading) {
|
||||
$tag = 'th';
|
||||
$attr['scope'] = 'row';
|
||||
}
|
||||
echo \html_writer::start_tag($tag, $attr);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the CSS classes to apply to every cell in this column.
|
||||
*/
|
||||
protected function get_classes() {
|
||||
$classes = $this->get_extra_classes();
|
||||
$classes[] = $this->get_name();
|
||||
return implode(' ', $classes);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 abstract function get_name();
|
||||
|
||||
/**
|
||||
* @return array any extra class names you would like applied to every cell in this column.
|
||||
*/
|
||||
public function get_extra_classes() {
|
||||
return array();
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 abstract function display_content($question, $rowclasses);
|
||||
|
||||
/**
|
||||
* Output the closing column tag
|
||||
*
|
||||
* @param object $question
|
||||
* @param string $rowclasses
|
||||
*/
|
||||
protected function display_end($question, $rowclasses) {
|
||||
$tag = 'td';
|
||||
if ($this->isheading) {
|
||||
$tag = 'th';
|
||||
}
|
||||
echo \html_writer::end_tag($tag);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an array 'table_alias' => 'JOIN clause' to bring in any data that
|
||||
* this column required.
|
||||
*
|
||||
* The return values for all the columns will be checked. It is OK if two
|
||||
* columns join in the same table with the same alias and identical JOIN clauses.
|
||||
* If to columns try to use the same alias with different joins, you get an error.
|
||||
* The only table included by default is the question table, which is aliased to 'q'.
|
||||
*
|
||||
* It is importnat that your join simply adds additional data (or NULLs) to the
|
||||
* existing rows of the query. It must not cause additional rows.
|
||||
*
|
||||
* @return array 'table_alias' => 'JOIN clause'
|
||||
*/
|
||||
public function get_extra_joins() {
|
||||
return array();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array fields required. use table alias 'q' for the question table, or one of the
|
||||
* ones from get_extra_joins. Every field requested must specify a table prefix.
|
||||
*/
|
||||
public function get_required_fields() {
|
||||
return array();
|
||||
}
|
||||
|
||||
/**
|
||||
* If this column needs extra data (e.g. tags) then load that here.
|
||||
*
|
||||
* The extra data should be added to the question object in the array.
|
||||
* Probably a good idea to check that another column has not already
|
||||
* loaded the data you want.
|
||||
*
|
||||
* @param \stdClass[] $questions the questions that will be displayed.
|
||||
*/
|
||||
public function load_additional_data(array $questions) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the tags for each question.
|
||||
*
|
||||
* Helper that can be used from {@see load_additional_data()};
|
||||
*
|
||||
* @param array $questions
|
||||
*/
|
||||
public function load_question_tags(array $questions) {
|
||||
$firstquestion = reset($questions);
|
||||
if (isset($firstquestion->tags)) {
|
||||
// Looks like tags are already loaded, so don't do it again.
|
||||
return;
|
||||
}
|
||||
|
||||
// Load the tags.
|
||||
$tagdata = \core_tag_tag::get_items_tags('core_question', 'question',
|
||||
array_keys($questions));
|
||||
|
||||
// Add them to the question objects.
|
||||
foreach ($tagdata as $questionid => $tags) {
|
||||
$questions[$questionid]->tags = $tags;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Can this column be sorted on? You can return either:
|
||||
* + false for no (the default),
|
||||
* + a field name, if sorting this column corresponds to sorting on that datbase field.
|
||||
* + an array of subnames to sort on as follows
|
||||
* return array(
|
||||
* 'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
|
||||
* 'lastname' => array('field' => 'uc.lastname', 'title' => get_string('lastname')),
|
||||
* );
|
||||
* As well as field, and field, you can also add 'revers' => 1 if you want the default sort
|
||||
* order to be DESC.
|
||||
* @return mixed as above.
|
||||
*/
|
||||
public function is_sortable() {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method for building sort clauses.
|
||||
* @param bool $reverse whether the normal direction should be reversed.
|
||||
* @return string 'ASC' or 'DESC'
|
||||
*/
|
||||
protected function sortorder($reverse) {
|
||||
if ($reverse) {
|
||||
return ' DESC';
|
||||
} else {
|
||||
return ' ASC';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param bool $reverse Whether to sort in the reverse of the default sort order.
|
||||
* @param string $subsort if is_sortable returns an array of subnames, then this will be
|
||||
* one of those. Otherwise will be empty.
|
||||
* @return string some SQL to go in the order by clause.
|
||||
*/
|
||||
public function sort_expression($reverse, $subsort) {
|
||||
$sortable = $this->is_sortable();
|
||||
if (is_array($sortable)) {
|
||||
if (array_key_exists($subsort, $sortable)) {
|
||||
return $sortable[$subsort]['field'] . $this->sortorder($reverse);
|
||||
} else {
|
||||
throw new \coding_exception('Unexpected $subsort type: ' . $subsort);
|
||||
}
|
||||
} else if ($sortable) {
|
||||
return $sortable . $this->sortorder($reverse);
|
||||
} else {
|
||||
throw new \coding_exception('sort_expression called on a non-sortable column.');
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,101 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* A question bank column which gathers together all the actions into a menu.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2019 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* A question bank column which gathers together all the actions into a menu.
|
||||
*
|
||||
* This question bank column, if added to the question bank, will
|
||||
* replace all of the other columns which implement the
|
||||
* {@link menuable_action} interface and replace them with a single
|
||||
* column containing an Edit menu.
|
||||
*
|
||||
* @copyright 2019 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class edit_menu_column extends column_base {
|
||||
/**
|
||||
* @var menuable_action[]
|
||||
*/
|
||||
protected $actions;
|
||||
|
||||
/**
|
||||
* Set up the list of actions that should be shown in the menu.
|
||||
*
|
||||
* This takes a list of column object (the list from a question
|
||||
* bank view). It extracts all the ones that should go in the menu
|
||||
* and stores them for later use. Then it returns the remaining columns.
|
||||
*
|
||||
* @param column_base[] $allcolumns a set of columns.
|
||||
* @return column_base[] the non-action columns from the set.
|
||||
*/
|
||||
public function claim_menuable_columns($allcolumns) {
|
||||
$remainingcolumns = [];
|
||||
foreach ($allcolumns as $key => $column) {
|
||||
if ($column instanceof menuable_action) {
|
||||
$this->actions[$key] = $column;
|
||||
} else {
|
||||
$remainingcolumns[$key] = $column;
|
||||
}
|
||||
}
|
||||
return $remainingcolumns;
|
||||
}
|
||||
|
||||
protected function get_title() {
|
||||
return get_string('actions');
|
||||
}
|
||||
|
||||
public function get_name() {
|
||||
return 'editmenu';
|
||||
}
|
||||
|
||||
protected function display_content($question, $rowclasses) {
|
||||
global $OUTPUT;
|
||||
|
||||
$menu = new \action_menu();
|
||||
$menu->set_menu_trigger(get_string('edit'));
|
||||
$menu->set_alignment(\action_menu::TL, \action_menu::BL);
|
||||
foreach ($this->actions as $actioncolumn) {
|
||||
$action = $actioncolumn->get_action_menu_link($question);
|
||||
if ($action) {
|
||||
$menu->add($action);
|
||||
}
|
||||
}
|
||||
|
||||
$qtypeactions = \question_bank::get_qtype($question->qtype, false)
|
||||
->get_extra_question_bank_actions($question);
|
||||
foreach ($qtypeactions as $action) {
|
||||
$menu->add($action);
|
||||
}
|
||||
|
||||
echo $OUTPUT->render($menu);
|
||||
}
|
||||
|
||||
public function get_required_fields() {
|
||||
return ['q.qtype'];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Base class to make it easier to implement actions that are menuable_actions.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* Base class to make it easier to implement actions that are menuable_actions.
|
||||
*
|
||||
* Use this class if your action is simple (defined by just a URL, label and icon).
|
||||
* If your action is not simple enough to fit into the pattern that this
|
||||
* class implements, then you will have to implement the menuable_action
|
||||
* interface yourself.
|
||||
*
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
abstract class menu_action_column_base extends action_column_base implements menuable_action {
|
||||
|
||||
/**
|
||||
* Get the information required to display this action either as a menu item or a separate action column.
|
||||
*
|
||||
* If this action cannot apply to this question (e.g. because the user does not have
|
||||
* permission, then return [null, null, null].
|
||||
*
|
||||
* @param \stdClass $question the row from the $question table, augmented with extra information.
|
||||
* @return array with three elements.
|
||||
* $url - the URL to perform the action.
|
||||
* $icon - the icon for this action. E.g. 't/delete'.
|
||||
* $label - text label to display in the UI (either in the menu, or as a tool-tip on the icon)
|
||||
*/
|
||||
abstract protected function get_url_icon_and_label(\stdClass $question): array;
|
||||
|
||||
protected function display_content($question, $rowclasses) {
|
||||
[$url, $icon, $label] = $this->get_url_icon_and_label($question);
|
||||
if ($url) {
|
||||
$this->print_icon($icon, $label, $url);
|
||||
}
|
||||
}
|
||||
|
||||
public function get_action_menu_link(\stdClass $question): ?\action_menu_link {
|
||||
[$url, $icon, $label] = $this->get_url_icon_and_label($question);
|
||||
if (!$url) {
|
||||
return null;
|
||||
}
|
||||
return new \action_menu_link_secondary($url, new \pix_icon($icon, ''), $label);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Interface to indicate that a question bank column can go in the action menu.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* Interface to indicate that a question bank column can go in the action menu.
|
||||
*
|
||||
* If a question bank column implements this interface, and if the {@link edit_menu_column}
|
||||
* is present in the question bank view, then the 'column' will be shown as an entry in the
|
||||
* edit menu instead of as a separate column.
|
||||
*
|
||||
* Probably most columns that want to implement this will be subclasses of
|
||||
* {@link action_column_base}, and most such columns should probably implement
|
||||
* this interface.
|
||||
*
|
||||
* If your column is a simple action, you can probably save duplicated code by
|
||||
* using the base class action_column_menuable as an easy way to implement both
|
||||
* action_column_base and this interface.
|
||||
*
|
||||
* @copyright 2019 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
interface menuable_action {
|
||||
|
||||
/**
|
||||
* Return the appropriate action menu link, or null if it does not apply to this question.
|
||||
*
|
||||
* @param \stdClass $question data about the question being displayed in this row.
|
||||
* @return \action_menu_link|null the action, if applicable to this question.
|
||||
*/
|
||||
public function get_action_menu_link(\stdClass $question): ?\action_menu_link;
|
||||
}
|
||||
@@ -0,0 +1,322 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* A class for efficiently finds questions at random from the question bank.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2015 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
|
||||
|
||||
/**
|
||||
* This class efficiently finds questions at random from the question bank.
|
||||
*
|
||||
* You can ask for questions at random one at a time. Each time you ask, you
|
||||
* pass a category id, and whether to pick from that category and all subcategories
|
||||
* or just that category.
|
||||
*
|
||||
* The number of teams each question has been used is tracked, and we will always
|
||||
* return a question from among those elegible that has been used the fewest times.
|
||||
* So, if there are questions that have not been used yet in the category asked for,
|
||||
* one of those will be returned. However, within one instantiation of this class,
|
||||
* we will never return a given question more than once, and we will never return
|
||||
* questions passed into the constructor as $usedquestions.
|
||||
*
|
||||
* @copyright 2015 The Open University
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class random_question_loader {
|
||||
/** @var \qubaid_condition which usages to consider previous attempts from. */
|
||||
protected $qubaids;
|
||||
|
||||
/** @var array qtypes that cannot be used by random questions. */
|
||||
protected $excludedqtypes;
|
||||
|
||||
/** @var array categoryid & include subcategories => num previous uses => questionid => 1. */
|
||||
protected $availablequestionscache = array();
|
||||
|
||||
/**
|
||||
* @var array questionid => num recent uses. Questions that have been used,
|
||||
* but that is not yet recorded in the DB.
|
||||
*/
|
||||
protected $recentlyusedquestions;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* @param \qubaid_condition $qubaids the usages to consider when counting previous uses of each question.
|
||||
* @param array $usedquestions questionid => number of times used count. If we should allow for
|
||||
* further existing uses of a question in addition to the ones in $qubaids.
|
||||
*/
|
||||
public function __construct(\qubaid_condition $qubaids, array $usedquestions = array()) {
|
||||
$this->qubaids = $qubaids;
|
||||
$this->recentlyusedquestions = $usedquestions;
|
||||
|
||||
foreach (\question_bank::get_all_qtypes() as $qtype) {
|
||||
if (!$qtype->is_usable_by_random()) {
|
||||
$this->excludedqtypes[] = $qtype->name();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Pick a question at random from the given category, from among those with the fewest uses.
|
||||
* If an array of tag ids are specified, then only the questions that are tagged with ALL those tags will be selected.
|
||||
*
|
||||
* It is up the the caller to verify that the cateogry exists. An unknown category
|
||||
* behaves like an empty one.
|
||||
*
|
||||
* @param int $categoryid the id of a category in the question bank.
|
||||
* @param bool $includesubcategories wether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids An array of tag ids. A question has to be tagged with all the provided tagids (if any)
|
||||
* in order to be eligible for being picked.
|
||||
* @return int|null the id of the question picked, or null if there aren't any.
|
||||
*/
|
||||
public function get_next_question_id($categoryid, $includesubcategories, $tagids = []) {
|
||||
$this->ensure_questions_for_category_loaded($categoryid, $includesubcategories, $tagids);
|
||||
|
||||
$categorykey = $this->get_category_key($categoryid, $includesubcategories, $tagids);
|
||||
if (empty($this->availablequestionscache[$categorykey])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
reset($this->availablequestionscache[$categorykey]);
|
||||
$lowestcount = key($this->availablequestionscache[$categorykey]);
|
||||
reset($this->availablequestionscache[$categorykey][$lowestcount]);
|
||||
$questionid = key($this->availablequestionscache[$categorykey][$lowestcount]);
|
||||
$this->use_question($questionid);
|
||||
return $questionid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the key into {@link $availablequestionscache} for this combination of options.
|
||||
* @param int $categoryid the id of a category in the question bank.
|
||||
* @param bool $includesubcategories wether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids an array of tag ids.
|
||||
* @return string the cache key.
|
||||
*/
|
||||
protected function get_category_key($categoryid, $includesubcategories, $tagids = []) {
|
||||
if ($includesubcategories) {
|
||||
$key = $categoryid . '|1';
|
||||
} else {
|
||||
$key = $categoryid . '|0';
|
||||
}
|
||||
|
||||
if (!empty($tagids)) {
|
||||
$key .= '|' . implode('|', $tagids);
|
||||
}
|
||||
|
||||
return $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Populate {@link $availablequestionscache} for this combination of options.
|
||||
* @param int $categoryid The id of a category in the question bank.
|
||||
* @param bool $includesubcategories Whether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids An array of tag ids. If an array is provided, then
|
||||
* only the questions that are tagged with ALL the provided tagids will be loaded.
|
||||
*/
|
||||
protected function ensure_questions_for_category_loaded($categoryid, $includesubcategories, $tagids = []) {
|
||||
global $DB;
|
||||
|
||||
$categorykey = $this->get_category_key($categoryid, $includesubcategories, $tagids);
|
||||
|
||||
if (isset($this->availablequestionscache[$categorykey])) {
|
||||
// Data is already in the cache, nothing to do.
|
||||
return;
|
||||
}
|
||||
|
||||
// Load the available questions from the question bank.
|
||||
if ($includesubcategories) {
|
||||
$categoryids = question_categorylist($categoryid);
|
||||
} else {
|
||||
$categoryids = array($categoryid);
|
||||
}
|
||||
|
||||
list($extraconditions, $extraparams) = $DB->get_in_or_equal($this->excludedqtypes,
|
||||
SQL_PARAMS_NAMED, 'excludedqtype', false);
|
||||
|
||||
$questionidsandcounts = \question_bank::get_finder()->get_questions_from_categories_and_tags_with_usage_counts(
|
||||
$categoryids, $this->qubaids, 'q.qtype ' . $extraconditions, $extraparams, $tagids);
|
||||
if (!$questionidsandcounts) {
|
||||
// No questions in this category.
|
||||
$this->availablequestionscache[$categorykey] = array();
|
||||
return;
|
||||
}
|
||||
|
||||
// Put all the questions with each value of $prevusecount in separate arrays.
|
||||
$idsbyusecount = array();
|
||||
foreach ($questionidsandcounts as $questionid => $prevusecount) {
|
||||
if (isset($this->recentlyusedquestions[$questionid])) {
|
||||
// Recently used questions are never returned.
|
||||
continue;
|
||||
}
|
||||
$idsbyusecount[$prevusecount][] = $questionid;
|
||||
}
|
||||
|
||||
// Now put that data into our cache. For each count, we need to shuffle
|
||||
// questionids, and make those the keys of an array.
|
||||
$this->availablequestionscache[$categorykey] = array();
|
||||
foreach ($idsbyusecount as $prevusecount => $questionids) {
|
||||
shuffle($questionids);
|
||||
$this->availablequestionscache[$categorykey][$prevusecount] = array_combine(
|
||||
$questionids, array_fill(0, count($questionids), 1));
|
||||
}
|
||||
ksort($this->availablequestionscache[$categorykey]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the internal data structures to indicate that a given question has
|
||||
* been used one more time.
|
||||
*
|
||||
* @param int $questionid the question that is being used.
|
||||
*/
|
||||
protected function use_question($questionid) {
|
||||
if (isset($this->recentlyusedquestions[$questionid])) {
|
||||
$this->recentlyusedquestions[$questionid] += 1;
|
||||
} else {
|
||||
$this->recentlyusedquestions[$questionid] = 1;
|
||||
}
|
||||
|
||||
foreach ($this->availablequestionscache as $categorykey => $questionsforcategory) {
|
||||
foreach ($questionsforcategory as $numuses => $questionids) {
|
||||
if (!isset($questionids[$questionid])) {
|
||||
continue;
|
||||
}
|
||||
unset($this->availablequestionscache[$categorykey][$numuses][$questionid]);
|
||||
if (empty($this->availablequestionscache[$categorykey][$numuses])) {
|
||||
unset($this->availablequestionscache[$categorykey][$numuses]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of available question ids for the given criteria.
|
||||
*
|
||||
* @param int $categoryid The id of a category in the question bank.
|
||||
* @param bool $includesubcategories Whether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids An array of tag ids. If an array is provided, then
|
||||
* only the questions that are tagged with ALL the provided tagids will be loaded.
|
||||
* @return int[] The list of question ids
|
||||
*/
|
||||
protected function get_question_ids($categoryid, $includesubcategories, $tagids = []) {
|
||||
$this->ensure_questions_for_category_loaded($categoryid, $includesubcategories, $tagids);
|
||||
$categorykey = $this->get_category_key($categoryid, $includesubcategories, $tagids);
|
||||
$cachedvalues = $this->availablequestionscache[$categorykey];
|
||||
$questionids = [];
|
||||
|
||||
foreach ($cachedvalues as $usecount => $ids) {
|
||||
$questionids = array_merge($questionids, array_keys($ids));
|
||||
}
|
||||
|
||||
return $questionids;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether a given question is available in a given category. If so, mark it used.
|
||||
* If an optional list of tag ids are provided, then the question must be tagged with
|
||||
* ALL of the provided tags to be considered as available.
|
||||
*
|
||||
* @param int $categoryid the id of a category in the question bank.
|
||||
* @param bool $includesubcategories wether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param int $questionid the question that is being used.
|
||||
* @param array $tagids An array of tag ids. Only the questions that are tagged with all the provided tagids can be available.
|
||||
* @return bool whether the question is available in the requested category.
|
||||
*/
|
||||
public function is_question_available($categoryid, $includesubcategories, $questionid, $tagids = []) {
|
||||
$this->ensure_questions_for_category_loaded($categoryid, $includesubcategories, $tagids);
|
||||
$categorykey = $this->get_category_key($categoryid, $includesubcategories, $tagids);
|
||||
|
||||
foreach ($this->availablequestionscache[$categorykey] as $questionids) {
|
||||
if (isset($questionids[$questionid])) {
|
||||
$this->use_question($questionid);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of available questions for the given criteria.
|
||||
*
|
||||
* @param int $categoryid The id of a category in the question bank.
|
||||
* @param bool $includesubcategories Whether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids An array of tag ids. If an array is provided, then
|
||||
* only the questions that are tagged with ALL the provided tagids will be loaded.
|
||||
* @param int $limit Maximum number of results to return.
|
||||
* @param int $offset Number of items to skip from the begging of the result set.
|
||||
* @param string[] $fields The fields to return for each question.
|
||||
* @return \stdClass[] The list of question records
|
||||
*/
|
||||
public function get_questions(
|
||||
$categoryid,
|
||||
$includesubcategories,
|
||||
$tagids = [],
|
||||
$limit = 100,
|
||||
$offset = 0,
|
||||
$fields = []
|
||||
) {
|
||||
global $DB;
|
||||
|
||||
$questionids = $this->get_question_ids($categoryid, $includesubcategories, $tagids);
|
||||
if (empty($questionids)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
if (empty($fields)) {
|
||||
// Return all fields.
|
||||
$fieldsstring = '*';
|
||||
} else {
|
||||
$fieldsstring = implode(',', $fields);
|
||||
}
|
||||
|
||||
return $DB->get_records_list(
|
||||
'question',
|
||||
'id',
|
||||
$questionids,
|
||||
'id',
|
||||
$fieldsstring,
|
||||
$offset,
|
||||
$limit
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of available questions for the given criteria.
|
||||
*
|
||||
* @param int $categoryid The id of a category in the question bank.
|
||||
* @param bool $includesubcategories Whether to pick a question from exactly
|
||||
* that category, or that category and subcategories.
|
||||
* @param array $tagids An array of tag ids. If an array is provided, then
|
||||
* only the questions that are tagged with ALL the provided tagids will be loaded.
|
||||
* @return int The number of questions matching the criteria.
|
||||
*/
|
||||
public function count_questions($categoryid, $includesubcategories, $tagids = []) {
|
||||
$questionids = $this->get_question_ids($categoryid, $includesubcategories, $tagids);
|
||||
return count($questionids);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Base class for 'columns' that are actually displayed as a row following the main question row.
|
||||
*
|
||||
* @package core_question
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace core_question\local\bank;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
|
||||
/**
|
||||
* Base class for 'columns' that are actually displayed as a row following the main question row.
|
||||
*
|
||||
* @copyright 2009 Tim Hunt
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
abstract class row_base extends column_base {
|
||||
public function is_extra_row() {
|
||||
return true;
|
||||
}
|
||||
|
||||
protected function display_start($question, $rowclasses) {
|
||||
if ($rowclasses) {
|
||||
echo '<tr class="' . $rowclasses . '">' . "\n";
|
||||
} else {
|
||||
echo "<tr>\n";
|
||||
}
|
||||
echo '<td colspan="' . $this->qbank->get_column_count() . '" class="' . $this->get_name() . '">';
|
||||
}
|
||||
|
||||
protected function display_end($question, $rowclasses) {
|
||||
echo "</td></tr>\n";
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,12 @@
|
||||
This files describes API changes for code that uses the question API.
|
||||
|
||||
=== 4.0 ==
|
||||
|
||||
1) Previously, the questionbank api classes were coupled in one place. Now the classes
|
||||
are divided in two different parts, base classes and feature classes. All the base
|
||||
classes are moved classes/local/bank and all the feature classes will be moved to
|
||||
the plugin for that feature.
|
||||
|
||||
=== 3.9 ==
|
||||
|
||||
1) For years, the ..._questions_in_use callback has been the right way for plugins to
|
||||
|
||||
Reference in New Issue
Block a user