Firebase Admin PHP SDK

Custom authentication methods return an instance of Kreaitirebase\Auth\SignInResult\SignInResult. This object provides access to the authentication data returned by the Firebase API.

Available Accessors:

• $signInResult->idToken(): Returns the ID token (string|null).
• $signInResult->firebaseUserId(): Returns the Firebase UID (string|null).
• $signInResult->accessToken(): Returns the access token (string|null).
• $signInResult->refreshToken(): Returns the refresh token (string|null).
• $signInResult->data(): Returns the full payload of the response (array).
• $signInResult->asTokenResponse(): Returns the result in a format suitable for client-side consumption (array).

$tokenResponse = [
    'token_type' => 'Bearer',
    'access_token' => '...',
    'id_token' => '...',
    'refresh_token' => '...',
    'expires_in' => 3600,
];

Use runTransaction() to update data based on its current state. This ensures that if the data changes during the operation, the transaction fails rather than overwriting with stale data.

Important: You must call $transaction->snapshot($reference) before attempting to modify a reference within a transaction.

use Kreaitirebase//... (imports)
use Kreaitirebase//... (imports)

$counterRef = $database->getReference('counter');

$result = $database->runTransaction(function (Transaction $transaction) use ($counterRef) {
    // You must snapshot the reference to change its value
    $counterSnapshot = $transaction->snapshot($counterRef);

    $counter = $counterSnapshot->getValue() ?: 0;
    $newCounter = ++$counter;

    $transaction->set($counterRef, $newCounter);

    return $newCounter;
});

Shallow queries allow you to limit the depth of data returned. If the location contains a JSON object, the values for each key will be truncated to true, allowing you to see the structure without downloading large child nodes.

Note: Shallow queries cannot be combined with any other query methods (like ordering or filtering).

$database->getReference('currencies')
    ->shallow()
    ->getSnapshot();

All errors returned by the Firebase FCM API are converted into exceptions that implement the Kreait\ Firebase\\Exception\\MessagingException interface.

Key features of these exceptions:

• errors(): A method available on all MessagingException implementations that provides additional error details.
• retryAfter(): Available on certain exceptions (like QuotaExceeded or ServerUnavailable) to return a DateTimeImmutable indicating when it is safe to retry the request.
• token(): Available on NotFound exceptions to retrieve the specific token that could not be found.

Most objects in this SDK are immutable. You can identify them by the presence of with* methods (e.g., withChangedProperty()). When calling these methods, the original object remains unchanged; you must capture the returned object to access the modifications.

$changedObject = $object->withChangedProperty();

To access Firebase services, use the Kreait\Firebase\Factory class. You typically initialize the factory with a service account JSON file and, if necessary, a specific database URI. From the factory instance, you can create service-specific clients such as Auth, Realtime Database, Cloud Messaging, Remote Config, Cloud Storage, and Firestore.

use Kreaitirebaseactory;

$factory = (new Factory)
    ->withServiceAccount('/path/to/firebase_credentials.json')
    ->withDatabaseUri('https://my-project-default-rtdb.firebaseio.com');

$auth = $factory->createAuth();
$realtimeDatabase = $factory->createDatabase();
$cloudMessaging = $factory->createMessaging();
$remoteConfig = $factory->createRemoteConfig();
$cloudStorage = $factory->createStorage();
$firestore = $factory->createFirestore();

To connect your application to Firebase, use the Kreait\Firebase\Factory class. You can configure the factory with a service account JSON file and a database URI, then use it to instantiate various Firebase service clients such as Auth, Realtime Database, Cloud Messaging, Remote Config, Cloud Storage, and Firestore.

use Kreaitirebaseactory;

$factory = (new Factory)
    ->withServiceAccount('/path/to/firebase_credentials.json')
    ->withDatabaseUri('https://my-project-default-rtdb.firebaseio.com');

$auth = $factory->createAuth();
$realtimeDatabase = $factory->createDatabase();
$cloudMessaging = $factory->createMessaging();
$remoteConfig = $factory->createRemoteConfig();
$cloudStorage = $factory->createStorage();
$firestore = $factory->createFirestore();

To follow the principle of least privilege, you can use withDatabaseAuthVariableOverride() when creating your database instance. This allows you to simulate a specific uid in your Security Rules, effectively downscoping the Admin SDK's permissions to match a specific service identity defined in your rules.

To act as an unauthenticated client, pass null to the override method.

use Kreait\Firebase\Factory;

$factory = (new Factory)
    ->withServiceAccount('/path/to/firebase_credentials.json')
    ->withDatabaseUri('https://my-project-default-rtdb.firebaseio.com');

// Access as a specific service user defined in rules
$database = $factory
    ->withDatabaseAuthVariableOverride('my-service-worker')
    ->createDatabase();

// Access as an unauthenticated client (public access only)
$database = $factory
    ->withDatabaseAuthVariableOverride(null)
    ->createDatabase();

To use the Realtime Database, create a database instance from your existing Firebase factory.

$database = $factory->createDatabase();

To use Firebase Authentication features, you must first initialize the Auth component using the factory instance.

$auth = $factory->createAuth();