pdUser Bundle

Simple user management system for Symfony 5+.

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 appaydin/pd-user

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

With Symfony 5, the package will be activated automatically. But if something goes wrong, you can install it manually.

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

<?php
// config/bundles.php

return [
    //...
    Pd\UserBundle\PdUserBundle::class => ['all' => true]
];

Step 3: Create User, Profile, Group, Class

A) Create User Class

Create the User class for your application. This class can look and act however you want: add any properties or methods you find useful. This is your User class.

<?php
// src/Entity/User.php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Pd\UserBundle\Model\User as BaseUser;

/**
 * @ORM\Table(name="user")
 * @ORM\Entity
 * @UniqueEntity(fields="email", message="email_already_taken")
 */
class User extends BaseUser
{
    public function __construct()
    {
        parent::__construct();
    }
}

B) Create Profile Class

Create the Profile class for your application. This class holds the user's private information.

<?php
// src/Entity/Profile.php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Pd\UserBundle\Model\Profile as BaseProfile;

/**
 * User Profile Table.
 *
 * @ORM\Table(name="user_profile")
 * @ORM\Entity
 */
class Profile extends BaseProfile
{
    
}

C) Create Group Class

Create the Group class for your application. This class creates user groups.

<?php
// src/Entity/Group.php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Pd\UserBundle\Model\Group as BaseGroup;

/**
 * @ORM\Table(name="user_group")
 * @ORM\Entity
 * @UniqueEntity(fields="name", message="group_already_taken")
 */
class Group extends BaseGroup
{
    
}

Step 4: Settings Bundle

Create a "user.yaml" file for the settings.

# config/packages/user.yaml

pd_user:
    user_class: App\Entity\User
    profile_class: App\Entity\Profile
    group_class: App\Entity\Group
    default_group: ''
    login_redirect: 'web_home'
    email_confirmation: true
    welcome_email: true
    user_registration: true
    #template_path: '@Admin/Auth'
    resetting_request_time: 7200
    mail_sender_address: 'example@example.com'
    mail_sender_name: 'pdUser'
    active_language: ['en', 'tr']
    register_type: ''
    resetting_type: ''
    

• user_class: Define 'User' class address
• profile_class: Define 'Profile' class address
• group_class: Define 'Group' class address
• default_group: New members will join group id
• login_redirect: The router name to which logged-in users will be directed.
• email_confirmation: Enables email verification for register.
• welcome_email: Welcome new members welcome message.
• user_registration: Enable/Disable user registration.
• template_path: Directory for Twig templates. Changes can be made by copying the source directory.
• resetting_request_time: Enter the retry time in seconds for password renewal.
• mail_sender_address: Mail sender address
• mail_sender_name: Mail sender name
• active_language: List of Active Language
• register_type: Register Form Type
• resetting_type: Resetting Form Type

####Events UserEvent::REGISTER_BEFORE => It is launched before the registration form. UserEvent::REGISTER => When the recording is complete, it is launched. UserEvent::REGISTER_CONFIRM => E-mail is launched when registration is confirmed. UserEvent::RESETTING => The password is launched when the reset mail is sent. UserEvent::RESETTING_COMPLETE => It is launched when the password is changed.

Step 5: Configure Your Application's Security.yml

Below is a minimal example of the configuration necessary to use the pdUser in your application:

# config/packages/security.yaml

security:
    encoders:
        App\Entity\User:
            algorithm: argon2i
    role_hierarchy:
        ROLE_ADMIN:       [ROLE_USER]
    providers:
        pdadmin_auth:
            entity:
                class: App\Entity\User
                property: email
    firewalls:
        # Enable for Development 
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false
        main:
            pattern:    ^/
            provider: pdadmin_auth
            user_checker: Pd\UserBundle\Security\UserChecker
            anonymous: true
            switch_user: true
            http_basic: ~
            form_login:
                use_referer: true
                login_path: security_login
                check_path: security_login
                #default_target_path: 'dashboard' # Login Redirect Path
                csrf_token_generator: security.csrf.token_manager
            logout:
                path: security_logout
                #target: 'home' # Logout Redirect Path
            remember_me:
                secret:   '%env(APP_SECRET)%'
                #lifetime: 604800
                path:     /
    access_control:
        - { path: ^/auth/login$, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/auth/register, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/auth/resetting, role: IS_AUTHENTICATED_ANONYMOUSLY }
        #- { path: '^/', role: ROLE_ADMIN }

Step 6: Import pdUser Routing

Now that you have activated and configured the bundle, all that is left to do is import the pdUser routing files.

By importing the routing files you will have ready made pages for things such as logging in, register, password resetting.

#config/routes.yaml

authorization:
    resource: "@PdUserBundle/Resources/config/routing.yaml"
    prefix: 'auth'

Step 6: Update Your Database Schema

All steps are completed. You can now update the database schema.

php bin/console doctrine:schema:update --force