phil / moderation-bundle
A single report queue for posts, comments, reactions, listings, messages and profiles, each package plugging in its own target: roles and decision history, a first-post sandbox, temporary hiding by trusted members, a statement of reasons to authors, member notes, a public journal without names, and
Package info
github.com/parler-haut-interagir-librement/moderation-bundle
Type:symfony-bundle
pkg:composer/phil/moderation-bundle
Requires
- php: >=8.5
- ext-mbstring: *
- ext-sodium: *
- doctrine/dbal: ^4.5
- psr/clock: ^1.0
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
- symfony/http-foundation: ^8.2
- symfony/http-kernel: ^8.2
- symfony/routing: ^8.2
- symfony/security-core: ^8.2
- symfony/security-csrf: ^8.2
- symfony/translation: ^8.2
- symfony/translation-contracts: ^3.6
- symfony/ux-twig-component: ^3.7
- twig/twig: ^3.21
Requires (Dev)
- doctrine/doctrine-bundle: ^3.3
- doctrine/orm: ^3.7
- easycorp/easyadmin-bundle: ^5.8
- phil/incident-mode: ^0.2@dev
- phil/notifications-bundle: ^0.1@dev
- phil/privacy-bundle: ^0.1@dev
- phil/ux-kit: >=0.5.0-alpha <1.0
- phpunit/phpunit: ^13.4
- psr/log: ^3.0
- symfony/browser-kit: ^8.2
- symfony/clock: ^8.2
- symfony/css-selector: ^8.2
- symfony/dom-crawler: ^8.1
- symfony/event-dispatcher: ^8.2
- symfony/framework-bundle: ^8.2
- symfony/messenger: ^8.2
- symfony/security-bundle: ^8.2
- symfony/twig-bundle: ^8.2
- symfony/yaml: ^8.2
- twig/extra-bundle: ^3.21
Suggests
- doctrine/orm: To add the tables of the bundle to the schema the ORM generates, so that a migration creates them
- easycorp/easyadmin-bundle: For the pages of the moderation inside every dashboard of an EasyAdmin back office
- phil/incident-mode: For the incident mode, offered in the back office and proposed when reports surge, and its port EstablishedMembers, which spares the members the application holds for established
- phil/notifications-bundle: To tell a member a statement of reasons is addressed to them
- phil/privacy-bundle: For the moderation's records of a member in the export and the erasure of their data
- phil/ux-kit: For the recipes the templates draw — Alert, Badge, Button, Field, Input, NativeSelect, Table, Textarea —, through the Symfony UX Toolkit
- symfony/messenger: To lift an incident at its end by a delayed message
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-16 01:17:49 UTC
README
One queue for every report on a site — forum posts, comments, reactions, listings, messages, profiles —, the decisions of its moderators and their history, a statement of reasons to the author of each restricted content, the hooks of the first-post sandbox and the watched words, and a public journal that shows the role of a moderator and never their name.
phil/moderation-bundle gives a Symfony site a single place where its moderators review what members report. Each
package that holds content plugs in its own ModerationTarget — what the queue shows of a content, and what a
decision does to it — and every report, whatever the content, lands in the same queue. A moderator acts under a role
of the site's configuration, which may cover every type of content or only some; their decision — dismiss, approve,
hide, restore, remove, warn — is applied by the content's package, closes the open reports, and joins the history of
the content and of its author. A decision that restricts the author comes with a statement of reasons: the reason,
whether it rests on the terms of the site or on the law, the facts, whether a report or automated detection prompted
it, and the ways to contest it, which the author reads on their own page and may be notified of.
The same queue receives what the site holds back on its own: a package calls Submissions::submit() when a member
posts, and the watched words block, hold or flag the text, while the sandbox of the first post holds the first
content of a newcomer until a moderator approves one. Members of a high trust level may hide a content at once, until
the moderation reviews it. Moderators keep notes on a member, which the member never reads. The public journal lists
the public decisions with the role they were taken under. When phil/incident-mode 0.2 is installed, the back office
offers the incident mode, and proposes it when reports surge; an incident may spare the members the site holds for
established.
Members are designated by a stable identifier, never an e-mail address. The records live in five tables of a Doctrine
DBAL connection, their moments in UTC, and join a member's export and erasure through phil/privacy-bundle. The
pages answer on the bundle's routes and, with EasyAdmin, inside every dashboard; they draw their parts with recipes of
the PHIL UX kit.
Status
| Part | State |
|---|---|
| One queue for every registered target type; a report per member and target while it is open; reasons from the configuration | Implemented and tested |
| Roles of the moderation: the first one held, the target types each covers | Implemented and tested |
| Decisions applied by the target's package, closing the open reports; history per target and per member | Implemented and tested |
Statements of reasons: grounds checked before the action, terms or law by reason, report and automated detection, redress; the member's pages; the notification with phil/notifications-bundle |
Implemented and tested |
Submissions: the hook of the watched words (block, hold, flag, replace) and of the first-post sandbox |
Implemented and tested |
| Temporary hiding by trusted members, reviewed by the moderation | Implemented and tested |
Profiles as a target, through the application's MemberProfiles |
Implemented and tested |
| Notes of the moderation on a member | Implemented and tested |
| The public journal: role, never name | Implemented and tested |
The incident mode offered, and proposed when reports surge, with phil/incident-mode |
Implemented and tested |
| Restrictions of an incident that spare established members | Implemented and tested; who is established comes through the port EstablishedMembers of phil/incident-mode, which the application implements |
| The pages, on the bundle's routes and inside EasyAdmin dashboards; the report form; the recipes of the kit | Implemented and tested |
Export and erasure through phil/privacy-bundle |
Implemented and tested |
| DBAL tables on PostgreSQL, MySQL and SQLite, moments in UTC, ORM schema listener | Implemented and tested |
Watched words from phil/watched-words |
Port only: WordScreen; the adapter comes with that package |
Trust levels from phil/trust-levels |
Ports only: TrustedHiders, and EstablishedMembers of phil/incident-mode; the adapters come with that package |
Reports on Fediverse content and the Flag activity |
Not started |
| The appeal of a decision, reviewed inside the bundle by another role than the one that decided | Not started: the statement of reasons links to the complaint page the site configures |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, the bundle, the tables, the routes, the recipes, the members. |
| Configuration | Every option, with an example. |
| The queue | Targets, reports, roles, decisions and their history. |
| Hooks | The first-post sandbox, the watched words, temporary hiding by trusted members, profiles. |
| Statements of reasons | The grounds of a restriction, what the author reads, the notification, the redress. |
| Pages | The back office, EasyAdmin, the notes on members, the report form, the public journal. |
| Incident mode | What the bundle wires when phil/incident-mode is installed. |
| Personal data | Stable identifiers, the export and the erasure. |
| Extension points | The ports, tags and events, and when they are stable. |
| Testing | The bundle's tests, its benchmark, and the servers its integration tests read. |
| Reference | Every class and service of the bundle. |
Quick start
// config/bundles.php Phil\ModerationBundle\PhilModerationBundle::class => ['all' => true],
# config/packages/phil_moderation.yaml phil_moderation: roles: - { name: moderator, attribute: ROLE_MODERATOR } sandbox: types: [forum.post]
{{ include('@PhilModeration/_report_form.html.twig', {type: 'forum.post', id: post.id}) }}
Requirements
PHP 8.5 or later with ext-sodium, Symfony 8.2 or later, Doctrine DBAL 4.5, Twig and Symfony UX Twig Component 3.7.
SecurityBundle for the pages of the moderation.
Contributing
Contributions are welcome on the PHIL monorepo: read the contribution guide and the code of conduct. Report a vulnerability privately, as the security policy explains, never in a public issue.
License
MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. See LICENSE.