PHP Object Framework (PHPOF) : Documentation

Welcome to the PHPOF documentation. This documentation provides information and examples on using the public interface of the PHPOF classes. It is somewhat thin in parts, but hopefully this will be resolved over time as the documentation expands and solidifies along with the classes. If you have any corrections/comments/enhancements/etc., please e-mail Tim Jackson.

The reference documentation has been designed to broadly follow the style of the HTML-format PHP documentation, so as to feel familiar.

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

Tutorial: An example Web application

1. Introduction - setting up the basics
2. Creating the derived classes
3. Creating the common file
4. Building the administration area
5. Building a front-end

Reference Documentation: Primary Classes

These are the core classes which PHPOF exists to provide.

DB - Class for use when handling databases
DB_xxx - Actual database functions
DB_result - Database query result
DBRow - Database row
DBTable - Database table
Token - Class to assist in using authentication tokens (useful to help avoid Cross-Site Request Forgery (CSRF) attacks)

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.

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)

Writing Secure Web Applications with PHPOF

Under construction

Introduction
Input Validation: Avoiding cross-site scripting vulnerabilities
Request Validation: Using tokens to prevent cross-site request forgeries