Spezifikation: die Extension bccie #

Diese Seite ist die Referenz für die Extension bccie (1.1.12), „BC CIE“, in der Administration als CIE angezeigt. Sie exportiert die gesammelten Informationen von Inhaltsobjekten (die Antworten, die über ein Kontaktformular, eine Umfrage oder eine Bewerbung gesendet wurden) in CSV- oder SYLK-Dateien (Excel): aus der Administration, im Hintergrund, über die Konsole und per Cron. Die Seite führt die Modul-Views und Richtlinien, die Exportoptionen und den Inhalt der Dateien, die Konsolenbefehle, die Cronjob-Teile und jede Einstellung auf. Die kurze Anleitung für Site-Betreiber ist die Funktionsseite.

Kurz gesagt #

• Einstiegspunkt in der Administration: /bccie/overview (der Reiter CIE): ein Dashboard mit den Formularen, die Informationen gesammelt haben, den letzten Exporten, dem geplanten Export und den gefundenen Problemen sowie eine Liste der Formulare mit Filter, Sortierung und Blättern.
• Ein Formular wird unter /bccie/export/<object id> exportiert: Felder, Zeitraum, Typ (CSV oder SYLK), Trennzeichen und Zeichensatz. Ein kleiner Export wird geschrieben, während Sie warten; ein großer läuft im Hintergrund und wird zum Herunterladen angeboten.
• Dieselbe Arbeit steht als Konsolenbefehle (ext:bccie:export, status, purge) und als zwei Cronjob-Teile (exportcsv, exportsylk) zur Verfügung. Alle verwenden die Runner-Klasse bccieRunner.
• Jede Textzelle wird für eine Tabellenkalkulation unschädlich gemacht: Eine Zelle, die mit =, +, - oder @ (oder einem Tabulator) beginnt, erhält ein vorangestelltes einfaches Anführungszeichen.
• Keine Tabellen: Die Extension liest ezinfocollection und ezinfocollection_attribute. Ihr eigener Zustand (die letzten Exporte) besteht aus zwei Zeilen in ezsite_data; Hintergrundläufe legen Dateien in var/<site>/bccie/jobs/ ab.

Beispiel: ein Formular über die Konsole exportieren und die Datei ansehen #

./console ext:bccie:status                                   # which forms have data
./console ext:bccie:export --object=123 --dry-run            # how many collections would be written
./console ext:bccie:export --object=123 --charset=utf8bom --from=2026-10-01 --output=var/export

Öffnen Sie die Datei in einer Tabellenkalkulation: Die erste Zeile ist die Kopfzeile mit den Feldnamen, danach folgt eine Zeile pro Sammlung, und eine Zelle, die mit = begann, zeigt ein vorangestelltes Anführungszeichen statt eines Ergebnisses.

Modul bccie #

Jede View verwendet den Navigationsteil ezbccienavigationpart, daher kommt das linke Menü in jedem Administrationsdesign aus design/standard/templates/parts/bccie/menu.tpl (die Links sind [Leftmenu_bccie] in menu.ini).

Richtlinienfunktionen: read (jede View) und, seit 1.1.12, remove (Entfernen gesammelter Informationen, aus der Liste und von der Exportseite; die Rolle Admin hat sie). Die View-Skripte sind schlanke Aufrufe ausführbarer Klassen in classes/runnable/views/bccie/; die Arbeit steckt in bccieExportPage, bccieRunner und bccieExportUtils.

Exportoptionen #

Was die Dateien enthalten #

• CSV: jede Zelle in doppelten Anführungszeichen, ein doppeltes Anführungszeichen innerhalb einer Zelle verdoppelt, Zellen durch das Trennzeichen getrennt, kein Trennzeichen nach der letzten Zelle, eine Zeile pro Sammlung, ein Zeilenumbruch innerhalb einer Zelle als Leerzeichen geschrieben. Zellen werden von Leerraum am Rand befreit.
• SYLK: die Formatdatensätze, eine fette Kopfzeile mit den Feldnamen, dann eine Zeile pro Sammlung; die ID der Sammlung ist eine Zahl, alle anderen Zellen sind Text (" verdoppelt, ; verdoppelt).
• Text ist UTF-8 und bleibt unverändert; erst der Zeichensatz-Handler konvertiert die fertige Datei.
• Formeln: Eine Textzelle, die mit =, +, - oder @, einem Tabulator oder einem Wagenrücklauf beginnt, erhält ein vorangestelltes einfaches Anführungszeichen (=1+1 wird zu '=1+1). Eine reine Zahl, auch mit Vorzeichen (+4912345, -5), bleibt unverändert, weil eine Tabellenkalkulation sie als Zahl liest, nicht als Formel.
• Dateiname: <ExportFileName><object name>-on-<date>.csv (.slk), wobei der Name auf Buchstaben, Ziffern, Punkt, Bindestrich und Unterstrich reduziert wird.
• Ein Datentyp mit Handler (siehe export.ini) wird so geschrieben, wie der Handler es vorgibt (der Text der Option, der Name des verknüpften Objekts, der Name des Landes); jeder andere Datentyp schreibt seinen gespeicherten Text.

Direkte Exporte und Hintergrund-Exporte #

Ein Download wird geschrieben, während die Seite wartet, bis zu DirectExportLimit Sammlungen (2000). Darüber, oder wenn „Im Hintergrund ausführen“ gedrückt wird, startet bccieJob extension/bccie/bin/php/export.php --job=<id> mit expProcessTools (setsid, die PHP-Kommandozeile). Die Seite fragt bccie/job/<id> regelmäßig nach Zustand, Fortschritt (done von total) und Protokoll ab und zeigt eine Schaltfläche Herunterladen, wenn der Zustand finished ist. Die neuesten 20 Jobs und ihre Dateien werden aufbewahrt. Ein Job, der zehn Minuten lang kein Lebenszeichen zeigt, wird als fehlgeschlagen gemeldet.

Konsolenbefehle #

Jeder Befehl zeigt seine Optionen mit --help. Es läuft jeweils nur ein Export gleichzeitig (eine Sperre im Cache-Verzeichnis, egal wer ihn startet). Ein Lauf hält für das Dashboard seinen Zeitpunkt und das Geschriebene fest und löst die Ereignisse für ausführbare Klassen des Kernels aus, sodass das Audit ihn wie jeden Befehl des Kernels sieht; ein Entfernen wird außerdem als bccie-purge in das Audit geschrieben.

Cronjob-Teile #

Beide Dateien sind Stubs, die die Klassen aufrufen; ext:bccie:export --cron --format=sylk führt denselben Code von Hand aus. Die Dateien heißen <object>_export_<date>_<time>.csv oder, mit ExportLimitedRange, <object>_<from>_to_<to>.csv. Jedes Feld des Formulars wird geschrieben, außer den Klassenattributen aus ExcludeAttributeID, mit der ID der Sammlung zuerst. Mit RemoveExported=enabled werden die Sammlungen, die eine Datei enthält, entfernt, nachdem die Datei geschrieben wurde; konnte die Datei nicht geschrieben werden, wird nichts entfernt.

Einstellungen #

Geltungsbereich: Extension (extension/bccie/settings/). Überschreiben Sie sie in settings/override/ oder in einem Siteaccess.

Siehe auch #

• Funktionsseite, Verhaltensänderungen der Extensions
• Abstraktionen für CLI, Cronjobs und Views, Cronjobs in der Konsole
• Chronik und Release Notes