Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Base class for representing a column. More...
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. | |
Base class for representing a column.
core_question\local\bank\column_base::__construct | ( | view | $qbank | ) |
Constructor.
view | $qbank | the question bank view we are helping to render. |
core_question\local\bank\column_base::display | ( | $question, | |
$rowclasses ) |
Output this column.
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. |
|
abstractprotected |
Output the contents of this column.
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 in core_question\local\bank\checkbox_column, core_question\local\bank\edit_menu_column, core_question\local\bank\menu_action_column_base, mod_quiz\question\bank\add_action_column, mod_quiz\question\bank\question_name_column, mod_quiz\question\bank\question_name_text_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_tagquestion\tags_action_column, qbank_usage\question_last_used_column, qbank_usage\question_usage_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.
|
protected |
Output the closing column tag.
object | $question | |
string | $rowclasses |
Reimplemented in core_question\local\bank\row_base.
|
protected |
Output the opening column tag.
If it is set as heading, it will use
tag instead of
stdClass | $question | |
string | $rowclasses |
Reimplemented in core_question\local\bank\row_base.
|
protected |
The CSS classes to apply to every cell in this column.
string |
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.
string | The unique name; |
Reimplemented in qbank_customfields\custom_field_column.
core_question\local\bank\column_base::get_extra_classes | ( | ) |
Any extra class names you would like applied to every cell in this column.
array |
Reimplemented in core_question\local\bank\action_column_base, core_question\local\bank\edit_menu_column, qbank_comment\comment_count_column, qbank_customfields\custom_field_column, qbank_editquestion\question_status_column, qbank_history\history_action_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, and qbank_viewquestionname\question_name_idnumber_tags_column.
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.
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.
|
abstract |
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.
string | column name. |
Reimplemented in core_question\local\bank\checkbox_column, core_question\local\bank\edit_menu_column, mod_quiz\question\bank\add_action_column, mod_quiz\question\bank\question_name_column, mod_quiz\question\bank\question_name_text_column, qbank_comment\comment_count_column, qbank_customfields\custom_field_column, qbank_deletequestion\delete_action_column, qbank_editquestion\copy_action_column, qbank_editquestion\edit_action_column, qbank_editquestion\question_status_column, qbank_exporttoxml\export_xml_action_column, qbank_history\history_action_column, qbank_history\version_number_column, qbank_previewquestion\preview_action_column, qbank_statistics\columns\discrimination_index, qbank_statistics\columns\discriminative_efficiency, qbank_statistics\columns\facility_index, qbank_tagquestion\tags_action_column, qbank_usage\question_last_used_column, qbank_usage\question_usage_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.
core_question\local\bank\column_base::get_preference | ( | ) |
Get if the preference of the row.
Reimplemented in qbank_viewquestiontext\question_text_row.
core_question\local\bank\column_base::get_preference_key | ( | ) |
Get if the preference key of the row.
Reimplemented in qbank_viewquestiontext\question_text_row.
core_question\local\bank\column_base::get_required_fields | ( | ) |
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.
array | fields required. |
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_deletequestion\delete_action_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.
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(...);
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.
|
protected |
Get an icon representing the corrent sort state.
bool | $reverse | sort is descending, not ascending. |
string | HTML image tag. |
|
abstract |
Title for this column.
Not used if is_sortable returns an array.
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, 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_viewquestiontext\question_text_row, and qbank_viewquestiontype\question_type_column.
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.
string | a fuller version of the name. |
Reimplemented in core_question\local\bank\checkbox_column, and qbank_viewquestiontype\question_type_column.
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.
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.
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.
|
protected |
A chance for subclasses to initialise themselves, for example to load lang strings, without having to override the constructor.
Reimplemented in mod_quiz\question\bank\add_action_column, qbank_deletequestion\delete_action_column, qbank_editquestion\copy_action_column, qbank_editquestion\edit_action_column, qbank_exporttoxml\export_xml_action_column, qbank_history\history_action_column, qbank_previewquestion\preview_action_column, qbank_tagquestion\tags_action_column, and qbank_viewquestiontext\question_text_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.
core_question\local\bank\column_base::is_sortable | ( | ) |
Can this column be sorted on? You can return either:
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.
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.
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.
core_question\local\bank\column_base::load_question_tags | ( | array | $questions | ) |
Load the tags for each question.
Helper that can be used from {
array | $questions |
|
protected |
Get a link that changes the sort order, and indicates the current sort state.
string | $sort | 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. |
string |
core_question\local\bank\column_base::sort_expression | ( | $reverse, | |
$subsort ) |
Sorts the expressions.
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. |
string | some SQL to go in the order by clause. |
|
protected |
Helper method for building sort clauses.
bool | $reverse | whether the normal direction should be reversed. |
string | 'ASC' or 'DESC' |