rollerworks/multi-user-bundle

Multi user management for the FOSUserBundle

RollerworksMultiUserBundle

!! MAINTAINERS WANTED !!

This project is no longer actively maintained! If you would like to takeover this project please leave a comment in: https://github.com/rollerworks/RollerworksMultiUserBundle/issues/96, _(*1)

, _(*2)

, _(*3)

The RollerworksMultiUserBundle adds support for a multi-user set-up using the FOSUserBundle. It provides a fully compatible in-place replacement for the 'fos_user' services., _(*4)

In practice it is build on-top of the FOSUserBundle, and uses the original controllers, forms and UserManager., _(*5)

Features include:, _(*6)

• Fully compatible with existing bundles that already use the FOSUserBundle
• Unlimited user-systems, each with there own configuration, storage engine, templates, forms, etc.
• Easy generation of new user-systems
• Unit tested

Caution: This bundle is developed in sync with FOSUserBundle's repository. For FOSUserBundle 2.0.x, you need to use the 1.0 release of the bundle (or lower)., _(*7)

As the FOSUserBundle 2.0 is not stable yet, multi-user support is considered experimental!, _(*8)

Warning: This bundle can not be used in combination with the PUGXMultiUserBundle. If the PUGXMultiUserBundle is installed, then please remove it before continuing., _(*9)

Documentation

The bulk of the documentation is stored in the doc/index.md file in this bundle:, _(*10)

Read the Documentation for master, _(*11)

Installation

All the installation instructions are located in documentation., _(*12)

License

This bundle is released under the MIT license. See the bundled LICENSE file for details., _(*13)

About

RollerworksMultiUserBundle was designed as an alternative to the PUGXMultiUserBundle., _(*14)

A major difference to the PUGXMultiUserBundle is that RollerworksMultiUserBundle does not use Doctrine ORM Joined-Entity inheritance and provides a richer set of features., _(*15)

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker., _(*16)

When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps., _(*17)

For opening a PR please use Gush so the information template is included., _(*18)

Credits

The original idea of the UserDiscriminator came from the PUGXMultiUserBundle., _(*19)

A major difference to the PUGXMultiUserBundle is as that RollerworksMultiUserBundle does not use Doctrine ORM Joined-Entity inheritance and every user-manager is accessible without 'discriminating'., _(*20)

This bundle contains source originally designed by the FOSUserBundle developers., _(*21)

Running the Tests

Before running the tests, you will need to install the bundle dependencies. Do this using composer:, _(*22)

The doctrine/mongodb-odm is required for functional tests but are not installed by default as it fails with some of the automated code analyzers., _(*23)

``` bash $ php composer.phar composer require doctrine/mongodb-odm:"1.0.@dev" --no-update $ php composer.phar composer require doctrine/mongodb-odm-bundle:"3.0.@dev" --no-update $ php composer.phar --dev install, <sub>(*24)</sub>

Then you can launch phpunit (make sure its installed https://github.com/sebastianbergmann/phpunit/#installation)

> Using the Composer version of PHPUnit currently fails so make sure to either use the Phar archive or PEAR version.
> You need at least version 3.6 of PHPUnit and MockObject plugin 1.0.8

``` bash
$ phpunit -c phpunit.xml.dist

Note: Functional test are not run by default, to run all tests make sure both PDO_SQLite and the PHP extension for MongoDB are installed, and launch phpunit with:, <sub>(*25)</sub>

bash $ bin/phpunit -c phpunit.xml.dist --exclude-group "", <sub>(*26)</sub>

Optionally you may skip the functional tests as these are always run automatically on Travis-CI when opening a Pull Request., <sub>(*27)</sub>