Firebase for Laravel

A Laravel package for the Firebase PHP Admin SDK.

• Installation
• Configuration
• Usage
• Documentation

Installation

This package requires Laravel 5.8 and higher.

composer require kreait/laravel-firebase

If you don't use package auto-discovery, add the following service provider in config/app.php

// config/app.php
<?php

return [
    // ...
    'providers' => [
        // ...
        Kreait\Laravel\Firebase\ServiceProvider::class
    ]
    // ...   
];

Configuration

In order to access a Firebase project and its related services using a server SDK, requests must be authenticated. For server-to-server communication this is done with a Service Account.

The package uses auto discovery to find the credentials needed for authenticating requests to the Firebase APIs by inspecting certain environment variables and looking into Google's well known path(s).

If you don't already have generated a Service Account, you can do so by following the instructions from the official documentation pages at https://firebase.google.com/docs/admin/setup#initialize_the_sdk.

Once you have downloaded the Service Account JSON file, you can use it to configure the package by specifying the environment variable FIREBASE_CREDENTIALS in your .env file:

FIREBASE_CREDENTIALS=/full/path/to/firebase_credentials.json
# or
FIREBASE_CREDENTIALS=relative/path/to/firebase_credentials.json

For further configuration, please see config/firebase.php. You can modify the configuration by copying it to your local config directory with the publish command:

php artisan vendor:publish --provider="Kreait\Laravel\Firebase\ServiceProvider" --tag=config

Usage

| Component | Automatic Injection | Facades | app() | | --- | --- | --- | --- | | Authentication | \Kreait\Firebase\Auth | FirebaseAuth | app('firebase.auth') | | Cloud Firestore | \Kreait\Firebase\Firestore | FirebaseFirestore | app('firebase.firestore') | | Cloud Messaging (FCM) | \Kreait\Firebase\Messaging | FirebaseMessaging | app('firebase.messaging') | | Dynamic Links | \Kreait\Firebase\DynamicLinks | FirebaseDynamicLinks | app('firebase.dynamic_links') | | Realtime Database | \Kreait\Firebase\Database | FirebaseDatabase | app('firebase.database') | | Remote Config | \Kreait\Firebase\RemoteConfig | FirebaseRemoteConfig | app('firebase.remote_config') | | Storage | \Kreait\Firebase\Storage | FirebaseStorage | app('firebase.storage') |

Once you have retrieved a component, please refer to the documentation of the Firebase PHP Admin SDK for further information on how to use it.

License

The MIT License (MIT). Please see License File for more information.