Documentation

TodoItem
in package

Todo item for users

Table of Contents

Properties

$assignment  : array<string, mixed>|null
$contextType  : string
$courseId  : int|null
$groupId  : int|null
$htmlUrl  : string
$ignore  : string
$ignorePermanently  : string
$needsGradingCount  : int|null
$quiz  : array<string, mixed>|null
$type  : string

Methods

__construct()  : mixed
Constructor
isGrading()  : bool
Check if this is a grading todo
isSubmitting()  : bool
Check if this is a submitting todo
toArray()  : array<string, mixed>
Convert to array

Properties

$assignment

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

Assignment object for grading/submitting types

$contextType

public string $contextType

Context type (Course|Group)

$courseId

public int|null $courseId = null

Course ID

$groupId

public int|null $groupId = null

Group ID

$htmlUrl

public string $htmlUrl

URL to the Canvas web UI for this item

$ignore

public string $ignore

URL to ignore this item

$ignorePermanently

public string $ignorePermanently

URL to ignore this item permanently

$needsGradingCount

public int|null $needsGradingCount = null

Number of submissions that need grading (for grading type)

$quiz

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

Quiz object for ungraded quizzes

$type

public string $type

Type of todo item (grading, submitting)

Methods

__construct()

Constructor

public __construct([array<string, mixed> $data = [] ]) : mixed
Parameters
$data : array<string, mixed> = []

isGrading()

Check if this is a grading todo

public isGrading() : bool
Return values
bool

isSubmitting()

Check if this is a submitting todo

public isSubmitting() : bool
Return values
bool

toArray()

Convert to array

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

        
On this page

Search results