著名互动/content-api

允许通过API和特定助手获取翻译

v0.14 2017-12-05 13:40 UTC

This package is not auto-updated.

Last update: 2024-09-15 03:49:48 UTC


README

设置一个包来从集中式API加载翻译

基本安装

  • composer require famousinteractive/content-api  

  • 在config/app.php中的serviceProvider中添加Famousinteractive\ContentApi\ContentApiServiceProvider::class

  • 发布配置文件: php artisan vendor:publish

  • 在翻译平台上创建项目

  • 运行命令 php artisan famousContentApi:initialize 以生成配置文件

使用方法

  • 使用fitrans($key, $params = [], $lang = null, $default = '') 通过内容API使用翻译。

数据集

  • 要获取数据集的数据,请使用函数fitds($datasetName, $prefixLang = false, $param=[], $useCache=true)

    • $datasetName是数据集的唯一名称
    • $prefixLang布尔值,允许您为每种语言使用不同的数据集。
    • $param字符串,包含要返回的数据。值
      • "fields" 仅字段列表及其类型。
      • "datas" 数据集中的所有条目,包含字段信息。
      • "formatted" 一个与字段 => 值相关联的数组,没有更多数据。
      • "All" 所有这些数据一次。默认情况下
    • $useCache布尔值。默认为true。如果您需要获取经常变化的数据(例如存储用户数据的数据集),您可能更愿意不缓存结果。
  • 要将新记录放入数据集,请使用函数fitpushds($datasetName, $data=[], $prefixLang = false)

    • $datasetName$prefixLang与fitds()函数的行为相同
    • $data是一个字段名和值关联的数组。
      • [ 'lastname' => 'Dillenbourg', 'firstname' => 'Jérémy', 'birtdate' => '1990-07-03' ]
    • 返回值是true或数组['success' => false, 'message' => 'error_description']。字段由平台中设置的规则进行验证。如果验证失败,您将收到错误响应。

额外功能

  • 您可以通过调用/fit-content-api-clear-cache?clientId=xxxxxx来清除网站的缓存
  • 您可以通过运行php artisan famousContentApi:collect 来收集所有fitrans()引用并将它们发送到平台。
  • 您可以通过向您网站的URL添加参数来强制渲染所有翻译键
    • ?fitrans=display_keys&exclusion=routes
    • fitrans=display_keys渲染所有键,fitrans=edit_keys生成由chrome扩展处理HTML标签
    • exlusion排除某些模式。这里所有以routes.开头的键。如果您在路由文件中使用fitrans(),这很有用。