An Unleash client for Laravel.
composer require mikefrancis/laravel-unleashExport package config:
php artisan vendor:publish --provider="MikeFrancis\LaravelUnleash\ServiceProvider"Documentation for configuration can be found in config/unleash.php.
use \MikeFrancis\LaravelUnleash\Unleash; $unleash = app(Unleash::class); if ($unleash->isFeatureEnabled('myAwesomeFeature')) { // Congratulations, you can see this awesome feature! } if ($unleash->isFeatureDisabled('myAwesomeFeature')) { // Check back later for more features! } $feature = $unleash->getFeature('myAwesomeFeature'); $allFeatures = $unleash->getFeatures();You can use the Unleash facade:
use Unleash; if (Unleash::isFeatureEnabled('myAwesomeFeature')) { // Congratulations, you can see this awesome feature! } if (Unleash::isFeatureDisabled('myAwesomeFeature')) { // Check back later for more features! } $feature = Unleash::getFeature('myAwesomeFeature'); $allFeatures = Unleash::getFeatures();or use the generically named Feature facade:
use Feature; if (Feature::enabled('myAwesomeFeature')) { // Congratulations, you can see this awesome feature! } if (Feature::disabled('myAwesomeFeature')) { // Check back later for more features! } $feature = Feature::get('myAwesomeFeature'); $allFeatures = Feature::all();If your strategy relies on dynamic data at runtime, you can pass additional arguments to the feature check functions:
use \MikeFrancis\LaravelUnleash\Unleash; use Config; $unleash = app(Unleash::class); $allowList = config('app.allow_list'); if ($unleash->isFeatureEnabled('myAwesomeFeature', $allowList)) { // Congratulations, you can see this awesome feature! } if ($unleash->isFeatureDisabled('myAwesomeFeature', $allowList)) { // Check back later for more features! }Blade directive for checking if a feature is enabled:
@featureEnabled('myAwesomeFeature') Congratulations, you can see this awesome feature! @endfeatureEnabledOr if a feature is disabled:
@featureDisabled('myAwesomeFeature') Check back later for more features! @endfeatureDisabledYou cannot currently use dynamic strategy arguments with Blade template directives.
This package includes middleware that will deny routes depending on whether a feature is enabled or not.
To use the middle, add the following to your app/Http/Kernel.php:
protected $routeMiddleware = [ // other middleware 'feature.enabled' => \MikeFrancis\LaravelUnleash\Middleware\FeatureEnabled::class, 'feature.disabled' => \MikeFrancis\LaravelUnleash\Middleware\FeatureDisabled::class, ];You can then use the middleware in your routes:
Route::get('/new-feature-path', function () { // })->middleware('feature.enabled:myAwesomeFeature'); Route::get('/terrible-legacy-path', function () { // })->middleware('feature.disabled:myAwesomeFeature');or in your controllers like so:
class ExampleController extends Controller { public function __construct() { $this->middleware('feature.enabled:myAwesomeFeature'); // or $this->middleware('feature.disabled:myAwesomeFeature'); } }You cannot currently use dynamic strategy arguments with Middleware.