feat: wrote on registrierung

chapters/konzeption-entwicklung.tex

@@ -54,7 +54,6 @@ Nachdem in Erfahrung gebracht wurde, welche konkreten Datenobjekte benötigt wer
 wurden Attribute dieser Objekte dem Pflichtenheft entnommen. Diese wurden in einem
 formalen Klassendiagramm festgehalten und in Rücksprache mit dem \ac{PO}
 weiter bis zu festen Datentypen und Auswahlmöglichkeiten konkretisiert.
-
 Beispielsweise, dass Wettbewerbskategorien durch TYPO3-Categories repräsentiert werden sollen.
 Das hat den Vorteil, dass TYPO3-Categories bereits native Bestandteile eines TYPO3-Redaktionssystemes sind
 und bereits alle relevanten Attribute anbieten. Diese sind ein Titel,
@@ -64,18 +63,14 @@ Das Parent-Attribut ist benötigt, da $n$ dieser Attribute einen Attributbaum bi
 Somit ist es möglich Unterkategorien zu erstellen. Beispiele hierfür sind die
 Unterkategorien \enquote{Trockener Riesling} und \enquote{Halbtrockener Riesling} für die Überkategorie
 \enquote{Riesling}.
-
 Rebsorten, Geschmack, Weineigenschaften und Qualität sollen eigene Datentypen
 anstatt einfacher Zeichenfolgen sein.
 Ziel davon ist, dass sich Nutzer für einen vorgefertigten, nominalen Eintrag in einem Dropdown-Menü
 entscheiden müssen und diese Auswahlmöglichkeiten immer noch im TYPO3-Backend pflegbar sind.
-
 Weinlagen sind im Brown-Field-Projekt bereits vorhanden, also sollen hierfür existierenden Daten
 eingebunden werden.
-
 Pro Wein sollen beliebig viele Weineigenschaften auswählbar sein, Wettbewerbskategorien,
 Geschmacksrichtung, etc, jeweils nur ein Element.
-
 Weitere Notizen zu diesem Gespräch sind im Anhang unter \fullref{chap:anhang-notizen-digitization}
 zu finden.
 \\
@@ -95,3 +90,112 @@ Schnittstellen werden über die Basisklasse \enquote{Repository} geerbt
 \cite{bib:typo3-docs-extdev-tut-tea-repositories}.
 Mit Abschluss der Digitization können alle Datenstrukturen im TYPO3-Backend händisch angelegt,
 eingesehen, gelöscht und bearbeitet werden.
+
+
+\section{Teilnehmerregistrierung}
+Ein essenzieller Teil des Jahresauswahlprobenwerkzeuges ist die Registrierung von Teilnehmern.
+Dieses Modul repräsentiert den ersten Berührungspunkt der Winzer mit dem System.
+Dem Pflichtenheft ist zu entnehmen, dass es zwei Kategorien von Teilnehmerregistrierungen gibt:
+\begin{enumerate}
+  \item Nutzer ist \ac{WM}-Mitglied
+  \item Nutzer ist kein \ac{WM}-Mitglied
+\end{enumerate}
+Der primäre Unterschied zwischen Mitgliedern und Nicht-Mitgliedern ist, dass Mitglieder bereits einen
+Stammdatensatz hinterlegt haben.
+Dieser Stammdatensatz bildet die Angaben zum Weingut des zu digitalisierendem Anmeldeformulares ab.
+Nicht-Mitglieder sind dem System noch gänzlich unbekannt und müssen im Zuge der Registrierung ihres Nutzers
+ihre Stammdaten angeben, während sich Mitglieder lediglich einloggen müssen und eine Schaltfläche
+\enquote{Teilnehmer werden} betätigen.
+Der mit dem \ac{PO} ausgearbeitete UX-Flow der Registrierung sieht vor, dass der Nutzer zunächst gefragt wird,
+ob er Mitglied sei oder nicht. Hierzu gibt es je einen Button. Ist der Nutzer ein Mitglied,
+wird er auf ein Loginform, mit der Option zur Registrierung weitergeleitet.
+Nach erfolgreichem Login, wird ein Teilnehmerobjekt erstellt.
+Wählt der Nutzer \enquote{Nein, ich bin kein Mitglied} aus, würde er auf ein Registrierungsformular
+weitergeleitet, auf um sich einen Nicht-Mitgliederaccount anzulegen. Im Zuge dieser Registrierung werden
+Stammdaten zum Weingut angefragt.
+
+\begin{nicepic}
+    \includegraphics[width=0.9\textwidth]{images/ux-flow-registrierung.png}
+    \captionof{figure}{UX-Flow: Registrierung}
+    \caption*{Quelle: Eigene Darstellung}
+    \label{fig:uxflow-registrierung}
+\end{nicepic}
+
+Da das Brown-Field-Projekt bereits Accountlogins und -Registrierungen implementiert und nutzt,
+werden auf diese Lösungen zurückgegriffen, um einen einheitlichen Workflow beizubehalten. Accountregistrierungen werden über den
+\enquote{femanager} \cite{bib:typo3-docs-femanager} realisiert, während Logins via TYPO3's nativem
+Frontend-Nutzer-Login gelöst werden. Das ist explizit von femanager so angedacht:
+\quotecite{Note: Login and a I forgot my password function is part of the core and not part of femanager.}
+\cite{bib:typo3-docs-femanager}.
+
+Im Folgenden wird der Registrierungsprozess im Detail beschrieben:\\
+Grundlegend gibt es drei relevante Nutzerzustände vor der Registrierung:
+\begin{enumerate}
+  \item Kein Mitglied
+  \item Mitglied, mit Konto
+  \item Mitglied, ohne Konto
+\end{enumerate}
+
+Diese Prozesse sehen wie folgt aus:
+\subsection*{Kein Mitglied}
+Ist ein Nutzer kein Mitglied, so muss er zunächst einen Account erstellen.
+Anfangs wählt dieser Nutzer \enquote{Ich bin kein Mitglied} auf der Registrierungsseite aus.
+Daraufhin navigiert der Browser zu einem Registrierungs-Formular.
+Hierfür muss eine Email-Adresse und ein Passwort vergeben und den Nutzungsbestimmungen zugestimmt werden.
+Im Anschluss erhält der Nutzer eine Bestätigungsemail mit einem Aktivierungslink.
+Wird dieser Link geöffnet, wird der Account freigeschalten und ein Login-Feld erscheint.
+Nach erfolgreichem Login wird der Nutzer mit einem
+Stammdatenformular konfrontiert. Dabei handelt es sich um Angaben zum teilnehmenden Weingut.
+Wird dieses Formular abgeschickt, ist die Teilnehmerregistrierung abgeschlossen.
+
+\subsection*{Mitglied, mit Konto}
+Ist ein Nutzer ein Mitglied und hat bereits ein Mitgliedskonto, muss dieser auf der Registrierungsseite
+\enquote{Ich bin ein Mitglied} auswählen. An dieser Stelle navigiert der Browser zu einem Login-Formular.
+Hier kann sich das Mitglied nun anmelden. Tut er dies erfolgreich, ist die Teilnehmerregistrierung
+abgeschlossen.
+
+\subsection*{Mitglied, ohne Konto}
+Ist ein Nutzer ein Mitglied und hat noch kein Mitgliedskonto, muss dieser auf der Registrierungsseite
+\enquote{Ich bin ein Mitglied} auswählen. An dieser Stelle navigiert der Browser zu einem Login-Formular.
+Auf diesem Login-Formular existiert ein Button \enquote{Jetzt registrieren}, sowie ein Hinsweistext dazu.
+Da der Nutzer noch keinen Account hat, muss dieser auf \enquote{Jetzt registrieren} klicken.
+Daraufhin navigiert der Browser zu einem Registrierungsformular, das eine Email-Adresse, ein Passwort
+und die Zustimmung zur Datenverarbeitung benötigt. Ist dieses Formular abgeschickt, erhält das Mitglied
+eine Email mit einem Bestätigungslink. Wird dieser Bestätigungslink angeklickt, wird das Mitgliedskonto
+freigegeben und es öffnet sich ein Login-Formular.
+Nach erfolgreichem Login wird das Mitgliedskonto um die notwendingen Teilnehmereigenschaften erweitert
+und ist somit erfolgreich als Teilnehmer registriert.
+
+\subsection*{Umsetzung}
+Um das umzusetzen wurde zunächst ein simples Weichen-Content-Element erstellt.
+Dieses Content-Element hat die Parameter \enquote{question}, \enquote{answ-1-link}, \enquote{answ-1-text},
+\enquote{answ-2-link} sowie \enquote{answ-2-text}.
+Der Zweck dieses Content-Elementes ist es, Nutzer basierend auf einer ausformilierten Frage auf eine
+von zwei Seiten weiterzuleiten. Anschließend wurden Registrierungen über Femanager-Plugin-Content-Elemente
+realisiert.
+Anpassungen der versendeten Emails erfolgen durch Überschreiben der Email-Templates von Femanager.
+Weiterleitungen zu bestimmten Seiten nachdem ein Nutzer spezielle Events ausgelöst hat können über TypoScript
+konfiguriert werden \cite{bib:typo3-docs-femanager}. Logins werden über das TYPO3-Native Loginformular
+gelöst. Im TYPO3-Loginformular kann man Weiterleitungen zu spezialisierten Seiten im Backend-UI festlegen
+\cite{bib:typo3-docs-felogin}.
+Für alle funktionalen Belange wurde ein TYPO3-Plugin registriert. Dieses Plugin verfügt über einen
+ActionController, der Nutzeranfragen an PHP-Funktionen (\enquote{Actions})
+bindet.
+In diesen Actions wird Fehlerbehandlung durchgeführt, Datenmodelle der Domäne erstellt und in der
+Datenbank persistiert sowie Daten für die Anzeige im Frontend aufbereitet \cite{bib:typo3-docs-extbase}.
+Neue Datenobjekte werden in Repositories registriert \cite{bib:typo3-docs-extdev-tut-tea-repositories}. Diese Repositories sind Aggregate des Controllers,
+werden jedoch nach dem \enquote{Inversion of Control}-Prinzip via Dependency Injection instanziiert und
+der ActionController-Klasse über Methode übergeben \cite{bib:typo3-docs-di}.
+Als problematisch erweisen sich bidirektionale Verbindungen zwischen Datenmodellen, wenn die Foreign Keys
+über das SQL-Schlüsselwort \enquote{AUTO\_INCREMENT} in der Datenbank definiert werden.
+In diesem Fall wollen wir
+einen MasterRecord, der Betriebsinformationen speichert, bidirektional an ein Teilnehmerobjekt linken.
+Als ForeignKeys werden hierfür ihre jeweiligen Uids herangezogen, da diese Werte durch
+\enquote{AUTO\_INCREMENT} auf der Datenbankebene gehandhabt werden.
+Es gilt also, dass ein MasterRecord $a$ die TeilnehmerUid von einem Teilnehmer $b$ hält und dass
+$b$ die MasterRecordUid von $a$ hält.
+Die Problematik hierbei ist, dass diese Uids erst nach dem persistieren in der Datenbank bekannt sind,
+da diese Werte erst im Zuge der Persistierung erstellt werden. Das ist so, da das
+\enquote{AUTO\_INCREMENT}-Schlüsselwort lediglich zu SQL gehört und SQL nur von der Datenbank ausgeführt wird.
+Die Lösung hierfür ist es, beide Elemente zu erstellen und zu persistieren, danach ihre Uids gegenseitig
+bekannt machen um sie danach erneut zu persistieren.