Firebase for Lumen

A Lumen package for the Firebase PHP Admin SDK.

• Installation
• Configuration
• Usage
• Documentation

Installation

This package requires Lumen 6.x and higher.

composer require prusak-tech/lumen-firebase

Add the following service provider in bootstrap/app.php

// bootstrap/app.php
<?php

/*
|--------------------------------------------------------------------------
| Register Service Providers
|--------------------------------------------------------------------------
|
| Here we will register all of the application's service providers which
| are used to bind services into the container. Service providers are
| totally optional, so you are not required to uncomment this line.
|
*/

// ...

$app->register(\PrusakTech\Lumen\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 have to copy it manually, as it is done in Lumen.

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.

You don't need and should not use the new Factory() pattern described in the SDK documentation, this is already done for you with the Laravel Service Provider. Use Dependency Injection, the Facades or the app() helper instead

License

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