UserEnrollment
extends BaseComponent
in package
User Enrollment
Table of Contents
Properties
- $depart_date : string|null
- $depart_reason : string|null
- $enroll_date : string|null
- $firstname : string|null
- $grade_level : GradeLevel
- $graduated : bool|null
- $lastname : string|null
- $name : string|null
- $preferred_last_name : string|null
- $preferred_name : string|null
- $repeated : bool|null
- $school_level : Level
- $school_year : string|null
- $session : string|null
- $user_id : int|null
- $fields : array<string|int, string>
Properties
$depart_date
public
string|null
$depart_date
The date the user departed the school year, ending the enrollment
$depart_reason
public
string|null
$depart_reason
The reason the user departed the school
$enroll_date
public
string|null
$enroll_date
The date the enrollment begins
$firstname
public
string|null
$firstname
The first name of the user
$grade_level
public
GradeLevel
$grade_level
GradeLevel Model
$graduated
public
bool|null
$graduated
Returns true if the user graduated after completing this enrollment year
$lastname
public
string|null
$lastname
The last name of the user
$name
public
string|null
$name
The formatted name of the user
$preferred_last_name
public
string|null
$preferred_last_name
The preferred last name of the user
$preferred_name
public
string|null
$preferred_name
The preferred name of the user
$repeated
public
bool|null
$repeated
Returns true if the user repeated this enrollment
$school_level
public
Level
$school_level
An object with school level information
$school_year
public
string|null
$school_year
The school year the user is enrolled in
$session
public
string|null
$session
The name of the session, if a session is attached to the enrollment
$user_id
public
int|null
$user_id
The id of the user
$fields
protected
static array<string|int, string>
$fields
= ["user_id" => "int", "firstname" => "string", "lastname" => "string", "preferred_name" => "string", "name" => "string", "school_year" => "string", "school_level" => "\\Blackbaud\\SKY\\School\\Components\\Level", "grade_level" => "\\Blackbaud\\SKY\\School\\Components\\GradeLevel", "repeated" => "bool", "graduated" => "bool", "enroll_date" => "string", "depart_date" => "string", "depart_reason" => "string", "session" => "string", "preferred_last_name" => "string"]