qandidate/toggle-bundle

This Bundle provides the integration with qandidate/toggle. It provides the services and configuration you need to implement feature toggles in your Symfony application.

1.4.2 2022-07-12 16:52 UTC

Requires

• php: >=7.2
• doctrine/annotations: ^1.13
• doctrine/common: ^2.13||^3.0
• qandidate/toggle: ^2.0
• symfony/framework-bundle: ^4.4||^5.0
• symfony/http-foundation: ^4.4.7||^5.0.7
• symfony/http-kernel: ^4.4.13||^5.1.5
• symfony/security-bundle: ^4.4||^5.0

Requires (Dev)

• broadway/coding-standard: ^1.2
• matthiasnoback/symfony-config-test: ^4.0
• matthiasnoback/symfony-dependency-injection-test: ^4.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.5
• symfony/browser-kit: ^4.4||^5.0
• symfony/twig-bundle: ^4.4||^5.0
• twig/twig: ^3.0

Suggests

• twig/twig: For using the twig helper

MIT

• Willem-Jan
• Qandidate.com

README

This Bundle provides the integration with our toggle library. It provides the services and configuration you need to implement feature toggles in your application.

About

Read the our blog post series about this repository at:

• http://labs.qandidate.com/blog/2014/08/18/a-new-feature-toggling-library-for-php/
• http://labs.qandidate.com/blog/2014/08/19/open-sourcing-our-feature-toggle-api-and-ui/

Installation

Using Symfony Flex

The easiest way to install and configure the QandidateToggleBundle with Symfony is by using Symfony Flex.

Make sure you have Symfony Flex installed:

$ composer require symfony/flex ^1.0
$ composer config extra.symfony.allow-contrib true

Install the bundle:

$ composer require qandidate/toggle-bundle ^1.0

Symfony Flex will automatically register and configure the bundle.

Manually

Add the bundle to your composer.json

$ composer require qandidate/toggle-bundle ^1.0

Add the bundle to your Kernel:

$bundles = array(
    // ..
    new Symfony\Bundle\SecurityBundle\SecurityBundle(),
    new Symfony\Bundle\TwigBundle\TwigBundle(),
    new Qandidate\Bundle\ToggleBundle\QandidateToggleBundle(),
);

Configuration

qandidate_toggle:
    persistence: in_memory|redis|factory|config
    context_factory: null|your.context_factory.service.id
    redis_namespace: toggle_%kernel.environment% # default, only required when persistence = redis
    redis_client: null|your.redis_client.service.id # only required when persistence = redis
    collection_factory: # only required when persistence = factory
        service_id: your.collection_factory.service.id
        method: create

Sample Configuration for Symfony

qandidate_toggle:
    persistence: config
    toggles:
      always-active-feature:
        name: always-active-feature
        status: always-active
      inactive-feature:
        name: inactive-feature
        status: inactive
        conditions: 
      conditionally-active:
        name: conditionally-active
        status: conditionally-active
        conditions:
         - name: operator-condition
           key: user_id
           operator:
               name: greater-than
               value: 42

Example usage

Usage can vary on your application. This example uses the supplied UserContextFactory, but you probably need to create your own factory.

<!-- services.xml -->

<service id="acme.controller" class="Acme\Controller">
    <argument type="service" id="qandidate.toggle.manager" />
    <argument type="service" id="qandidate.toggle.user_context_factory" />
</service>

// Acme\Controller

public function __construct(
    /* ArticleRepository, Templating, ..*/ 
    ToggleManager $manager, 
    ContextFactory $contextFactory
) {
    // ..
    $this->manager = $manager;
    $this->context = $contextFactory->createContext();
}

// ..

public function articleAction(Request $request)
{
    $this->article = $this->repository->findBySlug($request->request->get('slug'));

    return $this->templating->render('article.html.twig', array(
        'article'        => $article,
        'enableComments' => $this->manager->active('comments', $this->context),
    ));
}

You can find a working example using the Symfony MicroKernelTrait in the Resources/doc/example directory.

Annotation Usage

You can also use the @Toggle annotation on a controller. When the toggle isn't active a 404 exception is thrown.

use Qandidate\Bundle\ToggleBundle\Annotations\Toggle;

/**
 * @Toggle("cool-feature")
 */
class FooController
{

    /**
     * @Toggle("another-cool-feature")
     */
    public function barAction()
    {
    }

    public function bazAction()
    {
    }
}

Twig usage

If you use Twig you can also use the function:

{% if feature_is_active('comments') %}
    {# Awesome comments #}
{% endif %}

Or the Twig test:

{% if 'comments' is active feature %}
    {# Awesome comments #}
{% endif %}

Both are registered in the ToggleTwigExtension.

Data collector

With the data collector you have a overview about all toggles. In the toolbar you see all conditions and the current status.

In the panel you have two lists:

• You can see all keys and there current values.
• Then you can see all configured toggles, there conditions and if they are active.

Testing

To run PHPUnit tests:

$ ./vendor/bin/phpunit

License

MIT, see LICENSE.