Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_question\local\bank\plugin_features_base Class Reference

Class plugin_features_base is the base class for qbank plugins. More...

Inheritance diagram for core_question\local\bank\plugin_features_base:
qbank_bulkmove\plugin_feature qbank_columnsortorder\plugin_feature qbank_comment\plugin_feature qbank_customfields\plugin_feature qbank_deletequestion\plugin_feature qbank_editquestion\plugin_feature qbank_exportquestions\plugin_feature qbank_exporttoxml\plugin_feature qbank_history\plugin_feature qbank_importquestions\plugin_feature qbank_managecategories\plugin_feature qbank_previewquestion\plugin_feature qbank_statistics\plugin_feature qbank_tagquestion\plugin_feature qbank_usage\plugin_feature qbank_viewcreator\plugin_feature qbank_viewquestionname\plugin_feature qbank_viewquestiontext\plugin_feature qbank_viewquestiontype\plugin_feature

Public Member Functions

 get_bulk_actions ()
 This method will return the array objects for the bulk actions ui.
 
 get_column_manager ()
 This method will return a column manager object, if this plugin provides one.
 
 get_navigation_node ()
 This method will return the object for the navigation node.
 
 get_question_actions (view $qbank)
 This method will return the array of objects to be rendered as a part of question bank actions.
 
 get_question_bank_controls (view $qbank, context $context, int $categoryid)
 This method will return an array of renderable objects, for adding additional controls to the question bank screen.
 
 get_question_columns (view $qbank)
 This method will return the array of objects to be rendered as a part of question bank columns.
 
 get_question_filters (view $qbank=null)
 Return search conditions for the plugin.
 

Detailed Description

Class plugin_features_base is the base class for qbank plugins.

Author
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

Member Function Documentation

◆ get_bulk_actions()

core_question\local\bank\plugin_features_base::get_bulk_actions ( )

This method will return the array objects for the bulk actions ui.

Return values
bulk_action_base[]

Reimplemented in qbank_bulkmove\plugin_feature, and qbank_deletequestion\plugin_feature.

◆ get_column_manager()

core_question\local\bank\plugin_features_base::get_column_manager ( )

This method will return a column manager object, if this plugin provides one.

Return values
?column_manager_base

Reimplemented in qbank_columnsortorder\plugin_feature.

◆ get_navigation_node()

core_question\local\bank\plugin_features_base::get_navigation_node ( )

This method will return the object for the navigation node.

Return values
null|navigation_node_base

Reimplemented in qbank_exportquestions\plugin_feature, qbank_importquestions\plugin_feature, and qbank_managecategories\plugin_feature.

◆ get_question_actions()

core_question\local\bank\plugin_features_base::get_question_actions ( view $qbank)

This method will return the array of objects to be rendered as a part of question bank actions.

Parameters
view$qbank
Return values
question_action_base[]

Reimplemented in qbank_editquestion\plugin_feature, and qbank_history\plugin_feature.

◆ get_question_bank_controls()

core_question\local\bank\plugin_features_base::get_question_bank_controls ( view $qbank,
context $context,
int $categoryid )

This method will return an array of renderable objects, for adding additional controls to the question bank screen.

The array returned can include a numeric index for each object, to indicate the position in which it should be displayed relative to other controls. If two plugins return controls with the same position, they will be displayed after one another, based on the alphabetical order of the plugin component names.

Parameters
view$qbankThe question bank view.
context$contextThe current context, for permission checks.
int$categoryidThe current question category ID.
Return values
renderable[]

Reimplemented in qbank_columnsortorder\plugin_feature, qbank_editquestion\plugin_feature, and qbank_viewquestiontext\plugin_feature.

◆ get_question_columns()

core_question\local\bank\plugin_features_base::get_question_columns ( view $qbank)

This method will return the array of objects to be rendered as a part of question bank columns.

Parameters
view$qbank
Return values
array

Reimplemented in qbank_customfields\plugin_feature, qbank_usage\plugin_feature, and qbank_viewquestiontext\plugin_feature.

◆ get_question_filters()

core_question\local\bank\plugin_features_base::get_question_filters ( view $qbank = null)

Return search conditions for the plugin.

Parameters
view | null$qbank
Return values
condition[]

Reimplemented in mod_quiz\question\bank\quiz_managecategories_feature, qbank_deletequestion\plugin_feature, qbank_managecategories\plugin_feature, and qbank_tagquestion\plugin_feature.


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