Download the PHP package mpociot/laravel-firebase-sync without Composer
On this page you can find all versions of the php package mpociot/laravel-firebase-sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mpociot/laravel-firebase-sync
More information about mpociot/laravel-firebase-sync
Files in mpociot/laravel-firebase-sync
Package laravel-firebase-sync
Short Description Synchronize your Eloquent models with a Firebase realtime database.
License MIT
Homepage http://github.com/mpociot/laravel-firebase-sync
Informations about the package laravel-firebase-sync
Laravel Firebase Sync
Synchronize your Eloquent models with the Firebase Realtime Database
Contents
- Installation
- Usage
- License
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:
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.
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.