TipitakaChapterController.php 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?php
  2. namespace App\Http\Controllers\V3;
  3. use App\Http\Controllers\Controller;
  4. use App\Http\Requests\V3\IndexTipitakaChapterRequest;
  5. use App\Http\Resources\V3\TipitakaChapterResource;
  6. use App\Services\V3\TipitakaChapterService;
  7. /**
  8. * 三藏章节标题:按名字找章节,或列出一本书的全部标题。
  9. *
  10. * 取代 `GET /v2/search-title-index`(`SearchTitleController@index`)。v2 那份只回标题文字、
  11. * 不带坐标,在 dashboard-v4 下线前原样保留,不要改动。
  12. */
  13. class TipitakaChapterController extends Controller
  14. {
  15. public function __construct(private readonly TipitakaChapterService $chapters) {}
  16. /**
  17. * 找章节
  18. *
  19. * 两种用法,可以叠加:
  20. *
  21. * - **按名字找**(给 `q`):巴利名不分大小写、变音符号可有可无(`mahaparinibbana`),可以只写
  22. * 名字的一部分,拼错一两个字母也能找到;也能用公开译本里的章节译名(如「大般涅槃经」)。
  23. * 按匹配度排序,带 `score`(相等 1、开头相同 0.95、包含 0.9,拼错的按相似度最高 0.85);同一档里根本典在前,再按与整个标题的接近度、大章在前。
  24. * - **列出一本书的标题**(给 `book`,不给 `q`):按经文顺序。再给 `para` 只列那一章下面的;
  25. * `max_level` 限制层级深浅。
  26. *
  27. * `layer` 是这本书属于根本典(mula)、义注(atthakatha)、复注(tika)还是其他(anna);
  28. * `paragraphs` / `chars` 是这一章的段数与字符数;`parent` / `prev` / `next` 是同一本书里的段号,
  29. * 没有为 null;`path` 是从丛书到上一级的路径(不含本章)。
  30. *
  31. * @unauthenticated
  32. *
  33. * @queryParam q string 章节名:巴利名或译名,不给 book 时必填。Example: mahaparinibbana
  34. * @queryParam book integer 书号,不给 q 时必填。Example: 94
  35. * @queryParam para integer 只列 book 里这一章下面的标题(含它自己),要和 book 一起给。Example: 287
  36. * @queryParam layer string 只要某几层,逗号分隔。Enum: mula, atthakatha, tika, anna
  37. * @queryParam max_level integer 只要层级不深于它的标题(1 是书名)。Example: 3
  38. * @queryParam page integer 页码。Default: 1
  39. * @queryParam per_page integer 每页数量,最大 1000。Default: 50
  40. */
  41. public function __invoke(IndexTipitakaChapterRequest $request)
  42. {
  43. return TipitakaChapterResource::collection($this->chapters->search(
  44. $request->safe()->only(['q', 'book', 'para', 'layer', 'max_level']),
  45. $request->integer('page', 1),
  46. $request->integer('per_page', 50),
  47. ));
  48. }
  49. }