mod_bigbluebuttonbn\task\base_send_notification Class Reference

Class containing the abstract class for notification processes in BBB. More...

Inheritance diagram for mod_bigbluebuttonbn\task\base_send_notification:

Public Member Functions
	execute ()
	Execute the task.
	get_component ()
	Getter for $component.
	get_concurrency_limit ()
	Returns effective concurrency limit for this task.
	get_cron_lock ()
	Get the current lock for the entire cron.
	get_custom_data ()
	Getter for $customdata.
	get_custom_data_as_string ()
	Alternate getter for $customdata.
	get_fail_delay ()
	Getter for $faildelay.
	get_hostname ()
	Getter for $hostname.
	get_id ()
	Getter for $id.
	get_lock ()
	Get the current lock for this task.
	get_name ()
	Provide default implementation of the task name for backward compatibility.
	get_next_run_time ()
	Get the next run time for this task.
	get_pid ()
	Getter for $pid.
	get_runtime ()
	Returns task runtime.
	get_runtime_result ()
	Returns if the task has been running for too long.
	get_timestarted ()
	Getter for $timestarted.
	get_userid ()
	Getter for $userid.
	is_blocking ()
	Getter for $blocking.
	is_component_enabled ()
	Informs whether the task's component is enabled.
	release_concurrency_lock ()
	Release the concurrency lock for this task type.
	set_blocking ($blocking)
	Setter for $blocking.
	set_component ($component)
	Setter for $component.
	set_concurrency_lock (\core\lock\lock $lock)
	Sets concurrency task lock.
	set_cron_lock (\core\lock\lock $lock)
	Set the current lock for the entire cron process.
	set_custom_data ($customdata)
	Setter for $customdata.
	set_custom_data_as_string ($customdata)
	Alternate setter for $customdata.
	set_fail_delay ($faildelay)
	Setter for $faildelay.
	set_hostname ($hostname=null)
	Setter for $hostname.
	set_id ($id)
	Setter for $id.
	set_instance_id (int $instanceid)
	Set the instanceid in the custom data.
	set_lock (\core\lock\lock $lock)
	Set the current lock for this task.
	set_next_run_time ($nextruntime)
	Set the next run time for this task.
	set_pid ($pid=null)
	Setter for $pid.
	set_timestarted ($timestarted=null)
	Setter for $timestarted.
	set_userid ($userid)
	Setter for $userid.

Protected Member Functions
	append_custom_data (array $newdata)
	Append additional elements of custom data.
	get_course_contact ()
	Get the preferred course contact for this notification.
	get_default_concurrency_limit ()
	Returns default concurrency limit for this task.
	get_html_message ()
	Get the HTML message content.
	get_instance ()
	Get the bigbluebutton instance that this notification is for.
	get_message ()
	Get the plain text message content.
	get_message_format ()
	Get the preferred message format.
	get_notification_type ()
	Get the notification type.
	get_recipients ()
	Get the list of recipients for the notification.
	get_small_message ()
	Get the short summary message.
	get_subject ()
	Get the subject of the notification.
	send_all_notifications ()
	Send all of the notifications.
	send_notification_to_current_user ()
	Send the notificiation to the current user.

Protected Attributes
object	$coursecontact = null
instance	$instance = null

Detailed Description

Class containing the abstract class for notification processes in BBB.

Copyright

2023 onwards, Blindside Networks Inc

License

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

Member Function Documentation

append_custom_data()

mod_bigbluebuttonbn\task\base_send_notification::append_custom_data ( array $newdata )

protected

Append additional elements of custom data.

Parameters

array

$newdata

execute()

mod_bigbluebuttonbn\task\base_send_notification::execute

(

)

Execute the task.

Reimplemented from core\task\task_base.

get_component()

core\task\task_base::get_component ( )

inherited

Getter for $component.

Return values

string

get_concurrency_limit()

core\task\adhoc_task::get_concurrency_limit ( )

finalinherited

Returns effective concurrency limit for this task.

Return values

int	effective concurrency limit for this task

get_course_contact()

mod_bigbluebuttonbn\task\base_send_notification::get_course_contact ( )

protected

Get the preferred course contact for this notification.

Return values

stdClass

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_custom_data()

core\task\adhoc_task::get_custom_data ( )

inherited

Getter for $customdata.

Return values

mixed

(anything that can be handled by json_decode).

get_custom_data_as_string()

core\task\adhoc_task::get_custom_data_as_string ( )

inherited

Alternate getter for $customdata.

Return values

string

this is the raw json encoded version.

get_default_concurrency_limit()

core\task\adhoc_task::get_default_concurrency_limit ( )

protectedinherited

Returns default concurrency limit for this task.

Return values

int	default concurrency limit

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_html_message()

mod_bigbluebuttonbn\task\base_send_notification::get_html_message ( )

abstractprotected

Get the HTML message content.

Return values

string

Reimplemented in mod_bigbluebuttonbn\task\send_guest_emails, and mod_bigbluebuttonbn\task\send_recording_ready_notification.

get_id()

core\task\adhoc_task::get_id ( )

inherited

Getter for $id.

Return values

int|null\$id

get_instance()

mod_bigbluebuttonbn\task\base_send_notification::get_instance ( )

protected

Get the bigbluebutton instance that this notification is for.

Return values

instance|null

null if the instance could not be loaded.

get_lock()

core\task\task_base::get_lock ( )

inherited

Get the current lock for this task.

Return values

core\lock\lock

get_message()

mod_bigbluebuttonbn\task\base_send_notification::get_message ( )

protected

Get the plain text message content.

Return values

string

get_message_format()

mod_bigbluebuttonbn\task\base_send_notification::get_message_format ( )

protected

Get the preferred message format.

Return values

string

get_name()

core\task\adhoc_task::get_name ( )

inherited

Provide default implementation of the task name for backward compatibility.

Extending classes are expected to implement this method to provide a descriptive name for the task (shown to admins)

Return values

string

Reimplemented from core\task\task_base.

Reimplemented in core\task\badges_adhoc_task, core_reportbuilder\task\send_schedule, and quiz_statistics\task\recalculate.

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_notification_type()

mod_bigbluebuttonbn\task\base_send_notification::get_notification_type ( )

abstractprotected

Get the notification type.

Return values

string

Reimplemented in mod_bigbluebuttonbn\task\send_guest_emails, and mod_bigbluebuttonbn\task\send_recording_ready_notification.

get_pid()

core\task\task_base::get_pid ( )

inherited

Getter for $pid.

Return values

int

get_recipients()

mod_bigbluebuttonbn\task\base_send_notification::get_recipients ( )

protected

Get the list of recipients for the notification.

Return values

stdClass[]

get_runtime()

core\task\task_base::get_runtime ( )

inherited

Returns task runtime.

Return values

int

get_runtime_result()

core\task\task_base::get_runtime_result ( )

inherited

Returns if the task has been running for too long.

Return values

result

get_small_message()

mod_bigbluebuttonbn\task\base_send_notification::get_small_message ( )

abstractprotected

Get the short summary message.

Return values

string

Reimplemented in mod_bigbluebuttonbn\task\send_guest_emails, and mod_bigbluebuttonbn\task\send_recording_ready_notification.

get_subject()

mod_bigbluebuttonbn\task\base_send_notification::get_subject ( )

abstractprotected

Get the subject of the notification.

Return values

string

Reimplemented in mod_bigbluebuttonbn\task\send_guest_emails, and mod_bigbluebuttonbn\task\send_recording_ready_notification.

get_timestarted()

core\task\task_base::get_timestarted ( )

inherited

Getter for $timestarted.

Return values

int

get_userid()

core\task\adhoc_task::get_userid ( )

inherited

Getter for $userid.

Return values

int|null\$userid

is_blocking()

core\task\task_base::is_blocking ( )

inherited

Getter for $blocking.

Return values

bool

is_component_enabled()

core\task\task_base::is_component_enabled ( )

inherited

Informs whether the task's component is enabled.

Return values

bool	true when enabled. false otherwise.

send_all_notifications()

mod_bigbluebuttonbn\task\base_send_notification::send_all_notifications ( )

protected

Send all of the notifications.

Reimplemented in mod_bigbluebuttonbn\task\send_guest_emails.

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_concurrency_lock()

core\task\adhoc_task::set_concurrency_lock ( \core\lock\lock $lock )

finalinherited

Sets concurrency task lock.

Parameters

core\lock\lock

$lock

concurrency lock to be set

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_custom_data()

core\task\adhoc_task::set_custom_data ( $customdata )

inherited

Setter for $customdata.

Parameters

mixed

$customdata

(anything that can be handled by json_encode)

set_custom_data_as_string()

core\task\adhoc_task::set_custom_data_as_string ( $customdata )

inherited

Alternate setter for $customdata.

Expects the data as a json_encoded string.

Parameters

string

$customdata

json_encoded string

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_id()

core\task\adhoc_task::set_id ( $id )

inherited

Setter for $id.

Parameters

int | null

$id

set_instance_id()

mod_bigbluebuttonbn\task\base_send_notification::set_instance_id

(

int

$instanceid

)

Set the instanceid in the custom data.

Parameters

int

$instanceid

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_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_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

set_userid()

core\task\adhoc_task::set_userid ( $userid )

inherited

Setter for $userid.

Parameters

int | null

$userid

---

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

• mod/bigbluebuttonbn/classes/task/base_send_notification.php