class bunnynet_videos extends deprecated_item

Traits

Trait url_generator.

Constants

PERPAGE

STATUS_ACTIVE

STATUS_CANCELED

STATUS_COMPLETED

STATUS_DELETED

STATUS_DISABLED

STATUS_DISAPPROVED

STATUS_ENABLED

STATUS_EXPIRED

STATUS_FAILED

STATUS_FINISH

STATUS_INACTIVE

STATUS_INPROGRESS

STATUS_NEW

STATUS_PAUSED

STATUS_PLAYED

STATUS_SYNC

TYPE

Properties

$id
$type from  deprecated_item
$timecreated from  deprecated_model
$timemodified from  deprecated_model
protected $table from  deprecated_item
protected $table_metadata from  deprecated_item
protected $fillable
$contextid from  deprecated_item
$courseid from  deprecated_item
$userid from  deprecated_item
int $parent

The internal object for bunnynet_videolibrary.

null|string $fullname

The title of the video.

int $shortname

The ID of the video library that the video belongs to.

null|string $idnumber

The unique ID of the video.

$description from  deprecated_item
$descriptionformat from  deprecated_item
int $status

The status of the video.

$visible from  deprecated_item
$guid from  deprecated_item
$sortorder from  deprecated_item
$version from  deprecated_item
$usermodified from  deprecated_item
DateTime $dateUploaded

The date when the video was uploaded.

int $views

The number of views the video received.

bool $isPublic

Determines if the video is publicly accessible.

int $length

The duration of the video in seconds.

float $framerate

The framerate of the video.

null|int $rotation

The rotation of the video.

int $width

The width of the original video file.

int $height

The height of the original video file.

null|string $availableResolutions

The available resolutions of the video.

int $thumbnailCount

The number of thumbnails generated for this video.

int $encodeProgress

The current encode progress of the video.

int $storageSize

The amount of storage used by this video.

null|array $captions

The list of captions available for the video.

bool $hasMP4Fallback

Determines if the video has MP4 fallback files generated.

null|string $collectionId

The ID of the collection where the video belongs.

null|string $thumbnailFileName

The file name of the thumbnail inside of the storage.

int $averageWatchTime

The average watch time of the video in seconds.

int $totalWatchTime

The total video watch time in seconds.

null|string $category

The automatically detected category of the video.

null|array $chapters

The list of chapters available for the video.

null|array $moments

The list of moments available for the video.

null|array $metaTags

The list of meta tags that have been added to the video.

string $thumbnailUrl

Thumbnail URL.

null|array $transcodingMessages

The list of transcoding messages that describe potential issues while the video was transcoding.

Methods

static moodle_url
url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL based on the Symfony route name and parameters.

static moodle_url
webhook_url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a webhook URL.

__construct($id = null)

No description

__clone()

No description

string|null
get_path()

No description

string|null
get_table()

No description

string
get_table_metadata()

No description

update(array $formdata = [])

Update the model with form data.

bool
delete()

No description

array
all()

No description

array
get_records(array $searchcriteria, int $page, int $totalcount, string $sort = '', int $perpage = 0)

No description

array
get_items(array $searchcriteria, int $page, int $totalcount, string $sort = '', bool $includedeleted = false, int $perpage = 0)

No description

mixed
get_meta(string $meta_key)

Get metadata value by key.

array
get_all_metadata()

No description

void
set_meta(string $meta_key, mixed $meta_value)

Set metadata key-value pair.

void
set_metas(array $metas)

Set multiple metadata key-value pairs.

mixed
get_file(object $context, string $component, string $filearea, bool $validimage = false)

Get file associated with the model.

static mixed
get_fileurl(object $file)

Get file URL.

false|mixed|stdClass
get($id)

Get record by ID.

false|mixed|stdClass
get_by_idnumber($idnumber)

Get record by idnumber.

save()

No description

from_record(stdClass $r)

No description

void
load(bool $reload = false)

No description

bool
enabled()

No description

bool
disabled()

No description

bool
deleted()

No description

static 
get_item_or_create(int|string|null $contextid, string $type = '')

No description

array
get_items_by_metadata(array $searchcriteriaitem, array $searchcriteriameta, int $page, int $totalcount, string|null $sort = '', bool $includedeleted = false, int $perpage = 0) deprecated

No description

static bunnynet_videos|false
create_or_update($videoLibraryId, array $videoData)

No description

mixed
get_thumbnail()

No description

get_url()

No description

get_embed()

No description

Details

in url_generator at line 42
static moodle_url url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL based on the Symfony route name and parameters.

Parameters

string $route
array $parameters
int $referenceType

Return Value

moodle_url

in url_generator at line 56
static moodle_url webhook_url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a webhook URL.

Parameters

string $route
array $parameters
int $referenceType

Return Value

moodle_url

in deprecated_item at line 85
__construct($id = null)

No description

Parameters

$id

Exceptions

Exception

in deprecated_model at line 116
__clone()

No description

in deprecated_model at line 121
string|null get_path()

No description

Return Value

string|null

in deprecated_model at line 128
string|null get_table()

No description

Return Value

string|null

in deprecated_model at line 137
string get_table_metadata()

No description

Return Value

string

in deprecated_model at line 151
deprecated_model_interface update(array $formdata = [])

Update the model with form data.

Parameters

array $formdata

Return Value

deprecated_model_interface

in deprecated_model at line 165
bool delete()

No description

Return Value

bool

in deprecated_model at line 172
array all()

No description

Return Value

array

in deprecated_model at line 193
array get_records(array $searchcriteria, int $page, int $totalcount, string $sort = '', int $perpage = 0)

No description

Parameters

array $searchcriteria
int $page
int $totalcount

Output parameter

string $sort
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

in deprecated_model at line 302
array get_items(array $searchcriteria, int $page, int $totalcount, string $sort = '', bool $includedeleted = false, int $perpage = 0)

No description

Parameters

array $searchcriteria
int $page
int $totalcount
string $sort
bool $includedeleted
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

in deprecated_model at line 414
mixed get_meta(string $meta_key)

Get metadata value by key.

Parameters

string $meta_key

Return Value

mixed

Exceptions

dml_exception

in deprecated_model at line 428
array get_all_metadata()

No description

Return Value

array

in deprecated_model at line 456
void set_meta(string $meta_key, mixed $meta_value)

Set metadata key-value pair.

Parameters

string $meta_key
mixed $meta_value

Return Value

void

Exceptions

dml_exception

in deprecated_model at line 478
void set_metas(array $metas)

Set multiple metadata key-value pairs.

Parameters

array $metas

Return Value

void

in deprecated_model at line 497
mixed get_file(object $context, string $component, string $filearea, bool $validimage = false)

Get file associated with the model.

Parameters

object $context
string $component
string $filearea
bool $validimage

Return Value

mixed

Exceptions

coding_exception

in deprecated_model at line 523
static mixed get_fileurl(object $file)

Get file URL.

Parameters

object $file

Return Value

mixed

in deprecated_model at line 544
protected false|mixed|stdClass get($id)

Get record by ID.

Parameters

$id

Return Value

false|mixed|stdClass

Exceptions

dml_exception

in deprecated_model at line 560
protected false|mixed|stdClass get_by_idnumber($idnumber)

Get record by idnumber.

Parameters

$idnumber

Return Value

false|mixed|stdClass

Exceptions

dml_exception

in deprecated_model at line 575
protected save()

No description

in deprecated_model at line 616
static protected deprecated_model from_record(stdClass $r)

No description

Parameters

stdClass $r

Return Value

deprecated_model

in deprecated_item at line 105
void load(bool $reload = false)

No description

Parameters

bool $reload

Return Value

void

in deprecated_item at line 116
bool enabled()

No description

Return Value

bool

in deprecated_item at line 121
bool disabled()

No description

Return Value

bool

in deprecated_item at line 129
bool deleted()

No description

Return Value

bool

Exceptions

dml_exception

in deprecated_item at line 148
static get_item_or_create(int|string|null $contextid, string $type = '')

No description

Parameters

int|string|null $contextid
string $type

Exceptions

dml_exception

in deprecated_item at line 190
array get_items_by_metadata(array $searchcriteriaitem, array $searchcriteriameta, int $page, int $totalcount, string|null $sort = '', bool $includedeleted = false, int $perpage = 0) deprecated

deprecated Migrate to core\repository\item_search_repository

No description

Parameters

array $searchcriteriaitem
array $searchcriteriameta
int $page
int $totalcount
string|null $sort
bool $includedeleted
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

at line 245
static bunnynet_videos|false create_or_update($videoLibraryId, array $videoData)

No description

Parameters

$videoLibraryId
array $videoData

Return Value

bunnynet_videos|false

at line 302
mixed get_thumbnail()

No description

Return Value

mixed

at line 307
get_url()

No description

at line 317
bunnynet_videolibrary get_library()

No description

Return Value

bunnynet_videolibrary

at line 325
bunnynet_videolibrary get_embed()

No description

Return Value

bunnynet_videolibrary