Docs For Class Display

method display_complex_table_header [line 154]

void display_complex_table_header(
$properties,
$properties, column_header,
$column_header)

Display html header of table with several options.

Tags:

author:	Roan Embrechts
version:	1.01

Parameters:

$properties,	$properties	array with elements, all of which have defaults "width" - the table width, e.g. "100%", default is 85% "class" - the class to use for the table, e.g. "class=\"data_table\"" "cellpadding" - the extra border in each cell, e.g. "8",default is 4 "cellspacing" - the extra space between cells, default = 0
column_header,	$column_header	array with the header elements.

[ Top ]

method display_complex_table_row [line 225]

void display_complex_table_row(
$properties,
$properties, 
$table_row)

Displays a table row.

This function has more options and is easier to extend than display_table_row()

Tags:

todo:

add valign property

Parameters:

$properties,	$properties	array with properties: ["bgcolor"] - the background colour for the table ["is_alternating"] - true: the row colours alternate, false otherwise ["align_row"] - an array with, per cell, left\|center\|right
	$table_row

[ Top ]

method display_confirmation_message [line 423]

void display_confirmation_message(
string
$message, [bool
$filter = true])

Displays an confirmation message. Use this if something has been done successfully

Tags:

author:

Patrick Cool <patrick.cool@UGent.be>, Ghent University

Parameters:

string	$message
bool	$filter	Filter (true) or not (false)

[ Top ]

method display_error_message [line 455]

void display_error_message(
string
$message, [bool
$filter = true])

Displays an error message. It is recommended to use this function if an error occurs

Tags:

author:	Hugues Peeters
author:	Roan Embrechts
author:	Patrick Cool <patrick.cool@UGent.be>, Ghent University

Parameters:

string	$message	- include any additional html tags if you need them
bool	$filter	Filter (true) or not (false)

[ Top ]

method display_footer [line 550]

void display_footer(
)

Display the page footer

[ Top ]

method display_header [line 539]

void display_header(
string
$tool_name, [string
$help = NULL])

Display the page header

Parameters:

string	$tool_name	The name of the page (will be showed in the page title)
string	$help	Optional help file name

[ Top ]

method display_icon [line 636]

void display_icon(
string
$image, [string
$alt_text = ''], [array
$additional_attributes = array ()])

This function displays an icon

Parameters:

string	$image	the filename of the file (in the main/img/ folder
string	$alt_text	the alt text (probably a language variable)
array	$additional_attributes	additional attributes (for instance height, width, onclick, ...)

[ Top ]

method display_introduction_section [line 96]

html display_introduction_section(
string
$tool)

Displays the tool introduction of a tool.

Tags:

return:	code for adding an introduction
author:	Patrick Cool <patrick.cool@UGent.be>, Ghent University

Parameters:

string

$tool

These are the constants that are used for indicating the tools

[ Top ]

method display_localised_html_file [line 116]

void display_localised_html_file(

$full_file_name)

Parameters:

$full_file_name

[ Top ]

method display_normal_message [line 363]

void display_normal_message(
string
$message, [bool
$filter = true])

Displays a normal message. It is recommended to use this function to display any normal information messages.

Tags:

author:

Roan Embrechts

Parameters:

string	$message	- include any additional html tags if you need them
bool	$filter	Filter (true) or not (false)

[ Top ]

method display_sortable_config_table [line 326]

void display_sortable_config_table(
array
$header, array
$content, [array
$sorting_options = array ()], [array
$paging_options = array ()], [array
$query_vars = null], [array
$column_show = array()], [array
$column_order = array()], [array
$form_actions = array()])

Display a table with a special configuration

Tags:

author:

Julio Montoya

Parameters:

array	$header	Titles for the table header each item in this array can contain 3 values 1st element: the column title 2nd element: true or false (column sortable?) 3th element: additional attributes for th-tag (eg for column-width) 4the element: additional attributes for the td-tags
array	$content	2D-array with the tables content
array	$sorting_options	Keys are: 'column' = The column to use as sort-key 'direction' = SORT_ASC or SORT_DESC
array	$paging_options	Keys are: 'per_page_default' = items per page when switching from full- list to per-page-view 'per_page' = number of items to show per page 'page_nr' = The page to display
array	$query_vars	Additional variables to add in the query-string
array	$column_show	Array of binaries 1= show columns 0. hide a column
array	$column_order	An array of integers that let us decide how the columns are going to be sort. i.e: $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
array	$form_actions	Set optional forms actions

[ Top ]

method display_sortable_table [line 279]

void display_sortable_table(
array
$header, array
$content, [array
$sorting_options = array ()], [array
$paging_options = array ()], [array
$query_vars = null], [
$form_actions = array()])

Display a table

Tags:

author:

bart.mollet@hogent.be

Parameters:

array	$header	Titles for the table header each item in this array can contain 3 values 1st element: the column title 2nd element: true or false (column sortable?) 3th element: additional attributes for th-tag (eg for column-width) 4the element: additional attributes for the td-tags
array	$content	2D-array with the tables content
array	$sorting_options	Keys are: 'column' = The column to use as sort-key 'direction' = SORT_ASC or SORT_DESC
array	$paging_options	Keys are: 'per_page_default' = items per page when switching from full- list to per-page-view 'per_page' = number of items to show per page 'page_nr' = The page to display
array	$query_vars	Additional variables to add in the query-string
	$form_actions

[ Top ]

method display_table_footer [line 253]

void display_table_footer(
)

display html footer of table

[ Top ]

method display_table_header [line 134]

void display_table_header(
)

Display simple html header of table.

[ Top ]

method display_table_row [line 190]

void display_table_row(
$bgcolor
$bgcolor, $table_row
$table_row, [$is_alternating
$is_alternating = true])

Displays a table row.

Parameters:

$bgcolor	$bgcolor	the background colour for the table
$table_row	$table_row	an array with the row elements
$is_alternating	$is_alternating	true: the row colours alternate, false otherwise

[ Top ]

method display_warning_message [line 394]

void display_warning_message(
string
$message, [bool
$filter = true])

Displays an warning message. Use this if you want to draw attention to something This can also be used for instance with the hint in the exercises

Tags:

author:

Patrick Cool <patrick.cool@UGent.be>, Ghent University

Parameters:

string	$message
bool	$filter	Filter (true) or not (false)

[ Top ]

method encrypted_mailto_link [line 484]

- encrypted_mailto_link(
-
$email, [
$clickable_text = null], [-
$style_class = ''], -
$text)

Return an encrypted mailto hyperlink

Tags:

return:

encrypted mailto hyperlink

Parameters:

-	$email	(string) - e-mail
-	$text	(string) - clickable text
-	$style_class	(string) - optional, class from stylesheet
	$clickable_text

[ Top ]

method get_alphabet_options [line 561]

void get_alphabet_options(
[char
$selected_letter = ''])

Print an <option>-list with all letters (A-Z).

Parameters:

char

$selected_letter

The letter that should be selected

[ Top ]

method get_platform_home_link_html [line 526]

string get_platform_home_link_html(
[
$name = ''], string
$name,)

Create a hyperlink to the platform homepage.

Tags:

return:

with html code for hyperlink

Parameters:

string	$name,	the visible name of the hyperlink, default is sitename
	$name

[ Top ]

method return_icon [line 650]

void return_icon(
string
$image, [string
$alt_text = ''], [array
$additional_attributes = array()])

This function returns the htmlcode for an icon

Tags:

author:	Patrick Cool <patrick.cool@UGent.be>, Ghent University
version:	October 2006

Parameters:

string	$image	the filename of the file (in the main/img/ folder
string	$alt_text	the alt text (probably a language variable)
array	$additional_attributes	additional attributes (for instance height, width, onclick, ...)

[ Top ]

method show_course_navigation_menu [line 577]

void show_course_navigation_menu(
[
$isHidden = false])

Show the so-called "left" menu for navigating

Parameters:

$isHidden

[ Top ]

Class: Display

Class Overview

Methods

Class Details

Class Methods

method display_complex_table_header [line 154]

Tags:

Parameters:

method display_complex_table_row [line 225]

Tags:

Parameters:

method display_confirmation_message [line 423]

Tags:

Parameters:

method display_error_message [line 455]

Tags:

Parameters:

method display_footer [line 550]

method display_header [line 539]

Parameters:

method display_icon [line 636]

Parameters:

method display_introduction_section [line 96]

Tags:

Parameters:

method display_localised_html_file [line 116]

Parameters:

method display_normal_message [line 363]

Tags:

Parameters:

method display_sortable_config_table [line 326]

Tags:

Parameters:

method display_sortable_table [line 279]

Tags:

Parameters:

method display_table_footer [line 253]

method display_table_header [line 134]

method display_table_row [line 190]

Parameters:

method display_warning_message [line 394]

Tags:

Parameters:

method encrypted_mailto_link [line 484]

Tags:

Parameters:

method get_alphabet_options [line 561]

Parameters:

method get_platform_home_link_html [line 526]

Tags:

Parameters:

method return_icon [line 650]

Tags:

Parameters:

method show_course_navigation_menu [line 577]

Parameters: