rookiexxk/hyperf-firebase

A Hyperf package for the Firebase PHP Admin SDK

v1.0 2024-03-06 11:25 UTC

Requires

• php: >=8.1
• hyperf/cache: ~3.1.0
• hyperf/guzzle: ~3.1.0
• hyperf/logger: ~3.1.0
• hyperf/utils: ~3.1.0
• kreait/firebase-php: ^7.0
• symfony/cache: ^5.4|^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^1.0
• swoole/ide-helper: dev-master

MIT

• database
• api
• sdk
• gcm
• firebase
• FCM
• hyperf

README

A Hyperf package for the Firebase PHP Admin SDK.

Installation

composer require rookiexxk/hyperf-firebase

Publish

php bin/hyperf.php vendor:publish fcorz/hyperf-firebase

Configuration

Credentials with JSON files

FIREBASE_CREDENTIALS=config/certificates/service-account-file.json

Usage

Facades

use Fcorz\Hyperf\Firebase\Facades\Firebase;

// Return an instance of the Messaging component for the default Firebase project
$defaultMessaging = Firebase::messaging();

// Return an instance of the Auth component for a specific Firebase project
$appMessaging = Firebase::project('app')->messaging();

$anotherAppMessaging = Firebase::project('another-app')->messaging();

// send message
$message = [
    'token' => $deviceToken,
    'notification' => [/* Notification data as array */], // optional
    'data' => [/* data array */], // optional
];

Firebase::messaging()->send($message);

Dependency Injection

use Fcorz\Hyperf\Firebase\ApplicationProxy;

class yourProjectFirebase extends ApplicationProxy
{
    protected string $name = 'project_name';

}

// send message
class yourClass
{
    public function __construct(yourProjectFirebase $firebase)
    {
        $firebase->messaging()->send($message);
    }
}

The future of the Firebase Admin PHP SDK

Please read about the future of the Firebase Admin PHP SDK on the SDK's GitHub Repository.