Firebase Admin SDK for PHP

https://github.com/beste/firebase-php
Admin
The Firebase Admin PHP SDK enables access to Firebase services from privileged environments (such as...
Tokens:52,828
Snippets:453
Trust Score:7.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with composer setup

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Installs project dependencies. Run this first during local setup.

```bash
composer setup
```

--------------------------------

### Get App Instance Information with Example Outputs

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Retrieve current information about an app instance using its registration token. Includes commented examples of output for Android and web application instances.

```php
$registrationToken = '...';

$appInstance = $messaging->getAppInstance($registrationToken);
// Return the full information as provided by the Firebase API
$instanceInfo = $appInstance->rawData();

/* Example output for an Android application instance:
    [
      "applicationVersion" => "1060100"
      "connectDate" => "2019-07-21"
      "attestStatus" => "UNKNOWN"
      "application" => "com.vendor.application"
      "scope" => "*"
      "authorizedEntity" => "..."
      "rel" => array:1 [
        "topics" => array:3 [
          "test-topic" => array:1 [
            "addDate" => "2019-07-21"
          ]
          "test-topic-5d35b46a15094" => array:1 [
            "addDate" => "2019-07-22"
          ]
          "test-topic-5d35b46b66c31" => array:1 [
            "addDate" => "2019-07-22"
          ]
        ]
      ]
      "connectionType" => "WIFI"
      "appSigner" => "..."
      "platform" => "ANDROID"
    ]
*/

/* Example output for a web application instance
    [
      "application" => "webpush"
      "scope" => ""
      "authorizedEntity" => "..."
      "rel" => array:1 [
        "topics" => array:2 [
          "test-topic-5d35b445b830a" => array:1 [
            "addDate" => "2019-07-22"
          ]
          "test-topic-5d35b446c0839" => array:1 [
            "addDate" => "2019-07-22"
          ]
        ]
      ]
      "platform" => "BROWSER"
    ]
*/
```

--------------------------------

### Getting started sending a message with withToken()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Creates a CloudMessage with a notification, data, and a device token. Use either a token, topic, or condition; only one can be set.

```php
use Kreait\Firebase\Messaging\CloudMessage;

$message = CloudMessage::new()
    ->withNotification(Notification::create('Title', 'Body'))
    ->withData(['key' => 'value'])
    ->withToken('...')
    // ->withTopic('...')
    // ->withCondition('...')
;

$messaging->send($message);
```

--------------------------------

### Example Output of openssl_get_cert_locations

Source: https://github.com/beste/firebase-php/blob/8.x/docs/troubleshooting.rst

The expected output format when checking PHP certificate locations.

```php
array(8) {
    'default_cert_file' =>
    string(32) "/usr/local/etc/openssl/cert.pem"
    'default_cert_file_env' =>
    string(13) "SSL_CERT_FILE"
    'default_cert_dir' =>
    string(29) "/usr/local/etc/openssl/certs"
    'default_cert_dir_env' =>
    string(12) "SSL_CERT_DIR"
    'default_private_dir' =>
    string(31) "/usr/local/etc/openssl/private"
    'default_default_cert_area' =>
    string(23) "/usr/local/etc/openssl"
    'ini_cafile' =>
    string(0) ""
    'ini_capath' =>
    string(0) ""
}
```

--------------------------------

### Install Firebase CLI and run emulator tests

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Installs the locked Firebase CLI and runs the emulator test suite, which uses ports 9099 and 9100 for Auth and Realtime Database emulators.

```bash
composer tools:firebase:install
```

```bash
composer test:emulator
```

--------------------------------

### Migration example for type simplifications

Source: https://github.com/beste/firebase-php/blob/8.x/UPGRADE-8.0.md

Shows how to update code when passing Stringable objects to createUser and getUser methods. Extract the string value with (string) and use the uid property from the returned user record.

```diff
+use Kreait\Firebase\Auth\CreateUser;
+
 $userRecord = $auth->createUser(
-    CreateUser::new()->withEmail($emailObject)
+    CreateUser::new()->withEmail((string) $emailObject)
 );

-$user = $auth->getUser($userRecord);
+$user = $auth->getUser($userRecord->uid);
```

--------------------------------

### Install Firebase Admin PHP SDK with Composer

Source: https://github.com/beste/firebase-php/blob/8.x/README.md

Install the Firebase Admin PHP SDK version 8.0 or compatible using Composer.

```bash
composer require "kreait/firebase-php:^8.0"
```

--------------------------------

### Example: Sending a Message with Lowest Possible Priority

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows how to create a CloudMessage with a notification and set it to the lowest possible priority, while also overriding the APNS config with an immediate priority notification.

```php
$message = CloudMessage::new()
    ->withNotification([
        'title' => 'If you had an iOS device…',
        'body' => '… you would have received a very important message'
    ])
    ->withLowestPossiblePriority()
    ->withApnsConfig(
        ApnsConfig::new()
            ->withImmediatePriority()
            ->withNotification([
                'title => 'A very important message…',
                'body' => '… that requires your immediate attention.'
            ])
    )
;
```

--------------------------------

### Initialize Messaging component with createMessaging()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Creates a Messaging instance from the Firebase factory. This is the starting point for sending messages.

```php
$messaging = $factory->createMessaging();
```

--------------------------------

### Set database rules with RuleSet

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Use RuleSet to define default, public, private, or custom rules. The example shows how to create a RuleSet and update the database rules, then retrieve the current rules.

```php
use Kreait\Firebase\Database\RuleSet;

// The default rules allow full read and write access to authenticated users of your app
$ruleSet = RuleSet::default();

// This level of access means anyone can read or write to your database. You should
// configure more secure rules before launching your app.
$ruleSet = RuleSet::public();

// Private rules disable read and write access to your database by users.
// With these rules, you can only access the database through the
// Firebase console and the Admin SDKs.
$ruleSet = RuleSet::private();

// You can define custom rules
$ruleSet = RuleSet::fromArray(['rules' => [
    '.read' => true,
    '.write' => false,
    'users' => [
        '$uid' => [
            '.read' => '$uid === auth.uid',
            '.write' => '$uid === auth.uid',
        ]
    ]
]]);

$database->updateRules($ruleSet);

$freshRuleSet = $database->getRuleSet(); // Returns a new RuleSet instance
$actualRules = $ruleSet->getRules(); // returns an array
```

--------------------------------

### Add parameter group with UI colors

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Shows how to create a parameter group with named parameters and add it to a template. The example uses 'UI Colors' group with 'Primary Color' and 'Secondary Color' parameters.

```php
$uiColors = RemoteConfig\ParameterGroup::named('UI Colors')
    ->withDescription('Remote configurable UI colors')
    ->withParameter(RemoteConfig\Parameter::named('Primary Color')->withDefaultValue('blue'))
    ->withParameter(RemoteConfig\Parameter::named('Secondary Color')->withDefaultValue('red'))
;

$template = $template->withParameterGroup($parameterGroup);
```

--------------------------------

### Set/replace values with set()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Uses set() to save data to a specified reference, replacing any existing data at that path. Includes an example of setting a configuration array and then updating a single child value.

```php
$database->getReference('config/website')
    ->set([
        'name' => 'My Application',
        'emails' => [
            'support' => 'support@example.com',
            'sales' => 'sales@example.com',
        ],
        'website' => 'https://app.example.com',
    ]);

$database->getReference('config/website/name')->set('New name');
```

--------------------------------

### Install Firestore dependency

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-firestore.rst

Use Composer to add the google/cloud-firestore package to your project dependencies. This package requires the gRPC PHP extension.

```bash
composer require google/cloud-firestore
```

--------------------------------

### Get storage client and buckets

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-storage.rst

Retrieves the underlying Google Cloud Storage client and bucket instances. The default bucket is used when no name is provided.

```php
$storageClient = $storage->getStorageClient();
$defaultBucket = $storage->getBucket();
$anotherBucket = $storage->getBucket('another-bucket');
```

--------------------------------

### Get Child Keys with getChildKeys()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Convenience method to retrieve the key names of a reference's children as an array.

```php
$database->getReference('currencies')->getChildKeys(); // returns an array of key names
```

--------------------------------

### Get a specific Remote Config version

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Retrieves a specific version by its version number using getVersion().

```php
$version = $remoteConfig->getVersion($versionNumber);
```

--------------------------------

### Get Firestore database instance

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-firestore.rst

Retrieve the database instance, which is an object of type Google\Cloud\Firestore\FirestoreClient.

```php
$database = $firestore->database();
```

--------------------------------

### Configure Caching with Symfony FilesystemCache

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Provide a PSR-6 cache implementation to the factory for persistent caching. The example uses Symfony's FilesystemCache and shows separate caches for authentication tokens, JWKS, and verified tokens/session cookies.

```php
use Symfony\Component\Cache\Simple\FilesystemCache;

// One Cache instance for all components
$factory = $factory->withDefaultCache(new FilesystemCache());

// Cache used for authentication tokens, so that they requests don't have to be re-authenticated
$factory = $factory->withAuthTokenCache(new FilesystemCache());

// Cache used to store JWKS (JSON Web Key Sets), so that they don't have to be fetched again
$factory = $factory->withKeySetCache(new FilesystemCache());

// Cache used to store verified ID tokens and session cookies, so that they don't have to be verified again
$factory = $factory->withVerifierCache(new FilesystemCache());
```

--------------------------------

### Get multiple users with result

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Retrieves multiple user records. When a user doesn't exist, no exception is thrown, but its entry in the result set is null.

```php
$users = $auth->getUsers(['some-uid', 'another-uid', 'non-existing-uid']);
```

```text
[
    'some-uid' => <UserRecord>,
    'another-uid' => <UserRecord>,
    'non-existing-uid' => null
]
```

--------------------------------

### Get user by uid, email, phone, or provider uid

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Retrieves a specific user by uid, email, phone number, or provider uid. Throws Kreait\Firebase\Exception\Auth\UserNotFound if the user does not exist.

```php
try {
    $user = $auth->getUser('some-uid');
    $user = $auth->getUserByEmail('user@example.com');
    $user = $auth->getUserByPhoneNumber('+49-123-456789');
    // For `getUserByProviderUid()` please see the section below.
    $user = $auth->getUserByProviderUid('google.com', 'google-uid');
} catch (\Kreait\Firebase\Exception\Auth\UserNotFound $e) {
    echo $e->getMessage();
}
```

--------------------------------

### Get Remote Config template and version

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Retrieves the current Remote Config template and its version. You can also retrieve a specific template version by passing the version number.

```php
$template = $remoteConfig->get(); // Returns a Kreait\Firebase\RemoteConfig\Template
$version = $template->version(); // Returns a Kreait\Firebase\RemoteConfig\Version
$template = $remoteConfig->get($version->versionNumber()); // Returns a Kreait\Firebase\RemoteConfig\Template with the specified version
```

--------------------------------

### Listen to MessagesSent with Symfony EventDispatcher

Source: https://github.com/beste/firebase-php/blob/8.x/docs/events.rst

Example using the Symfony EventDispatcher to listen for the MessagesSent event. The listener receives the event with report and validateOnly properties, and the dispatcher is attached to the factory before creating the messaging component.

```php
use Kreait\Firebase\Messaging\Event\MessagesSent;
use Symfony\Component\EventDispatcher\EventDispatcher;

$eventDispatcher = new EventDispatcher();

$eventDispatcher->addListener(
    MessagesSent::class,
    function (MessagesSent $event): void {
        $report = $event->report;
        $validateOnly = $event->validateOnly;
    },
);

$messaging = $factory
    ->withEventDispatcher($eventDispatcher)
    ->createMessaging();
```

--------------------------------

### ActionCodeSettings array for email action links

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Defines an ActionCodeSettings array with a continue URL, handleCodeInApp flag, Android package name, minimum version, install app flag, and iOS bundle ID. Used to configure email action links for verification, password reset, or sign-in.

```php
$actionCodeSettings = [
    'continueUrl' => 'https://www.example.com/checkout?cartId=1234',
    'handleCodeInApp' => true,
    'androidPackageName' => 'com.example.android',
    'androidMinimumVersion' => '12',
    'androidInstallApp' => true,
    'iOSBundleId' => 'com.example.ios',
];
```

--------------------------------

### Initialize Realtime Database with createDatabase()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Initializes the Realtime Database component using the factory. This is the first step before any database operations.

```php
$database = $factory->createDatabase();
```

--------------------------------

### Initialize Firebase Admin SDK and Create Services

Source: https://github.com/beste/firebase-php/blob/8.x/README.md

Initialize the Firebase Admin SDK with a service account and database URI, then create service instances for Auth, Realtime Database, Cloud Messaging, Remote Config, Cloud Storage, and Firestore.

```php
use Kreait\Firebase\Factory;

$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();
```

--------------------------------

### Generate and send sign-in with email link

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Shows how to generate a sign-in link with getSignInWithEmailLink() and send it with sendSignInWithEmailLink(), optionally passing a locale.

```php
$link = $auth->getSignInWithEmailLink($email, $actionCodeSettings);
```

```php
$auth->sendSignInWithEmailLink($email, $actionCodeSettings);
$auth->sendSignInWithEmailLink($email, $actionCodeSettings, $locale);
```

--------------------------------

### Create tenant-aware authentication with withTenantId

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Configure the factory with a tenant ID to manage users, create custom tokens, verify ID tokens, and sign in users in the scope of a tenant. Requires Google Cloud's Identity Platform (GCIP) and tenants must be allowed on the project via the Cloud Console UI.

```php
$tenantUnawareAuth = $factory->createAuth();

$tenantAwareAuth = $factory
    ->withTenantId('my-tenant-id')
    ->createAuth();
```

--------------------------------

### Initialize Firestore component

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-firestore.rst

Create an instance of the Firestore component using the factory.

```php
$firestore = $factory->createFirestore();
```

--------------------------------

### List Remote Config versions

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Shows how to iterate over versions using listVersions(), which returns a Generator to avoid memory issues. Includes a foreach loop and an array_map alternative.

```php
foreach ($auth->listVersions() as $version) {
    /** @var \Kreait\Firebase\RemoteConfig\Version $version */
    // ...
}

// or

array_map(function (\Kreait\Firebase\RemoteConfig\Version $version) {
    // ...
}, iterator_to_array($auth->listVersions()));
```

--------------------------------

### Get user by provider UID

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Retrieves a user by their federated identity provider UID. Throws a \Kreait\Firebase\Exception\Auth\UserNotFound exception if the user is not found.

```php
try {
    $googleUser = $auth->getUserByProviderUid('google.com', 'google-uid');
    $facebookUser = $auth->getUserByProviderUid('facebook.com', 'facebook-uid');
} catch (\Kreait\Firebase\Exception\Auth\UserNotFound $e) {
    echo $e->getMessage();
}
```

--------------------------------

### Set Project ID and Database URI with Factory

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Manually set the project ID and database URI when credentials do not include them. This is usually unnecessary because service account credentials include the project ID.

```php
use Kreait\Firebase\Factory;

$factory = (new Factory())
    ->withProjectId('my-project')
    ->withDatabaseUri('https://my-project.firebaseio.com');
```

--------------------------------

### Run pre-push checks with composer pre-push

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Runs lint fixes, full tests, and backward-compat checks before pushing.

```bash
composer pre-push
```

--------------------------------

### Run test suites with composer test commands

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Runs the unit, integration, emulator, and full test suites.

```bash
composer test:unit
```

```bash
composer test:integration
```

```bash
composer test:emulator
```

```bash
composer test:all
```

--------------------------------

### Configure HTTP Client Options with Timeout, Proxy, and Custom Handler

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Create HttpClientOptions and set a timeout, proxy, and custom Guzzle handler. Pass the options to the factory to affect newly created services.

```php
use Kreait\Firebase\Http\HttpClientOptions;

$options = HttpClientOptions::default();

// Set the maximum amount of seconds (float) that can pass before
// a request is considered timed out
// (default: indefinitely)
$options = $options->withTimeOut(3.5);

// Use a proxy that all API requests should be passed through.
// (default: none)
$options = $options->withProxy('tcp://<host>:<port>');

// Use a custom handler
$options = $options->withGuzzleHandler(...);

$factory = $factory->withHttpClientOptions($options);

// Newly created services will now use the new HTTP options
$realtimeDatabase = $factory->createDatabase();
```

--------------------------------

### Copy tests/.env.dist to tests/.env

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Creates the local test environment configuration file from the distribution template.

```bash
cp tests/.env.dist tests/.env
```

--------------------------------

### Check cURL version in PHP

Source: https://github.com/beste/firebase-php/blob/8.x/docs/troubleshooting.rst

Use this PHP snippet to display the installed cURL version. It is useful for diagnosing issues in XAMPP/WAMP environments where cURL version 7.67 or newer is required.

```php
echo curl_version()['version']; exit;
```

--------------------------------

### Create and modify a Notification with withTitle, withBody, withImageUrl

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows how to create a Notification and then create a modified copy using the withTitle, withBody, and withImageUrl methods. The original notification is not changed; the methods return a new instance.

```php
$notification = Notification::create($title, $body);

$changedNotification = $notification
    ->withTitle('Changed title')
    ->withBody('Changed body')
    ->withImageUrl('https://example.com/image.jpg');
```

--------------------------------

### Initialize App Check with createAppCheck()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/app-check.rst

Initializes the App Check component using the factory. The returned instance is used for token verification and creation.

```php
$appCheck = $factory->createAppCheck();
```

--------------------------------

### Initialize the Storage component

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-storage.rst

Creates a storage instance using the Firebase factory. This is the first step before accessing storage functionality.

```php
$storage = $factory->createStorage();
```

--------------------------------

### Verify a Firebase Session Cookie

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Verifies a session cookie using Auth::verifySessionCookie(). Throws FailedToVerifySessionCookie if invalid. The verified cookie claims can be used to get the user UID and fetch the user.

```php
use Kreait\Firebase\Exception\Auth\FailedToVerifySessionCookie;

$sessionCookieString = '...';

try {
    $verifiedSessionCookie = $auth->verifySessionCookie($sessionCookieString);
} catch (FailedToVerifySessionCookie $e) {
    echo 'The Session Cookie is invalid: '.$e->getMessage();
}

$uid = $verifiedSessionCookie->claims()->get('sub');

$user = $auth->getUser($uid);
```

--------------------------------

### Retrieve Topic Subscriptions for an App Instance

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Fetches all topic subscriptions for a given app instance and iterates over them, printing each registration token and its subscribed topic.

```php
$appInstance = $messaging->getAppInstance('<registration token>');

/** @var \Kreait\Firebase\Messaging\TopicSubscriptions $subscriptions */
$subscriptions = $appInstance->topicSubscriptions();

foreach ($subscriptions as $subscription) {
    echo "{$subscription->registrationToken()} is subscribed to {$subscription->topic()}\n";
}
```

--------------------------------

### Filter Remote Config versions

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Shows how to filter listVersions() results using FindVersions::all() with startingAt, endingAt, upToVersion, withPageSize, and withLimit. Also shows an alternative array notation.

```php
use Kreait\Firebase\RemoteConfig\FindVersions;

$query = FindVersions::all()
    // Versions created/updated after August 1st, 2019 at midnight
    ->startingAt(new DateTime('2019-08-01 00:00:00'))
    // Versions created/updated before August 7th, 2019 at the end of the day
    ->endingAt(new DateTime('2019-08-06 23:59:59'))
    // Versions with version numbers smaller than 3464
    ->upToVersion(VersionNumber::fromValue(3463))
    // Setting a page size can results in faster first results,
    // but results in more request
    ->withPageSize(5)
    // Stop querying after the first 10 results
    ->withLimit(10)
;

// Alternative array notation

$query = [
    'startingAt' => '2019-08-01',
    'endingAt' => '2019-08-07',
    'upToVersion' => 9999,
    'pageSize' => 5,
    'limit' => 10,
];

foreach ($remoteConfig->listVersions($query) as $version) {
    echo "Version number: {$version->versionNumber()}\n";
    echo "Last updated at {$version->updatedAt()->format('Y-m-d H:i:s')}\n";
    // ...
    echo "\n---\n";
}
```

--------------------------------

### Security rules JSON for service worker

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Example security rules that grant access based on a custom auth UID. The rules allow read/write for public resources and restrict access to specific resources for the service worker.

```json
{
  "rules": {
    "public_resource": {
      ".read": true,
      ".write": true
    },
    "some_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": false
    },
    "another_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": "auth.uid === 'my-service-worker'"
    }
  }
}
```

--------------------------------

### Run static analysis with composer analyze

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Runs PHPStan static analysis.

```bash
composer analyze
```

--------------------------------

### Create a Reference with getReference()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Creates a reference to a database node. Creating a reference does not send a request; requests are only executed with getSnapshot() and getValue().

```php
$reference = $database->getReference('path/to/child/location');
```

--------------------------------

### Sign in with IdP access token and ID token

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user with IdP credentials. Use signInWithIdpAccessToken() with an access token or signInWithIdpIdToken() with an ID token. Optional parameters include redirectUrl, oauthTokenSecret, linkingIdToken, and rawNonce.

```php
$signInResult = $auth->signInWithIdpAccessToken($provider, string $accessToken, $redirectUrl = null, ?string $oauthTokenSecret = null, ?string $linkingIdToken = null, ?string $rawNonce = null);

$signInResult = $auth->signInWithIdpIdToken($provider, $idToken, $redirectUrl = null, ?string $linkingIdToken = null, ?string $rawNonce = null);
```

--------------------------------

### Initialize the Auth component

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Creates an Auth instance from the Firebase factory. This is the first step before using any authentication methods.

```php
$auth = $factory->createAuth();
```

--------------------------------

### Configure Firestore client

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-firestore.rst

Pass additional configuration options to the Firestore client using the withFirestoreClientConfig method.

```php
use Kreait\Firebase\Factory;

$factory = new Factory();

$firestore = $factory
    ->withFirestoreClientConfig([...])
    ->createFirestore();
```

--------------------------------

### Create a new Remote Config template

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Creates a new empty Remote Config template using the static factory method.

```php
use Kreait\Firebase\RemoteConfig;

$template = RemoteConfig\Template::new();
```

--------------------------------

### Sign in with email and password

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user with an email address and clear-text password.

```php
$signInResult = $auth->signInWithEmailAndPassword($email, $clearTextPassword);
```

--------------------------------

### List users with listUsers()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Lists all users using a Generator to avoid memory issues with large user sets. The method accepts optional max results and batch size parameters, both defaulting to 1000.

```php
$users = $auth->listUsers($defaultMaxResults = 1000, $defaultBatchSize = 1000);

foreach ($users as $user) {
    /** @var \Kreait\Firebase\Auth\UserRecord $user */
    // ...
}
// or
array_map(function (\Kreait\Firebase\Auth\UserRecord $user) {
    // ...
}, iterator_to_array($users));
```

--------------------------------

### Configure Service Account with Kreait\Firebase\Factory

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Provide a service account JSON key file directly to the factory when auto-discovery is not wanted. The file should be stored securely outside the code repository.

```php
use Kreait\Firebase\Factory;

$factory = (new Factory)->withServiceAccount('/path/to/firebase_credentials.json');
```

--------------------------------

### Send message to a topic using withTopic() and fromArray()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows two ways to create a message targeting a topic and send it, with error handling. Includes optional notification and data.

```php
use Kreait\Firebase\Exception\MessagingException;
use Kreait\Firebase\Messaging\CloudMessage;

$topic = 'a-topic';

$message = CloudMessage::new()
    ->withNotification($notification) // optional
    ->withData($data) // optional
    ->withTopic($topic)
;

$message = CloudMessage::fromArray([
    'topic' => $topic,
    'notification' => [/* Notification data as array */], // optional
    'data' => [/* data array */], // optional
]);

try {
    $result = $messaging->send($message);
    // $result = ['name' => 'projects/<project-id>/messages/6810356097230477954']
} catch (MessagingException $e) {
    // ...
}
```

--------------------------------

### getAppInstance

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Retrieves information about an app instance associated with a registration token.

```APIDOC
## getAppInstance

### Description
Retrieves information about an app instance associated with a registration token.

### Method
N/A (PHP SDK method)

### Endpoint
$messaging->getAppInstance($registrationToken)

### Parameters
- **$registrationToken** (string) - Required - A registration token for the app instance.

### Response
Returns an AppInstance object. The full raw data can be obtained via `$appInstance->rawData()`.
```

--------------------------------

### Order by Key with orderByKey()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Orders the reference's children by their key in ascending order. Only one order query can be used at a time.

```php
$database->getReference('currencies')
    // order the reference's children by their key in ascending order
    ->orderByKey()
    ->getSnapshot();
```

--------------------------------

### Add a parameter with default value and description

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Creates a parameter with a default value, an optional description, and a value type. Note: the value type method signature shown is incomplete.

```php
use Kreait\Firebase\RemoteConfig;
use Kreait\Firebase\RemoteConfig\ParameterValueType;

$welcomeMessageParameter = RemoteConfig\Parameter::named('welcome_message')
        ->withDefaultValue('Welcome!')
        ->withDescription('This is a welcome message') // optional
        ->withValueType(ParameterValueType $valueType): self
;
```

--------------------------------

### Sign in with email and OOB code

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user with an email address and an out-of-band (OOB) code.

```php
$signInResult = $auth->signInWithEmailAndOobCode($email, $oobCode);
```

--------------------------------

### Run tests with coverage

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Runs tests with coverage reporting.

```bash
composer test:coverage
```

--------------------------------

### Create a user with properties or request

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Creates a new Firebase Authentication user using either an array of properties or a \Kreait\Auth\Request\CreateUser request object. Both approaches are equivalent.

```php
$userProperties = [
    'email' => 'user@example.com',
    'emailVerified' => false,
    'phoneNumber' => '+15555550100',
    'password' => 'secretPassword',
    'displayName' => 'John Doe',
    'photoUrl' => 'http://www.example.com/12345678/photo.png',
    'disabled' => false,
];

$createdUser = $auth->createUser($userProperties);

// This is equivalent to:

$request = \Kreait\Auth\Request\CreateUser::new()
    ->withUnverifiedEmail('user@example.com')
    ->withPhoneNumber('+15555550100')
    ->withClearTextPassword('secretPassword')
    ->withDisplayName('John Doe')
    ->withPhotoUrl('http://www.example.com/12345678/photo.png');

$createdUser = $auth->createUser($request);
```

--------------------------------

### Initialize Remote Config component

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Creates a Remote Config instance using the Firebase factory. This is the first step before any Remote Config operations.

```php
$remoteConfig = $factory->createRemoteConfig();
```

--------------------------------

### Filter with startAt(1.68)

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Returns all persons taller than or exactly 1.68 meters.

```php
$database->getReference('people')
    // order the reference's children by the values in the field 'height'
    ->orderByChild('height')
    // returns all persons taller than or exactly 1.68 (meters)
    ->startAt(1.68)
    ->getSnapshot();
```

--------------------------------

### Sign in with custom token

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user with a custom token.

```php
$signInResult = $auth->signInWithCustomToken($customToken);
```

--------------------------------

### Write server timestamp with set()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Writes a server timestamp to a location using the '.sv' placeholder or the Database::SERVER_TIMESTAMP constant. Both usages are equivalent and set the 'created_at' field to the server time.

```php
$ref = $database->getReference('posts/my-post')
          ->set('created_at', ['.sv' => 'timestamp']);

$ref = $database->getReference('posts/my-post')
          ->set('created_at', Database::SERVER_TIMESTAMP);
```

--------------------------------

### Migrate CloudMessage target methods to with* pattern

Source: https://github.com/beste/firebase-php/blob/8.x/UPGRADE-8.0.md

Shows the migration from deprecated CloudMessage target methods (toToken, toTopic, toCondition) to the new with* methods (withToken, withTopic, withCondition). The old methods remain as deprecated aliases.

```diff
-$message = CloudMessage::new()
-    ->toToken('device-token')
-    ->withNotification(['title' => 'Hello']);
+$message = CloudMessage::new()
+    ->withToken('device-token')
+    ->withNotification(['title' => 'Hello']);

-$message->toTopic('news');
+$message->withTopic('news');

-$message->toCondition("'dogs' in topics");
+$message->withCondition("'dogs' in topics");
```

--------------------------------

### Enable a user

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Enables the user with the given UID. The updated user object is returned.

```php
$uid = 'some-uid';

$updatedUser = $auth->enableUser($uid);
```

--------------------------------

### Configure Realtime Database emulator in firebase.json

Source: https://github.com/beste/firebase-php/blob/8.x/docs/testing.rst

Configuration for the Realtime Database emulator. The default port 9000 may conflict with PHP-FPM, so choose a different one. The emulator must be running for the PHP SDK to connect.

```json
{
  "emulators": {
    "database": {
      "port": 9100
    }
  }
}
```

--------------------------------

### Configure Auth emulator in firebase.json

Source: https://github.com/beste/firebase-php/blob/8.x/docs/testing.rst

Configuration for the Firebase Auth emulator. Set the port to your requirements. The emulator must be running for the PHP SDK to connect.

```json
{
  "emulators": {
    "auth": {
      "port": 9099
    }
  }
}
```

--------------------------------

### Migrate removed Factory logging and debug methods

Source: https://github.com/beste/firebase-php/blob/8.x/UPGRADE-8.0.md

Migration for removed Factory methods: withHttpLogger, withHttpDebugLogger, and getDebugInfo. Use Guzzle middleware or inspect services directly as replacements.

```diff
-$factory = $factory->withHttpLogger($logger);
-$factory = $factory->withHttpDebugLogger($logger);
+// Use Guzzle middleware or your HTTP client's logging instead
+// See: https://docs.guzzlephp.org/en/stable/handlers-and-middleware.html

-$debugInfo = $factory->getDebugInfo();
+// No direct replacement - inspect services directly if needed
```

--------------------------------

### Query users with queryUsers()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Executes a user query built with UserQuery or an array. Returns an array of UserRecord objects, or an empty array if none are found.

```php
$users = $auth->queryUsers($userQuery);
```

--------------------------------

### Connect to multiple Firestore databases

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-firestore.rst

Specify a database name when creating an instance to connect to non-default databases or work with multiple databases simultaneously.

```php
use Kreait\Firebase\Factory;

$factory = new Factory();

$default = $factory->createFirestore();
$explicitDefault = $factory->createFirestore('(default)');
$custom = $factory->createFirestore('custom');
```

--------------------------------

### Rollback to a Remote Config version

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Rolls back to a specific version using rollbackToVersion(), returning a template.

```php
$template = $remoteConfig->rollbackToVersion($versionNumber);
```

--------------------------------

### Attach data payload to a message with withData

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows how to define a data array with string key-value pairs and attach it to a message using the withData method. All keys and values must be strings.

```php
$data = [
    'first_key' => 'First Value',
    'second_key' => 'Second Value',
];

$message = $message->withData($data);
```

--------------------------------

### AppInstance::topicSubscriptions

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Retrieves all topic subscriptions for a given app instance.

```APIDOC
## AppInstance::topicSubscriptions

### Description
Retrieves all topic subscriptions for a given app instance.

### Method
N/A (PHP SDK method)

### Endpoint
$appInstance->topicSubscriptions()

### Parameters
None

### Response
Returns a TopicSubscriptions object that can be iterated to access each subscription, with methods registrationToken() and topic().
```

--------------------------------

### Topic Management - Subscribe and Unsubscribe

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Subscribe or unsubscribe one or multiple devices to/from one or multiple topics, or unsubscribe from all topics. Results are an array keyed by topic name with operation results per token. Cannot exceed 1,000 devices per request.

```php
$result = $messaging->subscribeToTopic($topic, $registrationTokenOrTokens);
$result = $messaging->subscribeToTopics($topics, $registrationTokenOrTokens);

$result = $messaging->unsubscribeFromTopic($topic, $registrationTokenOrTokens);
$result = $messaging->unsubscribeFromTopics($topics, $registrationTokenOrTokens);

$result = $messaging->unsubscribeFromAllTopics($registrationTokenOrTokens);
```

--------------------------------

### Create a custom token with additional claims

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Creates a custom token with additional claims, such as 'premiumAccount', which become available in Security Rules. The token is converted to a string using toString().

```php
$uid = 'some-uid';
$additionalClaims = [
    'premiumAccount' => true
];

$customToken = $auth->createCustomToken($uid, $additionalClaims);

$customTokenString = $customToken->toString();
```

--------------------------------

### Configure curl.cainfo in php.ini

Source: https://github.com/beste/firebase-php/blob/8.x/docs/troubleshooting.rst

If cURL errors persist, manually set the path to the CA bundle in your php.ini file.

```ini
[curl]
curl.cainfo = /absolute/path/to/cacert.pem
```

--------------------------------

### Change the default storage bucket

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-storage.rst

Configures a custom default storage bucket name when creating the storage instance. The SDK normally assumes the default bucket is <project-id>.appspot.com.

```php
use Kreait\Firebase\Factory;

$storage = (new Factory())
    ->withDefaultStorageBucket('another-default-bucket')
    ->createStorage();
```

--------------------------------

### Run lint checks with composer lint

Source: https://github.com/beste/firebase-php/blob/8.x/CONTRIBUTING.md

Runs Rector, PHP-CS-Fixer, and composer normalization checks.

```bash
composer lint
```

--------------------------------

### Set FIREBASE_DATABASE_EMULATOR_HOST

Source: https://github.com/beste/firebase-php/blob/8.x/docs/testing.rst

Sets the environment variable that makes Firebase Admin SDKs connect to the Realtime Database emulator.

```bash
$ export FIREBASE_DATABASE_EMULATOR_HOST="localhost:9100"
```

--------------------------------

### Handle EMAIL_EXISTS and EMAIL_NOT_FOUND errors

Source: https://github.com/beste/firebase-php/blob/8.x/docs/user-management.rst

Handles the EMAIL_EXISTS error when creating a user with an already registered email and the EMAIL_NOT_FOUND error when signing in with an unregistered email. The catch blocks print the corresponding error messages.

```php
try {
    $user = $auth->createUser([
        'email' => $email,
    ]);
} catch (\Kreait\Firebase\Exception\Auth\EmailExists $e) {
    echo $e->getMessage(); // "The email address is already in use by another account"
}

try {
    $signInResult = $auth->signInWithEmailAndPassword($email, $password);
} catch (\Kreait\Firebase\Exception\Auth\EmailNotFound $e) {
    echo $e->getMessage(); // "There is no user record corresponding to this identifier. The user may have been deleted."
}
```

--------------------------------

### Log API Requests with Monolog

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Set up HTTP request logging using Monolog and a Guzzle log middleware. Requires a PSR-3 logger and logs at INFO level to a specified stream handler.

```php
use GuzzleHttp\MessageFormatter;
use GuzzleHttp\Middleware as GuzzleMiddleware;
use Kreait\Firebase\Factory;
use Kreait\Firebase\Http\HttpClientOptions;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Psr\Log\LogLevel;

$httpLogger = new Logger('firebase_http_logs');
$httpLogger->pushHandler(new StreamHandler('path/to/firebase_api.log'));

$logMiddleware = GuzzleMiddleware::log(
    logger: $httpLogger,
    formatter: new MessageFormatter(),
    logLevel: LogLevel::INFO,
);

$options = $options->withGuzzleMiddleware($logMiddleware, 'http_debug_logs');

$factory = (new Factory())
    ->withHttpClientOptions($clientOptions)
;
```

--------------------------------

### Sign in with refresh token

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user with a refresh token.

```php
$signInResult = $auth->signInWithRefreshToken($refreshToken);
```

--------------------------------

### Set Realtime Database URI with Factory

Source: https://github.com/beste/firebase-php/blob/8.x/docs/setup.rst

Specify a custom Realtime Database URI. If omitted, the SDK generates it from the project ID in the service account JSON file for backward compatibility.

```php
use Kreait\Firebase\Factory;

$factory = (new Factory())
    ->withDatabaseUri('https://my-project.firebaseio.com');
```

--------------------------------

### Add WebPush configuration with WebPushConfig::fromArray

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Creates a WebPushConfig from an array with notification and fcm_options, then attaches it to a message with withWebPushConfig. The configuration follows the Firebase Webpush reference.

```php
use Kreait\Firebase\Messaging\WebPushConfig;

$config = WebPushConfig::fromArray([
    'notification' => [
        'title' => '$GOOG up 1.43% on the day',
        'body' => '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
        'icon' => 'https://my-server.example/icon.png',
    ],
    'fcm_options' => [
        'link' => 'https://my-server.example/some-page',
    ],
]);

$message = $message->withWebPushConfig($config);
```

--------------------------------

### Database Snapshot Immutability and Shortcut

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Shows that snapshots are immutable copies of data at a location. The getValue() shortcut is equivalent to getSnapshot()->getValue().

```php
$snapshot = $reference->getSnapshot();
$value = $snapshot->getValue();

$value = $reference->getValue(); // Shortcut for $reference->getSnapshot()->getValue();
```

--------------------------------

### Using send* Methods with an Additional Parameter

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows how to set $validateOnly to true for the send* methods.

```php
$validateOnly = true;
```

--------------------------------

### Add Android configuration with AndroidConfig::fromArray

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Creates an AndroidConfig from an array with TTL, priority, and notification settings, then attaches it to a message with withAndroidConfig. The configuration follows the Firebase AndroidConfig reference.

```php
use Kreait\Firebase\Messaging\AndroidConfig;

$config = AndroidConfig::fromArray([
    'ttl' => '3600s',
    'priority' => 'normal',
    'notification' => [
        'title' => '$GOOG up 1.43% on the day',
        'body' => '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
        'icon' => 'stock_ticker_update',
        'color' => '#f45342',
        'sound' => 'default',
    ],
]);

$message = $message->withAndroidConfig($config);
```

--------------------------------

### Access Remote Config version properties

Source: https://github.com/beste/firebase-php/blob/8.x/docs/remote-config.rst

Lists the properties available from a Version object, such as version number, user, description, updatedAt, updateOrigin, updateType, and rollBackSource.

```php
$version->versionNumber();
$version->user(); // The user/service account the performed the change
$version->description();
$version->updatedAt();
$version->updateOrigin();
$version->updateType();
$version->rollBackSource();
```

--------------------------------

### Add FCM options with FcmOptions::create or array

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Shows two ways to create FCM options: using the FcmOptions::create()->withAnalyticsLabel() fluent method or a plain array with 'analytics_label'. Both are attached to the message with withFcmOptions.

```php
use Kreait\Firebase\Messaging\FcmOptions;

$fcmOptions = FcmOptions::create()
    ->withAnalyticsLabel('my-analytics-label');
// or
$fcmOptions = [
    'analytics_label' => 'my-analytics-label'
];

$message = $message->withFcmOptions($fcmOptions);
```

--------------------------------

### Send messages in batches with sendAll

Source: https://github.com/beste/firebase-php/blob/8.x/docs/cloud-messaging.rst

Sends multiple messages in a batch using sendAll(). Each element can be a Message object or an array parseable into a CloudMessage. The returned MulticastSendReport provides success and failure details. Consider sending to a topic instead when targeting more than a few devices.

```php
use Kreait\Firebase\Messaging\CloudMessage;

$messages = [
    // Either objects implementing Kreait\Firebase\Messaging\Message or arrays that can
    // be parsed into to Kreait\Firebase\Messaging\CloudMessage objects
];

/** @var Kreait\Firebase\Messaging\MulticastSendReport $sendReport **/
$sendReport = $messaging->sendAll($messages);
```

--------------------------------

### Downscope to unauthenticated client

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Pass null to withDatabaseAuthVariableOverride to act as an unauthenticated client. The resulting database instance only has access to public resources.

```php
$database = $factory
    ->withDatabaseAuthVariableOverride(null)
    ->createDatabase();

// $database now only has access to public resources
```

--------------------------------

### Append to a list with push()

Source: https://github.com/beste/firebase-php/blob/8.x/docs/realtime-database.rst

Appends data to a list using push(), which generates a unique, timestamp-based key to avoid write conflicts in multiuser applications. The getKey() method retrieves the auto-generated key.

```php
$postData = [...];
$postRef = $database->getReference('posts')->push($postData);

$postKey = $postRef->getKey(); // The key looks like this: -KVquJHezVLf-lSye6Qg
```

--------------------------------

### Sign in without a token

Source: https://github.com/beste/firebase-php/blob/8.x/docs/authentication.rst

Signs in a user without a token, using a user object or UID and optional claims.

```php
$signInResult = $auth->signInAsUser($userOrUid, array $claims = null);
```

--------------------------------

### Handle SDK Exceptions with try-catch

Source: https://github.com/beste/firebase-php/blob/8.x/docs/troubleshooting.rst

Wrap SDK operations in a try-catch block to handle Firebase-specific exceptions and general errors.

```php
use Kreait\Firebase\Exception\FirebaseException;
use Throwable;

try {
    // The operation you want to perform
    echo 'OK';
} catch (FirebaseException $e} {
    echo 'An error has occurred while working with the SDK: '.$e->getMessage;
} catch (Throwable $e) {
    echo 'A not-Firebase specific error has occurred: '.$e->getMessage;
}
```
Tokens:
Raw