Documentation

UpdateCourseDTO extends AbstractBaseDto
in package
implements DTOInterface

Table of Contents

Interfaces

DTOInterface

Properties

$accountId  : int|null
$allowStudentForumAttachments  : bool|null
$allowStudentWikiEdits  : bool|null
$allowWikiComments  : bool|null
$applyAssignmentGroupWeights  : bool|null
$blueprint  : bool|null
$blueprintRestrictionsByObjectType  : array<string|int, mixed>|null
$conditionalRelease  : bool|null
$courseCode  : string|null
$courseColor  : string|null
$courseFormat  : string|null
$defaultView  : string
$enableCoursePaces  : bool|null
$endAt  : DateTime|null
$event  : string|null
$friendlyName  : string|null
$gradePassbackSetting  : string|null
$gradingStandardId  : int|null
$hideFinalGrades  : bool|null
$homeroomCourse  : bool|null
$homeroomCourseId  : string|null
$imageId  : int|null
$imageUrl  : string|null
$integrationId  : string|null
$isPublic  : bool|null
$isPublicToAuthUsers  : bool|null
$license  : string|null
$name  : string|null
$offer  : bool|null
$openEnrollment  : bool|null
$overrideSisStickiness  : bool|null
$publicDescription  : string|null
$publicSyllabus  : bool|null
$publicSyllabusToAuth  : bool|null
$removeBannerImage  : bool|null
$removeImage  : bool|null
$restrictEnrollmentsToCourseDates  : bool|null
$selfEnrollment  : bool|null
$sisCourseId  : string|null
$startAt  : DateTime|null
$storageQuotaMb  : int|null
$syllabusBody  : string|null
$syllabusCourseSummary  : bool|null
$syncEnrollmentsFromHomeroom  : string|null
$template  : bool|null
$termId  : int|null
$timeZone  : string|null
$useBlueprintRestrictionsByObjectType  : bool|null
$apiPropertyName  : string
The name of the property in the API

Methods

__construct()  : mixed
BaseDto constructor.
getAccountId()  : int|null
getAllowStudentForumAttachments()  : bool|null
getAllowStudentWikiEdits()  : bool|null
getAllowWikiComments()  : bool|null
getApplyAssignmentGroupWeights()  : bool|null
getBlueprint()  : bool|null
getBlueprintRestrictionsByObjectType()  : array<string|int, mixed>|null
getConditionalRelease()  : bool|null
getCourseCode()  : string|null
getCourseColor()  : string|null
getCourseFormat()  : string|null
getDefaultView()  : string
getEnableCoursePaces()  : bool|null
getEndAt()  : DateTime|null
getEvent()  : string|null
getFriendlyName()  : string|null
getGradePassbackSetting()  : string|null
getGradingStandardId()  : int|null
getHideFinalGrades()  : bool|null
getHomeroomCourse()  : bool|null
getHomeroomCourseId()  : string|null
getImageId()  : int|null
getImageUrl()  : string|null
getIntegrationId()  : string|null
getIsPublic()  : bool|null
getIsPublicToAuthUsers()  : bool|null
getLicense()  : string|null
getName()  : string|null
getOffer()  : bool|null
getOpenEnrollment()  : bool|null
getOverrideSisStickiness()  : bool|null
getPublicDescription()  : string|null
getPublicSyllabus()  : bool|null
getPublicSyllabusToAuth()  : bool|null
getRemoveBannerImage()  : bool|null
getRemoveImage()  : bool|null
getRestrictEnrollmentsToCourseDates()  : bool|null
getSelfEnrollment()  : bool|null
getSisCourseId()  : string|null
getStartAt()  : DateTime|null
getStorageQuotaMb()  : int|null
getSyllabusBody()  : string|null
getSyllabusCourseSummary()  : bool|null
getSyncEnrollmentsFromHomeroom()  : string|null
getTemplate()  : bool|null
getTermId()  : int|null
getTimeZone()  : string|null
getUseBlueprintRestrictionsByObjectType()  : bool|null
setAccountId()  : void
setAllowStudentForumAttachments()  : void
setAllowStudentWikiEdits()  : void
setAllowWikiComments()  : void
setApplyAssignmentGroupWeights()  : void
setBlueprint()  : void
setBlueprintRestrictionsByObjectType()  : void
setConditionalRelease()  : void
setCourseCode()  : void
setCourseColor()  : void
setCourseFormat()  : void
setDefaultView()  : void
setEnableCoursePaces()  : void
setEndAt()  : void
setEvent()  : void
setFriendlyName()  : void
setGradePassbackSetting()  : void
setGradingStandardId()  : void
setHideFinalGrades()  : void
setHomeroomCourse()  : void
setHomeroomCourseId()  : void
setImageId()  : void
setImageUrl()  : void
setIntegrationId()  : void
setIsPublic()  : void
setIsPublicToAuthUsers()  : void
setLicense()  : void
setName()  : void
setOffer()  : void
setOpenEnrollment()  : void
setOverrideSisStickiness()  : void
setPublicDescription()  : void
setPublicSyllabus()  : void
setPublicSyllabusToAuth()  : void
setRemoveBannerImage()  : void
setRemoveImage()  : void
setRestrictEnrollmentsToCourseDates()  : void
setSelfEnrollment()  : void
setSisCourseId()  : void
setStartAt()  : void
setStorageQuotaMb()  : void
setSyllabusBody()  : void
setSyllabusCourseSummary()  : void
setSyncEnrollmentsFromHomeroom()  : void
setTemplate()  : void
setTermId()  : void
setTimeZone()  : void
setUseBlueprintRestrictionsByObjectType()  : void
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

$accountId

public int|null $accountId = null

The unique ID of the account to move the course to.

$allowStudentForumAttachments

public bool|null $allowStudentForumAttachments = null

If true, students can attach files to forum posts.

$allowStudentWikiEdits

public bool|null $allowStudentWikiEdits = null

If true, students will be able to modify the course wiki.

$allowWikiComments

public bool|null $allowWikiComments = null

If true, course members will be able to comment on wiki pages.

$applyAssignmentGroupWeights

public bool|null $applyAssignmentGroupWeights = null

Set to true to weight final grade based on assignment groups percentages.

$blueprint

public bool|null $blueprint = null

Sets the course as a blueprint course.

$blueprintRestrictionsByObjectType

public array<string|int, mixed>|null $blueprintRestrictionsByObjectType = null

Allows setting multiple Blueprint Restriction to apply to blueprint course objects of the matching type when restricted. The possible object types are “assignment”, “attachment”, “discussion_topic”, “quiz” and “wiki_page”.

$conditionalRelease

public bool|null $conditionalRelease = null

Enable or disable individual learning paths for students based on assessment.

$courseCode

public string|null $courseCode = null

The course code for the course.

$courseColor

public string|null $courseColor = null

Sets a color in hex code format to be associated with the course. The setting takes effect only when the course is associated with a Canvas for Elementary-enabled account.

$courseFormat

public string|null $courseFormat = null

Specifies the format of the course. (Should be either ‘on_campus’ or ‘online’)

$defaultView

public string $defaultView = 'syllabus'

The type of page that users will see when they first visit the course. Allowed values: feed, wiki, modules, syllabus, assignments

$enableCoursePaces

public bool|null $enableCoursePaces = null

Enable or disable Course Pacing for the course. This setting only has an effect when the Course Pacing feature flag is enabled for the sub-account. Otherwise, Course Pacing are always disabled.

Note: Course Pacing is in active development.

$endAt

public DateTime|null $endAt = null

Course end date in ISO8601 format, e.g. 2011-01-01T01:00Z. This value is ignored unless ‘restrict_enrollments_to_course_dates’ is set to true.

$event

public string|null $event = null

The action to take on each course. Allowed values: claim, offer, conclude, delete, undelete

$friendlyName

public string|null $friendlyName = null

Set a friendly name for the course. If this is provided and the course is associated with a Canvas for Elementary account, it will be shown instead of the course name. This setting takes priority over course nicknames defined by individual users.

$gradePassbackSetting

public string|null $gradePassbackSetting = null

The grade_passback_setting for the course. Only ‘nightly_sync’ and ” are allowed.

$gradingStandardId

public int|null $gradingStandardId = null

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course.

$hideFinalGrades

public bool|null $hideFinalGrades = null

If this option is set to true, the totals in student grades summary will be hidden.

$homeroomCourse

public bool|null $homeroomCourse = null

Sets the course as a homeroom course. The setting takes effect only when the course is associated with a Canvas for Elementary-enabled account.

$homeroomCourseId

public string|null $homeroomCourseId = null

Sets the Homeroom Course id to be used with sync_enrollments_from_homeroom. The setting only takes effect when the course is associated with a Canvas for Elementary-enabled account and sync_enrollments_from_homeroom is enabled.

$imageId

public int|null $imageId = null

This is a file ID corresponding to an image file in the course that will be used as the course image. This will clear the course’s image_url setting if set. If you attempt to provide image_url and image_id in a request it will fail.

$imageUrl

public string|null $imageUrl = null

This is a URL to an image to be used as the course image. This will clear the course’s image_id setting if set. If you attempt to provide image_url and image_id in a request it will fail.

$integrationId

public string|null $integrationId = null

The unique Integration identifier.

$isPublic

public bool|null $isPublic = null

Set to true if course is public to both authenticated and unauthenticated users.

$isPublicToAuthUsers

public bool|null $isPublicToAuthUsers = null

Set to true if course is public only to authenticated users.

$license

public string|null $license = null

The name of the licensing. Should be one of the following abbreviations:

  • ‘private’ (Private Copyrighted)
  • ‘cc_by_nc_nd’ (CC Attribution Non-Commercial No Derivatives)
  • ‘cc_by_nc_sa’ (CC Attribution Non-Commercial Share Alike)
  • ‘cc_by_nc’ (CC Attribution Non-Commercial)
  • ‘cc_by_nd’ (CC Attribution No Derivatives)
  • ‘cc_by_sa’ (CC Attribution Share Alike)
  • ‘cc_by’ (CC Attribution)
  • ‘public_domain’ (Public Domain).

$name

public string|null $name = null

The name of the course. If omitted, the course will be named “Unnamed Course.”

$offer

public bool|null $offer = null

If this option is set to true, the course will be available to students immediately.

$openEnrollment

public bool|null $openEnrollment = null

Set to true if the course is open enrollment.

$overrideSisStickiness

public bool|null $overrideSisStickiness = null

Default is true. If false, any fields containing “sticky” changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness.

$publicDescription

public string|null $publicDescription = null

A publicly visible description of the course.

$publicSyllabus

public bool|null $publicSyllabus = null

Set to true to make the course syllabus public.

$publicSyllabusToAuth

public bool|null $publicSyllabusToAuth = null

Set to true to make the course syllabus public for authenticated users.

$removeBannerImage

public bool|null $removeBannerImage = null

If this option is set to true, the course banner image url and course banner image ID are both set to nil.

$removeImage

public bool|null $removeImage = null

If this option is set to true, the course image url and course image ID are both set to nil.

$restrictEnrollmentsToCourseDates

public bool|null $restrictEnrollmentsToCourseDates = null

Set to true to restrict user enrollments to the start and end dates of the course. Setting this value to false will remove the course end date (if it exists), as well as the course start date (if the course is unpublished).

$selfEnrollment

public bool|null $selfEnrollment = null

Set to true if the course is self enrollment.

$sisCourseId

public string|null $sisCourseId = null

The unique SIS identifier.

$startAt

public DateTime|null $startAt = null

Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z. This value is ignored unless ‘restrict_enrollments_to_course_dates’ is set to true, or the course is already published.

$storageQuotaMb

public int|null $storageQuotaMb = null

Set the storage quota for the course, in megabytes. The caller must have the “Manage storage quotas” account permission.

$syllabusBody

public string|null $syllabusBody = null

The syllabus body for the course.

$syllabusCourseSummary

public bool|null $syllabusCourseSummary = null

Indicates whether the Course Summary (consisting of the course’s assignments and calendar events) is displayed on the syllabus page. Defaults to true.

$syncEnrollmentsFromHomeroom

public string|null $syncEnrollmentsFromHomeroom = null

Syncs enrollments from the homeroom that is set in homeroom_course_id. The setting only takes effect when the course is associated with a Canvas for Elementary-enabled account and sync_enrollments_from_homeroom is enabled.

$template

public bool|null $template = null

Enable or disable the course as a template that can be selected by an account.

$termId

public int|null $termId = null

The unique ID of the term to create to course in.

$timeZone

public string|null $timeZone = null

The time zone for the course. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

$useBlueprintRestrictionsByObjectType

public bool|null $useBlueprintRestrictionsByObjectType = null

When enabled, the blueprint_restrictions parameter will be ignored in favor of the blueprint_restrictions_by_object_type parameter.

$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
throws
Exception

getAccountId()

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

getAllowStudentForumAttachments()

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

getAllowStudentWikiEdits()

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

getAllowWikiComments()

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

getApplyAssignmentGroupWeights()

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

getBlueprint()

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

getBlueprintRestrictionsByObjectType()

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

getConditionalRelease()

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

getCourseCode()

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

getCourseColor()

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

getCourseFormat()

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

getDefaultView()

public getDefaultView() : string
Return values
string

getEnableCoursePaces()

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

getEndAt()

public getEndAt() : DateTime|null
Return values
DateTime|null

getEvent()

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

getFriendlyName()

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

getGradePassbackSetting()

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

getGradingStandardId()

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

getHideFinalGrades()

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

getHomeroomCourse()

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

getHomeroomCourseId()

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

getImageUrl()

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

getIntegrationId()

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

getIsPublic()

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

getIsPublicToAuthUsers()

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

getLicense()

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

getOpenEnrollment()

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

getOverrideSisStickiness()

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

getPublicDescription()

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

getPublicSyllabus()

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

getPublicSyllabusToAuth()

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

getRemoveBannerImage()

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

getRemoveImage()

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

getRestrictEnrollmentsToCourseDates()

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

getSelfEnrollment()

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

getSisCourseId()

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

getStartAt()

public getStartAt() : DateTime|null
Return values
DateTime|null

getStorageQuotaMb()

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

getSyllabusBody()

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

getSyllabusCourseSummary()

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

getSyncEnrollmentsFromHomeroom()

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

getTemplate()

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

getTimeZone()

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

getUseBlueprintRestrictionsByObjectType()

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

setAccountId()

public setAccountId(int|null $accountId) : void
Parameters
$accountId : int|null

setAllowStudentForumAttachments()

public setAllowStudentForumAttachments(bool|null $allowStudentForumAttachments) : void
Parameters
$allowStudentForumAttachments : bool|null

setAllowStudentWikiEdits()

public setAllowStudentWikiEdits(bool|null $allowStudentWikiEdits) : void
Parameters
$allowStudentWikiEdits : bool|null

setAllowWikiComments()

public setAllowWikiComments(bool|null $allowWikiComments) : void
Parameters
$allowWikiComments : bool|null

setApplyAssignmentGroupWeights()

public setApplyAssignmentGroupWeights(bool|null $applyAssignmentGroupWeights) : void
Parameters
$applyAssignmentGroupWeights : bool|null

setBlueprint()

public setBlueprint(bool|null $blueprint) : void
Parameters
$blueprint : bool|null

setBlueprintRestrictionsByObjectType()

public setBlueprintRestrictionsByObjectType(array<string|int, mixed>|null $blueprintRestrictionsByObjectType) : void
Parameters
$blueprintRestrictionsByObjectType : array<string|int, mixed>|null

setConditionalRelease()

public setConditionalRelease(bool|null $conditionalRelease) : void
Parameters
$conditionalRelease : bool|null

setCourseCode()

public setCourseCode(string|null $courseCode) : void
Parameters
$courseCode : string|null

setCourseColor()

public setCourseColor(string|null $courseColor) : void
Parameters
$courseColor : string|null

setCourseFormat()

public setCourseFormat(string|null $courseFormat) : void
Parameters
$courseFormat : string|null

setDefaultView()

public setDefaultView(string $defaultView) : void
Parameters
$defaultView : string

setEnableCoursePaces()

public setEnableCoursePaces(bool|null $enableCoursePaces) : void
Parameters
$enableCoursePaces : bool|null

setEndAt()

public setEndAt(DateTime|null $endAt) : void
Parameters
$endAt : DateTime|null

setEvent()

public setEvent(string|null $event) : void
Parameters
$event : string|null

setFriendlyName()

public setFriendlyName(string|null $friendlyName) : void
Parameters
$friendlyName : string|null

setGradePassbackSetting()

public setGradePassbackSetting(string|null $gradePassbackSetting) : void
Parameters
$gradePassbackSetting : string|null

setGradingStandardId()

public setGradingStandardId(int|null $gradingStandardId) : void
Parameters
$gradingStandardId : int|null

setHideFinalGrades()

public setHideFinalGrades(bool|null $hideFinalGrades) : void
Parameters
$hideFinalGrades : bool|null

setHomeroomCourse()

public setHomeroomCourse(bool|null $homeroomCourse) : void
Parameters
$homeroomCourse : bool|null

setHomeroomCourseId()

public setHomeroomCourseId(string|null $homeroomCourseId) : void
Parameters
$homeroomCourseId : string|null

setImageId()

public setImageId(int|null $imageId) : void
Parameters
$imageId : int|null

setImageUrl()

public setImageUrl(string|null $imageUrl) : void
Parameters
$imageUrl : string|null

setIntegrationId()

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

setIsPublic()

public setIsPublic(bool|null $isPublic) : void
Parameters
$isPublic : bool|null

setIsPublicToAuthUsers()

public setIsPublicToAuthUsers(bool|null $isPublicToAuthUsers) : void
Parameters
$isPublicToAuthUsers : bool|null

setLicense()

public setLicense(string|null $license) : void
Parameters
$license : string|null

setName()

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

setOffer()

public setOffer(bool|null $offer) : void
Parameters
$offer : bool|null

setOpenEnrollment()

public setOpenEnrollment(bool|null $openEnrollment) : void
Parameters
$openEnrollment : bool|null

setOverrideSisStickiness()

public setOverrideSisStickiness(bool|null $overrideSisStickiness) : void
Parameters
$overrideSisStickiness : bool|null

setPublicDescription()

public setPublicDescription(string|null $publicDescription) : void
Parameters
$publicDescription : string|null

setPublicSyllabus()

public setPublicSyllabus(bool|null $publicSyllabus) : void
Parameters
$publicSyllabus : bool|null

setPublicSyllabusToAuth()

public setPublicSyllabusToAuth(bool|null $publicSyllabusToAuth) : void
Parameters
$publicSyllabusToAuth : bool|null

setRemoveBannerImage()

public setRemoveBannerImage(bool|null $removeBannerImage) : void
Parameters
$removeBannerImage : bool|null

setRemoveImage()

public setRemoveImage(bool|null $removeImage) : void
Parameters
$removeImage : bool|null

setRestrictEnrollmentsToCourseDates()

public setRestrictEnrollmentsToCourseDates(bool|null $restrictEnrollmentsToCourseDates) : void
Parameters
$restrictEnrollmentsToCourseDates : bool|null

setSelfEnrollment()

public setSelfEnrollment(bool|null $selfEnrollment) : void
Parameters
$selfEnrollment : bool|null

setSisCourseId()

public setSisCourseId(string|null $sisCourseId) : void
Parameters
$sisCourseId : string|null

setStartAt()

public setStartAt(DateTime|null $startAt) : void
Parameters
$startAt : DateTime|null

setStorageQuotaMb()

public setStorageQuotaMb(int|null $storageQuotaMb) : void
Parameters
$storageQuotaMb : int|null

setSyllabusBody()

public setSyllabusBody(string|null $syllabusBody) : void
Parameters
$syllabusBody : string|null

setSyllabusCourseSummary()

public setSyllabusCourseSummary(bool|null $syllabusCourseSummary) : void
Parameters
$syllabusCourseSummary : bool|null

setSyncEnrollmentsFromHomeroom()

public setSyncEnrollmentsFromHomeroom(string|null $syncEnrollmentsFromHomeroom) : void
Parameters
$syncEnrollmentsFromHomeroom : string|null

setTemplate()

public setTemplate(bool|null $template) : void
Parameters
$template : bool|null

setTermId()

public setTermId(int|null $termId) : void
Parameters
$termId : int|null

setTimeZone()

public setTimeZone(string|null $timeZone) : void
Parameters
$timeZone : string|null

setUseBlueprintRestrictionsByObjectType()

public setUseBlueprintRestrictionsByObjectType(bool|null $useBlueprintRestrictionsByObjectType) : void
Parameters
$useBlueprintRestrictionsByObjectType : bool|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