kreait/laravel-firebase

A Laravel package for the Firebase PHP Admin SDK

3.2.0 2021-10-21 22:47 UTC

This package is auto-updated.

Last update: 2021-10-21 22:50:38 UTC


README

A Laravel package for the Firebase PHP Admin SDK.

Current version Monthly Downloads Total Downloads Tests codecov Discord Sponsor

Installation

This package requires Laravel 6.x and higher or Lumen 6.x and higher.

composer require kreait/laravel-firebase

If you use Lumen or don't use Laravel's package auto-discovery, add the following service provider in config/app.php (Laravel) or bootstrap/app.php (Lumen):

Laravel

<?php
// config/app.php
return [
    // ...
    'providers' => [
        // ...
        Kreait\Laravel\Firebase\ServiceProvider::class
    ]
    // ...
];

Lumen

<?php
// bootstrap/app.php

$app->register(Kreait\Laravel\Firebase\ServiceProvider::class);

// If you want to use the Facades provided by the package
$app->withFacades();

Upgrade

See UPGRADE.md for upgrade instructions.

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 for the default project 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 configure the package by specifying environment variables starting with FIREBASE_ in your .env file. Usually, the following are required for the package to work:

# relative or full path to the Service Account JSON file
FIREBASE_CREDENTIALS=
# You can find the database URL for your project at
# https://console.firebase.google.com/project/_/database
FIREBASE_DATABASE_URL=https://<your-project>.firebaseio.com

For further configuration, please see config/firebase.php. You can modify the configuration by copying it to your local config directory or by defining the environment variables used in the config file:

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

# Lumen
mkdir -p config
cp vendor/kreait/laravel-firebase/config/firebase.php config/firebase.php

Usage

Component Automatic Injection Facades app()
Authentication \Kreait\Firebase\Auth Firebase::auth() app('firebase.auth')
Cloud Firestore \Kreait\Firebase\Firestore Firebase::firestore() app('firebase.firestore')
Cloud Messaging (FCM) \Kreait\Firebase\Messaging Firebase::messaging() app('firebase.messaging')
Dynamic Links \Kreait\Firebase\DynamicLinks Firebase::dynamicLinks() app('firebase.dynamic_links')
Realtime Database \Kreait\Firebase\Database Firebase::database() app('firebase.database')
Remote Config \Kreait\Firebase\RemoteConfig Firebase::remoteConfig() app('firebase.remote_config')
Cloud Storage \Kreait\Firebase\Storage Firebase::storage() 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

Multiple projects

Multiple projects can be configured in config/firebase.php by adding another section to the projects array.

When accessing components, the facade uses the default project. You can also explicitly use a project:

use Kreait\Laravel\Firebase\Facades\Firebase;

// Return an instance of the Auth component for the default Firebase project
$defaultAuth = Firebase::auth();
// Return an instance of the Auth component for a specific Firebase project
$appAuth = Firebase::project('app')->auth();
$anotherAppAuth = Firebase::project('another-app')->auth();

Support

License

Firebase Admin PHP SDK is licensed under the MIT License.

Your use of Firebase is governed by the Terms of Service for Firebase Services.