jgizinski/laravel-firebase-sync

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

1.0.0 2016-06-20 21:04 UTC

This package is auto-updated.

Last update: 2024-09-13 06:20:39 UTC


README

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

image image codecov.io Build Status

内容

安装

为了将Laravel Firebase Sync添加到您的项目中,只需将以下内容添加到您的composer.json文件中。

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

然后运行composer installcomposer 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_urlsecret。其他密钥仅在您想同时使用Firebase JS API时才必要。

同步模型

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

use Mpociot\Firebase\SyncsWithFirebase;

class User extends Model {

    use SyncsWithFirebase;

}

将要同步的数据是您的模型的数组表示。这意味着您可以使用现有的Eloquent模型属性(如visiblehiddenappends)来修改数据。

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

许可证

Laravel Firebase Sync是免费软件,根据MIT许可证条款分发。