UpdateGroupCategoryDTO
extends AbstractBaseDto
in package
Data Transfer Object for updating a group category in Canvas LMS.
Table of Contents
Properties
- $autoLeader : string|null
- Assigns group leaders automatically Values: 'first', 'random', null
- $createGroupCount : int|null
- Create this number of groups
- $groupLimit : int|null
- Limit the maximum number of users in each group Requires self signup
- $name : string|null
- Name of the group category
- $selfSignup : string|null
- Allow students to sign up for a group themselves Values: 'enabled', 'restricted', null
- $sisGroupCategoryId : string|null
- The unique SIS identifier
- $splitGroupCount : string|null
- (Deprecated) Create groups and evenly distribute students
- $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
$autoLeader
Assigns group leaders automatically Values: 'first', 'random', null
public
string|null
$autoLeader
= null
$createGroupCount
Create this number of groups
public
int|null
$createGroupCount
= null
$groupLimit
Limit the maximum number of users in each group Requires self signup
public
int|null
$groupLimit
= null
$name
Name of the group category
public
string|null
$name
= null
$selfSignup
Allow students to sign up for a group themselves Values: 'enabled', 'restricted', null
public
string|null
$selfSignup
= null
$sisGroupCategoryId
The unique SIS identifier
public
string|null
$sisGroupCategoryId
= null
$splitGroupCount
(Deprecated) Create groups and evenly distribute students
Use assign_unassigned_members endpoint instead
public
string|null
$splitGroupCount
= 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>