phil / helpdesk-bundle
A help desk in Symfony where each request is a private conversation: queues worked by role, statuses moved by Symfony Workflow, assignees and canned replies.
Package info
github.com/parler-haut-interagir-librement/helpdesk-bundle
Type:symfony-bundle
pkg:composer/phil/helpdesk-bundle
Requires
- php: >=8.5
- doctrine/dbal: ^4.5
- phil/conversation-bundle: ^0.1@dev
- psr/clock: ^1.0
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
- symfony/event-dispatcher-contracts: ^3.6
- symfony/http-foundation: ^8.2
- symfony/http-kernel: ^8.2
- symfony/workflow: ^8.2
Requires (Dev)
- ext-pdo: *
- doctrine/doctrine-bundle: ^3.3
- doctrine/orm: ^3.7
- easycorp/easyadmin-bundle: ^5.8
- phil/notifications-bundle: ^0.1@dev || ^0.2@dev
- phil/privacy-bundle: ^0.1@dev
- phil/ux-kit: ^0.5@dev
- 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.2
- symfony/event-dispatcher: ^8.2
- symfony/framework-bundle: ^8.2
- symfony/key-management: ^8.2
- symfony/messenger: ^8.2
- symfony/routing: ^8.2
- symfony/security-bundle: ^8.2
- symfony/security-core: ^8.2
- symfony/security-csrf: ^8.2
- symfony/translation: ^8.2
- symfony/twig-bridge: ^8.2
- symfony/twig-bundle: ^8.2
- symfony/ux-twig-component: ^3.7
- twig/extra-bundle: ^3.24
- twig/twig: ^3.21
Suggests
- doctrine/orm: For the table added to the schema the ORM generates
- easycorp/easyadmin-bundle: To graft the pages of the agents on the dashboards of an EasyAdmin back office
- phil/notifications-bundle: To notify an agent a request is assigned to
- phil/privacy-bundle: For the requests in the export and the erasure of a member's data
- phil/ux-kit: For the recipes Button, Badge, Input, NativeSelect and Textarea the pages draw, through the Symfony UX Toolkit
- symfony/routing: For the pages of the requesters and of the agents
- symfony/security-core: To name the agents of each queue by role
- symfony/security-csrf: For the forms of the pages
- symfony/twig-bundle: For the pages and the canned replies
- symfony/ux-twig-component: For the recipes of the kit the pages draw
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-21 03:14:04 UTC
README
A help desk for Symfony: requests that are conversations, with queues, statuses and canned replies.
phil/helpdesk-bundle gives an application a help desk. A member asks for help: they pick a queue, write a subject and their question, and the request opens. Each request is a conversation of phil/conversation-bundle — sealed at rest, read and unread, notified — opened by the requester alone, with a queue, a status and an assignee. The agents of a queue read its requests on their desk, answer in their own words or with a canned reply, take a request or assign it, move it to another queue, resolve it and close it; when an agent answers, the agent joins the conversation and the request waits for the requester, and when the requester answers, it comes back to the agents.
The status moves through a Symfony Workflow state machine, phil_helpdesk_ticket: new, open, waiting, resolved,
closed. Its events are those of the component, so an application holds a transition with a guard or follows one with a
listener. The queues and the roles of their agents come from the configuration, checked by Symfony Security's
authorization checker, or by the application's own QueueAccess. Canned replies are Twig templates of the
application, written for the request, offered in the queues they name; an adapter to the application's content
templates replaces them through the port CannedReplies.
It is for a site that answers its members: a shop's customer service, the support of an online service, the volunteers of an association. The requesters' pages and the agents' desk work without JavaScript and draw their buttons, statuses, fields and text areas with the recipes of the kit, installed by the Symfony UX Toolkit; with EasyAdminBundle, the desk is also grafted on every dashboard, in its layout, through the same services.
The bundle keeps its table through DBAL, without the ORM, so that a long queue is read by page. phil/notifications-bundle and phil/privacy-bundle are optional: with the first, an agent is notified of a request someone else assigned to them; with the last, the requests take part in the export and the erasure of a member's data. The services keep no state between requests and are safe in a long-running worker.
Status
| Part | State |
|---|---|
| Requests as conversations of phil/conversation-bundle, opened by the requester alone, with a queue, a status and an assignee | Implemented and tested |
The workflow phil_helpdesk_ticket: the agent's answer waits for the requester, the requester's answer brings the request back |
Implemented and tested |
Queues and their agents by role, through QueueAccess; take, assign, move, resolve, reopen, close |
Implemented and tested |
Canned replies: Twig templates of the application by queue, through the port CannedReplies |
Implemented and tested |
The DBAL store, the schema by Schema::editor(), moments in UTC; MySQL 8.4, PostgreSQL 17 and SQLite |
Implemented and tested |
| The pages of the requesters and the desk of the agents, with the recipes of the kit, English and French | Implemented and tested |
| The desk grafted on the dashboards of EasyAdmin | Implemented and tested |
The notification of an assignment through phil/notifications-bundle |
Implemented and tested |
The export and the erasure of a member's requests through phil/privacy-bundle |
Implemented and tested |
An adapter of CannedReplies to the content templates of the application |
Through the port, by the application |
| The Flex recipe: the bundle, a queue and the routes | Written in recipe/0.1, for the recipes repository of PHIL |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, the table, the routes, the recipes of the kit, EasyAdmin, the recipe. |
| Configuration | Every option, with an example. |
| Requests | Opening, answering, the desk, assigning, moving, the workflow and its events, the pages. |
| Canned replies | The templates of the configuration, and the port that replaces them. |
| Extension points | The ports, the workflow, the events, the services to replace, and when they are stable. |
| Testing | The bundle's tests, the servers its integration tests read, and testing code that uses it. |
| Reference | Every class and file of the bundle. |
Quick start
composer require phil/helpdesk-bundle php bin/console ux:install button badge input native-select textarea --kit=github.com/parler-haut-interagir-librement/ux-kit
# config/packages/phil_helpdesk.yaml phil_helpdesk: queues: billing: { label: Billing, roles: [ROLE_BILLING] } tech: { label: Technical support, roles: [ROLE_TECH] } canned_replies: thanks: { label: Thanks for your patience, template: helpdesk/thanks.txt.twig }
# config/routes/phil_helpdesk.yaml phil_helpdesk: resource: '@PhilHelpdeskBundle/config/routes.php' prefix: /help phil_helpdesk_agents: resource: '@PhilHelpdeskBundle/config/routes_agents.php' prefix: /support-desk
Requirements
PHP 8.5 or later, Symfony 8.2 or later with its Workflow component, Doctrine DBAL 4, and phil/conversation-bundle with its key management service.
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.