SAutoLoad Class Reference

Auto-loads the necessary classes when a new object is called/created. More...

List of all members.

Static Public Member Functions

static addModule ($name)
 Add a module.
static addSearchPath ($path)
 Add a search path for class files.
static getModules ()
 Get the list of added modules.
static getSearchPath ()
 Get the list of search paths.
static initialize ()
 Initialize this class.
static isModuleUsed ($name)
 INSERT BRIEF DESCRIPTION HERE.


Detailed Description

Auto-loads the necessary classes when a new object is called/created.

Maintain a list of search paths for classes. When a new class that is not yet defined is called, search the search paths for a script with the same name as the required class. If such a script is found, include it.

Author:
Jonathan (jwsm@shodor.org)

Joel (jfeiner@shodor.org)

Date:
Created 11/27/07

Member Function Documentation

static SAutoLoad::addModule ( name  )  [static]

Add a module.

Modules are code libraries. When a module is added, and additional set of search paths is added to the SAutoLoad search paths.

Current default modules: pr2: PageRender2 module - for rendering out complete web pages xforms: Shodorx Forms - Create forms using XForms XML standard swat: Shodor Web Application Toolkit - do object-relational mapping, user login, and event handling snap2: Access content from the SNAP2 repository tk2: Toolkit functions to create widgets on your page using code smodel2: A newer version of ORM (alternative to SWAT) wiki: Wikitext parsing functions tsd: Access Textbooks, Standards and Dictionary information sdr: Metadata access classes

static SAutoLoad::addSearchPath ( path  )  [static]

Add a search path for class files.

Parameters:
$path [string]: The new search path
When SAutoLoad searches for a file to load for a class that is called, it will check in the $path directory as well as other paths.

static SAutoLoad::getModules (  )  [static]

Get the list of added modules.

Returns:
[array]: The list of added modules

static SAutoLoad::getSearchPath (  )  [static]

Get the list of search paths.

Returns:
[array]: The list of search paths

static SAutoLoad::initialize (  )  [static]

Initialize this class.

Find the common root, and build the default set of search paths

static SAutoLoad::isModuleUsed ( name  )  [static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$name [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION


The documentation for this class was generated from the following file:

Generated on Wed Nov 24 02:02:31 2010 for Common by  doxygen 1.5.6