Address
extends AbstractApiObject
in package
Address class
Tags
Table of Contents
- $id : id
- $required : required
- $care_of : string
- $city : string
- $company : string
- $country : string
- Country as uppercase ISO 3166-1 alpha-2 code.
- $drop_off_point : DropOffPoint
- $email : string
- Corresponding email address. Some carrier will need this to be provided (e.g. to notify the sender/receiver).
- $first_name : string
- $last_name : string
- $phone : string
- Telephone number (mandatory when the following terms apply - when carrier is UPS: service is one_day or one_day_early or ship to country is different than ship from country. Carrier is DHL Express: always provide phone number.).
- $state : string
- $street : string
- $street_no : string
- $zip_code : string
- __construct() : void
- Address constructor.
- get_care_of() : string
- Getter method for care of.
- get_city() : string
- Getter method for city.
- get_company() : string
- Getter method for company.
- get_country() : string
- Getter method for country.
- get_drop_off_point() : DropOffPoint
- Getter method for drop off point.
- get_email() : string
- Getter method for email.
- get_first_name() : string
- Getter method for first name.
- get_id() : string|null
- Getter method for id.
- get_last_name() : string
- Getter method for last name.
- get_phone() : string
- Getter method for phone.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_state() : string
- Getter method for state.
- get_street() : string
- Getter method for street.
- get_street_no() : string
- Getter method for street number.
- get_zip_code() : string
- Getter method for zipcode.
- set_care_of() : void
- Setter method for care of.
- set_city() : void
- Setter method for city.
- set_company() : void
- Setter method for company.
- set_country() : void
- Setter method for country.
- set_drop_off_point() : void
- Setter method for drop off point.
- set_email() : void
- Setter method for email.
- set_first_name() : void
- Setter method for first name.
- set_id() : void
- Setter method for id.
- set_last_name() : void
- Setter method for last name.
- set_phone() : void
- Setter method for phone.
- set_state() : void
- Setter method for state.
- set_street() : void
- Setter method for street.
- set_street_no() : void
- Setter method for street number.
- set_zip_code() : void
- Setter method for zipcode.
- to_array() : array<string|int, mixed>
- Getter method for parameter array.
- to_string() : string
- Getter method for string representation.
Properties
$id
protected
id
$id
$required
protected
required
$required
$care_of
private
string
$care_of
$city
private
string
$city
$company
private
string
$company
$country
Country as uppercase ISO 3166-1 alpha-2 code.
private
string
$country
$drop_off_point
private
DropOffPoint
$drop_off_point
Corresponding email address. Some carrier will need this to be provided (e.g. to notify the sender/receiver).
private
string
$email
$first_name
private
string
$first_name
$last_name
private
string
$last_name
$phone
Telephone number (mandatory when the following terms apply - when carrier is UPS: service is one_day or one_day_early or ship to country is different than ship from country. Carrier is DHL Express: always provide phone number.).
private
string
$phone
$state
private
string
$state
$street
private
string
$street
$street_no
private
string
$street_no
$zip_code
private
string
$zip_code
Methods
__construct()
Address constructor.
public
__construct(string $last_name, string $street, string $street_no, string $city, string $zip_code, string $country) : void
Parameters
- $last_name : string
- $street : string
- $street_no : string
- $city : string
- $zip_code : string
- $country : string
Tags
Return values
void —get_care_of()
Getter method for care of.
public
get_care_of() : string
Return values
string —The care of.
get_city()
Getter method for city.
public
get_city() : string
Return values
string —The city.
get_company()
Getter method for company.
public
get_company() : string
Return values
string —The company.
get_country()
Getter method for country.
public
get_country() : string
Return values
string —The country.
get_drop_off_point()
Getter method for drop off point.
public
get_drop_off_point() : DropOffPoint
Return values
DropOffPoint —The drop off point.
get_email()
Getter method for email.
public
get_email() : string
Return values
string —The email.
get_first_name()
Getter method for first name.
public
get_first_name() : string
Return values
string —The first name.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_last_name()
Getter method for last name.
public
get_last_name() : string
Return values
string —The last name.
get_phone()
Getter method for phone.
public
get_phone() : string
Return values
string —The phone.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_state()
Getter method for state.
public
get_state() : string
Return values
string —The state.
get_street()
Getter method for street.
public
get_street() : string
Return values
string —The street.
get_street_no()
Getter method for street number.
public
get_street_no() : string
Return values
string —The street_no.
get_zip_code()
Getter method for zipcode.
public
get_zip_code() : string
Return values
string —The zipcode.
set_care_of()
Setter method for care of.
public
set_care_of(string $care_of) : void
Parameters
- $care_of : string
-
The care of to set.
Return values
void —set_city()
Setter method for city.
public
set_city(string $city) : void
Parameters
- $city : string
-
The city to set.
Tags
Return values
void —set_company()
Setter method for company.
public
set_company(string $company) : void
Parameters
- $company : string
-
The company to set.
Return values
void —set_country()
Setter method for country.
public
set_country(string $country) : void
Parameters
- $country : string
-
The country to set.
Tags
Return values
void —set_drop_off_point()
Setter method for drop off point.
public
set_drop_off_point(DropOffPoint $drop_off_point) : void
Parameters
- $drop_off_point : DropOffPoint
-
The drop off point to set.
Return values
void —set_email()
Setter method for email.
public
set_email(string $email) : void
Parameters
- $email : string
-
The email to set.
Return values
void —set_first_name()
Setter method for first name.
public
set_first_name(string $first_name) : void
Parameters
- $first_name : string
-
The first name to set.
Return values
void —set_id()
Setter method for id.
public
set_id(string $id) : void
Parameters
- $id : string
-
The id to set.
Return values
void —set_last_name()
Setter method for last name.
public
set_last_name(string $last_name) : void
Parameters
- $last_name : string
-
The last name to set.
Tags
Return values
void —set_phone()
Setter method for phone.
public
set_phone(string $phone) : void
Parameters
- $phone : string
-
The phone to set.
Return values
void —set_state()
Setter method for state.
public
set_state(string $state) : void
Parameters
- $state : string
-
The state to set.
Return values
void —set_street()
Setter method for street.
public
set_street(string $street) : void
Parameters
- $street : string
-
The street to set.
Tags
Return values
void —set_street_no()
Setter method for street number.
public
set_street_no(string $street_no) : void
Parameters
- $street_no : string
-
The street number to set.
Tags
Return values
void —set_zip_code()
Setter method for zipcode.
public
set_zip_code(string $zipcode) : void
Parameters
- $zipcode : string
-
The zipcode to set.
Tags
Return values
void —to_array()
Getter method for parameter array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —The class object as array.
to_string()
Getter method for string representation.
public
to_string() : string
Return values
string —The object as string representation.