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

Base class for representing a column. More...

Inheritance diagram for core_question\local\bank\column_base:
core_question\local\bank\action_column_base core_question\local\bank\checkbox_column core_question\local\bank\edit_menu_column core_question\local\bank\row_base mod_quiz\question\bank\question_name_column qbank_comment\comment_count_column qbank_customfields\custom_field_column qbank_editquestion\question_status_column qbank_history\version_number_column qbank_statistics\columns\discrimination_index qbank_statistics\columns\discriminative_efficiency qbank_statistics\columns\facility_index qbank_usage\question_last_used_column qbank_usage\question_usage_column qbank_viewcreator\creator_name_column qbank_viewcreator\modifier_name_column qbank_viewquestionname\viewquestionname_column_helper qbank_viewquestiontype\question_type_column

Public Member Functions

 __construct (view $qbank)
 Constructor.
 
 display ($question, $rowclasses)
 Output this column.
 
 display_header ()
 Output the column header cell.
 
 get_column_name ()
 Get the name of this column.
 
 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 column required.
 
 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.
 

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 ($sort, $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

Base class for representing a column.

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\column_base::__construct ( view $qbank)

Constructor.

Parameters
view$qbankthe question bank view we are helping to render.

Member Function Documentation

◆ display()

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

Output this column.

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

◆ display_content()

◆ display_end()

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

Output the closing column tag.

Parameters
object$question
string$rowclasses

Reimplemented in core_question\local\bank\row_base.

◆ display_start()

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

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.

◆ get_classes()

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

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

Return values
string

◆ get_column_name()

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

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
stringThe unique name;

Reimplemented in qbank_customfields\custom_field_column.

◆ get_extra_classes()

◆ get_extra_joins()

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

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 values
array'table_alias' => 'JOIN clause'

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

◆ get_name()

◆ get_preference()

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

Get if the preference of the row.

Reimplemented in qbank_viewquestiontext\question_text_row.

◆ get_preference_key()

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

Get if the preference key of the row.

Reimplemented in qbank_viewquestiontext\question_text_row.

◆ get_required_fields()

◆ get_required_statistics_fields()

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

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)
protected

Get an icon representing the corrent sort state.

Parameters
bool$reversesort is descending, not ascending.
Return values
stringHTML image tag.

◆ get_title()

◆ get_title_tip()

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

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

Return values
stringa 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 ( )

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 ( )

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

Return values
help_icon|nullhelp 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()

◆ is_extra_row()

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

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 ( )

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
    mixedas 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)

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[]$questionsthe 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)

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 ( $sort,
$title,
$tip,
$defaultreverse = false )
protected

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

Parameters
string$sortthe column to sort on.
string$titlethe link text.
string$tipthe link tool-tip text. If empty, defaults to title.
bool$defaultreversewhether 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 )

Sorts the expressions.

Parameters
bool$reverseWhether to sort in the reverse of the default sort order.
string$subsortif is_sortable returns an array of subnames, then this will be one of those. Otherwise will be empty.
Return values
stringsome SQL to go in the order by clause.

◆ sortorder()

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

Helper method for building sort clauses.

Parameters
bool$reversewhether the normal direction should be reversed.
Return values
string'ASC' or 'DESC'

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