2017 © Pedro Peláez
 

library feature-flags-bundle

Symfony2 Bundle to implement Feature Flags to your Application

image

dzunke/feature-flags-bundle

Symfony2 Bundle to implement Feature Flags to your Application

  • Monday, March 19, 2018
  • by DZunke
  • Repository
  • 4 Watchers
  • 52 Stars
  • 48,901 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 11 Forks
  • 1 Open issues
  • 10 Versions
  • 25 % Grown

The README.md

Symfony FeatureFlagsBundle

Build Status Latest Stable Version Total Downloads License, (*1)

The Bundle will allow you to implement Feature Flags to your Application. Please Note that there is no Interface available, so the Flags must be configured directly in Symfony-Configs., (*2)

  • Use Versions ^2.0 if Symfony 3.0 Support is wanted!
  • Use Versions ^4.0 if Symfony 4.2 Support is wanted!
  • Use Versions ^5.0 if Symfony 4.3 or 5.x Support is wanted!
  • Use Versions ^6.0 if Symfony 6.0 Support is wanted!
  • Use Versions ^6.1 if Symfony >6.1 Support is wanted!

Documentation

Setup

You can add the Bundle by running Composer on your shell or adding it directly to your composer.json, (*3)

``` bash php composer.phar require dzunke/feature-flags-bundle:"^6.1", (*4)


``` json
"require" :  {
    "dzunke/feature-flags-bundle": "^6.1"
}

The Namespace will be registered by autoloading with Composer but to use the integrated features for symfony you have to register the Bundle., (*5)

``` php, (*6)

app/AppKernel.php

public function registerBundles() { $bundles = [ // [..] new DZunke\FeatureFlagsBundle\DZunkeFeatureFlagsBundle(), ]; }, (*7)

Without any Configuration all Features will be enabled! But at this point you
can start developing.

## Usage

### Service-Container

The simplest way to use the Bundle is to get the Container and request the
state of a Feature. **Note**: Features that are not configured are enabled by
default.

``` php
# src/AcmeBundle/Controller/IndexController.php
<?php

namespace AcmeBundle\Controller;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
class DefaultController extends Controller
{
    public function indexAction()
    {
        if ($this->get('dz.feature_flags.toggle')->isActive('FooFeature')) {
           // [...]
        }
        // [...]
    }
}

Twig

``` php, (*8)

src/AcmeBundle/Resources/views/Index/index.html.twig

{% if has_feature('FooFeature') %} , (*9)

Lorem Ipsum Dolor ..., (*10)

{% endif %} 

### Argument-Usage

On every check you can give arguments to the check if you want to specify
the check. The Arguments for a Flag can be definied by an array on the validation
method. The Keys must be named like the condition itself. Please Note that if the
Condition does not support the Arguments they would be ignored.

``` php
# src/AcmeBundle/Resources/views/Index/index.html.twig
{% if has_feature('FooBarFeature', {'device': 'tablet'}) %}
    <p>Lorem Ipsum Dolor ...</p>
{% endif %}

Creating a Condition

At first the Condition must be created. The Condition must implement the ConditionInterface. There is a general context available., (*11)

``` php <?php, (*12)

src/AcmeBundle/FeatureFlags/Condition/Foo.php

namespace AcmeBundle\FeatureFlags\Condition;, (*13)

use DZunke\FeatureFlagsBundle\Toggle\Conditions\AbstractCondition; use DZunke\FeatureFlagsBundle\Toggle\Conditions\ConditionInterface;, (*14)

class Foo extends AbstractCondition implements ConditionInterface { public function validate($config, $argument = null) { // [..] Implement your Methods to Validate the Feature, (*15)

    return true;
}

public function __toString()
{
    return 'Foo';
}

}, (*16)


After the Class was created it must be defined as a Tagged-Service. With this
Tag and the Alias the Condition would be loaded. At this point there is many
space to extend the Condition by adding calls or arguments.

``` yaml
# src/AcmeBundle/Resources/config/services.yml
services:
    acme.feature_flags.condition.fo:
        class: DZunke\FeatureFlagsBundle\Toggle\Conditions\Foo
        calls:
            - [setContext, [@dz.feature_flags.context]]
        tags:
            -  { name: dz.feature_flags.toggle.condition, alias: foo }

Configuration

Example

``` yaml d_zunke_feature_flags: flags: FooFeature: # feature will always be disabled default: false BarFeature: # feature will only be enabled for a list of special ClientIps conditions_config: ip_address: [192.168.0.1] BazFeature: # the feature will be enabled for the half of the users conditions_config: percentage: percentage: 50 cookie: ExampleCookieForFeature lifetime: 3600 FooBarFeature: conditions_config: device: tablet: "/ipad|playbook|android|kindle|opera mobi|arm|(^.android(?:(?!mobile).)$)/i" mobile: "/iphone|ipod|bb10|meego|blackberry|windows\sce|palm|windows phone|((android.*mobile))|mobile/i", (*17)


## Available Conditions

``` yaml
hostname: [example.local, www.example.local]

``` yaml ip_address: [192.168.0.1, 192.168.0.2], (*18)


``` yaml
percentage:
  cookie: NameThisCookieForTheUser # Default: 84a0b3f187a1d3bfefbb51d4b93074b1e5d9102a
  percentage: 29 # Default: 100
  lifetime: 3600 # Default: 86400 - 1 day

``` yaml device: name: regex # give regex for each valid device, (*19)


``` yaml
# See php.net/datetime
date:
  start_date: "2016-09-01" # Start date, accepts DateTime constructor values. Defaults to "now".
  end_date: "2016-09-03" # End date, accepts DateTime constructor values. Defaults to "now".

Reference

yaml d_zunke_feature_flags: # the default state to return for non-existent features default: true # feature flags for the built system flags: # Prototype feature: # general active state for the flag - if conditions used it would be irrelevant default: false # list of configured conditions which must be true to set this flag active conditions_config: [], (*20)

Resources

License

FeatureFlagsBundle is licensed under the MIT license., (*21)

The Versions

19/03 2018

2.x-dev

2.9999999.9999999.9999999-dev https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

14/03 2018

2.2.1

2.2.1.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

14/03 2018

2.2.0

2.2.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

08/08 2017

dev-master

9999999-dev https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

05/09 2016

1.2.1

1.2.1.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

05/09 2016

2.1.0

2.1.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

05/09 2016

1.2.0

1.2.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

05/09 2016

2.0.0

2.0.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

07/03 2016

1.1.0

1.1.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Denis Zunke

bundle symfony feature flags

26/01 2015

1.0.0

1.0.0.0 https://github.com/DZunke/FeatureFlagsBundle

Symfony2 Bundle to implement Feature Flags to your Application

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

by Denis Zunke

bundle symfony feature flags