README.md

Laravel Unleash

A simple Unleash client for Laravel. It is compatible with the Unlesah-hosted.com SaaS offering and Unleash Open-Source.

Getting started

1. Install the Laravel Unleash via Composer

composer require j-webb/laravel-unleash

2. Configure

Create local configuration (optional)

php artisan vendor:publish --provider="JWebb\Unleash\Providers\ServiceProvider"

Required .env values

# Your Unleash instance endpoint
UNLEASH_URL=https://app.unleash-hosted.com/

Optional .env values

# Enable or disable the Laravel Unleash client. If disabled, all feature checks will return false
UNLEASH_ENABLED=true

# Currently unused, but is sent as a header alongside the Unleash API requests
UNLEASH_APPLICATION_NAME=Laravel 

# Currently unused, but is sent as a header alongside the Unleash API requests
UNLEASH_INSTANCE_ID=production 

Setting up caching/polling

The configuration contains values to enable/disable cache, as well as set a cache TTL. You can mimic the recommended Unleash polling rate by setting a TTL of 15 seconds.

Setting up Activation Strategies

Laravel Unleash comes with a selection of activation strategies out of the box. You can enable/disable these by commenting out the required line inside the configuration.

You may also add custom strategy classes by adding them on a new line after the existing strategies.

Setting up the Middleware

The module comes bundled with middleware for you to perform a feature check on routes and/or controllers.

#/app/Http/Kernal.php
protected $routeMiddleware = [
    ...
    'feature' => \JWebb\Unleash\Middleware\CheckFeature::class,
    ...
];

Once added to your Kernal.php file, you can use this in any area where middleware is applicable. As an example, you could use this in a controller.

public function __construct()
{
    $this->middleware('feature:your_feature_name');
}

See the Laravel Docs for more information.

Usage

Checking individual features

if (Unleash::feature()->isActive('your_feature')) {
    // Your feature is enabled and is applicable (strategy activated)
}

if (Unleash::feature()->isActive('your_feature', false)) {
    // Your feature is active (strategy activated), but may not be enabled
}

if (Unleash::feature()->isEnabled('your_feature')) {
    // Your feature is enabled
}

Using array of features

// List of all features, enabled or disabled
$allFeatures = Unleash::feature()->all();

// List of all enabled features
$enabledFeatures = Unleash::feature()->getEnabled();

// List of all enabled and active features
$activeFeatures = Unleash::feature()->getActive();

// List of all active features, but may not be enabled
$activeFeatures = Unleash::feature()->getActive(false); 

Using middleware on a controller

class ExampleController extends Controller
{
    public function __construct()
    {
        ...
        $this->middleware('feature:your_feature');
    }
}

Using middleware on a route

Route::get('/', function () {
    //
})->middleware('feature:your_feature');