blockchain/utils/sdk/client/php/src/BlockTemplateRequestModel.php

<?php
/**
 * BlockTemplateRequestModel
 *
 * PHP version 8.1
 *
 * @package  lthn
 * @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 lthn\lthn;

use ArrayAccess;
use JsonSerializable;
use InvalidArgumentException;
use ReturnTypeWillChange;
use lthn\ObjectSerializer;

/**
 * BlockTemplateRequestModel Class Doc Comment
 *
 * @package  lthn
 * @author   OpenAPI Generator team
 * @link     https://openapi-generator.tech
 * @implements ArrayAccess<string, mixed>
 */
class BlockTemplateRequestModel implements ModelInterface, ArrayAccess, JsonSerializable
{
    public const DISCRIMINATOR = null;

    /**
      * The original name of the model.
      *
      * @var string
      */
    protected static string $openAPIModelName = 'BlockTemplateRequestModel';

    /**
      * Array of property to type mappings. Used for (de)serialization
      *
      * @var array<string, string>
      */
    protected static array $openAPITypes = [
        'miner_address' => 'string',
        'stakeholder_address' => 'string',
        'ex_nonce' => 'string',
        'pos_block' => 'bool',
        'ignore_pow_ts_check' => 'bool',
        'pe' => '\lthn\lthn\PosEntryModel',
        'explicit_txs' => 'string[]'
    ];

    /**
      * Array of property to format mappings. Used for (de)serialization
      *
      * @var array<string, string|null>
      */
    protected static array $openAPIFormats = [
        'miner_address' => null,
        'stakeholder_address' => null,
        'ex_nonce' => null,
        'pos_block' => null,
        'ignore_pow_ts_check' => null,
        'pe' => null,
        'explicit_txs' => null
    ];

    /**
      * Array of nullable properties. Used for (de)serialization
      *
      * @var array<string, bool>
      */
    protected static array $openAPINullables = [
        'miner_address' => false,
        'stakeholder_address' => false,
        'ex_nonce' => false,
        'pos_block' => false,
        'ignore_pow_ts_check' => false,
        'pe' => false,
        'explicit_txs' => 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 = [
        'miner_address' => 'miner_address',
        'stakeholder_address' => 'stakeholder_address',
        'ex_nonce' => 'ex_nonce',
        'pos_block' => 'pos_block',
        'ignore_pow_ts_check' => 'ignore_pow_ts_check',
        'pe' => 'pe',
        'explicit_txs' => 'explicit_txs'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var array<string, string>
     */
    protected static array $setters = [
        'miner_address' => 'setMinerAddress',
        'stakeholder_address' => 'setStakeholderAddress',
        'ex_nonce' => 'setExNonce',
        'pos_block' => 'setPosBlock',
        'ignore_pow_ts_check' => 'setIgnorePowTsCheck',
        'pe' => 'setPe',
        'explicit_txs' => 'setExplicitTxs'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var array<string, string>
     */
    protected static array $getters = [
        'miner_address' => 'getMinerAddress',
        'stakeholder_address' => 'getStakeholderAddress',
        'ex_nonce' => 'getExNonce',
        'pos_block' => 'getPosBlock',
        'ignore_pow_ts_check' => 'getIgnorePowTsCheck',
        'pe' => 'getPe',
        'explicit_txs' => 'getExplicitTxs'
    ];

    /**
     * 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('miner_address', $data ?? [], null);
        $this->setIfExists('stakeholder_address', $data ?? [], null);
        $this->setIfExists('ex_nonce', $data ?? [], null);
        $this->setIfExists('pos_block', $data ?? [], null);
        $this->setIfExists('ignore_pow_ts_check', $data ?? [], null);
        $this->setIfExists('pe', $data ?? [], null);
        $this->setIfExists('explicit_txs', $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 = [];

        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 miner_address
     *
     * @return string|null
     */
    public function getMinerAddress(): ?string
    {
        return $this->container['miner_address'];
    }

    /**
     * Sets miner_address
     *
     * @param string|null $miner_address miner_address
     *
     * @return $this
     */
    public function setMinerAddress(?string $miner_address): static
    {
        if (is_null($miner_address)) {
            throw new InvalidArgumentException('non-nullable miner_address cannot be null');
        }
        $this->container['miner_address'] = $miner_address;

        return $this;
    }

    /**
     * Gets stakeholder_address
     *
     * @return string|null
     */
    public function getStakeholderAddress(): ?string
    {
        return $this->container['stakeholder_address'];
    }

    /**
     * Sets stakeholder_address
     *
     * @param string|null $stakeholder_address stakeholder_address
     *
     * @return $this
     */
    public function setStakeholderAddress(?string $stakeholder_address): static
    {
        if (is_null($stakeholder_address)) {
            throw new InvalidArgumentException('non-nullable stakeholder_address cannot be null');
        }
        $this->container['stakeholder_address'] = $stakeholder_address;

        return $this;
    }

    /**
     * Gets ex_nonce
     *
     * @return string|null
     */
    public function getExNonce(): ?string
    {
        return $this->container['ex_nonce'];
    }

    /**
     * Sets ex_nonce
     *
     * @param string|null $ex_nonce ex_nonce
     *
     * @return $this
     */
    public function setExNonce(?string $ex_nonce): static
    {
        if (is_null($ex_nonce)) {
            throw new InvalidArgumentException('non-nullable ex_nonce cannot be null');
        }
        $this->container['ex_nonce'] = $ex_nonce;

        return $this;
    }

    /**
     * Gets pos_block
     *
     * @return bool|null
     */
    public function getPosBlock(): ?bool
    {
        return $this->container['pos_block'];
    }

    /**
     * Sets pos_block
     *
     * @param bool|null $pos_block pos_block
     *
     * @return $this
     */
    public function setPosBlock(?bool $pos_block): static
    {
        if (is_null($pos_block)) {
            throw new InvalidArgumentException('non-nullable pos_block cannot be null');
        }
        $this->container['pos_block'] = $pos_block;

        return $this;
    }

    /**
     * Gets ignore_pow_ts_check
     *
     * @return bool|null
     */
    public function getIgnorePowTsCheck(): ?bool
    {
        return $this->container['ignore_pow_ts_check'];
    }

    /**
     * Sets ignore_pow_ts_check
     *
     * @param bool|null $ignore_pow_ts_check ignore_pow_ts_check
     *
     * @return $this
     */
    public function setIgnorePowTsCheck(?bool $ignore_pow_ts_check): static
    {
        if (is_null($ignore_pow_ts_check)) {
            throw new InvalidArgumentException('non-nullable ignore_pow_ts_check cannot be null');
        }
        $this->container['ignore_pow_ts_check'] = $ignore_pow_ts_check;

        return $this;
    }

    /**
     * Gets pe
     *
     * @return \lthn\lthn\PosEntryModel|null
     */
    public function getPe(): ?\lthn\lthn\PosEntryModel
    {
        return $this->container['pe'];
    }

    /**
     * Sets pe
     *
     * @param \lthn\lthn\PosEntryModel|null $pe pe
     *
     * @return $this
     */
    public function setPe(?\lthn\lthn\PosEntryModel $pe): static
    {
        if (is_null($pe)) {
            throw new InvalidArgumentException('non-nullable pe cannot be null');
        }
        $this->container['pe'] = $pe;

        return $this;
    }

    /**
     * Gets explicit_txs
     *
     * @return string[]|null
     */
    public function getExplicitTxs(): ?array
    {
        return $this->container['explicit_txs'];
    }

    /**
     * Sets explicit_txs
     *
     * @param string[]|null $explicit_txs explicit_txs
     *
     * @return $this
     */
    public function setExplicitTxs(?array $explicit_txs): static
    {
        if (is_null($explicit_txs)) {
            throw new InvalidArgumentException('non-nullable explicit_txs cannot be null');
        }
        $this->container['explicit_txs'] = $explicit_txs;

        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));
    }
}