Table control used for enrolled users. More...

Inheritance diagram for course_enrolment_users_table:

Public Member Functions
	get_bulk_user_enrolment_operations ()
	Returns an array of bulk operations.

	get_combined_url_params ()
	Returns an array of URL params for both the table and the manager.

	get_field_sort_direction ($field)
	Gets the sort direction for a given field.

	get_manual_enrol_buttons ()
	Returns an array of enrol_user_buttons that are created by the different enrolment plugins available.

	get_paging_bar ()
	Gets the paging bar instance for this table.

	get_url_params ()
	Gets the params that will need to be added to the url in order to return to this page.

	has_bulk_user_enrolment_operations ()
	Returns true fi the table is aware of any bulk operations that can be performed on users selected from the currently filtered enrolment plugins.

	initialise_javascript ()

	set_bulk_user_enrolment_operations (array $bulkoperations)
	Sets the bulk operations for this table.

	set_fields ($fields, $output)
	Sets the fields for this table.

	set_total_users ($totalusers)
	Sets the total number of users.

	set_users (array $users)
	Sets the users for this table.

Public Attributes
bool	$otherusers
	To store status of Other users page.

int	$page = 0
	The current page, starting from 0.

int	$pages = 0
	The total number of pages.

int	$perpage = 0
	The number of items to display per page.

string	$sort
	The sort field for this table, should be one of course_enrolment_table\$sortablefields.

string	$sortdirection
	The sort direction, either ASC or DESC.

const	DEFAULTPERPAGE = 100
	The default number of items per page.

const	DEFAULTSORT = 'lastname'
	The default sort, options are course_enrolment_table\$sortablefields Default: lastname.

const	DEFAULTSORTDIRECTION = 'ASC'
	The default direction Default: ASC.

const	PAGEVAR = 'page'
	The get/post variable that is used to identify the page.

const	PERPAGEVAR = 'perpage'
	The get/post variable to is used to identify the number of items to display per page.

const	SORTDIRECTIONVAR = 'dir'
	The get/post variable that is used to identify the sort direction for the table.

const	SORTVAR = 'sort'
	The get/post variable that is used to identify the sort field for the table.

Protected Member Functions
	get_direction_icon ($output, $field)
	Gets the direction icon for the sortable field within this table.

Protected Attributes
array	$bulkoperations = array()
	An array of bulk user enrolment operations.

array	$fields = array()
	The fields for this table.

course_enrolment_manager	$manager
	The course manager this table is displaying for.

paging_bar	$pagingbar = null
	The paging bar that controls the paging for this table.

int	$totalusers = null
	The total number of users enrolled in the course.

array	$users = null
	The users enrolled in this course.

Static Protected Attributes
static array	$sortablefields
	An array of sortable fields.

Detailed Description

Table control used for enrolled users.

Copyright: 2010 Sam Hemelryk

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

Member Function Documentation

◆ get_bulk_user_enrolment_operations()

course_enrolment_table::get_bulk_user_enrolment_operations ( )

inherited

Returns an array of bulk operations.

Return values

array

◆ get_combined_url_params()

course_enrolment_table::get_combined_url_params ( )

inherited

Returns an array of URL params for both the table and the manager.

Return values

array

◆ get_direction_icon()

course_enrolment_table::get_direction_icon	(		$output,
			$field )

protectedinherited

Gets the direction icon for the sortable field within this table.

Parameters

core_renderer	$output
string	$field

Return values

string

◆ get_field_sort_direction()

course_enrolment_table::get_field_sort_direction ( $field )

inherited

Gets the sort direction for a given field.

Parameters

string $field

Return values

string ASC or DESC

◆ get_manual_enrol_buttons()

course_enrolment_table::get_manual_enrol_buttons ( )

inherited

Returns an array of enrol_user_buttons that are created by the different enrolment plugins available.

Return values

array

◆ get_paging_bar()

course_enrolment_table::get_paging_bar ( )

inherited

Gets the paging bar instance for this table.

Return values

paging_bar

◆ get_url_params()

course_enrolment_table::get_url_params ( )

inherited

Gets the params that will need to be added to the url in order to return to this page.

Return values

array

◆ has_bulk_user_enrolment_operations()

course_enrolment_table::has_bulk_user_enrolment_operations ( )

inherited

Returns true fi the table is aware of any bulk operations that can be performed on users selected from the currently filtered enrolment plugins.

Return values

bool

◆ set_bulk_user_enrolment_operations()

course_enrolment_table::set_bulk_user_enrolment_operations ( array $bulkoperations )

inherited

Sets the bulk operations for this table.

Parameters

array $bulkoperations

◆ set_fields()

course_enrolment_table::set_fields	(		$fields,
			$output )

inherited

Sets the fields for this table.

These get added to the tables head as well.

You can also use a multi dimensional array for this to have multiple fields in a single column

Parameters

array	$fields	An array of fields to set
string	$output

◆ set_total_users()

course_enrolment_table::set_total_users ( $totalusers )

inherited

Sets the total number of users.

Parameters

int $totalusers

◆ set_users()

course_enrolment_table::set_users ( array $users )

inherited

Sets the users for this table.

Parameters

array $users

Return values

void

Member Data Documentation

◆ $sortablefields

array course_enrolment_table::$sortablefields

staticprotectedinherited

Initial value:

= array('firstname', 'lastname', 'firstnamephonetic', 'lastnamephonetic', 'middlename',

'alternatename', 'username', 'idnumber', 'email', 'phone1', 'phone2',

'institution', 'department', 'lastaccess', 'lastcourseaccess')

An array of sortable fields.

◆ DEFAULTPERPAGE

const course_enrolment_table::DEFAULTPERPAGE = 100

inherited

The default number of items per page.

Default: 100

◆ PAGEVAR

const course_enrolment_table::PAGEVAR = 'page'

inherited

The get/post variable that is used to identify the page.

Default: page

◆ PERPAGEVAR

const course_enrolment_table::PERPAGEVAR = 'perpage'

inherited

The get/post variable to is used to identify the number of items to display per page.

Default: perpage

◆ SORTDIRECTIONVAR

const course_enrolment_table::SORTDIRECTIONVAR = 'dir'

inherited

The get/post variable that is used to identify the sort direction for the table.

Default: dir

◆ SORTVAR

const course_enrolment_table::SORTVAR = 'sort'

inherited

The get/post variable that is used to identify the sort field for the table.

Default: sort

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

enrol/renderer.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ get_bulk_user_enrolment_operations()

◆ get_combined_url_params()

◆ get_direction_icon()

◆ get_field_sort_direction()

◆ get_manual_enrol_buttons()

◆ get_paging_bar()

◆ get_url_params()

◆ has_bulk_user_enrolment_operations()

◆ set_bulk_user_enrolment_operations()

◆ set_fields()

◆ set_total_users()

◆ set_users()

Member Data Documentation

◆ $sortablefields

◆ DEFAULTPERPAGE

◆ PAGEVAR

◆ PERPAGEVAR

◆ SORTDIRECTIONVAR

◆ SORTVAR