mpociot/laravel-firebase-sync

Synchronize your Eloquent models with a Firebase realtime database.

Maintainers

Details

github.com/mpociot/laravel-firebase-sync

Homepage

Source

Issues

Installs: 96 669

Dependents: 1

Suggesters: 0

Security: 0

Stars: 248

Watchers: 18

Forks: 66

Open Issues: 18

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: 2021-03-24 02:53:54 UTC

README

Synchronize your Eloquent models with the Firebase Realtime Database

image image codecov.io Build Status

Contents

Installation

In order to add Laravel Firebase Sync to your project, just add

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

to your composer.json. Then run composer install or composer update.

Or run composer require mpociot/laravel-firebase-sync if you prefer that.

Usage

Configuration

This package requires you to add the following section to your config/services.php file:

'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
]

Note: This package only requires the configuration keys database_url and secret. The other keys are only necessary if you want to also use the firebase JS API.

Synchronizing models

To synchronize your Eloquent models with the Firebase realtime database, simply let the models that you want to synchronize with Firebase use the Mpociot\Firebase\SyncsWithFirebase trait.

use Mpociot\Firebase\SyncsWithFirebase;

class User extends Model {

    use SyncsWithFirebase;

}

The data that will be synchronized is the array representation of your model. That means that you can modify the data using the existing Eloquent model attributes like visible, hidden or appends.

If you need more control over the data that gets synchronized with Firebase, you can override the getFirebaseSyncData of the SyncsWithFirebase trait and let it return the array data you want to send to Firebase.

License

Laravel Firebase Sync is free software distributed under the terms of the MIT license.