<?php
/**
* InvoiceItem
*
* 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;
/**
* InvoiceItem Class Doc Comment
*
* @category Class
* @description An object representing an item within an invoice.
* @package Xendit
* @implements \ArrayAccess<string, mixed>
*/
class InvoiceItem implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'InvoiceItem';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'name' => 'string',
'price' => 'float',
'quantity' => 'float',
'reference_id' => 'string',
'url' => 'string',
'category' => '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 = [
'name' => null,
'price' => null,
'quantity' => null,
'reference_id' => null,
'url' => null,
'category' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'name' => false,
'price' => false,
'quantity' => false,
'reference_id' => false,
'url' => false,
'category' => false
];
/**
* 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 = [
'name' => 'name',
'price' => 'price',
'quantity' => 'quantity',
'reference_id' => 'reference_id',
'url' => 'url',
'category' => 'category'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'name' => 'setName',
'price' => 'setPrice',
'quantity' => 'setQuantity',
'reference_id' => 'setReferenceId',
'url' => 'setUrl',
'category' => 'setCategory'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'name' => 'getName',
'price' => 'getPrice',
'quantity' => 'getQuantity',
'reference_id' => 'getReferenceId',
'url' => 'getUrl',
'category' => 'getCategory'
];
/**
* 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('name', $data ?? [], null);
$this->setIfExists('price', $data ?? [], null);
$this->setIfExists('quantity', $data ?? [], null);
$this->setIfExists('reference_id', $data ?? [], null);
$this->setIfExists('url', $data ?? [], null);
$this->setIfExists('category', $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 = [];
if ($this->container['name'] === null) {
$invalidProperties[] = "'name' can't be null";
}
if ($this->container['price'] === null) {
$invalidProperties[] = "'price' can't be null";
}
if ($this->container['quantity'] === null) {
$invalidProperties[] = "'quantity' can't be null";
}
if (($this->container['quantity'] <= 0)) {
$invalidProperties[] = "invalid value for 'quantity', must be bigger than 0.";
}
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 name
*
* @return string
*/
public function getName()
{
return $this->container['name'];
}
/**
* Sets name
*
* @param string $name The name of the item.
*
* @return self
*/
public function setName($name)
{
if (is_null($name)) {
throw new \InvalidArgumentException('non-nullable name cannot be null');
}
$this->container['name'] = $name;
return $this;
}
/**
* Gets price
*
* @return float
*/
public function getPrice()
{
return $this->container['price'];
}
/**
* Sets price
*
* @param float $price The price of the item.
*
* @return self
*/
public function setPrice($price)
{
if (is_null($price)) {
throw new \InvalidArgumentException('non-nullable price cannot be null');
}
$this->container['price'] = $price;
return $this;
}
/**
* Gets quantity
*
* @return float
*/
public function getQuantity()
{
return $this->container['quantity'];
}
/**
* Sets quantity
*
* @param float $quantity The quantity of the item. Must be greater than or equal to 0.
*
* @return self
*/
public function setQuantity($quantity)
{
if (is_null($quantity)) {
throw new \InvalidArgumentException('non-nullable quantity cannot be null');
}
if (($quantity <= 0)) {
throw new \InvalidArgumentException('invalid value for $quantity when calling InvoiceItem., must be bigger than 0.');
}
$this->container['quantity'] = $quantity;
return $this;
}
/**
* Gets reference_id
*
* @return string|null
*/
public function getReferenceId()
{
return $this->container['reference_id'];
}
/**
* Sets reference_id
*
* @param string|null $reference_id The reference ID of the item.
*
* @return self
*/
public function setReferenceId($reference_id)
{
if (is_null($reference_id)) {
throw new \InvalidArgumentException('non-nullable reference_id cannot be null');
}
$this->container['reference_id'] = $reference_id;
return $this;
}
/**
* Gets url
*
* @return string|null
*/
public function getUrl()
{
return $this->container['url'];
}
/**
* Sets url
*
* @param string|null $url The URL associated with the item.
*
* @return self
*/
public function setUrl($url)
{
if (is_null($url)) {
throw new \InvalidArgumentException('non-nullable url cannot be null');
}
$this->container['url'] = $url;
return $this;
}
/**
* Gets category
*
* @return string|null
*/
public function getCategory()
{
return $this->container['category'];
}
/**
* Sets category
*
* @param string|null $category The category of the item.
*
* @return self
*/
public function setCategory($category)
{
if (is_null($category)) {
throw new \InvalidArgumentException('non-nullable category cannot be null');
}
$this->container['category'] = $category;
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));
}
}