Skip to content

Latest commit

 

History

History
194 lines (155 loc) · 6.13 KB

basic_configuration.md

File metadata and controls

194 lines (155 loc) · 6.13 KB
Raw

Prerequisites

Translations

If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.

# app/config/config.yml

framework:
    translator: { fallbacks: ["%locale%"] }

For more information about translations, check Symfony documentation and available BenGorUser translations.

Getting started

By default we recommend the following installation that will add the following adapters to the user bundle.

{
    "require": {
        "bengor-user/user-bundle": "^0.8",

        "bengor-user/symfony-routing-bridge-bundle": "^1.1",
        "bengor-user/symfony-security-bridge-bundle": "^1.0.1",
        "bengor-user/twig-bridge-bundle": "^1.0.1",
        "bengor-user/doctrine-orm-bridge-bundle": "^1.2.0",
        "bengor-user/swift-mailer-bridge-bundle": "^1.0.1",
        "bengor-user/simple-bus-bridge-bundle": "^1.0.1"
    }
}

Some other adapters for routing, security, ui, persistence, mailers and buses are available.

To install the desired adapters and the bundle itself run the following in the project root:

$ composer update

Make sure you have composer globally installed

Once the bundle has been installed enable it in the AppKernel:

// app/config/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...

        // Dependencies required by the bundle, keep the order.
        // First bridges and then the UserBundle
        
        // Bridges
        new BenGorUser\TwigBridgeBundle\TwigBridgeBundle(),
        new BenGorUser\SymfonyRoutingBridgeBundle\SymfonyRoutingBridgeBundle(),
        new BenGorUser\SymfonySecurityBridgeBundle\SymfonySecurityBridgeBundle(),
        new BenGorUser\SwiftMailerBridgeBundle\SwiftMailerBridgeBundle(),
        new BenGorUser\DoctrineORMBridgeBundle\DoctrineORMBridgeBundle(),
        new BenGorUser\SimpleBusBridgeBundle\SimpleBusBridgeBundle(),
        new BenGorUser\SimpleBusBridgeBundle\SimpleBusDoctrineORMBridgeBundle(),
        
        // User bundle
        new BenGorUser\UserBundle\BenGorUserBundle(),
        // ...
    ];
}

After that, you need to extend our BenGorUser\User\Domain\Model\User class in order to build the Doctrine mapping properly. The following snippet is the minimum code that bundle needs to work.

// src/AppBundle/Entity/User.php

namespace AppBundle\Entity;

use BenGorUser\User\Domain\Model\User as BaseUser;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="bengor_user")
 */
class User extends BaseUser
{
}

Next, you have to configure the bundle to work with the specific needs of your application in the config.yml:

# app/config/config.yml

ben_gor_user:
    user_class:
        user:
            class: AppBundle\Entity\User
            firewall: main

If you plan to implement a login system, you need to configure the security.yml:

# app/config/security.yml

security:
    encoders:
        AppBundle\Entity\User: bcrypt
    providers:
        bengor_user:
            id: bengor_user.user.provider
    firewalls:
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false
        main:
            anonymous: ~
            pattern: ^/user
            guard:
                authenticators:
                    - bengor_user.user.form_login_authenticator
            provider: bengor_user
            form_login:
                check_path: bengor_user_user_login_check
                login_path: bengor_user_user_login
                failure_path: bengor_user_user_login
            logout:
                path: bengor_user_user_logout
                target: /
    access_control:
        - { path: ^/user/login$, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/user/sign-up, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/user/enable, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/user/, role: ROLE_USER }

This bundle has some basic actions such as login, logout and registration already implemented. Just add the following to your routing.yml:

# app/config/routing.yml

ben_gor_user:
    resource: '@BenGorUserBundle/Resources/config/routing/all.yml'

It requires a route with its related controller action for success_redirection_route, so, the following code it can be a plain and simple example for that.

// src/AppBundle/Controller/DefaultController.php

namespace AppBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class DefaultController extends Controller
{
    /**
     * @Route("/user/", name="bengor_user_user_homepage")
     */
    public function adminAction()
    {
        // ...
    }
}

The list of available routes is available in the routes by default doc. To customize the routes check extending routes doc

That's all! Now that the bundle is configured, the last thing you need to do is update your database:

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

With this basic configuration you have single user login, logout and registration without confirmation.

  • For multiple users check this guide.
  • In order to use MongoDB's Doctrine ODM as persistence layer follow this chapter.
  • Back to the index.