GlossaryController.php 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?php
  2. namespace App\Http\Controllers\V3;
  3. use App\Http\Controllers\Controller;
  4. use App\Http\Requests\V3\IndexGlossaryRequest;
  5. use App\Http\Resources\V3\GlossaryEntryResource;
  6. use App\Services\V3\GlossaryService;
  7. /**
  8. * 术语词汇表:语法术语表 / 社区译名表(只读)。
  9. *
  10. * 取代 `GET /v2/term-vocabulary?view=grammar|community`(`TermVocabularyController@index`)。
  11. * v2 那份在 dashboard-v4 下线前原样保留,不要改动。
  12. */
  13. class GlossaryController extends Controller
  14. {
  15. public function __construct(private readonly GlossaryService $glossaries) {}
  16. /**
  17. * 术语词汇表
  18. *
  19. * 整表返回、不分页(客户端启动时拉一次,本地查词)。`meta.lang` 是实际用到的语言:
  20. * 该语言没有这张表时回退到英文。
  21. *
  22. * @unauthenticated
  23. *
  24. * @urlParam kind string required 哪张表:grammar 语法术语,community 社区译名。Enum: grammar,community
  25. *
  26. * @queryParam lang string 语言,如 zh-Hans。缺省用界面语言(Accept-Language 协商的结果)
  27. *
  28. * @meta kind string 哪张表
  29. * @meta lang string 实际用到的语言(没有该语言的表时是 en)
  30. * @meta total integer 条数
  31. */
  32. public function __invoke(IndexGlossaryRequest $request, string $kind)
  33. {
  34. $result = $this->glossaries->entries($kind, $request->validated('lang') ?? app()->getLocale());
  35. return GlossaryEntryResource::collection($result['items'])->additional(['meta' => [
  36. 'kind' => $kind,
  37. 'lang' => $result['lang'],
  38. 'total' => $result['items']->count(),
  39. ]]);
  40. }
  41. }