Download the PHP package appiersign/realtime-model without Composer
On this page you can find all versions of the php package appiersign/realtime-model. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download appiersign/realtime-model
More information about appiersign/realtime-model
Files in appiersign/realtime-model
Package realtime-model
Short Description This package enables syncing laravel models with Google Firestore
License MIT
Informations about the package realtime-model
Realtime Model
This package enables you to sync laravel models with Google Cloud Firestore. This packages works with an internally developed API that uses the gprc PHP extension to seamlessly connect your PHP backend to Firestore.
Installation
composer require appiersign/realtime-model
Set Up
Set these params in your .env file:
Configuration
Add the realtime model service provider 'providers' array in your config/app.php
file.
[
...
AppierSign\RealtimeModel\Providers\RealtimeModelServiceProvider::class
]
Add "AppierSign\\RealtimeModel\\": "vendor/appiersign/realtime-model/src"
to the autoload.psr-4
object in your composer.json
file
Usage
To automatically sync data to firestore, just add the RealtimeModel
trait to the desired model.
This will automatically sync all model attributes to Firestore whenever a new model is created or updated.
You can also use the realtime artisan command to sync all data associated with a model:
To define which fields or attributes to sync, define the toRealtimeData()
public method
on the model like this:
Setting Key
To set the id or primary/unique key for the model, override the getSyncKey()
public method
on the model like this:
The package uses the plural form of the model name as the suffix of the collection
name to change this, override the collection()
public method
on the model like this: