OutcomeRating
in package
OutcomeRating object for rating scale definitions.
This is a read-only object that represents a single rating level within an outcome's rating scale.
Table of Contents
Properties
- $color : string|null
- $description : string|null
- $id : int|null
- $mastery : bool|null
- $points : float|null
Methods
- __construct() : mixed
- Create an OutcomeRating instance.
- create() : self
- Create a rating from simple data.
- isMastery() : bool
- Check if this rating represents mastery level.
- toArray() : array<string, mixed>
- Convert to array for API requests.
Properties
$color
public
string|null
$color
= null
$description
public
string|null
$description
= null
$id
public
int|null
$id
= null
$mastery
public
bool|null
$mastery
= null
$points
public
float|null
$points
= null
Methods
__construct()
Create an OutcomeRating instance.
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
create()
Create a rating from simple data.
public
static create(string $description, float $points[, bool $mastery = false ]) : self
Parameters
- $description : string
- $points : float
- $mastery : bool = false
Return values
selfisMastery()
Check if this rating represents mastery level.
public
isMastery() : bool
Return values
booltoArray()
Convert to array for API requests.
public
toArray() : array<string, mixed>