GradeCategoryRepository
in package
Course grade categories and the link columns that sit in them.
A link belongs to one category or none. None is uncategorized. position orders categories in the grade book. hidden keeps a column off the student grade list.
Table of Contents
Methods
- create() : string|null
- delete() : string|null
- gradeColumns() : array<int, array<string, mixed>>
- Grade columns in this course.
- listForContext() : array<int, array<string, mixed>>
- move() : string|null
- setLinkCategory() : string|null
- setLinkHidden() : string|null
- update() : string|null
- categoryInContext() : mixed
- fields() : array{title: string, percent: int, extra_credit: int}|string
- linkInContext() : array<string, mixed>|false
- orderedIds() : array<string|int, int>
- writeError() : string|null
- writePositions() : mixed
Methods
create()
public
static create(mixed $context_id, mixed $title, mixed $percent, mixed $extra_credit) : string|null
Parameters
- $context_id : mixed
- $title : mixed
- $percent : mixed
- $extra_credit : mixed
Return values
string|null —Error message, or null on success.
delete()
public
static delete(mixed $context_id, mixed $category_id) : string|null
Parameters
- $context_id : mixed
- $category_id : mixed
Return values
string|null —Error message, or null on success.
gradeColumns()
Grade columns in this course.
public
static gradeColumns(mixed $context_id[, mixed $user_id = 0 ][, array<int, string> $link_keys = array() ]) : array<int, array<string, mixed>>
A column counts before anyone has a score: a result row, a quiz link, a content launch that sends a grade, or a lesson link key in $link_keys. $user_id adds that student's grade when it is set.
Parameters
- $context_id : mixed
- $user_id : mixed = 0
- $link_keys : array<int, string> = array()
Return values
array<int, array<string, mixed>>listForContext()
public
static listForContext(mixed $context_id) : array<int, array<string, mixed>>
Parameters
- $context_id : mixed
Return values
array<int, array<string, mixed>>move()
public
static move(mixed $context_id, mixed $category_id, string $direction) : string|null
Parameters
- $context_id : mixed
- $category_id : mixed
- $direction : string
-
up or down
Return values
string|null —Error message, or null on success.
setLinkCategory()
public
static setLinkCategory(mixed $context_id, mixed $link_id, int|null $category_id) : string|null
Parameters
- $context_id : mixed
- $link_id : mixed
- $category_id : int|null
-
Null clears the category.
Return values
string|null —Error message, or null on success.
setLinkHidden()
public
static setLinkHidden(mixed $context_id, mixed $link_id, mixed $hidden) : string|null
Parameters
- $context_id : mixed
- $link_id : mixed
- $hidden : mixed
Return values
string|null —Error message, or null on success.
update()
public
static update(mixed $context_id, mixed $category_id, mixed $title, mixed $percent, mixed $extra_credit) : string|null
Parameters
- $context_id : mixed
- $category_id : mixed
- $title : mixed
- $percent : mixed
- $extra_credit : mixed
Return values
string|null —Error message, or null on success.
categoryInContext()
private
static categoryInContext(mixed $category_id, mixed $context_id) : mixed
Parameters
- $category_id : mixed
- $context_id : mixed
fields()
private
static fields(mixed $title, mixed $percent, mixed $extra_credit) : array{title: string, percent: int, extra_credit: int}|string
Parameters
- $title : mixed
- $percent : mixed
- $extra_credit : mixed
Return values
array{title: string, percent: int, extra_credit: int}|stringlinkInContext()
private
static linkInContext(mixed $link_id, mixed $context_id) : array<string, mixed>|false
Parameters
- $link_id : mixed
- $context_id : mixed
Return values
array<string, mixed>|falseorderedIds()
private
static orderedIds(mixed $context_id) : array<string|int, int>
Parameters
- $context_id : mixed
Return values
array<string|int, int>writeError()
private
static writeError(mixed $q, mixed $duplicate, mixed $failed) : string|null
Parameters
- $q : mixed
- $duplicate : mixed
- $failed : mixed
Return values
string|nullwritePositions()
private
static writePositions(mixed $context_id, array<string|int, int> $ids) : mixed
Parameters
- $context_id : mixed
- $ids : array<string|int, int>