Export

Mit Hilfe der Exportfunktion können Immobiliendatensätze als XML exportiert werden - mit dieser Funktion kannst Du deine eigene Schnittstelle bereitstellen.

Dies ist eine Funktion der PRO-Version von Openimmo.

Konfigurieren des Exports

Gehst Du wie folgt vor:

1. Wechsel im Backend in den System-Ordner, in dem auch Deine "Connection" liegt und lege einen Datensatz vom Typ "Export" an.
2. Vergebe einen "Zugriffs-Schlüssel", dieser ist frei wählbar (z. B. "export-123").
3. Wähle den "Connection"-Datensatz, dessen Immobilien Du exportieren möchtest.
4. Optional kannst Du einen oder mehrere Frontend-Benutzer auswählen, um die Ausgabe zu filtern.
5. Lege nun eine neue Seite an (z. B. mit dem Titel "Export") und platziere das Plugin "Openimmo - Export" (das Plugin erscheint nicht im "Wizard" für neue Inhaltselemente, wähle daher "Plugin einfügen" und wähle dann im Reiter "Plugin" das Plugin "Openimmo - Export".

Du kannst verschiedene "Export"-Datensätze anlegen und diese dann über den "Zugriffs-Schlüssel" aufrufen (s. u.).

Export starten

Du kannst nun die Immobilien im Frontend exportieren. Rufe dazu angelegte Seite in folgender Form auf:

https://www.meineseite.de/export?tx_openimmopro_export[accessKey]=export-123

Um die Daten direkt als Datei herunterzuladen, verwende den "export"-Parameter:

https://www.meineseite.de/export?tx_openimmopro_export[accessKey]=export-123&tx_openimmopro_export[download]=1

Achtung:

Wenn Du einen Fehler wie The page did not exist or was inaccessible. Reason: Request parameters could not be validated (&cHash empty) bekommst - versuche den access_key Parameter aus der cHash-Berechnung auszuschließen.

Parameter aus der cHash-Berechnung ausschließen:

Um den Parameter access_key des OpenImmo Export-Plugins aus der cHash-Berechnung auszuschließen, nutze die folgende Konfiguration (LocalConfigration):

'FE' => [
    'cacheHash' => [
        'enforceValidation' => true,
        'excludedParameters' => [
            'tx_openimmopro_export[accessKey]',
        ],
    ],

Export-Daten manipulieren

Es kann vorkommen, dass Du die Exportdaten während der Generierung noch manipulieren musst oder auch weitere Daten hinzufügen willst. Für diesen Fall bietet die Exportfunktion einen Signal/Slot und ein PSR-14 Event an.

via Signal/Slot

Beispiel für die ext_localconf.php:

/** @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher */
$signalSlotDispatcher = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
$signalSlotDispatcher->connect(
    \CodingMs\OpenimmoPro\Controller\ExportController::class, 'manipulateXml',
    \CodingMs\OpenimmoPro\Slot\ImmobilieExportSlot::class, 'manipulateXml'
);

Ein Beispiel für einen Slot findest Du in der Datei openimmo_pro/Classes/Slot/ImmobilieExportSlot.php.

via Event Listener

(benötigt wird Openimmo Pro 4.1.1 oder höher)

Ein Beispiel findest Du in der Datei openimmo_pro/Classes/EventListener/ManipulateXmlExample.php, registriert wird der Event Listener, wie in der Datei openimmo_pro/Configuration/Services.yaml gezeigt.