Wer viele PHP-Projekte entwickelt, kennt die Situation sicherlich: Es gibt verschiedene Features, die in fast jedem Projekt benötigt werden. Sei es das simple Kontaktformular, der Versand von E-Mails, der Einbau eines Cookie-Banners oder die Ausgabe eines Menüs. Beim Start eines neuen Projekts verfällt der Entwickler gerne in das typische Muster, sich schnell alles zusammenzukopieren und so lange anzupassen, bis es passt. Bei zwei oder drei zu betreuenden Projekten ist das noch überschaubar. Aber bei 20, 30 oder gar 100? Wie kann ich den Spamschutz des Kontaktformulars in Dutzenden Projekten verbessern, ohne jedes Projekt einzeln individuell anpassen zu müssen? Die Lösung liegt auf der Hand: wir bauen uns ein Modul, das simpel mit Composer in jedes Projekt gebracht werden kann. Mit Git können wir Releases taggen und somit unterschiedliche Versionen des Moduls bereitstellen. Automatisierte Tests helfen uns beim Sicherstellen der Funktionalitäten. Tolle Sache! Doch manchmal möchten wir Formulare auch mal im Browser anschauen und die HTML-Ausgabe anpassen. Dabei helfen Module, die eine kleine Mini-Anwendung mit sich bringen, die im Browser gestartet werden kann. Wie wir so etwas umsetzen können, zeigt dieser Vortrag.

1. 1 / 70
PHP Module
PHP Module
als Rundum-Sorglos Pakete entwickeln
als Rundum-Sorglos Pakete entwickeln

2. 2 / 70
Ralf Eggert
Chef der Travello GmbH (2005+)
PHP und Web Entwickler (1999+)
Alexa Skill Entwickler (2017+)
Alexa Champion (2018+)

3. 3 / 70
Motivation

4. 4 / 70
Wie entwickele ich ein
Wie entwickele ich ein
komplettes Modul*,
komplettes Modul*,
das in 20+ Websites
das in 20+ Websites
eingesetzt wird?
eingesetzt wird?

5. 5 / 70
Eine Geschichte

6. 6 / 70
Dies ist eine Geschichte
Dies ist eine Geschichte
voller Missverständnisse…
voller Missverständnisse…
Jede Ähnlichkeit mit real existierenden Projekten ist rein zufällig.
Jede Ähnlichkeit mit real existierenden Projekten ist rein zufällig.

7. 7 / 70
Entwickler
Entwickler PM / PO
PM / PO

8. 8 / 70
Kapitel 1

9. 9 / 70
Los geht's
Hey, wir brauchen ein
Kontaktformular für
unsere Website!

10. 10 / 70
Kein Problem
Ich baue es in unser
zentrales Application
Modul ein. Das macht den
Kohl nicht mehr fett.

11. 11 / 70
Ergebnis
Einfaches Formular mit
wenigen Elementen.

12. 12 / 70
Kapitel 2

13. 13 / 70
Weiter geht's
Die andere Website
braucht auch ein
Kontaktformular, aber mit
zwei anderen Feldern!

14. 14 / 70
Kein Problem
Ich kopiere den Code mal
eben schnell ins andere
Projekt und passe es dann
fix an.

15. 15 / 70
Ergebnis
Jetzt haben wir alle
Formular Dateien zwar
doppelt, können sie aber
für jedes Projekt
individuell anpassen.

16. 16 / 70
Kapitel 3

17. 17 / 70
Und weiter
Bau noch mal zwei weitere
Kontaktformulare, die
funktionieren klasse!

18. 18 / 70
Ok, aber...
Beim letzten Mal gab es
Probleme beim Kopieren
der einzelnen Dateien. Ich
lagere das Formular in ein
Modul aus, das lässt sich
besser kopieren.

19. 19 / 70
Ergebnis
2x diverse Formular
Dateien in ein Modul
zusammenfassen.
Danach 2x Module
kopieren und anpassen.

20. 20 / 70
Kapitel 4

21. 21 / 70
Und weiter
Ein neuer Kunde braucht
auch ein Kontaktformular!
Die Anfragen müssen aber
in einer Datenbank
gespeichert werden.
Los schnell! Zeit ist Geld!

22. 22 / 70
Ähm
Ich kopiere das Modul und
passe es für den Kunden
an. Nur welches Modul soll
ich nehmen?

23. 23 / 70
Ergebnis
Hurra! Nun haben wir fünf
Module und alle
unterscheiden sich von
einander.

24. 24 / 70
Kapitel 5

25. 25 / 70
Noch weiter
Wir brauchen für unsere
eigenes Kontaktformular
nun auch das Datenbank
Dingsbums.
Los mach! Sofort!

26. 26 / 70
Idee!
Ich lagere das Modul in ein
Git Repository aus und
baue eine Konfiguration,
um Formularelemente und
Features konfigurieren zu
können.

27. 27 / 70
Ergebnis
Schon besser. Nun haben
wir nur noch ein Modul,
das individuell konfiguriert
und per Composer
installiert werden kann.

28. 28 / 70
Kapitel 6

29. 29 / 70
Kein Ende
Wir bekommen viel zu viel
Spam über die Formulare.
Bau mal Spamschutz ein!

30. 30 / 70
Hah!
Ich passe das Modul im
Vendor Ordner an und
kopiere die Änderungen in
das Modul Repository.
Danach aktualisiere ich die
Projekte per Composer.
Was soll da schief gehen?

31. 31 / 70
Achtung
Bitte zuhause nicht
nachmachen! Jedes Mal,
wenn du im Vendor Ordner
herum pfuscht, stirbt ein
kleines Katzenbaby.
Jedes. Verdammte. Mal.
Lass das sein!

32. 32 / 70
Kapitel 7

33. 33 / 70
Usw. usf.
Wir müssen die beiden
Kundenprojekte schnell
auf Bootstrap 5 umstellen!
Der Rest bleibt auf
Bootstrap 4. Das ist doch
kein Problem oder?

34. 34 / 70
WTF!
Ok, ich gebe auf und ziehe
nach Helgoland und züchte
Erdbeeren.

35. 35 / 70
Analyse

36. 36 / 70
Was ist hier
Was ist hier
passiert?
passiert?

37. 37 / 70
Clash of
Clash of
Gegensätze
Gegensätze
Nachhaltige
Nachhaltige
Entwicklung
Entwicklung
Kosten-/
Kosten-/
Zeitdruck
Zeitdruck

38. 38 / 70
»Premature optimization
is the root of all evil.«
– Donald Knuth –
»Don't repeat yourself!«
DRY-Prinzip
– Andy Hunt & Dave Thomas –
Clash of Principles
Clash of Principles

39. 39 / 70
Was war
Was war
schlecht?
schlecht?

40. 40 / 70
Programming by
Copy and Paste
1

41. 41 / 70
Dateien zu spät in
Modul kombiniert
2

42. 42 / 70
Modul zu spät in
ein eigenes
Git Repository
ausgelagert
3

43. 43 / 70
Konfiguration &
Feature Flags zu
spät eingeführt
4

44. 44 / 70
Im Vendor Ordner
herum gepfuscht
5

45. 45 / 70
Was ist bis
Was ist bis
jetzt gut?
jetzt gut?

46. 46 / 70
Composer
1

47. 47 / 70
Versionierung
2

48. 48 / 70
Feature Flags
3

49. 49 / 70
Automatisierte
Tests
4

50. 50 / 70
DRY
5

51. 51 / 70
Was fehlt dir
Was fehlt dir
denn noch?
denn noch?

52. 52 / 70
Human Testing
Ablauf
Darstellung
Konfigurierbarkeit

53. 53 / 70
Rundum-Sorglos Pakete

54. 54 / 70
Hohe Standardisierung
Hohe Standardisierung

55. 55 / 70
Implementation
Mit Laminas Mezzio
(Middleware Framework),
Font Awesome, MDB und
Bootstrap
Umsetzung mit anderen
Frameworks möglich

56. 56 / 70
Modul Aufbau

57. 57 / 70
Konfiguration
Dateien werden bei
Installation und Updates
ins Projekt übernommen

58. 58 / 70
HTML Blöcke
Können im Projekt
individuell angepasst
werden.

59. 59 / 70
Klassen
Kern des Moduls mit
Handlern, View Helpern,
Input Filtern,
Konfiguration, etc.

60. 60 / 70
Templates
Templates für Handler,
View Helper und Mails
(HTML und Text)

61. 61 / 70
Tests
Unit Tests für Handler,
View Helper, Input Filter,
Mailservice, Konfiguration,
etc.

62. 62 / 70
Modul Application
Lauffähige Middleware
Anwendung (Mezzio) zum
Testen von Handlern,
Routen, View Helpern,
usw.

63. 63 / 70
Assets
Zentrale Symlinks
Modul Symlinks
CDN
Einchecken

64. 64 / 70
Composer
composer serve
"scripts": {
"serve": "php -S 0.0.0.0:8080
-t public/ -c public/php.ini"
}

65. 65 / 70
View Helper
View Helper
testen
testen

66. 66 / 70
Handler DE
Handler DE

67. 67 / 70
Handler EN
Handler EN

68. 68 / 70
Zusammenfassung

69. 69 / 70
Rundum-sorglos PHP Module
Rundum-sorglos PHP Module
Unit Tests
konfigurierbar
wiederver-
wendbar
Feature Flags
Modul
Application
versionierbar
I18n
standardisiert
Routing

70. 70 / 70
Fragen?
ralf@travello.de
www.travello.de