Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heimrichhannot/contao-entity-import-bundle
https://github.com/heimrichhannot/contao-entity-import-bundle
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/heimrichhannot/contao-entity-import-bundle
- Owner: heimrichhannot
- Created: 2020-02-21T13:58:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T07:29:36.000Z (5 months ago)
- Last Synced: 2024-10-26T13:45:37.161Z (about 2 months ago)
- Language: PHP
- Size: 1000 KB
- Stars: 2
- Watchers: 8
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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
- 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
Importer source backend settings:
Importer config backend settings:
## Installation
Install via composer: `composer require heimrichhannot/contao-entity-import-bundle` and update your database.
## Configuration
1. Navigate to "Import" in the Contao backend in the section "system".
1. Create an importer source to your needs.
1. Create an importer using the source created in the step before.
1. Run the importer either using dry-run or the normal mode.
### config.yml
```yaml
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
### 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
`huh:entity-import:execute config-ids [--dry-run]`
where `config-ids` needs to be a comma separated list of importer config IDs.
##### Arguments
Argument | Mandatory | Type | Description
--------|--------|-------|---
config-id | true | integer |The ID of the importer configuration
dry-run | false | boolean |Run importer without writing data into database
### 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
1. Create the source and extend from `\HeimrichHannot\EntityImportBundle\Source\AbstractSource` or implement the
interface `\HeimrichHannot\EntityImportBundle\Source\SourceInterface`.
1. Create an event listener for the event `SourceFactoryCreateSourceEvent`:
```php
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);
}
}
```
1. Create a `tl_entity_import_source.php` and add your sources in the `type` field's options:
```php
$dca = &$GLOBALS['TL_DCA']['tl_entity_import_source'];
$dca['fields']['type']['options'] = array_merge($dca['fields']['type']['options'], [
'new_stuff'
]);
```
1. 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
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
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).
### 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
Name | Description
-----|------------
`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