mod_quiz\question\bank\preview_action_column Class Reference

Inheritance diagram for mod_quiz\question\bank\preview_action_column:

Public Member Functions
	display ($question, $rowclasses)
	Output this column.
	display_header (array $columnactions=[], string $width='')
	Output the column header cell.
	display_preview (\stdClass $question, string $rowclasses)
	Output the column with an example value.
	get_column_id ()
	Return a unique ID for this column object.
	get_column_name ()
	Get the name of this column.
	get_default_width ()
	Return the default column width in pixels.
	get_extra_classes ()
	Any extra class names you would like applied to every cell in this column.
	get_extra_joins ()
	Return an array 'table_alias' => 'JOIN clause' to bring in any data that this feature requires.
	get_menu_position ()
	Return an integer to indicate the desired position in the menu for this link, smaller at the top.
	get_name ()
	Get the internal name for this column.
	get_preference ()
	Get if the preference of the row.
	get_preference_key ()
	Get if the preference key of the row.
	get_required_fields ()
	Use table alias 'q' for the question table, or one of the ones from get_extra_joins.
	get_required_statistics_fields ()
	If this column requires any aggregated statistics, it should declare that here.
	get_title ()
	Title for this column.
	get_title_tip ()
	Use this when get_title() returns something very short, and you want a longer version as a tool tip.
	has_preference ()
	Check if the row has an extra preference to view/hide.
	help_icon ()
	If you return a help icon here, it is shown in the column header after the title.
	is_extra_row ()
	Check if the column is an extra row of not.
	is_sortable ()
	Can this column be sorted on? You can return either:
	load_additional_data (array $questions)
	If this column needs extra data (e.g.
	load_question_tags (array $questions)
	Load the tags for each question.
	set_as_heading ()
	Set the column as heading.
	sort_expression ($reverse, $subsort)
	Sorts the expressions.

Static Public Member Functions
static	from_column_name (view $view, string $columnname, bool $ingoremissing=false)
	Return an instance of this column, based on the column name.

Public Attributes
bool	$isvisible = true
	determine whether the column is visible
string const	ID_SEPARATOR = '-'
	A separator for joining column attributes together into a unique ID string.
int const	MENU_POSITION_NOT_SET = 6666
	value we return from get_menu_position here.

Protected Member Functions
	display_content ($question, $rowclasses)
	Output the contents of this column.
	display_end ($question, $rowclasses)
	Output the closing column tag.
	display_start ($question, $rowclasses)
	Output the opening column tag.
	get_classes ()
	The CSS classes to apply to every cell in this column.
	get_sort_icon ($reverse)
	Get an icon representing the corrent sort state.
	init ()
	A chance for subclasses to initialise themselves, for example to load lang strings, without having to override the constructor.
	make_sort_link ($sortname, $title, $tip, $defaultreverse=false)
	Get a link that changes the sort order, and indicates the current sort state.
	sortorder ($reverse)
	Helper method for building sort clauses.

Protected Attributes
bool	$isheading = false
	determine whether the column is td or th.
view	$qbank
	$qbank the question bank view we are helping to render.

Detailed Description

Copyright

2023 Catalyst IT Europe Ltd.

Author

Mark Johnson mark..nosp@m.john.nosp@m.son@c.nosp@m.atal.nosp@m.yst-e.nosp@m.u.ne.nosp@m.t

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

display()

core_question\local\bank\column_base::display ( $question, $rowclasses )

inherited

Output this column.

Parameters

object	$question	the row from the $question table, augmented with extra information.
string	$rowclasses	CSS class names that should be applied to this row of output.

display_content()

mod_quiz\question\bank\preview_action_column::display_content ( $question, $rowclasses )

protected

Output the contents of this column.

Parameters

object	$question	the row from the $question table, augmented with extra information.
string	$rowclasses	CSS class names that should be applied to this row of output.

Reimplemented from core_question\local\bank\column_base.

display_end()

core_question\local\bank\column_base::display_end ( $question, $rowclasses )

protectedinherited

Output the closing column tag.

Parameters

object	$question
string	$rowclasses

Reimplemented in core_question\local\bank\row_base.

display_header()

core_question\local\bank\column_base::display_header ( array $columnactions = [], string $width = '' )

inherited

Output the column header cell.

Parameters

column_action_base[]	$columnactions	A list of column actions to include in the header.
string	$width	A CSS width property value.

Reimplemented in core_question\local\bank\checkbox_column.

display_preview()

core_question\local\bank\column_base::display_preview ( \stdClass $question, string $rowclasses )

inherited

Output the column with an example value.

By default, this will call $this->display() using whatever dummy data is passed in. Columns can override this to provide example output without requiring valid data.

Parameters

stdClass	$question	the row from the $question table, augmented with extra information.
string	$rowclasses	CSS class names that should be applied to this row of output.

Reimplemented in qbank_statistics\columns\discrimination_index, qbank_statistics\columns\discriminative_efficiency, and qbank_statistics\columns\facility_index.

display_start()

core_question\local\bank\column_base::display_start ( $question, $rowclasses )

protectedinherited

Output the opening column tag.

If it is set as heading, it will use

tag instead of

Parameters

stdClass	$question
string	$rowclasses

Reimplemented in core_question\local\bank\row_base.

from_column_name()

static core_question\local\bank\column_base::from_column_name ( view $view, string $columnname, bool $ingoremissing = false )

staticinherited

Return an instance of this column, based on the column name.

In the case of the base class, we don't actually use the column name since the class represents one specific column. However, sub-classes may use the column name as an additional constructor to the parameter.

Parameters

view	$view	Question bank view
string	$columnname	The column name for this instance, as returned by {

See also

get_column_name()}

Parameters

bool

$ingoremissing

Whether to ignore if the class does not exist.

Return values

column_base|null

An instance of this class.

Reimplemented in qbank_customfields\custom_field_column.

get_classes()

core_question\local\bank\column_base::get_classes ( )

protectedinherited

The CSS classes to apply to every cell in this column.

Return values

string

get_column_id()

core_question\local\bank\column_base::get_column_id ( )

finalinherited

Return a unique ID for this column object.

This is constructed using the class name and get_column_name(), which must be unique.

The combination of these attributes allows the object to be reconstructed, by splitting the ID into its constituent parts then calling {

See also

from_column_name()}, like this: [$class, $columnname] = explode(column_base\ID_SEPARATOR, $columnid, 2); $column = $class\from_column_name($qbank, $columnname); Including 2 as the $limit parameter for explode() is a good idea for safely, in case a plugin defines a column with the ID_SEPARATOR in the column name.

Return values

string

The column ID.

get_column_name()

core_question\local\bank\column_base::get_column_name ( )

inherited

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 values

string

The unique name;

Reimplemented in qbank_customfields\custom_field_column.

get_default_width()

mod_quiz\question\bank\preview_action_column::get_default_width

(

)

Return the default column width in pixels.

Return values

int

Reimplemented from core_question\local\bank\column_base.

get_extra_classes()

mod_quiz\question\bank\preview_action_column::get_extra_classes

(

)

Any extra class names you would like applied to every cell in this column.

Return values

array

Reimplemented from core_question\local\bank\column_base.

get_extra_joins()

core_question\local\bank\column_base::get_extra_joins ( )

inherited

Return an array 'table_alias' => 'JOIN clause' to bring in any data that this feature requires.

The return values for all the features will be checked. It is OK if two features join in the same table with the same alias and identical JOIN clauses. If two features try to use the same alias with different joins, you get an error. Tables included by default are question (alias q) and those defined in {

See also

view\get_required_joins()}

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 values

string[]

'table_alias' => 'JOIN clause'

Reimplemented from core_question\local\bank\view_component.

Reimplemented in core_question\local\bank\action_column_base, qbank_viewcreator\creator_name_column, and qbank_viewcreator\modifier_name_column.

get_menu_position()

core_question\local\bank\view_component::get_menu_position ( )

inherited

Return an integer to indicate the desired position in the menu for this link, smaller at the top.

The standard menu items in Moodle core return these numbers: 100 preview_action 200 edit_action 250 copy_action 300 tags_action 400 delete_action 500 history_action 600 export_xml_action (So, if you want your action at a particular place in the order, there should be space.)

If two actions get the same order number, then the tie-break on the sort is plugin name, then the order returned by get_question_actions for that plugin.

Return values

int	desired position. Smallest at the top.

Reimplemented in qbank_deletequestion\delete_action, qbank_editquestion\copy_action, qbank_editquestion\edit_action, qbank_exporttoxml\export_xml_action, qbank_history\history_action, qbank_previewquestion\preview_action, and qbank_tagquestion\tags_action.

get_name()

mod_quiz\question\bank\preview_action_column::get_name

(

)

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 values

string

column name.

Reimplemented from core_question\local\bank\column_base.

get_preference_key()

core_question\local\bank\column_base::get_preference_key ( )

inherited

Get if the preference key of the row.

Reimplemented in qbank_viewquestiontext\question_text_row.

get_required_fields()

core_question\local\bank\column_base::get_required_fields ( )

inherited

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.

Return values

string[]

fields required.

Reimplemented from core_question\local\bank\view_component.

Reimplemented in core_question\local\bank\action_column_base, core_question\local\bank\checkbox_column, core_question\local\bank\edit_menu_column, mod_quiz\question\bank\question_name_column, mod_quiz\question\bank\question_name_text_column, qbank_viewcreator\creator_name_column, qbank_viewcreator\modifier_name_column, qbank_viewquestionname\question_name_idnumber_tags_column, qbank_viewquestionname\viewquestionname_column_helper, qbank_viewquestiontext\question_text_row, and qbank_viewquestiontype\question_type_column.

get_required_statistics_fields()

core_question\local\bank\column_base::get_required_statistics_fields ( )

inherited

If this column requires any aggregated statistics, it should declare that here.

This is those statistics can be efficiently loaded in bulk.

The statistics are all loaded just before load_additional_data is called on each column. The values are then available from $this->qbank->get_aggregate_statistic(...);

Return values

string[]

the names of the required statistics fields. E.g. ['facility'].

Reimplemented in qbank_statistics\columns\discrimination_index, qbank_statistics\columns\discriminative_efficiency, and qbank_statistics\columns\facility_index.

get_sort_icon()

core_question\local\bank\column_base::get_sort_icon ( $reverse )

protectedinherited

Get an icon representing the corrent sort state.

Parameters

bool

$reverse

sort is descending, not ascending.

Return values

string

HTML image tag.

get_title()

mod_quiz\question\bank\preview_action_column::get_title

(

)

Title for this column.

Not used if is_sortable returns an array.

Reimplemented from core_question\local\bank\column_base.

get_title_tip()

core_question\local\bank\column_base::get_title_tip ( )

inherited

Use this when get_title() returns something very short, and you want a longer version as a tool tip.

Return values

string

a fuller version of the name.

Reimplemented in core_question\local\bank\checkbox_column, and qbank_viewquestiontype\question_type_column.

has_preference()

core_question\local\bank\column_base::has_preference ( )

inherited

Check if the row has an extra preference to view/hide.

Reimplemented in qbank_viewquestiontext\question_text_row.

help_icon()

core_question\local\bank\column_base::help_icon ( )

inherited

If you return a help icon here, it is shown in the column header after the title.

Return values

help_icon|null

help icon to show, if required.

Reimplemented in qbank_statistics\columns\discrimination_index, qbank_statistics\columns\discriminative_efficiency, qbank_statistics\columns\facility_index, qbank_usage\question_last_used_column, and qbank_usage\question_usage_column.

init()

core_question\local\bank\view_component::init ( )

protectedinherited

A chance for subclasses to initialise themselves, for example to load lang strings, without having to override the constructor.

Reimplemented in core_question\local\bank\column_action_base, mod_quiz\question\bank\add_action_column, qbank_columnsortorder\local\bank\column_action_move, qbank_columnsortorder\local\bank\column_action_remove, qbank_columnsortorder\local\bank\column_action_resize, qbank_comment\comment_count_column, qbank_deletequestion\delete_action, qbank_editquestion\copy_action, qbank_editquestion\edit_action, qbank_exporttoxml\export_xml_action, qbank_history\history_action, qbank_previewquestion\preview_action, qbank_tagquestion\tags_action, qbank_usage\question_usage_column, and qbank_viewquestiontext\question_text_row.

is_extra_row()

core_question\local\bank\column_base::is_extra_row ( )

inherited

Check if the column is an extra row of not.

Reimplemented in core_question\local\bank\row_base.

is_sortable()

core_question\local\bank\column_base::is_sortable ( )

inherited

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 [ 'firstname' => ['field' => 'uc.firstname', 'title' => get_string('firstname')], 'lastname' => ['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 values

  mixed

  as above.

Reimplemented in mod_quiz\question\bank\question_name_column, qbank_viewcreator\creator_name_column, qbank_viewcreator\modifier_name_column, qbank_viewquestionname\question_name_idnumber_tags_column, qbank_viewquestionname\viewquestionname_column_helper, and qbank_viewquestiontype\question_type_column.

load_additional_data()

core_question\local\bank\column_base::load_additional_data ( array $questions )

inherited

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.

Parameters

stdClass[]

$questions

the questions that will be displayed, indexed by question id.

Reimplemented in mod_quiz\question\bank\question_name_text_column, and qbank_viewquestionname\question_name_idnumber_tags_column.

load_question_tags()

core_question\local\bank\column_base::load_question_tags ( array $questions )

inherited

Load the tags for each question.

Helper that can be used from {

See also

load_additional_data()};

Parameters

array

$questions

make_sort_link()

core_question\local\bank\column_base::make_sort_link ( $sortname, $title, $tip, $defaultreverse = false )

protectedinherited

Get a link that changes the sort order, and indicates the current sort state.

Parameters

string	$sortname	the column to sort on.
string	$title	the link text.
string	$tip	the link tool-tip text. If empty, defaults to title.
bool	$defaultreverse	whether the default sort order for this column is descending, rather than ascending.

Return values

string

sort_expression()

core_question\local\bank\column_base::sort_expression ( $reverse, $subsort )

inherited

Sorts the expressions.

Parameters

bool	$reverse	Whether to sort in the reverse of the default sort order.
string	$subsort	if is_sortable returns an array of subnames, then this will be one of those. Otherwise will be empty.

Return values

string

some SQL to go in the order by clause.

sortorder()

core_question\local\bank\column_base::sortorder ( $reverse )

protectedinherited

Helper method for building sort clauses.

Parameters

bool

$reverse

whether the normal direction should be reversed.

Return values

string

'ASC' or 'DESC'

Member Data Documentation

MENU_POSITION_NOT_SET

int const core_question\local\bank\view_component::MENU_POSITION_NOT_SET = 6666

inherited

value we return from get_menu_position here.

Subclasses should override this.

---

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

• mod/quiz/classes/question/bank/preview_action_column.php