Documentation

GradebookHistoryDay
in package

GradebookHistoryDay represents a date with grading activity.

This is a read-only object that does not extend AbstractBaseApi.

Tags
see
https://canvas.instructure.com/doc/api/gradebook_history.html#Day

Table of Contents

Properties

$date  : string|null
$graders  : array<string|int, GradebookHistoryGrader>

Methods

__construct()  : mixed
Constructor to hydrate the object from API response.
findGrader()  : GradebookHistoryGrader|null
Find a grader by ID.
fromArray()  : self
Create a GradebookHistoryDay from an array.
getAllAssignmentIds()  : array<string|int, int>
Get all unique assignment IDs that had activity on this day.
getGraderCount()  : int
Get the number of graders who had activity on this day.
getTotalAssignmentCount()  : int
Get the total number of assignments graded on this day.

Properties

Methods

__construct()

Constructor to hydrate the object from API response.

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

fromArray()

Create a GradebookHistoryDay from an array.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>
Return values
self

getAllAssignmentIds()

Get all unique assignment IDs that had activity on this day.

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

getGraderCount()

Get the number of graders who had activity on this day.

public getGraderCount() : int
Return values
int

getTotalAssignmentCount()

Get the total number of assignments graded on this day.

public getTotalAssignmentCount() : int
Return values
int

        
On this page

Search results