C:/xampp/htdocs/moodle/enrol/cohort/locallib.php File Reference

Go to the source code of this file.

Data Structures
class	enrol_cohort_handler
Namespaces
namespace	enrol
Functions
	enrol_cohort_sync ($courseid=NULL)
	enrol_cohort_enrol_all_users (course_enrolment_manager $manager, $cohortid, $roleid)
	enrol_cohort_get_cohorts (course_enrolment_manager $manager)
	enrol_cohort_can_view_cohort ($cohortid)
	enrol_cohort_search_cohorts (course_enrolment_manager $manager, $offset=0, $limit=25, $search= '')

---

Function Documentation

enrol_cohort_can_view_cohort

(

$

cohortid

)

Check if cohort exists and user is allowed to enrol it

moodle_database $DB

Parameters:

int

$cohortid

Cohort ID

Returns:

boolean

Definition at line 288 of file locallib.php.

Here is the call graph for this function:

enrol_cohort_enrol_all_users	(	course_enrolment_manager $	manager,
		$	cohortid,
		$	roleid
	)

Enrols all of the users in a cohort through a manual plugin instance.

In order for this to succeed the course must contain a valid manual enrolment plugin instance that the user has permission to enrol users through.

moodle_database $DB

Parameters:

course_enrolment_manager	$manager
int	$cohortid
int	$roleid

Returns:

int

Definition at line 205 of file locallib.php.

Here is the call graph for this function:

enrol_cohort_get_cohorts

(

course_enrolment_manager $

manager

)

Gets all the cohorts the user is able to view.

moodle_database $DB

Parameters:

course_enrolment_manager

$manager

Returns:

array

Definition at line 248 of file locallib.php.

Here is the call graph for this function:

enrol_cohort_search_cohorts	(	course_enrolment_manager $	manager,
		$	offset = 0,
		$	limit = 25,
		$	search = ''
	)

Gets cohorts the user is able to view.

moodle_database $DB

Parameters:

course_enrolment_manager	$manager
int	$offset	limit output from
int	$limit	items to output per load
string	$search	search string

Returns:

array Array(more => bool, offset => int, cohorts => array)

Definition at line 310 of file locallib.php.

Here is the call graph for this function:

enrol_cohort_sync

(

$

courseid = NULL

)

Sync all cohort course links.

Parameters:

int

$courseid

one course, empty mean all

Returns:

void

Definition at line 100 of file locallib.php.

Here is the call graph for this function:

Here is the caller graph for this function: