CreateEnrollmentDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Table of Contents
Interfaces
Properties
- $courseSectionId : string|null
- $endAt : DateTime|null
- $enrollmentState : string|null
- $limitPrivilegesToCourseSection : bool|null
- $notify : bool|null
- $roleId : string|null
- $selfEnrollmentCode : string|null
- $sisUserId : string|null
- $startAt : DateTime|null
- $type : string|null
- $userEmail : string|null
- $userFirstName : string|null
- $userId : string|null
- $userLastName : string|null
- $userSisId : string|null
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- BaseDto constructor.
- getCourseSectionId() : string|null
- Get the course section ID
- getEndAt() : string|null
- Get end date
- getEnrollmentState() : string|null
- Get the enrollment state
- getRoleId() : string|null
- Get the role ID
- getSelfEnrollmentCode() : string|null
- Get self-enrollment code
- getSisUserId() : string|null
- Get SIS user ID
- getStartAt() : string|null
- Get start date
- getType() : string|null
- Get the enrollment type
- getUserEmail() : string|null
- Get user email
- getUserFirstName() : string|null
- Get user first name
- getUserId() : string|null
- Get the user ID
- getUserLastName() : string|null
- Get user last name
- getUserSisId() : string|null
- Get user SIS ID
- isLimitPrivilegesToCourseSection() : bool|null
- Get limit privileges to course section flag
- isNotify() : bool|null
- Get notification preference
- setCourseSectionId() : void
- Set the course section ID
- setEndAt() : void
- Set end date
- setEnrollmentState() : void
- Set the enrollment state
- setLimitPrivilegesToCourseSection() : void
- Set limit privileges to course section flag
- setNotify() : void
- Set notification preference
- setRoleId() : void
- Set the role ID
- setSelfEnrollmentCode() : void
- Set self-enrollment code
- setSisUserId() : void
- Set SIS user ID
- setStartAt() : void
- Set start date
- setType() : void
- Set the enrollment type
- setUserEmail() : void
- Set user email
- setUserFirstName() : void
- Set user first name
- setUserId() : void
- Set the user ID
- setUserLastName() : void
- Set user last name
- setUserSisId() : void
- Set user SIS ID
- toApiArray() : array<string|int, mixed>
- Convert the DTO to an array for API requests
- toArray() : array<string|int, mixed>
- Convert the DTO to an array with proper date formatting
Properties
$courseSectionId
public
string|null
$courseSectionId
= null
$endAt
public
DateTime|null
$endAt
= null
$enrollmentState
public
string|null
$enrollmentState
= 'active'
$limitPrivilegesToCourseSection
public
bool|null
$limitPrivilegesToCourseSection
= null
$notify
public
bool|null
$notify
= null
$roleId
public
string|null
$roleId
= null
$selfEnrollmentCode
public
string|null
$selfEnrollmentCode
= null
$sisUserId
public
string|null
$sisUserId
= null
$startAt
public
DateTime|null
$startAt
= null
$type
public
string|null
$type
= null
$userEmail
public
string|null
$userEmail
= null
$userFirstName
public
string|null
$userFirstName
= null
$userId
public
string|null
$userId
= null
$userLastName
public
string|null
$userLastName
= null
$userSisId
public
string|null
$userSisId
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= 'enrollment'
Methods
__construct()
BaseDto constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
getCourseSectionId()
Get the course section ID
public
getCourseSectionId() : string|null
Return values
string|nullgetEndAt()
Get end date
public
getEndAt() : string|null
Return values
string|nullgetEnrollmentState()
Get the enrollment state
public
getEnrollmentState() : string|null
Return values
string|nullgetRoleId()
Get the role ID
public
getRoleId() : string|null
Return values
string|nullgetSelfEnrollmentCode()
Get self-enrollment code
public
getSelfEnrollmentCode() : string|null
Return values
string|nullgetSisUserId()
Get SIS user ID
public
getSisUserId() : string|null
Return values
string|nullgetStartAt()
Get start date
public
getStartAt() : string|null
Return values
string|nullgetType()
Get the enrollment type
public
getType() : string|null
Return values
string|nullgetUserEmail()
Get user email
public
getUserEmail() : string|null
Return values
string|nullgetUserFirstName()
Get user first name
public
getUserFirstName() : string|null
Return values
string|nullgetUserId()
Get the user ID
public
getUserId() : string|null
Return values
string|nullgetUserLastName()
Get user last name
public
getUserLastName() : string|null
Return values
string|nullgetUserSisId()
Get user SIS ID
public
getUserSisId() : string|null
Return values
string|nullisLimitPrivilegesToCourseSection()
Get limit privileges to course section flag
public
isLimitPrivilegesToCourseSection() : bool|null
Return values
bool|nullisNotify()
Get notification preference
public
isNotify() : bool|null
Return values
bool|nullsetCourseSectionId()
Set the course section ID
public
setCourseSectionId(string|null $courseSectionId) : void
Parameters
- $courseSectionId : string|null
setEndAt()
Set end date
public
setEndAt(DateTime|string|null $endAt) : void
Parameters
- $endAt : DateTime|string|null
setEnrollmentState()
Set the enrollment state
public
setEnrollmentState(string|null $enrollmentState) : void
Parameters
- $enrollmentState : string|null
setLimitPrivilegesToCourseSection()
Set limit privileges to course section flag
public
setLimitPrivilegesToCourseSection(bool|null $limitPrivilegesToCourseSection) : void
Parameters
- $limitPrivilegesToCourseSection : bool|null
setNotify()
Set notification preference
public
setNotify(bool|null $notify) : void
Parameters
- $notify : bool|null
setRoleId()
Set the role ID
public
setRoleId(string|null $roleId) : void
Parameters
- $roleId : string|null
setSelfEnrollmentCode()
Set self-enrollment code
public
setSelfEnrollmentCode(string|null $selfEnrollmentCode) : void
Parameters
- $selfEnrollmentCode : string|null
setSisUserId()
Set SIS user ID
public
setSisUserId(string|null $sisUserId) : void
Parameters
- $sisUserId : string|null
setStartAt()
Set start date
public
setStartAt(DateTime|string|null $startAt) : void
Parameters
- $startAt : DateTime|string|null
setType()
Set the enrollment type
public
setType(string|null $type) : void
Parameters
- $type : string|null
setUserEmail()
Set user email
public
setUserEmail(string|null $userEmail) : void
Parameters
- $userEmail : string|null
setUserFirstName()
Set user first name
public
setUserFirstName(string|null $userFirstName) : void
Parameters
- $userFirstName : string|null
setUserId()
Set the user ID
public
setUserId(string|null $userId) : void
Parameters
- $userId : string|null
setUserLastName()
Set user last name
public
setUserLastName(string|null $userLastName) : void
Parameters
- $userLastName : string|null
setUserSisId()
Set user SIS ID
public
setUserSisId(string|null $userSisId) : void
Parameters
- $userSisId : string|null
toApiArray()
Convert the DTO to an array for API requests
public
toApiArray() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
Convert the DTO to an array with proper date formatting
public
toArray() : array<string|int, mixed>