course_enrolment_table Class Reference

Inheritance diagram for course_enrolment_table:

Collaboration diagram for course_enrolment_table:

Public Member Functions
	__construct (course_enrolment_manager $manager)
	get_manual_enrol_buttons ()
	get_field_sort_direction ($field)
	set_fields ($fields, $output)
	set_total_users ($totalusers)
	set_users (array $users)
	initialise_javascript ()
	get_paging_bar ()
	get_url_params ()
	get_combined_url_params ()
	set_bulk_user_enrolment_operations (array $bulkoperations)
	get_bulk_user_enrolment_operations ()
	has_bulk_user_enrolment_operations ()
Data Fields
const	PAGEVAR = 'page'
const	PERPAGEVAR = 'perpage'
const	SORTVAR = 'sort'
const	SORTDIRECTIONVAR = 'dir'
const	DEFAULTPERPAGE = 100
const	DEFAULTSORT = 'lastname'
const	DEFAULTSORTDIRECTION = 'ASC'
	$page = 0
	$pages = 0
	$perpage = 0
	$sort
	$sortdirection
Protected Member Functions
	get_direction_icon ($output, $field)
Protected Attributes
	$manager
	$pagingbar = null
	$totalusers = null
	$users = null
	$fields = array()
	$bulkoperations = array()
Static Protected Attributes
static	$sortablefields

---

Detailed Description

Definition at line 304 of file renderer.php.

---

Constructor & Destructor Documentation

__construct

(

course_enrolment_manager $

manager

)

Constructs the table

Parameters:

course_enrolment_manager

$manager

Reimplemented in course_enrolment_other_users_table.

Definition at line 428 of file renderer.php.

Here is the call graph for this function:

---

Member Function Documentation

get_bulk_user_enrolment_operations

(

)

Returns an array of bulk operations.

Returns:

array

Definition at line 679 of file renderer.php.

Here is the caller graph for this function:

get_combined_url_params

(

)

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

Returns:

array

Definition at line 661 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_direction_icon	(	$	output,
		$	field
	)		[protected]

Gets the direction icon for the sortable field within this table

Parameters:

core_renderer	$output
string	$field

Returns:

string

Definition at line 630 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_field_sort_direction

(

$

field

)

Gets the sort direction for a given field

Parameters:

string

$field

Returns:

string ASC or DESC

Definition at line 473 of file renderer.php.

Here is the caller graph for this function:

get_manual_enrol_buttons

(

)

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

Returns:

array

Definition at line 463 of file renderer.php.

Here is the caller graph for this function:

get_paging_bar

(

)

Gets the paging bar instance for this table

Returns:

paging_bar

Definition at line 616 of file renderer.php.

Here is the caller graph for this function:

get_url_params

(

)

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

Returns:

array

Definition at line 647 of file renderer.php.

Here is the caller graph for this function:

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.

Returns:

bool

Definition at line 689 of file renderer.php.

Here is the caller graph for this function:

initialise_javascript

(

)

Definition at line 591 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

set_bulk_user_enrolment_operations

(

array $

bulkoperations

)

Sets the bulk operations for this table.

Parameters:

array

$bulkoperations

Definition at line 670 of file renderer.php.

set_fields	(	$	fields,
		$	output
	)

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

Definition at line 489 of file renderer.php.

Here is the call graph for this function:

set_total_users

(

$

totalusers

)

Sets the total number of users

Parameters:

int

$totalusers

Definition at line 541 of file renderer.php.

set_users

(

array $

users

)

Sets the users for this table

Parameters:

array

$users

Returns:

void

Definition at line 554 of file renderer.php.

Here is the call graph for this function:

---

Field Documentation

$bulkoperations = array() [protected]

Definition at line 413 of file renderer.php.

$fields = array() [protected]

Definition at line 407 of file renderer.php.

$manager [protected]

Definition at line 383 of file renderer.php.

$page = 0

Definition at line 353 of file renderer.php.

$pages = 0

Definition at line 359 of file renderer.php.

$pagingbar = null [protected]

Definition at line 389 of file renderer.php.

$perpage = 0

Definition at line 365 of file renderer.php.

$sort

Definition at line 371 of file renderer.php.

$sortablefields [static, protected]

Initial value:

 array('firstname', 'lastname', 'idnumber', 'email',
            'phone1', 'phone2', 'institution', 'department' )

Reimplemented in course_enrolment_users_table.

Definition at line 420 of file renderer.php.

$sortdirection

Definition at line 377 of file renderer.php.

$totalusers = null [protected]

Definition at line 395 of file renderer.php.

$users = null [protected]

Definition at line 401 of file renderer.php.

const DEFAULTPERPAGE = 100

The default number of items per page. Default: 100

Definition at line 335 of file renderer.php.

const DEFAULTSORT = 'lastname'

The default sort, options are course_enrolment_table::$sortablefields Default: lastname

Definition at line 341 of file renderer.php.

const DEFAULTSORTDIRECTION = 'ASC'

The default direction Default: ASC

Definition at line 347 of file renderer.php.

const PAGEVAR = 'page'

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

Definition at line 310 of file renderer.php.

const PERPAGEVAR = 'perpage'

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

Definition at line 317 of file renderer.php.

const SORTDIRECTIONVAR = 'dir'

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

Definition at line 329 of file renderer.php.

const SORTVAR = 'sort'

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

Definition at line 323 of file renderer.php.

---

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

• C:/xampp/htdocs/moodle/enrol/renderer.php