Lti11CourseTool
in package
The course Settings form for an LTI 1.1 tool on that course.
The checkboxes are the LTI 1.1 choices: a resource link, a content item, where the tool appears, names, email, and returning a grade. They become message, placement, claim, and scope rows. This course owns the registration and is the only course the deployment is assigned to. Edit and delete apply only to a tool this course owns.
Table of Contents
Methods
- addToCourse() : int
- deleteFromCourse() : void
- formSections() : array<int, array<string, mixed>>
- formState() : array<string, mixed>
- Saved form values for a tool this course owns.
- launchUrlNote() : string
- metaFromPost() : array<string, mixed>
- otherLaunchUrlCount() : int
- toolsOnCourse() : array<int, array<string, mixed>>
- Tools already visible in this course.
- updateOnCourse() : void
- postedChecks() : array<int, string>
- postedText() : string
- scopeUri() : string
Methods
addToCourse()
public
static addToCourse(int $contextId, int $userId, array<string, mixed> $post) : int
Parameters
- $contextId : int
- $userId : int
- $post : array<string, mixed>
Return values
int —registration_id
deleteFromCourse()
public
static deleteFromCourse(int $contextId, int $registrationId) : void
Parameters
- $contextId : int
- $registrationId : int
formSections()
public
static formSections() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>formState()
Saved form values for a tool this course owns.
public
static formState(int $contextId, int $registrationId) : array<string, mixed>
Parameters
- $contextId : int
- $registrationId : int
Return values
array<string, mixed>launchUrlNote()
public
static launchUrlNote(int $count) : string
Parameters
- $count : int
Return values
string —empty when no other tool uses the URL
metaFromPost()
public
static metaFromPost(array<string, mixed> $post) : array<string, mixed>
Parameters
- $post : array<string, mixed>
Return values
array<string, mixed>otherLaunchUrlCount()
public
static otherLaunchUrlCount(int $contextId, string $url[, int $exceptRegistrationId = 0 ]) : int
Parameters
- $contextId : int
- $url : string
- $exceptRegistrationId : int = 0
Return values
inttoolsOnCourse()
Tools already visible in this course.
public
static toolsOnCourse(int $contextId) : array<int, array<string, mixed>>
course_owned is true when this course administers the registration. A tool shared from an organization stays visible and is not course_owned.
Parameters
- $contextId : int
Return values
array<int, array<string, mixed>>updateOnCourse()
public
static updateOnCourse(int $contextId, int $registrationId, array<string, mixed> $post) : void
Parameters
- $contextId : int
- $registrationId : int
- $post : array<string, mixed>
postedChecks()
private
static postedChecks(array<string, mixed> $post, string $name) : array<int, string>
Parameters
- $post : array<string, mixed>
- $name : string
Return values
array<int, string>postedText()
private
static postedText(array<string, mixed> $post, string $name, string $label, int $max) : string
Parameters
- $post : array<string, mixed>
- $name : string
- $label : string
- $max : int
Return values
stringscopeUri()
private
static scopeUri(string $service) : string
Parameters
- $service : string