Skip to content
FlagSwiftDocs

Integrate with PHP

A shared config cache for FPM, CLI and Octane.

Before you start#

  • A server key (fs_srv_…) from the API Keys page of your console. See API keys for how keys differ.
  • The address of your FlagSwift server, for example https://flags.example.com.
  • A flag to read. Create one in the console and turn it on in an environment.

Keep the key on the server

Store the key in your secrets manager or an environment variable. Never commit it and never send it to a browser.

Your server#

Enter your server address and, if your key covers every environment of the project, the environment to read. The examples below fill in as you type. Nothing is sent anywhere: the values stay in this browser.

Set up#

  1. Environment

    bash
    FLAGSWIFT_KEY=fs_srv_...   # private; from the API Keys page
  2. Install

    bash
    composer require flagswift/flagswift-php
  3. Set up

    php
    use FlagSwift\Client;
    use FlagSwift\FileStore;
    
    $flags = new Client(
        apiKey: getenv('FLAGSWIFT_KEY'),
        baseUrl: 'https://flags.example.com',
        store: new FileStore('/var/cache/myapp/flagswift.json'), // shared by every request
        fallbacks: ['new-checkout' => false],
    );
  4. Use

    php
    // No network call: evaluated from the shared cache.
    if ($flags->isEnabled('new-checkout', ['identifier' => 'user-42', 'account' => 'acme', 'attributes' => ['plan' => 'pro']])) {
        // new checkout
    }
    $variant = $flags->variant('button-colour', 'user-42');
    $value = $flags->value('button-colour', 'user-42', 'blue');

Verify it works#

Before you run your app, check the key, the address and the environment with one request. A server key downloads the configuration your app will evaluate locally.

bash
curl -s "https://flags.example.com/api/v1/evaluation/server?mode=config" \
  -H "Authorization: Bearer $FLAGSWIFT_SERVER_KEY"

A 200 response with your flags means everything is wired up. If it fails, Troubleshooting lists the usual causes.

Next steps#