tungltdev/laravel-firebase-sync

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

0.0.1 2019-09-09 08:58 UTC

This package is auto-updated.

Last update: 2024-09-09 20:44:43 UTC


README

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

image image codecov.io Build Status

内容

## 安装

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

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

然后运行composer installcomposer update

或者如果您愿意,可以运行composer require tungltdev/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同步的模型使用Tungltdev\Firebase\SyncsWithFirebase特性。

use Tungltdev\Firebase\SyncsWithFirebase;

class User extends Model {

    use SyncsWithFirebase;

}

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

模型不同步事件

如果您想禁用同步,可以使用属性$withoutSyncsWithFirebase。

use Tungltdev\Firebase\SyncsWithFirebase;

class User extends Model {

    use SyncsWithFirebase;
    protected $withoutSyncsWithFirebase=['created','updated','deleted'];
}
'created' : off sync on create model
'updated' : off sync on update model
'deleted' : off sync on delete model
## 许可证

Laravel Firebase Sync是免费软件,在MIT许可的条款下分发。