UserRead
extends BaseComponent
in package
UserRead Model
Tags
Table of Contents
Properties
- $affiliation : string|null
- $custom_field_eight : string|null
- $custom_field_five : string|null
- $custom_field_four : string|null
- $custom_field_nine : string|null
- $custom_field_one : string|null
- $custom_field_seven : string|null
- $custom_field_six : string|null
- $custom_field_ten : string|null
- $custom_field_three : string|null
- $custom_field_two : string|null
- $deceased : bool
- $display : string|null
- $dob : string|null
- $email : string|null
- $email_active : bool
- $first_name : string|null
- $gender : string|null
- $gender_description : string|null
- $greeting : string|null
- $host_id : string|null
- $id : int
- $last_name : string|null
- $lost : bool
- $maiden_name : string|null
- $middle_name : string|null
- $nick_name : string|null
- $preferred_last_name : string|null
- $preferred_name : string|null
- $prefix : string|null
- $suffix : string|null
- $fields : array<string|int, string>
Properties
$affiliation
public
string|null
$affiliation
The affiliation of a user
$custom_field_eight
public
string|null
$custom_field_eight
A custom field on the user profile (eight of ten)
$custom_field_five
public
string|null
$custom_field_five
A custom field on the user profile (five of ten)
$custom_field_four
public
string|null
$custom_field_four
A custom field on the user profile (four of ten)
$custom_field_nine
public
string|null
$custom_field_nine
A custom field on the user profile (nine of ten)
$custom_field_one
public
string|null
$custom_field_one
A custom field on the user profile (one of ten)
$custom_field_seven
public
string|null
$custom_field_seven
A custom field on the user profile (seven of ten)
$custom_field_six
public
string|null
$custom_field_six
A custom field on the user profile (six of ten)
$custom_field_ten
public
string|null
$custom_field_ten
A custom field on the user profile (ten of ten)
$custom_field_three
public
string|null
$custom_field_three
A custom field on the user profile (three of ten)
$custom_field_two
public
string|null
$custom_field_two
A custom field on the user profile (two of ten)
$deceased
public
bool
$deceased
Returns true if deceased is selected under sensitive information in a personal profile ex: {last_name} {suffix*}, {first_name} {(maidenname*}) {grad_year*} *If not populated fields will not appear (read only)
$display
public
string|null
$display
Display name field generated from first name, last name, nickname, and grad year (read only)
$dob
public
string|null
$dob
Users date of birth
public
string|null
$email
The email address of a user
$email_active
public
bool
$email_active
Returns true if the users e-mail is ok to send to
$first_name
public
string|null
$first_name
The first name of a user
$gender
public
string|null
$gender
The gender of a user
$gender_description
public
string|null
$gender_description
The gender of a user
$greeting
public
string|null
$greeting
The greeting of a user
$host_id
public
string|null
$host_id
The HostId of a user
$id
public
int
$id
The ID associated with a user
$last_name
public
string|null
$last_name
The last name of a user
$lost
public
bool
$lost
Returns true if lost is selected under sensitive information in a personal profile (read only)
$maiden_name
public
string|null
$maiden_name
The maiden name of a user
$middle_name
public
string|null
$middle_name
The middle name of a user
$nick_name
public
string|null
$nick_name
The nickname of a user This field will be deprecated after 90 days.
$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
$prefix
public
string|null
$prefix
The prefix of a user
$suffix
public
string|null
$suffix
The suffix of a user
$fields
protected
static array<string|int, string>
$fields
= ["id" => "int", "affiliation" => "string", "custom_field_eight" => "string", "custom_field_five" => "string", "custom_field_four" => "string", "custom_field_nine" => "string", "custom_field_one" => "string", "custom_field_seven" => "string", "custom_field_six" => "string", "custom_field_ten" => "string", "custom_field_three" => "string", "custom_field_two" => "string", "deceased" => "bool", "display" => "string", "email" => "string", "email_active" => "bool", "first_name" => "string", "gender" => "string", "gender_description" => "string", "greeting" => "string", "host_id" => "string", "last_name" => "string", "lost" => "bool", "maiden_name" => "string", "middle_name" => "string", "nick_name" => "string", "preferred_name" => "string", "preferred_last_name" => "string", "dob" => "string", "prefix" => "string", "suffix" => "string", "profile_pictures" => "\\Blackbaud\\SKY\\School\\Components\\ProfilePictureUrls", "home_languages" => "\\Blackbaud\\SKY\\School\\Components\\HomeLanguageRead[]"]