kirschbaum/laravel-feature-toggle

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
There is no license information available for the latest version (dev-master) of this package.

Simple feature toggles for Laravel PHP and Javascript

dev-master 2016-02-25 11:32 UTC

This package is auto-updated.

Last update: 2021-10-01 00:06:53 UTC


README

This package allows for easy and efficient feature flag managment in Laravel. Features include:

  • Definition of feature toggles per environment (e.g. local, dev, stage, production).
  • Managable way to keep flags in source control without becomming overwhelming.
  • Creation of a default setting per feature that will be used if the environment specific setting is not found.
  • Ability to easily request the status of a feature and automatically get the correct setting based on the current environment the application is running on.
  • Ability to tag features as eligable for Javascript export.
  • A helper method to easily export Javascript eligable feature flags and pass them along to your front-end framework.

Installation

Add the package to your project:

composer require kirschbaum/laravel-feature-flag

Add the following service provider:

// config/app.php

'providers' => [
    ...
    Kirschbaum\LaravelFeatureFlag\ServiceProvider::class,
    ...
];

This package also comes with a facade, making it easy to retrieve the correct flags for the environment you are in:

// config/app.php

'aliases' => [
    ...
    'FeatureFlag' => Kirschbaum\LaravelFeatureFlag\Facades\FeatureFlag::class,
    ...
]

Publish the config file using the arisan command:

php artisan vendor:publish --provider="Kirschbaum\LaravelFeatureFlag\ServiceProvider"

The configuration looks like this:

<?php

return [

    'feature-1' => [
        'environments' => [
            'default'  => false,
            'local'    => true,
            'dev'      => false,
            'stage'    => false
        ],
        'js_export'    => true,
    ],

    'feature-2' => [
        'environments'   => [
            'default'    => false,
            'production' => true,
        ],
        'js_export'      => true,
    ],

];

Usage

General PHP use:

if(FeatureFlag::isEnabled('feature-1'))
{
    // Only do stuff if feature is enabled.
}

If you need to pass your feature flags to a front-end JS framework like Angular or Vue.js, you can do so by using the getJavascriptFlags() method:

$js->put(
            [
                'pusher_public_key' => env('PUSHER_PUBLIC'),
                'feature_flags'     => FeatureFlag::getJavascriptFlags()
            ]
        );

Because not all feature flags should be passed to the front-end, only features with the setting 'js_export = true' will be included. The end result is a simple array of features with the correct flags for the environment:

array:2 [▼
  "feature-1" => true
  "feature-2" => false
]