mint/api-test/client/lib/Model/PostApiV3DiscussionsRequest.php

<?php
/**
 * PostApiV3DiscussionsRequest
 *
 * PHP version 8.1
 *
 * @category Class
 * @package  WikipaliApi
 * @author   OpenAPI Generator team
 * @link     https://openapi-generator.tech
 */

/**
 * MINT API
 *
 * International Academy Of Pali Tipitaka(国际巴利三藏学院)  由 `php openapi/scripts/generate.php` 依据 api-v13 的路由与控制器源码生成。 响应统一封装为 `{ok, message, data}`；`ok=false` 时 `message` 为错误信息。
 *
 * The version of the OpenAPI document: 2026.10.21
 * Generated by: https://openapi-generator.tech
 * Generator version: 7.25.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 WikipaliApi\Model;

use \ArrayAccess;
use \WikipaliApi\ObjectSerializer;

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

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

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @var string[]
     */
    protected static $openAPITypes = [
        'target_type' => 'string',
        'target_id' => 'string',
        'type' => 'string',
        'title' => 'string',
        'content' => 'string',
        'severity' => 'string',
        'pos_start' => 'int',
        'pos_end' => 'int',
        'quote_exact' => 'string',
        'quote_prefix' => 'string',
        'quote_suffix' => 'string',
        'tpl_id' => 'string',
        'notify' => 'bool'
    ];

    /**
     * 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 = [
        'target_type' => null,
        'target_id' => null,
        'type' => null,
        'title' => null,
        'content' => null,
        'severity' => null,
        'pos_start' => null,
        'pos_end' => null,
        'quote_exact' => null,
        'quote_prefix' => null,
        'quote_suffix' => null,
        'tpl_id' => null,
        'notify' => null
    ];

    /**
     * Array of nullable properties. Used for (de)serialization
     *
     * @var boolean[]
     */
    protected static array $openAPINullables = [
        'target_type' => false,
        'target_id' => false,
        'type' => false,
        'title' => false,
        'content' => false,
        'severity' => false,
        'pos_start' => false,
        'pos_end' => false,
        'quote_exact' => false,
        'quote_prefix' => false,
        'quote_suffix' => false,
        'tpl_id' => false,
        'notify' => 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 = [
        'target_type' => 'target_type',
        'target_id' => 'target_id',
        'type' => 'type',
        'title' => 'title',
        'content' => 'content',
        'severity' => 'severity',
        'pos_start' => 'pos_start',
        'pos_end' => 'pos_end',
        'quote_exact' => 'quote_exact',
        'quote_prefix' => 'quote_prefix',
        'quote_suffix' => 'quote_suffix',
        'tpl_id' => 'tpl_id',
        'notify' => 'notify'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'target_type' => 'setTargetType',
        'target_id' => 'setTargetId',
        'type' => 'setType',
        'title' => 'setTitle',
        'content' => 'setContent',
        'severity' => 'setSeverity',
        'pos_start' => 'setPosStart',
        'pos_end' => 'setPosEnd',
        'quote_exact' => 'setQuoteExact',
        'quote_prefix' => 'setQuotePrefix',
        'quote_suffix' => 'setQuoteSuffix',
        'tpl_id' => 'setTplId',
        'notify' => 'setNotify'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'target_type' => 'getTargetType',
        'target_id' => 'getTargetId',
        'type' => 'getType',
        'title' => 'getTitle',
        'content' => 'getContent',
        'severity' => 'getSeverity',
        'pos_start' => 'getPosStart',
        'pos_end' => 'getPosEnd',
        'quote_exact' => 'getQuoteExact',
        'quote_prefix' => 'getQuotePrefix',
        'quote_suffix' => 'getQuoteSuffix',
        'tpl_id' => 'getTplId',
        'notify' => 'getNotify'
    ];

    /**
     * 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;
    }

    public const TARGET_TYPE_SENTENCE = 'sentence';
    public const TARGET_TYPE_WBW = 'wbw';
    public const TARGET_TYPE_ARTICLE = 'article';
    public const TARGET_TYPE_TERM = 'term';
    public const TARGET_TYPE_TASK = 'task';
    public const TYPE_DISCUSSION = 'discussion';
    public const TYPE_QA = 'qa';
    public const TYPE_HELP = 'help';
    public const TYPE_ISSUE = 'issue';
    public const TYPE_GLOSSARY = 'glossary';
    public const TYPE_NOTE = 'note';
    public const TYPE_COMMENTARY = 'commentary';
    public const SEVERITY_ERROR = 'error';
    public const SEVERITY_WARNING = 'warning';
    public const SEVERITY_SUGGESTION = 'suggestion';
    public const SEVERITY_URGENT = 'urgent';
    public const SEVERITY_NORMAL = 'normal';

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getTargetTypeAllowableValues()
    {
        return [
            self::TARGET_TYPE_SENTENCE,
            self::TARGET_TYPE_WBW,
            self::TARGET_TYPE_ARTICLE,
            self::TARGET_TYPE_TERM,
            self::TARGET_TYPE_TASK,
        ];
    }

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getTypeAllowableValues()
    {
        return [
            self::TYPE_DISCUSSION,
            self::TYPE_QA,
            self::TYPE_HELP,
            self::TYPE_ISSUE,
            self::TYPE_GLOSSARY,
            self::TYPE_NOTE,
            self::TYPE_COMMENTARY,
        ];
    }

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getSeverityAllowableValues()
    {
        return [
            self::SEVERITY_ERROR,
            self::SEVERITY_WARNING,
            self::SEVERITY_SUGGESTION,
            self::SEVERITY_URGENT,
            self::SEVERITY_NORMAL,
        ];
    }

    /**
     * Associative array for storing property values
     *
     * @var mixed[]
     */
    protected $container = [];

    /**
     * Constructor
     *
     * @param mixed[]|null $data Associated array of property values
     *                      initializing the model
     */
    public function __construct(?array $data = null)
    {
        $this->setIfExists('target_type', $data ?? [], null);
        $this->setIfExists('target_id', $data ?? [], null);
        $this->setIfExists('type', $data ?? [], 'discussion');
        $this->setIfExists('title', $data ?? [], null);
        $this->setIfExists('content', $data ?? [], null);
        $this->setIfExists('severity', $data ?? [], null);
        $this->setIfExists('pos_start', $data ?? [], null);
        $this->setIfExists('pos_end', $data ?? [], null);
        $this->setIfExists('quote_exact', $data ?? [], null);
        $this->setIfExists('quote_prefix', $data ?? [], null);
        $this->setIfExists('quote_suffix', $data ?? [], null);
        $this->setIfExists('tpl_id', $data ?? [], null);
        $this->setIfExists('notify', $data ?? [], true);
    }

    /**
     * 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['target_type'] === null) {
            $invalidProperties[] = "'target_type' can't be null";
        }
        $allowedValues = $this->getTargetTypeAllowableValues();
        if (!is_null($this->container['target_type']) && !in_array($this->container['target_type'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'target_type', must be one of '%s'",
                $this->container['target_type'],
                implode("', '", $allowedValues)
            );
        }

        if ($this->container['target_id'] === null) {
            $invalidProperties[] = "'target_id' can't be null";
        }
        $allowedValues = $this->getTypeAllowableValues();
        if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'type', must be one of '%s'",
                $this->container['type'],
                implode("', '", $allowedValues)
            );
        }

        $allowedValues = $this->getSeverityAllowableValues();
        if (!is_null($this->container['severity']) && !in_array($this->container['severity'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'severity', must be one of '%s'",
                $this->container['severity'],
                implode("', '", $allowedValues)
            );
        }

        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 target_type
     *
     * @return string
     */
    public function getTargetType()
    {
        return $this->container['target_type'];
    }

    /**
     * Sets target_type
     *
     * @param string $target_type 挂靠对象的类型
     *
     * @return self
     */
    public function setTargetType($target_type)
    {
        if (is_null($target_type)) {
            throw new \InvalidArgumentException('non-nullable target_type cannot be null');
        }
        $allowedValues = $this->getTargetTypeAllowableValues();
        if (!in_array($target_type, $allowedValues, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    "Invalid value '%s' for 'target_type', must be one of '%s'",
                    $target_type,
                    implode("', '", $allowedValues)
                )
            );
        }
        $this->container['target_type'] = $target_type;

        return $this;
    }

    /**
     * Gets target_id
     *
     * @return string
     */
    public function getTargetId()
    {
        return $this->container['target_id'];
    }

    /**
     * Sets target_id
     *
     * @param string $target_id 挂靠对象的 uuid
     *
     * @return self
     */
    public function setTargetId($target_id)
    {
        if (is_null($target_id)) {
            throw new \InvalidArgumentException('non-nullable target_id cannot be null');
        }
        $this->container['target_id'] = $target_id;

        return $this;
    }

    /**
     * Gets type
     *
     * @return string|null
     */
    public function getType()
    {
        return $this->container['type'];
    }

    /**
     * Sets type
     *
     * @param string|null $type 类型
     *
     * @return self
     */
    public function setType($type)
    {
        if (is_null($type)) {
            throw new \InvalidArgumentException('non-nullable type cannot be null');
        }
        $allowedValues = $this->getTypeAllowableValues();
        if (!in_array($type, $allowedValues, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    "Invalid value '%s' for 'type', must be one of '%s'",
                    $type,
                    implode("', '", $allowedValues)
                )
            );
        }
        $this->container['type'] = $type;

        return $this;
    }

    /**
     * Gets title
     *
     * @return string|null
     */
    public function getTitle()
    {
        return $this->container['title'];
    }

    /**
     * Sets title
     *
     * @param string|null $title 标题，最长 256 字符；评论线程必填（glossary 填术语词头），批注可省
     *
     * @return self
     */
    public function setTitle($title)
    {
        if (is_null($title)) {
            throw new \InvalidArgumentException('non-nullable title cannot be null');
        }
        $this->container['title'] = $title;

        return $this;
    }

    /**
     * Gets content
     *
     * @return string|null
     */
    public function getContent()
    {
        return $this->container['content'];
    }

    /**
     * Sets content
     *
     * @param string|null $content 正文（markdown）；批注必填
     *
     * @return self
     */
    public function setContent($content)
    {
        if (is_null($content)) {
            throw new \InvalidArgumentException('non-nullable content cannot be null');
        }
        $this->container['content'] = $content;

        return $this;
    }

    /**
     * Gets severity
     *
     * @return string|null
     */
    public function getSeverity()
    {
        return $this->container['severity'];
    }

    /**
     * Sets severity
     *
     * @param string|null $severity 严重程度
     *
     * @return self
     */
    public function setSeverity($severity)
    {
        if (is_null($severity)) {
            throw new \InvalidArgumentException('non-nullable severity cannot be null');
        }
        $allowedValues = $this->getSeverityAllowableValues();
        if (!in_array($severity, $allowedValues, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    "Invalid value '%s' for 'severity', must be one of '%s'",
                    $severity,
                    implode("', '", $allowedValues)
                )
            );
        }
        $this->container['severity'] = $severity;

        return $this;
    }

    /**
     * Gets pos_start
     *
     * @return int|null
     */
    public function getPosStart()
    {
        return $this->container['pos_start'];
    }

    /**
     * Sets pos_start
     *
     * @param int|null $pos_start 锚点在句子文本中的起始偏移（只限 note / commentary / issue / glossary）
     *
     * @return self
     */
    public function setPosStart($pos_start)
    {
        if (is_null($pos_start)) {
            throw new \InvalidArgumentException('non-nullable pos_start cannot be null');
        }
        $this->container['pos_start'] = $pos_start;

        return $this;
    }

    /**
     * Gets pos_end
     *
     * @return int|null
     */
    public function getPosEnd()
    {
        return $this->container['pos_end'];
    }

    /**
     * Sets pos_end
     *
     * @param int|null $pos_end 锚点的结束偏移，批注插在这里（只限 note / commentary / issue / glossary）
     *
     * @return self
     */
    public function setPosEnd($pos_end)
    {
        if (is_null($pos_end)) {
            throw new \InvalidArgumentException('non-nullable pos_end cannot be null');
        }
        $this->container['pos_end'] = $pos_end;

        return $this;
    }

    /**
     * Gets quote_exact
     *
     * @return string|null
     */
    public function getQuoteExact()
    {
        return $this->container['quote_exact'];
    }

    /**
     * Sets quote_exact
     *
     * @param string|null $quote_exact 锚定的原文片段（只限 note / commentary / issue / glossary）
     *
     * @return self
     */
    public function setQuoteExact($quote_exact)
    {
        if (is_null($quote_exact)) {
            throw new \InvalidArgumentException('non-nullable quote_exact cannot be null');
        }
        $this->container['quote_exact'] = $quote_exact;

        return $this;
    }

    /**
     * Gets quote_prefix
     *
     * @return string|null
     */
    public function getQuotePrefix()
    {
        return $this->container['quote_prefix'];
    }

    /**
     * Sets quote_prefix
     *
     * @param string|null $quote_prefix 锚定片段前的上下文，用于重新定位（只限 note / commentary / issue / glossary）
     *
     * @return self
     */
    public function setQuotePrefix($quote_prefix)
    {
        if (is_null($quote_prefix)) {
            throw new \InvalidArgumentException('non-nullable quote_prefix cannot be null');
        }
        $this->container['quote_prefix'] = $quote_prefix;

        return $this;
    }

    /**
     * Gets quote_suffix
     *
     * @return string|null
     */
    public function getQuoteSuffix()
    {
        return $this->container['quote_suffix'];
    }

    /**
     * Sets quote_suffix
     *
     * @param string|null $quote_suffix 锚定片段后的上下文，用于重新定位（只限 note / commentary / issue / glossary）
     *
     * @return self
     */
    public function setQuoteSuffix($quote_suffix)
    {
        if (is_null($quote_suffix)) {
            throw new \InvalidArgumentException('non-nullable quote_suffix cannot be null');
        }
        $this->container['quote_suffix'] = $quote_suffix;

        return $this;
    }

    /**
     * Gets tpl_id
     *
     * @return string|null
     */
    public function getTplId()
    {
        return $this->container['tpl_id'];
    }

    /**
     * Sets tpl_id
     *
     * @param string|null $tpl_id 话题模板（文章）的 uuid
     *
     * @return self
     */
    public function setTplId($tpl_id)
    {
        if (is_null($tpl_id)) {
            throw new \InvalidArgumentException('non-nullable tpl_id cannot be null');
        }
        $this->container['tpl_id'] = $tpl_id;

        return $this;
    }

    /**
     * Gets notify
     *
     * @return bool|null
     */
    public function getNotify()
    {
        return $this->container['notify'];
    }

    /**
     * Sets notify
     *
     * @param bool|null $notify 是否发通知（批注不发）
     *
     * @return self
     */
    public function setNotify($notify)
    {
        if (is_null($notify)) {
            throw new \InvalidArgumentException('non-nullable notify cannot be null');
        }
        $this->container['notify'] = $notify;

        return $this;
    }
    /**
     * Returns true if offset exists. False otherwise.
     *
     * @param integer|string $offset Offset
     *
     * @return boolean
     */
    public function offsetExists(mixed $offset): bool
    {
        return isset($this->container[$offset]);
    }

    /**
     * Gets offset.
     *
     * @param integer|string $offset Offset
     *
     * @return mixed|null
     */
    #[\ReturnTypeWillChange]
    public function offsetGet(mixed $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|string $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()
    {
       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));
    }
}