heimrichhannot/contao-exporter

A backend module for exporting any contao entity to file.

4.2.5 2018-09-11 12:18 UTC

Requires

• php: ~5.4 || ~7.0
• contao-community-alliance/composer-plugin: ~2.4 || ~3.0
• contao/core-bundle: ^3.5.1 || ~4.1
• heimrichhannot/contao-fieldpalette: >=1.2
• heimrichhannot/contao-haste_plus: >=1.3.23
• phpoffice/phpexcel: >=1.8.1

LGPL-3.0+

• Heimrich & Hannot

• xls
• csv
• module
• backend
• export
• developer
• contao

README

A module for exporting any contao entity.

Export config preview

Features

• export an entity list in the backend
• export of entities in the frontend
• currently supported file types:
  • csv
  • xls
  • pdf
  • zip (media file export as zip)

Classes

Hooks

Technical instruction

Backend export

Step 1

Define your global operation in your entity's dca as follows:

'global_operations' => array
(
    'export_csv' => \HeimrichHannot\Exporter\ModuleExporter::getGlobalOperation('export_csv',
                 $GLOBALS['TL_LANG']['MSC']['export_csv'],
                 'system/modules/exporter/assets/img/icon_export.png')
),

Step 2

Add your backend module in your entity's config.php as follows:

$GLOBALS['BE_MOD']['mygroup'] = array
(
    'export_csv' => \HeimrichHannot\Exporter\ModuleExporter::getBackendModule()
),

Step 3

Create a configuration for your export by using the exporter's backend module (group devtools).

Frontend

You can use frontendedit or formhybrid_list in order to easily create a module for manipulating your entities in the frontend. It already contains a function to export entities after submission!

Step 1

Create a configuration for your export by using the exporter's backend module (group devtools).

Step 2

Add the following code to your module in order to your module:

ModuleExporter::export($objConfig, $objEntity, $arrFields);

If you add $arrFields, this array will be iteratd automatically in your template. Alternatively you can print every entity's property using $this in the template.