blockchain/utils/sdk/client/php/src/Model/TransactionOutputModel.php
Snider c67fda3cfb Add generated PHP client SDK for blockchain API
Introduces a new PHP client SDK generated via OpenAPI for the Lethean blockchain, including source code, models, API classes, documentation, tests, and configuration files. Updates Makefile to support PHP SDK generation and modifies php.json package configuration.
2025-10-19 15:09:11 +01:00

559 lines
14 KiB
PHP
Generated

<?php
/**
* TransactionOutputModel
*
* PHP version 8.1
*
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
*/
/**
* Lethean Blockchain API
*
* OpenAPI for Lethean Blockchain
*
* The version of the OpenAPI document: 6.0.1
* @generated Generated by: https://openapi-generator.tech
* Generator version: 7.16.0
*/
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace OpenAPI\Client\Model;
use ArrayAccess;
use JsonSerializable;
use InvalidArgumentException;
use ReturnTypeWillChange;
use OpenAPI\Client\ObjectSerializer;
/**
* TransactionOutputModel Class Doc Comment
*
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
* @implements ArrayAccess<string, mixed>
*/
class TransactionOutputModel implements ModelInterface, ArrayAccess, JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static string $openAPIModelName = 'TransactionOutputModel';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var array<string, string>
*/
protected static array $openAPITypes = [
'amount' => 'int',
'global_index' => 'int',
'is_spent' => 'bool',
'minimum_sigs' => 'int',
'pub_keys' => 'string[]'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var array<string, string|null>
*/
protected static array $openAPIFormats = [
'amount' => null,
'global_index' => null,
'is_spent' => null,
'minimum_sigs' => null,
'pub_keys' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var array<string, bool>
*/
protected static array $openAPINullables = [
'amount' => false,
'global_index' => false,
'is_spent' => false,
'minimum_sigs' => false,
'pub_keys' => false
];
/**
* If a nullable field gets set to null, insert it here
*
* @var array<string, bool>
*/
protected array $openAPINullablesSetToNull = [];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array<string, string>
*/
public static function openAPITypes(): array
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array<string, string>
*/
public static function openAPIFormats(): array
{
return self::$openAPIFormats;
}
/**
* Array of nullable properties
*
* @return array<string, bool>
*/
protected static function openAPINullables(): array
{
return self::$openAPINullables;
}
/**
* Array of nullable field names deliberately set to null
*
* @return array<string, bool>
*/
private function getOpenAPINullablesSetToNull(): array
{
return $this->openAPINullablesSetToNull;
}
/**
* Setter - Array of nullable field names deliberately set to null
*
* @param array<string, bool> $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 array<string, string>
*/
protected static array $attributeMap = [
'amount' => 'amount',
'global_index' => 'global_index',
'is_spent' => 'is_spent',
'minimum_sigs' => 'minimum_sigs',
'pub_keys' => 'pub_keys'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var array<string, string>
*/
protected static array $setters = [
'amount' => 'setAmount',
'global_index' => 'setGlobalIndex',
'is_spent' => 'setIsSpent',
'minimum_sigs' => 'setMinimumSigs',
'pub_keys' => 'setPubKeys'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var array<string, string>
*/
protected static array $getters = [
'amount' => 'getAmount',
'global_index' => 'getGlobalIndex',
'is_spent' => 'getIsSpent',
'minimum_sigs' => 'getMinimumSigs',
'pub_keys' => 'getPubKeys'
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @return array<string, string>
*/
public static function attributeMap(): array
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array<string, string>
*/
public static function setters(): array
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array<string, string>
*/
public static function getters(): array
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName(): string
{
return self::$openAPIModelName;
}
/**
* Associative array for storing property values
*
* @var array
*/
protected array $container = [];
/**
* Constructor
*
* @param array $data Associated array of property values initializing the model
*/
public function __construct(?array $data = null)
{
$this->setIfExists('amount', $data ?? [], null);
$this->setIfExists('global_index', $data ?? [], null);
$this->setIfExists('is_spent', $data ?? [], null);
$this->setIfExists('minimum_sigs', $data ?? [], null);
$this->setIfExists('pub_keys', $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, mixed $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 string[] invalid properties with reasons
*/
public function listInvalidProperties(): array
{
$invalidProperties = [];
if (!is_null($this->container['minimum_sigs']) && ($this->container['minimum_sigs'] > 4294967295)) {
$invalidProperties[] = "invalid value for 'minimum_sigs', must be smaller than or equal to 4294967295.";
}
if (!is_null($this->container['minimum_sigs']) && ($this->container['minimum_sigs'] < 0)) {
$invalidProperties[] = "invalid value for 'minimum_sigs', must be bigger than or equal to 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(): bool
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets amount
*
* @return int|null
*/
public function getAmount(): ?int
{
return $this->container['amount'];
}
/**
* Sets amount
*
* @param int|null $amount amount
*
* @return $this
*/
public function setAmount(?int $amount): static
{
if (is_null($amount)) {
throw new InvalidArgumentException('non-nullable amount cannot be null');
}
$this->container['amount'] = $amount;
return $this;
}
/**
* Gets global_index
*
* @return int|null
*/
public function getGlobalIndex(): ?int
{
return $this->container['global_index'];
}
/**
* Sets global_index
*
* @param int|null $global_index global_index
*
* @return $this
*/
public function setGlobalIndex(?int $global_index): static
{
if (is_null($global_index)) {
throw new InvalidArgumentException('non-nullable global_index cannot be null');
}
$this->container['global_index'] = $global_index;
return $this;
}
/**
* Gets is_spent
*
* @return bool|null
*/
public function getIsSpent(): ?bool
{
return $this->container['is_spent'];
}
/**
* Sets is_spent
*
* @param bool|null $is_spent is_spent
*
* @return $this
*/
public function setIsSpent(?bool $is_spent): static
{
if (is_null($is_spent)) {
throw new InvalidArgumentException('non-nullable is_spent cannot be null');
}
$this->container['is_spent'] = $is_spent;
return $this;
}
/**
* Gets minimum_sigs
*
* @return int|null
*/
public function getMinimumSigs(): ?int
{
return $this->container['minimum_sigs'];
}
/**
* Sets minimum_sigs
*
* @param int|null $minimum_sigs minimum_sigs
*
* @return $this
*/
public function setMinimumSigs(?int $minimum_sigs): static
{
if (is_null($minimum_sigs)) {
throw new InvalidArgumentException('non-nullable minimum_sigs cannot be null');
}
if (($minimum_sigs > 4294967295)) {
throw new InvalidArgumentException('invalid value for $minimum_sigs when calling TransactionOutputModel., must be smaller than or equal to 4294967295.');
}
if (($minimum_sigs < 0)) {
throw new InvalidArgumentException('invalid value for $minimum_sigs when calling TransactionOutputModel., must be bigger than or equal to 0.');
}
$this->container['minimum_sigs'] = $minimum_sigs;
return $this;
}
/**
* Gets pub_keys
*
* @return string[]|null
*/
public function getPubKeys(): ?array
{
return $this->container['pub_keys'];
}
/**
* Sets pub_keys
*
* @param string[]|null $pub_keys pub_keys
*
* @return $this
*/
public function setPubKeys(?array $pub_keys): static
{
if (is_null($pub_keys)) {
throw new InvalidArgumentException('non-nullable pub_keys cannot be null');
}
$this->container['pub_keys'] = $pub_keys;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists(mixed $offset): bool
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed|null
*/
#[ReturnTypeWillChange]
public function offsetGet(mixed $offset): mixed
{
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(mixed $offset, mixed $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(mixed $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(): mixed
{
return ObjectSerializer::sanitizeForSerialization($this);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString(): string
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue(): string
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}