Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_question\local\bank\view Class Reference

This class prints a view of the question bank. More...

Inheritance diagram for core_question\local\bank\view:
mod_quiz\question\bank\custom_view qbank_history\question_history_view

Public Member Functions

 __construct ($contexts, $pageurl, $course, $cm=null)
 Constructor for view.
 
 add_searchcondition ($searchcondition)
 Add another search control to this view.
 
 base_url ()
 Returns the base url.
 
 copy_question_moodle_url ($questionid)
 Get the URL for duplicating a question as a moodle url.
 
 copy_question_url ($questionid)
 Get the URL for duplicating a given question.
 
 display ($pagevars, $tabname)
 Shows the question bank interface.
 
 edit_question_moodle_url ($questionid)
 Get the URL for editing a question as a moodle url.
 
 edit_question_url ($questionid)
 Get the URL for editing a question as a HTML-escaped string.
 
 get_aggregate_statistic (int $questionid, string $fieldname)
 Get the aggregated value of a particular statistic for a particular question.
 
 get_column_count ()
 Get the count of the columns.
 
 get_courseid ()
 Get course id.
 
 get_most_specific_context ()
 Get the context we are displaying the question bank for.
 
 get_primary_sort_order ($sort)
 Gets the primary sort order according to the default sort.
 
 get_visiblecolumns ()
 Gets visible columns.
 
 has_column ($colname)
 Checks if the column included in the output.
 
 is_listing_specific_versions ()
 Is this view showing separate versions of a question?
 
 new_sort_url ($sort, $newsortreverse)
 Get a URL to redisplay the page with a new sort for the question bank.
 
 preview_question_url ($questiondata)
 Get the URL to preview a question.
 
 process_actions ()
 Process actions for the selected action.
 
 process_actions_needing_ui ()
 Process actions with ui.
 
 wanted_filters ($cat, $tagids, $showhidden, $recurse, $editcontexts, $showquestiontext)
 The filters for the question bank.
 

Public Attributes

array $bulkactions = []
 $bulkactions to identify the bulk actions for the api.
 
object cm_info null $cm
 if we are in a module context, the cm.
 
object $course
 the course we are within.
 
array $customfilterobjects = null
 to pass custom filters instead of the specified ones.
 
bool $enablefilters = true
 enable or disable filters while calling the API.
 
string $returnurl
 url of the new question page.
 
const MAX_SORTS = 3
 Maximum number of sorts allowed.
 

Protected Member Functions

 build_query ()
 Create the SQL query to retrieve the indicated questions, based on core_question\bank\search\condition filters.
 
 create_new_question_form ($category, $canadd)
 Create a new question form.
 
 default_sort ()
 Default sort for question data.
 
 determine_required_statistics ()
 Work out the list of all the required statistics fields for this question bank view.
 
 display_advanced_search_form ($advancedsearch)
 Print the "advanced" UI elements for the form to select which questions.
 
 display_bottom_controls (\context $catcontext)
 Display the controls at the bottom of the list of questions.
 
 display_bottom_pagination ($pagination, $totalnumber, $perpage, $pageurl)
 Display bottom pagination bar.
 
 display_options_form ($showquestiontext)
 Display the form with options for which questions are displayed and how they are displayed.
 
 display_question_bank_header ()
 Display the header element for the question bank.
 
 display_question_list ($pageurl, $categoryandcontext, $recurse=1, $page=0, $perpage=null, $addcontexts=[])
 Prints the table of questions in a category with interactions.
 
 display_questions ($questions)
 Display the questions.
 
 display_showtext_checkbox ($showquestiontext)
 Display the checkbox UI for toggling the display of the question text in the list.
 
 display_top_pagnation ($pagination)
 Display the top pagination bar.
 
 end_table ()
 End of the table html.
 
 get_column_type ($columnname)
 Check a column object from its name and get the object for sort.
 
 get_current_category ($categoryandcontext)
 Gets current selected category.
 
 get_question_bank_plugins ()
 Get the list of qbank plugins with available objects for features.
 
 get_question_count ()
 Get the number of questions.
 
 get_row_classes ($question, $rowcount)
 Gets the classes for the row.
 
 heading_column ()
 Specify the column heading.
 
 init_bulk_actions ()
 Initialize bulk actions.
 
 init_columns ($wanted, $heading='')
 Initializing table columns.
 
 init_search_conditions ()
 Initialize search conditions from plugins local_*_get_question_bank_search_conditions() must return an array of core_question\bank\search\condition objects.
 
 init_sort ()
 Initialise sorting.
 
 init_sort_from_params ()
 Initialise sort from parameters.
 
 load_page_questions ($page, $perpage)
 Load the questions we need to display.
 
 load_required_statistics (array $questions)
 Load the aggregate statistics that all the columns require.
 
 parse_subsort ($sort)
 Deal with a sort name of the form columnname, or colname_subsort by breaking it up, validating the bits that are present, and returning them.
 
 print_choose_category_message ()
 Print the text if category id not available.
 
 print_table ($questions)
 Prints the actual table with question.
 
 print_table_headers ()
 Print table headers from child classes.
 
 print_table_row ($question, $rowcount)
 Prints the table row from child classes.
 
 sort_to_params ($sorts)
 Sort to parameters.
 
 start_table ()
 Start of the table html.
 
 wanted_columns ()
 Loads all the available columns.
 

Protected Attributes

moodle_url $baseurl
 base URL for the current page.
 
core_question local bank question_edit_contexts $contexts
 
string $countsql
 SQL to count the number of questions matching the current search conditions.
 
moodle_url $editquestionurl
 used as a basis for URLs that edit a question.
 
column_base[] $extrarows
 these are the 'columns' that are actually displayed as an additional row (e.g.
 
int null $lastchangedid
 id of the a question to highlight in the list (if present).
 
array $loadedstatistics = null
 Stores all the average statistics that this question bank view needs.
 
string $loadsql
 SQL to actually load the question data to display.
 
int $pagesize = DEFAULT_QUESTIONS_PER_PAGE
 page size to use (when we are not showing all questions).
 
column_base[] $requiredcolumns
 these are all the 'columns' that are part of the display.
 
condition[] $searchconditions = []
 search conditions.
 
array $sort
 list of column class names for which columns to sort on.
 
array $sqlparams
 params used by $countsql and $loadsql (which currently must be the same).
 
column_base[] $visiblecolumns
 these are the 'columns' that are actually displayed as a column, in order.
 

Detailed Description

This class prints a view of the question bank.

including

  • Some controls to allow users to to select what is displayed.
  • A list of questions as a table.
  • Further controls to do things with the questions.

This class gives a basic view, and provides plenty of hooks where subclasses can override parts of the display.

The list of questions presented as a table is generated by creating a list of core_question\bank\column objects, one for each 'column' to be displayed. These manage

  • outputting the contents of that column, given a $question object, but also
  • generating the right fragments of SQL to ensure the necessary data is present, and sorted in the right order.
  • outputting table headers.
Author
2021 Safat Shahin safat.nosp@m.shah.nosp@m.in@ca.nosp@m.taly.nosp@m.st-au.nosp@m..net
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

core_question\local\bank\view::__construct ( $contexts,
$pageurl,
$course,
$cm = null )

Constructor for view.

Parameters
core_question\local\bank\question_edit_contexts$contexts
moodle_url$pageurl
object$coursecourse settings
object$cm(optional) activity settings.

Member Function Documentation

◆ add_searchcondition()

core_question\local\bank\view::add_searchcondition ( $searchcondition)

Add another search control to this view.

Parameters
condition$searchconditionthe condition to add.

◆ build_query()

core_question\local\bank\view::build_query ( )
protected

Create the SQL query to retrieve the indicated questions, based on core_question\bank\search\condition filters.

Reimplemented in mod_quiz\question\bank\custom_view, and qbank_history\question_history_view.

◆ copy_question_moodle_url()

core_question\local\bank\view::copy_question_moodle_url ( $questionid)

Get the URL for duplicating a question as a moodle url.

Parameters
int$questionidthe question id.
Return values
moodle_urlthe URL.

◆ copy_question_url()

core_question\local\bank\view::copy_question_url ( $questionid)

Get the URL for duplicating a given question.

Parameters
int$questionidthe question id.
Return values
stringthe URL, HTML-escaped.

◆ create_new_question_form()

core_question\local\bank\view::create_new_question_form ( $category,
$canadd )
protected

Create a new question form.

Parameters
false | mixed | stdClass$category
bool$canadd

Reimplemented in mod_quiz\question\bank\custom_view, and qbank_history\question_history_view.

◆ default_sort()

core_question\local\bank\view::default_sort ( )
protected

Default sort for question data.

Return values
int[]

Reimplemented in mod_quiz\question\bank\custom_view, and qbank_history\question_history_view.

◆ determine_required_statistics()

core_question\local\bank\view::determine_required_statistics ( )
protected

Work out the list of all the required statistics fields for this question bank view.

This gathers all the required fields from all columns, so they can all be loaded at once.

Return values
string[]the names of all the required fields for this question bank view.

◆ display()

core_question\local\bank\view::display ( $pagevars,
$tabname )

Shows the question bank interface.

The function also processes a number of actions:

Actions affecting the question pool: move Moves a question to a different category deleteselected Deletes the selected questions from the category Other actions: category Chooses the category params: $tabname question bank edit tab name, for permission checking $pagevars current list of page variables

Parameters
string$tabname
array$pagevars

◆ display_advanced_search_form()

core_question\local\bank\view::display_advanced_search_form ( $advancedsearch)
protected

Print the "advanced" UI elements for the form to select which questions.

Hidden by default.

Parameters
array$advancedsearch

Reimplemented in qbank_history\question_history_view.

◆ display_bottom_controls()

core_question\local\bank\view::display_bottom_controls ( \context $catcontext)
protected

Display the controls at the bottom of the list of questions.

Parameters
context$catcontextThe context of the category being displayed.

Reimplemented in mod_quiz\question\bank\custom_view.

◆ display_bottom_pagination()

core_question\local\bank\view::display_bottom_pagination ( $pagination,
$totalnumber,
$perpage,
$pageurl )
protected

Display bottom pagination bar.

Parameters
string$pagination
int$totalnumber
int$perpage
moodle_url$pageurl

◆ display_options_form()

core_question\local\bank\view::display_options_form ( $showquestiontext)
protected

Display the form with options for which questions are displayed and how they are displayed.

Parameters
bool$showquestiontextDisplay the text of the question within the list.

◆ display_question_bank_header()

core_question\local\bank\view::display_question_bank_header ( )
protected

Display the header element for the question bank.

Reimplemented in mod_quiz\question\bank\custom_view, and qbank_history\question_history_view.

◆ display_question_list()

core_question\local\bank\view::display_question_list ( $pageurl,
$categoryandcontext,
$recurse = 1,
$page = 0,
$perpage = null,
$addcontexts = [] )
protected

Prints the table of questions in a category with interactions.

Parameters
moodle_url$pageurlThe URL to reload this page.
string$categoryandcontext'categoryID,contextID'.
int$recurseWhether to include subcategories.
int$pageThe number of the page to be displayed
int | null$perpageNumber of questions to show per page
array$addcontextscontexts where the user is allowed to add new questions.

◆ display_questions()

core_question\local\bank\view::display_questions ( $questions)
protected

Display the questions.

Parameters
array$questions

◆ display_showtext_checkbox()

core_question\local\bank\view::display_showtext_checkbox ( $showquestiontext)
protected

Display the checkbox UI for toggling the display of the question text in the list.

Parameters
bool$showquestiontextthe current or default value for whether to display the text.

◆ display_top_pagnation()

core_question\local\bank\view::display_top_pagnation ( $pagination)
protected

Display the top pagination bar.

Parameters
object$pagination

◆ edit_question_moodle_url()

core_question\local\bank\view::edit_question_moodle_url ( $questionid)

Get the URL for editing a question as a moodle url.

Parameters
int$questionidthe question id.
Return values
moodle_urlthe URL, HTML-escaped.

◆ edit_question_url()

core_question\local\bank\view::edit_question_url ( $questionid)

Get the URL for editing a question as a HTML-escaped string.

Parameters
int$questionidthe question id.
Return values
stringthe URL, HTML-escaped.

◆ end_table()

core_question\local\bank\view::end_table ( )
protected

End of the table html.

Deprecated
since Moodle 4.0
See also
print_table()
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ get_aggregate_statistic()

core_question\local\bank\view::get_aggregate_statistic ( int $questionid,
string $fieldname )

Get the aggregated value of a particular statistic for a particular question.

You can only get values for the questions on the current page of the question bank view, and only if you declared the need for this statistic in the get_required_statistics_fields() method of your question bank column.

Parameters
int$questionidthe id of a question
string$fieldnamethe name of a statistics field, e.g. 'facility'.
Return values
float|nullthe average (across all users) of this statistic for this question. Null if the value is not available right now.

◆ get_column_count()

core_question\local\bank\view::get_column_count ( )

Get the count of the columns.

Return values
intThe number of columns in the table.

◆ get_column_type()

core_question\local\bank\view::get_column_type ( $columnname)
protected

Check a column object from its name and get the object for sort.

Parameters
string$columnname

◆ get_courseid()

core_question\local\bank\view::get_courseid ( )

Get course id.

Return values
mixed

◆ get_current_category()

core_question\local\bank\view::get_current_category ( $categoryandcontext)
protected

Gets current selected category.

Parameters
string$categoryandcontext
Return values
false|mixed|stdClass

◆ get_most_specific_context()

core_question\local\bank\view::get_most_specific_context ( )

Get the context we are displaying the question bank for.

Return values
contextcontext object.

◆ get_primary_sort_order()

core_question\local\bank\view::get_primary_sort_order ( $sort)

Gets the primary sort order according to the default sort.

Parameters
string$sorta column or column_subsort name.
Return values
intthe current sort order for this column -1, 0, 1

◆ get_question_bank_plugins()

core_question\local\bank\view::get_question_bank_plugins ( )
protected

Get the list of qbank plugins with available objects for features.

Return values
array

Reimplemented in mod_quiz\question\bank\custom_view.

◆ get_question_count()

core_question\local\bank\view::get_question_count ( )
protected

Get the number of questions.

Return values
int

◆ get_row_classes()

core_question\local\bank\view::get_row_classes ( $question,
$rowcount )
protected

Gets the classes for the row.

Parameters
stdClass$question
int$rowcount
Return values
array

◆ get_visiblecolumns()

core_question\local\bank\view::get_visiblecolumns ( )

Gets visible columns.

Return values
arrayVisible columns.

◆ has_column()

core_question\local\bank\view::has_column ( $colname)

Checks if the column included in the output.

Parameters
string$colnamea column internal name.
Return values
boolis this column included in the output?

◆ heading_column()

core_question\local\bank\view::heading_column ( )
protected

Specify the column heading.

Return values
stringColumn name for the heading

Reimplemented in mod_quiz\question\bank\custom_view.

◆ init_columns()

core_question\local\bank\view::init_columns ( $wanted,
$heading = '' )
protected

Initializing table columns.

Parameters
array$wantedCollection of column names
string$headingThe name of column that is set as heading

◆ init_sort_from_params()

core_question\local\bank\view::init_sort_from_params ( )
protected

Initialise sort from parameters.

Reimplemented in mod_quiz\question\bank\custom_view.

◆ is_listing_specific_versions()

core_question\local\bank\view::is_listing_specific_versions ( )

Is this view showing separate versions of a question?

Return values
bool

Reimplemented in qbank_history\question_history_view.

◆ load_page_questions()

core_question\local\bank\view::load_page_questions ( $page,
$perpage )
protected

Load the questions we need to display.

Parameters
int$pagepage to display.
int$perpagenumber of questions per page.
Return values
moodle_recordsetquestionid => data about each question.

◆ load_required_statistics()

core_question\local\bank\view::load_required_statistics ( array $questions)
protected

Load the aggregate statistics that all the columns require.

Parameters
stdClass[]$questionsthe questions that will be displayed indexed by question id.

◆ new_sort_url()

core_question\local\bank\view::new_sort_url ( $sort,
$newsortreverse )

Get a URL to redisplay the page with a new sort for the question bank.

Parameters
string$sortthe column, or column_subsort to sort on.
bool$newsortreversewhether to sort in reverse order.
Return values
stringThe new URL.

◆ parse_subsort()

core_question\local\bank\view::parse_subsort ( $sort)
protected

Deal with a sort name of the form columnname, or colname_subsort by breaking it up, validating the bits that are present, and returning them.

If there is no subsort, then $subsort is returned as ''.

Parameters
string$sortthe sort parameter to process.
Return values
array[$colname, $subsort].

◆ preview_question_url()

core_question\local\bank\view::preview_question_url ( $questiondata)

Get the URL to preview a question.

Parameters
stdClass$questiondatathe data defining the question.
Return values
moodle_urlthe URL.
Deprecated
since Moodle 4.0
See also
qbank_previewquestion\helper\question_preview_url()
Todo
Final deprecation on Moodle 4.4 MDL-72438

Reimplemented in mod_quiz\question\bank\custom_view.

◆ print_table()

core_question\local\bank\view::print_table ( $questions)
protected

Prints the actual table with question.

Parameters
array$questions

◆ print_table_row()

core_question\local\bank\view::print_table_row ( $question,
$rowcount )
protected

Prints the table row from child classes.

Parameters
stdClass$question
int$rowcount

◆ process_actions()

core_question\local\bank\view::process_actions ( )

Process actions for the selected action.

Deprecated
since Moodle 4.0
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ process_actions_needing_ui()

core_question\local\bank\view::process_actions_needing_ui ( )

Process actions with ui.

Return values
bool
Deprecated
since Moodle 4.0
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ sort_to_params()

core_question\local\bank\view::sort_to_params ( $sorts)
protected

Sort to parameters.

Parameters
array$sorts
Return values
array

◆ start_table()

core_question\local\bank\view::start_table ( )
protected

Start of the table html.

Deprecated
since Moodle 4.0
See also
print_table()
Todo
Final deprecation on Moodle 4.4 MDL-72438

◆ wanted_columns()

core_question\local\bank\view::wanted_columns ( )
protected

Loads all the available columns.

Return values
array

Reimplemented in qbank_history\question_history_view.

◆ wanted_filters()

core_question\local\bank\view::wanted_filters ( $cat,
$tagids,
$showhidden,
$recurse,
$editcontexts,
$showquestiontext )

The filters for the question bank.

Parameters
string$cat'categoryid,contextid'
array$tagidscurrent list of selected tags
bool$showhiddenwhether deleted questions should be displayed
int$recurseWhether to include subcategories
array$editcontextsparent contexts
bool$showquestiontextwhether the text of each question should be shown in the list

Reimplemented in mod_quiz\question\bank\custom_view, and qbank_history\question_history_view.

Member Data Documentation

◆ $baseurl

moodle_url core_question\local\bank\view::$baseurl
protected

base URL for the current page.

Used as the basis for making URLs for actions that reload the page.

◆ $extrarows

column_base [] core_question\local\bank\view::$extrarows
protected

these are the 'columns' that are actually displayed as an additional row (e.g.

question text), in order. Array keys are the class name.

◆ $loadedstatistics

array core_question\local\bank\view::$loadedstatistics = null
protected

Stores all the average statistics that this question bank view needs.

This field gets initialised in {

See also
display_question_list()}. It is a two dimensional $this->loadedstatistics[$questionid][$fieldname] = $average value of that statistics for that question. Column classes in qbank plugins can access these values using {
get_aggregate_statistic()}.

◆ $requiredcolumns

column_base [] core_question\local\bank\view::$requiredcolumns
protected

these are all the 'columns' that are part of the display.

Array keys are the class name.

◆ $visiblecolumns

column_base [] core_question\local\bank\view::$visiblecolumns
protected

these are the 'columns' that are actually displayed as a column, in order.

Array keys are the class name.


The documentation for this class was generated from the following file: