rasyid46/laravel-firebase-sync

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

维护者

详细信息

github.com/rasyid46/laravel-firebase-sync

主页

源代码

问题

安装: 3

依赖: 0

建议: 0

安全: 0

星星: 0

关注者: 0

分支: 71

开放问题: 0

v1 2024-09-19 09:23 UTC

Requires

Requires (Dev)

MIT 7e81bf1c91240ed07d8e9664fd259d8388f04d6c

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

laraveleloquentfirebase

This package is not auto-updated.

Last update: 2024-09-20 07:47:45 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 rasyid46/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 许可证下免费分发的软件。