Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/longitude-one/banned-bundle
This repository is a very small bundle for Symfony framework. Banned users won't be able to login on your website.
https://github.com/longitude-one/banned-bundle
bundle symfony
Last synced: 5 days ago
JSON representation
This repository is a very small bundle for Symfony framework. Banned users won't be able to login on your website.
- Host: GitHub
- URL: https://github.com/longitude-one/banned-bundle
- Owner: longitude-one
- License: mit
- Created: 2021-06-11T13:58:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T14:03:34.000Z (over 1 year ago)
- Last Synced: 2024-11-26T05:28:26.414Z (2 months ago)
- Topics: bundle, symfony
- Language: PHP
- Homepage:
- Size: 48.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Banned bundle for Symfony [](https://github.com/longitude-one/banned-bundle/actions/workflows/php.yml) [](https://www.travis-ci.com/longitude-one/banned-bundle)
=========================
LongitudeOne\BannedBundle is a very small bundle for Symfony framework.
Banned users won't be able to login on your application.
Installation
============
Make sure Composer is globally installed, as explained in the
[installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
Applications that use Symfony Flex
----------------------------------
Open a command console, enter your project directory and execute:
```console
$ composer require longitude-one/banned-bundle
```
Applications that don't use Symfony Flex
----------------------------------------
### 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:
```console
$ composer require longitude-one/banned-bundle
```
### Step 2: Enable the Bundle
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 [
// ...
LongitudeOne\BannedBundle\LongitudeOneBannedBundle::class => ['all' => true],
];
```
Configuration
=============
First, your user class should implement the BannedInterface, then add the stub method `isBanned`.
Example
-------
```php
// src/Entity/User.php
namespace App\Entity;
// declare the interface
use LongitudeOne\BannedBundle\Entity\BannedInterface;
use Symfony\Component\Security\Core\User\UserInterface;
// add the interface
class User implements BannedInterface, UserInterface
{
//Add a private property
private bool $banned = false;
//Your getter can be improved to avoid that an admin bans another one.
public function isBanned(): bool
{
//In this example admins cannot be banned
return $this->isBanned() and !in_array('ROLE_ADMIN', $this->getRoles());
}
//Add a setter if needed
public function setBanned(bool $banned): self
{
$this->banned = $banned;
return $this;
}
//...
}
```
Step2, configure the security layer:
Add the UserChecker service to your security config:
```yaml
# config/security.yaml
security:
...
firewalls:
...
main:
...
user_checker: lo_banned.user_checker
```
Jobs done!