PHPackages heimrichhannot/contao-entity-import-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. heimrichhannot/contao-entity-import-bundle ActiveContao-bundle[Database & ORM](/categories/database) heimrichhannot/contao-entity-import-bundle ========================================== A backend only bundle. It offers data import from database or files to database. 0.24.8(1y ago)22.1k↓50%3[2 issues](https://github.com/heimrichhannot/contao-entity-import-bundle/issues)[2 PRs](https://github.com/heimrichhannot/contao-entity-import-bundle/pulls)LGPL-3.0-or-laterPHPPHP ^7.4||^8.0CI failing Since Apr 8Pushed 3mo ago7 watchersCompare [ Source](https://github.com/heimrichhannot/contao-entity-import-bundle)[ Packagist](https://packagist.org/packages/heimrichhannot/contao-entity-import-bundle)[ Docs](https://github.com/heimrichhannot/contao-entity-import-bundle)[ RSS](/packages/heimrichhannot-contao-entity-import-bundle/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (28)Versions (81)Used By (0) Contao Entity Import Bundle =========================== [](#contao-entity-import-bundle) This bundle offers a generic importer to migrate data from various sources to contao database entities. **This Bundle is still in development.** Features -------- [](#features) - import data from either file content or database into arbitrary contao database entities (`tl_*`) - support for various data types (json, csv, ...) - support for various source types (contao file system, http, absolute path) - executable from contao backend, as cronjob and symfony command - automatic field manipulation (sorting, alias, dateAdded, tstamp) - merge and insert mode - email and contao\_log notifications while executing import with exceptions (will be sent once per importer configuration, will be reset after next successful import) - (optional) support for [DC\_Multilingual](https://github.com/terminal42/contao-DC_Multilingual) if installed Impressions ----------- [](#impressions) Importer source backend settings: [![alt import_source_1](./docs/img/importer_source.png)](./docs/img/importer_source.png) Importer config backend settings: [![alt privacy config](./docs/img/importer_config.png)](./docs/img/importer_config.png) Installation ------------ [](#installation) Install via composer: `composer require heimrichhannot/contao-entity-import-bundle` and update your database. Configuration ------------- [](#configuration) 1. Navigate to "Import" in the Contao backend in the section "system". 2. Create an importer source to your needs. 3. Create an importer using the source created in the step before. 4. Run the importer either using dry-run or the normal mode. ### config.yml [](#configyml) ``` huh_entity_import: debug: contao_log: true # log errors while importing to contao system log email: false # report errors while importing via email to the admin email defined in the contao settings ``` Technical instructions ---------------------- [](#technical-instructions) ### Output messages during import process respecting the context [](#output-messages-during-import-process-respecting-the-context) An importer can be run as command, cronjob or in the web context. The context implies how to output messages (or error messages). For example, when running an importer by clicking the "import" button in the website (i.e. in the browser), the messages should be printed out using `\Contao\Message::addError()` (or `addConfirmation()`, ...). If the import is run as command, the same messages need to be printed out on command line using a `SymfonyStyle` instance. If the command is also run in web context, the messages even need to be stored to the `tl_entity_import_config` entity, because these are retrieved by ajax in the progress bar view. As you can see, it's not just "printing a message", but taking care of the context, as well. For this you can use the method `ImporterInterface::outputResultMessage()` which takes care of the correct context itself. ### Run as symfony command [](#run-as-symfony-command) `huh:entity-import:execute config-ids [--dry-run]` where `config-ids` needs to be a comma separated list of importer config IDs. ##### Arguments [](#arguments) ArgumentMandatoryTypeDescriptionconfig-idtrueintegerThe ID of the importer configurationdry-runfalsebooleanRun importer without writing data into database### Run as contao cron [](#run-as-contao-cron) Import is executable with contao poor man's cron. The interval of execution is similar to the contao definition. The import configuration allows to enable cron execution and picking of the cron interval. Possible to choose between `minutely`, `hourly`, `daily`, `weekly`, `monthly` interval. It is recommended to setup the debug options in config.yml before importing via cronjob. ### Add custom sources [](#add-custom-sources) 1. Create the source and extend from `\HeimrichHannot\EntityImportBundle\Source\AbstractSource` or implement the interface `\HeimrichHannot\EntityImportBundle\Source\SourceInterface`. 2. Create an event listener for the event `SourceFactoryCreateSourceEvent`: ``` class SourceFactoryCreateSourceEventListener { public function __invoke(SourceFactoryCreateSourceEvent $event) { $sourceModel = $event->getSourceModel(); $source = $event->getSource(); switch ($sourceModel->type) { case 'new_stuff': $source = new NewStuffSource(); break; // ... } $event->setSource($source); } } ``` 3. Create a `tl_entity_import_source.php` and add your sources in the `type` field's options: ``` $dca = &$GLOBALS['TL_DCA']['tl_entity_import_source']; $dca['fields']['type']['options'] = array_merge($dca['fields']['type']['options'], [ 'new_stuff' ]); ``` 4. Create your palette in your `tl_entity_import_source.php`, e.g. by copying one from this bundle. ### Add presets for source/config field mapping [](#add-presets-for-sourceconfig-field-mapping) Adding a field mapping might be tedious sometimes. Hence we provide an event for adding presets which then are selectable in the backend entity (source and config). Just register an event listener and add your presets the following way: ``` $presets = $event->getPresets(); $presets = array_merge($presets, [ 'twitter' => [ [ 'name' => 'externalId', 'valueType' => 'source_value', 'sourceValue' => 'id', ], [ 'name' => 'text', 'valueType' => 'source_value', 'sourceValue' => 'full_text', ], [ 'name' => 'publishedAt', 'valueType' => 'source_value', 'sourceValue' => 'created_at', ], [ 'name' => 'imageUrl', 'valueType' => 'source_value', 'sourceValue' => 'image_url', ], [ 'name' => 'imageId', 'valueType' => 'source_value', 'sourceValue' => 'image_id', ], [ 'name' => 'url', 'valueType' => 'source_value', 'sourceValue' => 'url', ], ] ]); $event->setPresets($presets); ``` ### Add quick importers for editors [](#add-quick-importers-for-editors) To be honest: A "quick importer" is a nicer term for "easy importer", so that editors don't get sad ;-) The use case for quick importers is to have a user interface which is *way* easier to use for editors. Simply create an import source and import config as you would normally. Afterwards editors can create quick importers on their own and add custom file sources (currently only files of the type CSV are supported). [![alt quick importer example](./docs/img/quick_importer.png)](./docs/img/quick_importer.png) ### Run the import via cronjob in web context [](#run-the-import-via-cronjob-in-web-context) If you have large datasets the import might take too much memory of the web server. In this case it's often useful to 1. Run the importer as symfony command. This has to be done by a developer. 2. Run the importer in the web context by cronjob. This can be done by editors or developers. In most cases, running an importer by command on the shell takes way less memory compared to running it in the web context via website. For option 2 to work you need to do the following steps: 1. Add the bundle's import command as cronjob using the parameter `--web-cron-mode`: `* * * * * /path/to/vendor/bin/contao-console huh:entity-import:execute --web-cron-mode >/dev/null 2>&1` 2. Activate `useCron` in the importer config and fill out the needed fields. 3. Activate `useCronInWebContext` in the importer config. Events ------ [](#events) NameDescription`AddConfigFieldMappingPresetsEvent`Add config field mapping presets`AddSourceFieldMappingPresetsEvent`Add source field mapping presets`AfterCsvFileSourceGetRowEvent`Modify csv rows e.g. for fixing file encoding issues`AfterFileSourceGetContentEvent`Configure the data after receiving from source`AfterImportEvent`Get imported data after finished import`AfterItemImportEvent`Get imported item data after finished import`BeforeAuthenticationEvent`Configure authentication data before sending GET request to http source`BeforeImportEvent`Configure the data before importing`BeforeItemImportEvent`Configure the item data before importing; call `setSkipped(true)` in order to skip the import`SourceFactoryCreateSourceEvent`Implement custom logic for new custom file sources`BeforeFileImportEvent`Implement a custom logic for setting the folder and/or file path when importing files ### Health Score 39 — LowBetter than 86% of packages Maintenance38 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community17 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~20 days Recently: every ~85 days Total 76 Last Release 670d ago PHP version history (3 changes)0.1.0PHP ^7.1 0.19.3PHP ^7.1||^8.0 0.20.2PHP ^7.4||^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/28ad3224d8727b622ebd229840eea6b9dbcb83eb0bd609e6ce65b614830ff538?d=identicon)[digitales@heimrich-hannot.de](/maintainers/digitales@heimrich-hannot.de) --- Top Contributors [![Defcon0](https://avatars.githubusercontent.com/u/1485098?v=4)](https://github.com/Defcon0 "Defcon0 (11 commits)")[![SGehle](https://avatars.githubusercontent.com/u/1748990?v=4)](https://github.com/SGehle "SGehle (8 commits)")[![vvohh](https://avatars.githubusercontent.com/u/75325799?v=4)](https://github.com/vvohh "vvohh (4 commits)")[![AlexejKossmann](https://avatars.githubusercontent.com/u/32612134?v=4)](https://github.com/AlexejKossmann "AlexejKossmann (1 commits)")[![koertho](https://avatars.githubusercontent.com/u/12064642?v=4)](https://github.com/koertho "koertho (1 commits)") ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/heimrichhannot-contao-entity-import-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/heimrichhannot-contao-entity-import-bundle/health.svg)](https://phpackages.com/packages/heimrichhannot-contao-entity-import-bundle) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[contao/core-bundle Contao Open Source CMS 1231.6M2.4k](/packages/contao-core-bundle)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[shopware/storefront Storefront for Shopware 684.2M148](/packages/shopware-storefront) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)