Documentation

AddressInformationV2
in package
implements ArrayAccess

AddressInformationV2 Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

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)
$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()  : mixed
getAddress1()  : string
Gets address1
getAddress2()  : string
Gets address2
getCity()  : string
Gets city
getCountry()  : string
Gets country
getFax()  : string
Gets fax
getPhone()  : string
Gets phone
getPostalCode()  : string
Gets postal_code
getStateOrProvince()  : string
Gets state_or_province
getters()  : mixed
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()  : mixed
swaggerTypes()  : mixed
valid()  : bool
validate all the properties in the model return true if all passed

Constants

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']

$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']

$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']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'addressInformation_v2'

$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']

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

getPostalCode()

Gets postal_code

public getPostalCode() : string
Return values
string

getStateOrProvince()

Gets state_or_province

public getStateOrProvince() : string
Return values
string

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 $address1) : $this
Parameters
$address1 : string

First Line of the address. Maximum length: 100 characters.

Return values
$this

setAddress2()

Sets address2

public setAddress2(string $address2) : $this
Parameters
$address2 : string

Second Line of the address. Maximum length: 100 characters.

Return values
$this

setCity()

Sets city

public setCity(string $city) : $this
Parameters
$city : string
Return values
$this

setCountry()

Sets country

public setCountry(string $country) : $this
Parameters
$country : string

Specifies the country associated with the address.

Return values
$this

setFax()

Sets fax

public setFax(string $fax) : $this
Parameters
$fax : string
Return values
$this

setPhone()

Sets phone

public setPhone(string $phone) : $this
Parameters
$phone : string
Return values
$this

setPostalCode()

Sets postal_code

public setPostalCode(string $postal_code) : $this
Parameters
$postal_code : string
Return values
$this

setStateOrProvince()

Sets state_or_province

public setStateOrProvince(string $state_or_province) : $this
Parameters
$state_or_province : string

The state or province associated with the address.

Return values
$this

valid()

validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properteis are valid

Search results