pixelpub/loco

Laravel 包用于访问 localise.biz api

dev-master 2016-07-18 09:14 UTC

This package is not auto-updated.

Last update: 2024-09-20 21:55:14 UTC


README

本包提供了一种易于使用的接口,用于从 Localise.biz api 获取和缓存资源。

目录

安装

Composer

将 PixelPub/Loco 添加到您的 composer.json 文件中。

"pixelpub/loco":"dev-master"

运行 composer install 以获取包的最新版本。

手动

建议使用 Composer,但您也可以从该仓库下载和安装。

Laravel

Laravel-Loco 包含一个 Laravel 服务提供器。

要在您的 Laravel 应用程序中注册服务提供器,打开 config/app.php 并将以下行添加到 providers 数组中

	...
	Pixelpub\Loco\LocoServiceProvider::class
	...

配置

配置文件

要编辑默认包配置,您可以运行以下 artisan 命令

php artisan vendor:publish --provider="Pixelpub\Loco\LocoServiceProvider" --tag="config"

完成此操作后,您将在 config/loco.php 中找到配置文件。

配置值

  • api(默认:https://localise.biz/api/export/locale/

Localise.biz api 的 URL。

  • languages(默认:['en_US', 'de_DE']

一个包含 Localise.biz api 上可用语言的数组。

  • projects

一个键值对数组,定义 Localise.biz 项目及其 API 密钥。

  • cache(默认:database

定义 Laravel 缓存接口,其中将包含从 Localise.biz 获取的资源。

使用

获取翻译

LocoServiceProvider.php 通过 Loco 接口注入。

	...
	use Pixelpub\Loco\LocoContract;
	...
    public function translation(Loco $loco)
    {
        return $loco->fetch('my-translation-project', 'en_US');
    }
	...

完成此操作后,您就无需再做什么了。Laravel 应用程序的地区设置已完成,您可以像平时一样使用其他依赖于地区的 Laravel 组件(例如翻译)。

清除缓存

所有资源将从 loco api 获取一次,并永久存储在缓存中。如果您调用 flush 方法,此包将尝试在清除缓存之前从 loco 加载资源。如果 loco api 不可用,当前资源将保留在缓存中,并抛出异常。

    $loco->flush('my-translation-project');

许可

本包遵循 MIT 许可证