| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801 |
- <?php
- /**
- * PostApiV3ChannelsChannelTermsRequest
- *
- * 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: 1.0.0
- * 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;
- /**
- * PostApiV3ChannelsChannelTermsRequest Class Doc Comment
- *
- * @category Class
- * @package WikipaliApi
- * @author OpenAPI Generator team
- * @link https://openapi-generator.tech
- * @implements \ArrayAccess<string, mixed>
- */
- class PostApiV3ChannelsChannelTermsRequest implements ModelInterface, ArrayAccess, \JsonSerializable
- {
- public const DISCRIMINATOR = null;
- /**
- * The original name of the model.
- *
- * @var string
- */
- protected static $openAPIModelName = 'post_api_v3_channels_channel_terms_request';
- /**
- * Array of property to type mappings. Used for (de)serialization
- *
- * @var string[]
- */
- protected static $openAPITypes = [
- 'word' => 'string',
- 'tag' => 'string',
- 'meaning' => 'string',
- 'other_meaning' => 'string',
- 'note' => 'string',
- 'summary' => 'string',
- 'quality' => 'string',
- 'content_type' => 'string',
- 'redirect' => '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 = [
- 'word' => null,
- 'tag' => null,
- 'meaning' => null,
- 'other_meaning' => null,
- 'note' => null,
- 'summary' => null,
- 'quality' => null,
- 'content_type' => null,
- 'redirect' => null
- ];
- /**
- * Array of nullable properties. Used for (de)serialization
- *
- * @var boolean[]
- */
- protected static array $openAPINullables = [
- 'word' => false,
- 'tag' => true,
- 'meaning' => false,
- 'other_meaning' => true,
- 'note' => true,
- 'summary' => true,
- 'quality' => true,
- 'content_type' => false,
- 'redirect' => true
- ];
- /**
- * 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 = [
- 'word' => 'word',
- 'tag' => 'tag',
- 'meaning' => 'meaning',
- 'other_meaning' => 'other_meaning',
- 'note' => 'note',
- 'summary' => 'summary',
- 'quality' => 'quality',
- 'content_type' => 'content_type',
- 'redirect' => 'redirect'
- ];
- /**
- * Array of attributes to setter functions (for deserialization of responses)
- *
- * @var string[]
- */
- protected static $setters = [
- 'word' => 'setWord',
- 'tag' => 'setTag',
- 'meaning' => 'setMeaning',
- 'other_meaning' => 'setOtherMeaning',
- 'note' => 'setNote',
- 'summary' => 'setSummary',
- 'quality' => 'setQuality',
- 'content_type' => 'setContentType',
- 'redirect' => 'setRedirect'
- ];
- /**
- * Array of attributes to getter functions (for serialization of requests)
- *
- * @var string[]
- */
- protected static $getters = [
- 'word' => 'getWord',
- 'tag' => 'getTag',
- 'meaning' => 'getMeaning',
- 'other_meaning' => 'getOtherMeaning',
- 'note' => 'getNote',
- 'summary' => 'getSummary',
- 'quality' => 'getQuality',
- 'content_type' => 'getContentType',
- 'redirect' => 'getRedirect'
- ];
- /**
- * 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 QUALITY_FEATURED = 'featured';
- public const QUALITY_STANDARD = 'standard';
- public const QUALITY_DRAFT = 'draft';
- public const QUALITY_PENDING = 'pending';
- public const CONTENT_TYPE_MARKDOWN = 'markdown';
- public const CONTENT_TYPE_MARKDOWN_E2 = 'markdown-e2';
- /**
- * Gets allowable values of the enum
- *
- * @return string[]
- */
- public function getQualityAllowableValues()
- {
- return [
- self::QUALITY_FEATURED,
- self::QUALITY_STANDARD,
- self::QUALITY_DRAFT,
- self::QUALITY_PENDING,
- ];
- }
- /**
- * Gets allowable values of the enum
- *
- * @return string[]
- */
- public function getContentTypeAllowableValues()
- {
- return [
- self::CONTENT_TYPE_MARKDOWN,
- self::CONTENT_TYPE_MARKDOWN_E2,
- ];
- }
- /**
- * 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('word', $data ?? [], null);
- $this->setIfExists('tag', $data ?? [], null);
- $this->setIfExists('meaning', $data ?? [], null);
- $this->setIfExists('other_meaning', $data ?? [], null);
- $this->setIfExists('note', $data ?? [], null);
- $this->setIfExists('summary', $data ?? [], null);
- $this->setIfExists('quality', $data ?? [], null);
- $this->setIfExists('content_type', $data ?? [], 'markdown-e2');
- $this->setIfExists('redirect', $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['word'] === null) {
- $invalidProperties[] = "'word' can't be null";
- }
- if ($this->container['meaning'] === null) {
- $invalidProperties[] = "'meaning' can't be null";
- }
- $allowedValues = $this->getQualityAllowableValues();
- if (!is_null($this->container['quality']) && !in_array($this->container['quality'], $allowedValues, true)) {
- $invalidProperties[] = sprintf(
- "invalid value '%s' for 'quality', must be one of '%s'",
- $this->container['quality'],
- implode("', '", $allowedValues)
- );
- }
- $allowedValues = $this->getContentTypeAllowableValues();
- if (!is_null($this->container['content_type']) && !in_array($this->container['content_type'], $allowedValues, true)) {
- $invalidProperties[] = sprintf(
- "invalid value '%s' for 'content_type', must be one of '%s'",
- $this->container['content_type'],
- 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 word
- *
- * @return string
- */
- public function getWord()
- {
- return $this->container['word'];
- }
- /**
- * Sets word
- *
- * @param string $word 巴利词,建立后不能改
- *
- * @return self
- */
- public function setWord($word)
- {
- if (is_null($word)) {
- throw new \InvalidArgumentException('non-nullable word cannot be null');
- }
- $this->container['word'] = $word;
- return $this;
- }
- /**
- * Gets tag
- *
- * @return string|null
- */
- public function getTag()
- {
- return $this->container['tag'];
- }
- /**
- * Sets tag
- *
- * @param string|null $tag 义项(同词多义时区分),不能含 @,建立后不能改
- *
- * @return self
- */
- public function setTag($tag)
- {
- if (is_null($tag)) {
- array_push($this->openAPINullablesSetToNull, 'tag');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('tag', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $this->container['tag'] = $tag;
- return $this;
- }
- /**
- * Gets meaning
- *
- * @return string
- */
- public function getMeaning()
- {
- return $this->container['meaning'];
- }
- /**
- * Sets meaning
- *
- * @param string $meaning 释义
- *
- * @return self
- */
- public function setMeaning($meaning)
- {
- if (is_null($meaning)) {
- throw new \InvalidArgumentException('non-nullable meaning cannot be null');
- }
- $this->container['meaning'] = $meaning;
- return $this;
- }
- /**
- * Gets other_meaning
- *
- * @return string|null
- */
- public function getOtherMeaning()
- {
- return $this->container['other_meaning'];
- }
- /**
- * Sets other_meaning
- *
- * @param string|null $other_meaning 其它释义
- *
- * @return self
- */
- public function setOtherMeaning($other_meaning)
- {
- if (is_null($other_meaning)) {
- array_push($this->openAPINullablesSetToNull, 'other_meaning');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('other_meaning', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $this->container['other_meaning'] = $other_meaning;
- return $this;
- }
- /**
- * Gets note
- *
- * @return string|null
- */
- public function getNote()
- {
- return $this->container['note'];
- }
- /**
- * Sets note
- *
- * @param string|null $note 正文
- *
- * @return self
- */
- public function setNote($note)
- {
- if (is_null($note)) {
- array_push($this->openAPINullablesSetToNull, 'note');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('note', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $this->container['note'] = $note;
- return $this;
- }
- /**
- * Gets summary
- *
- * @return string|null
- */
- public function getSummary()
- {
- return $this->container['summary'];
- }
- /**
- * Sets summary
- *
- * @param string|null $summary 摘要,格式与 note 相同
- *
- * @return self
- */
- public function setSummary($summary)
- {
- if (is_null($summary)) {
- array_push($this->openAPINullablesSetToNull, 'summary');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('summary', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $this->container['summary'] = $summary;
- return $this;
- }
- /**
- * Gets quality
- *
- * @return string|null
- */
- public function getQuality()
- {
- return $this->container['quality'];
- }
- /**
- * Sets quality
- *
- * @param string|null $quality 质量
- *
- * @return self
- */
- public function setQuality($quality)
- {
- if (is_null($quality)) {
- array_push($this->openAPINullablesSetToNull, 'quality');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('quality', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $allowedValues = $this->getQualityAllowableValues();
- if (!is_null($quality) && !in_array($quality, $allowedValues, true)) {
- throw new \InvalidArgumentException(
- sprintf(
- "Invalid value '%s' for 'quality', must be one of '%s'",
- $quality,
- implode("', '", $allowedValues)
- )
- );
- }
- $this->container['quality'] = $quality;
- return $this;
- }
- /**
- * Gets content_type
- *
- * @return string|null
- */
- public function getContentType()
- {
- return $this->container['content_type'];
- }
- /**
- * Sets content_type
- *
- * @param string|null $content_type 正文方言
- *
- * @return self
- */
- public function setContentType($content_type)
- {
- if (is_null($content_type)) {
- throw new \InvalidArgumentException('non-nullable content_type cannot be null');
- }
- $allowedValues = $this->getContentTypeAllowableValues();
- if (!in_array($content_type, $allowedValues, true)) {
- throw new \InvalidArgumentException(
- sprintf(
- "Invalid value '%s' for 'content_type', must be one of '%s'",
- $content_type,
- implode("', '", $allowedValues)
- )
- );
- }
- $this->container['content_type'] = $content_type;
- return $this;
- }
- /**
- * Gets redirect
- *
- * @return string|null
- */
- public function getRedirect()
- {
- return $this->container['redirect'];
- }
- /**
- * Sets redirect
- *
- * @param string|null $redirect 重定向到 word 或 word@tag
- *
- * @return self
- */
- public function setRedirect($redirect)
- {
- if (is_null($redirect)) {
- array_push($this->openAPINullablesSetToNull, 'redirect');
- } else {
- $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
- $index = array_search('redirect', $nullablesSetToNull);
- if ($index !== FALSE) {
- unset($nullablesSetToNull[$index]);
- $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
- }
- }
- $this->container['redirect'] = $redirect;
- 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));
- }
- }
|