*/ 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 * @psalm-var array */ 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)); } }