<?php
/**
* AddressObject
*
* PHP version 7.4
*
* @category Class
* @package Xendit
*/
/**
* xendit-invoice-service
*
* The version of the OpenAPI document: 1.6.0
*/
/**
* NOTE: This class is auto generated.
* Do not edit the class manually.
*/
namespace Xendit\Invoice;
use \ArrayAccess;
use \Xendit\ObjectSerializer;
use \Xendit\Model\ModelInterface;
/**
* AddressObject Class Doc Comment
*
* @category Class
* @description An object representing an address with various properties.
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class AddressObject implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'AddressObject';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'country' => 'string',
'street_line1' => 'string',
'street_line2' => 'string',
'city' => 'string',
'province' => 'string',
'state' => 'string',
'postal_code' => 'string'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
* @phpstan-var array<string, string|null>
* @psalm-var array<string, string|null>
*/
protected static $openAPIFormats = [
'country' => null,
'street_line1' => null,
'street_line2' => null,
'city' => null,
'province' => null,
'state' => null,
'postal_code' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'country' => true,
'street_line1' => true,
'street_line2' => true,
'city' => true,
'province' => true,
'state' => true,
'postal_code' => true
];
/**
* If a nullable field gets set to null, insert it here
*
* @var boolean[]
*/
protected array $openAPINullablesSetToNull = [];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPITypes()
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPIFormats()
{
return self::$openAPIFormats;
}
/**
* Array of nullable properties
*
* @return array
*/
protected static function openAPINullables(): array
{
return self::$openAPINullables;
}
/**
* Array of nullable field names deliberately set to null
*
* @return boolean[]
*/
private function getOpenAPINullablesSetToNull(): array
{
return $this->openAPINullablesSetToNull;
}
/**
* Setter - Array of nullable field names deliberately set to null
*
* @param boolean[] $openAPINullablesSetToNull
*/
private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
{
$this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
}
/**
* Checks if a property is nullable
*
* @param string $property
* @return bool
*/
public static function isNullable(string $property): bool
{
return self::openAPINullables()[$property] ?? false;
}
/**
* Checks if a nullable property is set to null.
*
* @param string $property
* @return bool
*/
public function isNullableSetToNull(string $property): bool
{
return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @var string[]
*/
protected static $attributeMap = [
'country' => 'country',
'street_line1' => 'street_line1',
'street_line2' => 'street_line2',
'city' => 'city',
'province' => 'province',
'state' => 'state',
'postal_code' => 'postal_code'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'country' => 'setCountry',
'street_line1' => 'setStreetLine1',
'street_line2' => 'setStreetLine2',
'city' => 'setCity',
'province' => 'setProvince',
'state' => 'setState',
'postal_code' => 'setPostalCode'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'country' => 'getCountry',
'street_line1' => 'getStreetLine1',
'street_line2' => 'getStreetLine2',
'city' => 'getCity',
'province' => 'getProvince',
'state' => 'getState',
'postal_code' => 'getPostalCode'
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$openAPIModelName;
}
/**
* Associative array for storing property values
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->setIfExists('country', $data ?? [], null);
$this->setIfExists('street_line1', $data ?? [], null);
$this->setIfExists('street_line2', $data ?? [], null);
$this->setIfExists('city', $data ?? [], null);
$this->setIfExists('province', $data ?? [], null);
$this->setIfExists('state', $data ?? [], null);
$this->setIfExists('postal_code', $data ?? [], null);
}
/**
* Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
* is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
* $this->openAPINullablesSetToNull array
*
* @param string $variableName
* @param array $fields
* @param mixed $defaultValue
*/
private function setIfExists(string $variableName, array $fields, $defaultValue): void
{
if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
$this->openAPINullablesSetToNull[] = $variableName;
}
$this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets country
*
* @return string|null
*/
public function getCountry()
{
return $this->container['country'];
}
/**
* Sets country
*
* @param string|null $country The country where the address is located.
*
* @return self
*/
public function setCountry($country)
{
if (is_null($country)) {
array_push($this->openAPINullablesSetToNull, 'country');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('country', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['country'] = $country;
return $this;
}
/**
* Gets street_line1
*
* @return string|null
*/
public function getStreetLine1()
{
return $this->container['street_line1'];
}
/**
* Sets street_line1
*
* @param string|null $street_line1 The first line of the street address.
*
* @return self
*/
public function setStreetLine1($street_line1)
{
if (is_null($street_line1)) {
array_push($this->openAPINullablesSetToNull, 'street_line1');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('street_line1', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['street_line1'] = $street_line1;
return $this;
}
/**
* Gets street_line2
*
* @return string|null
*/
public function getStreetLine2()
{
return $this->container['street_line2'];
}
/**
* Sets street_line2
*
* @param string|null $street_line2 The second line of the street address.
*
* @return self
*/
public function setStreetLine2($street_line2)
{
if (is_null($street_line2)) {
array_push($this->openAPINullablesSetToNull, 'street_line2');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('street_line2', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['street_line2'] = $street_line2;
return $this;
}
/**
* Gets city
*
* @return string|null
*/
public function getCity()
{
return $this->container['city'];
}
/**
* Sets city
*
* @param string|null $city The city or locality within the address.
*
* @return self
*/
public function setCity($city)
{
if (is_null($city)) {
array_push($this->openAPINullablesSetToNull, 'city');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('city', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['city'] = $city;
return $this;
}
/**
* Gets province
*
* @return string|null
*/
public function getProvince()
{
return $this->container['province'];
}
/**
* Sets province
*
* @param string|null $province The province or region within the country.
*
* @return self
*/
public function setProvince($province)
{
if (is_null($province)) {
array_push($this->openAPINullablesSetToNull, 'province');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('province', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['province'] = $province;
return $this;
}
/**
* Gets state
*
* @return string|null
*/
public function getState()
{
return $this->container['state'];
}
/**
* Sets state
*
* @param string|null $state The state or administrative division within the country.
*
* @return self
*/
public function setState($state)
{
if (is_null($state)) {
array_push($this->openAPINullablesSetToNull, 'state');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('state', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['state'] = $state;
return $this;
}
/**
* Gets postal_code
*
* @return string|null
*/
public function getPostalCode()
{
return $this->container['postal_code'];
}
/**
* Sets postal_code
*
* @param string|null $postal_code The postal code or ZIP code for the address.
*
* @return self
*/
public function setPostalCode($postal_code)
{
if (is_null($postal_code)) {
array_push($this->openAPINullablesSetToNull, 'postal_code');
} else {
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
$index = array_search('postal_code', $nullablesSetToNull);
if ($index !== FALSE) {
unset($nullablesSetToNull[$index]);
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
}
}
$this->container['postal_code'] = $postal_code;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists($offset): bool
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed|null
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->container[$offset] ?? null;
}
/**
* Sets value based on offset.
*
* @param int|null $offset Offset
* @param mixed $value Value to be set
*
* @return void
*/
public function offsetSet($offset, $value): void
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param integer $offset Offset
*
* @return void
*/
public function offsetUnset($offset): void
{
unset($this->container[$offset]);
}
/**
* Serializes the object to a value that can be serialized natively by json_encode().
* @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
*
* @return mixed Returns data which can be serialized by json_encode(), which is a value
* of any type other than a resource.
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return ObjectSerializer::sanitizeForSerialization($this);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}