Download the PHP package firevel/firestore-mirror without Composer
On this page you can find all versions of the php package firevel/firestore-mirror. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package firestore-mirror
Laravel Firestore Mirror
Automatically sync your Laravel Eloquent models to Google Firestore collections in real-time. This package provides a seamless way to mirror your database records to Firestore, enabling powerful real-time features and offline capabilities for your applications.
Features
- 🔄 Automatic Synchronization: Changes to your Eloquent models are automatically reflected in Firestore
- 🚀 Batch Operations: Efficiently sync entire collections using Firestore's batch API
- 🎯 Flexible Configuration: Customize collection names, document IDs, and document structure
- 🧩 Simple Integration: Just add a trait to your existing Eloquent models
- ⚡ Performance Optimized: Uses Firestore batch operations for bulk updates
Requirements
- PHP 8.0 or higher
- Laravel 8.0 or higher
- firevel/firestore package
Installation
Install the package using Composer:
Quick Start
Add the HasFirestoreMirror trait to any Eloquent model you want to sync with Firestore:
That's it! Your User model will now automatically sync to Firestore whenever you create, update, or delete records.
Configuration
Customizing Collection Names
By default, the Firestore collection name matches your model's database table name. You can customize this in two ways:
Static Collection Name
Dynamic Collection Name
Customizing Document Structure
Control exactly what data gets synced to Firestore by overriding the toFirestoreDocument() method:
Customizing Document IDs
By default, the Firestore document ID matches your model's primary key. Override this behavior:
Usage
Automatic Syncing
Once you've added the HasFirestoreMirror trait, your models will automatically sync to Firestore on these events:
- Create: New model instances are added to Firestore
- Update: Changes to existing models are synced to Firestore
- Delete: Deleted models are removed from Firestore
Manual Syncing
You can manually sync individual models:
Batch Syncing Collections
The package provides a powerful mirrorToFirestore() collection macro for efficiently syncing multiple models at once using Firestore's batch operations:
The batch operation is atomic - either all documents are synced successfully, or none are.
Deleting from Firestore
To manually delete a model from Firestore without deleting it from your database:
Advanced Usage
Conditional Syncing
You might want to sync only certain models based on conditions:
Multi-Tenant Applications
For multi-tenant applications, you can dynamically set collection names:
Testing
Run the test suite:
Run a specific test:
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
The MIT License (MIT). Please see License File for more information.
