flexible_table Class Reference

#- More...

Inheritance diagram for flexible_table:

Public Member Functions
	__construct ($uniqueid)
	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.
	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_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 ()
	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...
	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.
	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...
	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...
	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()
	$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...
	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...
	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
$filename	$filename
string	$headercolumn = null
	A column which should be considered as a header column.
$sheettitle	$sheettitle

Detailed Description

#-

Copyright

1999 onwards Martin Dougiamas http://moodle.com

License

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

Constructor & Destructor Documentation

__construct()

flexible_table::__construct

(

$uniqueid

)

Constructor.

Parameters

string

$uniqueid

all tables have to have a unique id, this is used as a key when storing table properties like sort order in the session.

Reimplemented in table_sql, tool_usertours\local\table\step_list, core_tag_manage_table, quiz_statistics_question_table, webservice\token_table, enrol_lti\manage_table, and tool_dataprivacy\output\expired_contexts_table.

Member Function Documentation

add_data()

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

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 = ''
	)

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

protected

Are there some table preferences that can be reset?

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

Return values

bool

col_fullname()

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

@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 core_tag_manage_table, assign_grading_table, tool_policy\acceptances_table, webservice\token_table, core_user\participants_table, forumreport_summary\summary_table, and quiz_attempts_report_table.

collapsible()

flexible_table::collapsible

(

$bool

)

Sets the is_collapsible variable to the given boolean.

Parameters

bool

$bool

Return values

void

column_class()

flexible_table::column_class	(		$column,
			$classname
	)

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
	)

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
	)

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

)

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

static

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

)

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

)

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

)

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

)

Parameters

array

$headers

numerical keyed array of displayed string titles for each column.

define_help_for_headers()

flexible_table::define_help_for_headers

(

$helpicons

)

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

(

)

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

)

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
	)

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

flexible_table::format_row

(

$row

)

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
	)

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

(

)

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

(

)

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

(

)

Return values

int	the pagesize for LIMIT clause of SQL

get_page_start()

flexible_table::get_page_start

(

)

Return values

int	the offset for LIMIT clause of SQL

get_row_html()

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

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

(

)

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

Return values

array

column name => SORT_... constant.

Reimplemented in quiz_attempts_report_table, assign_grading_table, and tool_policy\acceptances_table.

get_sort_for_table()

static flexible_table::get_sort_for_table (   $uniqueid )

static

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

(

)

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

(

)

Return values

string

sql to add to where statement.

Reimplemented in core_tag_manage_table, and tool_policy\acceptances_table.

initialbars()

flexible_table::initialbars

(

$bool

)

Sets the use_initials variable to the given boolean.

Parameters

bool

$bool

Return values

void

is_downloadable()

flexible_table::is_downloadable

(

$downloadable = null

)

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 = ''
	)

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

flexible_table::is_persistent

(

$persistent = null

)

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

)

Is the column sortable?

Parameters

string

column name, null means table

Return values

bool

make_styles_string()

flexible_table::make_styles_string

(

$styles

)

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

)

Do not sort using this column.

Parameters

string

column name

other_cols()

flexible_table::other_cols	(		$column,
			$row
	)

You can override this method in a child class.

See the description of build_table which calls this method.

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

pageable()

flexible_table::pageable

(

$bool

)

Sets the use_pages variable to the given boolean.

Parameters

bool

$bool

Return values

void

pagesize()

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

Parameters

int	$perpage
int	$total

Return values

void

print_html()

flexible_table::print_html

(

)

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  )

protected

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

protected

Generate the HTML for the table preferences reset button.

Return values

string

HTML fragment, empty string if no need to reset

set_attribute()

flexible_table::set_attribute	(		$attribute,
			$value
	)

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

)

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

Parameters

array

$variables

Return values

void

setup()

flexible_table::setup

(

)

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

)

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  )

protected

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.

sort_icon()

flexible_table::sort_icon (   $isprimary,   $order  )

protected

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  )

protected

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  )

protected

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
	)

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

(

)

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

)

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

flexible_table::wrap_html_finish

(

)

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 in quiz_statistics_table, quiz_attempts_report_table, forumreport_summary\summary_table, tool_policy\acceptances_table, and tool_dataprivacy\output\data_requests_table.

wrap_html_start()

flexible_table::wrap_html_start

(

)

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 in quiz_statistics_table, quiz_attempts_report_table, and tool_policy\acceptances_table.

Member Data Documentation

$download

string flexible_table::$download = ''

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

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:

• lib/tablelib.php