Skip to content
Branch: master
Go to file

Latest commit


Failed to load latest commit information.
Latest commit message
Commit time

rollout (for php)

Build Status Scrutinizer Code Quality Code Coverage

Feature flippers for PHP. A port of ruby's rollout.

Install It

composer require opensoft/rollout

How it works

Initialize a rollout object:

use Opensoft\Rollout\Rollout;
use Opensoft\Rollout\Storage\ArrayStorage;

$rollout = new Rollout(new ArrayStorage());

Check if a feature is active for a particular user:

$rollout->isActive('chat', $user);  // returns true/false

Check if a feature is activated globally:

$rollout->isActive('chat'); // returns true/false


There are a number of different storage implementations for where the configuration for the rollout is stored.

  • ArrayStorage - default storage, not persistent
  • DoctrineCacheStorageAdapter - requires doctrine/cache
  • PDOStorageAdapter - persistent using PDO
  • RedisStorageAdapter - persistent using Redis
  • MongoDBStorageAdapter - persistent using Mongo

All storage adapters must implement Opensoft\Rollout\Storage\StorageInterface.


Rollout ships with one group by default: all, which does exactly what it sounds like.

You can activate the all group for chat features like this:

$rollout->activateGroup('chat', 'all');

You may also want to define your own groups. We have one for caretakers:

$rollout->defineGroup('caretakers', function(RolloutUserInterface $user = null) {
  if (null === $user) {
    return false;

  return $user->isCaretaker(); // boolean

You can activate multiple groups per feature.

Deactivate groups like this:


Specific Users

You may want to let a specific user into a beta test or something. If that user isn't part of an existing group, you can let them in specifically:

$rollout->activateUser('chat', $user);

Deactivate them like this:

$rollout->deactivateUser('chat', $user);

Rollout users must implement the RolloutUserInterface.

User Percentages

If you're rolling out a new feature, you may want to test the waters by slowly enabling it for a percentage of your users.

$rollout->activatePercentage('chat', 20);

The algorithm for determining which users get let in is this:

crc32($user->getRolloutIdentifier()) % 100 < $percentage

So, for 20%, users 0, 1, 10, 11, 20, 21, etc would be allowed in. Those users would remain in as the percentage increases.

Deactivate all percentages like this:


Note: Activating a feature for 100% of users will also make it activate globally. This is like calling $rollout->isActive() without a user object.

Feature is Broken

Deactivate everybody at once:


You may wish to disable features programmatically if monitoring tools detect unusually high error rates for example.

Remove a Feature (added in 2.0.0)

After a feature becomes mainstream or a failed experiment, you may want to remove the feature definition from rollout.


Note: If there is still code referencing the feature, it will be recreated with default settings.

Symfony2 Bundle

A Symfony2 bundle is available to integrate rollout into Symfony2 projects. It can be found at

Zend Framework 2 Module

A Zend Framework 2 module is availabile to intergrate rollout into Zend Framwork 2 projects. It can be found at

Implementations in other languages


Copyright © 2017 James Golick, BitLove, Inc. See LICENSE for details.

You can’t perform that action at this time.