phil / document-import-bundle
Word, OpenDocument, RTF and PDF files imported into UJO documents in Symfony: scanned first, limits and style map configured, images kept in the media library.
Package info
github.com/parler-haut-interagir-librement/document-import-bundle
Type:symfony-bundle
pkg:composer/phil/document-import-bundle
Requires
- php: >=8.5
- ext-mbstring: *
- ext-sodium: *
- phil/document-import: ^0.1@dev
- phil/svg-sanitizer: ^0.1@dev
- phil/ujo: ^0.1@dev
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
Requires (Dev)
- phil/media-bundle: ^0.2@dev
- phil/upload-scan: ^0.1@dev
- phil/upload-scan-bundle: ^0.1@dev
- phpunit/phpunit: ^13.4
- psr/log: ^3.0
- symfony/clock: ^8.2
- symfony/event-dispatcher: ^8.2
- symfony/event-dispatcher-contracts: ^3.6
- symfony/framework-bundle: ^8.2
- symfony/http-kernel: ^8.2
- symfony/messenger: ^8.2
- symfony/twig-bundle: ^8.2
- symfony/yaml: ^8.2
- twig/twig: ^3.21
Suggests
- phil/media-bundle: For the imported images stored in the media library
- phil/upload-scan-bundle: For each imported file scanned by an antivirus before it is parsed
- symfony/messenger: For the imports on a worker
- twig/twig: For the report of an import rendered as an HTML fragment
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-21 03:04:37 UTC
README
Word processing documents and PDFs imported in a Symfony application, their images sanitized and kept in the media library, and documents exported back to DOCX or ODT.
phil/document-import-bundle puts phil/document-import in a Symfony application. It registers the
DocumentImporter and the DocumentExporter as services, with the limits, the style map and the policy of the
SvgSanitizer every SVG image goes through, and gives the importer a media store: the media library of
phil/media-bundle when that bundle is registered — each image uploaded as a medium, in a collection of the
configuration, with its text alternative —, or a folder prefix otherwise. DocumentImports reads only the formats
the application accepts — DOCX, strict OOXML included, ODT, flat ODT, RTF, PDF, Markdown, HTML —, refuses an upload
larger than the limits before reading it, has each file scanned by phil/upload-scan-bundle before it is parsed when
that bundle is registered, and gives the report of what each import left out as an event, a block of the document or
a Twig fragment. DocumentImportQueue imports on a Messenger worker, with messages that carry a claim and nothing
else: the file waits in a store, never in the message.
It is for any Symfony application that receives texts written elsewhere: a CMS that takes manuscripts, a tool that lays out books from the chapters of their authors, a wiki that imports old pages. A controller asks for the importer, imports the uploaded file, and gets a UJO document whose image blocks point to media already kept.
It is a thin bundle built on symfony/config and symfony/dependency-injection, and dispatches through
psr/event-dispatcher. phil/media-bundle, phil/upload-scan-bundle, symfony/messenger and Twig are optional:
each part that uses one is registered only when it is installed or enabled.
The design is small: PhilDocumentImportBundle reads the configuration, DocumentImportServices registers the
services, DocumentImports applies the accepted formats and the screening and dispatches DocumentImported,
DocumentImportQueue and ImportDocumentHandler import on a worker, and MediaLibraryStore keeps the images in the
media library.
Status
| Part | State |
|---|---|
DocumentImporter, DocumentExporter and SvgSanitizer as services; the limits, the style map and the SVG policy configured |
Implemented and tested |
DocumentImports: the formats accepted for import and export, uploads checked against the limits, the report title |
Implemented and tested |
DocumentImported, the report of each import dispatched as an event |
Implemented and tested |
Images kept in phil/media-bundle, in a configured collection, with their text alternative |
Implemented and tested |
| Images under a folder prefix, without the media library | Implemented and tested |
Each file scanned by phil/upload-scan-bundle before it is parsed |
Implemented and tested |
The report as a Twig fragment, @PhilDocumentImport/report.html.twig |
Implemented and tested |
| Imports on a Messenger worker, the message carrying a claim, the file in a directory or a store of the application | Implemented and tested |
| An upload form and a controller that imports | Not started: the application's |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, installing and enabling the bundle. |
| Configuration | Every option, and the services it gives. |
| Media | Where the images go: the media library, a folder, a store of the application's own. |
| Importing | Importing in a controller, the scan before parsing, the report shown to the author, the style map, exporting. |
| Imports on a worker | The queue, its message and its claims, where the files wait, the events of the result. |
| Extension points | The services and options an application replaces or relies on. |
| Exceptions | What the bundle and the libraries throw. |
| Testing | The bundle's tests, and testing an application that uses it. |
| Reference | Every class and service of the bundle. |
Quick start
composer require phil/document-import-bundle
# config/packages/phil_document_import.yaml phil_document_import: media: collection: manuscripts formats: import: [docx, odt, rtf] styles: 'Chapter Title': heading-1 'Author Note': omit svg: max_bytes: 1048576
public function __invoke(Request $request, DocumentImports $imports): Response { $file = $request->files->get('manuscript'); $imported = $imports->importFile($file->getPathname(), filename: $file->getClientOriginalName()); // $imported->document: the UJO document; $imported->report: what was left out; // $imports->documentWithReport($imported): the document with the report as a last block. }
{% include '@PhilDocumentImport/report.html.twig' with {report: imported.report} %}
Requirements
PHP 8.5 or later with ext-sodium, Symfony 8.2, phil/document-import, phil/svg-sanitizer, phil/ujo and
psr/event-dispatcher; phil/media-bundle, for the images kept in the media library; phil/upload-scan-bundle, for
the antivirus; symfony/messenger, for the imports on a worker; Twig, for the report fragment.
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.