Documentation

CreateAssignmentDTO extends AbstractBaseDto
in package
implements DTOInterface

Data Transfer Object for creating assignments in Canvas LMS

This DTO handles the creation of new assignments with all the necessary fields supported by the Canvas API.

Table of Contents

Interfaces

DTOInterface

Properties

$allowedAttempts  : int|null
Maximum number of submission attempts allowed
$allowedExtensions  : array<string|int, string>|null
Allowed file extensions for submissions
$anonymousGrading  : bool|null
Whether grading is anonymous
$anonymousInstructorAnnotations  : bool|null
Whether anonymous instructor annotations are enabled
$anonymousPeerReviews  : bool|null
Whether anonymous peer reviews are enabled
$assignmentGroupId  : int|null
Assignment group ID
$automaticPeerReviews  : bool|null
Whether automatic peer review assignment is enabled
$description  : string|null
Assignment description (HTML content)
$dueAt  : string|null
Assignment due date (ISO 8601 format)
$externalToolTagAttributes  : array<string, mixed>|null
External tool tag attributes
$finalGraderId  : int|null
Final grader ID for moderated grading
$gradeGroupStudentsIndividually  : bool|null
Whether to grade students individually in group assignments
$graderCommentsVisibleToGraders  : bool|null
Grader comments visible to graders
$graderCount  : int|null
Number of graders for moderated grading
$graderNamesVisibleToFinalGrader  : bool|null
Whether final grader can view other grader identities
$gradersAnonymousToGraders  : bool|null
Whether students can see grader names
$gradersAnonymousToStudents  : bool|null
Whether graders can see student names
$gradingType  : string|null
Grading type (points, percent, pass_fail, etc.)
$groupCategoryId  : int|null
Group category ID for group assignments
$hideInGradebook  : bool|null
Whether to hide assignment in gradebook
$integrationData  : array<string, mixed>|null
Assignment integration data
$integrationId  : string|null
Assignment integration ID
$lockAt  : string|null
Assignment lock date (ISO 8601 format)
$moderatedGrading  : bool|null
Whether moderated grading is enabled
$name  : string|null
Assignment name (required)
$omitFromFinalGrade  : bool|null
Whether to omit assignment from final grade
$onlyVisibleToOverrides  : bool|null
Whether assignment is only visible to users with overrides
$peerReviewCount  : int|null
Number of peer reviews to assign per student
$peerReviews  : bool|null
Whether peer reviews are enabled
$peerReviewsAssignAt  : string|null
Date when automatic peer review assignment should occur
$pointsPossible  : float|null
Maximum points possible for this assignment
$position  : int|null
Assignment position in the group
$published  : bool|null
Whether the assignment is published
$submissionTypes  : array<string|int, string>|null
Allowed submission types
$unlockAt  : string|null
Assignment unlock date (ISO 8601 format)
$apiPropertyName  : string
The API property name for multipart requests

Methods

__construct()  : mixed
BaseDto constructor.
getAllowedAttempts()  : int|null
Get allowed attempts
getAllowedExtensions()  : array<string|int, string>|null
Get allowed extensions
getAnonymousGrading()  : bool|null
Get anonymous grading status
getAnonymousInstructorAnnotations()  : bool|null
Get anonymous instructor annotations status
getAnonymousPeerReviews()  : bool|null
Get anonymous peer reviews status
getAssignmentGroupId()  : int|null
Get assignment group ID
getAutomaticPeerReviews()  : bool|null
Get automatic peer reviews status
getDescription()  : string|null
Get assignment description
getDueAt()  : string|null
Get due date
getExternalToolTagAttributes()  : array<string, mixed>|null
Get external tool tag attributes
getFinalGraderId()  : int|null
Get final grader ID
getGradeGroupStudentsIndividually()  : bool|null
Get grade group students individually status
getGraderCommentsVisibleToGraders()  : bool|null
Get grader comments visible to graders status
getGraderCount()  : int|null
Get grader count
getGraderNamesVisibleToFinalGrader()  : bool|null
Get grader names visible to final grader status
getGradersAnonymousToGraders()  : bool|null
Get graders anonymous to graders status
getGradersAnonymousToStudents()  : bool|null
Get graders anonymous to students status
getGradingType()  : string|null
Get grading type
getGroupCategoryId()  : int|null
Get group category ID
getHideInGradebook()  : bool|null
Get hide in gradebook status
getIntegrationData()  : array<string, mixed>|null
Get integration data
getIntegrationId()  : string|null
Get integration ID
getLockAt()  : string|null
Get lock date
getModeratedGrading()  : bool|null
Get moderated grading status
getName()  : string|null
Get assignment name
getOmitFromFinalGrade()  : bool|null
Get omit from final grade status
getOnlyVisibleToOverrides()  : bool|null
Get only visible to overrides status
getPeerReviewCount()  : int|null
Get peer review count
getPeerReviews()  : bool|null
Get peer reviews status
getPeerReviewsAssignAt()  : string|null
Get peer reviews assign at date
getPointsPossible()  : float|null
Get points possible
getPosition()  : int|null
Get position
getPublished()  : bool|null
Get published status
getSubmissionTypes()  : array<string|int, string>|null
Get submission types
getUnlockAt()  : string|null
Get unlock date
setAllowedAttempts()  : void
Set allowed attempts
setAllowedExtensions()  : void
Set allowed extensions
setAnonymousGrading()  : void
Set anonymous grading status
setAnonymousInstructorAnnotations()  : void
Set anonymous instructor annotations status
setAnonymousPeerReviews()  : void
Set anonymous peer reviews status
setAssignmentGroupId()  : void
Set assignment group ID
setAutomaticPeerReviews()  : void
Set automatic peer reviews status
setDescription()  : void
Set assignment description
setDueAt()  : void
Set due date
setExternalToolTagAttributes()  : void
Set external tool tag attributes
setFinalGraderId()  : void
Set final grader ID
setGradeGroupStudentsIndividually()  : void
Set grade group students individually status
setGraderCommentsVisibleToGraders()  : void
Set grader comments visible to graders status
setGraderCount()  : void
Set grader count
setGraderNamesVisibleToFinalGrader()  : void
Set grader names visible to final grader status
setGradersAnonymousToGraders()  : void
Set graders anonymous to graders status
setGradersAnonymousToStudents()  : void
Set graders anonymous to students status
setGradingType()  : void
Set grading type
setGroupCategoryId()  : void
Set group category ID
setHideInGradebook()  : void
Set hide in gradebook status
setIntegrationData()  : void
Set integration data
setIntegrationId()  : void
Set integration ID
setLockAt()  : void
Set lock date
setModeratedGrading()  : void
Set moderated grading status
setName()  : void
Set assignment name
setOmitFromFinalGrade()  : void
Set omit from final grade status
setOnlyVisibleToOverrides()  : void
Set only visible to overrides status
setPeerReviewCount()  : void
Set peer review count
setPeerReviews()  : void
Set peer reviews status
setPeerReviewsAssignAt()  : void
Set peer reviews assign at date
setPointsPossible()  : void
Set points possible
setPosition()  : void
Set position
setPublished()  : void
Set published status
setSubmissionTypes()  : void
Set submission types
setUnlockAt()  : void
Set unlock date
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

Properties

$allowedAttempts

Maximum number of submission attempts allowed

public int|null $allowedAttempts = null

$allowedExtensions

Allowed file extensions for submissions

public array<string|int, string>|null $allowedExtensions = null

$anonymousGrading

Whether grading is anonymous

public bool|null $anonymousGrading = null

$anonymousInstructorAnnotations

Whether anonymous instructor annotations are enabled

public bool|null $anonymousInstructorAnnotations = null

$anonymousPeerReviews

Whether anonymous peer reviews are enabled

public bool|null $anonymousPeerReviews = null

$automaticPeerReviews

Whether automatic peer review assignment is enabled

public bool|null $automaticPeerReviews = null

$description

Assignment description (HTML content)

public string|null $description = null

$externalToolTagAttributes

External tool tag attributes

public array<string, mixed>|null $externalToolTagAttributes = null

$finalGraderId

Final grader ID for moderated grading

public int|null $finalGraderId = null

$gradeGroupStudentsIndividually

Whether to grade students individually in group assignments

public bool|null $gradeGroupStudentsIndividually = null

$graderCommentsVisibleToGraders

Grader comments visible to graders

public bool|null $graderCommentsVisibleToGraders = null

$graderCount

Number of graders for moderated grading

public int|null $graderCount = null

$graderNamesVisibleToFinalGrader

Whether final grader can view other grader identities

public bool|null $graderNamesVisibleToFinalGrader = null

$gradersAnonymousToGraders

Whether students can see grader names

public bool|null $gradersAnonymousToGraders = null

$gradersAnonymousToStudents

Whether graders can see student names

public bool|null $gradersAnonymousToStudents = null

$gradingType

Grading type (points, percent, pass_fail, etc.)

public string|null $gradingType = null

$groupCategoryId

Group category ID for group assignments

public int|null $groupCategoryId = null

$hideInGradebook

Whether to hide assignment in gradebook

public bool|null $hideInGradebook = null

$integrationData

Assignment integration data

public array<string, mixed>|null $integrationData = null

$moderatedGrading

Whether moderated grading is enabled

public bool|null $moderatedGrading = null

$omitFromFinalGrade

Whether to omit assignment from final grade

public bool|null $omitFromFinalGrade = null

$onlyVisibleToOverrides

Whether assignment is only visible to users with overrides

public bool|null $onlyVisibleToOverrides = null

$peerReviewCount

Number of peer reviews to assign per student

public int|null $peerReviewCount = null

$peerReviewsAssignAt

Date when automatic peer review assignment should occur

public string|null $peerReviewsAssignAt = null

$pointsPossible

Maximum points possible for this assignment

public float|null $pointsPossible = null

$submissionTypes

Allowed submission types

public array<string|int, string>|null $submissionTypes = null

$unlockAt

Assignment unlock date (ISO 8601 format)

public string|null $unlockAt = null

$apiPropertyName

The API property name for multipart requests

protected string $apiPropertyName = 'assignment'

Methods

__construct()

BaseDto constructor.

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
throws
Exception

getAllowedAttempts()

Get allowed attempts

public getAllowedAttempts() : int|null
Return values
int|null

getAllowedExtensions()

Get allowed extensions

public getAllowedExtensions() : array<string|int, string>|null
Return values
array<string|int, string>|null

getAnonymousGrading()

Get anonymous grading status

public getAnonymousGrading() : bool|null
Return values
bool|null

getAnonymousInstructorAnnotations()

Get anonymous instructor annotations status

public getAnonymousInstructorAnnotations() : bool|null
Return values
bool|null

getAnonymousPeerReviews()

Get anonymous peer reviews status

public getAnonymousPeerReviews() : bool|null
Return values
bool|null

getAssignmentGroupId()

Get assignment group ID

public getAssignmentGroupId() : int|null
Return values
int|null

getAutomaticPeerReviews()

Get automatic peer reviews status

public getAutomaticPeerReviews() : bool|null
Return values
bool|null

getDescription()

Get assignment description

public getDescription() : string|null
Return values
string|null

getExternalToolTagAttributes()

Get external tool tag attributes

public getExternalToolTagAttributes() : array<string, mixed>|null
Return values
array<string, mixed>|null

getFinalGraderId()

Get final grader ID

public getFinalGraderId() : int|null
Return values
int|null

getGradeGroupStudentsIndividually()

Get grade group students individually status

public getGradeGroupStudentsIndividually() : bool|null
Return values
bool|null

getGraderCommentsVisibleToGraders()

Get grader comments visible to graders status

public getGraderCommentsVisibleToGraders() : bool|null
Return values
bool|null

getGraderCount()

Get grader count

public getGraderCount() : int|null
Return values
int|null

getGraderNamesVisibleToFinalGrader()

Get grader names visible to final grader status

public getGraderNamesVisibleToFinalGrader() : bool|null
Return values
bool|null

getGradersAnonymousToGraders()

Get graders anonymous to graders status

public getGradersAnonymousToGraders() : bool|null
Return values
bool|null

getGradersAnonymousToStudents()

Get graders anonymous to students status

public getGradersAnonymousToStudents() : bool|null
Return values
bool|null

getGradingType()

Get grading type

public getGradingType() : string|null
Return values
string|null

getGroupCategoryId()

Get group category ID

public getGroupCategoryId() : int|null
Return values
int|null

getHideInGradebook()

Get hide in gradebook status

public getHideInGradebook() : bool|null
Return values
bool|null

getIntegrationData()

Get integration data

public getIntegrationData() : array<string, mixed>|null
Return values
array<string, mixed>|null

getIntegrationId()

Get integration ID

public getIntegrationId() : string|null
Return values
string|null

getLockAt()

Get lock date

public getLockAt() : string|null
Return values
string|null

getModeratedGrading()

Get moderated grading status

public getModeratedGrading() : bool|null
Return values
bool|null

getName()

Get assignment name

public getName() : string|null
Return values
string|null

getOmitFromFinalGrade()

Get omit from final grade status

public getOmitFromFinalGrade() : bool|null
Return values
bool|null

getOnlyVisibleToOverrides()

Get only visible to overrides status

public getOnlyVisibleToOverrides() : bool|null
Return values
bool|null

getPeerReviewCount()

Get peer review count

public getPeerReviewCount() : int|null
Return values
int|null

getPeerReviews()

Get peer reviews status

public getPeerReviews() : bool|null
Return values
bool|null

getPeerReviewsAssignAt()

Get peer reviews assign at date

public getPeerReviewsAssignAt() : string|null
Return values
string|null

getPointsPossible()

Get points possible

public getPointsPossible() : float|null
Return values
float|null

getPublished()

Get published status

public getPublished() : bool|null
Return values
bool|null

getSubmissionTypes()

Get submission types

public getSubmissionTypes() : array<string|int, string>|null
Return values
array<string|int, string>|null

getUnlockAt()

Get unlock date

public getUnlockAt() : string|null
Return values
string|null

setAllowedAttempts()

Set allowed attempts

public setAllowedAttempts(int|null $allowedAttempts) : void
Parameters
$allowedAttempts : int|null

setAllowedExtensions()

Set allowed extensions

public setAllowedExtensions(array<string|int, string>|null $allowedExtensions) : void
Parameters
$allowedExtensions : array<string|int, string>|null

setAnonymousGrading()

Set anonymous grading status

public setAnonymousGrading(bool|null $anonymousGrading) : void
Parameters
$anonymousGrading : bool|null

setAnonymousInstructorAnnotations()

Set anonymous instructor annotations status

public setAnonymousInstructorAnnotations(bool|null $anonymousInstructorAnnotations) : void
Parameters
$anonymousInstructorAnnotations : bool|null

setAnonymousPeerReviews()

Set anonymous peer reviews status

public setAnonymousPeerReviews(bool|null $anonymousPeerReviews) : void
Parameters
$anonymousPeerReviews : bool|null

setAssignmentGroupId()

Set assignment group ID

public setAssignmentGroupId(int|null $assignmentGroupId) : void
Parameters
$assignmentGroupId : int|null

setAutomaticPeerReviews()

Set automatic peer reviews status

public setAutomaticPeerReviews(bool|null $automaticPeerReviews) : void
Parameters
$automaticPeerReviews : bool|null

setDescription()

Set assignment description

public setDescription(string|null $description) : void
Parameters
$description : string|null

setDueAt()

Set due date

public setDueAt(string|null $dueAt) : void
Parameters
$dueAt : string|null

setExternalToolTagAttributes()

Set external tool tag attributes

public setExternalToolTagAttributes(array<string, mixed>|null $externalToolTagAttributes) : void
Parameters
$externalToolTagAttributes : array<string, mixed>|null

setFinalGraderId()

Set final grader ID

public setFinalGraderId(int|null $finalGraderId) : void
Parameters
$finalGraderId : int|null

setGradeGroupStudentsIndividually()

Set grade group students individually status

public setGradeGroupStudentsIndividually(bool|null $gradeGroupStudentsIndividually) : void
Parameters
$gradeGroupStudentsIndividually : bool|null

setGraderCommentsVisibleToGraders()

Set grader comments visible to graders status

public setGraderCommentsVisibleToGraders(bool|null $graderCommentsVisibleToGraders) : void
Parameters
$graderCommentsVisibleToGraders : bool|null

setGraderCount()

Set grader count

public setGraderCount(int|null $graderCount) : void
Parameters
$graderCount : int|null

setGraderNamesVisibleToFinalGrader()

Set grader names visible to final grader status

public setGraderNamesVisibleToFinalGrader(bool|null $graderNamesVisibleToFinalGrader) : void
Parameters
$graderNamesVisibleToFinalGrader : bool|null

setGradersAnonymousToGraders()

Set graders anonymous to graders status

public setGradersAnonymousToGraders(bool|null $gradersAnonymousToGraders) : void
Parameters
$gradersAnonymousToGraders : bool|null

setGradersAnonymousToStudents()

Set graders anonymous to students status

public setGradersAnonymousToStudents(bool|null $gradersAnonymousToStudents) : void
Parameters
$gradersAnonymousToStudents : bool|null

setGradingType()

Set grading type

public setGradingType(string|null $gradingType) : void
Parameters
$gradingType : string|null

setGroupCategoryId()

Set group category ID

public setGroupCategoryId(int|null $groupCategoryId) : void
Parameters
$groupCategoryId : int|null

setHideInGradebook()

Set hide in gradebook status

public setHideInGradebook(bool|null $hideInGradebook) : void
Parameters
$hideInGradebook : bool|null

setIntegrationData()

Set integration data

public setIntegrationData(array<string, mixed>|null $integrationData) : void
Parameters
$integrationData : array<string, mixed>|null

setIntegrationId()

Set integration ID

public setIntegrationId(string|null $integrationId) : void
Parameters
$integrationId : string|null

setLockAt()

Set lock date

public setLockAt(string|null $lockAt) : void
Parameters
$lockAt : string|null

setModeratedGrading()

Set moderated grading status

public setModeratedGrading(bool|null $moderatedGrading) : void
Parameters
$moderatedGrading : bool|null

setName()

Set assignment name

public setName(string|null $name) : void
Parameters
$name : string|null

setOmitFromFinalGrade()

Set omit from final grade status

public setOmitFromFinalGrade(bool|null $omitFromFinalGrade) : void
Parameters
$omitFromFinalGrade : bool|null

setOnlyVisibleToOverrides()

Set only visible to overrides status

public setOnlyVisibleToOverrides(bool|null $onlyVisibleToOverrides) : void
Parameters
$onlyVisibleToOverrides : bool|null

setPeerReviewCount()

Set peer review count

public setPeerReviewCount(int|null $peerReviewCount) : void
Parameters
$peerReviewCount : int|null

setPeerReviews()

Set peer reviews status

public setPeerReviews(bool|null $peerReviews) : void
Parameters
$peerReviews : bool|null

setPeerReviewsAssignAt()

Set peer reviews assign at date

public setPeerReviewsAssignAt(string|null $peerReviewsAssignAt) : void
Parameters
$peerReviewsAssignAt : string|null

setPointsPossible()

Set points possible

public setPointsPossible(float|null $pointsPossible) : void
Parameters
$pointsPossible : float|null

setPosition()

Set position

public setPosition(int|null $position) : void
Parameters
$position : int|null

setPublished()

Set published status

public setPublished(bool|null $published) : void
Parameters
$published : bool|null

setSubmissionTypes()

Set submission types

public setSubmissionTypes(array<string|int, string>|null $submissionTypes) : void
Parameters
$submissionTypes : array<string|int, string>|null

setUnlockAt()

Set unlock date

public setUnlockAt(string|null $unlockAt) : void
Parameters
$unlockAt : 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

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results