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 der 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=""> [<html:placeholder name="" />] [<core:addtaglib namespace="" prefix="" class="" />] </html:template>

so sind die Attribut incparam bzw. context im ersten und die Tags <html:placeholder /> bzw. <core: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 ClassLoader-Implementierung und dem Front- und Page-Controller. Daneben reihen sich eine Liste von weiteren Hilfsmitteln in die Liste ein, die für die Integration der Komponenten sorgen. Diese sind:

  1. Laden von Klassen
  2. Page-Controller
  3. Front-Controller
  4. Request-Verarbeitung
  5. Templates
  6. Erweiterte Template-Funktionen
  7. (Document-)Controller
  8. Parser Secrets
  9. Konfiguration
  10. Registry
  11. Filter
  12. Logger
  13. Erzeugung von Objekten
  14. Services
  15. Fehlerbehandlung
  16. Exception-Behandlung
  17. Benchmark
  18. ConnectionManager

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 Tags
    1. Iterator-Tag
    2. Mediastream-Tags
    3. Generischer importdesign-Tag
    4. core:appendnode-Tag
  3. URL-Rewriting
  4. Validierung
  5. Formulare
  6. Verwendung von Formularen
  7. Links
  8. ImageManager
  9. StringAssistant
  10. StringEncryptor
  11. AdvancedBBCodeParser
  12. CacheManager
  13. FilesystemManager
  14. RandomStringManager
  15. ExtendedSoapClientService
  16. MultiFileUpload
  17. FileSystem

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
  9. Generischer O/R-Mapper

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.