imatic/user-bundle

Imatic User Bundle

v5.0.0 2021-11-26 12:23 UTC

Requires

• php: >=7.4
• doctrine/doctrine-bundle: ^2.1.2
• doctrine/orm: ^2.7.4
• imatic/controller-bundle: ^5.0.0
• imatic/view-bundle: ^5.0.4
• sensio/framework-extra-bundle: ^5.6.1
• symfony/framework-bundle: ^4.4.16
• symfony/swiftmailer-bundle: ^3.5.1

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^3.3
• friendsofphp/php-cs-fixer: ^2.8
• imatic/form-bundle: ^4.0.1
• imatic/testing: ^6.0.2
• phpmd/phpmd: ^2.6
• symfony/asset: ^4.4
• symfony/expression-language: ^4.4
• symfony/web-profiler-bundle: ^4.4
• symfony/yaml: ^4.4

Suggests

• phpoffice/phpexcel: To create and import role documents.

MIT

• Stepan Koci
• Imatic Software s.r.o.

README

ImaticUserBundle

Roles

Global roles

Configuration

# app/config/security.yml

security:
    # ...

    role_hierarchy:
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

Translation

Global roles are translated using the "roles" domain.

Model roles

Configuration

# app/config/config.yml

# Imatic user
imatic_user:
    # ...
    security:
        role:
            model:
                namespaces:
                    includes:
                        - App
                    excludes:
                        - AppExampleBundle\Entity\Example   # exclude single entity
                        - AppFooBundle\Entity               # exclude all entities

Installation

1. Generate AppUserBundle

Generate and enable a local bundle called AppUserBundle.

This bundle will contain user-related entities and fixtures.

2. Download ImaticUserBundle using composer

"require": {
    # ...
    "imatic/user-bundle": "^3.0"
}

3. Enable the bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FOS\UserBundle\FOSUserBundle(),
        new Imatic\Bundle\UserBundle\ImaticUserBundle(),
    );
}

4. Configure the bundles

# app/config/config.yml

imports:
    # ...
    - { resource: "@ImaticUserBundle/Resources/config/config.yml" }
    - { resource: "@AppUserBundle/Resources/config/config.yml" }

doctrine:
    # ...
    orm:
        #...
        resolve_target_entities:
            # UserBundle
            Imatic\Bundle\UserBundle\Model\UserInterface: ApUserBundle\Entity\User
            Imatic\Bundle\UserBundle\Model\GroupInterface: AppUserBundle\Entity\Group

# Imatic user
imatic_user:
    entities:
        user: AppUserBundle\Entity\User
        group: AppUserBundle\Entity\Group
    security:
        role:
            model:
                namespaces:
                    includes: ~
                    excludes: ~
            hierarchy: ~

5. Configure the security

# app/config/security.yml

security:
    encoders:
        Symfony\Component\Security\Core\User\UserInterface: bcrypt

    role_hierarchy:
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

    providers:
        imatic_user_provider:
            id: imatic_user.user_provider.username

    firewalls:
        dev:
            pattern:  ^/(_(profiler|wdt)|css|images|js)/
            security: false

        main:
            pattern: ^/
            form_login:
                provider: imatic_user_provider
                csrf_token_generator: security.csrf.token_manager
            logout:       true
            anonymous:    true
            switch_user:  true

    access_control:
        - { path: ^/login$, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/register, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/resetting, role: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/, role: IS_AUTHENTICATED_FULLY }

6. Configure the routing

# app/config/routing.yml

imatic_user:
    resource: "@ImaticUserBundle/Resources/config/routing.yml"