CreateConferenceDTO
extends AbstractBaseDto
in package
Data Transfer Object for creating conferences.
This DTO handles the transformation of conference creation data into the format required by the Canvas API, including support for provider-specific settings.
Table of Contents
Properties
- $conference_type : string|null
- The conference provider type (required).
- $description : string|null
- Description of the conference.
- $duration : int|null
- Duration of the conference in minutes.
- $has_advanced_settings : bool|null
- Whether the conference has advanced settings.
- $long_running : bool|null
- Whether this is a long-running conference.
- $settings : array<string, mixed>|null
- $title : string|null
- The title of the conference (required).
- $users : array<string|int, int>|null
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- Constructor to initialize DTO from array.
- toApiArray() : array<string|int, array{name: string, contents: string}>
- Convert DTO to API array format.
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
Properties
$conference_type
The conference provider type (required).
public
string|null
$conference_type
= null
Examples: 'BigBlueButton', 'Zoom', etc.
$description
Description of the conference.
public
string|null
$description
= null
$duration
Duration of the conference in minutes.
public
int|null
$duration
= null
$has_advanced_settings
Whether the conference has advanced settings.
public
bool|null
$has_advanced_settings
= null
$long_running
Whether this is a long-running conference.
public
bool|null
$long_running
= null
$settings
public
array<string, mixed>|null
$settings
= null
$title
The title of the conference (required).
public
string|null
$title
= null
$users
public
array<string|int, int>|null
$users
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= ''
Methods
__construct()
Constructor to initialize DTO from array.
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
-
Initial data
toApiArray()
Convert DTO to API array format.
public
toApiArray() : array<string|int, array{name: string, contents: string}>
Tags
Return values
array<string|int, array{name: string, contents: string}>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>