switchover/php-sdk

Switchover PHP SDK. Feature Toggle Management made easy!

0.5.4 2021-01-02 18:19 UTC

Requires

• php: >=7.2
• guzzlehttp/guzzle: ^7.0
• monolog/monolog: ^2.1
• psr/log: ^1.1
• psr/simple-cache: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Michael Hofmann

• laravel
• feature flag
• feature switch
• feature toggle
• switchover
• switch-over
• switchover-io
• feature flag management
• feature toggle management

README

Switchover

Switchover is a Software-As-A-Service for managing feature toggles (aka switches, flags or feature flips) in your application. Use it for Continous Integration, Continous Delivery, A/B-Testing, Canary Releases, Experementing and everything else you can think of.

Note: Use this SDK for PHP Projects

Getting Started

Install

Via composer:

composer require switchover/php-sdk

For Laravel Users

Use our Laravel Package to get up and running quickly with Switchover in your Laravel App: https://github.com/switchover-io/laravel-integration

Initialize client

You will find your SDK Key on the environment page. Copy it and use it to initialize the client:

Basic usage:

// create a client, per default the client will cache the toggles 60 seconds
$client = new SwitchoverClient('<SDK-KEY');

//get some toggle values
$featureValue = $client->toggleValue('<TOGGLE-NAME>', false);

//or with context if you have specific (user) conditions
$context = new Context();
$context->set('email', '[e-mail]');

$isFeatureVisible = $client->toggleValue('<OTHER-FLAG>', false, $context);

if ($isFeatureVisible) {
    // ...do something
}

What is the Context?

The context holds any data (key-value pair) which should be evaluated against the toggle conditions. This can be anything, from user-related data (email, userId) to pure technical infos (stage, system infos, versions, etc). If you have rollout options you have to provide a uuid (more details below).

👀 PLEASE NOTE We do not send any context data (and such any user data) to our servers. All evaluations happens on the client.

In an user webfrontend you would typically want to use userdata like email or userId, etc. to evaluate you feature flag. Of course the toggle conditions should also contain the relevant context key.

Example:

$ctx = new Context([
    "email" => "[e-mail]"
]);

$isFeatureEnabled = $client->toggleValue('my-big-feature', false, $ctx);

If you have specified a rollout option for you feature flag it is important to provide a UUID. You can freely choose, but should be unique.

Example:

/* Feature flag has rollout options so we must provide a uuid.
   Here we use the email */
$ctx = new Context([
    "uuid" => "[e-mail]"
]);

⚠️ IMPORTANT: Rollout options expects a uuid. Toggle evaluation will fail and return the default value if you don't provide the uuid.

Client Options

It's possible to pass numerous options to the client:

Option	Value
cache.time	Sets time in seconds before the internal cache becomes stale and will be refreshed (TTL). Default is 60 seconds. The value 0 will keep the cache forever.
logger	Possibility to provide you own logger instance (PSR-7).
cache	Option to set your cache instance (e.g. for redis). Expects a PSR-16 compliant instance.
http	The client uses guzzlehttp/guzzle for http requests. You can pass an array of options to the Guzzle Http Client.

Example

$client = new SwitchoverClient('<SDK-KEY', [
    'cache.time' => 10,
    'http' => [
        'timeout' => '10',
        'proxy' => 'http://proxy.tld'
    ]
]);

Documentation

Learn more on the official documentation: Switchover Quickstart