UserEnrollmentCreate
extends BaseComponent
in package
Table of Contents
Properties
- $allow_delete : bool
- $allow_edit : bool
- $current_year : bool
- $depart_date : string|null
- $duration_id : int
- $enroll_date : string
- $future_enrollments : bool
- $grade_level_id : int
- $grade_repeated : bool
- $graduated : bool
- $has_grades : bool
- $role_ids : array<string|int, int>
- $school_level_id : int
- $school_year_label : string|null
- $session_id : int
- $user_id : int
- $fields : array<string|int, string>
Properties
$allow_delete
public
bool
$allow_delete
Toggles allow delete
$allow_edit
public
bool
$allow_edit
Toggles allow edit
$current_year
public
bool
$current_year
Toggles current year
$depart_date
public
string|null
$depart_date
Date departed
$duration_id
public
int
$duration_id
The Id of the duration the user should be enrolled in. Optional for all Education Enrollments.
$enroll_date
public
string
$enroll_date
Date of the enrollment
$future_enrollments
public
bool
$future_enrollments
Toggles future enrollments
$grade_level_id
public
int
$grade_level_id
ID of the grade the individual is enrolling in
$grade_repeated
public
bool
$grade_repeated
Toggles grade repeated
$graduated
public
bool
$graduated
Toggles graduated
$has_grades
public
bool
$has_grades
Toggles has grades
$role_ids
public
array<string|int, int>
$role_ids
Collection of RoleIds the individual should be associated to
$school_level_id
public
int
$school_level_id
ID of the school level
$school_year_label
public
string|null
$school_year_label
School Year individual is enrolling in. Defaults to the current school year.
$session_id
public
int
$session_id
The Id of the session the user should be enrolled in. Required for Higher Education Enrollments.
$user_id
public
int
$user_id
ID of the individual to be enrolled
$fields
protected
static array<string|int, string>
$fields
= ["user_id" => "int", "grade_level_id" => "int", "school_level_id" => "int", "school_year_label" => "string", "enroll_date" => "string", "depart_date" => "string", "current_year" => "bool", "has_grades" => "bool", "grade_repeated" => "bool", "graduated" => "bool", "allow_edit" => "bool", "allow_delete" => "bool", "future_enrollments" => "bool", "duration_id" => "int", "session_id" => "int", "role_ids" => "int[]"]