PHPOF v1: Documentation

Welcome to the PHPOF documentation. This documentation is brief but provides information and examples on using the public methods of the PHPOF classes.

Introduction

1. What is PHPOF?
2. The terms under which PHPOF are licensed, which you must accept in order to use PHPOF
3. Basic concepts
4. Configuration

Tutorial: An example Web application

1. Introduction - setting up the basics
2. Creating the derived classes
3. Creating the common file

Reference Documentation

The most up-to-date reference documentation is in the code. The main classes for database handling are:

• DB - Class for use when handling databases
• DB_xxx - Database drivers, containing the "real" database functions for querying etc.
• DB_result - Database query result
• DBRow - Database row
• DBTable - Database table

Reference Documentation: Utility Classes

These 'classes' are primarily collections of useful functions, organised into classes for the sake of simplicity. In most cases, they can (and are intended to) be used uninstantiated.

• Token - Class to assist in using authentication tokens (useful to help avoid Cross-Site Request Forgery (CSRF) attacks)
• XArray - Functions for dealing with and manipulating arrays
• XError - Functions to assist in handling errors
• XDateTime - Functions to assist when dealing with dates and times, especially ISO8601-formatted dates/times
• XString - Functions for dealing with and manipulating strings
• XVar - Functions for handling variables (under construction)