mpociot/laravel-firebase-sync

将您的 Eloquent 模型与 Firebase 实时数据库同步。

维护者

详细信息

github.com/mpociot/laravel-firebase-sync

主页

源代码

问题

安装: 152,066

依赖项: 1

建议者: 0

安全性: 0

星标: 265

关注者: 18

分支: 70

开放问题: 19

1.0.0 2016-06-20 21:04 UTC

Requires

Requires (Dev)

MIT c7b172b1827bdeb4bb3c22f64d19ef12519b5a32

  • Marcel Pociot <m.pociot.woop@gmail.com>

laraveleloquentfirebase

This package is auto-updated.

Last update: 2024-08-24 09:37:29 UTC

README

将您的 Eloquent 模型与 Firebase 实时数据库 同步

image image codecov.io Build Status

内容

安装

要将 Laravel Firebase Sync 添加到您的项目中，只需将以下内容添加到您的 composer.json 文件中：

"mpociot/laravel-firebase-sync": "~1.0"

然后运行 composer install 或 composer update。

如果您更喜欢这种方式，也可以运行 composer require mpociot/laravel-firebase-sync。

使用方法

配置

此包需要您将以下部分添加到您的 config/services.php 文件中

'firebase' => [
    'api_key' => 'API_KEY', // Only used for JS integration
    'auth_domain' => 'AUTH_DOMAIN', // Only used for JS integration
    'database_url' => 'https://your-database-at.firebaseio.com',
    'secret' => 'DATABASE_SECRET',
    'storage_bucket' => 'STORAGE_BUCKET', // Only used for JS integration
]

注意：此包仅需要配置键 database_url 和 secret。其他键仅在您想要同时使用 Firebase JS API 时才是必要的。

同步模型

要将 Eloquent 模型与 Firebase 实时数据库同步，只需让要同步到 Firebase 的模型使用 Mpociot\Firebase\SyncsWithFirebase 特性。

use Mpociot\Firebase\SyncsWithFirebase;

class User extends Model {

    use SyncsWithFirebase;

}

将要同步的数据是您的模型数组的表示形式。这意味着您可以使用现有的 Eloquent 模型属性（如 visible、hidden 或 appends）来修改数据。

如果您需要更多控制同步到 Firebase 的数据，可以覆盖 SyncsWithFirebase 特性的 getFirebaseSyncData 并让它返回您想要发送到 Firebase 的数组数据。

许可协议

Laravel Firebase Sync 是免费软件，根据 MIT 许可协议分发。