{"id":18963789,"url":"https://github.com/opensoft/opensoftrolloutbundle","last_synced_at":"2025-10-18T18:51:08.888Z","repository":{"id":15686803,"uuid":"18424506","full_name":"opensoft/OpensoftRolloutBundle","owner":"opensoft","description":"A Symfony2 Bundle for opensoft/rollout","archived":false,"fork":false,"pushed_at":"2023-03-24T15:47:24.000Z","size":348,"stargazers_count":42,"open_issues_count":2,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-12T21:43:50.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-04-04T02:00:03.000Z","updated_at":"2021-02-22T09:21:47.000Z","dependencies_parsed_at":"2024-06-19T20:03:08.769Z","dependency_job_id":"be61b569-3d18-4785-a842-a500c46ad544","html_url":"https://github.com/opensoft/OpensoftRolloutBundle","commit_stats":{"total_commits":18,"total_committers":4,"mean_commits":4.5,"dds":0.4444444444444444,"last_synced_commit":"c19cc618cd4c8738c7edc1136d9d616a3e72333f"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/opensoft/OpensoftRolloutBundle","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensoft%2FOpensoftRolloutBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensoft%2FOpensoftRolloutBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensoft%2FOpensoftRolloutBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensoft%2FOpensoftRolloutBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensoft","download_url":"https://codeload.github.com/opensoft/OpensoftRolloutBundle/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensoft%2FOpensoftRolloutBundle/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271444403,"owners_count":24760799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T14:21:42.198Z","updated_at":"2025-10-18T18:51:03.828Z","avatar_url":"https://github.com/opensoft.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"OpensoftRolloutBundle\n=====================\n\nA Symfony3 Bundle for [opensoft/rollout](http://github.com/opensoft/rollout)\n\n[![Build Status](https://travis-ci.org/opensoft/OpensoftRolloutBundle.svg?branch=master)](https://travis-ci.org/opensoft/OpensoftRolloutBundle) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/opensoft/OpensoftRolloutBundle/badges/quality-score.png?s=4980d55f8407070251ca97ba3b92f855cfce67ce)](https://scrutinizer-ci.com/g/opensoft/OpensoftRolloutBundle/) [![Code Coverage](https://scrutinizer-ci.com/g/opensoft/OpensoftRolloutBundle/badges/coverage.png?s=2a11bb9fe02adb950f1b446311c6044a70a2e1fd)](https://scrutinizer-ci.com/g/opensoft/OpensoftRolloutBundle/) [![Total Downloads](https://poser.pugx.org/opensoft/rollout-bundle/downloads.png)](https://packagist.org/packages/opensoft/rollout-bundle) [![Latest Stable Version](https://poser.pugx.org/opensoft/rollout-bundle/v/stable.png)](https://packagist.org/packages/opensoft/rollout-bundle)\n\n### Obligatory Screenshot\n\n![Screenshot](https://github.com/opensoft/OpensoftRolloutBundle/raw/master/Resources/doc/screenshot-extended.png)\n\nInstallation\n------------\n\n### 1) Install via composer\n\nAdd the bundle via composer\n\n    composer require opensoft/rollout-bundle\n\nAnd activate it inside your `app\\AppKernel.php`\n\n```php\nnew Opensoft\\RolloutBundle\\OpensoftRolloutBundle(),\n```\n\n### 2) Configuration\n\nAdd the following to your configuration (supports auto-wiring)\n\n```yaml\nopensoft_rollout:\n    user_provider_service: [YOUR USER PROVIDER SERVICE]\n    storage_service: [YOUR STORAGE SERVICE FOR ROLLOUT]\n```\n\n* `user_provider_service`: Add the service id (generally the FQDN with auto-wiring) of the UserProvider to which you added the Rollout `UserProviderInterface`\n* `storage_service`: Defaults to `Opensoft\\Rollout\\Storage\\ArrayStorage`, but you can also use the included `Opensoft\\RolloutBundle\\Storage\\Doctrine\\DoctrineORMStorage` or create your own (see below for implementation)\n\n### 3) Implement Interfaces\n\n#### RolloutUserInterface\n\nAny rollout user _must_ implement the `RolloutUserInterface`.  Often, this will be your main user object in the application.\n\n```php\n\u003c?php\n\nuse Opensoft/Rollout/RolloutUserInterface;\n\nclass User implements RolloutUserInterface\n{\n    /**\n     * @return string\n     */\n    public function getRolloutIdentifier()\n    {\n        return $this-\u003eemail;\n    }\n}\n\n```\n\n#### UserProviderInterface\n\nExpose individual users to the rollout interface by implementing the `UserProviderInterface`\n\n```php\n\u003c?php\n\nuse Doctrine\\ORM\\EntityRepository;\nuse Opensoft\\RolloutBundle\\Rollout\\UserProviderInterface;\n\nclass UserRepository extends EntityRepository implements UserProviderInterface\n{\n    /**\n     * @param  mixed $id\n     * @return RolloutUserInterface|null\n     */\n    public function findByRolloutIdentifier($id)\n    {\n        return $this-\u003efindOneBy(array('email' =\u003e $id));\n    }\n}\n```\n\n#### GroupDefinitionInterface\n\nProvide different groups of users to your rollout.\n\nTag all of your group definitions with the DIC tag `rollout.group` to expose them to the rollout interface\n\n```php\n\u003c?php\n\nuse Opensoft\\RolloutBundle\\Rollout\\GroupDefinitionInterface;\n\nclass AcmeEmployeeGroupDefinition implements GroupDefinitionInterface\n{\n    /**\n     * @return string\n     */\n    public function getName()\n    {\n        return 'acme_employee';\n    }\n\n    /**\n     * @return string\n     */\n    public function getDescription()\n    {\n        return 'This group contains acme company employees';\n    }\n\n    /**\n     * @return \\Closure\n     */\n    public function getCallback()\n    {\n        return function(RolloutUserInterface $user) {\n            // Is this user an employee of acme?\n            return strpos($user-\u003egetEmail(), 'acme.com') !== false;\n        };\n    }\n}\n```\n\n#### StorageInterface\n\nImplement a custom storage solution.\n\n**Note:** The rollout `StorageInterface` [changed](https://github.com/opensoft/rollout/releases/tag/2.0.0) in version `2.0.0`.\n\n```php\n\u003c?php\n\nuse Opensoft\\Rollout\\Storage\\StorageInterface;\n\nclass MyStorage implements StorageInterface\n{\n    /**\n     * @param  string     $key\n     * @return mixed|null Null if the value is not found\n     */\n    public function get($key)\n    {\n        // implement get\n    }\n\n    /**\n     * @param string $key\n     * @param mixed  $value\n     */\n    public function set($key, $value)\n    {\n        // implement set\n    }\n\n    /**\n     * @param string $key\n     * @since 2.0.0\n     */\n    public function remove($key)\n    {\n        // implement remove\n    }\n}\n```\n\n### 4) Activate Routing\n\nAdd the following to your `app/Resources/config/routing.yml` file:\n\n    opensoft_rollout:\n        resource: \"@OpensoftRolloutBundle/Resources/config/routing.yml\"\n        prefix:   /admin/rollout\n\n## Usage\n\nCheck if a feature is enabled in a controller\n\n```php\nif ($this-\u003eget('rollout')-\u003eisActive('chat', $this-\u003egetUser())) {\n    // do some chat related feature work\n}\n```\n\nTwig example:\n\n```\n{% if rollout_is_active('chat', app.user) %}\n   \u003c!-- show a chat interface --\u003e\n{% endif %}\n```\n\n\n## Further Reading\n\n* https://github.com/FetLife/rollout\n* http://blog.travis-ci.com/2014-03-04-use-feature-flags-to-ship-changes-with-confidence/\n* http://code.flickr.net/2009/12/02/flipping-out/\n* http://en.wikipedia.org/wiki/Feature_toggle\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensoft%2Fopensoftrolloutbundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensoft%2Fopensoftrolloutbundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensoft%2Fopensoftrolloutbundle/lists"}