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

<?php
/**
 * PostApiV3SearchRequest
 *
 * 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.9.28
 * 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;

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

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

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @var string[]
     */
    protected static $openAPITypes = [
        'q' => 'string',
        'search_mode' => 'string',
        'resource_type' => 'string',
        'granularity' => 'string',
        'language' => 'string',
        'category' => 'string',
        'tags' => 'string',
        'page_refs' => 'string[]',
        'related_id' => 'string[]',
        'author' => 'string',
        'channel' => 'string',
        'page' => 'int',
        'page_size' => 'int'
    ];

    /**
     * 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 = [
        'q' => null,
        'search_mode' => null,
        'resource_type' => null,
        'granularity' => null,
        'language' => null,
        'category' => null,
        'tags' => null,
        'page_refs' => null,
        'related_id' => null,
        'author' => null,
        'channel' => null,
        'page' => null,
        'page_size' => null
    ];

    /**
     * Array of nullable properties. Used for (de)serialization
     *
     * @var boolean[]
     */
    protected static array $openAPINullables = [
        'q' => false,
        'search_mode' => false,
        'resource_type' => false,
        'granularity' => false,
        'language' => false,
        'category' => false,
        'tags' => false,
        'page_refs' => false,
        'related_id' => false,
        'author' => false,
        'channel' => false,
        'page' => false,
        'page_size' => 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 = [
        'q' => 'q',
        'search_mode' => 'search_mode',
        'resource_type' => 'resource_type',
        'granularity' => 'granularity',
        'language' => 'language',
        'category' => 'category',
        'tags' => 'tags',
        'page_refs' => 'page_refs',
        'related_id' => 'related_id',
        'author' => 'author',
        'channel' => 'channel',
        'page' => 'page',
        'page_size' => 'page_size'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'q' => 'setQ',
        'search_mode' => 'setSearchMode',
        'resource_type' => 'setResourceType',
        'granularity' => 'setGranularity',
        'language' => 'setLanguage',
        'category' => 'setCategory',
        'tags' => 'setTags',
        'page_refs' => 'setPageRefs',
        'related_id' => 'setRelatedId',
        'author' => 'setAuthor',
        'channel' => 'setChannel',
        'page' => 'setPage',
        'page_size' => 'setPageSize'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'q' => 'getQ',
        'search_mode' => 'getSearchMode',
        'resource_type' => 'getResourceType',
        'granularity' => 'getGranularity',
        'language' => 'getLanguage',
        'category' => 'getCategory',
        'tags' => 'getTags',
        'page_refs' => 'getPageRefs',
        'related_id' => 'getRelatedId',
        'author' => 'getAuthor',
        'channel' => 'getChannel',
        'page' => 'getPage',
        'page_size' => 'getPageSize'
    ];

    /**
     * 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 SEARCH_MODE_FUZZY = 'fuzzy';
    public const SEARCH_MODE_EXACT = 'exact';
    public const SEARCH_MODE_SEMANTIC = 'semantic';
    public const SEARCH_MODE_HYBRID = 'hybrid';

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getSearchModeAllowableValues()
    {
        return [
            self::SEARCH_MODE_FUZZY,
            self::SEARCH_MODE_EXACT,
            self::SEARCH_MODE_SEMANTIC,
            self::SEARCH_MODE_HYBRID,
        ];
    }

    /**
     * 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('q', $data ?? [], null);
        $this->setIfExists('search_mode', $data ?? [], 'fuzzy');
        $this->setIfExists('resource_type', $data ?? [], null);
        $this->setIfExists('granularity', $data ?? [], null);
        $this->setIfExists('language', $data ?? [], null);
        $this->setIfExists('category', $data ?? [], null);
        $this->setIfExists('tags', $data ?? [], null);
        $this->setIfExists('page_refs', $data ?? [], null);
        $this->setIfExists('related_id', $data ?? [], null);
        $this->setIfExists('author', $data ?? [], null);
        $this->setIfExists('channel', $data ?? [], null);
        $this->setIfExists('page', $data ?? [], 1);
        $this->setIfExists('page_size', $data ?? [], 20);
    }

    /**
     * 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['q'] === null) {
            $invalidProperties[] = "'q' can't be null";
        }
        $allowedValues = $this->getSearchModeAllowableValues();
        if (!is_null($this->container['search_mode']) && !in_array($this->container['search_mode'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'search_mode', must be one of '%s'",
                $this->container['search_mode'],
                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 q
     *
     * @return string
     */
    public function getQ()
    {
        return $this->container['q'];
    }

    /**
     * Sets q
     *
     * @param string $q 搜索关键词
     *
     * @return self
     */
    public function setQ($q)
    {
        if (is_null($q)) {
            throw new \InvalidArgumentException('non-nullable q cannot be null');
        }
        $this->container['q'] = $q;

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * Sets resource_type
     *
     * @param string|null $resource_type 资源类型
     *
     * @return self
     */
    public function setResourceType($resource_type)
    {
        if (is_null($resource_type)) {
            throw new \InvalidArgumentException('non-nullable resource_type cannot be null');
        }
        $this->container['resource_type'] = $resource_type;

        return $this;
    }

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

    /**
     * Sets granularity
     *
     * @param string|null $granularity 文档颗粒度
     *
     * @return self
     */
    public function setGranularity($granularity)
    {
        if (is_null($granularity)) {
            throw new \InvalidArgumentException('non-nullable granularity cannot be null');
        }
        $this->container['granularity'] = $granularity;

        return $this;
    }

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

    /**
     * Sets language
     *
     * @param string|null $language 语言
     *
     * @return self
     */
    public function setLanguage($language)
    {
        if (is_null($language)) {
            throw new \InvalidArgumentException('non-nullable language cannot be null');
        }
        $this->container['language'] = $language;

        return $this;
    }

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

    /**
     * Sets category
     *
     * @param string|null $category 文档分类，逗号分隔
     *
     * @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;
    }

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

    /**
     * Sets tags
     *
     * @param string|null $tags 标签，逗号分隔
     *
     * @return self
     */
    public function setTags($tags)
    {
        if (is_null($tags)) {
            throw new \InvalidArgumentException('non-nullable tags cannot be null');
        }
        $this->container['tags'] = $tags;

        return $this;
    }

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

    /**
     * Sets page_refs
     *
     * @param string[]|null $page_refs 页码标记
     *
     * @return self
     */
    public function setPageRefs($page_refs)
    {
        if (is_null($page_refs)) {
            throw new \InvalidArgumentException('non-nullable page_refs cannot be null');
        }
        $this->container['page_refs'] = $page_refs;

        return $this;
    }

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

    /**
     * Sets related_id
     *
     * @param string[]|null $related_id 关联 id
     *
     * @return self
     */
    public function setRelatedId($related_id)
    {
        if (is_null($related_id)) {
            throw new \InvalidArgumentException('non-nullable related_id cannot be null');
        }
        $this->container['related_id'] = $related_id;

        return $this;
    }

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

    /**
     * Sets author
     *
     * @param string|null $author 作者或译者
     *
     * @return self
     */
    public function setAuthor($author)
    {
        if (is_null($author)) {
            throw new \InvalidArgumentException('non-nullable author cannot be null');
        }
        $this->container['author'] = $author;

        return $this;
    }

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

    /**
     * Sets channel
     *
     * @param string|null $channel 来源 channel
     *
     * @return self
     */
    public function setChannel($channel)
    {
        if (is_null($channel)) {
            throw new \InvalidArgumentException('non-nullable channel cannot be null');
        }
        $this->container['channel'] = $channel;

        return $this;
    }

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

    /**
     * Sets page
     *
     * @param int|null $page 页码
     *
     * @return self
     */
    public function setPage($page)
    {
        if (is_null($page)) {
            throw new \InvalidArgumentException('non-nullable page cannot be null');
        }
        $this->container['page'] = $page;

        return $this;
    }

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

    /**
     * Sets page_size
     *
     * @param int|null $page_size 每页数量，上限 100
     *
     * @return self
     */
    public function setPageSize($page_size)
    {
        if (is_null($page_size)) {
            throw new \InvalidArgumentException('non-nullable page_size cannot be null');
        }
        $this->container['page_size'] = $page_size;

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