This is a table subclass for displaying the quiz grades report. More...

Inheritance diagram for quiz_overview_table:

Public Member Functions
	__construct ($quiz, $context, $qmsubselect, quiz_overview_options $options, core\dml\sql_join $groupstudentsjoins, core\dml\sql_join $studentsjoins, $questions, $reporturl)
	Constructor. More...

	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.

	base_sql (\core\dml\sql_join $allowedstudentsjoins)
	Contruct all the parts of the main database query. More...

	build_table ()
	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. More...

	checkbox_col_header (string $columnname)
	Generates the contents for the checkbox column header. More...

	close_recordset ()
	Closes recordset (for use after building the table).

	col_checkbox ($attempt)
	Generate the display of the checkbox column. More...

	col_duration ($attempt)
	Generate the display of the time taken column. More...

	col_feedbacktext ($attempt)
	Generate the display of the feedback column. More...

	col_fullname ($attempt)
	Generate the display of the user's full name column. More...

	col_picture ($attempt)
	Generate the display of the user's picture column. More...

	col_regraded ($attempt)

	col_state ($attempt)
	Generate the display of the attempt state column. More...

	col_sumgrades ($attempt)

	col_timefinish ($attempt)
	Generate the display of the finish time column. More...

	col_timestart ($attempt)
	Generate the display of the start time column. 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...

	compute_average_row ($label, core\dml\sql_join $usersjoins)
	Calculate the average overall and question scores for a set of attempts at the quiz. 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_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_class ($attempt)
	Get any extra classes names to add to this row in the HTML. More...

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

	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_review_link ($data, $attempt, $slot)
	Make a link to review an individual question in a popup window. More...

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

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

	other_cols ($colname, $attempt)

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

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

	query_db ($pagesize, $useinitialsbar=true)
	Query the db. More...

	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_count_sql ($sql, array $params=NULL)
	This is only needed if you want to use different sql to count rows. More...

	set_sql ($fields, $from, $where, array $params=array())
	Set the sql to query the db. More...

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

	setup_sql_queries ($allowedjoins)
	Set up the SQL queries (count rows, and get data). 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...

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

	wrap_html_finish ()
	Hook that can be overridden in child classes to wrap a table in a form for example. More...

	wrap_html_start ()
	Hook that can be overridden in child classes to wrap a table in a form for example. 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()

	$countparams = NULL

	$countsql = NULL

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

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

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_average_row ($label, core\dml\sql_join $usersjoins)
	Add an average grade row for a set of users. More...

	add_latest_state_join ($slot)
	Add the information about the latest state of the question with slot $slot to the query. More...

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

	format_average ($record, $question=false)
	Format an entry in an average row. More...

	format_average_grade_for_questions ($gradeaverages)
	Helper userd by add_average_row(). More...

	get_qubaids_condition ()
	Get an appropriate qubaid_condition for loading more data about the attempts we are displaying. More...

	get_regraded_questions ()
	Get all the questions in all the attempts being displayed that need regrading. More...

	get_required_latest_state_fields ($slot, $alias)
	Get any fields that might be needed when sorting on date for a particular slot. More...

	icon_for_fraction ($fraction)
	Return an appropriate icon (green tick, red cross, etc.) for a grade. More...

	is_flagged ($questionusageid, $slot)

	is_latest_step_column ($column)
	Is this a column that depends on joining to the latest state information? If so, return the corresponding slot. More...

	load_extra_data ()
	Load any extra data after main query. More...

	load_question_latest_steps (qubaid_condition $qubaids=null)
	Load information about the latest state of selected questions in selected attempts. 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...

	requires_extra_data ()
	Does this report require loading any more data after the main query. More...

	requires_latest_steps_loaded ()
	Does this report require the detailed information for each question from the question_attempts_steps table? More...

	show_hide_link ($column, $index)
	Generate the HTML for the collapse/uncollapse icon. More...

	slot_fraction ($attempt, $slot)

	slot_state ($attempt, $slot)

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

	submit_buttons ()
	Output any submit buttons required by the $this->includecheckboxes form.

	update_sql_after_count ($fields, $from, $where, $params)
	A chance for subclasses to modify the SQL after the count query has been generated, and before the full query is constructed. More...

Protected Attributes
context	$context
	the quiz context.

array	$displayoptions
	the display options.

$filename	$filename

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.

bool	$includecheckboxes
	whether to include the column with checkboxes to select each attempt.

array	$lateststeps = null
	information about the latest step of each question. More...

object	$options
	mod_quiz_attempts_report_options the options affecting this report.

string	$qmsubselect
	HTML fragment to select the first/best/last attempt, if appropriate.

object	$questions
	the questions that comprise this quiz. More...

object	$quiz
	the quiz settings for the quiz we are reporting on.

	$regradedqs = array()

moodle_url	$reporturl
	the URL of this report.

$sheettitle	$sheettitle

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.

Detailed Description

This is a table subclass for displaying the quiz grades report.

Copyright: 2008 Jamie Pratt

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

Constructor & Destructor Documentation

◆ __construct()

quiz_overview_table::__construct	(		$quiz,
			$context,
			$qmsubselect,
		quiz_overview_options	$options,
		core\dml\sql_join	$groupstudentsjoins,
		core\dml\sql_join	$studentsjoins,
			$questions,
			$reporturl
	)

Constructor.

Parameters

object	$quiz
context	$context
string	$qmsubselect
quiz_overview_options	$options
core\dml\sql_join	$groupstudentsjoins
core\dml\sql_join	$studentsjoins
array	$questions
moodle_url	$reporturl

Member Function Documentation

◆ add_average_row()

quiz_overview_table::add_average_row	(		$label,
		core\dml\sql_join	$usersjoins
	)

protected

Add an average grade row for a set of users.

Parameters

string	$label	the title ot use for this row.
core\dml\sql_join	$usersjoins	(joins, wheres, params) for the users to average over.

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

◆ add_latest_state_join()

quiz_attempts_report_table::add_latest_state_join ( $slot )

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.

Parameters

int $slot the question to add information for.

◆ base_sql()

quiz_attempts_report_table::base_sql ( \core\dml\sql_join $allowedstudentsjoins )

inherited

Contruct all the parts of the main database query.

Parameters

core\dml\sql_join $allowedstudentsjoins (joins, wheres, params) defines allowed users for the report.

Return values

array with 4 elements ($fields, $from, $where, $params) that can be used to build the actual database query.

◆ build_table()

quiz_overview_table::build_table ( )

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.

◆ 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

◆ checkbox_col_header()

quiz_attempts_report_table::checkbox_col_header ( string $columnname )

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.

Parameters

string $columnname The name of the checkbox column.

Return values

string

◆ col_checkbox()

quiz_attempts_report_table::col_checkbox ( $attempt )

inherited

Generate the display of the checkbox column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

Reimplemented in quiz_first_or_all_responses_table.

◆ col_duration()

quiz_attempts_report_table::col_duration ( $attempt )

inherited

Generate the display of the time taken column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

◆ col_feedbacktext()

quiz_attempts_report_table::col_feedbacktext ( $attempt )

inherited

Generate the display of the feedback column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

◆ col_fullname()

quiz_attempts_report_table::col_fullname ( $attempt )

inherited

Generate the display of the user's full name column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

Reimplemented from flexible_table.

◆ col_picture()

quiz_attempts_report_table::col_picture ( $attempt )

inherited

Generate the display of the user's picture column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

◆ col_state()

quiz_attempts_report_table::col_state ( $attempt )

inherited

Generate the display of the attempt state column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

Reimplemented in quiz_first_or_all_responses_table.

◆ col_timefinish()

quiz_attempts_report_table::col_timefinish ( $attempt )

inherited

Generate the display of the finish time column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

◆ col_timestart()

quiz_attempts_report_table::col_timestart ( $attempt )

inherited

Generate the display of the start time column.

Parameters

object $attempt the table row being output.

Return values

string HTML content to go inside the td.

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

◆ compute_average_row()

quiz_overview_table::compute_average_row	(		$label,
		core\dml\sql_join	$usersjoins
	)

Calculate the average overall and question scores for a set of attempts at the quiz.

Parameters

string	$label	the title ot use for this row.
core\dml\sql_join	$usersjoins	to indicate a set of users.

Return values

array of table cells that make up the average row.

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

quiz_overview_table::format_average	(	$record,
		$question = `false`
	)

protected

Format an entry in an average row.

Parameters

object	$record	with fields grade and numaveraged.
bool	$question	true if this is a question score, false if it is an overall score.

Return values

string HTML fragment for an average score (with number of things included in the average).

◆ format_average_grade_for_questions()

quiz_overview_table::format_average_grade_for_questions ( $gradeaverages )

protected

Helper userd by add_average_row().

Parameters

array $gradeaverages the raw grades.

Return values

array the (partial) row of data.

◆ 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 assign_grading_table, and tool_policy\acceptances_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_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_qubaids_condition()

quiz_attempts_report_table::get_qubaids_condition ( )

protectedinherited

Get an appropriate qubaid_condition for loading more data about the attempts we are displaying.

Return values

qubaid_condition

◆ get_regraded_questions()

quiz_overview_table::get_regraded_questions ( )

protected

Get all the questions in all the attempts being displayed that need regrading.

Return values

array A two dimensional array $questionusageid => $slot => $regradeinfo.

◆ get_required_latest_state_fields()

quiz_overview_table::get_required_latest_state_fields	(	$slot,
		$alias
	)

protected

Get any fields that might be needed when sorting on date for a particular slot.

Note: these values are only used for sorting. The values displayed are taken from $this->lateststeps loaded in load_extra_data().

Parameters

int	$slot	the slot for the column we want.
string	$alias	the table alias for latest state information relating to that slot.

Return values

string definitions of extra fields to add to the SELECT list of the query.

Reimplemented from quiz_attempts_report_table.

◆ get_row_class()

quiz_attempts_report_table::get_row_class ( $row )

inherited

Get any extra classes names to add to this row in the HTML.

Parameters

$row	array the data for this row.

Return values

string added to the class="" attribute of the tr.

Reimplemented from table_sql.

Reimplemented in quiz_first_or_all_responses_table.

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

quiz_attempts_report_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 from flexible_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_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.

◆ get_sql_where()

flexible_table::get_sql_where ( )

inherited

Return values

string sql to add to where statement.

Reimplemented in core_tag_manage_table, and tool_policy\acceptances_table.

◆ icon_for_fraction()

quiz_attempts_report_table::icon_for_fraction ( $fraction )

protectedinherited

Return an appropriate icon (green tick, red cross, etc.) for a grade.

Parameters

float $fraction grade on a scale 0..1.

Return values

string html fragment.

◆ initialbars()

flexible_table::initialbars ( $bool )

inherited

Sets the use_initials variable to the given boolean.

Parameters

bool $bool

Return values

void

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

quiz_attempts_report_table::is_flagged	(	$questionusageid,
		$slot
	)

protectedinherited

Parameters

int	$questionusageid
int	$slot

Return values

bool

Reimplemented in quiz_first_or_all_responses_table.

◆ is_latest_step_column()

quiz_overview_table::is_latest_step_column ( $column )

protected

Is this a column that depends on joining to the latest state information? If so, return the corresponding slot.

If not, return false.

Parameters

string $column a column name

Return values

int	false if no, else a slot.

Reimplemented from quiz_attempts_report_table.

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

flexible_table::is_sortable ( $column = null )

inherited

Is the column sortable?

Parameters

string column name, null means table

Return values

bool

◆ load_extra_data()

quiz_attempts_report_table::load_extra_data ( )

protectedinherited

Load any extra data after main query.

At this point you can call get_qubaids_condition to get the condition that limits the query to just the question usages shown in this report page or alternatively for all attempts if downloading a full report.

Reimplemented in quiz_first_or_all_responses_table.

◆ load_question_latest_steps()

quiz_attempts_report_table::load_question_latest_steps ( qubaid_condition $qubaids = null )

protectedinherited

Load information about the latest state of selected questions in selected attempts.

The results are returned as an two dimensional array $qubaid => $slot => $dataobject

Parameters

qubaid_condition | null $qubaids used to restrict which usages are included in the query. See qubaid_condition.

Return values

array of records. See the SQL in this function to see the fields available.

◆ make_review_link()

quiz_attempts_report_table::make_review_link	(	$data,
		$attempt,
		$slot
	)

inherited

Make a link to review an individual question in a popup window.

Parameters

string	$data	HTML fragment. The text to make into the link.
object	$attempt	data for the row of the table being output.
int	$slot	the number used to identify this question within this usage.

Reimplemented in quiz_first_or_all_responses_table.

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

quiz_overview_table::other_cols	(	$colname,
		$attempt
	)

Parameters

string	$colname	the name of the column.
object	$attempt	the row of data - see the SQL in display() in mod/quiz/report/overview/report.php to see what fields are present, and what they are called.

Return values

string the contents of the cell.

Reimplemented from flexible_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_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

◆ query_db()

quiz_overview_table::query_db	(	$pagesize,
		$useinitialsbar = `true`
	)

Query the db.

Store results in the table object for use by build_table.

Parameters

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

◆ 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

◆ requires_extra_data()

quiz_attempts_report_table::requires_extra_data ( )

protectedinherited

Does this report require loading any more data after the main query.

After the main query then you can use $this->get

Return values

bool	should } call load_extra_data?

Reimplemented in quiz_last_responses_table.

◆ requires_latest_steps_loaded()

quiz_overview_table::requires_latest_steps_loaded ( )

protected

Does this report require the detailed information for each question from the question_attempts_steps table?

Return values

bool	should } call load_question_latest_steps?

Reimplemented from quiz_attempts_report_table.

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

table_sql::set_count_sql	(		$sql,
		array	$params = `NULL`
	)

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.

◆ set_sql()

table_sql::set_sql	(		$fields,
			$from,
			$where,
		array	$params = `array()`
	)

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.

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

◆ setup_sql_queries()

quiz_attempts_report_table::setup_sql_queries ( $allowedjoins )

inherited

Set up the SQL queries (count rows, and get data).

Parameters

core\dml\sql_join $allowedjoins (joins, wheres, params) defines allowed users for the report.

◆ 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 core_user\participants_table, assign_grading_table, tool_dataprivacy\output\expired_contexts_table, and tool_dataprivacy\output\data_requests_table.

◆ slot_fraction()

quiz_attempts_report_table::slot_fraction	(	$attempt,
		$slot
	)

protectedinherited

Parameters

object	$attempt	the row data
int	$slot

Return values

float

Reimplemented in quiz_first_or_all_responses_table.

◆ slot_state()

quiz_attempts_report_table::slot_state	(	$attempt,
		$slot
	)

protectedinherited

Parameters

object	$attempt	the row data
int	$slot

Return values

question_state

Reimplemented in quiz_first_or_all_responses_table.

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

◆ 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

◆ update_sql_after_count()

quiz_overview_table::update_sql_after_count	(	$fields,
		$from,
		$where,
		$params
	)

protected

A chance for subclasses to modify the SQL after the count query has been generated, and before the full query is constructed.

Parameters

string	$fields	SELECT list.
string	$from	JOINs part of the SQL.
string	$where	WHERE clauses.
array	$params	Query params.

Return values

array with 4 elements ($fields, $from, $where, $params) as from base_sql.

Reimplemented from quiz_attempts_report_table.

◆ wrap_html_finish()

quiz_attempts_report_table::wrap_html_finish ( )

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.

◆ wrap_html_start()

quiz_attempts_report_table::wrap_html_start ( )

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.

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

◆ $lateststeps

array quiz_attempts_report_table::$lateststeps = null

protectedinherited

information about the latest step of each question.

Loaded by load_question_latest_steps(), if applicable.

◆ $questions

object quiz_attempts_report_table::$questions

protectedinherited

the questions that comprise this quiz.

◆ $sql

object table_sql::$sql = NULL

inherited

sql for querying db.

Has fields 'fields', 'from', 'where', 'params'.

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

mod/quiz/report/overview/overview_table.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_average_row()

◆ add_data()

◆ add_data_keyed()

◆ add_latest_state_join()

◆ base_sql()

◆ build_table()

◆ can_be_reset()

◆ checkbox_col_header()

◆ col_checkbox()

◆ col_duration()

◆ col_feedbacktext()

◆ col_fullname()

◆ col_picture()

◆ col_state()

◆ col_timefinish()

◆ col_timestart()

◆ collapsible()

◆ column_class()

◆ column_style()

◆ column_style_all()

◆ column_suppress()

◆ compute_average_row()

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

◆ format_average_grade_for_questions()

◆ format_row()

◆ format_text()

◆ get_initial_first()

◆ get_initial_last()

◆ get_page_size()

◆ get_page_start()

◆ get_qubaids_condition()

◆ get_regraded_questions()

◆ get_required_latest_state_fields()

◆ get_row_class()

◆ get_row_html()

◆ get_sort_columns()

◆ get_sort_for_table()

◆ get_sql_sort()

◆ get_sql_where()

◆ icon_for_fraction()

◆ initialbars()

◆ is_downloadable()

◆ is_downloading()

◆ is_flagged()

◆ is_latest_step_column()

◆ is_persistent()

◆ is_sortable()

◆ load_extra_data()

◆ load_question_latest_steps()

◆ make_review_link()

◆ make_styles_string()

◆ no_sorting()

◆ other_cols()

◆ pageable()

◆ pagesize()

◆ print_html()

◆ print_one_initials_bar()

◆ query_db()

◆ render_reset_button()

◆ requires_extra_data()

◆ requires_latest_steps_loaded()

◆ set_attribute()