Documentation

CreateCourseDTO extends AbstractBaseDto

in package

• Application

implements DTOInterface

Table of Contents

Interfaces

DTOInterface

Properties

$allowStudentForumAttachments  : bool

If true, students can attach files to forum posts.

$allowStudentWikiEdits  : bool

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

$allowWikiComments  : bool

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

$applyAssignmentGroupWeights  : bool

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

$courseCode  : string

The course code for the course.

$courseFormat  : string|null

Optional. Specifies the format of the course. (Should be ‘on_campus’, ‘online’, or ‘blended’)

$defaultView  : string

The type of page that users will see when they first visit the course - ‘feed’ Recent Activity Dashboard - ‘modules’ Course Modules/Sections Page - ‘assignments’ Course Assignments List - ‘syllabus’ Course Syllabus Page - other types may be added in the future Allowed values: feed, wiki, modules, syllabus, assignments

$enableSisReactivation  : bool

When true, will first try to re-activate a deleted course with matching sis_course_id if possible.

$endAt  : DateTime|null

Course end date in ISO8601 format, e.g. 2011-01-01T01:00Z.

$enrollMe  : bool

Set to true to enroll the current user as the teacher.

$gradePassbackSetting  : string|null

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

$gradingStandardId  : int|null

The grading standard id to set for the course.

$hideFinalGrades  : bool

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

$integrationId  : string|null

The unique Integration identifier.

$isPublic  : bool

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

$isPublicToAuthUsers  : bool

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

$license  : string

The name of the licensing. Should be one of the following abbreviations (a descriptive name is included in parenthesis for reference): - ‘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  : string

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

$offer  : bool

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

$openEnrollment  : bool

Set to true if the course is open enrollment.

$publicDescription  : string|null

A publicly visible description of the course.

$publicSyllabus  : bool

Set to true to make the course syllabus public.

$publicSyllabusToAuth  : bool

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

$restrictEnrollmentsToCourseDates  : bool

Set to true to restrict user enrollments to the start and end dates of the course.

$selfEnrollment  : bool

Set to true if the course is self enrollment.

$sisCourseId  : string|null

The unique SIS identifier.

$startAt  : DateTime|null

Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z.

$syllabusBody  : string|null

The syllabus body for the course.

$termId  : string|null

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

$timeZone  : string

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

$apiPropertyName  : string

The name of the property in the API

Methods

__construct()  : mixed

BaseDto constructor.

getCourseCode()  : string

getCourseFormat()  : string|null

getDefaultView()  : string

getEndAt()  : DateTime|null

getGradePassbackSetting()  : string|null

getGradingStandardId()  : int|null

getIntegrationId()  : string|null

getLicense()  : string

getName()  : string

getPublicDescription()  : string|null

getSisCourseId()  : string|null

getStartAt()  : DateTime|null

getSyllabusBody()  : string|null

getTermId()  : string|null

getTimeZone()  : string

isAllowStudentForumAttachments()  : bool

isAllowStudentWikiEdits()  : bool

isAllowWikiComments()  : bool

isApplyAssignmentGroupWeights()  : bool

isEnableSisReactivation()  : bool

isEnrollMe()  : bool

isHideFinalGrades()  : bool

isOffer()  : bool

isOpenEnrollment()  : bool

isPublic()  : bool

isPublicSyllabus()  : bool

isPublicSyllabusToAuth()  : bool

isPublicToAuthUsers()  : bool

isRestrictEnrollmentsToCourseDates()  : bool

isSelfEnrollment()  : bool

setAllowStudentForumAttachments()  : void

setAllowStudentWikiEdits()  : void

setAllowWikiComments()  : void

setApplyAssignmentGroupWeights()  : void

setCourseCode()  : void

setCourseFormat()  : void

setDefaultView()  : void

setEnableSisReactivation()  : void

setEndAt()  : void

setEnrollMe()  : void

setGradePassbackSetting()  : void

setGradingStandardId()  : void

setHideFinalGrades()  : void

setIntegrationId()  : void

setIsPublic()  : void

setIsPublicToAuthUsers()  : void

setLicense()  : void

setName()  : void

setOffer()  : void

setOpenEnrollment()  : void

setPublicDescription()  : void

setPublicSyllabus()  : void

setPublicSyllabusToAuth()  : void

setRestrictEnrollmentsToCourseDates()  : void

setSelfEnrollment()  : void

setSisCourseId()  : void

setStartAt()  : void

setSyllabusBody()  : void

setTermId()  : void

setTimeZone()  : 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