Components documentation

This page contains the the documentation of the components of the Adventure PHP Framework (APF). Further documentation can be found on the Documentation page.

Common hints

To ease reading of the documentation, please take a look at the symbols and notations used within the subsequent chapters.

Optional tags or tag attributes are always noted in brackets. In case the documentation chapter includes a code box with

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

or

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

the attributes incparam and context as well as the <template:placeholder /> and <template:addtaglib /> tags are declared as optional. In case you intend to use them, please remove the brackets. If you do not use them, the tags or attributes must be removed together with their surrounding brackets.

Using the tag definition from the code boxes as-is generates as ParserException since the syntax cannot be interpreted correctly by the APF template parser.

First steps

The pages listed below are intended to give you a brief introduction into development with the APF. In case these are not enough have a look at the Tutorials page.

  1. Basics
  2. Hello world!

The framework's core

The core of the framework merely consists of the front and page controller implementation and some more tools, that are responsible for the integration of the components.

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

Core-supporting components

Core-supporting components are contained in the core package. These are very helpful operating an APF application:

  1. SessionManager
  2. ConnectionManager
  3. AdvancedLogger (deprecated since 1.17)

Tools & helper

The included tools and helper extend the core components and help you to implement web applications more efficiently.

  1. Standard taglibs
  2. Special-taglibs
    1. Iterator tag
    2. Mediastream tags
    3. Generic importdesign tag
    4. core:appendnode tag
  3. URL rewriting
  4. Forms
  5. Usage of forms
  6. Links
  7. CookieManager
  8. mailSender
  9. ImageManager
  10. StringAssistant
  11. StringEncryptor
  12. Validator ("myValidator" before 1.11)
  13. AdvancedBBCodeParser
  14. HeaderManager
  15. CacheManager
  16. FilesystemManager
  17. RequestHandler
  18. PostHandler
  19. RandomStringManager
  20. ExtendedSoapClientService
  21. MultiFileUpload
  22. FileSystem (since 1.16)

Modules

The framework's release ships modules, that are built on the core components ans tools. They can be uses as a basis for your applications and can be seen as "extended helper".

  1. Comment function
  2. Contact form
  3. Pager
  4. Socialbookmarking
  5. CAPTCHA taglib (for forms)
  6. ReCaptcha (for forms)
  7. User management module (partially deprecated)
  8. Benutzer-Verwaltung (since 1.15; until 1.16 German only)
  9. Generic OR mapper
    1. Introduction and application
    2. Custom domain objects
    3. Performance hacks
    4. Database update

Extensions

Since the end of 2009, engaged APF user have provided their extensions to the community. These extensions are directly packaged with the APF release und are thus maintained with each release. The documentation of the extensions can be found within the extensions folder of the release package and the Wiki.