PHP Ruby Shell
Clone or download
Permalink
Failed to load latest commit information.
.circleci
integration-tests
src/LaunchDarkly
tests
.gitignore
.php_cs
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
README.md
VERSION
composer.json
composer.lock
phpunit.xml

README.md

LaunchDarkly SDK for PHP

Circle CI

Requirements

  1. PHP 5.5 or higher.

Quick setup

  1. Install the PHP SDK and monolog for logging with Composer

     php composer.phar require launchdarkly/launchdarkly-php
    
  2. After installing, require Composer's autoloader:

     require 'vendor/autoload.php';
    
  3. Create a new LDClient with your SDK key:

     $client = new LaunchDarkly\LDClient("your_sdk_key");
    

Your first feature flag

  1. Create a new feature flag on your dashboard

  2. In your application code, use the feature's key to check whether the flag is on for each user:

     $user = new LaunchDarkly\LDUser("user@test.com");
     if ($client->variation("your.flag.key", $user)) {
         # application code to show the feature
     } else {
         # the code to run if the feature is off
     }
    

Fetching flags

There are two distinct methods of integrating LaunchDarkly in a PHP environment.

We strongly recommend using the ld-relay. Per-flag caching (Guzzle method) is only intended for low-throughput environments.

Using Guzzle

Require Guzzle as a dependency:

php composer.phar require "guzzlehttp/guzzle:6.2.1"
php composer.phar require "kevinrob/guzzle-cache-middleware:1.4.1"

It will then be used as the default way of fetching flags.

With Guzzle, you could persist your cache somewhere other than the default in-memory store, like Memcached or Redis. You could then specify your cache when initializing the client with the cache option.

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY", array("cache" => $cacheStorage));

Using LD-Relay

The LaunchDarkly Relay Proxy (ld-relay) consumes the LaunchDarkly streaming API and can update a Redis cache operating in your production environment. The ld-relay offers many benefits such as performance and feature flag consistency. With PHP applications, we strongly recommend setting up ld-relay with a Redis store.

  1. Set up ld-relay in daemon-mode with Redis

  2. Require Predis as a dependency:

     php composer.phar require "predis/predis:1.0.*"
    
  3. Create the LDClient with the Redis feature requester as an option:

     $client = new LaunchDarkly\LDClient("your_sdk_key", [
         'feature_requester_class' => 'LaunchDarkly\LDDFeatureRequester',
         'redis_host' => 'your.redis.host',
         'redis_port' => 6379
     ]);
    
  4. If ld-relay is configured for event forwarding, you can configure the LDClient to publish events to ld-relay instead of directly to events.launchdarkly.com. Using GuzzleEventPublisher with ld-relay event forwarding can be an efficient alternative to the default curl-based event publishing.

     $client = new LaunchDarkly\LDClient("your_sdk_key", [
         'event_publisher_class' => 'LaunchDarkly\GuzzleEventPublisher',
         'events_uri' => 'http://your-ldrelay-host:8030',
         'feature_requester_class' => 'LaunchDarkly\LDDFeatureRequester',
         'redis_host' => 'your.redis.host',
         'redis_port' => 6379
     ]);
    

Testing

We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.

Learn more

Check out our documentation for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the complete reference guide for this SDK.

Contributing

We encourage pull-requests and other contributions from the community. We've also published an SDK contributor's guide that provides a detailed explanation of how our SDKs work.

About LaunchDarkly

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for
  • Explore LaunchDarkly