Functional Documentation

• Cache

  A class to handle manipulation of cache files (or any file, really).

• Controller

  A default controller class to be extended

• CRUD

  Database abstraction layer implementing CRUD procedures

• CSV

  Simple object to aid in creating CSV documents

• Database

  Database interaction abstract class definition

• DatabaseConnectionException

  This exception extends the PHP Exception class and should be thrown when an attempted connection to a database fails.

• Debug

  Provides a method for debugging and logging information by specifying a callback function to use as a debug handler.

• Dispatcher

  Dispatcher to route URI request to appropriate controller / method, and loads view files based on instructions from the controller, passing data setup by the controller from the controller to the view file.

• ExtensionNotInstalledException

  This exception extends the PHP Exception class and should be thrown when a required PHP extension is not installed.

• FileFunctions

  A library for manipulating files, directories and paths

• FileNotFoundException

  This exception extends the PHP Exception class and should be thrown when a needed file does not exist at the specified location.

• Form

  A library of form field generation helpers, mainly useful automate data preservation on form errors

• ImageFunctions

  A library for manipulating images

• JSONObject

  Based on properties added, this class is responsible for building a list of elements, and then generating a JSON string from those elements. This is more powerful than json_encode() in that it allows for adding arrays and objects as member variables to the JavaScript object.

• Model

  The model class of the MVC architecture. Extends the CRUD database abstraction layer to enhance it. This class should not be used directly. It should be extended with methods specific to the database table it is interacting with.

• Pagination

  A simple library to handle calculating pagination values and returning a set of pagination links to output.

• PostgresDatabase

  Database adapter class for PostgreSQL

• QueryFailedException

  This exception extends the PHP Exception class and should be thrown when a query fails so that a developer can properly handle that exception.

• Request

  The request object stores information about the web request and how it was routed, as well as stores data setup by the controller, including view file and loaded data.

• ResultSet

  Contains a set of database results, but is database indepenent, and allows the traversing of the database records as well as access to the data.

• SimpleXMLElementExt

  This class extends the SimpleXMLElement class in PHP and adds a few extra methods to aid in the XML DOM manipulation.

• StaticTimer

  A simple timer for various purposes

• StringFunctions

  A library for manipulating strings

• Validation

  Data validation class helper

• XMLFunctions

  A library for manipulating XML objects and/or strings