mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data Class Reference

Static Public Member Functions
static	get_recording_table (array $recordings, array $tools, instance $instance=null, int $courseid=0)
	Get the full recording table.
static	preview_enabled (instance $instance)
	Helper function evaluates if recording preview should be included.
static	row (?instance $instance, recording $rec, ?array $tools=null, ?int $courseid=0)
	Helper function builds a row for the data used by the recording table.
static	type_text (string $playbacktype)
	Helper function to handle yet unknown recording types.

Static Protected Member Functions
static	include_recording_table_row (?instance $instance, recording $rec)
	Helper function evaluates if recording row should be included in the table.
static	row_duration (recording $recording)
	Helper function converts recording duration used in row for the data used by the recording table.

Member Function Documentation

get_recording_table()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::get_recording_table ( array $recordings, array $tools, instance $instance = null, int $courseid = 0 )

static

Get the full recording table.

Parameters

array	$recordings
array	$tools
instance | null	$instance
int	$courseid

Return values

array

include_recording_table_row()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::include_recording_table_row ( ?instance $instance, recording $rec )

staticprotected

Helper function evaluates if recording row should be included in the table.

Parameters

instance | null	$instance
recording	$rec	a bigbluebuttonbn_recordings row

Return values

bool

preview_enabled()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::preview_enabled ( instance $instance )

static

Helper function evaluates if recording preview should be included.

Parameters

instance

$instance

Return values

bool

row()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::row ( ?instance $instance, recording $rec, ?array $tools = null, ?int $courseid = 0 )

static

Helper function builds a row for the data used by the recording table.

TODO: replace this with templates whenever possible so we just return the data via the API.

Parameters

instance | null	$instance	$instance
recording	$rec	a recording row
array | null	$tools
int | null	$courseid

Return values

stdClass|null

row_duration()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::row_duration ( recording $recording )

staticprotected

Helper function converts recording duration used in row for the data used by the recording table.

Parameters

recording

$recording

Return values

int

type_text()

static mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data::type_text ( string $playbacktype )

static

Helper function to handle yet unknown recording types.

Parameters

string

$playbacktype

: for now presentation, video, statistics, capture, notes, podcast

Return values

string

the matching language string or a capitalised version of the provided string

---

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

• mod/bigbluebuttonbn/classes/local/bigbluebutton/recordings/recording_data.php