UpdateGroupDTO
extends AbstractBaseDto
in package
Data Transfer Object for updating a group in Canvas LMS.
Table of Contents
Properties
- $avatarId : int|null
- The ID of the avatar attachment to use for the group
- $description : string|null
- A description of the group
- $isPublic : bool|null
- Whether the group is public (applies only to community groups)
- $joinLevel : string|null
- Who can join the group: 'invitation_only', 'request', 'free_to_join'
- $members : array<string|int, int>|null
- An array of user IDs to add as group members
- $name : string|null
- The name of the group
- $overrideSisStickiness : bool|null
- Override any sis stickiness
- $sisGroupId : string|null
- The SIS ID of the group
- $storageQuotaMb : int|null
- The storage quota for the group, in megabytes
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- BaseDto constructor.
- toApiArray() : array<string|int, array{name: string, contents: string}>
- Convert DTO to API-compatible array format
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
Properties
$avatarId
The ID of the avatar attachment to use for the group
public
int|null
$avatarId
= null
$description
A description of the group
public
string|null
$description
= null
$isPublic
Whether the group is public (applies only to community groups)
public
bool|null
$isPublic
= null
$joinLevel
Who can join the group: 'invitation_only', 'request', 'free_to_join'
public
string|null
$joinLevel
= null
$members
An array of user IDs to add as group members
public
array<string|int, int>|null
$members
= null
$name
The name of the group
public
string|null
$name
= null
$overrideSisStickiness
Override any sis stickiness
public
bool|null
$overrideSisStickiness
= null
$sisGroupId
The SIS ID of the group
public
string|null
$sisGroupId
= null
$storageQuotaMb
The storage quota for the group, in megabytes
public
int|null
$storageQuotaMb
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= ''
Methods
__construct()
BaseDto constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
toApiArray()
Convert DTO to API-compatible array format
public
toApiArray() : array<string|int, array{name: string, contents: string}>
Return values
array<string|int, array{name: string, contents: string}>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>