Merkliste für MetaModels

Warnung

Die Merkliste ist noch im Fundraising und wird erst nach Erreichen der Zielsumme von x.000€ frei geschaltet.
Eine Vorab-Installation ist nach Absprache möglich. Kontakt: info@e-spin.de

Die Merkliste (Notelist) erweitert MetaModels um die Möglichkeit, in der FE-Ausgabe einzelne Datensätze (Items) einer Merkliste hinzuzufügen (add).

Einsatzmöglichkeiten für die Merkliste reichen von einer „normalen Merkliste“ über Vergleichslisten z.B. von Produkteigenschaften bis zu Warenkorbfunktionen.

Ist ein Datensatz in einer Merkliste gespeichert, kann der Datensatz natürlich auch aus der Merkliste wieder entfernt werden (remove).

Mit der Merkliste gibt es eine neue Filterregel, mit der eine MetaModels-Liste nach vorhandenen Merklist-Datensätzen gefiltert werden kann.

Für den Formulargenerator wurde ein neues Widget erstellt, mit dem die Datensätze der Merkliste aufgelistet und in der E-Mail mit übertragen werden - eine Versendung der E-Mail per Notification-Center ist auch möglich.

In jedem MetaModels können mehrere Merklisten angelegt werden. Damit ist es z.B. möglich, einen Datensatz bei zwei Merklisten einzutragen wie „Favoriten“ und „Bestellen“ oder man kann einen Datensatz von einer Merkliste wie „Vormerken“ zu einer weiteren Merkliste „Bestellen“ übertragen.

In der Konfiguration einer Merkliste kann ein Filter gesetzt werden, so dass nur noch bestimmte Datensätze in die Merkliste aufgenommen werden können - z.B. nur Mitarbeiter aus der Abteilung „Vertrieb“.

Die Merkliste arbeitet auch mit übersetzten MetaModels, so dass die Datensätze einer Merkliste auch beim Wechsel der Sprache erhalten bleiben.

Installation per Composer

Voraussetzungen für die Installation:

  • PHP 7.x
  • Contao 3.5.x oder Contao 4.4.x
  • MetaModels ab core 2.0.0-alpha16 bzw. 2.1 und DCG 2.0.0-beta39
  • (Zip-Paket der Erweiterung, Anfrage über info@e-spin.de)

In der Paketverwaltung in der Suche metamodels/notelist eingeben, installieren und die Datenbank aktualisieren.

Merkliste anlegen

Nach der erfolgreichen Installation der Merkliste erscheint ein neues Icon in der Reihe der MetaModels-Icons, über welches man zum Anlegen und editieren der Merklisten gelangt.

img_notelist_icon

Legt man eine neue Merkliste an, so kann ein Name für die Merkliste vergeben werden. Als „Storage adapter“ stehen z.Z. die PHP-Session und die Contao-Session zur Verfügung. Bei der Contao-Session werden die Werte einer Merkliste bei eingeloggten Mitgliedern automatisch in den Sessionwerten der Datenbank gespeichert und stehen bei erneutem Login wieder zur Verfügung.

Über die Filterauswahl kann die Aufnahme auf Datensätze mit bestimmten Eigenschaften wie z.B. die „Abteilung“ oder Mitgliedergruppen eingeschränkt werden. Die Filterung auf Mitgliedergruppen ist z.B. über die Erweiterung „condition membergroup filter“ möglich.

img_nodelist_config

Über die Listenansicht erhält man Zugriff auf alle angelegten Merklisten.

img_notelist_overview

Merkliste in MetaModels-Liste aktivieren

Im CE MetaModels-Liste bzw. FE-Modul gibt es einen neuen Abschnitt „Notelist“, in dem eine oder mehrere der angelegten Merklisten aktiviert werden kann.

img_notelist_ce_mm-list

Die Reihenfolge der „Action-Ausgaben“ ist über die Sortrierung der Merklisten per Drag&Drop veränderbar.

Wird für die Ausgabe das Standardtemplate verwendet müssen keine weiteren Änderungen vorgenommen werden und in der FE-Listenansicht sollten die Datensätze einen weiteren Link zum Hinzufügen zur Merkliste vorweisen.

Verwendet man ein eigenes Template, so ist für die neuen Links eine entsprechend Anpassung notwendig. Die Links sind im Knoten action enthalten und können z.B. mit dem folgenden Code ausgegeben werden:

1
<a href="<?= $arrItem['actions']['notelist_1']['href'] ?>" class="<?= $arrItem['actions']['notelist_1']['class'] ?>"><?= $arrItem['actions']['notelist_1']['label'] ?></a>

img_notelist_fe_list

Ausgabe der Merkliste per Filter

Die Ausgabe der Merkliste im FE erfolgt über eine normale MetaModels-Liste, die auf die Elemente der Merkliste gefiltert wird.

Für die Filterung muss ein Filter mit der neuen Filterregel „Notelist“ angelegt werden. In der Filterregel ist lediglich die Merkliste auszuwählen, dessen Elemente ausgegeben werden sollen.

img_notelist_filterrule

In der FE-Ausgabe der gefilterten Liste, sieht man nur noch die Mitarbeiter der Merkliste.

img_notelist_filtered_list

In der Listenausgabe wäre es z.B. möglich, eine weitere Merkliste zu aktivieren, um die Elemente von einer merkliste zu einer weiteren zu übernehmen - z.B. von „Vormerken“ zu „Bestellen“.

In den Einstellungen der Merkliste kann optional ein Filter für die Aufnahme zu einer Merkliste gesetzt werden. Sind z.B. nur Mitarbeiter erlaubt, die zum Vertrieb gehören, sieht die Liste wie folgt aus:

img_notelist_fe_list_with_filter

Datenanzeige und Übernahme im Formular

Im Formulargeneratorsteht ein neues Widget MetaModels note list zur Verfügung. Mit den Einstellungen wird sowohl die Anzeige im Formular als auch in der E-Mail gesteuert.

Dazu kann eine oder mehrere Merklisten aktiviert und jeweils eine Render-Einstellung für die FE-Ausgabe und die E-Mail-Ausgabe ausgewählt werden. Zusätzlich kann für jede Merkliste über die Checkbox „Clear list“ bestimmt werden, ob nach der Formularverarbeitung die Liste geleert werden soll.

img_nodelist_form_widget

Das optionale Template „Custom email template“ bindet alle Renderings der E-Mail-Ausgaben der Merklisten ein und „umschließt“ diese. Achtung: in den Einstellungen von Contao muss bei „Unterstützte Templateformate“ unbedingt die Extension text eingetragen sein! Aktuell können die Merklistdaten in der E-Mail nur als (Plain-)Text übermittelt werden - die Rendereinstellungen „Ausgabeformat“ für das Listing in der E-Mail ist entsprechend auf „Text“ einzustellen.

Im Formular werden die entsprechenden Datensätze über die gewählte Render-Einstellung ausgegeben.

img_nodelist_form_fe_list

Eine Bearbeitung z.B. Löschen der Elemente der Merkliste ist im Formular nicht möglich, da bei einem Reload der Seite schon im Formular eingegebene Daten verloren gehen würden.

Man kann vor der Ausgabe des Formulares eine Liste mit allen Elementen der Merkliste ausgeben und dort diese einzeln bearbeiten oder die gesamte Liste löschen.

1
<p><a href="de/metamodels/note-list-contact-form.html?notelist_2_action=clear">Clear List 2</a></p>

img_nodelist_form_fe_list_edit_items

Die Daten werden per E-Mail übertragen und können über das E-Mail-Template in der Ausgabe angepasst werden. Für die Versendung stehen die Contao-Formularoption oder auch das „Notification Center (NC)“ zur Verfügung.

img_notelist_email_list

Übermittlung zusätzlicher Daten für jedes Item

Als Option können für jedes Item zusätzliche Daten an die Merkliste wie z.B. eine Anzahl, Freitext o.ä. übermittelt werden. Dafür erstellt man über den Formulargenerator ein Formular, welches die anzuzeigenden Felder beinhaltet z.B. Auswahlfeld für eine Anzahl und Textfeld für eine kurze Info - ein Absendefeld ist nicht notwendig und wird automatisch generiert.

Dieses angelegte Formular steht nun in den Einstellungen der Merkliste zur Verfügung - Formulare, die schon ein Merkliste-Formularelement beinhalten, werden nicht angezeigt (Rekursion!).

In der Listendarstellung wird bei jedem Item nun das Formular inkl. einem „Add/Edit-Button“ angezeigt. Die Daten werden vom Formular auch mit verarbeitet und z.B. per E-Mail mitgesendet.

img_notelist_fe_list_with_form

InsertTags

Für die Ausgabe der Anzahl der Items in den Merklisten sind verschiedene InsertTags implementiert. Diese geben die Anzahl wie folgt aus (‚mm_mitarbeiterliste‘ ist das entsprechende MetaModels):

  • Anzahl aller Items: {{metamodels_notelist::sum::mm_mitarbeiterliste}}
  • Anzahl aller Items der Merkliste ID 1: {{metamodels_notelist::sum::mm_mitarbeiterliste::1}}
  • Anzahl aller Items der Merkliste ID 1 und 2: {{metamodels_notelist::sum::mm_mitarbeiterliste::1,2}}

Ist kein Item in der Merkliste, wird 0 (Null) ausgebeben.

Events

Soll die Manipulation einer Notelist (add, remove, clear) überwacht werden, steht dafür ein Eventlistener zur Verfügung.

Mit dem Eventlistener kann z.B. ein Rückmeldung an die Webseite erfolgen oder ein Logging/Tracking der Aktionen.

Als Beispiel für eine Rückmeldung kann in einem eigenen Contao-Modul z.B. unter /system/modules/myModule/config/event_listeners.php folgender Code eingetragen werden:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?php

use MetaModels\NoteList\Event\ManipulateNoteListEvent;
use MetaModels\NoteList\Event\NoteListEvents;

return [
    NoteListEvents::MANIPULATE_NOTE_LIST => [
        function (ManipulateNoteListEvent $event) {
            // Only handle note list "1".
            if ('1' !== ($listId = $event->getNoteList()->getStorageKey())) {
                return;
            }

            switch ($event->getOperation()) {
                case ManipulateNoteListEvent::OPERATION_ADD:
                    Message::addConfirmation('Added ' . $event->getItem()->get('id') . ' to ' . $listId);
                    // Add your own notes in metaData.
                    $metaData = $event->getNoteList()->getMetaDataFor($event->getItem());
                    $metaData['tstamp'] = time();
                    $event->getNoteList()->updateMetaDataFor($event->getItem(), $metaData);
                    break;
                case ManipulateNoteListEvent::OPERATION_REMOVE:
                    Message::addConfirmation('Removed ' . $event->getItem()->get('id') . ' to ' . $listId);
                    break;
                case ManipulateNoteListEvent::OPERATION_CLEAR:
                    Message::addConfirmation('Cleared ' . $listId);
                    break;
                default:
                    throw new \RuntimeException('Unknown note list operation: ' . $event->getOperation());
            }
        }
    ]
];

Auf der Webseite kann in einem Template die Rückmeldung über die Ausgabe der Contao-Message erfolgen - z.B.

1
2
3
<?php
echo Message::generate();
?>

Zudem können über diesen Event auch zusätzliche Informationen abgespeichert werden - siehe bei OPERATION_ADD.

Known Issues and Next Features

  • Übersetzungen in DE (wenn Projekt freigeschaltet per Transifex)
  • Datenübergabe an Formular als HTML (z.Z. nur als Text möglich)

Spenden

Ein Dank für die Spenden* für die Erweiterung an:

(Spenden in Netto)