PostApiV3GroupsGroupMembersRequest.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. <?php
  2. /**
  3. * PostApiV3GroupsGroupMembersRequest
  4. *
  5. * PHP version 8.1
  6. *
  7. * @category Class
  8. * @package WikipaliApi
  9. * @author OpenAPI Generator team
  10. * @link https://openapi-generator.tech
  11. */
  12. /**
  13. * MINT API
  14. *
  15. * International Academy Of Pali Tipitaka(国际巴利三藏学院) 由 `php openapi/scripts/generate.php` 依据 api-v13 的路由与控制器源码生成。 响应统一封装为 `{ok, message, data}`;`ok=false` 时 `message` 为错误信息。
  16. *
  17. * The version of the OpenAPI document: 1.0.0
  18. * Generated by: https://openapi-generator.tech
  19. * Generator version: 7.25.0
  20. */
  21. /**
  22. * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  23. * https://openapi-generator.tech
  24. * Do not edit the class manually.
  25. */
  26. namespace WikipaliApi\Model;
  27. use \ArrayAccess;
  28. use \WikipaliApi\ObjectSerializer;
  29. /**
  30. * PostApiV3GroupsGroupMembersRequest Class Doc Comment
  31. *
  32. * @category Class
  33. * @package WikipaliApi
  34. * @author OpenAPI Generator team
  35. * @link https://openapi-generator.tech
  36. * @implements \ArrayAccess<string, mixed>
  37. */
  38. class PostApiV3GroupsGroupMembersRequest implements ModelInterface, ArrayAccess, \JsonSerializable
  39. {
  40. public const DISCRIMINATOR = null;
  41. /**
  42. * The original name of the model.
  43. *
  44. * @var string
  45. */
  46. protected static $openAPIModelName = 'post_api_v3_groups_group_members_request';
  47. /**
  48. * Array of property to type mappings. Used for (de)serialization
  49. *
  50. * @var string[]
  51. */
  52. protected static $openAPITypes = [
  53. 'user_id' => 'string',
  54. 'role' => 'string'
  55. ];
  56. /**
  57. * Array of property to format mappings. Used for (de)serialization
  58. *
  59. * @var string[]
  60. * @phpstan-var array<string, string|null>
  61. * @psalm-var array<string, string|null>
  62. */
  63. protected static $openAPIFormats = [
  64. 'user_id' => null,
  65. 'role' => null
  66. ];
  67. /**
  68. * Array of nullable properties. Used for (de)serialization
  69. *
  70. * @var boolean[]
  71. */
  72. protected static array $openAPINullables = [
  73. 'user_id' => false,
  74. 'role' => false
  75. ];
  76. /**
  77. * If a nullable field gets set to null, insert it here
  78. *
  79. * @var boolean[]
  80. */
  81. protected array $openAPINullablesSetToNull = [];
  82. /**
  83. * Array of property to type mappings. Used for (de)serialization
  84. *
  85. * @return array
  86. */
  87. public static function openAPITypes()
  88. {
  89. return self::$openAPITypes;
  90. }
  91. /**
  92. * Array of property to format mappings. Used for (de)serialization
  93. *
  94. * @return array
  95. */
  96. public static function openAPIFormats()
  97. {
  98. return self::$openAPIFormats;
  99. }
  100. /**
  101. * Array of nullable properties
  102. *
  103. * @return array
  104. */
  105. protected static function openAPINullables(): array
  106. {
  107. return self::$openAPINullables;
  108. }
  109. /**
  110. * Array of nullable field names deliberately set to null
  111. *
  112. * @return boolean[]
  113. */
  114. private function getOpenAPINullablesSetToNull(): array
  115. {
  116. return $this->openAPINullablesSetToNull;
  117. }
  118. /**
  119. * Setter - Array of nullable field names deliberately set to null
  120. *
  121. * @param boolean[] $openAPINullablesSetToNull
  122. */
  123. private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
  124. {
  125. $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
  126. }
  127. /**
  128. * Checks if a property is nullable
  129. *
  130. * @param string $property
  131. * @return bool
  132. */
  133. public static function isNullable(string $property): bool
  134. {
  135. return self::openAPINullables()[$property] ?? false;
  136. }
  137. /**
  138. * Checks if a nullable property is set to null.
  139. *
  140. * @param string $property
  141. * @return bool
  142. */
  143. public function isNullableSetToNull(string $property): bool
  144. {
  145. return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
  146. }
  147. /**
  148. * Array of attributes where the key is the local name,
  149. * and the value is the original name
  150. *
  151. * @var string[]
  152. */
  153. protected static $attributeMap = [
  154. 'user_id' => 'user_id',
  155. 'role' => 'role'
  156. ];
  157. /**
  158. * Array of attributes to setter functions (for deserialization of responses)
  159. *
  160. * @var string[]
  161. */
  162. protected static $setters = [
  163. 'user_id' => 'setUserId',
  164. 'role' => 'setRole'
  165. ];
  166. /**
  167. * Array of attributes to getter functions (for serialization of requests)
  168. *
  169. * @var string[]
  170. */
  171. protected static $getters = [
  172. 'user_id' => 'getUserId',
  173. 'role' => 'getRole'
  174. ];
  175. /**
  176. * Array of attributes where the key is the local name,
  177. * and the value is the original name
  178. *
  179. * @return array
  180. */
  181. public static function attributeMap()
  182. {
  183. return self::$attributeMap;
  184. }
  185. /**
  186. * Array of attributes to setter functions (for deserialization of responses)
  187. *
  188. * @return array
  189. */
  190. public static function setters()
  191. {
  192. return self::$setters;
  193. }
  194. /**
  195. * Array of attributes to getter functions (for serialization of requests)
  196. *
  197. * @return array
  198. */
  199. public static function getters()
  200. {
  201. return self::$getters;
  202. }
  203. /**
  204. * The original name of the model.
  205. *
  206. * @return string
  207. */
  208. public function getModelName()
  209. {
  210. return self::$openAPIModelName;
  211. }
  212. public const ROLE_MANAGER = 'manager';
  213. public const ROLE_EDITOR = 'editor';
  214. public const ROLE_READER = 'reader';
  215. /**
  216. * Gets allowable values of the enum
  217. *
  218. * @return string[]
  219. */
  220. public function getRoleAllowableValues()
  221. {
  222. return [
  223. self::ROLE_MANAGER,
  224. self::ROLE_EDITOR,
  225. self::ROLE_READER,
  226. ];
  227. }
  228. /**
  229. * Associative array for storing property values
  230. *
  231. * @var mixed[]
  232. */
  233. protected $container = [];
  234. /**
  235. * Constructor
  236. *
  237. * @param mixed[]|null $data Associated array of property values
  238. * initializing the model
  239. */
  240. public function __construct(?array $data = null)
  241. {
  242. $this->setIfExists('user_id', $data ?? [], null);
  243. $this->setIfExists('role', $data ?? [], null);
  244. }
  245. /**
  246. * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
  247. * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
  248. * $this->openAPINullablesSetToNull array
  249. *
  250. * @param string $variableName
  251. * @param array $fields
  252. * @param mixed $defaultValue
  253. */
  254. private function setIfExists(string $variableName, array $fields, $defaultValue): void
  255. {
  256. if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
  257. $this->openAPINullablesSetToNull[] = $variableName;
  258. }
  259. $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
  260. }
  261. /**
  262. * Show all the invalid properties with reasons.
  263. *
  264. * @return array invalid properties with reasons
  265. */
  266. public function listInvalidProperties()
  267. {
  268. $invalidProperties = [];
  269. if ($this->container['user_id'] === null) {
  270. $invalidProperties[] = "'user_id' can't be null";
  271. }
  272. $allowedValues = $this->getRoleAllowableValues();
  273. if (!is_null($this->container['role']) && !in_array($this->container['role'], $allowedValues, true)) {
  274. $invalidProperties[] = sprintf(
  275. "invalid value '%s' for 'role', must be one of '%s'",
  276. $this->container['role'],
  277. implode("', '", $allowedValues)
  278. );
  279. }
  280. return $invalidProperties;
  281. }
  282. /**
  283. * Validate all the properties in the model
  284. * return true if all passed
  285. *
  286. * @return bool True if all properties are valid
  287. */
  288. public function valid()
  289. {
  290. return count($this->listInvalidProperties()) === 0;
  291. }
  292. /**
  293. * Gets user_id
  294. *
  295. * @return string
  296. */
  297. public function getUserId()
  298. {
  299. return $this->container['user_id'];
  300. }
  301. /**
  302. * Sets user_id
  303. *
  304. * @param string $user_id 要加入的用户 uuid
  305. *
  306. * @return self
  307. */
  308. public function setUserId($user_id)
  309. {
  310. if (is_null($user_id)) {
  311. throw new \InvalidArgumentException('non-nullable user_id cannot be null');
  312. }
  313. $this->container['user_id'] = $user_id;
  314. return $this;
  315. }
  316. /**
  317. * Gets role
  318. *
  319. * @return string|null
  320. */
  321. public function getRole()
  322. {
  323. return $this->container['role'];
  324. }
  325. /**
  326. * Sets role
  327. *
  328. * @param string|null $role 角色,默认 reader
  329. *
  330. * @return self
  331. */
  332. public function setRole($role)
  333. {
  334. if (is_null($role)) {
  335. throw new \InvalidArgumentException('non-nullable role cannot be null');
  336. }
  337. $allowedValues = $this->getRoleAllowableValues();
  338. if (!in_array($role, $allowedValues, true)) {
  339. throw new \InvalidArgumentException(
  340. sprintf(
  341. "Invalid value '%s' for 'role', must be one of '%s'",
  342. $role,
  343. implode("', '", $allowedValues)
  344. )
  345. );
  346. }
  347. $this->container['role'] = $role;
  348. return $this;
  349. }
  350. /**
  351. * Returns true if offset exists. False otherwise.
  352. *
  353. * @param integer|string $offset Offset
  354. *
  355. * @return boolean
  356. */
  357. public function offsetExists(mixed $offset): bool
  358. {
  359. return isset($this->container[$offset]);
  360. }
  361. /**
  362. * Gets offset.
  363. *
  364. * @param integer|string $offset Offset
  365. *
  366. * @return mixed|null
  367. */
  368. #[\ReturnTypeWillChange]
  369. public function offsetGet(mixed $offset)
  370. {
  371. return $this->container[$offset] ?? null;
  372. }
  373. /**
  374. * Sets value based on offset.
  375. *
  376. * @param int|null $offset Offset
  377. * @param mixed $value Value to be set
  378. *
  379. * @return void
  380. */
  381. public function offsetSet($offset, $value): void
  382. {
  383. if (is_null($offset)) {
  384. $this->container[] = $value;
  385. } else {
  386. $this->container[$offset] = $value;
  387. }
  388. }
  389. /**
  390. * Unsets offset.
  391. *
  392. * @param integer|string $offset Offset
  393. *
  394. * @return void
  395. */
  396. public function offsetUnset(mixed $offset): void
  397. {
  398. unset($this->container[$offset]);
  399. }
  400. /**
  401. * Serializes the object to a value that can be serialized natively by json_encode().
  402. * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
  403. *
  404. * @return mixed Returns data which can be serialized by json_encode(), which is a value
  405. * of any type other than a resource.
  406. */
  407. #[\ReturnTypeWillChange]
  408. public function jsonSerialize()
  409. {
  410. return ObjectSerializer::sanitizeForSerialization($this);
  411. }
  412. /**
  413. * Gets the string presentation of the object
  414. *
  415. * @return string
  416. */
  417. public function __toString()
  418. {
  419. return json_encode(
  420. ObjectSerializer::sanitizeForSerialization($this),
  421. JSON_PRETTY_PRINT
  422. );
  423. }
  424. /**
  425. * Gets a header-safe presentation of the object
  426. *
  427. * @return string
  428. */
  429. public function toHeaderValue()
  430. {
  431. return json_encode(ObjectSerializer::sanitizeForSerialization($this));
  432. }
  433. }