This table has one row for each question in the quiz, with sub-rows when random questions and variants appear. More...

Inheritance diagram for quiz_statistics_table:

Public Member Functions
	__construct ()
	Constructor.

	add_data ($row, $classname='')
	This method actually directly echoes the row passed to it now or adds it to the download. More...

	add_data_keyed ($rowwithkeys, $classname='')
	Add a row of data to the table. More...

	add_separator ()
	Add a seperator line to table.

	col_fullname ($row)
	Fullname is treated as a special columname in tablelib and should always be treated the same as the fullname of a user. More...

	collapsible ($bool)
	Sets the is_collapsible variable to the given boolean. More...

	column_class ($column, $classname)
	Sets the given $column index to the given $classname in $this->column_class. More...

	column_style ($column, $property, $value)
	Sets the given $column index and $property index to the given $value in $this->column_style. More...

	column_style_all ($property, $value)
	Sets all columns' $propertys to the given $value in $this->column_style. More...

	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. More...

	define_baseurl ($url)
	Sets $this->baseurl. More...

	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. More...

	define_headers ($headers)

	define_help_for_headers ($helpicons)
	Defines a help icon for the header. More...

	download_buttons ()
	Get the html for the download buttons. More...

	export_class_instance ($exportclass=null)
	Get, and optionally set, the export class. More...

	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. More...

	format_row ($row)
	Call appropriate methods on this table class to perform any processing on values before displaying in table. More...

	format_text ($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL)
	Used from col_* functions when text is to be displayed. More...

	get_context ()
	Get the context for the table. More...

	get_filterset ()
	Get the currently defined filterset. More...

	get_initial_first ()
	This function is not part of the public api. More...

	get_initial_last ()
	This function is not part of the public api. More...

	get_page_size ()

	get_page_start ()

	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. More...

	get_sort_columns ()
	Get the columns to sort by, in the form required by construct_order_by(). More...

	get_sql_sort ()

	get_sql_where ()

	guess_base_url ()
	Attempt to guess the base URL. More...

	initialbars ($bool)
	Sets the use_initials variable to the given boolean. More...

	is_downloadable ($downloadable=null)
	Probably don't need to call this directly. More...

	is_downloading ($download=null, $filename='', $sheettitle='')
	Call this to pass the download type. More...

	is_persistent ($persistent=null)
	Call with boolean true to store table layout changes in the user_preferences table. More...

	is_sortable ($column=null)
	Is the column sortable? More...

	make_styles_string ($styles)
	This function is not part of the public api. More...

	mark_table_to_reset ()
	Mark the table preferences to be reset.

	no_sorting ($column)
	Do not sort using this column. More...

	other_cols ($column, $row)
	You can override this method in a child class. More...

	pageable ($bool)
	Sets the use_pages variable to the given boolean. More...

	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. More...

	print_headers ()
	This function is not part of the public api.

	print_html ()
	This method is deprecated although the old api is still supported. More...

	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. More...

	print_row ($row, $classname='')
	This function is not part of the public api.

	set_attribute ($attribute, $value)
	Gives the given $value to the $attribute index of $this->attributes. More...

	set_control_variables ($variables)
	Assigns each given variable in the array to the corresponding index in the request class variable. More...

	set_filterset (filterset $filterset)
	Set the filterset in the table class. More...

	set_first_initial (string $initial)
	Set the preferred first name initial in an initials bar. More...

	set_hidden_columns (array $columns)
	Set the list of hidden columns. More...

	set_last_initial (string $initial)
	Set the preferred last name initial in an initials bar. More...

	set_page_number (int $pagenumber)
	Set the page number. More...

	set_sortdata (array $sortdata)
	Set the preferred table sorting attributes. More...

	setup ()
	Must be called after table is defined. More...

	show_download_buttons_at ($showat)
	Where to show download buttons. More...

	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. More...

	start_html ()
	This function is not part of the public api.

	start_output ()
	This function is not part of the public api. More...

	statistics_setup ($quiz, $cmid, $reporturl, $s)
	Set up the columns and headers and other properties of the table and then call flexible_table::setup() method. More...

	text_sorting ($column)
	Use text sorting functions for this column (required for text columns with Oracle). More...

	wrap_html_finish ()
	Close a statistics table div. More...

	wrap_html_start ()
	Open a div tag to wrap statistics table. More...

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. More...

static	get_sort_for_table ($uniqueid)
	Get the order by clause from the session or user preferences, for the table with id $uniqueid. More...

Public Attributes
	$attributes = array()

	$baseurl = NULL

	$column_class = array()

	$column_nosort = array('userpic')

	$column_style = array()

	$column_suppress = array()

	$columns = array()

	$currentrow = 0

	$currpage = 0

string	$download = ''
	which download plugin to use. More...

bool	$downloadable = false
	whether data is downloadable from table. More...

	$exportclass = null

	$headers = array()

	$is_collapsible = false

	$is_sortable = false

	$maxsortkeys = 2

	$pagesize = 30

	$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

bool	$started_output = false
	Has start output been called yet?

	$totalrows = 0

	$uniqueid = NULL

	$use_initials = false

	$use_pages = false

string	$useridfield = 'id'
	Key of field returned by db query that is the id field of the user table or equivalent.

Protected Member Functions
	can_be_reset ()
	Are there some table preferences that can be reset? More...

	col_actions ($questionstat)
	Actions that can be performed on the question by this user (e.g. More...

	col_discrimination_index ($questionstat)
	Discrimination index. More...

	col_discriminative_efficiency ($questionstat)
	Discrimination efficiency, similar to, but different from, the Discrimination index. More...

	col_effective_weight ($questionstat)
	The effective question weight. More...

	col_facility ($questionstat)
	The facility index (average fraction). More...

	col_icon ($questionstat)
	The question type icon. More...

	col_intended_weight ($questionstat)
	The intended question weight. More...

	col_name ($questionstat)
	The question name. More...

	col_number ($questionstat)
	The question number. More...

	col_qtype ($questionstat)
	The question type name. More...

	col_random_guess_score ($questionstat)
	An estimate of the fraction a student would get by guessing randomly. More...

	col_s ($questionstat)
	The number of attempts at this question. More...

	col_sd ($questionstat)
	The standard deviation of the fractions. More...

	format_percentage (float $number, bool $fraction=true, int $decimals=2)
	Format a number to a localised percentage with specified decimal points. More...

	format_percentage_range (float $min=null, float $max=null, bool $fraction=true, int $decimals=2)
	Format $min and $max to localised percentages and form a string that represents a range between them. More...

	format_range (string $min=null, string $max=null)
	Format inputs to represent a range between $min and $max. More...

	get_component ()
	Get dynamic class component. More...

	get_dynamic_table_html_end ()
	Get the dynamic table end wrapper. More...

	get_dynamic_table_html_start ()
	Get the dynamic table start wrapper. More...

	get_handler ()
	Get dynamic class handler. More...

	get_primary_sort_order ()
	Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table. More...

	get_sort_order ()
	Return sorting attributes values. More...

	initialise_table_preferences ()
	Initialise table preferences.

	is_calculated_question_summary ($questionstat)
	Check if the given stats object is an instance of calculated_question_summary. More...

	is_dubious_question ($questionstat)
	This method encapsulates the test for wheter a question should be considered dubious. More...

	is_resetting_preferences ()
	Is the table marked for reset preferences? More...

	print_one_initials_bar ($alpha, $current, $class, $title, $urlvar)
	Helper function, used by print_initials_bar() to output one initial bar. More...

	render_reset_button ()
	Generate the HTML for the table preferences reset button. More...

	save_preferences ($oldprefs)
	Save preferences. More...

	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. More...

	sort_icon ($isprimary, $order)
	Generate the HTML for the sort icon. More...

	sort_link ($text, $column, $isprimary, $order)
	Generate the HTML for the sort link. More...

	sort_order_name ($isprimary, $order)
	Generate the correct tool tip for changing the sort order. More...

Protected Attributes
integer	$cmid
	the quiz course_module id.

$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.

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.

object	$quiz
	the quiz settings.

$resetting	$resetting
	bool Whether the table preferences is resetting.

$sheettitle	$sheettitle

array	$sortdata
	The fields to sort.

Detailed Description

This table has one row for each question in the quiz, with sub-rows when random questions and variants appear.

There are columns for the various item and position statistics.

Copyright: 2008 Jamie Pratt

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

Member Function Documentation

◆ add_data()

flexible_table::add_data	(	$row,
		$classname = `''`
	)

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.

Parameters

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.

Return values

bool success.

◆ add_data_keyed()

flexible_table::add_data_keyed	(	$rowwithkeys,
		$classname = `''`
	)

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

Parameters

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.

◆ can_be_reset()

flexible_table::can_be_reset ( )

protectedinherited

Are there some table preferences that can be reset?

If true, then the "reset table preferences" widget should be displayed.

Return values

bool

◆ col_actions()

quiz_statistics_table::col_actions ( $questionstat )

protected

Actions that can be performed on the question by this user (e.g.

edit or preview).

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_discrimination_index()

quiz_statistics_table::col_discrimination_index ( $questionstat )

protected

Discrimination index.

This is the product moment correlation coefficient between the fraction for this question, and the average fraction for the other questions in this quiz.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_discriminative_efficiency()

quiz_statistics_table::col_discriminative_efficiency ( $questionstat )

protected

Discrimination efficiency, similar to, but different from, the Discrimination index.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_effective_weight()

quiz_statistics_table::col_effective_weight ( $questionstat )

protected

The effective question weight.

That is, an estimate of the actual influence this question has on the student's overall mark.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_facility()

quiz_statistics_table::col_facility ( $questionstat )

protected

The facility index (average fraction).

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_fullname()

flexible_table::col_fullname ( $row )

inherited

Fullname is treated as a special columname in tablelib and should always be treated the same as the fullname of a user.

@uses $this->useridfield if the userid field is not expected to be id then you need to override $this->useridfield to point at the correct field for the user id.

Parameters

object $row the data from the db containing all fields from the users table necessary to construct the full name of the user in current language.

Return values

string contents of cell in column 'fullname', for this row.

Reimplemented in quiz_attempts_report_table, forumreport_summary\summary_table, core_user\table\participants, webservice\token_table, tool_policy\acceptances_table, assign_grading_table, report_configlog\output\report_table, core_tag_manage_table, and mod_h5pactivity\local\report\participants.

◆ col_icon()

quiz_statistics_table::col_icon ( $questionstat )

protected

The question type icon.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_intended_weight()

quiz_statistics_table::col_intended_weight ( $questionstat )

protected

The intended question weight.

Maximum mark for the question as a percentage of maximum mark for the quiz. That is, the indended influence this question on the student's overall mark.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_name()

quiz_statistics_table::col_name ( $questionstat )

protected

The question name.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_number()

quiz_statistics_table::col_number ( $questionstat )

protected

The question number.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_qtype()

quiz_statistics_table::col_qtype ( $questionstat )

protected

The question type name.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_random_guess_score()

quiz_statistics_table::col_random_guess_score ( $questionstat )

protected

An estimate of the fraction a student would get by guessing randomly.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_s()

quiz_statistics_table::col_s ( $questionstat )

protected

The number of attempts at this question.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ col_sd()

quiz_statistics_table::col_sd ( $questionstat )

protected

The standard deviation of the fractions.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

string contents of this table cell.

◆ collapsible()

flexible_table::collapsible ( $bool )

inherited

Sets the is_collapsible variable to the given boolean.

Parameters

bool $bool

Return values

void

◆ column_class()

flexible_table::column_class	(	$column,
		$classname
	)

inherited

Sets the given $column index to the given $classname in $this->column_class.

Parameters

int	$column
string	$classname

Return values

void

◆ column_style()

flexible_table::column_style	(	$column,
		$property,
		$value
	)

inherited

Sets the given $column index and $property index to the given $value in $this->column_style.

Parameters

int	$column
string	$property
mixed	$value

Return values

void

◆ column_style_all()

flexible_table::column_style_all	(	$property,
		$value
	)

inherited

Sets all columns' $propertys to the given $value in $this->column_style.

Parameters

int	$property
string	$value

Return values

void

◆ column_suppress()

flexible_table::column_suppress ( $column )

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.

Parameters

int $column the index of a column.

◆ construct_order_by()

static flexible_table::construct_order_by	(	$cols,
		$textsortcols = `array()`
	)

staticinherited

Prepare an an order by clause from the list of columns to be sorted.

Parameters

array $cols column name => SORT_ASC or SORT_DESC

Return values

SQL	fragment that can be used in an ORDER BY clause.

◆ define_baseurl()

flexible_table::define_baseurl ( $url )

inherited

Sets $this->baseurl.

Parameters

moodle_url | string $url the url with params needed to call up this page

◆ define_columns()

flexible_table::define_columns ( $columns )

inherited

Parameters

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.

◆ define_header_column()

flexible_table::define_header_column ( string $column )

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.

Parameters

string $column

◆ define_headers()

flexible_table::define_headers ( $headers )

inherited

Parameters

array $headers numerical keyed array of displayed string titles for each column.

◆ define_help_for_headers()

flexible_table::define_help_for_headers ( $helpicons )

inherited

Defines a help icon for the header.

Always use this function if you need to create header with sorting and help icon.

Parameters

renderable[] $helpicons An array of renderable objects to be used as help icons

◆ download_buttons()

flexible_table::download_buttons ( )

inherited

Get the html for the download buttons.

Usually only use internally

Reimplemented in mod_feedback_responses_table.

◆ export_class_instance()

flexible_table::export_class_instance ( $exportclass = null )

inherited

Get, and optionally set, the export class.

Parameters

$exportclass (optional) if passed, set the table to use this export class.

Return values

table_default_export_format_parent the export class in use (after any set).

◆ format_and_add_array_of_rows()

flexible_table::format_and_add_array_of_rows	(	$rowstoadd,
		$finish = `true`
	)

inherited

Add a number of rows to the table at once.

And optionally finish output after they have been added.

Parameters

	(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

◆ format_percentage()

quiz_statistics_table::format_percentage	(	float	$number,
		bool	$fraction = `true`,
		int	$decimals = `2`
	)

protected

Format a number to a localised percentage with specified decimal points.

Parameters

float	$number	The number being formatted
bool	$fraction	An indicator for whether the number is a fraction or is already multiplied by 100
int	$decimals	Sets the number of decimal points

Return values

string

◆ format_percentage_range()

quiz_statistics_table::format_percentage_range	(	float	$min = `null`,
		float	$max = `null`,
		bool	$fraction = `true`,
		int	$decimals = `2`
	)

protected

Format $min and $max to localised percentages and form a string that represents a range between them.

This function does not check if $min is less than $max or not. If both $min and $max are equal to null, this function returns an empty string.

Parameters

float \| null	$min	The minimum value of the range
float \| null	$max	The maximum value of the range
bool	$fraction	An indicator for whether min and max are a fractions or are already multiplied by 100
int	$decimals	Sets the number of decimal points

Return values

string A formatted string that represents a range between $min to $max.

◆ format_range()

quiz_statistics_table::format_range	(	string	$min = `null`,
		string	$max = `null`
	)

protected

Format inputs to represent a range between $min and $max.

This function does not check if $min is less than $max or not. If both $min and $max are equal to null, this function returns an empty string.

Parameters

string \| null	$min	The minimum value in the range
string \| null	$max	The maximum value in the range

Return values

string

◆ format_row()

flexible_table::format_row ( $row )

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'.

Parameters

array | object $row row of data from db used to make one row of the table.

Return values

array one row for the table, added using add_data_keyed method.

Reimplemented in tool_policy\acceptances_table, and assign_grading_table.

◆ format_text()

flexible_table::format_text	(	$text,
		$format = `FORMAT_MOODLE`,
		$options = `NULL`,
		$courseid = `NULL`
	)

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.

◆ get_component()

flexible_table::get_component ( )

protectedinherited

Get dynamic class component.

Return values

string

◆ get_context()

flexible_table::get_context ( )

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.

Return values

context

Reimplemented in mod_feedback_responses_table, and core_user\table\participants.

◆ get_dynamic_table_html_end()

flexible_table::get_dynamic_table_html_end ( )

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.

Return values

string

◆ get_dynamic_table_html_start()

flexible_table::get_dynamic_table_html_start ( )

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.

Return values

string

◆ get_filterset()

flexible_table::get_filterset ( )

inherited

Get the currently defined filterset.

Return values

filterset

◆ get_handler()

flexible_table::get_handler ( )

protectedinherited

Get dynamic class handler.

Return values

string

◆ get_initial_first()

flexible_table::get_initial_first ( )

inherited

This function is not part of the public api.

Return values

string initial of first name we are currently filtering by

◆ get_initial_last()

flexible_table::get_initial_last ( )

inherited

This function is not part of the public api.

Return values

string initial of last name we are currently filtering by

◆ get_page_size()

flexible_table::get_page_size ( )

inherited

Return values

int	the pagesize for LIMIT clause of SQL

◆ get_page_start()

flexible_table::get_page_start ( )

inherited

Return values

int	the offset for LIMIT clause of SQL

◆ get_primary_sort_order()

flexible_table::get_primary_sort_order ( )

protectedinherited

Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table.

Return values

array

◆ get_row_html()

flexible_table::get_row_html	(	$row,
		$classname = `''`
	)

inherited

Generate html code for the passed row.

Parameters

array	$row	Row data.
string	$classname	classes to add.

Return values

string::$html html code for the row passed.

◆ get_sort_columns()

flexible_table::get_sort_columns ( )

inherited

Get the columns to sort by, in the form required by construct_order_by().

Return values

array column name => SORT_... constant.

Reimplemented in tool_policy\acceptances_table, assign_grading_table, and quiz_attempts_report_table.

◆ get_sort_for_table()

static flexible_table::get_sort_for_table ( $uniqueid )

staticinherited

Get the order by clause from the session or user preferences, for the table with id $uniqueid.

Parameters

string $uniqueid the identifier for a table.

Return values

SQL	fragment that can be used in an ORDER BY clause.

◆ get_sort_order()

flexible_table::get_sort_order ( )

protectedinherited

Return sorting attributes values.

Return values

array

◆ get_sql_sort()

flexible_table::get_sql_sort ( )

inherited

Return values

SQL	fragment that can be used in an ORDER BY clause.

Reimplemented in gradereport_history\output\tablelog, and report_configlog\output\report_table.

◆ get_sql_where()

flexible_table::get_sql_where ( )

inherited

Return values

string sql to add to where statement.

Reimplemented in tool_policy\acceptances_table, and core_tag_manage_table.

◆ guess_base_url()

flexible_table::guess_base_url ( )

inherited

Attempt to guess the base URL.

Reimplemented in core_user\table\participants.

◆ initialbars()

flexible_table::initialbars ( $bool )

inherited

Sets the use_initials variable to the given boolean.

Parameters

bool $bool

Return values

void

◆ is_calculated_question_summary()

quiz_statistics_table::is_calculated_question_summary ( $questionstat )

protected

Check if the given stats object is an instance of calculated_question_summary.

Parameters

core_question::statistics::questions::calculated $questionstat Stats object

Return values

bool

◆ is_downloadable()

flexible_table::is_downloadable ( $downloadable = null )

inherited

Probably don't need to call this directly.

Calling is_downloading with a param automatically sets table as downloadable.

Parameters

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.

Return values

bool	whether table data is set to be downloadable.

◆ is_downloading()

flexible_table::is_downloading	(	$download = `null`,
		$filename = `''`,
		$sheettitle = `''`
	)

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.

Parameters

string	$download	dataformat type. One of csv, xhtml, ods, etc
string	$filename	filename for downloads without file extension.
string	$sheettitle	title for downloaded data.

Return values

string download dataformat type. One of csv, xhtml, ods, etc

◆ is_dubious_question()

quiz_statistics_table::is_dubious_question ( $questionstat )

protected

This method encapsulates the test for wheter a question should be considered dubious.

Parameters

core_question::statistics::questions::calculated $questionstat stats for the question.

Return values

bool	is this question possibly not pulling it's weight?

◆ is_persistent()

flexible_table::is_persistent ( $persistent = null )

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.

Parameters

bool $persistent Optional parameter to set table layout persistence.

Return values

bool	Whether or not the table layout preferences will persist.

◆ is_resetting_preferences()

flexible_table::is_resetting_preferences ( )

protectedinherited

Is the table marked for reset preferences?

Return values

bool	True if the table is marked to reset, false otherwise.

◆ is_sortable()

flexible_table::is_sortable ( $column = null )

inherited

Is the column sortable?

Parameters

string column name, null means table

Return values

bool

◆ make_styles_string()

flexible_table::make_styles_string ( $styles )

inherited

This function is not part of the public api.

Parameters

array $styles CSS-property => value

Return values

string values suitably to go in a style="" attribute in HTML.

◆ no_sorting()

flexible_table::no_sorting ( $column )

inherited

Do not sort using this column.

Parameters

string column name

◆ other_cols()

flexible_table::other_cols	(	$column,
		$row
	)

inherited

You can override this method in a child class.

See the description of build_table which calls this method.

Reimplemented in quiz_overview_table, quiz_last_responses_table, core_user\table\participants, webservice\token_table, quiz_statistics_question_table, assign_grading_table, tool_policy\acceptances_table, and mod_feedback_responses_table.

◆ pageable()

flexible_table::pageable ( $bool )

inherited

Sets the use_pages variable to the given boolean.

Parameters

bool $bool

Return values

void

◆ pagesize()

flexible_table::pagesize	(	$perpage,
		$total
	)

inherited

Sets the pagesize variable to the given integer, the totalrows variable to the given integer, and the use_pages variable to true.

Parameters

int	$perpage
int	$total

Return values

void

◆ print_html()

flexible_table::print_html ( )

inherited

This method is deprecated although the old api is still supported.

Deprecated:: 1.9.2 - Jun 2, 2008

◆ print_nothing_to_display()

flexible_table::print_nothing_to_display ( )

inherited

This function is not part of the public api.

Reimplemented in 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, tool_lp\output\template_plans_table, forumreport_summary\summary_table, and mod_h5pactivity\local\report\participants.

◆ print_one_initials_bar()

flexible_table::print_one_initials_bar	(	$alpha,
		$current,
		$class,
		$title,
		$urlvar
	)

protectedinherited

Helper function, used by print_initials_bar() to output one initial bar.

Parameters

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.

Deprecated:: since Moodle 3.3

◆ render_reset_button()

flexible_table::render_reset_button ( )

protectedinherited

Generate the HTML for the table preferences reset button.

Return values

string HTML fragment, empty string if no need to reset

◆ save_preferences()

flexible_table::save_preferences ( $oldprefs )

protectedinherited

Save preferences.

Parameters

array $oldprefs Old preferences to compare against.

◆ set_attribute()

flexible_table::set_attribute	(	$attribute,
		$value
	)

inherited

Gives the given $value to the $attribute index of $this->attributes.

Parameters

string	$attribute
mixed	$value

Return values

void

◆ set_control_variables()

flexible_table::set_control_variables ( $variables )

inherited

Assigns each given variable in the array to the corresponding index in the request class variable.

Parameters

array $variables

Return values

void

◆ set_filterset()

flexible_table::set_filterset ( filterset $filterset )

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.

Parameters

filterset $filterset The filterset object to get filters and table parameters from

Reimplemented in core_user\table\participants.

◆ set_first_initial()

flexible_table::set_first_initial ( string $initial )

inherited

Set the preferred first name initial in an initials bar.

Parameters

string $initial The character to set

◆ set_hidden_columns()

flexible_table::set_hidden_columns ( array $columns )

inherited

Set the list of hidden columns.

Parameters

array $columns The list of hidden columns.

◆ set_last_initial()

flexible_table::set_last_initial ( string $initial )

inherited

Set the preferred last name initial in an initials bar.

Parameters

string $initial The character to set

◆ set_page_number()

flexible_table::set_page_number ( int $pagenumber )

inherited

Set the page number.

Parameters

int $pagenumber The page number.

◆ set_sortdata()

flexible_table::set_sortdata ( array $sortdata )

inherited

Set the preferred table sorting attributes.

Parameters

string	$sortby	The field to sort by.
int	$sortorder	The sort order.

◆ setup()

flexible_table::setup ( )

inherited

Must be called after table is defined.

Use methods above first. Cannot use functions below till after calling this method.

Return values

type?

Reimplemented in assign_grading_table.

◆ show_download_buttons_at()

flexible_table::show_download_buttons_at ( $showat )

inherited

Where to show download buttons.

Parameters

array $showat array of postions in which to show download buttons. Containing TABLE_P_TOP and/or TABLE_P_BOTTOM

◆ show_hide_link()

flexible_table::show_hide_link	(	$column,
		$index
	)

protectedinherited

Generate the HTML for the collapse/uncollapse icon.

This is a helper method used by print_headers().

Parameters

string	$column	the column name, index into various names.
int	$index	numerical index of the column.

Return values

string HTML fragment.

Reimplemented in tool_dataprivacy\output\data_requests_table, tool_dataprivacy\output\expired_contexts_table, assign_grading_table, and core_user\table\participants.

◆ sort_icon()

flexible_table::sort_icon	(	$isprimary,
		$order
	)

protectedinherited

Generate the HTML for the sort icon.

This is a helper method used by sort_link().

Parameters

bool	$isprimary	whether an icon is needed (it is only needed for the primary sort column.)
int	$order	SORT_ASC or SORT_DESC

Return values

string HTML fragment.

◆ sort_link()

flexible_table::sort_link	(	$text,
		$column,
		$isprimary,
		$order
	)

protectedinherited

Generate the HTML for the sort link.

This is a helper method used by print_headers().

Parameters

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

Return values

string HTML fragment.

◆ sort_order_name()

flexible_table::sort_order_name	(	$isprimary,
		$order
	)

protectedinherited

Generate the correct tool tip for changing the sort order.

This is a helper method used by sort_link().

Parameters

bool	$isprimary	whether the is column is the current primary sort column.
int	$order	SORT_ASC or SORT_DESC

Return values

string the correct title.

◆ sortable()

flexible_table::sortable	(	$bool,
		$defaultcolumn = `NULL`,
		$defaultorder = `SORT_ASC`
	)

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.

Parameters

bool	$bool
string	$defaultcolumn
int	$defaultorder

Return values

void

◆ start_output()

flexible_table::start_output ( )

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.

◆ statistics_setup()

quiz_statistics_table::statistics_setup	(	$quiz,
		$cmid,
		$reporturl,
		$s
	)

Set up the columns and headers and other properties of the table and then call flexible_table::setup() method.

Parameters

object	$quiz	the quiz settings
int	$cmid	the quiz course_module id
moodle_url	$reporturl	the URL to redisplay this report.
int	$s	number of attempts included in the statistics.

◆ text_sorting()

flexible_table::text_sorting ( $column )

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.

Parameters

string column name

◆ wrap_html_finish()

quiz_statistics_table::wrap_html_finish ( )

Close a statistics table div.

Reimplemented from flexible_table.

◆ wrap_html_start()

quiz_statistics_table::wrap_html_start ( )

Open a div tag to wrap statistics table.

Reimplemented from flexible_table.

Member Data Documentation

◆ $download

string flexible_table::$download = ''

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 $

◆ $downloadable

bool flexible_table::$downloadable = false

inherited

whether data is downloadable from table.

Determines whether to display download buttons. Set by method downloadable().

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

mod/quiz/report/statistics/statistics_table.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_data()

◆ add_data_keyed()

◆ can_be_reset()

◆ col_actions()

◆ col_discrimination_index()

◆ col_discriminative_efficiency()

◆ col_effective_weight()

◆ col_facility()

◆ col_fullname()

◆ col_icon()

◆ col_intended_weight()

◆ col_name()

◆ col_number()

◆ col_qtype()

◆ col_random_guess_score()

◆ col_s()

◆ col_sd()

◆ collapsible()

◆ column_class()

◆ column_style()

◆ column_style_all()

◆ column_suppress()

◆ construct_order_by()

◆ define_baseurl()

◆ define_columns()

◆ define_header_column()

◆ define_headers()

◆ define_help_for_headers()

◆ download_buttons()

◆ export_class_instance()

◆ format_and_add_array_of_rows()

◆ format_percentage()

◆ format_percentage_range()

◆ format_range()

◆ format_row()

◆ format_text()

◆ get_component()

◆ get_context()

◆ get_dynamic_table_html_end()

◆ get_dynamic_table_html_start()

◆ get_filterset()

◆ get_handler()

◆ get_initial_first()

◆ get_initial_last()

◆ get_page_size()

◆ get_page_start()

◆ get_primary_sort_order()

◆ get_row_html()

◆ get_sort_columns()

◆ get_sort_for_table()

◆ get_sort_order()

◆ get_sql_sort()

◆ get_sql_where()

◆ guess_base_url()

◆ initialbars()

◆ is_calculated_question_summary()

◆ is_downloadable()

◆ is_downloading()

◆ is_dubious_question()

◆ is_persistent()

◆ is_resetting_preferences()

◆ is_sortable()

◆ make_styles_string()

◆ no_sorting()

◆ other_cols()

◆ pageable()

◆ pagesize()

◆ print_html()

◆ print_nothing_to_display()

◆ print_one_initials_bar()

◆ render_reset_button()

◆ save_preferences()

◆ set_attribute()