Task for synchronising members using the enrolment LTI. More...

Inheritance diagram for enrol_lti\task\sync_members:

Public Member Functions
	eval_cron_field ($field, $min, $max)
	Take a cron field definition and return an array of valid numbers with the range min-max. More...

	execute ()
	Performs the synchronisation of members. More...

	get_component ()
	Getter for $component. More...

	get_cron_lock ()
	Get the current lock for the entire cron. More...

	get_day ()
	Getter for $day. More...

	get_day_of_week ()
	Getter for $dayofweek. More...

	get_disabled ()
	Getter for $disabled. More...

	get_fail_delay ()
	Getter for $faildelay. More...

	get_hostname ()
	Getter for $hostname. More...

	get_hour ()
	Getter for $hour. More...

	get_last_run_time ()
	Get the last run time for this scheduled task. More...

	get_lock ()
	Get the current lock for this task. More...

	get_minute ()
	Getter for $minute. More...

	get_month ()
	Getter for $month. More...

	get_name ()
	Get a descriptive name for this task. More...

	get_next_run_time ()
	Get the next run time for this task. More...

	get_next_scheduled_time ()
	Calculate when this task should next be run based on the schedule. More...

	get_pid ()
	Getter for $pid. More...

	get_run_if_component_disabled ()
	Override this function if you want this scheduled task to run, even if the component is disabled. More...

	get_timestarted ()
	Getter for $timestarted. More...

	is_blocking ()
	Getter for $blocking. More...

	is_customised ()
	Has this task been changed from it's default config? More...

	is_overridden ()
	Has this task been changed from it's default config? More...

	set_blocking ($blocking)
	Setter for $blocking. More...

	set_component ($component)
	Setter for $component. More...

	set_cron_lock (\core\lock\lock $lock)
	Set the current lock for the entire cron process. More...

	set_customised ($customised)
	Has this task been changed from it's default config? More...

	set_day ($day)
	Setter for $day. More...

	set_day_of_week ($dayofweek, $expandr=true)
	Setter for $dayofweek. More...

	set_disabled ($disabled)
	Setter for $disabled. More...

	set_fail_delay ($faildelay)
	Setter for $faildelay. More...

	set_hostname ($hostname=null)
	Setter for $hostname. More...

	set_hour ($hour, $expandr=true)
	Setter for $hour. More...

	set_last_run_time ($lastruntime)
	Set the last run time for this scheduled task. More...

	set_lock (\core\lock\lock $lock)
	Set the current lock for this task. More...

	set_minute ($minute, $expandr=true)
	Setter for $minute. More...

	set_month ($month)
	Setter for $month. More...

	set_next_run_time ($nextruntime)
	Set the next run time for this task. More...

	set_overridden (bool $overridden)
	Set the overridden value. More...

	set_pid ($pid=null)
	Setter for $pid. More...

	set_timestarted ($timestarted=null)
	Setter for $timestarted. More...

Public Attributes
const	DAYOFWEEKMAX = 6
	Maximum dayofweek value.

const	DAYOFWEEKMIN = 0
	Minimum dayofweek value.

const	HOURMAX = 23
	Maximum hour value.

const	HOURMIN = 0
	Minimum hour value.

const	MINUTEMAX = 59
	Maximum minute value.

const	MINUTEMIN = 0
	Minimum minute value.

Protected Member Functions
	do_context_membership_request (Context $context, ResourceLink $resourcelink=null, $membershipsurltemplate='')
	Performs membership service request using an LTI Context object. More...

	do_resourcelink_membership_request (ResourceLink $resourcelink)
	Performs membership service request using ResourceLink::doMembershipsService() method. More...

	fetch_members_from_consumer (ToolConsumer $consumer)
	Fetches the members that belong to a ToolConsumer. More...

	should_sync_enrol ($syncmode)
	Method to determine whether to sync enrolments or not. More...

	should_sync_unenrol ($syncmode)
	Method to determine whether to sync unenrolments or not. More...

	sync_member_information (stdClass $tool, ToolConsumer $consumer, $members)
	Performs synchronisation of member information and enrolments. More...

	sync_profile_images ()
	Performs synchronisation of user profile images.

	sync_unenrol (stdClass $tool, string $consumerkey, array $currentusers)
	Performs unenrolment of users that are no longer enrolled in the consumer side. More...

Protected Attributes
data_connector	$dataconnector
	$dataconnector A data_connector instance.

array	$userphotos = []
	Array of user photos.

Detailed Description

Task for synchronising members using the enrolment LTI.

Copyright: 2016 Mark Nelson markn.nosp@m.@moo.nosp@m.dle.c.nosp@m.om

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

Member Function Documentation

◆ do_context_membership_request()

enrol_lti\task\sync_members::do_context_membership_request	(	Context	$context,
		ResourceLink	$resourcelink = `null`,
			$membershipsurltemplate = `''`
	)

protected

Performs membership service request using an LTI Context object.

If the context has a 'custom_context_memberships_url' setting, we use this to perform the membership service request. Otherwise, if a context is associated with resource link, we try first to get the members using the ResourceLink::doMembershipsService() method. If we're still unable to fetch members from the resource link, we try to build a memberships URL from the memberships URL endpoint template that is defined in the ToolConsumer profile and substitute the parameters accordingly.

Parameters

Context	$context	The context object.
ResourceLink	$resourcelink	The resource link object.
string	$membershipsurltemplate	The memberships endpoint URL template.

Return values

bool|User[] Array of User objects upon successful membership service request. False, otherwise.

◆ do_resourcelink_membership_request()

enrol_lti\task\sync_members::do_resourcelink_membership_request ( ResourceLink $resourcelink )

protected

Performs membership service request using ResourceLink::doMembershipsService() method.

Parameters

ResourceLink $resourcelink

Return values

bool|User[] Array of User objects upon successful membership service request. False, otherwise.

◆ eval_cron_field()

core\task\scheduled_task::eval_cron_field	(	$field,
		$min,
		$max
	)

inherited

Take a cron field definition and return an array of valid numbers with the range min-max.

Parameters

string	$field	- The field definition.
int	$min	- The minimum allowable value.
int	$max	- The maximum allowable value.

Return values

array(int)

◆ execute()

enrol_lti\task\sync_members::execute ( )

Performs the synchronisation of members.

Reimplemented from core\task\task_base.

◆ fetch_members_from_consumer()

enrol_lti\task\sync_members::fetch_members_from_consumer ( ToolConsumer $consumer )

protected

Fetches the members that belong to a ToolConsumer.

Parameters

ToolConsumer $consumer

Return values

bool|User[]

◆ get_component()

core\task\task_base::get_component ( )

inherited

Getter for $component.

Return values

string

◆ get_cron_lock()

core\task\task_base::get_cron_lock ( )

inherited

Get the current lock for the entire cron.

Return values

core::lock::lock

◆ get_day()

core\task\scheduled_task::get_day ( )

inherited

Getter for $day.

Return values

string

◆ get_day_of_week()

core\task\scheduled_task::get_day_of_week ( )

inherited

Getter for $dayofweek.

Return values

string

◆ get_disabled()

core\task\scheduled_task::get_disabled ( )

inherited

Getter for $disabled.

Return values

bool

◆ get_fail_delay()

core\task\task_base::get_fail_delay ( )

inherited

Getter for $faildelay.

Return values

int

◆ get_hostname()

core\task\task_base::get_hostname ( )

inherited

Getter for $hostname.

Return values

string

◆ get_hour()

core\task\scheduled_task::get_hour ( )

inherited

Getter for $hour.

Return values

string

◆ get_last_run_time()

core\task\scheduled_task::get_last_run_time ( )

inherited

Get the last run time for this scheduled task.

Return values

int

◆ get_lock()

core\task\task_base::get_lock ( )

inherited

Get the current lock for this task.

Return values

core::lock::lock

◆ get_minute()

core\task\scheduled_task::get_minute ( )

inherited

Getter for $minute.

Return values

string

◆ get_month()

core\task\scheduled_task::get_month ( )

inherited

Getter for $month.

Return values

string

◆ get_name()

enrol_lti\task\sync_members::get_name ( )

Get a descriptive name for this task.

Return values

string

Reimplemented from core\task\scheduled_task.

◆ get_next_run_time()

core\task\task_base::get_next_run_time ( )

inherited

Get the next run time for this task.

Return values

int timestamp

◆ get_next_scheduled_time()

core\task\scheduled_task::get_next_scheduled_time ( )

inherited

Calculate when this task should next be run based on the schedule.

Return values

int::$nextruntime,.

◆ get_pid()

core\task\task_base::get_pid ( )

inherited

Getter for $pid.

Return values

int

◆ get_run_if_component_disabled()

core\task\scheduled_task::get_run_if_component_disabled ( )

inherited

Override this function if you want this scheduled task to run, even if the component is disabled.

Return values

bool

◆ get_timestarted()

core\task\task_base::get_timestarted ( )

inherited

Getter for $timestarted.

Return values

int

◆ is_blocking()

core\task\task_base::is_blocking ( )

inherited

Getter for $blocking.

Return values

bool

◆ is_customised()

core\task\scheduled_task::is_customised ( )

inherited

Has this task been changed from it's default config?

Return values

bool

◆ is_overridden()

core\task\scheduled_task::is_overridden ( )

inherited

Has this task been changed from it's default config?

Return values

bool

◆ set_blocking()

core\task\task_base::set_blocking ( $blocking )

inherited

Setter for $blocking.

Parameters

bool $blocking

◆ set_component()

core\task\task_base::set_component ( $component )

inherited

Setter for $component.

Parameters

string $component

◆ set_cron_lock()

core\task\task_base::set_cron_lock ( \core\lock\lock $lock )

inherited

Set the current lock for the entire cron process.

Parameters

core::lock::lock $lock

◆ set_customised()

core\task\scheduled_task::set_customised ( $customised )

inherited

Has this task been changed from it's default config?

Parameters

bool

◆ set_day()

core\task\scheduled_task::set_day ( $day )

inherited

Setter for $day.

Parameters

string $day

◆ set_day_of_week()

core\task\scheduled_task::set_day_of_week	(	$dayofweek,
		$expandr = `true`
	)

inherited

Setter for $dayofweek.

Parameters

string	$dayofweek
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

◆ set_disabled()

core\task\scheduled_task::set_disabled ( $disabled )

inherited

Setter for $disabled.

Parameters

bool $disabled

◆ set_fail_delay()

core\task\task_base::set_fail_delay ( $faildelay )

inherited

Setter for $faildelay.

Parameters

int $faildelay

◆ set_hostname()

core\task\task_base::set_hostname ( $hostname = null )

inherited

Setter for $hostname.

Parameters

string $hostname

◆ set_hour()

core\task\scheduled_task::set_hour	(	$hour,
		$expandr = `true`
	)

inherited

Setter for $hour.

Accepts a special 'R' value which will be translated to a random hour.

Parameters

string	$hour
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

◆ set_last_run_time()

core\task\scheduled_task::set_last_run_time ( $lastruntime )

inherited

Set the last run time for this scheduled task.

Parameters

int $lastruntime

◆ set_lock()

core\task\task_base::set_lock ( \core\lock\lock $lock )

inherited

Set the current lock for this task.

Parameters

core::lock::lock $lock

◆ set_minute()

core\task\scheduled_task::set_minute	(	$minute,
		$expandr = `true`
	)

inherited

Setter for $minute.

Accepts a special 'R' value which will be translated to a random minute.

Parameters

string	$minute
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

◆ set_month()

core\task\scheduled_task::set_month ( $month )

inherited

Setter for $month.

Parameters

string $month

◆ set_next_run_time()

core\task\task_base::set_next_run_time ( $nextruntime )

inherited

Set the next run time for this task.

Parameters

int $nextruntime

◆ set_overridden()

core\task\scheduled_task::set_overridden ( bool $overridden )

inherited

Set the overridden value.

Parameters

bool $overridden

◆ set_pid()

core\task\task_base::set_pid ( $pid = null )

inherited

Setter for $pid.

Parameters

int $pid

◆ set_timestarted()

core\task\task_base::set_timestarted ( $timestarted = null )

inherited

Setter for $timestarted.

Parameters

int $timestarted

◆ should_sync_enrol()

enrol_lti\task\sync_members::should_sync_enrol ( $syncmode )

protected

Method to determine whether to sync enrolments or not.

Parameters

int $syncmode The tool's membersyncmode.

Return values

bool

◆ should_sync_unenrol()

enrol_lti\task\sync_members::should_sync_unenrol ( $syncmode )

protected

Method to determine whether to sync unenrolments or not.

Parameters

int $syncmode The tool's membersyncmode.

Return values

bool

◆ sync_member_information()

enrol_lti\task\sync_members::sync_member_information	(	stdClass	$tool,
		ToolConsumer	$consumer,
			$members
	)

protected

Performs synchronisation of member information and enrolments.

Parameters

stdClass	$tool
ToolConsumer	$consumer
User[]	$members

Return values

array An array of users from processed members and the number that were enrolled.

◆ sync_unenrol()

enrol_lti\task\sync_members::sync_unenrol	(	stdClass	$tool,
		string	$consumerkey,
		array	$currentusers
	)

protected

Performs unenrolment of users that are no longer enrolled in the consumer side.

Parameters

stdClass	$tool	The tool record object.
string	$consumerkey	ensure we only unenrol users from this tool consumer.
array	$currentusers	The list of current users.

Return values

int	The number of users that have been unenrolled.

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

enrol/lti/classes/task/sync_members.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ do_context_membership_request()

◆ do_resourcelink_membership_request()

◆ eval_cron_field()

◆ execute()

◆ fetch_members_from_consumer()

◆ get_component()

◆ get_cron_lock()

◆ get_day()

◆ get_day_of_week()

◆ get_disabled()

◆ get_fail_delay()

◆ get_hostname()

◆ get_hour()

◆ get_last_run_time()

◆ get_lock()

◆ get_minute()

◆ get_month()

◆ get_name()

◆ get_next_run_time()

◆ get_next_scheduled_time()

◆ get_pid()

◆ get_run_if_component_disabled()

◆ get_timestarted()

◆ is_blocking()

◆ is_customised()

◆ is_overridden()

◆ set_blocking()

◆ set_component()

◆ set_cron_lock()

◆ set_customised()

◆ set_day()

◆ set_day_of_week()

◆ set_disabled()

◆ set_fail_delay()

◆ set_hostname()

◆ set_hour()

◆ set_last_run_time()

◆ set_lock()

◆ set_minute()

◆ set_month()

◆ set_next_run_time()

◆ set_overridden()

◆ set_pid()

◆ set_timestarted()

◆ should_sync_enrol()

◆ should_sync_unenrol()

◆ sync_member_information()

◆ sync_unenrol()