bengor-user/user-bundle

Symfony bundle on top of BenGor's user library

v0.8.5 2017-06-26 08:03 UTC

README

Fully featured and test covered user Symfony bundle built on top of BenGorUser library

SensioLabsInsight Build Status Scrutinizer Code Quality Total Downloads Latest Stable Version Latest Unstable Version

Following the basic configuration guide, in 2 minutes you will have the following fully tested multiple user type and multiple renderers (HTML / JSON) features in your Symfony application:

  • User registration
    • Basic
    • With confirmation
    • By invitation
  • Change password
    • Basic
    • Without old password
    • Using Remember password
  • Log in / log out
  • JWT authentication
  • User removal
  • Role management
    • Grant
    • Revoke
  • Purge outdated tokens
    • Invitation token
    • Remember password token

Requirements

PHP >= 5.5
Symfony >= 2.8

Documentation

All the documentation is stored in the docs folder.

Show me the docs!

Tests

This bundle is completely tested by PHPSpec, SpecBDD framework for PHP.

In case you want to contribute or just run the tests, use the following command.

$ vendor/bin/phpspec run -fpretty

Contributing

If you have any doubt or maybe you want to share some opinion, you can use our Gitter chat.

Join the chat at https://gitter.im/BenGorUser/User

BenGorUser uses Crowdin as tool to manage translations so, please help us translating your favorite language via this service. Pull requests about translations will not be accepted.

Crowdin

This bundle follows PHP coding standards, so pull requests need to execute the Fabien Potencier's PHP-CS-Fixer. Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order to simplify we provide a Composer script that wraps all the commands related with this process.

$ composer run-script cs

There is also a policy for contributing to this project. Pull requests must be explained step by step to make the review process easy in order to accept and merge them. New methods or code improvements must come paired with PHPSpec tests.

If you would like to contribute it is a good point to follow Symfony contribution standards, so please read the Contributing Code in the project documentation. If you are submitting a pull request, please follow the guidelines in the Submitting a Patch section and use the Pull Request Template.

Credits

This bundle is created by:

@benatespina - benatespina@gmail.com
@gorkalaucirica - gorka.lauzirika@gmail.com

Licensing Options

License