Documentation

This section holds the documentation for the various components of the sytem.

This is where to look for samples of the code and how it works.

Currently the documentation is a bit sparse. But this section will grow with more information on how to implement the classes and build your site.

There is a reasonable API that I will link to wherever possible.

API Documentation

API Home


Auto Class Loader
24 June 2010
The automatic loading of classes makes things very simple when developing a ...
Database Interface
28 June 2010
This page describes the DatabaseInterface class and how it is used to run queries on the ...
Template Manager
29 June 2010
This page details the functionality of the TemplateManager class. This class is responsible for managing the templates and the data to be ...
Page Manager
29 June 2010
This abstract class sets up the basic functionality required on every page, like logging in, caching, performing actions, rendering the page ...
Base Component
29 June 2010
The Base Component class is the parent class for all objects in the system.It provides the functionality to build classes on-the-fly, to cache the object and to display a formatted var_dump of the instantiated object ...
Database Interaction Store
6 July 2010
This class is a simple container class for holding the details of the table definition's database ...
Setting the Include Path
6 July 2010
When PHP tries to include a file it will look for it first in the folder specified by the include_path variable. You can set this variable in the config file to point to the root folder where you keep your code files, and PHP will go looking for your file there ...
Getting the System Constants
6 July 2010
There are many settings within the system that are constant. Instead of passing them around in parameter lists we can define them as a constant and refer to them directly whenever we need ...
Table Definition
6 July 2010
The TableDefinition class holds all the relevant details on a table or view so you can run queries on ...
Template
7 July 2010
This class defines a template so it can be ...