Documentation

AddressExRead extends BaseComponent
in package

AddressExRead 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
$mailing_address  : bool
$postal_code  : string|null
$primary  : bool
$province  : string|null
$region  : string|null
$salutations  : Salutations
$shared  : bool
$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

$country

public string|null $country

The country for 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

$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

$shared

public bool $shared

Returns true if the address is shared with other users

$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", "mailing_address" => "bool", "postal_code" => "string", "primary" => "bool", "province" => "string", "region" => "string", "shared" => "bool", "state" => "string", "type_id" => "int", "user_id" => "int"]

        
On this page

Search results