Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
This is a table subclass for displaying the quiz responses report, showing first or all tries. More...
Public Member Functions | |
add_data ($row, $classname='') | |
This method actually directly echoes the row passed to it now or adds it to the download. | |
add_data_keyed ($rowwithkeys, $classname='') | |
Add a row of data to the table. | |
add_separator () | |
Add a seperator line to table. | |
base_sql (\core\dml\sql_join $allowedstudentsjoins) | |
Contruct all the parts of the main database query. | |
build_table () | |
Build the table from the fetched data. | |
checkbox_col_header (string $columnname) | |
Generates the contents for the checkbox column header. | |
close_recordset () | |
Closes recordset (for use after building the table). | |
col_checkbox ($tablerow) | |
Generate the display of the checkbox column. | |
col_duration ($attempt) | |
Generate the display of the duration column. | |
col_email ($tablerow) | |
Cell value function for email column. | |
col_feedbacktext ($attempt) | |
Generate the display of the feedback column. | |
col_fullname ($attempt) | |
Generate the display of the user's full name column. | |
col_picture ($attempt) | |
Generate the display of the user's picture column. | |
col_state ($tablerow) | |
Generate the display of the attempt state column. | |
col_sumgrades ($tablerow) | |
Cell value function for sumgrades column. | |
col_timefinish ($attempt) | |
Generate the display of the finish time column. | |
col_timestart ($attempt) | |
Generate the display of the start time column. | |
collapsible ($bool) | |
Sets the is_collapsible variable to the given boolean. | |
column_class ($column, $classname) | |
Sets the given $column index to the given $classname in $this->column_class. | |
column_sticky (string $column, bool $sticky=true) | |
Sets a sticky attribute to a column. | |
column_style ($column, $property, $value) | |
Sets the given $column index and $property index to the given $value in $this->column_style. | |
column_style_all ($property, $value) | |
Sets all columns' $propertys to the given $value in $this->column_style. | |
column_suppress ($column) | |
What this method does is set the column so that if the same data appears in consecutive rows, then it is not repeated. | |
data_col ($slot, $field, $attempt) | |
define_baseurl ($url) | |
Sets $this->baseurl. | |
define_columns ($columns) | |
define_header_column (string $column) | |
Mark a specific column as being a table header using the column name defined in define_columns. | |
define_headers ($headers) | |
define_help_for_headers ($helpicons) | |
Defines a help icon for the header. | |
download_buttons () | |
Get the html for the download buttons. | |
export_class_instance ($exportclass=null) | |
Get, and optionally set, the export class. | |
finish_html () | |
This function is not part of the public api. | |
finish_output ($closeexportclassdoc=true) | |
You should call this to finish outputting the table data after adding data to the table with add_data or add_data_keyed. | |
format_and_add_array_of_rows ($rowstoadd, $finish=true) | |
Add a number of rows to the table at once. | |
format_row ($row) | |
Call appropriate methods on this table class to perform any processing on values before displaying in table. | |
format_text ($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) | |
Used from col_* functions when text is to be displayed. | |
get_context () | |
Get the context for the table. | |
get_default_per_page () | |
Get the default per page. | |
get_filterset () | |
Get the currently defined filterset. | |
get_initial_first () | |
This function is not part of the public api. | |
get_initial_last () | |
This function is not part of the public api. | |
get_no_of_tries ($tablerow, $slot) | |
How many tries were attempted at this question in this slot, during this usage? | |
get_page_size () | |
get_page_start () | |
get_row_cells_html (string $rowid, array $row, ?array $suppresslastrow) | |
Generate html code for the row cells. | |
get_row_class ($tablerow) | |
Get any extra classes names to add to this row in the HTML. | |
get_row_from_keyed ($rowwithkeys) | |
This function is not part of the public api. | |
get_row_html ($row, $classname='') | |
Generate html code for the passed row. | |
get_sort_columns () | |
Get the columns to sort by, in the form required by construct_order_by(). | |
get_sql_sort () | |
get_sql_where () | |
get_summary_after_try ($tablerow, $slot) | |
Get the summary of the response after the try. | |
guess_base_url () | |
Attempt to guess the base URL. | |
initialbars ($bool) | |
Sets the use_initials variable to the given boolean. | |
is_downloadable ($downloadable=null) | |
Probably don't need to call this directly. | |
is_downloading ($download=null, $filename='', $sheettitle='') | |
Call this to pass the download type. | |
is_persistent ($persistent=null) | |
Call with boolean true to store table layout changes in the user_preferences table. | |
is_sortable ($column=null) | |
Is the column sortable? | |
make_review_link ($data, $tablerow, $slot) | |
Make a link to review an individual question in a popup window. | |
make_styles_string ($styles) | |
This function is not part of the public api. | |
mark_table_to_reset () | |
Mark the table preferences to be reset. | |
no_sorting ($column) | |
Do not sort using this column. | |
other_cols ($colname, $attempt) | |
You can override this method in a child class. | |
out ($pagesize, $useinitialsbar, $downloadhelpbutton='') | |
Convenience method to call a number of methods for you to display the table. | |
pageable ($bool) | |
Sets the use_pages variable to the given boolean. | |
pagesize ($perpage, $total) | |
Sets the pagesize variable to the given integer, the totalrows variable to the given integer, and the use_pages variable to true. | |
print_headers () | |
This function is not part of the public api. | |
print_html () | |
This method is deprecated although the old api is still supported. | |
print_initials_bar () | |
This function is not part of the public api. | |
print_nothing_to_display () | |
This function is not part of the public api. | |
print_row ($row, $classname='') | |
This function is not part of the public api. | |
query_db ($pagesize, $useinitialsbar=true) | |
Query the db. | |
render_caption () | |
This function renders a table caption. | |
set_attribute ($attribute, $value) | |
Gives the given $value to the $attribute index of $this->attributes. | |
set_caption (string $caption, ?array $captionattributes) | |
This function set caption for table. | |
set_columnsattributes (array $attributes) | |
Sets the given $attributes to $this->columnsattributes. | |
set_control_variables ($variables) | |
Assigns each given variable in the array to the corresponding index in the request class variable. | |
set_count_sql ($sql, array $params=NULL) | |
This is only needed if you want to use different sql to count rows. | |
set_default_per_page (int $defaultperpage) | |
Set the default per page. | |
set_filterset (filterset $filterset) | |
Set the filterset in the table class. | |
set_first_initial (string $initial) | |
Set the preferred first name initial in an initials bar. | |
set_hidden_columns (array $columns) | |
Set the list of hidden columns. | |
set_last_initial (string $initial) | |
Set the preferred last name initial in an initials bar. | |
set_page_number (int $pagenumber) | |
Set the page number. | |
set_quiz_setting (quiz_settings $quizobj) | |
A way for the report to pass in the quiz settings object. | |
set_sortdata (array $sortdata) | |
Set the preferred table sorting attributes. | |
set_sql ($fields, $from, $where, array $params=array()) | |
Set the sql to query the db. | |
setup () | |
Must be called after table is defined. | |
setup_sql_queries ($allowedjoins) | |
Set up the SQL queries (count rows, and get data). | |
show_download_buttons_at ($showat) | |
Where to show download buttons. | |
sortable ($bool, $defaultcolumn=NULL, $defaultorder=SORT_ASC) | |
Sets the is_sortable variable to the given boolean, sort_default_column to the given string, and the sort_default_order to the given integer. | |
start_html () | |
This function is not part of the public api. | |
start_output () | |
This function is not part of the public api. | |
text_sorting ($column) | |
Use text sorting functions for this column (required for text columns with Oracle). | |
wrap_html_finish () | |
Hook that can be overridden in child classes to wrap a table in a form for example. | |
wrap_html_start () | |
Hook that can be overridden in child classes to wrap a table in a form for example. | |
Static Public Member Functions | |
static | construct_order_by ($cols, $textsortcols=array()) |
Prepare an an order by clause from the list of columns to be sorted. | |
static | get_filterset_class () |
Get the class used as a filterset. | |
static | get_sort_for_table ($uniqueid) |
Get the order by clause from the session or user preferences, for the table with id $uniqueid. | |
Public Attributes | |
$attributes = array() | |
$baseurl = NULL | |
string | $caption |
$caption The caption of table | |
array | $captionattributes |
$captionattributes The caption attributes of table | |
$column_class = array() | |
$column_nosort = array('userpic') | |
$column_style = array() | |
$column_suppress = array() | |
$columns = array() | |
$countparams = NULL | |
$countsql = NULL | |
$currentrow = 0 | |
$currpage = 0 | |
string | $download = '' |
which download plugin to use. | |
bool | $downloadable = false |
whether data is downloadable from table. | |
table_dataformat_export_format | $exportclass = null |
$headers = array() | |
bool | $is_collapsible = true |
Overriding default for this. | |
bool | $is_sortable = true |
Overriding default for this. | |
$maxsortkeys = 2 | |
$pagesize = 30 | |
array Traversable | $rawdata = NULL |
Data fetched from the db. | |
$request = array() | |
boolean | $setup = false |
Stores if setup has already been called on this flixible table. | |
$showdownloadbuttonsat = array(TABLE_P_TOP) | |
Array of positions in which to display download controls. | |
$sort_default_column = NULL | |
$sort_default_order = SORT_ASC | |
object | $sql = NULL |
sql for querying db. | |
bool | $started_output = false |
Has start output been called yet? | |
$totalrows = 0 | |
$uniqueid = NULL | |
$use_initials = false | |
$use_pages = false | |
$useridfield = 'userid' | |
Protected Member Functions | |
add_grade_item_mark (int $gradeitemid) | |
Add a field marks$gradeitemid to the query, with the total score for that grade item. | |
add_latest_state_join ($slot) | |
Add the information about the latest state of the question with slot $slot to the query. | |
can_be_reset () | |
Are there some table preferences that can be reset? | |
field_from_extra_data ($tablerow, $slot, $field) | |
Column text from the extra data loaded in load_extra_data(), before html formatting etc. | |
get_component () | |
Get dynamic class component. | |
get_dynamic_table_html_end () | |
Get the dynamic table end wrapper. | |
get_dynamic_table_html_start () | |
Get the dynamic table start wrapper. | |
get_handler () | |
Get dynamic class handler. | |
get_primary_sort_order () | |
Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table. | |
get_qubaids_condition () | |
Get an appropriate qubaid_condition for loading more data about the attempts we are displaying. | |
get_question_attempt ($questionusagesid, $slot) | |
Return the question attempt object. | |
get_required_latest_state_fields ($slot, $alias) | |
Get any fields that might be needed when sorting on date for a particular slot. | |
get_sort_order () | |
Return sorting attributes values. | |
icon_for_fraction ($fraction) | |
Return an appropriate icon (green tick, red cross, etc.) for a grade. | |
initialise_table_preferences () | |
Initialise table preferences. | |
is_flagged ($questionusageid, $slot) | |
Has this question usage been flagged? | |
is_grade_item_column (string $columnname) | |
Is this the column key for an extra grade item column? | |
is_last_try ($tablerow, $slot, $tryno) | |
Is this the last try in the question attempt? | |
is_latest_step_column ($column) | |
Is this a column that depends on joining to the latest state information? | |
is_resetting_preferences () | |
Is the table marked for reset preferences? | |
load_extra_data () | |
Load any extra data after main query. | |
load_grade_item_marks () | |
Load the total mark for each grade item for each attempt. | |
load_question_latest_steps (qubaid_condition $qubaids=null) | |
Load information about the latest state of selected questions in selected attempts. | |
print_one_initials_bar ($alpha, $current, $class, $title, $urlvar) | |
Helper function, used by print_initials_bar() to output one initial bar. | |
render_reset_button () | |
Generate the HTML for the table preferences reset button. | |
requires_extra_data () | |
Does this report require loading any more data after the main query. | |
requires_latest_steps_loaded () | |
Does this report require the detailed information for each question from the question_attempts_steps table? | |
save_preferences ($oldprefs) | |
Save preferences. | |
set_hide_show_preferences () | |
Set hide and show preferences. | |
set_initials_preferences () | |
Fill in the preferences for the initials bar. | |
set_sorting_preferences () | |
Calculate the preferences for sort order based on user-supplied values and get params. | |
show_hide_link ($column, $index) | |
Generate the HTML for the collapse/uncollapse icon. | |
slot_fraction ($tablerow, $slot) | |
The grade for this slot after this try. | |
slot_state ($tablerow, $slot) | |
Find the state for $slot given after this try. | |
sort_icon ($isprimary, $order) | |
Generate the HTML for the sort icon. | |
sort_link ($text, $column, $isprimary, $order) | |
Generate the HTML for the sort link. | |
sort_order_name ($isprimary, $order) | |
Generate the correct tool tip for changing the sort order. | |
step_no_for_try ($questionusageid, $slot, $tryno) | |
What is the step no this try was seen in? | |
submit_buttons () | |
Output any submit buttons required by the $this->includecheckboxes form. | |
update_sql_after_count ($fields, $from, $where, $params) | |
Lets subclasses modify the SQL after the count query has been created and before the full query is. | |
Protected Attributes | |
bool null | $canreopen = null |
used by { | |
array | $columnsticky = [] |
The sticky attribute of each table column. | |
context_module | $context |
the quiz context. | |
array | $displayoptions |
the display options. | |
string | $filename |
$filename | |
filterset | $filterset = null |
The currently applied filerset This is required for dynamic tables, but can be used by other tables too if desired. | |
float[][] null array | $gradeitemtotals = null |
total mark for each grade item. | |
core dml sql_join | $groupstudentsjoins |
Contains joins, wheres, params to find students in the currently selected group, if applicable. | |
string | $headercolumn = null |
A column which should be considered as a header column. | |
array | $hiddencolumns |
$hiddencolumns List of hidden columns. | |
string | $ifirst |
The manually set first name initial preference. | |
string | $ilast |
The manually set last name initial preference. | |
bool | $includecheckboxes |
whether to include the column with checkboxes to select each attempt. | |
array | $lateststeps = null |
information about the latest step of each question. | |
stdClass | $options |
attempts_report_options the options affecting this report. | |
string | $qmsubselect |
HTML fragment to select the first/best/last attempt, if appropriate. | |
array | $questions |
the questions that comprise this quiz. | |
question_usage_by_activity[] | $questionusagesbyactivity |
The full question usage object for each try shown in report. | |
stdClass | $quiz |
the quiz settings for the quiz we are reporting on. | |
quiz_settings quiz_settings | $quizobj |
quiz settings object for this quiz. | |
moodle_url | $reporturl |
the URL of this report. | |
bool | $resetting |
$resetting Whether the table preferences is resetting. | |
string | $sheettitle |
$sheettitle | |
array | $sortdata |
The fields to sort. | |
string | $strtimeformat |
strftime format. | |
core dml sql_join | $studentsjoins |
Contains joins, wheres, params to find the students in the course. | |
string | $togglegroup = 'quiz-attempts' |
The toggle group name for the checkboxes in the checkbox column. | |
string[] | $userfullnamecolumns = ['fullname'] |
Columns that are expected to contain a users fullname. | |
This is a table subclass for displaying the quiz responses report, showing first or all tries.
|
inherited |
This method actually directly echoes the row passed to it now or adds it to the download.
If this is the first row and start_output has not already been called this method also calls start_output to open the table or send headers for the downloaded. Can be used as before. print_html now calls finish_html to close table.
array | $row | a numerically keyed row of data to add to the table. |
string | $classname | CSS class name to add to this row's tr tag. |
bool | success. |
|
inherited |
Add a row of data to the table.
This function takes an array or object with column names as keys or property names.
It ignores any elements with keys that are not defined as columns. It puts in empty strings into the row when there is no element in the passed array corresponding to a column in the table. It puts the row elements in the proper order (internally row table data is stored by in arrays with a numerical index corresponding to the column number).
object | array | $rowwithkeys | array keys or object property names are column names, as defined in call to define_columns. |
string | $classname | CSS class name to add to this row's tr tag. |
|
protectedinherited |
Add a field marks$gradeitemid to the query, with the total score for that grade item.
int | $gradeitemid | the grade item to add information for. |
|
protectedinherited |
Add the information about the latest state of the question with slot $slot to the query.
The extra information is added as a join to a 'table' with alias qa$slot, with columns that are a union of the columns of the question_attempts and question_attempts_states tables.
int | $slot | the question to add information for. |
|
inherited |
Contruct all the parts of the main database query.
core\dml\sql_join | $allowedstudentsjoins | (joins, wheres, params) defines allowed users for the report. |
array | with 4 elements [$fields, $from, $where, $params] that can be used to build the actual database query. |
|
inherited |
Build the table from the fetched data.
Take the data returned from the db_query and go through all the rows processing each col using either col_{columnname} method or other_cols method or if other_cols returns NULL then put the data straight into the table.
After calling this function, don't forget to call close_recordset.
Reimplemented from table_sql.
|
protectedinherited |
Are there some table preferences that can be reset?
If true, then the "reset table preferences" widget should be displayed.
bool |
|
inherited |
Generates the contents for the checkbox column header.
It returns the HTML for a master core\output\checkbox_toggleall component that selects/deselects all quiz attempts.
string | $columnname | The name of the checkbox column. |
string |
quiz_first_or_all_responses_table::col_checkbox | ( | $attempt | ) |
Generate the display of the checkbox column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
Generate the display of the duration column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
quiz_first_or_all_responses_table::col_email | ( | $tablerow | ) |
Cell value function for email column.
This extracts the contents for any cell in the email column from the row data.
stdClass | $tablerow | Row data. |
string | What to put in the cell for this column, for this row data. |
|
inherited |
Generate the display of the feedback column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
|
inherited |
Generate the display of the user's full name column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
Reimplemented from flexible_table.
|
inherited |
Generate the display of the user's picture column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
quiz_first_or_all_responses_table::col_state | ( | $attempt | ) |
Generate the display of the attempt state column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
quiz_first_or_all_responses_table::col_sumgrades | ( | $tablerow | ) |
Cell value function for sumgrades column.
This extracts the contents for any cell in the sumgrades column from the row data.
stdClass | $tablerow | Row data. |
string | What to put in the cell for this column, for this row data. |
Reimplemented from quiz_last_responses_table.
|
inherited |
Generate the display of the finish time column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
|
inherited |
Generate the display of the start time column.
stdClass | $attempt | the table row being output. |
string | HTML content to go inside the td. |
|
inherited |
Sets the is_collapsible variable to the given boolean.
bool | $bool |
void |
|
inherited |
Sets the given $column index to the given $classname in $this->column_class.
int | $column | |
string | $classname |
void |
|
inherited |
Sets a sticky attribute to a column.
string | $column | Column name |
bool | $sticky |
|
inherited |
Sets the given $column index and $property index to the given $value in $this->column_style.
int | $column | |
string | $property | |
mixed | $value |
void |
|
inherited |
Sets all columns' $propertys to the given $value in $this->column_style.
int | $property | |
string | $value |
void |
|
inherited |
What this method does is set the column so that if the same data appears in consecutive rows, then it is not repeated.
For example, in the quiz overview report, the fullname column is set to be suppressed, so that when one student has made multiple attempts, their name is only printed in the row for their first attempt.
int | $column | the index of a column. |
|
staticinherited |
Prepare an an order by clause from the list of columns to be sorted.
array | $cols | column name => SORT_ASC or SORT_DESC |
string | SQL fragment that can be used in an ORDER BY clause. |
|
inherited |
Sets $this->baseurl.
moodle_url | string | $url | the url with params needed to call up this page |
|
inherited |
array | $columns | an array of identifying names for columns. If columns are sorted then column names must correspond to a field in sql. |
Reimplemented in mod_feedback_responses_table.
|
inherited |
Mark a specific column as being a table header using the column name defined in define_columns.
Note: Only one column can be a header, and it will be rendered using a th tag.
string | $column |
|
inherited |
array | $headers | numerical keyed array of displayed string titles for each column. |
|
inherited |
Defines a help icon for the header.
Always use this function if you need to create header with sorting and help icon.
renderable[] | $helpicons | An array of renderable objects to be used as help icons |
|
inherited |
Get the html for the download buttons.
Usually only use internally
Reimplemented in core_reportbuilder\table\custom_report_table, core_reportbuilder\table\custom_report_table_view, core_reportbuilder\table\system_report_table, and mod_feedback_responses_table.
|
inherited |
Get, and optionally set, the export class.
table_dataformat_export_format | $exportclass | (optional) if passed, set the table to use this export class. |
table_dataformat_export_format | the export class in use (after any set). |
|
protected |
Column text from the extra data loaded in load_extra_data(), before html formatting etc.
stdClass | $attempt | |
int | $slot | |
string | $field |
string |
Reimplemented from quiz_last_responses_table.
|
inherited |
Add a number of rows to the table at once.
And optionally finish output after they have been added.
(object|array|null)[] | $rowstoadd Array of rows to add to table, a null value in array adds a separator row. Or a object or array is added to table. We expect properties for the row array as would be passed to add_data_keyed. | |
bool | $finish |
|
inherited |
Call appropriate methods on this table class to perform any processing on values before displaying in table.
Takes raw data from the database and process it into human readable format, perhaps also adding html linking when displaying table as html, adding a div wrap, etc.
See for example col_fullname below which will be called for a column whose name is 'fullname'.
array | object | $row | row of data from db used to make one row of the table. |
array | one row for the table, added using add_data_keyed method. |
Reimplemented in assign_grading_table, core_reportbuilder\table\custom_report_table, core_reportbuilder\table\system_report_table, and tool_policy\acceptances_table.
|
inherited |
Used from col_* functions when text is to be displayed.
Does the right thing - either converts text to html or strips any html tags depending on if we are downloading and what is the download type. Params are the same as format_text function in weblib.php but some default options are changed.
|
protectedinherited |
Get dynamic class component.
string |
|
inherited |
Get the context for the table.
Note: This function must be overridden by dynamic tables to ensure that the context is correctly determined from the filterset parameters.
context |
Reimplemented in core_admin\table\plugin_management_table, core_reportbuilder\table\base_report_table, core_user\table\participants, and mod_feedback_responses_table.
|
inherited |
Get the default per page.
int |
Reimplemented in core_reportbuilder\table\custom_report_table_view.
|
protectedinherited |
Get the dynamic table end wrapper.
If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
string |
Reimplemented in core_admin\table\plugin_management_table.
|
protectedinherited |
Get the dynamic table start wrapper.
If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
string |
|
inherited |
Get the currently defined filterset.
filterset |
|
staticinherited |
Get the class used as a filterset.
string |
Reimplemented in core_admin\table\plugin_management_table.
|
protectedinherited |
Get dynamic class handler.
string |
|
inherited |
This function is not part of the public api.
string | initial of first name we are currently filtering by |
|
inherited |
This function is not part of the public api.
string | initial of last name we are currently filtering by |
quiz_first_or_all_responses_table::get_no_of_tries | ( | $tablerow, | |
$slot ) |
How many tries were attempted at this question in this slot, during this usage?
stdClass | $tablerow | attempt data from db. |
int | $slot | Slot number |
int | the number of tries in the question attempt for slot $slot. |
|
inherited |
int | the pagesize for LIMIT clause of SQL |
|
inherited |
int | the offset for LIMIT clause of SQL |
|
protectedinherited |
Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table.
array |
|
protectedinherited |
Get an appropriate qubaid_condition for loading more data about the attempts we are displaying.
qubaid_condition |
|
protected |
Return the question attempt object.
int | $questionusagesid | |
int | $slot |
question_attempt |
|
protectedinherited |
Get any fields that might be needed when sorting on date for a particular slot.
int | $slot | the slot for the column we want. |
string | $alias | the table alias for latest state information relating to that slot. |
string | sql fragment to alias fields. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
Generate html code for the row cells.
string | $rowid | |
array | $row | |
array | null | $suppresslastrow |
string |
Reimplemented in core_reportbuilder\table\custom_report_table.
quiz_first_or_all_responses_table::get_row_class | ( | $row | ) |
Get any extra classes names to add to this row in the HTML.
$row | array the data for this row. |
string | added to the class="" attribute of the tr. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
Generate html code for the passed row.
array | $row | Row data. |
string | $classname | classes to add. |
string\$html | html code for the row passed. |
|
inherited |
Get the columns to sort by, in the form required by construct_order_by().
array | column name => SORT_... constant. |
Reimplemented from flexible_table.
|
staticinherited |
Get the order by clause from the session or user preferences, for the table with id $uniqueid.
string | $uniqueid | the identifier for a table. |
string | SQL fragment that can be used in an ORDER BY clause. |
|
protectedinherited |
Return sorting attributes values.
array |
|
inherited |
string | SQL fragment that can be used in an ORDER BY clause. |
Reimplemented in core_reportbuilder\table\base_report_table, and gradereport_history\output\tablelog.
|
inherited |
array | sql to add to where statement. |
Reimplemented in core_tag_manage_table, and tool_policy\acceptances_table.
quiz_first_or_all_responses_table::get_summary_after_try | ( | $tablerow, | |
$slot ) |
Get the summary of the response after the try.
stdClass | $tablerow | row data |
int | $slot | Slot number. |
string | summary for the question after this try. |
|
inherited |
Attempt to guess the base URL.
Reimplemented in core_admin\table\activity_management_table, core_admin\table\block_management_table, core_admin\table\editor_management_table, core_admin\table\plugin_management_table, core_reportbuilder\table\base_report_table, core_user\table\participants, and editor_tiny\table\plugin_management_table.
|
protectedinherited |
Return an appropriate icon (green tick, red cross, etc.) for a grade.
float | $fraction | grade on a scale 0..1. |
string | html fragment. |
|
inherited |
Sets the use_initials variable to the given boolean.
bool | $bool |
void |
|
inherited |
Probably don't need to call this directly.
Calling is_downloading with a param automatically sets table as downloadable.
bool | $downloadable | optional param to set whether data from table is downloadable. If ommitted this function can be used to get current state of table. |
bool | whether table data is set to be downloadable. |
Reimplemented in core_admin\table\plugin_management_table.
|
inherited |
Call this to pass the download type.
Use : $download = optional_param('download', '', PARAM_ALPHA); To get the download type. We assume that if you call this function with params that this table's data is downloadable, so we call is_downloadable for you (even if the param is '', which means no download this time. Also you can call this method with no params to get the current set download type.
string | null | $download | type of dataformat for export. |
string | $filename | filename for downloads without file extension. |
string | $sheettitle | title for downloaded data. |
string | download dataformat type. |
|
protected |
Has this question usage been flagged?
int | $questionusageid | Question usage id. |
int | $slot | Slot number |
bool | Has it been flagged? |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
protectedinherited |
Is this the column key for an extra grade item column?
string | $columnname | e.g. 'marks123' or 'duration'. |
int | grade item id if this is a column for showing that grade item grade, else, 0. |
|
protected |
Is this the last try in the question attempt?
stdClass | $tablerow | attempt data from db. |
int | $slot | Slot number |
int | $tryno | try no |
bool | Is it the last try? |
|
protectedinherited |
Is this a column that depends on joining to the latest state information?
If so, return the corresponding slot. If not, return false.
string | $column | a column name |
int|false | false if no, else a slot. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
Call with boolean true to store table layout changes in the user_preferences table.
Note: user_preferences.value has a maximum length of 1333 characters. Call with no parameter to get current state of table persistence.
bool | $persistent | Optional parameter to set table layout persistence. |
bool | Whether or not the table layout preferences will persist. |
|
protectedinherited |
Is the table marked for reset preferences?
bool | True if the table is marked to reset, false otherwise. |
|
inherited |
Is the column sortable?
string | column name, null means table |
bool |
|
protected |
Load any extra data after main query.
At this point you can call {
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
protectedinherited |
Load information about the latest state of selected questions in selected attempts.
The results are returned as a two-dimensional array $qubaid => $slot => $dataobject.
qubaid_condition | null | $qubaids | used to restrict which usages are included in the query. See { |
array | of records. See the SQL in this function to see the fields available. |
quiz_first_or_all_responses_table::make_review_link | ( | $data, | |
$attempt, | |||
$slot ) |
Make a link to review an individual question in a popup window.
string | $data | HTML fragment. The text to make into the link. |
stdClass | $attempt | data for the row of the table being output. |
int | $slot | the number used to identify this question within this usage. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
This function is not part of the public api.
array | $styles | CSS-property => value |
string | values suitably to go in a style="" attribute in HTML. |
|
inherited |
Do not sort using this column.
string | column name |
|
inherited |
You can override this method in a child class.
See the description of build_table which calls this method.
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
inherited |
Convenience method to call a number of methods for you to display the table.
Reimplemented in core_reportbuilder\table\custom_report_table, core_user\table\participants, forumreport_summary\summary_table, mod_feedback_responses_table, and report_loglive_table_log_ajax.
|
inherited |
Sets the use_pages variable to the given boolean.
bool | $bool |
void |
|
inherited |
Sets the pagesize variable to the given integer, the totalrows variable to the given integer, and the use_pages variable to true.
int | $perpage | |
int | $total |
void |
|
inherited |
This function is not part of the public api.
Reimplemented in core_reportbuilder\table\custom_report_table, core_reportbuilder\table\custom_report_table_view, and mod_h5pactivity\local\report\participants.
|
inherited |
This method is deprecated although the old api is still supported.
|
inherited |
This function is not part of the public api.
Reimplemented in core\moodlenet\share_progress_table, core_reportbuilder\table\base_report_table, core_reportbuilder\table\custom_report_table, forumreport_summary\summary_table, mod_h5pactivity\local\report\participants, tool_cohortroles\output\cohort_role_assignments_table, tool_dataprivacy\output\data_requests_table, tool_dataprivacy\output\expired_contexts_table, tool_lp\output\template_cohorts_table, and tool_lp\output\template_plans_table.
|
protectedinherited |
Helper function, used by print_initials_bar() to output one initial bar.
array | $alpha | of letters in the alphabet. |
string | $current | the currently selected letter. |
string | $class | class name to add to this initial bar. |
string | $title | the name to put in front of this initial bar. |
string | $urlvar | URL parameter name for this initial. |
|
inherited |
Query the db.
Store results in the table object for use by build_table.
int | $pagesize | size of page for paginated displayed table. |
bool | $useinitialsbar | do you want to use the initials bar. Bar will only be used if there is a fullname column defined for the table. |
Reimplemented from table_sql.
Reimplemented in quiz_overview_table.
|
inherited |
This function renders a table caption.
string\$output | Caption of table. |
|
protectedinherited |
Generate the HTML for the table preferences reset button.
string | HTML fragment, empty string if no need to reset |
|
protectedinherited |
Does this report require loading any more data after the main query.
bool | should { |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
protectedinherited |
Does this report require the detailed information for each question from the question_attempts_steps table?
bool | should { |
Reimplemented in quiz_overview_table.
|
protectedinherited |
Save preferences.
array | $oldprefs | Old preferences to compare against. |
|
inherited |
Gives the given $value to the $attribute index of $this->attributes.
string | $attribute | |
mixed | $value |
void |
|
inherited |
|
inherited |
Sets the given $attributes to $this->columnsattributes.
Column attributes will be added to every cell in the column.
array[] | $attributes | e.g. ['c0_firstname' => ['data-foo' => 'bar']] |
|
inherited |
Assigns each given variable in the array to the corresponding index in the request class variable.
array | $variables |
void |
|
inherited |
This is only needed if you want to use different sql to count rows.
Used for example when perhaps all db JOINS are not needed when counting records. You don't need to call this function the count_sql will be generated automatically.
We need to count rows returned by the db seperately to the query itself as we need to know how many pages of data we have to display.
|
inherited |
Set the default per page.
int | $defaultperpage |
|
inherited |
Set the filterset in the table class.
The use of filtersets is a requirement for dynamic tables, but can be used by other tables too if desired.
filterset | $filterset | The filterset object to get filters and table parameters from |
Reimplemented in core_reportbuilder\table\system_report_table, and core_user\table\participants.
|
inherited |
Set the preferred first name initial in an initials bar.
string | $initial | The character to set |
|
inherited |
Set the list of hidden columns.
array | $columns | The list of hidden columns. |
|
inherited |
Set the preferred last name initial in an initials bar.
string | $initial | The character to set |
|
inherited |
Set the page number.
int | $pagenumber | The page number. |
|
inherited |
A way for the report to pass in the quiz settings object.
Currently done in {
quiz_settings | $quizobj |
|
inherited |
Set the preferred table sorting attributes.
string | $sortby | The field to sort by. |
int | $sortorder | The sort order. |
|
inherited |
Set the sql to query the db.
Query will be : SELECT $fields FROM $from WHERE $where Of course you can use sub-queries, JOINS etc. by putting them in the appropriate clause of the query.
Reimplemented in forumreport_summary\summary_table.
|
inherited |
Must be called after table is defined.
Use methods above first. Cannot use functions below till after calling this method.
Reimplemented in assign_grading_table, and core_admin\table\activity_management_table.
|
inherited |
Set up the SQL queries (count rows, and get data).
core\dml\sql_join | $allowedjoins | (joins, wheres, params) defines allowed users for the report. |
|
inherited |
Where to show download buttons.
array | $showat | array of postions in which to show download buttons. Containing TABLE_P_TOP and/or TABLE_P_BOTTOM |
|
protectedinherited |
Generate the HTML for the collapse/uncollapse icon.
This is a helper method used by print_headers().
string | $column | the column name, index into various names. |
int | $index | numerical index of the column. |
string | HTML fragment. |
Reimplemented in assign_grading_table, core_tag_manage_table, core_user\table\participants, tool_dataprivacy\output\data_requests_table, and tool_dataprivacy\output\expired_contexts_table.
|
protected |
The grade for this slot after this try.
stdClass | $tablerow | attempt data from db. |
int | $slot | Slot number. |
float | The fraction. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
protected |
Find the state for $slot given after this try.
stdClass | $tablerow | row data |
int | $slot | Slot number. |
question_state | The question state after the attempt. |
Reimplemented from mod_quiz\local\reports\attempts_report_table.
|
protectedinherited |
Generate the HTML for the sort icon.
This is a helper method used by sort_link().
bool | $isprimary | whether an icon is needed (it is only needed for the primary sort column.) |
int | $order | SORT_ASC or SORT_DESC |
string | HTML fragment. |
|
protectedinherited |
Generate the HTML for the sort link.
This is a helper method used by print_headers().
string | $text | the text for the link. |
string | $column | the column name, may be a fake column like 'firstname' or a real one. |
bool | $isprimary | whether the is column is the current primary sort column. |
int | $order | SORT_ASC or SORT_DESC |
string | HTML fragment. |
|
protectedinherited |
Generate the correct tool tip for changing the sort order.
This is a helper method used by sort_link().
bool | $isprimary | whether the is column is the current primary sort column. |
int | $order | SORT_ASC or SORT_DESC |
string | the correct title. |
|
inherited |
Sets the is_sortable variable to the given boolean, sort_default_column to the given string, and the sort_default_order to the given integer.
bool | $bool | |
string | $defaultcolumn | |
int | $defaultorder |
void |
|
inherited |
This function is not part of the public api.
Reimplemented in core_reportbuilder\table\base_report_table.
|
inherited |
This function is not part of the public api.
You don't normally need to call this. It is called automatically when needed when you start adding data to the table.
|
protected |
What is the step no this try was seen in?
int | $questionusageid | The question usage id. |
int | $slot | Slot number |
int | $tryno | Try no |
int | the step no or zero if not found |
|
protectedinherited |
Output any submit buttons required by the $this->includecheckboxes form.
Reimplemented in quiz_overview_table.
|
inherited |
Use text sorting functions for this column (required for text columns with Oracle).
Be warned that you cannot use this with column aliases. You can only do this with real columns. See MDL-40481 for an example.
string | column name |
|
protectedinherited |
Lets subclasses modify the SQL after the count query has been created and before the full query is.
string | $fields | SELECT list. |
string | $from | JOINs part of the SQL. |
string | $where | WHERE clauses. |
array | $params | Query params. |
array | with 4 elements ($fields, $from, $where, $params) as from base_sql. |
Reimplemented in quiz_overview_table.
|
inherited |
Hook that can be overridden in child classes to wrap a table in a form for example.
Called only when there is data to display and not downloading.
Reimplemented from flexible_table.
|
inherited |
Hook that can be overridden in child classes to wrap a table in a form for example.
Called only when there is data to display and not downloading.
Reimplemented from flexible_table.
|
protectedinherited |
used by {
|
inherited |
which download plugin to use.
Default '' means none - print html table with paging. Property set by is_downloading which typically passes in cleaned data from $
|
inherited |
whether data is downloadable from table.
Determines whether to display download buttons. Set by method downloadable().
|
protectedinherited |
total mark for each grade item.
Array question_usage.id => quiz_grade_item.id => mark. Loaded by {
|
protectedinherited |
information about the latest step of each question.
Loaded by {
|
protectedinherited |
quiz settings object for this quiz.
Gets set in {
|
inherited |
sql for querying db.
Has fields 'fields', 'from', 'where', 'params'.
|
protectedinherited |
Columns that are expected to contain a users fullname.