PHPackages jairwin/user-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. jairwin/user-bundle ActiveSymfony-bundle jairwin/user-bundle =================== This bundle provides user management and forms for Symfony 3 projects. v1.1.7(7y ago)168MITPHP Since Apr 4Pushed 7y ago1 watchersCompare [ Source](https://github.com/JAIrwin/JAIUserBundle)[ Packagist](https://packagist.org/packages/jairwin/user-bundle)[ Docs](https://github.com/JAIrwin/JAIUserBundle)[ RSS](/packages/jairwin-user-bundle/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (8)Dependencies (3)Versions (10)Used By (0) JAIUserBundle ============= [](#jaiuserbundle) This bundle provides user management and forms for Symfony3 Projects. Installation ------------ [](#installation) ### Step 1: Download the Bundle [](#step-1-download-the-bundle) Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle: ``` $ composer require jairwin/user-bundle ``` This command requires you to have Composer installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md)of the Composer documentation. ### Step 2: Enable the Bundle [](#step-2-enable-the-bundle) Enable the bundle and the depended bundles by adding them to the list of registered bundles in `app/AppKernel.php`: ``` // app/AppKernel.php // ... class AppKernel extends Kernel { public function registerBundles() { $bundles = array( // ... new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle(), new Doctrine\Bundle\FixturesBundle\DoctrineFixturesBundle(), new EWZ\Bundle\RecaptchaBundle\EWZRecaptchaBundle(), new JAI\Bundle\UserBundle\JAIUserBundle(), ); // ... } // ... } ``` ### Step 3: Add Routing [](#step-3-add-routing) To add the provided routes update `app/config/routing.yml`: ``` # app/config/routing.yml jai_user: resource: "@JAIUserBundle/Resources/config/routing.yml" prefix: / logout: path: /logout ``` ### Step 4: Configure ReCaptcha [](#step-4-configure-recaptcha) This bundle uses the EZWRecaptchaBundle which is configured in `app/config/config.yml`(documentation: [EWZRecaptcha on GitHub](https://github.com/excelwebzone/EWZRecaptchaBundle)): ``` # app/config/config.yml ewz_recaptcha: public_key: here_is_your_public_key private_key: here_is_your_private_key locale_key: %kernel.default_locale% ``` For development you need to provide separate configuratons using the public test keys everywhere except production (documentation: [Google Recaptcha FAQ](https://developers.google.com/recaptcha/docs/faq)). You could either store the keys in `parameters.yml` or add the `ewz_recaptcha` configurations to `config_dev.yml`, `config_prod.yml`, and `config_test.yml` instead of `config.yml`. ### Step 5: Enable Translations [](#step-5-enable-translations) To get the correct form labels and placeholders enable translation. In a new Symfony3 project it needs to be uncommented in `app/config/config.yml`: ``` # app/config/config.yml framework: translator: { fallbacks: ["%locale%"] } ``` And set the locale in `app/config/parameters.yml`: ``` # app/config/parameters.yml locale: en ``` Note - so far only english translations have been provided in this bundle. Most of the defaults are rather ugly. ### Step 6: Configure Required parameters [](#step-6-configure-required-parameters) Make sure your database and mailer parameters are correct in `app/config/parameters.yml`. You will also need to add `site_name` and `from_email` parameters. ``` # app/config/parameters.yml parameters: database_host: 127.0.0.1 database_port: null database_name: your_database_name database_user: your_database_user database_password: your_database_user_password mailer_transport: smtp mailer_host: 127.0.0.1 mailer_user: your_mail_user mailer_password: your_mail_password secret: somethingmorerandomthanthis locale: en # JAI User Bundle Configuration site_name: My Great Website from_email: greeter@yourdomain.tld ``` ### Step 7: Configure Security [](#step-7-configure-security) Configure security to your needs (documentation: [Security from the Symfony Book](http://symfony.com/doc/current/book/security.html)). Here is an example you can start with: ``` # app/config/security.yml security: encoders: JAI\Bundle\UserBundle\Entity\User: algorithm: bcrypt role_hierarchy: ROLE_ADMIN: ROLE_USER # http://symfony.com/doc/current/book/security.html#where-do-users-come-from-user-providers providers: our_db_provider: entity: class: JAIUserBundle:User firewalls: # disables authentication for assets and the profiler, adapt it according to your needs dev: pattern: ^/(_(profiler|wdt)|css|images|js)/ security: false main: anonymous: ~ form_login: login_path: jai_user_login check_path: jai_user_login username_parameter: login[username] password_parameter: login[password] provider: our_db_provider logout: path: /logout target: / remember_me: secret: "preferablysomethingmoresecretthanthis" remember_me_parameter: login[remember] access_control: # require ROLE_ADMIN for /admin* #- { path: ^/admin, roles: ROLE_ADMIN } # require ROLE_USER for /user* - { path: ^/user, roles: ROLE_USER } ``` For the moment we've disabled the firewall for the admin page, there's a reason for that. we'll fix it later. ### Step 8: Initialize the Database [](#step-8-initialize-the-database) Update the database schema and load the initial roles from the console: ``` $ php bin/console doctrine:schema:update --force $ php bin/console doctrine:fixtures:load ``` ### Step 9: Create an Admin User [](#step-9-create-an-admin-user) At this point all of the routes should be working, so you can register a new user by going to `/register`. If email is configured correctly an activation email will be sent. Using the link in the activation email will land you on the login page with the message that your account is now active. Now go to `/admin/user` and Click on the name of your new user and you will see the profile information displayed. Find the button under "Available Roles" named "ROLE\_ADMIN" and click it. The selected user will update with the role ROLE\_ADMIN. ### Step 10: Secure the Admin Page [](#step-10-secure-the-admin-page) Now that we have an admin user we'll fix the admin firewall in `app/config/security.yml`. Just un-comment it: ``` # app/config/security.yml access_control: # require ROLE_ADMIN for /admin* - { path: ^/admin, roles: ROLE_ADMIN } # require ROLE_USER for /user* - { path: ^/user, roles: ROLE_USER } ``` Now you can only access `/admin/user` (actually `/admin/*` since you'll probably have other Admin pages in your app) logged in as a user with the role ROLE\_ADMIN. Using ----- [](#using) This bundle provides the routes `/register`, `/activate`, `/login`, `/logout`, `/user/profile`, `/forgot`, `/reset`, and `/admin/user`. Their purposes should be self-explanatory. The forms use the Symfony Forms Component (documentation: [Forms from the Symfony Book](http://symfony.com/doc/current/book/forms.html)), so they will use the form themes (documentation: [Form Themes from the Symfony Book](https://symfony.com/doc/current/cookbook/form/form_customization.html#cookbook-form-customization-form-themes)). To make the routes visually consistent with your own site start by overriding `UserBundle/Resources/views/base.html.twig` to extend one of your own templates : ``` {# UserBundle/Resources/views/base.html.twig #} {% extends 'base.html.twig' %} {% block body %} {% block user %}{% endblock %} {% endblock %} ``` Upgrading --------- [](#upgrading) Some upgrades will include database schema changes. After updating you may need to **backup your database** and run doctrine migrations: ``` $ php bin/console doctrine:migrations:diff $ php bin/console doctrine:migrations:migrate ``` **Always backup your database first!** For example, v1.1.0 renamed the tables to avoid possible conflicts. Doctrine diffs this as DROP old\_table\_name, ADD new\_table\_name. In this case, reading the diff would tell you what will happen and you'd need the backup to restore your user, role, and user\_role join table data to the renamed tables. To-Do ----- [](#to-do) ### Unit Testing [](#unit-testing) Currently there aren't any unit tests, and that's just not right. ### Remove Dependency on EWZRecaptchaBundle [](#remove-dependency-on-ewzrecaptchabundle) It would be better if there was an optional setting like "use captcha" and then further settings such as only requiring after a certain amount of flooding, and then specifics related to whatever captcha implementation is used in the current project. ### User Admin Features [](#user-admin-features) Delete user should be added to the admin page. Currently you can only delete a user by accessing the database directly. "Delete Inactive" - Specify a number of days since registration to show accounts that have not been activated. View should be a table of inactive users with a checkbox for each, and a "delete marked" button. Currently users are selected for editing from a drop-down list of user names. Need a "find user" feature to search by user name or email. This is especially needed for sites with a large number of users. ### User Admin Manage Roles [](#user-admin-manage-roles) This is a little tricky because ideally you should be able to both add roles and change the heirarchy. Currently roles are in the database while the heirarchy is in `app/config/security.yml`. ### Health Score 29 — LowBetter than 59% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community4 Small or concentrated contributor base Maturity69 Established project with proven stability How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~102 days Recently: every ~163 days Total 9 Last Release 2874d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/c65f19c9962aba4ecb38b2b32bf8fd29927abd558a47c92eb9fd811d48cc3683?d=identicon)[JAIrwin](/maintainers/JAIrwin) --- Tags User managementuser registrationuser activationuser-profileuser loginuser role assignment ### Embed Badge ![Health badge](/badges/jairwin-user-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/jairwin-user-bundle/health.svg)](https://phpackages.com/packages/jairwin-user-bundle) ``` ### Alternatives [friendsofsymfony/user-bundle Symfony FOSUserBundle 3.2k35.4M311](/packages/friendsofsymfony-user-bundle)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[dektrium/yii2-user Flexible user registration and authentication module for Yii2 913792.8k38](/packages/dektrium-yii2-user)[jrean/laravel-user-verification User Email Verification For Laravel 865843.6k7](/packages/jrean-laravel-user-verification)[2amigos/yii2-usuario Highly customizable and extensible user management, authentication, and authorization Yii2 extension 298275.5k14](/packages/2amigos-yii2-usuario)[nucleos/user-bundle Lightweight user management for symfony 61380.7k5](/packages/nucleos-user-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)