MarkupTemplate.php 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555
  1. <?php
  2. /**
  3. * MarkupTemplate
  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. * MarkupTemplate 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 MarkupTemplate 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 = 'MarkupTemplate';
  47. /**
  48. * Array of property to type mappings. Used for (de)serialization
  49. *
  50. * @var string[]
  51. */
  52. protected static $openAPITypes = [
  53. 'type' => 'string',
  54. 'name' => 'string',
  55. 'props' => 'array<string,mixed>',
  56. 'children' => '\WikipaliApi\Model\MarkupNode[]'
  57. ];
  58. /**
  59. * Array of property to format mappings. Used for (de)serialization
  60. *
  61. * @var string[]
  62. * @phpstan-var array<string, string|null>
  63. * @psalm-var array<string, string|null>
  64. */
  65. protected static $openAPIFormats = [
  66. 'type' => null,
  67. 'name' => null,
  68. 'props' => null,
  69. 'children' => null
  70. ];
  71. /**
  72. * Array of nullable properties. Used for (de)serialization
  73. *
  74. * @var boolean[]
  75. */
  76. protected static array $openAPINullables = [
  77. 'type' => false,
  78. 'name' => false,
  79. 'props' => false,
  80. 'children' => false
  81. ];
  82. /**
  83. * If a nullable field gets set to null, insert it here
  84. *
  85. * @var boolean[]
  86. */
  87. protected array $openAPINullablesSetToNull = [];
  88. /**
  89. * Array of property to type mappings. Used for (de)serialization
  90. *
  91. * @return array
  92. */
  93. public static function openAPITypes()
  94. {
  95. return self::$openAPITypes;
  96. }
  97. /**
  98. * Array of property to format mappings. Used for (de)serialization
  99. *
  100. * @return array
  101. */
  102. public static function openAPIFormats()
  103. {
  104. return self::$openAPIFormats;
  105. }
  106. /**
  107. * Array of nullable properties
  108. *
  109. * @return array
  110. */
  111. protected static function openAPINullables(): array
  112. {
  113. return self::$openAPINullables;
  114. }
  115. /**
  116. * Array of nullable field names deliberately set to null
  117. *
  118. * @return boolean[]
  119. */
  120. private function getOpenAPINullablesSetToNull(): array
  121. {
  122. return $this->openAPINullablesSetToNull;
  123. }
  124. /**
  125. * Setter - Array of nullable field names deliberately set to null
  126. *
  127. * @param boolean[] $openAPINullablesSetToNull
  128. */
  129. private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
  130. {
  131. $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
  132. }
  133. /**
  134. * Checks if a property is nullable
  135. *
  136. * @param string $property
  137. * @return bool
  138. */
  139. public static function isNullable(string $property): bool
  140. {
  141. return self::openAPINullables()[$property] ?? false;
  142. }
  143. /**
  144. * Checks if a nullable property is set to null.
  145. *
  146. * @param string $property
  147. * @return bool
  148. */
  149. public function isNullableSetToNull(string $property): bool
  150. {
  151. return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
  152. }
  153. /**
  154. * Array of attributes where the key is the local name,
  155. * and the value is the original name
  156. *
  157. * @var string[]
  158. */
  159. protected static $attributeMap = [
  160. 'type' => 'type',
  161. 'name' => 'name',
  162. 'props' => 'props',
  163. 'children' => 'children'
  164. ];
  165. /**
  166. * Array of attributes to setter functions (for deserialization of responses)
  167. *
  168. * @var string[]
  169. */
  170. protected static $setters = [
  171. 'type' => 'setType',
  172. 'name' => 'setName',
  173. 'props' => 'setProps',
  174. 'children' => 'setChildren'
  175. ];
  176. /**
  177. * Array of attributes to getter functions (for serialization of requests)
  178. *
  179. * @var string[]
  180. */
  181. protected static $getters = [
  182. 'type' => 'getType',
  183. 'name' => 'getName',
  184. 'props' => 'getProps',
  185. 'children' => 'getChildren'
  186. ];
  187. /**
  188. * Array of attributes where the key is the local name,
  189. * and the value is the original name
  190. *
  191. * @return array
  192. */
  193. public static function attributeMap()
  194. {
  195. return self::$attributeMap;
  196. }
  197. /**
  198. * Array of attributes to setter functions (for deserialization of responses)
  199. *
  200. * @return array
  201. */
  202. public static function setters()
  203. {
  204. return self::$setters;
  205. }
  206. /**
  207. * Array of attributes to getter functions (for serialization of requests)
  208. *
  209. * @return array
  210. */
  211. public static function getters()
  212. {
  213. return self::$getters;
  214. }
  215. /**
  216. * The original name of the model.
  217. *
  218. * @return string
  219. */
  220. public function getModelName()
  221. {
  222. return self::$openAPIModelName;
  223. }
  224. public const TYPE_TPL = 'tpl';
  225. /**
  226. * Gets allowable values of the enum
  227. *
  228. * @return string[]
  229. */
  230. public function getTypeAllowableValues()
  231. {
  232. return [
  233. self::TYPE_TPL,
  234. ];
  235. }
  236. /**
  237. * Associative array for storing property values
  238. *
  239. * @var mixed[]
  240. */
  241. protected $container = [];
  242. /**
  243. * Constructor
  244. *
  245. * @param mixed[]|null $data Associated array of property values
  246. * initializing the model
  247. */
  248. public function __construct(?array $data = null)
  249. {
  250. $this->setIfExists('type', $data ?? [], null);
  251. $this->setIfExists('name', $data ?? [], null);
  252. $this->setIfExists('props', $data ?? [], null);
  253. $this->setIfExists('children', $data ?? [], null);
  254. }
  255. /**
  256. * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
  257. * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
  258. * $this->openAPINullablesSetToNull array
  259. *
  260. * @param string $variableName
  261. * @param array $fields
  262. * @param mixed $defaultValue
  263. */
  264. private function setIfExists(string $variableName, array $fields, $defaultValue): void
  265. {
  266. if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
  267. $this->openAPINullablesSetToNull[] = $variableName;
  268. }
  269. $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
  270. }
  271. /**
  272. * Show all the invalid properties with reasons.
  273. *
  274. * @return array invalid properties with reasons
  275. */
  276. public function listInvalidProperties()
  277. {
  278. $invalidProperties = [];
  279. if ($this->container['type'] === null) {
  280. $invalidProperties[] = "'type' can't be null";
  281. }
  282. $allowedValues = $this->getTypeAllowableValues();
  283. if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) {
  284. $invalidProperties[] = sprintf(
  285. "invalid value '%s' for 'type', must be one of '%s'",
  286. $this->container['type'],
  287. implode("', '", $allowedValues)
  288. );
  289. }
  290. if ($this->container['name'] === null) {
  291. $invalidProperties[] = "'name' can't be null";
  292. }
  293. if ($this->container['props'] === null) {
  294. $invalidProperties[] = "'props' can't be null";
  295. }
  296. if ($this->container['children'] === null) {
  297. $invalidProperties[] = "'children' can't be null";
  298. }
  299. return $invalidProperties;
  300. }
  301. /**
  302. * Validate all the properties in the model
  303. * return true if all passed
  304. *
  305. * @return bool True if all properties are valid
  306. */
  307. public function valid()
  308. {
  309. return count($this->listInvalidProperties()) === 0;
  310. }
  311. /**
  312. * Gets type
  313. *
  314. * @return string
  315. */
  316. public function getType()
  317. {
  318. return $this->container['type'];
  319. }
  320. /**
  321. * Sets type
  322. *
  323. * @param string $type type
  324. *
  325. * @return self
  326. */
  327. public function setType($type)
  328. {
  329. if (is_null($type)) {
  330. throw new \InvalidArgumentException('non-nullable type cannot be null');
  331. }
  332. $allowedValues = $this->getTypeAllowableValues();
  333. if (!in_array($type, $allowedValues, true)) {
  334. throw new \InvalidArgumentException(
  335. sprintf(
  336. "Invalid value '%s' for 'type', must be one of '%s'",
  337. $type,
  338. implode("', '", $allowedValues)
  339. )
  340. );
  341. }
  342. $this->container['type'] = $type;
  343. return $this;
  344. }
  345. /**
  346. * Gets name
  347. *
  348. * @return string
  349. */
  350. public function getName()
  351. {
  352. return $this->container['name'];
  353. }
  354. /**
  355. * Sets name
  356. *
  357. * @param string $name 前端组件名:term、note、sentread、sentedit、quote、quote-link、mermaid…
  358. *
  359. * @return self
  360. */
  361. public function setName($name)
  362. {
  363. if (is_null($name)) {
  364. throw new \InvalidArgumentException('non-nullable name cannot be null');
  365. }
  366. $this->container['name'] = $name;
  367. return $this;
  368. }
  369. /**
  370. * Gets props
  371. *
  372. * @return array<string,mixed>
  373. */
  374. public function getProps()
  375. {
  376. return $this->container['props'];
  377. }
  378. /**
  379. * Sets props
  380. *
  381. * @param array<string,mixed> $props props
  382. *
  383. * @return self
  384. */
  385. public function setProps($props)
  386. {
  387. if (is_null($props)) {
  388. throw new \InvalidArgumentException('non-nullable props cannot be null');
  389. }
  390. $this->container['props'] = $props;
  391. return $this;
  392. }
  393. /**
  394. * Gets children
  395. *
  396. * @return \WikipaliApi\Model\MarkupNode[]
  397. */
  398. public function getChildren()
  399. {
  400. return $this->container['children'];
  401. }
  402. /**
  403. * Sets children
  404. *
  405. * @param \WikipaliApi\Model\MarkupNode[] $children children
  406. *
  407. * @return self
  408. */
  409. public function setChildren($children)
  410. {
  411. if (is_null($children)) {
  412. throw new \InvalidArgumentException('non-nullable children cannot be null');
  413. }
  414. $this->container['children'] = $children;
  415. return $this;
  416. }
  417. /**
  418. * Returns true if offset exists. False otherwise.
  419. *
  420. * @param integer|string $offset Offset
  421. *
  422. * @return boolean
  423. */
  424. public function offsetExists(mixed $offset): bool
  425. {
  426. return isset($this->container[$offset]);
  427. }
  428. /**
  429. * Gets offset.
  430. *
  431. * @param integer|string $offset Offset
  432. *
  433. * @return mixed|null
  434. */
  435. #[\ReturnTypeWillChange]
  436. public function offsetGet(mixed $offset)
  437. {
  438. return $this->container[$offset] ?? null;
  439. }
  440. /**
  441. * Sets value based on offset.
  442. *
  443. * @param int|null $offset Offset
  444. * @param mixed $value Value to be set
  445. *
  446. * @return void
  447. */
  448. public function offsetSet($offset, $value): void
  449. {
  450. if (is_null($offset)) {
  451. $this->container[] = $value;
  452. } else {
  453. $this->container[$offset] = $value;
  454. }
  455. }
  456. /**
  457. * Unsets offset.
  458. *
  459. * @param integer|string $offset Offset
  460. *
  461. * @return void
  462. */
  463. public function offsetUnset(mixed $offset): void
  464. {
  465. unset($this->container[$offset]);
  466. }
  467. /**
  468. * Serializes the object to a value that can be serialized natively by json_encode().
  469. * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
  470. *
  471. * @return mixed Returns data which can be serialized by json_encode(), which is a value
  472. * of any type other than a resource.
  473. */
  474. #[\ReturnTypeWillChange]
  475. public function jsonSerialize()
  476. {
  477. return ObjectSerializer::sanitizeForSerialization($this);
  478. }
  479. /**
  480. * Gets the string presentation of the object
  481. *
  482. * @return string
  483. */
  484. public function __toString()
  485. {
  486. return json_encode(
  487. ObjectSerializer::sanitizeForSerialization($this),
  488. JSON_PRETTY_PRINT
  489. );
  490. }
  491. /**
  492. * Gets a header-safe presentation of the object
  493. *
  494. * @return string
  495. */
  496. public function toHeaderValue()
  497. {
  498. return json_encode(ObjectSerializer::sanitizeForSerialization($this));
  499. }
  500. }