Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
mod_bigbluebuttonbn\instance Class Reference

Public Member Functions

 allow_recording_start_stop ()
 Whether recording can be started and stopped.
 
 before_start_time ()
 Whether the current time is before the scheduled start time.
 
 can_import_recordings ()
 Whether this instance can import recordings from another instance.
 
 can_join ()
 Whether this user can join the conference.
 
 can_manage_recordings ()
 Whether this user can manage recordings.
 
 can_perform_on_recordings ($action)
 Whether this user can publish/unpublish/protect/unprotect/delete recordings.
 
 does_current_user_count_towards_user_limit ()
 Check whether the current user counts towards the user limit.
 
 get_cm ()
 Get the cm_info object for the instance.
 
 get_cm_id ()
 Get the id of the course module.
 
 get_context ()
 Get the context.
 
 get_context_id ()
 Get the context ID of the module context.
 
 get_course ()
 Get the course object for the instance.
 
 get_course_context ()
 Get the course context.
 
 get_course_id ()
 Get the course id of the course that the instance is in.
 
 get_course_url ()
 Get the URL used to access the course that the instance is in.
 
 get_current_user_password ()
 Get the appropriate password for the current user.
 
 get_current_user_role ()
 Get the appropriate designated role for the current user.
 
 get_enabled_features ()
 Get the list of enabled features for this instance.
 
 get_group_id ()
 Get the current groupid if set.
 
 get_group_name ()
 Get the group name for the current group, if a group has been set.
 
 get_guest_access_password ()
 Get current meeting password.
 
 get_guest_access_url ()
 Get current guest link url.
 
 get_import_url ()
 Get the URL used for the import page.
 
 get_instance_data ()
 Get the big blue button instance data.
 
 get_instance_id ()
 Get the instance id.
 
 get_instance_var (string $name)
 Helper to get an instance var.
 
 get_join_url ()
 Get the URL used to join a meeting.
 
 get_logout_url ()
 Get the logout URL used to log out of the meeting.
 
 get_meeting_description (bool $rewritepluginfileurls=false)
 Get the meeting description with the pluginfile URLs optionally rewritten.
 
 get_meeting_event_notification_url ()
 Get the URL that the remote server will use to notify of meeting events.
 
 get_meeting_id (?int $groupid=null)
 Get the meeting id for this meeting.
 
 get_meeting_name ()
 Get the name of the meeting, considering any group if set.
 
 get_moderator_password ()
 Get the moderator password.
 
 get_mute_on_start ()
 Whether participants are muted on entry.
 
 get_origin_data ()
 Get information about the origin.
 
 get_participant_list ()
 Get the participant list for the session.
 
 get_presentation ()
 Get the presentation data for internal use.
 
 get_presentation_for_bigbluebutton_upload ()
 Get the presentation data for external API url.
 
 get_record_ready_url ()
 Get the URL that the remote server will use to notify that the recording is ready.
 
 get_recordings (array $excludedid=[], bool $viewdeleted=false)
 Get recordings for this instance.
 
 get_recordings_imported ()
 Get recordings_imported from instancedata.
 
 get_type ()
 Get the meeting type if set.
 
 get_user ()
 Get the user.
 
 get_user_fullname ()
 Get the fullname of the current user.
 
 get_user_id ()
 Get the id of the user.
 
 get_user_limit ()
 Get the configured user limit.
 
 get_view_url ()
 Get the URL used to view the instance as a user.
 
 get_viewer_password ()
 Get the viewer password.
 
 get_voice_bridge ()
 Get the voice bridge details.
 
 get_welcome_message ()
 Get the welcome message to display.
 
 has_ended ()
 Whether the meeting time has passed.
 
 has_user_limit_been_reached (int $currentusercount)
 Check whether the user limit has been reached.
 
 is_admin ()
 Whether the current user is an administrator.
 
 is_blindside_network_server ()
 Whether this is a server belonging to blindside networks.
 
 is_currently_open ()
 Whether this session is currently open.
 
 is_feature_enabled (string $feature)
 Check whetherthe named features is enabled.
 
 is_guest_allowed ()
 Is guest access allowed in this instance.
 
 is_moderator ()
 Whether the user is a session moderator.
 
 is_moderator_approval_required ()
 Moderator approval required ?
 
 is_profile_picture_enabled ()
 Is this meeting configured to display avatars of the users ?
 
 is_recorded ()
 Whether this instance is recorded.
 
 is_type_recordings_only ()
 Whether this instance is one that only includes recordings.
 
 is_type_room_and_recordings ()
 Whether this instance is includes both a room, and recordings.
 
 is_type_room_only ()
 Whether this instance is one that only includes a room.
 
 set_group_id (int $groupid)
 Set the current group id of the activity.
 
 should_record ()
 Check if meeting is recorded.
 
 should_record_from_start ()
 Whether this instance is recorded from the start.
 
 should_show_recording_button ()
 Whether to show the recording button.
 
 user_can_end_meeting ()
 Whether the user can end a meeting.
 
 user_can_force_join ()
 Whether the user can force join in all cases.
 
 user_has_group_access ($user, $groupid)
 Check if this is a valid group for this user/instance,.
 
 user_must_wait_to_join ()
 Whether the user must wait to join the session.
 
 uses_groups ()
 Check whether this instance is configured to use a group.
 

Static Public Member Functions

static get_all_instances_in_course (int $courseid)
 Get all instances in the specified course.
 
static get_from_cmid (int $cmid)
 Get the instance information from a cmid.
 
static get_from_instanceid (int $instanceid)
 Get the instance information from an instance id.
 
static get_from_meetingid (string $meetingid)
 Get the instance information from a meetingid.
 
static get_group_instance_from_instance (self $originalinstance, int $groupid)
 Get a group instance of the specified instance.
 
static parse_meetingid (string $meetingid)
 Parse a meetingID for key data.
 

Public Attributes

const IDTYPE_CMID = 0
 Get the instance information from a cmid.
 
const IDTYPE_INSTANCEID = 1
 Get the instance information from an id.
 
int const TYPE_ALL = 0
 Defines an instance type that includes room and recordings.
 
int const TYPE_RECORDING_ONLY = 2
 Defines an instance type that includes only recordings.
 
int const TYPE_ROOM_ONLY = 1
 Defines an instance type that includes only room.
 

Protected Member Functions

 do_get_presentation_with_nonce (bool $withnonce)
 Generate Presentation URL.
 

Protected Attributes

cm_info $cm
 The cm_info object relating to the instance.
 
int $cmid
 The course module id.
 
context $context
 The current context.
 
stdClass $course
 The course that the instance is in.
 
int $groupid
 The current groupid if set.
 
stdClass $instancedata
 The instance data for the instance.
 
array $participantlist
 The list of participants.
 

Member Function Documentation

◆ allow_recording_start_stop()

mod_bigbluebuttonbn\instance::allow_recording_start_stop ( )

Whether recording can be started and stopped.

Return values
bool

◆ before_start_time()

mod_bigbluebuttonbn\instance::before_start_time ( )

Whether the current time is before the scheduled start time.

Return values
bool

◆ can_import_recordings()

mod_bigbluebuttonbn\instance::can_import_recordings ( )

Whether this instance can import recordings from another instance.

Return values
bool

◆ can_join()

mod_bigbluebuttonbn\instance::can_join ( )

Whether this user can join the conference.

This checks the user right for access against capabilities and group membership

Return values
bool

◆ can_manage_recordings()

mod_bigbluebuttonbn\instance::can_manage_recordings ( )

Whether this user can manage recordings.

Return values
bool

◆ can_perform_on_recordings()

mod_bigbluebuttonbn\instance::can_perform_on_recordings ( $action)

Whether this user can publish/unpublish/protect/unprotect/delete recordings.

Parameters
string$action
Return values
bool

◆ do_get_presentation_with_nonce()

mod_bigbluebuttonbn\instance::do_get_presentation_with_nonce ( bool $withnonce)
protected

Generate Presentation URL.

Parameters
bool$withnonceThe generated url will have a nonce included
Return values
array|null

◆ does_current_user_count_towards_user_limit()

mod_bigbluebuttonbn\instance::does_current_user_count_towards_user_limit ( )

Check whether the current user counts towards the user limit.

Return values
bool

◆ get_all_instances_in_course()

static mod_bigbluebuttonbn\instance::get_all_instances_in_course ( int $courseid)
static

Get all instances in the specified course.

Parameters
int$courseid
Return values
self[]

◆ get_cm()

mod_bigbluebuttonbn\instance::get_cm ( )

Get the cm_info object for the instance.

Return values
cm_info

◆ get_cm_id()

mod_bigbluebuttonbn\instance::get_cm_id ( )

Get the id of the course module.

Return values
int

◆ get_context()

mod_bigbluebuttonbn\instance::get_context ( )

Get the context.

Return values
context_module

◆ get_context_id()

mod_bigbluebuttonbn\instance::get_context_id ( )

Get the context ID of the module context.

Return values
int

◆ get_course()

mod_bigbluebuttonbn\instance::get_course ( )

Get the course object for the instance.

Return values
stdClass

◆ get_course_context()

mod_bigbluebuttonbn\instance::get_course_context ( )

Get the course context.

Return values
context_course

◆ get_course_id()

mod_bigbluebuttonbn\instance::get_course_id ( )

Get the course id of the course that the instance is in.

Return values
int

◆ get_course_url()

mod_bigbluebuttonbn\instance::get_course_url ( )

Get the URL used to access the course that the instance is in.

Return values
moodle_url

◆ get_current_user_password()

mod_bigbluebuttonbn\instance::get_current_user_password ( )

Get the appropriate password for the current user.

Return values
string

◆ get_current_user_role()

mod_bigbluebuttonbn\instance::get_current_user_role ( )

Get the appropriate designated role for the current user.

Return values
string

◆ get_enabled_features()

mod_bigbluebuttonbn\instance::get_enabled_features ( )

Get the list of enabled features for this instance.

Return values
array

◆ get_from_cmid()

static mod_bigbluebuttonbn\instance::get_from_cmid ( int $cmid)
static

Get the instance information from a cmid.

Parameters
int$cmid
Return values
null|self

◆ get_from_instanceid()

static mod_bigbluebuttonbn\instance::get_from_instanceid ( int $instanceid)
static

Get the instance information from an instance id.

Parameters
int$instanceidThe id from the bigbluebuttonbn table
Return values
null|self

◆ get_from_meetingid()

static mod_bigbluebuttonbn\instance::get_from_meetingid ( string $meetingid)
static

Get the instance information from a meetingid.

If a group is specified in the meetingid then this will also be set.

Parameters
string$meetingid
Return values
null|self

◆ get_group_id()

mod_bigbluebuttonbn\instance::get_group_id ( )

Get the current groupid if set.

Return values
int

◆ get_group_instance_from_instance()

static mod_bigbluebuttonbn\instance::get_group_instance_from_instance ( self $originalinstance,
int $groupid )
static

Get a group instance of the specified instance.

Parameters
self$originalinstance
int$groupid
Return values
null|self

◆ get_group_name()

mod_bigbluebuttonbn\instance::get_group_name ( )

Get the group name for the current group, if a group has been set.

Return values
null|string

◆ get_guest_access_password()

mod_bigbluebuttonbn\instance::get_guest_access_password ( )

Get current meeting password.

Return values
string

◆ get_guest_access_url()

mod_bigbluebuttonbn\instance::get_guest_access_url ( )

Get current guest link url.

Return values
moodle_url

◆ get_import_url()

mod_bigbluebuttonbn\instance::get_import_url ( )

Get the URL used for the import page.

Return values
moodle_url

◆ get_instance_data()

mod_bigbluebuttonbn\instance::get_instance_data ( )

Get the big blue button instance data.

Return values
stdClass

◆ get_instance_id()

mod_bigbluebuttonbn\instance::get_instance_id ( )

Get the instance id.

Return values
int

◆ get_instance_var()

mod_bigbluebuttonbn\instance::get_instance_var ( string $name)

Helper to get an instance var.

Parameters
string$name
Return values
mixed|null

◆ get_join_url()

mod_bigbluebuttonbn\instance::get_join_url ( )

Get the URL used to join a meeting.

Return values
moodle_url

◆ get_logout_url()

mod_bigbluebuttonbn\instance::get_logout_url ( )

Get the logout URL used to log out of the meeting.

Return values
moodle_url

◆ get_meeting_description()

mod_bigbluebuttonbn\instance::get_meeting_description ( bool $rewritepluginfileurls = false)

Get the meeting description with the pluginfile URLs optionally rewritten.

Parameters
bool$rewritepluginfileurls
Return values
string

◆ get_meeting_event_notification_url()

mod_bigbluebuttonbn\instance::get_meeting_event_notification_url ( )

Get the URL that the remote server will use to notify of meeting events.

Return values
moodle_url

◆ get_meeting_id()

mod_bigbluebuttonbn\instance::get_meeting_id ( ?int $groupid = null)

Get the meeting id for this meeting.

Parameters
null | int$groupid
Return values
string

◆ get_meeting_name()

mod_bigbluebuttonbn\instance::get_meeting_name ( )

Get the name of the meeting, considering any group if set.

Return values
string

◆ get_moderator_password()

mod_bigbluebuttonbn\instance::get_moderator_password ( )

Get the moderator password.

Return values
string

◆ get_mute_on_start()

mod_bigbluebuttonbn\instance::get_mute_on_start ( )

Whether participants are muted on entry.

Return values
bool

◆ get_origin_data()

mod_bigbluebuttonbn\instance::get_origin_data ( )

Get information about the origin.

Return values
stdClass

◆ get_participant_list()

mod_bigbluebuttonbn\instance::get_participant_list ( )

Get the participant list for the session.

Return values
array

◆ get_presentation()

mod_bigbluebuttonbn\instance::get_presentation ( )

Get the presentation data for internal use.

The URL returned for the presentation will be accessible through moodle with checks about user being logged in.

Return values
array|null

◆ get_presentation_for_bigbluebutton_upload()

mod_bigbluebuttonbn\instance::get_presentation_for_bigbluebutton_upload ( )

Get the presentation data for external API url.

The URL returned for the presentation will be accessible publicly but once and with a specific URL.

Return values
array|null

◆ get_record_ready_url()

mod_bigbluebuttonbn\instance::get_record_ready_url ( )

Get the URL that the remote server will use to notify that the recording is ready.

Return values
moodle_url

◆ get_recordings()

mod_bigbluebuttonbn\instance::get_recordings ( array $excludedid = [],
bool $viewdeleted = false )

Get recordings for this instance.

Parameters
string[]$excludedid
bool$viewdeletedview deleted recordings ?
Return values
recording[]

◆ get_recordings_imported()

mod_bigbluebuttonbn\instance::get_recordings_imported ( )

Get recordings_imported from instancedata.

Return values
bool

◆ get_type()

mod_bigbluebuttonbn\instance::get_type ( )

Get the meeting type if set.

Return values
null|string

◆ get_user()

mod_bigbluebuttonbn\instance::get_user ( )

Get the user.

Return values
stdClass

◆ get_user_fullname()

mod_bigbluebuttonbn\instance::get_user_fullname ( )

Get the fullname of the current user.

Return values
string

◆ get_user_id()

mod_bigbluebuttonbn\instance::get_user_id ( )

Get the id of the user.

Return values
int

◆ get_user_limit()

mod_bigbluebuttonbn\instance::get_user_limit ( )

Get the configured user limit.

Return values
int

◆ get_view_url()

mod_bigbluebuttonbn\instance::get_view_url ( )

Get the URL used to view the instance as a user.

Return values
moodle_url

◆ get_viewer_password()

mod_bigbluebuttonbn\instance::get_viewer_password ( )

Get the viewer password.

Return values
string

◆ get_voice_bridge()

mod_bigbluebuttonbn\instance::get_voice_bridge ( )

Get the voice bridge details.

Return values
null|int

◆ get_welcome_message()

mod_bigbluebuttonbn\instance::get_welcome_message ( )

Get the welcome message to display.

Return values
string

◆ has_ended()

mod_bigbluebuttonbn\instance::has_ended ( )

Whether the meeting time has passed.

Return values
bool

◆ has_user_limit_been_reached()

mod_bigbluebuttonbn\instance::has_user_limit_been_reached ( int $currentusercount)

Check whether the user limit has been reached.

Parameters
int$currentusercountThe user count to check
Return values
bool

◆ is_admin()

mod_bigbluebuttonbn\instance::is_admin ( )

Whether the current user is an administrator.

Return values
bool

◆ is_blindside_network_server()

mod_bigbluebuttonbn\instance::is_blindside_network_server ( )

Whether this is a server belonging to blindside networks.

Return values
bool

◆ is_currently_open()

mod_bigbluebuttonbn\instance::is_currently_open ( )

Whether this session is currently open.

Return values
bool

◆ is_feature_enabled()

mod_bigbluebuttonbn\instance::is_feature_enabled ( string $feature)

Check whetherthe named features is enabled.

Parameters
string$feature
Return values
bool

◆ is_guest_allowed()

mod_bigbluebuttonbn\instance::is_guest_allowed ( )

Is guest access allowed in this instance.

Return values
bool

◆ is_moderator()

mod_bigbluebuttonbn\instance::is_moderator ( )

Whether the user is a session moderator.

Return values
bool

◆ is_moderator_approval_required()

mod_bigbluebuttonbn\instance::is_moderator_approval_required ( )

Moderator approval required ?

By default we leave it as false as "ALWAYS_ACCEPT" is the default value for the guestPolicy create parameter (https://docs.bigbluebutton.org/dev/api.html)

Return values
bool

◆ is_profile_picture_enabled()

mod_bigbluebuttonbn\instance::is_profile_picture_enabled ( )

Is this meeting configured to display avatars of the users ?

Note: this is for now a global setting.

Return values
bool

◆ is_recorded()

mod_bigbluebuttonbn\instance::is_recorded ( )

Whether this instance is recorded.

Return values
bool

◆ is_type_recordings_only()

mod_bigbluebuttonbn\instance::is_type_recordings_only ( )

Whether this instance is one that only includes recordings.

Return values
bool

◆ is_type_room_and_recordings()

mod_bigbluebuttonbn\instance::is_type_room_and_recordings ( )

Whether this instance is includes both a room, and recordings.

Return values
bool

◆ is_type_room_only()

mod_bigbluebuttonbn\instance::is_type_room_only ( )

Whether this instance is one that only includes a room.

Return values
bool

◆ parse_meetingid()

static mod_bigbluebuttonbn\instance::parse_meetingid ( string $meetingid)
static

Parse a meetingID for key data.

Parameters
string$meetingid
Return values
array
Exceptions
moodle_exception

◆ set_group_id()

mod_bigbluebuttonbn\instance::set_group_id ( int $groupid)

Set the current group id of the activity.

Parameters
int$groupid

◆ should_record()

mod_bigbluebuttonbn\instance::should_record ( )

Check if meeting is recorded.

Return values
bool

◆ should_record_from_start()

mod_bigbluebuttonbn\instance::should_record_from_start ( )

Whether this instance is recorded from the start.

Return values
bool

◆ should_show_recording_button()

mod_bigbluebuttonbn\instance::should_show_recording_button ( )

Whether to show the recording button.

Return values
bool

◆ user_can_end_meeting()

mod_bigbluebuttonbn\instance::user_can_end_meeting ( )

Whether the user can end a meeting.

Return values
bool

◆ user_can_force_join()

mod_bigbluebuttonbn\instance::user_can_force_join ( )

Whether the user can force join in all cases.

Return values
bool

◆ user_has_group_access()

mod_bigbluebuttonbn\instance::user_has_group_access ( $user,
$groupid )

Check if this is a valid group for this user/instance,.

Parameters
stdClass$user
int$groupid
Return values
bool

◆ user_must_wait_to_join()

mod_bigbluebuttonbn\instance::user_must_wait_to_join ( )

Whether the user must wait to join the session.

Return values
bool

◆ uses_groups()

mod_bigbluebuttonbn\instance::uses_groups ( )

Check whether this instance is configured to use a group.

Return values
bool

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