README

This bundle provides user management and forms for Symfony3 Projects.

Installation

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 of the Composer documentation.

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

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

This bundle uses the EZWRecaptchaBundle which is configured in app/config/config.yml (documentation: EWZRecaptcha on GitHub):

# 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). 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

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

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

Configure security to your needs (documentation: Security from the Symfony Book). 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

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

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

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

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), so they will use the form themes (documentation: Form Themes from the Symfony Book).

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

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

Unit Testing

Currently there aren't any unit tests, and that's just not right.

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

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

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.

jairwin / user-bundle

Maintainers

Details