pnModDBInfoLoad

load database infor for a module

Synopsis

bool pnModDBInfoLoad(module, directory);

Description

pnModDBInfoLoad() loads the database table information for a module. This information is merged with the

Parameters

module

The well-known name of a module for which to load the database table information

directory

The directory name of the module for which to load the database table information, if known

Return Values

This function returns true. This function returns void if an exception was raised.

Exceptions

This function raises BAD_PARAM if you pass an invalid parameter. This function raises DATABASE_ERROR if an error occurs while querying data. This function raises MODULE_NOT_EXIST if the module doesn't exist.

Notes

If there is no database table information present then it is assumed that the module uses tables defined elsewhere, or no database tables at all, hence the function always returns true.

Examples

// Load the table information for the News module
pnModDBInfoLoad('News'
// Get the table information, now including the news tables
$pntable = pnDBGetTables();