Komponenten-Dokumentation

Diese Seite beinhaltet die Dokumentation der Komponenten des Adventure PHP Framework (APF). Weitere Teile der Dokumentation finden sich auf der Seite Dokumentation.

Allgemeine Hinweise

Um das Lesen Dokumentation zu erleichtern, sollten Sie kurz die verwendeten Symbole und Notationen verinnerlichen.

Optional verwendete Tags oder Tag-Attribute werden in eckigen Klammern notiert. Finden Sie in der Dokumentation eine Code-Box der Form

APF-Template
<core:importdesign namespace="" template="" [incparam=""] [context=""] />

oder

APF-Template
<html:template name=""> [<template:placeholder name="" />] [<template:addtaglib namespace="" prefix="" class="" />] </html:template>

so sind die Attribut incparam bzw. context im ersten und die Tags <template:placeholder /> bzw. <template:addtaglib /> im zweiten Code-Block als optional deklariert. Sollten Sie diese trotzdem benötigen, sind die eckigen Klammern zu entfernen. Werden die Bestandteile nicht verwendet, so müssen diese inklusiv der eckigen Klammern entfernt werden.

Sollten Sie die Tag-Definition wie in den Code-Boxen beschrieben 1:1 übernehmen, führt dies zu einer ParserException, da die Syntax vom APF-Template-Parser nicht erkannt werden kann.

Der Einstieg

Die hier aufgeführten Seiten dienen zum Einstieg in die Entwicklung mit dem APF. Sollten diese nicht ausreichen, bietet sich ein Blick in die Tutorials an.

  1. Grundlagen
  2. Hallo Welt!

Der Kern des Frameworks

Der Kern des Frameworks besteht im Wesentlichen aus der Front- und Page-Controller-Implementierung und einigen weiteren Hilfsmitteln, die für die Integration der Komponenten sorgen. Diese sind:

  1. Page-Controller
  2. Front-Controller
  3. Templates
  4. (Document-)Controller
  5. Konfiguration
  6. Registry
  7. Benchmark
  8. Filter
  9. Logger
  10. Singleton / SessionSingleton
  11. Services
  12. Fehlerbehandlung
  13. Exception-Behandlung

Kern-nahe Komponenten

Kern-nahe Komponenten sind solche, die im Package core zu finden sind und für das Arbeiten mit dem APF sehr nützlich sind:

  1. SessionManager
  2. ConnectionManager
  3. AdvancedLogger (veraltet seit 1.17)

Tools & Helfer

Unter Tools & Helfer finden sich erweiterte Konfigurations-Möglichkeiten der Kern-Komponenten und Hilfmittel, die die Entwicklung effizienter gestalten.

  1. Standard TagLibs
  2. Spezielle TagLibs
    1. Iterator-Tag
    2. Mediastream-Tags
    3. Generischer importdesign-Tag
    4. core:appendnode-Tag
  3. URL-Rewriting
  4. Formulare
  5. Verwendung von Formularen
  6. Links
  7. CookieManager
  8. mailSender
  9. ImageManager
  10. StringAssistant
  11. StringEncryptor
  12. Validator (vor 1.11 "myValidator")
  13. AdvancedBBCodeParser
  14. HeaderManager
  15. CacheManager
  16. FilesystemManager
  17. RequestHandler
  18. PostHandler
  19. RandomStringManager
  20. ExtendedSoapClientService
  21. MultiFileUpload
  22. FileSystem (seit 1.16)

Module

Das Framework liefert Module aus, die auf den Kern-Komponenten und den Tools aufgebaut sind. Diese können als Basis für eigene Anwendungen genutzt werden und verstehen sich als "erweiterte Hilfmittel".

  1. Kommentar-Funktion
  2. Kontaktformular
  3. Pager
  4. Socialbookmarking
  5. CAPTCHA-Taglib (für Formulare)
  6. ReCaptcha (für Formulare)
  7. Usermanagement-Modul (teilweise veraltet)
  8. Benutzer-Verwaltung (seit 1.15)
  9. Generischer O/R-Mapper
    1. Einführung und Anwendung
    2. Eigene Domänen-Objekte
    3. Performance-Hacks
    4. Update der Datenbank

Extensions

Seit einiger Zeit haben engagierte APF-Nutzer eigene Extensions erstellt. Diese liegen dem APF-Release bei und werden dadurch bei Änderungen der Core-Komponenten mit gepflegt. Die Dokumentation der Extensions findet sich im Wiki.