AddressRead
extends BaseComponent
in package
AddressRead Model
Table of Contents
Properties
- $address_type : string|null
- $city : string|null
- $country : string|null
- $id : int
- $line_one : string|null
- $line_three : string|null
- $line_two : string|null
- $links : array<string|int, AddressTypeLink>|null
- $mailing_address : bool
- $postal_code : string|null
- $primary : bool
- $province : string|null
- $region : string|null
- $salutations : Salutations
- $state : string|null
- $type_id : int|null
- $user_id : int|null
- $fields : array<string|int, string>
Properties
$address_type
public
string|null
$address_type
The 'Type' of the address
$city
public
string|null
$city
The city for the address
$country
public
string|null
$country
The country for the address
$id
public
int
$id
The ID of the address
$line_one
public
string|null
$line_one
The first line of the address
$line_three
public
string|null
$line_three
The third line of the address
$line_two
public
string|null
$line_two
The second line of the address
$links
public
array<string|int, AddressTypeLink>|null
$links
Returns each instance of an address type for each relationship to the user
$mailing_address
public
bool
$mailing_address
Returns True if user accepts mail from the address
$postal_code
public
string|null
$postal_code
The postal code for the address
$primary
public
bool
$primary
Returns true if the address is primary
$province
public
string|null
$province
The province for the address
$region
public
string|null
$region
The region for the address
$salutations
public
Salutations
$salutations
Salutations Model
$state
public
string|null
$state
The state for the address
$type_id
public
int|null
$type_id
The type ID associated with an address that is based upon a user's primary relationship to the address
$user_id
public
int|null
$user_id
The ID of the user of the address
$fields
protected
static array<string|int, string>
$fields
= ["id" => "int", "address_type" => "string", "salutations" => "\\Blackbaud\\SKY\\School\\Components\\Salutations", "city" => "string", "country" => "string", "line_one" => "string", "line_three" => "string", "line_two" => "string", "links" => "\\Blackbaud\\SKY\\School\\Components\\AddressTypeLink[]", "mailing_address" => "bool", "postal_code" => "string", "primary" => "bool", "province" => "string", "region" => "string", "state" => "string", "type_id" => "int", "user_id" => "int"]