 |
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
|
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Public Member Functions | |
| __construct ($uniqueid) | |
| Constructor. | |
| add_data ($row, $classname='') | |
| This method actually directly echoes the row passed to it now or adds it to the download. | |
| add_data_keyed ($rowwithkeys, $classname='') | |
| Add a row of data to the table. | |
| add_separator () | |
| Add a seperator line to table. | |
| 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. | |
| collapsible ($bool) | |
| Sets the is_collapsible variable to the given boolean. | |
| column_class ($column, $classname) | |
| Sets the given $column index to the given $classname in $this->column_class. | |
| column_style ($column, $property, $value) | |
| Sets the given $column index and $property index to the given $value in $this->column_style. | |
| column_style_all ($property, $value) | |
| Sets all columns' $propertys to the given $value in $this->column_style. | |
| column_suppress ($column) | |
| What this method does is set the column so that if the same data appears in consecutive rows, then it is not repeated. | |
| define_baseurl ($url) | |
| Sets $this->baseurl. | |
| define_columns ($columns) | |
| define_header_column (string $column) | |
| Mark a specific column as being a table header using the column name defined in define_columns. | |
| define_headers ($headers) | |
| define_help_for_headers ($helpicons) | |
| Defines a help icon for the header. | |
| download_buttons () | |
| Get the html for the download buttons. | |
| export_class_instance ($exportclass=null) | |
| Get, and optionally set, the export class. | |
| finish_html () | |
| This function is not part of the public api. | |
| finish_output ($closeexportclassdoc=true) | |
| You should call this to finish outputting the table data after adding data to the table with add_data or add_data_keyed. | |
| format_and_add_array_of_rows ($rowstoadd, $finish=true) | |
| Add a number of rows to the table at once. | |
| format_row ($row) | |
| Call appropriate methods on this table class to perform any processing on values before displaying in table. | |
| format_text ($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) | |
| Used from col_* functions when text is to be displayed. | |
| get_context () | |
| Get the context for the table. | |
| get_default_per_page () | |
| Get the default per page. | |
| get_filterset () | |
| Get the currently defined filterset. | |
| get_initial_first () | |
| This function is not part of the public api. | |
| get_initial_last () | |
| This function is not part of the public api. | |
| get_page_size () | |
| get_page_start () | |
| get_row_cells_html (string $rowid, array $row, ?array $suppresslastrow) | |
| Generate html code for the row cells. | |
| get_row_from_keyed ($rowwithkeys) | |
| This function is not part of the public api. | |
| get_row_html ($row, $classname='') | |
| Generate html code for the passed row. | |
| get_sort_columns () | |
| Get the columns to sort by, in the form required by construct_order_by(). | |
| get_sql_sort () | |
| get_sql_where () | |
| guess_base_url () | |
| Attempt to guess the base URL. | |
| initialbars ($bool) | |
| Sets the use_initials variable to the given boolean. | |
| is_downloadable ($downloadable=null) | |
| Probably don't need to call this directly. | |
| is_downloading ($download=null, $filename='', $sheettitle='') | |
| Call this to pass the download type. | |
| is_persistent ($persistent=null) | |
| Call with boolean true to store table layout changes in the user_preferences table. | |
| is_sortable ($column=null) | |
| Is the column sortable? | |
| make_styles_string ($styles) | |
| This function is not part of the public api. | |
| mark_table_to_reset () | |
| Mark the table preferences to be reset. | |
| no_sorting ($column) | |
| Do not sort using this column. | |
| other_cols ($column, $row) | |
| You can override this method in a child class. | |
| pageable ($bool) | |
| Sets the use_pages variable to the given boolean. | |
| pagesize ($perpage, $total) | |
| Sets the pagesize variable to the given integer, the totalrows variable to the given integer, and the use_pages variable to true. | |
| print_headers () | |
| This function is not part of the public api. | |
| print_html () | |
| This method is deprecated although the old api is still supported. | |
| print_initials_bar () | |
| This function is not part of the public api. | |
| print_nothing_to_display () | |
| This function is not part of the public api. | |
| print_row ($row, $classname='') | |
| This function is not part of the public api. | |
| render_caption () | |
| This function renders a table caption. | |
| set_attribute ($attribute, $value) | |
| Gives the given $value to the $attribute index of $this->attributes. | |
| set_caption (string $caption, ?array $captionattributes) | |
| This function set caption for table. | |
| set_columnsattributes (array $attributes) | |
| Sets the given $attributes to $this->columnsattributes. | |
| set_control_variables ($variables) | |
| Assigns each given variable in the array to the corresponding index in the request class variable. | |
| set_default_per_page (int $defaultperpage) | |
| Set the default per page. | |
| set_filterset (filterset $filterset) | |
| Set the filterset in the table class. | |
| set_first_initial (string $initial) | |
| Set the preferred first name initial in an initials bar. | |
| set_hidden_columns (array $columns) | |
| Set the list of hidden columns. | |
| set_last_initial (string $initial) | |
| Set the preferred last name initial in an initials bar. | |
| set_page_number (int $pagenumber) | |
| Set the page number. | |
| set_sortdata (array $sortdata) | |
| Set the preferred table sorting attributes. | |
| setup () | |
| Must be called after table is defined. | |
| show_download_buttons_at ($showat) | |
| Where to show download buttons. | |
| sortable ($bool, $defaultcolumn=NULL, $defaultorder=SORT_ASC) | |
| Sets the is_sortable variable to the given boolean, sort_default_column to the given string, and the sort_default_order to the given integer. | |
| start_html () | |
| This function is not part of the public api. | |
| start_output () | |
| This function is not part of the public api. | |
| text_sorting ($column) | |
| Use text sorting functions for this column (required for text columns with Oracle). | |
| wrap_html_finish () | |
| Hook that can be overridden in child classes to wrap a table in a form for example. | |
| wrap_html_start () | |
| Hook that can be overridden in child classes to wrap a table in a form for example. | |
Static Public Member Functions | |
| static | construct_order_by ($cols, $textsortcols=array()) |
| Prepare an an order by clause from the list of columns to be sorted. | |
| static | get_filterset_class () |
| Get the class used as a filterset. | |
| static | get_sort_for_table ($uniqueid) |
| Get the order by clause from the session or user preferences, for the table with id $uniqueid. | |
Public Attributes | |
| $attributes = array() | |
| $baseurl = NULL | |
| string | $caption |
| $caption The caption of table | |
| array | $captionattributes |
| $captionattributes The caption attributes of table | |
| $column_class = array() | |
| $column_nosort = array('userpic') | |
| $column_style = array() | |
| $column_suppress = array() | |
| $columns = array() | |
| $currentrow = 0 | |
| $currpage = 0 | |
| string | $download = '' |
| which download plugin to use. | |
| bool | $downloadable = false |
| whether data is downloadable from table. | |
| table_dataformat_export_format | $exportclass = null |
| $headers = array() | |
| $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? | |
| get_component () | |
| Get dynamic class component. | |
| get_dynamic_table_html_end () | |
| Get the dynamic table end wrapper. | |
| get_dynamic_table_html_start () | |
| Get the dynamic table start wrapper. | |
| get_handler () | |
| Get dynamic class handler. | |
| get_primary_sort_order () | |
| Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table. | |
| get_sort_order () | |
| Return sorting attributes values. | |
| initialise_table_preferences () | |
| Initialise table preferences. | |
| is_resetting_preferences () | |
| Is the table marked for reset preferences? | |
| print_one_initials_bar ($alpha, $current, $class, $title, $urlvar) | |
| Helper function, used by print_initials_bar() to output one initial bar. | |
| render_reset_button () | |
| Generate the HTML for the table preferences reset button. | |
| save_preferences ($oldprefs) | |
| Save preferences. | |
| set_hide_show_preferences () | |
| Set hide and show preferences. | |
| set_initials_preferences () | |
| Fill in the preferences for the initials bar. | |
| set_sorting_preferences () | |
| Calculate the preferences for sort order based on user-supplied values and get params. | |
| show_hide_link ($column, $index) | |
| Generate the HTML for the collapse/uncollapse icon. | |
| sort_icon ($isprimary, $order) | |
| Generate the HTML for the sort icon. | |
| sort_link ($text, $column, $isprimary, $order) | |
| Generate the HTML for the sort link. | |
| sort_order_name ($isprimary, $order) | |
| Generate the correct tool tip for changing the sort order. | |
Protected Attributes | |
| string | $filename |
| $filename | |
| filterset | $filterset = null |
| The currently applied filerset This is required for dynamic tables, but can be used by other tables too if desired. | |
| string | $headercolumn = null |
| A column which should be considered as a header column. | |
| array | $hiddencolumns |
| $hiddencolumns List of hidden columns. | |
| string | $ifirst |
| The manually set first name initial preference. | |
| string | $ilast |
| The manually set last name initial preference. | |
| bool | $resetting |
| $resetting Whether the table preferences is resetting. | |
| string | $sheettitle |
| $sheettitle | |
| array | $sortdata |
| The fields to sort. | |
| string[] | $userfullnamecolumns = ['fullname'] |
| Columns that are expected to contain a users fullname. | |
| flexible_table::__construct | ( | $uniqueid | ) |
Constructor.
| 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 core_tag_manage_table, enrol_lti\local\ltiadvantage\table\published_resources_table, enrol_lti\manage_table, quiz_statistics_question_table, quizaccess_seb\local\table\template_list, table_sql, tool_dataprivacy\output\expired_contexts_table, and tool_usertours\local\table\step_list.
| 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.
| array | $row | a numerically keyed row of data to add to the table. |
| string | $classname | CSS class name to add to this row's tr tag. |
| bool | success. |
| 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).
| 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. |
|
protected |
Are there some table preferences that can be reset?
If true, then the "reset table preferences" widget should be displayed.
| bool |
| 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.
| 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. |
| string | contents of cell in column 'fullname', for this row. |
Reimplemented in assign_grading_table, core_tag_manage_table, core_user\table\participants, core_webservice\token_table, forumreport_summary\summary_table, mod_h5pactivity\local\report\participants, mod_quiz\local\reports\attempts_report_table, and tool_policy\acceptances_table.
| flexible_table::collapsible | ( | $bool | ) |
Sets the is_collapsible variable to the given boolean.
| bool | $bool |
| void |
| flexible_table::column_class | ( | $column, | |
| $classname ) |
Sets the given $column index to the given $classname in $this->column_class.
| int | $column | |
| string | $classname |
| void |
| flexible_table::column_style | ( | $column, | |
| $property, | |||
| $value ) |
Sets the given $column index and $property index to the given $value in $this->column_style.
| int | $column | |
| string | $property | |
| mixed | $value |
| void |
| flexible_table::column_style_all | ( | $property, | |
| $value ) |
Sets all columns' $propertys to the given $value in $this->column_style.
| int | $property | |
| string | $value |
| void |
| 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.
| int | $column | the index of a column. |
|
static |
Prepare an an order by clause from the list of columns to be sorted.
| array | $cols | column name => SORT_ASC or SORT_DESC |
| string | SQL fragment that can be used in an ORDER BY clause. |
| flexible_table::define_baseurl | ( | $url | ) |
Sets $this->baseurl.
| moodle_url | string | $url | the url with params needed to call up this page |
| flexible_table::define_columns | ( | $columns | ) |
| 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.
| 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.
| string | $column |
| flexible_table::define_headers | ( | $headers | ) |
| array | $headers | numerical keyed array of displayed string titles for each column. |
| 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.
| renderable[] | $helpicons | An array of renderable objects to be used as help icons |
| flexible_table::download_buttons | ( | ) |
Get the html for the download buttons.
Usually only use internally
Reimplemented in core_reportbuilder\table\custom_report_table, core_reportbuilder\table\custom_report_table_view, core_reportbuilder\table\system_report_table, and mod_feedback_responses_table.
| flexible_table::export_class_instance | ( | $exportclass = null | ) |
Get, and optionally set, the export class.
| table_dataformat_export_format | $exportclass | (optional) if passed, set the table to use this export class. |
| table_dataformat_export_format | the export class in use (after any set). |
| 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.
| (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 |
| 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'.
| array | object | $row | row of data from db used to make one row of the table. |
| array | one row for the table, added using add_data_keyed method. |
Reimplemented in assign_grading_table, core_reportbuilder\table\custom_report_table, core_reportbuilder\table\system_report_table, and tool_policy\acceptances_table.
| 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.
|
protected |
Get dynamic class component.
| string |
| flexible_table::get_context | ( | ) |
Get the context for the table.
Note: This function must be overridden by dynamic tables to ensure that the context is correctly determined from the filterset parameters.
| context |
Reimplemented in core_admin\table\plugin_management_table, core_reportbuilder\table\base_report_table, core_user\table\participants, and mod_feedback_responses_table.
| flexible_table::get_default_per_page | ( | ) |
Get the default per page.
| int |
Reimplemented in core_reportbuilder\table\custom_report_table_view.
|
protected |
Get the dynamic table end wrapper.
If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
| string |
Reimplemented in core_admin\table\plugin_management_table.
|
protected |
Get the dynamic table start wrapper.
If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
| string |
| flexible_table::get_filterset | ( | ) |
Get the currently defined filterset.
| filterset |
|
static |
Get the class used as a filterset.
| string |
Reimplemented in core_admin\table\plugin_management_table.
|
protected |
Get dynamic class handler.
| string |
| flexible_table::get_initial_first | ( | ) |
This function is not part of the public api.
| string | initial of first name we are currently filtering by |
| flexible_table::get_initial_last | ( | ) |
This function is not part of the public api.
| string | initial of last name we are currently filtering by |
| flexible_table::get_page_size | ( | ) |
| int | the pagesize for LIMIT clause of SQL |
| flexible_table::get_page_start | ( | ) |
| int | the offset for LIMIT clause of SQL |
|
protected |
Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table.
| array |
| flexible_table::get_row_cells_html | ( | string | $rowid, |
| array | $row, | ||
| ?array | $suppresslastrow ) |
Generate html code for the row cells.
| string | $rowid | |
| array | $row | |
| array | null | $suppresslastrow |
| string |
Reimplemented in core_reportbuilder\table\custom_report_table.
| flexible_table::get_row_html | ( | $row, | |
| $classname = '' ) |
Generate html code for the passed row.
| array | $row | Row data. |
| string | $classname | classes to add. |
| string\$html | html code for the row passed. |
| flexible_table::get_sort_columns | ( | ) |
Get the columns to sort by, in the form required by construct_order_by().
| array | column name => SORT_... constant. |
Reimplemented in assign_grading_table, core_reportbuilder\table\custom_report_table, mod_quiz\local\reports\attempts_report_table, and tool_policy\acceptances_table.
|
static |
Get the order by clause from the session or user preferences, for the table with id $uniqueid.
| string | $uniqueid | the identifier for a table. |
| string | SQL fragment that can be used in an ORDER BY clause. |
|
protected |
Return sorting attributes values.
| array |
| flexible_table::get_sql_sort | ( | ) |
| string | SQL fragment that can be used in an ORDER BY clause. |
Reimplemented in core_reportbuilder\table\base_report_table, and gradereport_history\output\tablelog.
| flexible_table::get_sql_where | ( | ) |
| string | sql to add to where statement. |
Reimplemented in core_tag_manage_table, and tool_policy\acceptances_table.
| flexible_table::guess_base_url | ( | ) |
Attempt to guess the base URL.
Reimplemented in core_admin\table\activity_management_table, core_admin\table\block_management_table, core_admin\table\editor_management_table, core_admin\table\plugin_management_table, core_reportbuilder\table\base_report_table, core_user\table\participants, and editor_tiny\table\plugin_management_table.
| flexible_table::initialbars | ( | $bool | ) |
Sets the use_initials variable to the given boolean.
| bool | $bool |
| void |
| 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.
| bool | $downloadable | optional param to set whether data from table is downloadable. If ommitted this function can be used to get current state of table. |
| bool | whether table data is set to be downloadable. |
Reimplemented in core_admin\table\plugin_management_table.
| 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.
| string | null | $download | type of dataformat for export. |
| string | $filename | filename for downloads without file extension. |
| string | $sheettitle | title for downloaded data. |
| string | download dataformat type. |
| 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.
| bool | $persistent | Optional parameter to set table layout persistence. |
| bool | Whether or not the table layout preferences will persist. |
|
protected |
Is the table marked for reset preferences?
| bool | True if the table is marked to reset, false otherwise. |
| flexible_table::is_sortable | ( | $column = null | ) |
Is the column sortable?
| string | column name, null means table |
| bool |
| flexible_table::make_styles_string | ( | $styles | ) |
This function is not part of the public api.
| array | $styles | CSS-property => value |
| string | values suitably to go in a style="" attribute in HTML. |
| flexible_table::no_sorting | ( | $column | ) |
Do not sort using this column.
| string | column name |
| 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 assign_grading_table, core_user\table\participants, core_webservice\token_table, mod_feedback_responses_table, quiz_last_responses_table, quiz_overview_table, quiz_statistics_question_table, and tool_policy\acceptances_table.
| flexible_table::pageable | ( | $bool | ) |
Sets the use_pages variable to the given boolean.
| bool | $bool |
| void |
| 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.
| int | $perpage | |
| int | $total |
| void |
| flexible_table::print_headers | ( | ) |
This function is not part of the public api.
Reimplemented in core_reportbuilder\table\custom_report_table, and core_reportbuilder\table\custom_report_table_view.
| flexible_table::print_html | ( | ) |
This method is deprecated although the old api is still supported.
| flexible_table::print_nothing_to_display | ( | ) |
This function is not part of the public api.
Reimplemented in core_reportbuilder\table\base_report_table, core_reportbuilder\table\custom_report_table, forumreport_summary\summary_table, mod_h5pactivity\local\report\participants, tool_cohortroles\output\cohort_role_assignments_table, tool_dataprivacy\output\data_requests_table, tool_dataprivacy\output\expired_contexts_table, tool_lp\output\template_cohorts_table, and tool_lp\output\template_plans_table.
|
protected |
Helper function, used by print_initials_bar() to output one initial bar.
| array | $alpha | of letters in the alphabet. |
| string | $current | the currently selected letter. |
| string | $class | class name to add to this initial bar. |
| string | $title | the name to put in front of this initial bar. |
| string | $urlvar | URL parameter name for this initial. |
| flexible_table::render_caption | ( | ) |
This function renders a table caption.
| string\$output | Caption of table. |
|
protected |
Generate the HTML for the table preferences reset button.
| string | HTML fragment, empty string if no need to reset |
|
protected |
Save preferences.
| array | $oldprefs | Old preferences to compare against. |
| flexible_table::set_attribute | ( | $attribute, | |
| $value ) |
Gives the given $value to the $attribute index of $this->attributes.
| string | $attribute | |
| mixed | $value |
| void |
| flexible_table::set_caption | ( | string | $caption, |
| ?array | $captionattributes ) |
| flexible_table::set_columnsattributes | ( | array | $attributes | ) |
Sets the given $attributes to $this->columnsattributes.
Column attributes will be added to every cell in the column.
| array[] | $attributes | e.g. ['c0_firstname' => ['data-foo' => 'bar']] |
| flexible_table::set_control_variables | ( | $variables | ) |
Assigns each given variable in the array to the corresponding index in the request class variable.
| array | $variables |
| void |
| flexible_table::set_default_per_page | ( | int | $defaultperpage | ) |
Set the default per page.
| int | $defaultperpage |
| flexible_table::set_filterset | ( | filterset | $filterset | ) |
Set the filterset in the table class.
The use of filtersets is a requirement for dynamic tables, but can be used by other tables too if desired.
| filterset | $filterset | The filterset object to get filters and table parameters from |
Reimplemented in core_reportbuilder\table\system_report_table, and core_user\table\participants.
| flexible_table::set_first_initial | ( | string | $initial | ) |
Set the preferred first name initial in an initials bar.
| string | $initial | The character to set |
| flexible_table::set_hidden_columns | ( | array | $columns | ) |
Set the list of hidden columns.
| array | $columns | The list of hidden columns. |
| flexible_table::set_last_initial | ( | string | $initial | ) |
Set the preferred last name initial in an initials bar.
| string | $initial | The character to set |
| flexible_table::set_page_number | ( | int | $pagenumber | ) |
Set the page number.
| int | $pagenumber | The page number. |
| flexible_table::set_sortdata | ( | array | $sortdata | ) |
Set the preferred table sorting attributes.
| string | $sortby | The field to sort by. |
| int | $sortorder | The sort order. |
| flexible_table::setup | ( | ) |
Must be called after table is defined.
Use methods above first. Cannot use functions below till after calling this method.
Reimplemented in assign_grading_table, and core_admin\table\activity_management_table.
| flexible_table::show_download_buttons_at | ( | $showat | ) |
Where to show download buttons.
| array | $showat | array of postions in which to show download buttons. Containing TABLE_P_TOP and/or TABLE_P_BOTTOM |
|
protected |
Generate the HTML for the collapse/uncollapse icon.
This is a helper method used by print_headers().
| string | $column | the column name, index into various names. |
| int | $index | numerical index of the column. |
| string | HTML fragment. |
Reimplemented in assign_grading_table, core_tag_manage_table, core_user\table\participants, tool_dataprivacy\output\data_requests_table, and tool_dataprivacy\output\expired_contexts_table.
|
protected |
Generate the HTML for the sort icon.
This is a helper method used by sort_link().
| bool | $isprimary | whether an icon is needed (it is only needed for the primary sort column.) |
| int | $order | SORT_ASC or SORT_DESC |
| string | HTML fragment. |
|
protected |
Generate the HTML for the sort link.
This is a helper method used by print_headers().
| string | $text | the text for the link. |
| string | $column | the column name, may be a fake column like 'firstname' or a real one. |
| bool | $isprimary | whether the is column is the current primary sort column. |
| int | $order | SORT_ASC or SORT_DESC |
| string | HTML fragment. |
|
protected |
Generate the correct tool tip for changing the sort order.
This is a helper method used by sort_link().
| bool | $isprimary | whether the is column is the current primary sort column. |
| int | $order | SORT_ASC or SORT_DESC |
| string | the correct title. |
| 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.
| bool | $bool | |
| string | $defaultcolumn | |
| int | $defaultorder |
| void |
| flexible_table::start_html | ( | ) |
This function is not part of the public api.
Reimplemented in core_reportbuilder\table\base_report_table.
| 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.
| 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.
| string | column name |
| 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 core_reportbuilder\table\custom_report_table, forumreport_summary\summary_table, mod_quiz\local\reports\attempts_report_table, quiz_statistics_table, tool_dataprivacy\output\data_requests_table, and tool_policy\acceptances_table.
| 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 mod_quiz\local\reports\attempts_report_table, quiz_statistics_table, and tool_policy\acceptances_table.
| 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 $
| bool flexible_table::$downloadable = false |
whether data is downloadable from table.
Determines whether to display download buttons. Set by method downloadable().
|
protected |
Columns that are expected to contain a users fullname.
1.11.0