Download the PHP package opensoft/rollout without Composer
On this page you can find all versions of the php package opensoft/rollout. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package rollout
rollout (for php)
Feature flippers for PHP. A port of ruby's rollout.
Install It
composer require opensoft/rollout
How it works
Initialize a rollout object:
Check if a feature is active for a particular user:
Check if a feature is activated globally:
Storage
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
.
Groups
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:
You may also want to define your own groups. We have one for caretakers:
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:
Deactivate them like this:
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.
The algorithm for determining which users get let in is this:
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 http://github.com/opensoft/OpensoftRolloutBundle.
Zend Framework 2 Module
A Zend Framework 2 module is availabile to intergrate rollout into Zend Framwork 2 projects. It can be found at https://github.com/adlogix/zf2-opensoft-rollout.
Implementations in other languages
Copyright
Copyright © 2017 James Golick, BitLove, Inc. See LICENSE for details.