AddressInformation
in package
implements
ModelInterface, ArrayAccess
AddressInformation Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAddress1() : string|null
- Gets address1
- getAddress2() : string|null
- Gets address2
- getCity() : string|null
- Gets city
- getCountry() : string|null
- Gets country
- getFax() : string|null
- Gets fax
- getModelName() : string
- The original name of the model.
- getPhone() : string|null
- Gets phone
- getPostalCode() : string|null
- Gets postal_code
- getStateOrProvince() : string|null
- Gets state_or_province
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getZipPlus4() : string|null
- Gets zip_plus4
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAddress1() : $this
- Sets address1
- setAddress2() : $this
- Sets address2
- setCity() : $this
- Sets city
- setCountry() : $this
- Sets country
- setFax() : $this
- Sets fax
- setPhone() : $this
- Sets phone
- setPostalCode() : $this
- Sets postal_code
- setStateOrProvince() : $this
- Sets state_or_province
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setZipPlus4() : $this
- Sets zip_plus4
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['address1' => 'address1', 'address2' => 'address2', 'city' => 'city', 'country' => 'country', 'fax' => 'fax', 'phone' => 'phone', 'postal_code' => 'postalCode', 'state_or_province' => 'stateOrProvince', 'zip_plus4' => 'zipPlus4']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['address1' => 'getAddress1', 'address2' => 'getAddress2', 'city' => 'getCity', 'country' => 'getCountry', 'fax' => 'getFax', 'phone' => 'getPhone', 'postal_code' => 'getPostalCode', 'state_or_province' => 'getStateOrProvince', 'zip_plus4' => 'getZipPlus4']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['address1' => 'setAddress1', 'address2' => 'setAddress2', 'city' => 'setCity', 'country' => 'setCountry', 'fax' => 'setFax', 'phone' => 'setPhone', 'postal_code' => 'setPostalCode', 'state_or_province' => 'setStateOrProvince', 'zip_plus4' => 'setZipPlus4']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['address1' => null, 'address2' => null, 'city' => null, 'country' => null, 'fax' => null, 'phone' => null, 'postal_code' => null, 'state_or_province' => null, 'zip_plus4' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'addressInformation'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['address1' => '?string', 'address2' => '?string', 'city' => '?string', 'country' => '?string', 'fax' => '?string', 'phone' => '?string', 'postal_code' => '?string', 'state_or_province' => '?string', 'zip_plus4' => '?string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAddress1()
Gets address1
public
getAddress1() : string|null
Return values
string|null —getAddress2()
Gets address2
public
getAddress2() : string|null
Return values
string|null —getCity()
Gets city
public
getCity() : string|null
Return values
string|null —getCountry()
Gets country
public
getCountry() : string|null
Return values
string|null —getFax()
Gets fax
public
getFax() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhone()
Gets phone
public
getPhone() : string|null
Return values
string|null —getPostalCode()
Gets postal_code
public
getPostalCode() : string|null
Return values
string|null —getStateOrProvince()
Gets state_or_province
public
getStateOrProvince() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getZipPlus4()
Gets zip_plus4
public
getZipPlus4() : string|null
Return values
string|null —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAddress1()
Sets address1
public
setAddress1(string|null $address1) : $this
Parameters
- $address1 : string|null
-
First Line of the address. Maximum length: 100 characters.
Return values
$this —setAddress2()
Sets address2
public
setAddress2(string|null $address2) : $this
Parameters
- $address2 : string|null
-
Second Line of the address. Maximum length: 100 characters.
Return values
$this —setCity()
Sets city
public
setCity(string|null $city) : $this
Parameters
- $city : string|null
-
The city associated with the address.
Return values
$this —setCountry()
Sets country
public
setCountry(string|null $country) : $this
Parameters
- $country : string|null
-
Specifies the country associated with the address.
Return values
$this —setFax()
Sets fax
public
setFax(string|null $fax) : $this
Parameters
- $fax : string|null
-
A Fax number associated with the address if one is available.
Return values
$this —setPhone()
Sets phone
public
setPhone(string|null $phone) : $this
Parameters
- $phone : string|null
-
A phone number associated with the address.
Return values
$this —setPostalCode()
Sets postal_code
public
setPostalCode(string|null $postal_code) : $this
Parameters
- $postal_code : string|null
Return values
$this —setStateOrProvince()
Sets state_or_province
public
setStateOrProvince(string|null $state_or_province) : $this
Parameters
- $state_or_province : string|null
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setZipPlus4()
Sets zip_plus4
public
setZipPlus4(string|null $zip_plus4) : $this
Parameters
- $zip_plus4 : string|null
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid