Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/becklyn/becklynstaticrolesbundle
Config-based user role management for Symfony
https://github.com/becklyn/becklynstaticrolesbundle
php roles security symfony symfony-bundle
Last synced: 2 days ago
JSON representation
Config-based user role management for Symfony
- Host: GitHub
- URL: https://github.com/becklyn/becklynstaticrolesbundle
- Owner: Becklyn
- License: bsd-3-clause
- Created: 2015-07-08T18:47:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T15:22:26.000Z (almost 2 years ago)
- Last Synced: 2024-09-17T23:21:18.710Z (about 2 months ago)
- Topics: php, roles, security, symfony, symfony-bundle
- Language: PHP
- Homepage: https://github.com/Becklyn/BecklynStaticRolesBundle
- Size: 62.5 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
BecklynStaticRolesBundle
========================
As user roles are directly coupled to the application code and we would like to configure our roles using an existing VCS (instead of the DB) this bundle implements a simple role system.
You define your roles including the hierarchy in your security.yml and the system provides ways to validated that, list them and for you to select them.
Installation
------------
You can install it via composer:
```bash
$ composer require becklyn/static-roles-bundle
```
Afterwards, you need to activate the bundle in your `app/AppKernel.php`:
```php
public function registerBundles()
{
$bundles = array(
// ...
new \Becklyn\StaticRolesBundle\BecklynStaticRolesBundle(),
// ...
);
// ...
}
```
Configuration
-------------
Open up `app/config/security.yml` and first remove the section `role_hierarchy` that is automatically provided by symfony.
Then add your own role configuration on top of the file:
```yml
becklyn_static_roles:
roles:
ROLE_ADMIN:
title: "Admin"
included_roles: [ROLE_USER]
ROLE_USER:
title: "User"
description: "The default frontend user"
tags: [tag1, tag2]
```
Assigning roles to a user entity
--------------------------------
The bundle provides a form type to be used in user forms:
```php
$builder
->add("roles", "static_role", [
"label" => "User roles",
"multiple" => true,
"expanded" => true,
]);
```
You will receive an array of roles in the entity as values: `["ROLE_ADMIN", "ROLE_USER"]`.
The mapping of these values can be done using the [`simple_array`][doctrine:simple-type] type of doctrine. You need to set it nullable to properly support a user without any roles.
```php
class User implements UserInterface
{
// ...
/**
* @var string[]
*
* @ORM\Column(name="roles", type="simple_array", nullable=true)
*
*/
private $userRoles = null;
// ...
/**
* @inheritdoc
*/
public function getRoles ()
{
return $this->roles;
}
/**
* @param string[]|null $roles
*/
public function setRoles (array $roles = null)
{
$this->roles = $roles;
}
// ...
}
```
Hidden roles
------------
If you are using roles, that should be used internally, but shouldn't be presented in the form type, you can add `hidden: true` to the role definition:
```yml
becklyn_static_roles:
roles:
ROLE_ADMIN:
title: "Admin"
included_roles: [ROLE_ALLOWED_TO_SWITCH]
ROLE_ALLOWED_TO_SWITCH:
title: "Internal: The user is allowed to switch roles"
hidden: true
```
In this example, only `ROLE_ADMIN` will be selectable by the user.
Tagging
-------
You can tag roles. This is a way to filter the visible roles in the form type. All roles that have at least one of your defined tags will be included.
```php
$builder
->add("roles", "static_role", [
"label" => "User roles",
"multiple" => true,
"expanded" => true,
"roles_with_tags" => ["tag1", "tag2"], // only include roles with either "tag1" or "tag2"
]);
```
```yml
becklyn_static_roles:
roles:
ROLE_USER_1:
title: "User 1"
tags: [tag1, tag3] # will be included, as it has at least one of the defined roles
ROLE_USER_2:
title: "User 2"
tags: [tag3, tag4] # will not be included, as it has none of the defined roles
```
If you don't define any tags in your form, all roles will be included.
```php
$builder
->add("roles", "static_role", [
"label" => "User roles",
"multiple" => true,
"expanded" => true,
"roles_with_tags" => [], // includes all roles
]);
// This is also the default value, so you can omit it:
$builder
->add("roles", "static_role", [
"label" => "User roles",
"multiple" => true,
"expanded" => true,
]);
```
Twig helper functions
---------------------
```twig
staticRoleTitle(key)
```
Returns the role title by key. Returns null if the role key is not found.
Note
----
If you are transforming sensitive data, please keep in mind that updating the roles of the user entity won't automatically update the roles of the authenticated user token.
You need to refresh this token.
You can fix this issue by adding this configuration in your `app/config/security.yml`:
```yml
security:
always_authenticate_before_granting: true
```
[doctrine:simple-type]: http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html#simple-array