DirectoryResult
extends BaseComponent
in package
Directory Result Model
Table of Contents
Properties
- $address_line1 : string|null
- $address_line2 : string|null
- $address_line3 : string|null
- $cell_phone : string|null
- $child_names : string|null
- $city : string|null
- $country : string|null
- $deceased : bool|null
- $department : string|null
- $department_display : string|null
- $email : string|null
- $first_name : string|null
- $grad_year : string|null
- $grade : string|null
- $grade_display : string|null
- $grade_numeric : int|null
- $grade_numeric_display : string|null
- $has_relationships : bool|null
- $home_phone : string|null
- $home_phone2 : string|null
- $job_title : string|null
- $last_name : string|null
- $maiden_name : string|null
- $middlename : string|null
- $office_phone : string|null
- $preferred_address_id : int|null
- $preferred_address_lat : float|null
- $preferred_address_lng : float|null
- $preferred_name : string|null
- $prefix : string|null
- $profile_photo : string|null
- $spouse_id : int|null
- $state : string|null
- $student : bool|null
- $suffix : string|null
- $total_count : int|null
- $user_id : int|null
- $zip : string|null
- $fields : array<string|int, string>
Properties
$address_line1
public
string|null
$address_line1
The first line of the user address
$address_line2
public
string|null
$address_line2
The second line of the user address
$address_line3
public
string|null
$address_line3
The third line of the user address
$cell_phone
public
string|null
$cell_phone
The user's cell phone number
$child_names
public
string|null
$child_names
The user's children
$city
public
string|null
$city
The city the user lives in
$country
public
string|null
$country
The country the user lives in
$deceased
public
bool|null
$deceased
Returns true if the user is deceased
$department
public
string|null
$department
The department the user belongs to
$department_display
public
string|null
$department_display
How the user's department should be displayed
public
string|null
$email
The email address of the user
$first_name
public
string|null
$first_name
The first name of the user
$grad_year
public
string|null
$grad_year
The user's graduation year
$grade
public
string|null
$grade
The user's grade
$grade_display
public
string|null
$grade_display
Grade display
$grade_numeric
public
int|null
$grade_numeric
The numeric grade of the user
$grade_numeric_display
public
string|null
$grade_numeric_display
The way the numeric grade should be displayed
$has_relationships
public
bool|null
$has_relationships
Returns true if the user has relationships
$home_phone
public
string|null
$home_phone
The user's home phone number
$home_phone2
public
string|null
$home_phone2
The user's secondary home phone number
$job_title
public
string|null
$job_title
The user's job title
$last_name
public
string|null
$last_name
The last name of the user
$maiden_name
public
string|null
$maiden_name
The user's maiden name
$middlename
public
string|null
$middlename
The user's middle name
$office_phone
public
string|null
$office_phone
The user's office phone number
$preferred_address_id
public
int|null
$preferred_address_id
The Id of the preferred address for the user
$preferred_address_lat
public
float|null
$preferred_address_lat
Preferred address latitude
$preferred_address_lng
public
float|null
$preferred_address_lng
Preferred address longitude
$preferred_name
public
string|null
$preferred_name
The user's preferred name
$prefix
public
string|null
$prefix
The user's prefix
$profile_photo
public
string|null
$profile_photo
The user's profile photo
$spouse_id
public
int|null
$spouse_id
The Id of the user's spouse
$state
public
string|null
$state
The state the user lives in
$student
public
bool|null
$student
Returns true if the user is a student
$suffix
public
string|null
$suffix
The user's suffix
$total_count
public
int|null
$total_count
The total count of records
$user_id
public
int|null
$user_id
The Id of the user
$zip
public
string|null
$zip
The zip code the user lives in
$fields
protected
static array<string|int, string>
$fields
= ["user_id" => "int", "first_name" => "string", "last_name" => "string", "email" => "string", "address_line1" => "string", "address_line2" => "string", "address_line3" => "string", "city" => "string", "state" => "string", "zip" => "string", "country" => "string", "home_phone" => "string", "cell_phone" => "string", "office_phone" => "string", "home_phone2" => "string", "has_relationships" => "bool", "prefix" => "string", "preferred_name" => "string", "profile_photo" => "string", "middlename" => "string", "maiden_name" => "string", "suffix" => "string", "grad_year" => "string", "grade" => "string", "grade_display" => "string", "department" => "string", "department_display" => "string", "spouse_id" => "int", "child_names" => "string", "grade_numeric" => "int", "grade_numeric_display" => "string", "total_count" => "int", "deceased" => "bool", "student" => "bool", "preferred_address_id" => "int", "preferred_address_lat" => "float", "preferred_address_lng" => "float", "job_title" => "string"]